Interface for the equilibrium density profile values. More...

Public Member Functions
real(rprec) function	equilibrium_get_ne_cart (this, x_cart)
	Gets the electron density at a cartesian position. More...

real(rprec) function	equilibrium_get_ne_radial (this, r)
	Gets the electron density at a radial position. More...

Detailed Description

Interface for the equilibrium density profile values.

Definition at line 91 of file equilibrium.f.

Member Function/Subroutine Documentation

real (rprec) function equilibrium::equilibrium_get_ne::equilibrium_get_ne_cart	(	type (equilibrium_class), intent(in)	this,
		real (rprec), dimension(3), intent(in)	x_cart
	)

Gets the electron density at a cartesian position.

This method is virtual. The actual getting of the electron density should be handled by a subclass method.

Parameters

[in]	this	A equilibrium_class instance.
[in]	x_cart	Cartesian position to get the electron density at.

Note: Note the electron density is not relevant to all equilibrium types. For instance, vacuum equilibrium should not override this method.

Definition at line 931 of file equilibrium.f.

real (rprec) function equilibrium::equilibrium_get_ne::equilibrium_get_ne_radial	(	type (equilibrium_class), intent(in)	this,
		real (rprec), intent(in)	r
	)

Gets the electron density at a radial position.

This method is virtual. The actual getting of the electron density should be handled by a subclass method.

Parameters

[in]	this	A equilibrium_class instance.
[in]	r	Radial position to get the electron density at.

Note: Note the electron density is not relevant to all equilibrium types. For instance, vacuum equilibrium should not override this method.

Definition at line 978 of file equilibrium.f.

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