v3fit_params::param_locking_class Type Reference

Class to hold variables needed when a parameter is a locking parameter. The locking parameter coefficents are stored in the correlation array of the parent type. More...

Inheritance diagram for v3fit_params::param_locking_class:

Public Member Functions
FINAL	param_locking_destruct (this)
	Deconstruct a param_locking_class object.
procedure	set_lock_value (this, a_model, eq_comm)
	Sets the locking parameter value.
Public Member Functions inherited from v3fit_params::param_class
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, dimension(:), pointer	ids => null()
	Parameter id's of the parameter to lock to.
integer, dimension(:,:), pointer	lock_indices => null()
	The i and j indices of the parameters to lock to.
Public Attributes inherited from v3fit_params::param_class
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

Class to hold variables needed when a parameter is a locking parameter. The locking parameter coefficents are stored in the correlation array of the parent type.

Member Function/Subroutine Documentation

param_locking_destruct()

FINAL v3fit_params::param_locking_class::param_locking_destruct ( type (param_locking_class), intent(inout)  this )

final

Deconstruct a param_locking_class object.

Deallocates memory and uninitializes a param_locking_class object.

Parameters

[in,out]

this

A param_locking_class object.

set_lock_value()

procedure v3fit_params::param_locking_class::set_lock_value	(	class (param_locking_class), intent(in)	this,
		class (model_class), intent(inout)	a_model,
		integer, intent(in)	eq_comm
	)

Sets the locking parameter value.

Sets the value of a locking parameter. These parameters are locked to a linear combination of other set parameters.

Parameters

[in]	this	A param_locking_class instance.
[in,out]	a_model	A model instance.
[in]	eq_comm	MPI communicator for the child equilibrium processes.

---

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

• V3FIT/Sources/v3fit_params.f