Stellarator-Tools
surface_context::surface_context_class Interface Reference

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

Public Member Functions

PROCEDURE, pass set_vector_potential => surface_context_set_vector_potential
 
PROCEDURE, pass write => surface_context_write
 
FINAL surface_context_destruct
 
class(surface_context_class) function, pointer surface_context_construct (wout_file_name, surface_file_name, parallel, io_unit)
 Construct a surface_context_class object. More...
 

Public Attributes

real(rprec), dimension(:), pointer x
 Array of radial points on the current surface.
 
real(rprec), dimension(:), pointer y
 Array of phi points on the current surface.
 
real(rprec), dimension(:), pointer z
 Array of z points on the current surface.
 
real(rprec), dimension(:), pointer a_x
 Virtual Surface current in the r direction.
 
real(rprec), dimension(:), pointer a_y
 Virtual Surface current in the phi direction.
 
real(rprec), dimension(:), pointer a_z
 Virtual Surface current in the z direction.
 
class(vmec_file_class), pointer vmec => null()
 VMEC equilibrium object.
 

Detailed Description

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

Interface to constructors.

Member Function/Subroutine Documentation

◆ surface_context_construct()

class (surface_context_class) function, pointer surface_context::surface_context_class::surface_context_construct ( character (len=*), intent(in)  wout_file_name,
character (len=*), intent(in)  surface_file_name,
class (bmw_parallel_context_class), intent(in)  parallel,
integer, intent(in)  io_unit 
)

Construct a surface_context_class object.

Allocates memory and initializes a surface_context_class object.

Parameters
[in]wout_file_namePath and name of the wout file.
[in]surface_file_namePath defining the surface to compute fields to.
[in]parallelbmw_parallel_context_class object instance.
[in]io_unitUnit number to write messages to.
Returns
A pointer to a constructed bmw_context_class object.

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