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

Data Types
interface	ece_class
	Base class representing an ECE signal. More...

type	ece_context
	Structure to hold all memory needed to be sent to the callback function. More...

Functions/Subroutines
class(ece_class) function, pointer	ece_construct (start_path, end_path, resonance)
	Construct a ece_class object. More...

subroutine	ece_destruct (this)
	Deconstruct a ece_class object. More...

real(rprec) function, dimension(4)	ece_get_modeled_signal (this, a_model, sigma, last_value)
	Calculates the modeled signal. More...

real(rprec) function, dimension(3)	ece_get_cart (this, a_model, found)
	Calculates the signal measurement point. More...

character(len=data_name_length) function	ece_get_type (this)
	Gets a discription of the ece type. More...

subroutine	ece_get_header (this, header)
	Gets a discription of the model and model sigma array indices. More...

real(rprec) function	ece_get_gp_i (this, a_model, i, flags)
	Gets the guassian process kernel for an ece signal and a position. More...

real(rprec) function	ece_get_gp_s (this, a_model, signal, flags)
	Gets the guassian process kernel for a ece signal and a signal. More...

real(rprec) function	ece_get_gp_x (this, a_model, x_cart, flags)
	Gets the guassian process kernel for an ece signal and a cartesian position. More...

logical function, private	ece_function (context, xcart1, xcart2)
	ECE callback function. More...

pure logical function, private	is_in_range (xp, x1, x2)
	Check if values is in range. More...

Detailed Description

Defines the base class of the type ece_class.

Super Class:: diagnostic

Function/Subroutine Documentation

◆ ece_construct()

class (ece_class) function, pointer ece::ece_construct	(	real (rprec), dimension(3), intent(in)	start_path,
		real (rprec), dimension(3), intent(in)	end_path,
		real (rprec), intent(in)	resonance
	)

Construct a ece_class object.

Allocates memory and initializes a ece_class object.

Parameters

[in]	start_path	Starting point of an ece chord.
[in]	end_path	Ending point of an ece chord.
[in]	resonance	Geometric factor of the chord.

Returns: A pointer to a constructed ece_class object.

Definition at line 87 of file ece.f.

◆ ece_destruct()

subroutine ece::ece_destruct ( type (ece_class), intent(inout) this )

Deconstruct a ece_class object.

Deallocates memory and uninitializes a ece_class object.

Parameters

[in,out] this A ece_class instance.

Definition at line 124 of file ece.f.

◆ ece_function()

logical function, private ece::ece_function	(	character (len=1), dimension(:), intent(in)	context,
		real (rprec), dimension(3), intent(in)	xcart1,
		real (rprec), dimension(3), intent(in)	xcart2
	)

private

ECE callback function.

Returns true if the magnetic field resonance if found with in a specified range.

See also: integration_path

Parameters

[in]	context	A ece_context for the model.
[in]	xcart1	The upper search point.
[in]	xcart2	The lower search point.

Returns: True if the resonace was found.

Definition at line 466 of file ece.f.

◆ ece_get_cart()

real (rprec) function, dimension(3) ece::ece_get_cart	(	class (ece_class), intent(in)	this,
		type (model_class), pointer	a_model,
		logical, intent(out)	found
	)

Calculates the signal measurement point.

Calculates the ECE measurement point by searching along the chord for the resonance. The search criteria is provided by the ece_function.

Parameters

[in]	this	A ece_class instance.
[in]	a_model	A model instance.
[out]	found	Flag to indicate if the resonance was found.

Returns: Position in cartesian coordinates of the resonance.

Definition at line 209 of file ece.f.

◆ ece_get_gp_i()

real (rprec) function ece::ece_get_gp_i	(	class (ece_class), intent(in)	this,
		type (model_class), pointer	a_model,
		integer, intent(in)	i,
		integer, intent(in)	flags
	)

Gets the guassian process kernel for an ece signal and a position.

Calculates the guassian process kernel between the signal and the position. Temperature kernels are provided by model::model_get_gp_te.

Parameters

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

Definition at line 327 of file ece.f.

◆ ece_get_gp_s()

real (rprec) function ece::ece_get_gp_s	(	class (ece_class), intent(in)	this,
		type (model_class), pointer	a_model,
		class (signal_class), pointer	signal,
		integer, intent(in)	flags
	)

Gets the guassian process kernel for a ece signal and a signal.

Calculates the guassian process kernel between the signal and a signal. Calls back to the signal module to call the other signal.

Parameters

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

Definition at line 371 of file ece.f.

◆ ece_get_gp_x()

real (rprec) function ece::ece_get_gp_x	(	class (ece_class), intent(in)	this,
		type (model_class), pointer	a_model,
		real (rprec), dimension(3), intent(in)	x_cart,
		integer, intent(in)	flags
	)

Gets the guassian process kernel for an ece signal and a cartesian position.

Calculates the guassian process kernel between the signal and the position. Temperature kernels are provided by model::model_get_gp_te. This is the second signal so x_cart goes in the second position and this signal in the second.

Parameters

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

Definition at line 418 of file ece.f.

◆ ece_get_header()

subroutine ece::ece_get_header	(	class (ece_class), intent(in)	this,
		character (len=data_name_length), dimension(7), intent(inout)	header
	)

Gets a discription of the model and model sigma array indices.

Returns a description of the array indices for use when writting output files.

Parameters

[in]	this	A ece_class instance.
[in,out]	header	Buffer arrays to write header strings to.

Returns: A string describing the model and model sigma array indices.

Definition at line 286 of file ece.f.

◆ ece_get_modeled_signal()

real (rprec) function, dimension(4) ece::ece_get_modeled_signal	(	class (ece_class), intent(inout)	this,
		type (model_class), pointer	a_model,
		real (rprec), dimension(4), intent(out)	sigma,
		real (rprec), dimension(4), intent(in)	last_value
	)

Calculates the modeled signal.

Calculates the ECE signal by searching along the chord for the resonance. The search criteria is provided by the ece_function.

Parameters

[in,out]	this	A ece_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.

Definition at line 154 of file ece.f.

◆ ece_get_type()

character (len=data_name_length) function ece::ece_get_type ( class (ece_class), intent(in) this )

Gets a discription of the ece type.

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

Parameters

[in] this A ece_class instance.

Returns: A string describing the ece type.

Definition at line 255 of file ece.f.

◆ is_in_range()

pure logical function, private ece::is_in_range	(	real(rprec), intent(in)	xp,
		real(rprec), intent(in)	x1,
		real(rprec), intent(in)	x2
	)

private

Check if values is in range.

Returns true the value if x_low <= xp <= x_high

Parameters

[in]	xp	Value to see if it is in range.
[in]	x1	First bounding point to check.
[in]	x2	Second bounding point to check.

Returns: True if the resonace was found.

Definition at line 520 of file ece.f.

Data Types

Functions/Subroutines

Detailed Description

Function/Subroutine Documentation

◆ ece_construct()

◆ ece_destruct()

◆ ece_function()

◆ ece_get_cart()

◆ ece_get_gp_i()

◆ ece_get_gp_s()

◆ ece_get_gp_x()

◆ ece_get_header()

◆ ece_get_modeled_signal()

◆ ece_get_type()

◆ is_in_range()