vmec_context::vmec_context_class Type Reference

Base class representing a vmec_context. This contains a copy of every variable that is needed to define the VMEC state. More...

Public Member Functions
FINAL	vmec_context_destruct (this)
	Deconstruct a vmec_context_class object.
procedure	set_context (this)
	Sets the current context to the vmec_context_class object.
procedure	get_context (this)
	Gets the current context from the VMEC internal state.
procedure	sync_state (this, recon_comm)
	Syncronize the vmec_context to children.
procedure	sync_child (this, index, recon_comm)
	Syncronize a child vmec_context to the parent.

Public Attributes
real(rprec), dimension(:), pointer	xc => null()
	Cache of the vmec internal state xc array.
real(rprec), dimension(:), pointer	raxis_cc => null()
	Cache of the magnetic axis R cosine coefficents.
real(rprec), dimension(:), pointer	raxis_cs => null()
	Cache of the magnetic axis R sine coefficents.
real(rprec), dimension(:), pointer	zaxis_cc => null()
	Cache of the magnetic axis Z cosine coefficents.
real(rprec), dimension(:), pointer	zaxis_cs => null()
	Cache of the magnetic axis Z sine coefficents.
real(rprec), dimension(:,:), pointer	rbc => null()
	Cache of the equilibrium boundary R cosine coefficents.
real(rprec), dimension(:,:), pointer	rbs => null()
	Cache of the equilibrium boundary R sine coefficents.
real(rprec), dimension(:,:), pointer	zbc => null()
	Cache of the equilibrium boundary Z cosine coefficents.
real(rprec), dimension(:,:), pointer	zbs => null()
	Cache of the equilibrium boundary Z sine coefficents.
real(rprec)	vvc_smaleli
	Internal inductance.
real(rprec)	vvc_kappa_p
	Mean elongation.

Detailed Description

Base class representing a vmec_context. This contains a copy of every variable that is needed to define the VMEC state.

Member Function/Subroutine Documentation

get_context()

procedure vmec_context::vmec_context_class::get_context

(

class (vmec_context_class), intent(inout)

this

)

Gets the current context from the VMEC internal state.

Copy the internal vmec state to the context object.

Parameters

[in,out]

this

A vmec_context_class instance.

set_context()

procedure vmec_context::vmec_context_class::set_context

(

class (vmec_context_class), intent(in)

this

)

Sets the current context to the vmec_context_class object.

This sets this context to be the VMEC state.

Parameters

[in]

this

A vmec_context_class instance.

sync_child()

procedure vmec_context::vmec_context_class::sync_child	(	class (vmec_context_class), intent(inout)	this,
		integer, intent(in)	index,
		integer, intent(in)	recon_comm
	)

Syncronize a child vmec_context to the parent.

Syncs data between a child and the parent process. If MPI support is not compiled in this subroutine reduces to a no op. This syncs the VMEC variables directly.

Parameters

[in,out]	this	A vmec_context_class instance.
[in]	index	Reconstruction rank to sync.
[in]	recon_comm	MPI communicator for the reconstruction processes.

sync_state()

procedure vmec_context::vmec_context_class::sync_state	(	class (vmec_context_class), intent(inout)	this,
		integer, intent(in)	recon_comm
	)

Syncronize the vmec_context to children.

Syncs data between the parent and child processes. If MPI support is not compiled in this subroutine reduces to a no op. This syncs the VMEC variables directly.

Parameters

[in,out]	this	A vmec_context_class instance.
[in]	recon_comm	MPI communicator for the reconstruction processes.

vmec_context_destruct()

FINAL vmec_context::vmec_context_class::vmec_context_destruct ( type (vmec_context_class), intent(inout)  this )

final

Deconstruct a vmec_context_class object.

Deallocates memory and uninitializes a vmec_context_class object.

Parameters

[in,out]

this

A vmec_context_class instance.

---

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

• V3FIT/Sources/vmec_context.f