Base class representing a sxrem_ratio signal. More...

Inheritance diagram for sxrem_ratio::sxrem_ratio_class:

Public Member Functions
procedure	get_modeled_signal_last (this, a_model, sigma, last_value)
	Calculates the modeled signal.

procedure	get_observed_signal (this, a_model)
	Calculates the observed signal.

procedure	get_type (this)
	Gets a discription of the feedback type.

procedure	write_auxiliary (this, iou, index, a_model)
	Write out auxiliary signal information to an output file.

FINAL	sxrem_ratio_destruct (this)
	Deconstruct a sxrem_ratio_class object.

class(sxrem_ratio_class) function, pointer	sxrem_ratio_construct (x_cart, indices)
	Construct a sxrem_ratio_class object.

Public Member Functions inherited from signal::signal_class
procedure	get_modeled_signal_cache (this, a_model, sigma, use_cache, last_value)
	Calculates the modeled signal.

procedure	get_modeled_signal_last (this, a_model, sigma, last_value)
	Calculates the modeled signal.

GENERIC	get_modeled_signal get_modeled_signal_cache, get_modeled_signal_last

procedure	get_observed_signal (this, a_model)
	Calculates the observed signal.

procedure	get_g2 (this, a_model, use_cache, last_value)
	Calculates the g^2 contribution of a signal.

procedure	get_e (this, a_model, use_cache, last_value)
	Calculates the e contribution of a signal.

procedure	get_sigma2 (this)
	Calculates the total sigma^2 of a signal.

procedure	get_type (this)
	Gets a discription of the signal type.

procedure	get_header (this, header)
	Gets a discription of the model and model sigma array indices.

procedure	get_gp_i (this, a_model, i, flags)
	Gets the guassian process kernel for a signal and a position.

procedure	get_gp_s (this, a_model, signal, flags)
	Gets the guassian process kernel for a signal and a signal.

procedure	get_gp_x (this, a_model, x_cart, flags)
	Gets the guassian process kernel for a signal and cartesian position.

GENERIC	get_gp get_gp_i, get_gp_s, get_gp_x

procedure	scale_and_offset (this, a_model, value)
	Apply scale and offset to the value.

procedure	sync_child (this, index, recon_comm)
	Syncronize a child signal state to the parent.

procedure	write_header (this, iou)
	Write out the signal header information to an output file.

procedure	write (this, iou, index, a_model)
	Write out the signal information to an output file.

procedure	write_auxiliary (this, iou, index, a_model)
	Write out any auxiliary signal information to an output file.

procedure	write_step_data (this, a_model, result_ncid, current_step, index, signal_model_value_id, signal_sigma_value_id)
	Write out the signal data for a step to the result netcdf file.

FINAL	signal_destruct (this)
	Deconstruct a signal_class object.

Public Attributes
real(rprec), dimension(3)	x_cart
	Radial position to feedback the soft x-ray emission from.

integer, dimension(2)	indices
	Indicies of soft x-ray emissivity profiles to take the ratios of.

Public Attributes inherited from signal::signal_class
character(len=data_short_name_length)	s_name
	Short name of the signal.

character(len=data_name_length)	l_name
	Long name of the signal.

character(len=data_short_name_length)	units
	Physical units the signal measures.

real(rprec)	observed
	Eperimentally measured signal value.

real(rprec)	observed_sigma
	Eperimentally measured signal uncertainty.

real(rprec)	weight
	Weighting parameter of the signal.

real(rprec), dimension(4)	modeled
	Cached value of the modeled signal.

real(rprec), dimension(4)	modeled_sigma
	Cached value of the modeled sigma.

integer	scale_index
	Scale factor index.

integer	offset_index
	Offset factor index.

Detailed Description

Base class representing a sxrem_ratio signal.

Interface for Soft X-ray ratio constructor.

Super Class:: feedback

Member Function/Subroutine Documentation

◆ get_modeled_signal_last()

procedure sxrem_ratio::sxrem_ratio_class::get_modeled_signal_last	(	class (sxrem_ratio_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 signal.

The modeled signal is the ratio of the soft x-ray emissivity profiles.

Parameters

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

◆ get_observed_signal()

procedure sxrem_ratio::sxrem_ratio_class::get_observed_signal	(	class (sxrem_ratio_class), intent(in)	this,
		class (model_class), intent(in)	a_model
	)

Calculates the observed signal.

The observed signal is the ratio computed as the ratio as a function of the temperature.

Parameters

[in]	this	A sxrem_ratio_class instance.
[in]	a_model	A model instance.

Returns: The observed value.

◆ get_type()

procedure sxrem_ratio::sxrem_ratio_class::get_type ( class (sxrem_ratio_class), intent(in) this )

Gets a discription of the feedback type.

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

Parameters

[in] this A sxrem_ratio_class instance.

Returns: A string describing the feedback type.

◆ sxrem_ratio_construct()

class (sxrem_ratio_class) function, pointer sxrem_ratio::sxrem_ratio_class::sxrem_ratio_construct	(	real (rprec), dimension(3), intent(in)	x_cart,
		integer, dimension(2), intent(in)	indices
	)

Construct a sxrem_ratio_class object.

Allocates memory and initializes a sxrem_ratio_class object.

Parameters

[in]	x_cart	Radial position to feedback the soft x-ray emission from.
[in]	indices	Indicies of the two cords.

Returns: A pointer to a constructed sxrem_ratio_class object.

◆ sxrem_ratio_destruct()

FINAL sxrem_ratio::sxrem_ratio_class::sxrem_ratio_destruct ( type (sxrem_ratio_class), intent(inout) this )

final

Deconstruct a sxrem_ratio_class object.

Deallocates memory and uninitializes a sxrem_ratio_class object.

Parameters

[in,out] this A sxrem_ratio_class instance.

◆ write_auxiliary()

procedure sxrem_ratio::sxrem_ratio_class::write_auxiliary	(	class (sxrem_ratio_class), intent(in)	this,
		integer, intent(in)	iou,
		integer, intent(in)	index,
		class (model_class), intent(in)	a_model
	)

Write out auxiliary signal information to an output file.

Writes out the s_name and coefficient of the combined signals.

Parameters

[in]	this	A sxrem_ratio_class instance.
[in]	iou	A input/output representing the file to write to.
[in]	index	A index of a signal.
[in]	a_model	The equilibrium model.

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

V3FIT/Sources/sxrem_ratio.f

Public Member Functions

Public Attributes

Detailed Description

Member Function/Subroutine Documentation

◆ get_modeled_signal_last()

◆ get_observed_signal()

◆ get_type()

◆ sxrem_ratio_construct()

◆ sxrem_ratio_destruct()

◆ write_auxiliary()