equilibrium::equilibrium_set_magnetic_cache Interface Reference

Interface for the equilibrium set magnetic cache. More...

Public Member Functions
subroutine	equilibrium_set_magnetic_cache_response (this, response_object, state_flags)
	Sets the magnetic cache of the equilibrium for the magnetic responce. More...
subroutine	equilibrium_set_magnetic_cache_point (this, use_axi, state_flags)
	Sets the magnetic cache of the equilibrium for points. More...

Detailed Description

Interface for the equilibrium set magnetic cache.

Definition at line 83 of file equilibrium.f.

Member Function/Subroutine Documentation

equilibrium_set_magnetic_cache_point()

subroutine equilibrium::equilibrium_set_magnetic_cache::equilibrium_set_magnetic_cache_point	(	type (equilibrium_class), intent(inout)	this,
		logical, intent(in)	use_axi,
		integer, intent(in)	state_flags
	)

Sets the magnetic cache of the equilibrium for points.

This method is virtual. The actual setting of the magnetic cache should be handled a subclass method. The magnetic cache is any pre compuation that needs to be performed so that magnetic signals may compute a modeled signal. If the equilibrium does not require any information to be cached, this method does not need to be overridden. This method is meant to only be called once to tell the equilibrium it needs to use a magnetic cache.

See also

vmec_equilibrium::vmec_set_magnetic_cache

siesta_equilibrium::siesta_set_magnetic_cache

Parameters

[in,out]	this	A equilibrium_class instance.
[in]	use_axi	Magnetics can subtract off axisymmetric components.
[in]	state_flags	Bitwise flags to indicate which parts of the model changed.

Definition at line 475 of file equilibrium.f.

equilibrium_set_magnetic_cache_response()

subroutine equilibrium::equilibrium_set_magnetic_cache::equilibrium_set_magnetic_cache_response	(	type (equilibrium_class), intent(inout)	this,
		type (magnetic_response_class), intent(in)	response_object,
		integer, intent(in)	state_flags
	)

Sets the magnetic cache of the equilibrium for the magnetic responce.

This method is virtual. The actual setting of the magnetic cache should be handled a subclass method. The magnetic cache is any pre compuation that needs to be performed so that magnetic signals may compute a modeled signal. If the equilibrium does not require any information to be cached, this method does not need to be overridden. This method is meant to only be called once to tell the equilibrium it needs to use a magnetic cache.

See also

vmec_equilibrium::vmec_set_magnetic_cache

siesta_equilibrium::siesta_set_magnetic_cache

Parameters

[in,out]	this	A equilibrium_class instance.
[in]	response_object	A magnetic_response::magnetic_response_class instance.
[in]	state_flags	Bitwise flags to indicate which parts of the model changed.

Definition at line 414 of file equilibrium.f.

---

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

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