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_vmec (vmec_object, force_solve)
	Construct a equilibrium_class containing a vmec_equilibrium object. More...
type(equilibrium_class) function, pointer	equilibrium_construct_vacuum (vacuum_object, force_solve)
	Construct a equilibrium_class containing a vacuum_equilibrium object. More...
type(equilibrium_class) function, pointer	equilibrium_construct_siesta (siesta_object, force_solve)
	Construct a equilibrium_class containing a siesta_equilibrium object. More...

Detailed Description

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

Definition at line 74 of file equilibrium.f.

Member Function/Subroutine Documentation

equilibrium_construct_siesta()

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

Construct a equilibrium_class containing a siesta_equilibrium object.

Allocates memory and initializes a equilibrium_class object.

Parameters

[in]	siesta_object	An instance of a siesta_equilibrium subclass.
[in]	force_solve	If true, forces the equilbirum to resolve every time.

Returns

A pointer to a constructed equilibrium_class object.

Definition at line 264 of file equilibrium.f.

equilibrium_construct_vacuum()

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

Construct a equilibrium_class containing a vacuum_equilibrium object.

Allocates memory and initializes a equilibrium_class object.

Parameters

[in]	vacuum_object	An instance of a vacuum_equilibrium subclass.
[in]	force_solve	If true, forces the equilbirum to resolve every time.

Returns

A pointer to a constructed equilibrium_class object.

Definition at line 227 of file equilibrium.f.

equilibrium_construct_vmec()

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

Construct a equilibrium_class containing a vmec_equilibrium object.

Allocates memory and initializes a equilibrium_class object.

Parameters

[in]	vmec_object	An instance of a vmec_equilibrium subclass.
[in]	force_solve	If true, forces the equilbirum to resolve every time.

Returns

A pointer to a constructed equilibrium_class object.

Definition at line 190 of file equilibrium.f.

---

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

• /Users/m4c/repo/trunk/V3FITA/Sources/equilibrium.f