v3fit_params::param_construct Interface Reference

Interface for the construction of param_class types using param_construct_basic or param_construct_recon. More...

Public Member Functions
type(param_class) function, pointer	param_construct_basic (a_model, param_name, indices, num_params)
	Construct a param_class object. More...
type(param_class) function, pointer	param_construct_recon (a_model, param_name, indices, vrnc, range_type, range_indices, range_value, num_signals, num_params)
	Construct a param_class object. More...
type(param_class) function, pointer	param_construct_locking (a_model, param_name, indices, set, set_indices, set_coeff, eq_comm)
	Construct a param_class object. More...

Detailed Description

Interface for the construction of param_class types using param_construct_basic or param_construct_recon.

Definition at line 135 of file v3fit_params.f.

Member Function/Subroutine Documentation

param_construct_basic()

type (param_class) function, pointer v3fit_params::param_construct::param_construct_basic	(	type (model_class), intent(in)	a_model,
		character (len=*), intent(in)	param_name,
		integer, dimension(2), intent(in)	indices,
		integer, intent(in)	num_params
	)

Construct a param_class object.

Allocates memory and initializes a param_class object. Parameters are converted from strings to an internal id representation by either the model or the equilibrium. This version is used to construct basic parameters.

Parameters

[in]	a_model	An instance of a model object.
[in]	param_name	The name of the parameter.
[in]	indices	The array indices of the parameter.
[in]	num_params	Number of parameters. USed to determine the size of the param_class::correlation arrays.

Returns

A pointer to a constructed param_class object.

Definition at line 171 of file v3fit_params.f.

param_construct_locking()

type (param_class) function, pointer v3fit_params::param_construct::param_construct_locking	(	type (model_class), intent(inout)	a_model,
		character (len=*), intent(in)	param_name,
		integer, dimension(2), intent(in)	indices,
		character (len=*), dimension(:), intent(in)	set,
		integer, dimension(:,:), intent(in)	set_indices,
		real (rprec), dimension(:), intent(in)	set_coeff,
		integer, intent(in)	eq_comm
	)

Construct a param_class object.

Allocates memory and initializes a param_class object. Parameters are converted from strings to an internal id representation by either the model or the equilibrium. This version is used to construct locking parameters.

Parameters

[in]	a_model	An instance of a model object.
[in]	param_name	The name of the parameter.
[in]	indices	The array indices of the parameter.
[in]	set	Array of parameters to lock to.
[in]	set_indices	Array of parameters indices for parameters to lock to.
[in]	set_coeff	Coefficients for the parameters to lock to.
[in]	eq_comm	MPI communicator for the child equilibrium processes.

Returns

A pointer to a constructed param_class object.

Definition at line 355 of file v3fit_params.f.

param_construct_recon()

type (param_class) function, pointer v3fit_params::param_construct::param_construct_recon	(	type (model_class), intent(in)	a_model,
		character (len=*), intent(in)	param_name,
		integer, dimension(2), intent(in)	indices,
		real (rprec), intent(in)	vrnc,
		character (len=*), dimension(2), intent(in)	range_type,
		integer, dimension(2,2), intent(in)	range_indices,
		real (rprec), dimension(2), intent(in)	range_value,
		integer, intent(in)	num_signals,
		integer, intent(in)	num_params
	)

Construct a param_class object.

Allocates memory and initializes a param_class object. Parameters are converted from strings to an internal id representation by either the model or the equilibrium. This version is used to construct reconstruction parameters.

Parameter boundaries are specified by a range type. This range type may be one of three types. 'infinity' represents an unbounded case. 'value' represents a bounds by a fixed value. By specifying another parameter name, the boundary will be bounded by a fixed or varying parameter. The bounding parameter string is converted into an internal id representation.

Parameters

[in]	a_model	An instance of a model object.
[in]	param_name	The name of the parameter.
[in]	indices	The array indices of the parameter.
[in]	vrnc	The maximum incremental step size.
[in]	range_type	Range type of the bounds. Values can be 'infinity', 'value' or the name of a parameter.
[in]	range_indices	The array indices of the boundary parameter.
[in]	range_value	Value of a boundary.
[in]	num_signals	Number of signals. Used to determine the size of the param_recon_class::sem arrays.
[in]	num_params	Number of parameters. Used to determine the size of the param_class::correlation arrays.

Returns

A pointer to a constructed param_class object.

Definition at line 233 of file v3fit_params.f.

---

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

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