Stellarator-Tools
Loading...
Searching...
No Matches
vmec_file::vmec_file_class Interface Reference

Base class representing a vmec output. More...

Public Member Functions

FINAL vmec_file_destruct (this)
 Deconstruct a vmec_file_class object.
class(vmec_file_class) function, pointer vmec_file_construct (vmec_file_name)
 Construct a vmec_file_class object.

Public Attributes

integer ns
integer mnmax
integer isigng
integer nfp
real(rprec), dimension(:), pointer extcur => null()
real(rprec), dimension(:), pointer xm => null()
real(rprec), dimension(:), pointer xn => null()
integer mnmax_nyq
real(rprec), dimension(:), pointer xm_nyq => null()
real(rprec), dimension(:), pointer xn_nyq => null()
logical lasym
real(rprec), dimension(:), pointer presf => null()
real(rprec), dimension(:,:), pointer rmncf => null()
real(rprec), dimension(:,:), pointer zmnsf => null()
real(rprec), dimension(:,:), pointer rmnsf => null()
real(rprec), dimension(:,:), pointer zmncf => null()
real(rprec), dimension(:,:), pointer bsupumnch => null()
real(rprec), dimension(:,:), pointer bsupvmnch => null()
real(rprec), dimension(:,:), pointer bsupumnsh => null()
real(rprec), dimension(:,:), pointer bsupvmnsh => null()
real(rprec), dimension(:,:), pointer jksupumncf => null()
real(rprec), dimension(:,:), pointer jksupvmncf => null()
real(rprec), dimension(:,:), pointer jksupumnsf => null()
real(rprec), dimension(:,:), pointer jksupvmnsf => null()

Detailed Description

Base class representing a vmec output.

Interface for the vmec_file_class constructor.

Member Function/Subroutine Documentation

◆ vmec_file_construct()

class (vmec_file_class) function, pointer vmec_file::vmec_file_class::vmec_file_construct ( character (len=*), intent(in) vmec_file_name)

Construct a vmec_file_class object.

Allocates memory and initializes a vmec_file_class object with an siesta restart file.

Parameters
[in]vmec_file_nameFile name for vacuum fields.
Returns
A pointer to a constructed vmec_file_class object.

◆ vmec_file_destruct()

FINAL vmec_file::vmec_file_class::vmec_file_destruct ( type (vmec_file_class), intent(inout) this)
final

Deconstruct a vmec_file_class object.

Deallocates memory and uninitializes a vmec_file_class object.

Parameters
[in,out]thisA vmec_file_class instance.

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