Base class representing a m grid. This is grid contains information about the vacuum fields. More...

Public Member Functions
procedure, pass	interpolate (this, r, phi, z, ar, ap, az)
	Interpolate the vector potential at a point.

FINAL	m_grid_destruct (this)
	Deconstruct a m_grid_class object.

class(m_grid_class) function, pointer	m_grid_construct (mgrid_file_name, parallel, io_unit, vmec)
	Construct a m_grid_class object.

class(m_grid_class) function, pointer	m_grid_construct_plasma (num_r, num_p, num_z, rmax, rmin, zmax, zmin, parallel, io_unit, vmec)
	Construct a m_grid_class object.

Public Attributes
real(rprec)	rmin
	Minimum R position.

real(rprec)	rmax
	Maximum R position.

real(rprec)	zmin
	Minimum Z position.

real(rprec)	zmax
	Maximum Z position.

real(rprec)	dr
	Radial grid size.

real(rprec)	dz
	Vertical grid size.

integer	nfp
	Number of field periods.

real(rprec), dimension(:,:,:), pointer	a_r => null()
	Vector potential in the R direction.

real(rprec), dimension(:,:,:), pointer	a_p => null()
	Vector potential in the Phi direction.

real(rprec), dimension(:,:,:), pointer	a_z => null()
	Vector potential in the Z direction.

Detailed Description

Base class representing a m grid. This is grid contains information about the vacuum fields.

Interface for the bmw_commandline_parser constructor.

Member Function/Subroutine Documentation

procedure, pass m_grid::m_grid_class::interpolate	(	class (m_grid_class), intent(in)	this,
		real (rprec), intent(in)	r,
		real (rprec), intent(in)	phi,
		real (rprec), intent(in)	z,
		real (rprec), intent(out)	ar,
		real (rprec), intent(out)	ap,
		real (rprec), intent(out)	az
	)

Interpolate the vector potential at a point.

This interpolates the vector potential to from the mgrid grid to an arbitrary point. This performs a trilinear interpolation.

Parameters

[in]	this	A m_grid_class instance.
[in]	r	Radial position to interpolate to.
[in]	phi	Phi position to interpolate to.
[in]	z	Vertical position to interpolate to.
[out]	ar	Interpolated radial component of the vector potential.
[out]	ap	Interpolated phi component of the vector potential.
[out]	az	Interpolated vertial component of the vector potential.

class (m_grid_class) function, pointer m_grid::m_grid_class::m_grid_construct	(	character (len=*), intent(in)	mgrid_file_name,
		class (bmw_parallel_context_class), intent(in)	parallel,
		integer, intent(in)	io_unit,
		class (vmec_file_class), intent(in), pointer	vmec
	)

Construct a m_grid_class object.

Allocates memory and initializes a m_grid_class object with an mgrid file.

Parameters

[in]	mgrid_file_name	File name for vacuum fields.
[in]	parallel	bmw_parallel_context_class object instance.
[in]	io_unit	Unit number to write messages to.
[in]	vmec	The vmec file object.

class (m_grid_class) function, pointer m_grid::m_grid_class::m_grid_construct_plasma	(	integer, intent(in)	num_r,
		integer, intent(in)	num_p,
		integer, intent(in)	num_z,
		real (rprec), intent(in)	rmax,
		real (rprec), intent(in)	rmin,
		real (rprec), intent(in)	zmax,
		real (rprec), intent(in)	zmin,
		class (bmw_parallel_context_class), intent(in)	parallel,
		integer, intent(in)	io_unit,
		class (vmec_file_class), intent(in), pointer	vmec
	)

Construct a m_grid_class object.

Allocates memory and initializes a m_grid_class for plasma only responce on a manual grid.

Parameters

[in]	num_r	Number of radial points.
[in]	num_p	Number of toroidal points.
[in]	num_z	Number of vertical points.
[in]	rmax	Maximum radial position.
[in]	rmin	Minimum radial position.
[in]	zmax	Maximum vertical position.
[in]	zmin	Minimum vertical position.
[in]	parallel	bmw_parallel_context_class object instance.
[in]	io_unit	Unit number to write messages to.
[in]	vmec	The vmec file object.

FINAL m_grid::m_grid_class::m_grid_destruct ( type (m_grid_class), intent(inout) this )

final

Deconstruct a m_grid_class object.

Deallocates memory and uninitializes a m_grid_class object.

Parameters

[in,out] this A m_grid_class instance.

The documentation for this interface was generated from the following file: