signal::signal_construct Interface Reference

Interface for the construction of signal_class types using signal_construct_magnetic, signal_construct_sxrem, signal_construct_intpol, signal_construct_thomson, signal_construct_extcurz, signal_construct_mse, signal_construct_ece, signal_construct_limiter, signal_construct_prior_gaussian, signal_construct_feedback, signal_construct_combination or signal_construct_diagnostic_netcdf. More...

Public Member Functions
subroutine	signal_construct_new (this, s_name, l_name, units, observed, sigma, weight, s_index, o_index)
	Construct new signal_class object. More...
subroutine	signal_construct_diagnostic_netcdf (this, mdsig_iou, observed, sigma, weight, s_index, o_index)
	Construct a signal_class containing a diagnostic object. More...

Detailed Description

Interface for the construction of signal_class types using signal_construct_magnetic, signal_construct_sxrem, signal_construct_intpol, signal_construct_thomson, signal_construct_extcurz, signal_construct_mse, signal_construct_ece, signal_construct_limiter, signal_construct_prior_gaussian, signal_construct_feedback, signal_construct_combination or signal_construct_diagnostic_netcdf.

Definition at line 118 of file signal.f.

Member Function/Subroutine Documentation

signal_construct_diagnostic_netcdf()

subroutine signal::signal_construct::signal_construct_diagnostic_netcdf	(	class (signal_class), intent(inout)	this,
		integer, intent(in)	mdsig_iou,
		real(rprec), intent(in)	observed,
		real(rprec), intent(in)	sigma,
		real(rprec), intent(in)	weight,
		integer, intent(in)	s_index,
		integer, intent(in)	o_index
	)

Construct a signal_class containing a diagnostic object.

Reads the s_name, l_name and units from a netcdf file. Used for constructing the magnetic objects.

Parameters

[in,out]	signal_class	An instance of a signal_class.
[in]	mdsig_iou	NetCDF id of the opened mdsig file.
[in]	observed	Observed value of the signal.
[in]	sigma	Observed sigma of the signal.
[in]	weight	Weight factor of the signal.
[in]	s_index	Index of the model signal scale factor.
[in]	o_index	Index of the model signal offset factor.

Returns

Apointer to a constructed signal_class object.

Definition at line 206 of file signal.f.

signal_construct_new()

subroutine signal::signal_construct::signal_construct_new	(	class (signal_class), intent(inout)	this,
		character(len=*), intent(in)	s_name,
		character(len=*), intent(in)	l_name,
		character(len=*), intent(in)	units,
		real(rprec), intent(in)	observed,
		real(rprec), intent(in)	sigma,
		real(rprec), intent(in)	weight,
		integer, intent(in)	s_index,
		integer, intent(in)	o_index
	)

Construct new signal_class object.

Allocates memory and initializes a signal_class object.

Parameters

[in,out]	this	An instance of a signal_class.
[in]	s_name	The short name of the signal.
[in]	l_name	The short name of the signal.
[in]	units	The units of the signal.
[in]	observed	Observed value of the signal.
[in]	sigma	Observed sigma of the signal.
[in]	weight	Weight factor of the signal.
[in]	s_index	Index of the model signal scale factor.
[in]	o_index	Index of the model signal offset factor.

Definition at line 145 of file signal.f.

---

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

• /Users/m4c/repo/trunk/V3FITA/Sources/signal.f