Stellarator-Tools
equilibrium::equilibrium_construct Interface Reference

Interface for the construction of equilibrium_class types using equilibrium_construct_vmec, equilibrium_construct_vacuum or equilibrium_construct_siesta. More...

Public Member Functions

type(equilibrium_class) function, pointer equilibrium_construct (force_solve)
 Construct a equilibrium_class. More...
 

Detailed Description

Interface for the construction of equilibrium_class types using equilibrium_construct_vmec, equilibrium_construct_vacuum or equilibrium_construct_siesta.

Constructor & Destructor Documentation

◆ equilibrium_construct()

type (equilibrium_class) function, pointer equilibrium::equilibrium_construct::equilibrium_construct ( logical, intent(in)  force_solve)

Construct a equilibrium_class.

Allocates memory for a equilibrium_class object.

Parameters
[in]vmec_objectAn instance of a vmec_equilibrium subclass.
[in]force_solveIf true, forces the equilbirum to resolve every time.
Returns
A pointer to a constructed equilibrium_class object.

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