v3fit_params.f File Reference

Contains module v3fit_params. More...

Data Types
type	v3fit_params::param_recon_class
	Class to hold variables needed when a parameter is a reconstruction parameter. More...
type	v3fit_params::param_locking_class
	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...
type	v3fit_params::param_class
	Base class representing a reconstructed parameter. An upper and lower bound may be set for the parameter value. More...
type	v3fit_params::param_pointer
	Pointer to a parameter object. Used for creating arrays of signal pointers. This is needed because fortran does not allow arrays of pointers directly. More...
interface	v3fit_params::param_construct
	Interface for the construction of param_class types using param_construct_basic or param_construct_recon. More...
interface	v3fit_params::param_write_step_data
	Interface for the writting of param_class data to the result file using param_write_step_data_1 or param_write_step_data_2. More...

Modules
module	v3fit_params
	Defines the base class of the type param_class.

Functions/Subroutines
type(param_class) function, pointer	v3fit_params::param_construct_basic (a_model, param_name, indices, num_params)
	Construct a param_class object.
type(param_class) function, pointer	v3fit_params::param_construct_recon (a_model, param_name, indices, vrnc, range_type, range_indices, range_value, num_signals, num_params)
	Construct a param_class object.
type(param_class) function, pointer	v3fit_params::param_construct_locking (a_model, param_name, indices, set, set_indices, set_coeff, eq_comm)
	Construct a param_class object.
subroutine	v3fit_params::param_destruct (this)
	Deconstruct a param_class object.
subroutine	v3fit_params::param_set_value (this, a_model, value, eq_comm, is_central)
	Sets the parameter value.
subroutine	v3fit_params::param_set_lock_value (this, a_model, eq_comm)
	Sets the locking parameter value.
real(rprec) function	v3fit_params::param_get_value (this, a_model)
	Gets the parameter value.
character(len=data_name_length) function	v3fit_params::param_get_name (this, a_model)
	Gets the parameter name.
real(rprec) function	v3fit_params::param_get_lower_range_value (this, a_model)
	Gets the lower boundary value.
real(rprec) function	v3fit_params::param_get_upper_range_value (this, a_model)
	Gets the upper boundary value.
character(len=data_name_length) function	v3fit_params::param_get_lower_range_type (this, a_model)
	Gets the lower boundary type description.
character(len=data_name_length) function	v3fit_params::param_get_upper_range_type (this, a_model)
	Gets the upper boundary type description.
logical function	v3fit_params::param_is_in_lower_range (this, a_model, value)
	Checks if the value is in the lower range.
logical function	v3fit_params::param_is_in_upper_range (this, a_model, value)
	Checks if the value is in the upper range.
subroutine	v3fit_params::param_increment (this, a_model, eq_comm, is_central)
	Increments the parameter value.
subroutine	v3fit_params::param_decrement (this, a_model, eq_comm)
	Decrements the parameter value.
subroutine	v3fit_params::param_write (this, iou, index, a_model)
	Writes out a parameter to an output file.
subroutine	v3fit_params::param_write_short (this, iou, index, a_model)
	Writes out a parameter to an output file.
subroutine	v3fit_params::param_write_header (iou)
	Writes out parameter header information to an output file.
subroutine	v3fit_params::param_write_header_short (iou)
	Writes out parameter header information to an output file.
subroutine	v3fit_params::param_write_correlation (this, iou, a_model)
	Writes out a parameter covariance matrix row.
subroutine	v3fit_params::param_write_step_data_1 (this, a_model, result_ncid, current_step, index, param_value_id, param_sigma_id, param_corr_id, param_sem_id)
	Write out the parameter data for a step to the result netcdf file.
subroutine	v3fit_params::param_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.
subroutine	v3fit_params::param_restart (this, a_model, result_ncid, current_step, index, param_value_id, param_sigma_id, param_corr_id, eq_comm, is_central)
	Restart the parameter.
subroutine	v3fit_params::param_sync_value (this, a_model, recon_comm, eq_comm, is_central)
	Syncronize the param value to children.
subroutine	v3fit_params::param_send_delta (this, index, recon_comm)
	Sends the delta used.
subroutine	v3fit_params::param_recv_delta (this, index, recon_comm)
	Receives the delta used.
subroutine	v3fit_params::param_sync_delta (this, recon_comm)
	Sync the delta used.
subroutine	v3fit_params::param_sync_child (this, a_model, index, recon_comm, eq_comm, is_central)
	Sync the parameter value from a child to the parent.

Variables
integer, parameter	v3fit_params::param_range_no_type = -1
	No bounding type specified.
integer, parameter	v3fit_params::param_range_value_type = 0
	Parameter value is bounded by a value.
integer, parameter	v3fit_params::param_range_infinity_type = 1
	Parameter value is unbounded.
integer, parameter	v3fit_params::param_range_parameter_type = 2
	Parameter value is bounded by another parameter.
integer, parameter	v3fit_params::param_max_increment_steps = 5
	Maximum number of attemps to change the parameter increment size.
integer, parameter	v3fit_params::param_div_factor = 10.0
	Division factor to decrease the step size.

Detailed Description

Contains module v3fit_params.