Interface for the equilibrium soft x-ray emissivity profile values. More...

Public Member Functions
real(rprec) function	equilibrium_get_sxrem_cart (this, x_cart, index)
	Gets the soft x-ray emissivity at a cartesian position. More...

real(rprec) function	equilibrium_get_sxrem_radial (this, r, index)
	Gets the soft x-ray emissivity at a radial position. More...

Detailed Description

Interface for the equilibrium soft x-ray emissivity profile values.

Definition at line 152 of file equilibrium.f.

Member Function/Subroutine Documentation

real (rprec) function equilibrium::equilibrium_get_sxrem::equilibrium_get_sxrem_cart	(	type (equilibrium_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart,
		integer, intent(in)	index
	)

Gets the soft x-ray emissivity at a cartesian position.

This method is virtual. The actual getting of the soft x-ray emissivity should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_sxrem; siesta_equilibrium::siesta_get_sxrem

Parameters

[in]	this	A equilibrium_class instance.
[in]	x_cart	Cartesian position to get the soft x-ray emissivity at.
[in]	index	Index of the soft x-ray emissivity profile to use.

Note: Note the soft x-ray emissivity is not relevant to all equilibrium types. For instance, vacuum equilibrium should not override this method.

Definition at line 2041 of file equilibrium.f.

real (rprec) function equilibrium::equilibrium_get_sxrem::equilibrium_get_sxrem_radial	(	type (equilibrium_class), intent(in)	this,
		real (rprec), intent(in)	r,
		integer, intent(in)	index
	)

Gets the soft x-ray emissivity at a radial position.

This method is virtual. The actual getting of the soft x-ray emissivity should be handled by a subclass method.

See also: vmec_equilibrium::vmec_get_sxrem; siesta_equilibrium::siesta_get_sxrem

Parameters

[in]	this	A equilibrium_class instance.
[in]	r	Cartesian position to get the soft x-ray emissivity at.
[in]	index	Index of the soft x-ray emissivity profile to use.

Note: Note the soft x-ray emissivity is not relevant to all equilibrium types. For instance, vacuum equilibrium should not override this method.

Definition at line 2092 of file equilibrium.f.

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