sxrem Module Reference

Defines the base class of the type sxrem_class. More...

Data Types
type	sxrem_class
	Base class representing a soft x-ray signal. More...
interface	sxrem_emiss_class
	Base class representing a soft x-ray emissivity signal. More...
interface	sxrem_ti_class
	Base class representing a soft x-ray ti signal. More...
type	sxrem_context
	Structure to hold all memory needed to be sent to the callback function. More...
type	sxrem_ti_context
	Structure to hold all memory needed to be sent to the callback function. More...
type	sxrem_gp_context_i
	Structure to hold all memory needed to be sent to the guassian process callback function for point. More...
type	sxrem_gp_ti_context_i
	Structure to hold all memory needed to be sent to the guassian process callback function for point. More...
type	sxrem_gp_context_s
	Structure to hold all memory needed to be sent to the guassian process callback function for signal. More...
type	sxrem_gp_ti_context_s
	Structure to hold all memory needed to be sent to the guassian process callback function for signal. More...
type	sxrem_gp_context_x
	Structure to hold all memory needed to be sent to the guassian process callback function for signal. More...
type	sxrem_gp_ti_context_x
	Structure to hold all memory needed to be sent to the guassian process callback function for signal. More...

Functions/Subroutines
class(sxrem_emiss_class) function, pointer	sxrem_emiss_construct (start_path, end_path, geo, profile_number)
	Construct a sxrem_class object for emission. More...
class(sxrem_ti_class) function, pointer	sxrem_ti_construct (start_path, end_path, profile_number)
	Construct a sxrem_class object for ti. More...
subroutine	sxrem_destruct (this)
	Deconstruct a sxrem_class object. More...
subroutine	sxrem_emiss_destruct (this)
	Deconstruct a sxrem_emiss_class object. More...
real(rprec) function, dimension(4)	sxrem_emiss_get_modeled_signal (this, a_model, sigma, last_value)
	Calculates the modeled emiss signal. More...
real(rprec) function, dimension(4)	sxrem_ti_get_modeled_signal (this, a_model, sigma, last_value)
	Calculates the modeled ion temperature signal. More...
character(len=data_name_length) function	sxrem_emiss_get_type (this)
	Gets a discription of the sxrem emiss type. More...
character(len=data_name_length) function	sxrem_ti_get_type (this)
	Gets a discription of the sxrem emiss type. More...
real(rprec) function	sxrem_emiss_get_gp_i (this, a_model, i, flags)
	Gets the guassian process kernel for a sxrem emiss signal and a position. More...
real(rprec) function	sxrem_ti_get_gp_i (this, a_model, i, flags)
	Gets the guassian process kernel for a sxrem ti signal and a position. More...
real(rprec) function	sxrem_emiss_get_gp_s (this, a_model, signal, flags)
	Gets the guassian process kernel for a sxrem emiss signal and a signal. More...
real(rprec) function	sxrem_ti_get_gp_s (this, a_model, signal, flags)
	Gets the guassian process kernel for a sxrem ti signal and a signal. More...
real(rprec) function	sxrem_emiss_get_gp_x (this, a_model, x_cart, flags)
	Gets the guassian process kernel for a sxrem emiss signal and a cartesian position. More...
real(rprec) function	sxrem_ti_get_gp_x (this, a_model, x_cart, flags)
	Gets the guassian process kernel for a sxrem ti signal and a cartesian position. More...

Detailed Description

Defines the base class of the type sxrem_class.

Super Class:

diagnostic

Function/Subroutine Documentation

sxrem_destruct()

subroutine sxrem::sxrem_destruct

(

type (sxrem_class), intent(inout)

this

)

Deconstruct a sxrem_class object.

Deallocates memory and uninitializes a sxrem_class object.

Parameters

[in,out]

this

A sxrem_class instance.

sxrem_emiss_construct()

