Stellarator-Tools
primed_grid::primed_grid_class Interface Reference

Base class representing a primed grid. This is grid the volume integral will be summed over. More...

Public Member Functions

FINAL primed_grid_destruct
 
type(primed_grid_class) function, pointer primed_grid_construct (num_v, flags, vmec, vmec_vac_file, siesta_file_name, parallel, io_unit)
 Construct a primed_grid_class object. More...
 
type(primed_grid_class) function, pointer primed_grid_construct_no_vac (num_v, flags, vmec, siesta_file_name, parallel, io_unit)
 Construct a primed_grid_class object. More...
 

Public Attributes

real(rprec) dvol
 Volume integration element.
 
real(rprec) dv
 Toroidal grid spacing.
 
real(rprec), dimension(:,:,:), pointer x => null()
 X position.
 
real(rprec), dimension(:,:,:), pointer y => null()
 Y position.
 
real(rprec), dimension(:,:,:), pointer z => null()
 Z position.
 
real(rprec), dimension(:,:,:), pointer j_x => null()
 Current density in the X direction.
 
real(rprec), dimension(:,:,:), pointer j_y => null()
 Current density in the Y direction.
 
real(rprec), dimension(:,:,:), pointer j_z => null()
 Current density in the Z direction.
 

Detailed Description

Base class representing a primed grid. This is grid the volume integral will be summed over.

Interface for the bmw_commandline_parser constructor.

Member Function/Subroutine Documentation

◆ primed_grid_construct()

type (primed_grid_class) function, pointer primed_grid::primed_grid_class::primed_grid_construct ( integer, intent(in)  num_v,
integer, intent(in)  flags,
class (vmec_file_class), intent(in), pointer  vmec,
character (len=*), intent(in)  vmec_vac_file,
character (len=*), intent(in)  siesta_file_name,
type (bmw_parallel_context_class), intent(in)  parallel,
integer, intent(in)  io_unit 
)

Construct a primed_grid_class object.

Allocates memory and initializes a primed_grid_class object depending on the option flags.

Parameters
[in]num_vNumber of toroidal grid points.
[in]flagsNumber of toroidal grid points.
[in]vmecVMEC file object.
[in]vmec_vac_fileName of the zero beta vmec file.
[in]siesta_file_nameName of the siesta restart file.
[in]parallelbmw_parallel_context_class object instance.
[in]io_unitUnit number to write messages to.
Returns
A pointer to a constructed primed_grid_class object.

◆ primed_grid_construct_no_vac()

type (primed_grid_class) function, pointer primed_grid::primed_grid_class::primed_grid_construct_no_vac ( integer, intent(in)  num_v,
integer, intent(in)  flags,
class (vmec_file_class), intent(in), pointer  vmec,
character (len=*), intent(in)  siesta_file_name,
type (bmw_parallel_context_class), intent(in)  parallel,
integer, intent(in)  io_unit 
)

Construct a primed_grid_class object.

Allocates memory and initializes a primed_grid_class object depending on the option flags.

Parameters
[in]num_vNumber of toroidal grid points.
[in]flagsNumber of toroidal grid points.
[in]vmecVMEC file object.
[in]siesta_file_nameName of the siesta restart file.
[in]parallelbmw_parallel_context_class object instance.
[in]io_unitUnit number to write messages to.
Returns
A pointer to a constructed primed_grid_class object.

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