sxrem_ratio Module Reference

Defines a feedback signal based on the temperature based on the ration of the soft x-ray emissivity profile. This signal feeds back the temperature profile at a specified positon. More...

Data Types
interface	sxrem_ratio_class
	Base class representing a sxrem_ratio signal. More...

Functions/Subroutines
class(sxrem_ratio_class) function, pointer	sxrem_ratio_construct (x_cart, indices)
	Construct a sxrem_ratio_class object. More...
subroutine	sxrem_ratio_destruct (this)
	Deconstruct a sxrem_ratio_class object. More...
real(rprec) function, dimension(4)	sxrem_ratio_get_modeled_signal (this, a_model, sigma, last_value)
	Calculates the modeled signal. More...
real(rprec) function	sxrem_ratio_get_observed_signal (this, a_model)
	Calculates the observed signal. More...
character(len=data_name_length) function	sxrem_ratio_get_type (this)
	Gets a discription of the feedback type. More...
subroutine	sxrem_ratio_write_auxiliary (this, iou, index, a_model)
	Write out auxiliary signal information to an output file. More...

Detailed Description

Defines a feedback signal based on the temperature based on the ration of the soft x-ray emissivity profile. This signal feeds back the temperature profile at a specified positon.

Super Class:

feedback

Function/Subroutine Documentation

sxrem_ratio_construct()

class (sxrem_ratio_class) function, pointer sxrem_ratio::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.

Definition at line 71 of file sxrem_ratio.f.

sxrem_ratio_destruct()

subroutine sxrem_ratio::sxrem_ratio_destruct

(

type (sxrem_ratio_class), intent(inout)

this

)

Deconstruct a sxrem_ratio_class object.

Deallocates memory and uninitializes a sxrem_ratio_class object.

Parameters

[in,out]

this

A sxrem_ratio_class instance.

Definition at line 105 of file sxrem_ratio.f.

sxrem_ratio_get_modeled_signal()

real (rprec) function, dimension(4) sxrem_ratio::sxrem_ratio_get_modeled_signal	(	class (sxrem_ratio_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.

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.

Definition at line 133 of file sxrem_ratio.f.

sxrem_ratio_get_observed_signal()

real (rprec) function sxrem_ratio::sxrem_ratio_get_observed_signal	(	class (sxrem_ratio_class), intent(in)	this,
		type (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.

Definition at line 194 of file sxrem_ratio.f.

sxrem_ratio_get_type()

character (len=data_name_length) function sxrem_ratio::sxrem_ratio_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.

Definition at line 227 of file sxrem_ratio.f.

sxrem_ratio_write_auxiliary()

subroutine sxrem_ratio::sxrem_ratio_write_auxiliary	(	class (sxrem_ratio_class), intent(in)	this,
		integer, intent(in)	iou,
		integer, intent(in)	index,
		type (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.

Definition at line 260 of file sxrem_ratio.f.