feedback Module Reference

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

Data Types
interface	feedback_class
	Base class representing a feedback signal. More...

Functions/Subroutines
function	feedback_construct (signal)
	Construct a feedback_class containing a sxrem_ratio object. More...
subroutine	feedback_destruct (this)
	Deconstruct a feedback_class object. More...
real(rprec) function, dimension(4)	feedback_get_modeled_signal (this, a_model, sigma, last_value)
	Calculates the modeled signal. More...
real(rprec) function	feedback_get_observed_signal (this, a_model)
	Calculates the observed signal. More...
character(len=data_name_length) function	feedback_get_signal_type (this)
	Gets a discription of the feedback signal type. More...
character(len=data_name_length) function, dimension(7)	feedback_get_header (this)
	Gets a discription of the model and model sigma array indices. More...
character(len=data_name_length) function	feedback_get_feedback_type (this)
	Gets a discription of the feedback type. More...
subroutine	feedback_write_auxiliary (this, iou, index)
	Write out auxiliary signal information to an output file. More...

Detailed Description

Defines the base class of the type feedback_class.

Super Class:

signal

Sub Classes:

Sub Classes: sxrem_ratio

Function/Subroutine Documentation

feedback_construct()

function feedback::feedback_construct

(

class (signal_class), pointer

signal

)

Construct a feedback_class containing a sxrem_ratio object.

Allocates memory and initializes a feedback_class object.

Parameters

[in]

ratio_object

An instance of a sxrem_ratio subclass.

Returns

A pointer to a constructed feedback_class object.

Definition at line 64 of file feedback.f.

feedback_destruct()

subroutine feedback::feedback_destruct

(

type (feedback_class), pointer

this

)

Deconstruct a feedback_class object.

Deallocates memory and uninitializes a feedback_class object.

Parameters

[in,out]

this

A feedback_class instance.

Definition at line 96 of file feedback.f.

feedback_get_feedback_type()

character (len=data_name_length) function feedback::feedback_get_feedback_type

(

type (feedback_class), intent(in)

this

)

Gets a discription of the feedback type.

Returns a string describing the feedback subclass.

See also

sxrem_ratio::sxrem_ratio_get_signal_type

Parameters

[in]

this

A feedback_class instance.

Returns

A string describing the feedback subclass.

Definition at line 300 of file feedback.f.

feedback_get_header()

character (len=data_name_length) function, dimension(7) feedback::feedback_get_header

(

type (feedback_class), intent(in)

this

)

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

This method is meant to be overwritten by a subclass method if need be. As a result, returns the get_header method of the subclass instance feedback_class was constructed with.

Parameters

[in]

this

A feedback_class instance.

Returns

A string describing the model and model sigma array indices.

Definition at line 260 of file feedback.f.

feedback_get_modeled_signal()

real (rprec) function, dimension(4) feedback::feedback_get_modeled_signal	(	class (feedback_class), intent(in)	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.

This method is meant to be overwritten by a subclass method. As a result, returns the get_modeled_signal method of the subclass instance feedback_class was constructed with.

See also

sxrem_ratio::sxrem_ratio_get_modeled_signal

Parameters

[in,out]	this	A feedback_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 131 of file feedback.f.

feedback_get_observed_signal()

real(rprec) function feedback::feedback_get_observed_signal	(	type(feedback_class), intent(in)	this,
		type (model_class), intent(in)	a_model
	)

Calculates the observed signal.

This method is meant to be overwritten by a subclass method. As a result, returns the get_observed_signal method of the subclass instance feedback_class was constructed with. This observed value is actually a a second model. This is used in the chi^2 minimization for self consistent feedback of quanities derived from two different models.

See also

sxrem_ratio::sxrem_ratio_get_observed_signal

Parameters

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

Returns

The observed value.

Definition at line 179 of file feedback.f.

feedback_get_signal_type()

character (len=data_name_length) function feedback::feedback_get_signal_type

(

type (feedback_class), intent(in)

this

)

Gets a discription of the feedback signal type.

This method is meant to be overwritten by a subclass method. As a result, returns the get_signal_type method of the subclass instance feedback_class was constructed with.

See also

sxrem_ratio::sxrem_ratio_get_signal_type

Parameters

[in]

this

A feedback_class instance.

Returns

A string describing the feedback type.

Definition at line 222 of file feedback.f.

feedback_write_auxiliary()

subroutine feedback::feedback_write_auxiliary	(	type (feedback_class), intent(in)	this,
		integer, intent(in)	iou,
		integer, intent(in)	index
	)

Write out auxiliary signal information to an output file.

Writes out the s_name and coefficient of the combined signals.

Parameters

[in]	this	A feedback_class instance.
[in]	iou	A input/output representing the file to write to.
[in]	index	A index of this signal.

Definition at line 338 of file feedback.f.