class (sxrem_emiss_class) function, pointer sxrem::sxrem_emiss_construct	(	real (rprec), dimension(3), intent(in)	start_path,
		real (rprec), dimension(3), intent(in)	end_path,
		real (rprec), intent(in)	geo,
		integer, intent(in)	profile_number
	)

Construct a sxrem_class object for emission.

Allocates memory and initializes a sxrem_class object.

Parameters

[in]	start_path	Starting point of a sxrem chord.
[in]	end_path	Ending point of a sxrem chord.
[in]	geo	Geometric factor of the chord.
[in]	profile_number	Index of the soft x-ray emissivity profile.

Returns

A pointer to a constructed sxrem_class object.

sxrem_emiss_destruct()

subroutine sxrem::sxrem_emiss_destruct

(

type (sxrem_emiss_class), intent(inout)

this

)

Deconstruct a sxrem_emiss_class object.

Deallocates memory and uninitializes a sxrem_emiss_class object.

Parameters

[in,out]

this

A sxrem_emiss_class instance.

sxrem_emiss_get_gp_i()

real (rprec) function sxrem::sxrem_emiss_get_gp_i	(	class (sxrem_emiss_class), intent(in)	this,
		class (model_class), pointer	a_model,
		integer, intent(in)	i,
		integer, intent(in)	flags
	)

Gets the guassian process kernel for a sxrem emiss signal and a position.

Calculates the guassian process kernel between the signal and the position. Integrates the gp_emiss_function_i function.

Parameters

[in]	this	A sxrem_class instance.
[in]	a_model	A model instance.
[in]	i	Index of the position for the kernel.
[in]	flags	State flags to send to the kernel.

Returns

Kernel value for the position and the signal.

sxrem_emiss_get_gp_s()

real (rprec) function sxrem::sxrem_emiss_get_gp_s	(	class (sxrem_emiss_class), intent(in)	this,
		class (model_class), pointer	a_model,
		class (signal_class), pointer	signal,
		integer, intent(in)	flags
	)

Gets the guassian process kernel for a sxrem emiss signal and a signal.

Calculates the guassian process kernel between the signal and a signal. This is the first signal.

Parameters

[in]	this	A sxrem_emiss_class instance.
[in]	a_model	A model instance.
[in]	signal	A signal_class instance for the second signal.
[in]	flags	State flags to send to the kernel.

Returns

Kernel value for the signal and the signal.

sxrem_emiss_get_gp_x()

real (rprec) function sxrem::sxrem_emiss_get_gp_x	(	class (sxrem_emiss_class), intent(in)	this,
		class (model_class), pointer	a_model,
		real (rprec), dimension(3), intent(in)	x_cart,
		integer, intent(in)	flags
	)

Gets the guassian process kernel for a sxrem emiss signal and a cartesian position.

Calculates the guassian process kernel between the signal and the position. This is the second signal.

Parameters

[in]	this	A sxrem_emiss_class instance.
[in]	a_model	A model instance.
[in]	x_cart	The cartesian position of to get the kernel at.
[in]	flags	State flags to send to the kernel.

Returns

Kernel value for the signal and the signal.

sxrem_emiss_get_modeled_signal()

real (rprec) function, dimension(4) sxrem::sxrem_emiss_get_modeled_signal	(	class (sxrem_emiss_class), intent(inout)	this,
		class (model_class), pointer	a_model,
		real (rprec), dimension(4), intent(out)	sigma,
		real (rprec), dimension(4), intent(in)	last_value
	)

Calculates the modeled emiss signal.

Calculates the soft x-ray emissivity signal by integrating along the chord path. The emissivity is provided by the sxr_function.

Parameters

[in,out]	this	A sxrem_emiss_class instance.
[in]	a_model	A model instance.
[out]	sigma	The modeled sigma.
[in]	last_value	Last good value in case the signal did not change.

Returns

The model value.

sxrem_emiss_get_type()

character (len=data_name_length) function sxrem::sxrem_emiss_get_type

(

class (sxrem_emiss_class), intent(in)

this

)

Gets a discription of the sxrem emiss type.

