v3fit_params::param_class Type Reference

Base class representing a reconstructed parameter. An upper and lower bound may be set for the parameter value. More...

Inheritance diagram for v3fit_params::param_class:

Public Member Functions
FINAL	param_destruct (this)
	Deconstruct a param_class object.
procedure	get_value (this, a_model)
	Gets the parameter value.
procedure	get_name (this, a_model)
	Gets the parameter name.
procedure	write_short (this, iou, index, a_model)
	Writes out a parameter to an output file.
procedure	write_correlation (this, iou, a_model)
	Writes out a parameter covariance matrix row.
procedure	write_step_data_2 (this, a_model, result_ncid, current_step, index, param_value_id, param_sigma_id, param_corr_id)
	Write out the parameter data for a step to the result netcdf file.
GENERIC	write_step_data write_step_data_2

Public Attributes
integer	param_id = data_no_id
	Id number of the parameter. Id's are provided by either the model or the equilibrium.
integer, dimension(data_max_indices)	indices = 0
	The i and j indices of the parameter. These are only used if the parameter is the element of an array.
real(rprec)	sigma = 0.0
	Stored value of the parameter uncertainty for the current reconstruction step. This value is calculated by reconstruction::reconstruction_eval_sem.
real(rprec), dimension(:), pointer	correlation => null()
	Stored row of the correlation matrix. When the parameter is interpreted as a locking parameter, this array contains the parameter coefficents.

Detailed Description

Base class representing a reconstructed parameter. An upper and lower bound may be set for the parameter value.

Member Function/Subroutine Documentation

get_name()

procedure v3fit_params::param_class::get_name	(	class (param_class), intent(in)	this,
		class (model_class), intent(in)	a_model
	)

Gets the parameter name.

Converts the parameter id from either the model or the equilibrium.

Parameters

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

Returns

The parameter name.

get_value()

procedure v3fit_params::param_class::get_value	(	class (param_class), intent(in)	this,
		class (model_class), intent(in)	a_model
	)

Gets the parameter value.

Gets the current parameter value from either the model or the equilibrium.

Parameters

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

Returns

The parameter value.

param_destruct()

FINAL v3fit_params::param_class::param_destruct ( type (param_class), intent(inout)  this )

final

Deconstruct a param_class object.

Deallocates memory and uninitializes a param_class object.

Parameters

[in,out]

this

A param_class instance.

write_correlation()

procedure v3fit_params::param_class::write_correlation	(	class (param_class), intent(in)	this,
		integer, intent(in)	iou,
		class (model_class), intent(in)	a_model
	)

Writes out a parameter covariance matrix row.

Each parameter contains the row for it's covariance matrix. This write it out formatted as the name of the parameter up to 12 characters. This followed by each value spearated by 2 spaces and a 12 character number.

Parameters

[in]	this	A param_class instance.
[in]	iou	Input/output unit representing the file to write to.
[in]	a_model	A model instance.

write_short()

procedure v3fit_params::param_class::write_short	(	class (param_class), intent(in)	this,
		integer, intent(in)	iou,
		integer, intent(in)	index,
		class (model_class), intent(in)	a_model
	)

Writes out a parameter to an output file.

Parameter information is formated as the index, name, index 1, index2, value and sigma.

Parameters

[in]	this	A param_class instance.
[in]	iou	Input/output unit representing the file to write to.
[in]	index	The index of a parameter.
[in]	a_model	A model instance.

write_step_data_2()

procedure v3fit_params::param_class::write_step_data_2	(	class (param_class), intent(in)	this,
		class (model_class), intent(in)	a_model,
		integer, intent(in)	result_ncid,
		integer, intent(in)	current_step,
		integer, intent(in)	index,
		integer, intent(in)	param_value_id,
		integer, intent(in)	param_sigma_id,
		integer, intent(in)	param_corr_id
	)

Write out the parameter data for a step to the result netcdf file.

Writes out the parameter value and sigma to the result file.

Parameters

[in]	this	A param_class instance.
[in]	a_model	The equilibrium model.
[in]	result_ncid	A NetCDF id of the result file.
[in]	current_step	The surrent reconstruction step.
[in]	index	A index of a parameter.
[in]	param_value_id	NetCDF variable id of the parameter value.

See also

v3fit_context

Parameters

[in]

param_sigma_id

NetCDF variable id of the parameter sigma.

See also

v3fit_context

Parameters

[in]

param_corr_id

NetCDF variable id of the parameter correlation.

See also

v3fit_context

Note

This assumes that the parameter sigma has already been calculated. Name and index information is written when the result file is first created by v3fit_context::v3fit_context_write_step_data.

---

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

• V3FIT/Sources/v3fit_params.f