Stellarator-Tools
vmec_file Module Reference

Defines the base class of the type vmec_file_class. This contains the output of a vmec equilibrium. More...

Data Types

interface  vmec_file_class
 Base class representing a vmec output. More...
 

Functions/Subroutines

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

Detailed Description

Defines the base class of the type vmec_file_class. This contains the output of a vmec equilibrium.

Function/Subroutine Documentation

◆ vmec_file_construct()

class (vmec_file_class) function, pointer vmec_file::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()

subroutine vmec_file::vmec_file_destruct ( type (vmec_file_class), intent(inout)  this)

Deconstruct a vmec_file_class object.

Deallocates memory and uninitializes a vmec_file_class object.

Parameters
[in,out]thisA vmec_file_class instance.