siesta_equilibrium::siesta_get_sxrem Interface Reference

Interface for the siesta soft x-ray emission profile values. More...

Public Member Functions
real(rprec) function	siesta_get_sxrem_cart (this, x_cart, index)
	Gets the soft x-ray emissivity at a cartesian position. More...
real(rprec) function	siesta_get_sxrem_radial (this, s, index)
	Gets the soft x-ray emissivity at a s, u=0, v=0 position. More...

Detailed Description

Interface for the siesta soft x-ray emission profile values.

Definition at line 329 of file siesta_equilibrium.f.

Member Function/Subroutine Documentation

siesta_get_sxrem_cart()

real (rprec) function siesta_equilibrium::siesta_get_sxrem::siesta_get_sxrem_cart	(	type (siesta_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 overrides equilibrium::equilibrium_get_sxrem. If no soft x-ray emissivity profile was created, return zero. Soft x-ray emissivity is defined by a mapping function of the pressure.

Parameters

[in]	this	A siesta_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.

Returns

The soft x-ray emissivity at x_cart.

Definition at line 2742 of file siesta_equilibrium.f.

siesta_get_sxrem_radial()

real (rprec) function siesta_equilibrium::siesta_get_sxrem::siesta_get_sxrem_radial	(	type (siesta_class), intent(in)	this,
		real (rprec), intent(in)	s,
		integer, intent(in)	index
	)

Gets the soft x-ray emissivity at a s, u=0, v=0 position.

This method overrides equilibrium::equilibrium_get_sxrem. If no soft x-ray emissivity profile was created, return zero. Soft x-ray emissivity is defined by a mapping function of the pressure.

Parameters

[in]	this	A siesta_class instance.
[in]	s	Radial position to get the electron density at.
[in]	index	Index of the soft x-ray emissivity profile.

Returns

The soft x-ray emissivity at s, u=0, v=0.

Definition at line 2783 of file siesta_equilibrium.f.

---

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

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