Returns a description of the sxrem type for use when writting output files.

Parameters

[in]

this

A sxrem_emiss_class instance.

Returns

A string describing the sxrem type.

sxrem_ti_construct()

class (sxrem_ti_class) function, pointer sxrem::sxrem_ti_construct	(	real (rprec), dimension(3), intent(in)	start_path,
		real (rprec), dimension(3), intent(in)	end_path,
		integer, intent(in)	profile_number
	)

Construct a sxrem_class object for ti.

Allocates memory and initializes a sxrem_class object.

Parameters

[in]	start_path	Starting point of a sxrem chord.
[in]	end_path	Ending point of a sxrem chord.
[in]	profile_number	Index of the soft x-ray emissivity profile.

Returns

A pointer to a constructed sxrem_class object.

sxrem_ti_get_gp_i()

real (rprec) function sxrem::sxrem_ti_get_gp_i	(	class (sxrem_ti_class), intent(in)	this,
		class (model_class), pointer	a_model,
		integer, intent(in)	i,
		integer, intent(in)	flags
	)

Gets the guassian process kernel for a sxrem ti signal and a position.

Calculates the guassian process kernel between the signal and the position. Integrates the gp_ti_function_i function.

Parameters

[in]	this	A sxrem_class instance.
[in]	a_model	A model instance.
[in]	i	Index of the position for the kernel.
[in]	flags	State flags to send to the kernel.

Returns

Kernel value for the position and the signal.

sxrem_ti_get_gp_s()

real (rprec) function sxrem::sxrem_ti_get_gp_s	(	class (sxrem_ti_class), intent(in)	this,
		class (model_class), pointer	a_model,
		class (signal_class), pointer	signal,
		integer, intent(in)	flags
	)

Gets the guassian process kernel for a sxrem ti signal and a signal.

Calculates the guassian process kernel between the signal and a signal. This is the first signal.

Parameters

[in]	this	A sxrem_emiss_class instance.
[in]	a_model	A model instance.
[in]	signal	A signal_class instance for the second signal.
[in]	flags	State flags to send to the kernel.

Returns

Kernel value for the signal and the signal.

sxrem_ti_get_gp_x()

real (rprec) function sxrem::sxrem_ti_get_gp_x	(	class (sxrem_ti_class), intent(in)	this,
		class (model_class), pointer	a_model,
		real (rprec), dimension(3), intent(in)	x_cart,
		integer, intent(in)	flags
	)

Gets the guassian process kernel for a sxrem ti signal and a cartesian position.

Calculates the guassian process kernel between the signal and the position. This is the second signal.

Parameters

[in]	this	A sxrem_emiss_class instance.
[in]	a_model	A model instance.
[in]	x_cart	The cartesian position of to get the kernel at.
[in]	flags	State flags to send to the kernel.

Returns

Kernel value for the signal and the signal.

sxrem_ti_get_modeled_signal()

real (rprec) function, dimension(4) sxrem::sxrem_ti_get_modeled_signal	(	class (sxrem_ti_class), intent(inout)	this,
		class (model_class), pointer	a_model,
		real (rprec), dimension(4), intent(out)	sigma,
		real (rprec), dimension(4), intent(in)	last_value
	)

Calculates the modeled ion temperature signal.

Calculates the soft x-ray emissivity/ion temperature signal by integrating along the chord path. The emissivity is provided by the ti_function.

Parameters

[in,out]	this	A sxrem_ti_class instance.
[in]	a_model	A model instance.
[out]	sigma	The modeled sigma.
[in]	last_value	Last good value in case the signal did not change.

Returns

The model value.

sxrem_ti_get_type()

character (len=data_name_length) function sxrem::sxrem_ti_get_type

(

class (sxrem_ti_class), intent(in)

this

)

Gets a discription of the sxrem emiss type.

Returns a description of the sxrem type for use when writting output files.

Parameters

[in]

this

A sxrem_ti_class instance.

Returns

A string describing the sxrem type.