vmec_context Module Reference

Defines the base class of the type vmec_context_class. This contains the state variables needed by VMEC. More...

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

Functions/Subroutines
type(vmec_context_class) function, pointer	vmec_context_construct ()
	Construct a new vmec_context_class object. More...
subroutine	vmec_context_destruct (this)
	Deconstruct a vmec_context_class object. More...
subroutine	vmec_context_set_context (this)
	Sets the current context to the vmec_context_class object. More...
subroutine	vmec_context_get_context (this)
	Gets the current context from the VMEC internal state. More...
subroutine	vmec_context_sync_state (this, recon_comm)
	Syncronize the vmec_context to children. More...
subroutine	vmec_context_sync_child (this, index, recon_comm)
	Syncronize a child vmec_context to the parent. More...

Detailed Description

Defines the base class of the type vmec_context_class. This contains the state variables needed by VMEC.

Function/Subroutine Documentation

vmec_context_construct()

type (vmec_context_class) function, pointer vmec_context::vmec_context_construct

Construct a new vmec_context_class object.

Allocates memory and initializes a vmec_context_class object.

Returns

A pointer to a constructed vmec_context_class object.

Definition at line 63 of file vmec_context.f.

vmec_context_destruct()

subroutine vmec_context::vmec_context_destruct

(

type (vmec_context_class), pointer

this

)

Deconstruct a vmec_context_class object.

Deallocates memory and uninitializes a vmec_context_class object.

Parameters

[in,out]

this

A vmec_context_class instance.

Definition at line 100 of file vmec_context.f.

vmec_context_get_context()

subroutine vmec_context::vmec_context_get_context

(

type (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.

Definition at line 188 of file vmec_context.f.

vmec_context_set_context()

subroutine vmec_context::vmec_context_set_context

(

type (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.

Definition at line 147 of file vmec_context.f.

vmec_context_sync_child()

subroutine vmec_context::vmec_context_sync_child	(	type (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.

Definition at line 287 of file vmec_context.f.

vmec_context_sync_state()

subroutine vmec_context::vmec_context_sync_state	(	type (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.

Definition at line 233 of file vmec_context.f.