Base class representing a bmw context. This contains all memory needed to operate bmw. More...

Public Member Functions
PROCEDURE, pass	set_up_grid_m => bmw_context_set_up_grid_m

PROCEDURE, pass	set_up_grid_a => bmw_context_set_up_grid_a

PROCEDURE, pass	set_up_grid_c => bmw_context_set_up_grid_c

GENERIC	set_up_grid => set_up_grid_m, set_up_grid_a, set_up_grid_c

PROCEDURE, pass	write => bmw_context_write

FINAL	bmw_context_destruct

class(bmw_context_class) function, pointer	bmw_context_construct (mgrid_file_name, wout_file_name, siesta_file_name, flags, num_p, parallel, io_unit)
	Construct a bmw_context_class object. More...

class(bmw_context_class) function, pointer	bmw_context_construct_plasma (wout_file_name, siesta_file_name, flags, num_r, num_p, num_z, rmax, rmin, zmax, zmin, parallel, io_unit)
	Construct a bmw_context_class object. More...

Public Attributes
class(vmec_file_class), pointer	vmec => null()
	VMEC equilibrium object.

class(m_grid_class), pointer	m_grid => null()
	Vacuum grid object.

class(primed_grid_class), pointer	p_grid => null()
	Primed grid object.

class(unprimed_grid_class), pointer	up_grid => null()
	Unprimed grid object.

Detailed Description

Base class representing a bmw context. This contains all memory needed to operate bmw.

Interface for the bmw_context constructor.

Member Function/Subroutine Documentation

class (bmw_context_class) function, pointer bmw_context::bmw_context_class::bmw_context_construct	(	character (len=*), intent(in)	mgrid_file_name,
		character (len=*), intent(in)	wout_file_name,
		character (len=*), intent(in)	siesta_file_name,
		integer, intent(in)	flags,
		integer, intent(inout)	num_p,
		class (bmw_parallel_context_class), intent(in)	parallel,
		integer, intent(in)	io_unit
	)

Construct a bmw_context_class object.

Allocates memory and initializes a bmw_context_class object.

Parameters

[in]	mgrid_file_name	Path and name of the mgrid file.
[in]	wout_file_name	Path and name of the wout file.
[in]	siesta_file_name	Path and name of the siesta file.
[in]	flags	Option flags.
[in]	num_p	Number of phi planes per field period.
[in]	parallel	bmw_parallel_context_class object instance.
[in]	io_unit	Unit number to write messages to.

class (bmw_context_class) function, pointer bmw_context::bmw_context_class::bmw_context_construct_plasma	(	character (len=*), intent(in)	wout_file_name,
		character (len=*), intent(in)	siesta_file_name,
		integer, intent(in)	flags,
		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
	)

Construct a bmw_context_class object.

Allocates memory and initializes a bmw_context_class object.

Parameters

[in]	mgrid_file_name	Path and name of the mgrid file.
[in]	wout_file_name	Path and name of the wout file.
[in]	siesta_file_name	Path and name of the siesta file.
[in]	flags	Option flags.
[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.

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