camp_sub_model_unifac::sub_model_unifac_t Interface Reference

UNIFAC activity coefficient calculation. More...

Inheritance diagram for camp_sub_model_unifac::sub_model_unifac_t:

Collaboration diagram for camp_sub_model_unifac::sub_model_unifac_t:

Public Member Functions
procedure	initialize (this, aero_rep_set, aero_phase_set, chem_spec_data)
	Initialize the sub model data, validating input parameters and loading any required information form the sub_model_data_t::property_set. This routine should be called once for each sub model at the beginning of the model run after all the input files have been read in. It ensures all data required during the model run are included in the condensed data arrays.
procedure	priority (this)
	Return a real number representing the priority of the sub-model calculations. Low priority sub models may depend on the results of higher priority sub models.
final	finalize (this)
	Finalize the sub-model.
Public Member Functions inherited from camp_sub_model_data::sub_model_data_t
procedure(initialize), deferred	initialize initialize
	Initialize the sub-model data, validating input parameters and loading any required information form the sub_model_data_t::property_set. This routine should be called once for each sub-model at the beginning of the model run after all the input files have been read in. It ensures all data required during the model run are included in the condensed data arrays.
procedure(priority), deferred	priority priority
	Return a real number representing the priority of the sub-model calculations. Low priority sub models may depend on the results of higher priority sub models. Lower numbers indicate higher priority.
procedure	name (this)
	Get the name of the sub-model.
procedure	pack_size (this, comm)
	Determine the number of bytes required to pack the sub-model data.
procedure	bin_pack (this, buffer, pos, comm)
	Packs the sub-model into the buffer, advancing position.
procedure	bin_unpack (this, buffer, pos, comm)
	Unpacks the sub-model from the buffer, advancing position.
procedure	load (this, json, j_obj)
	Load data from an input file.
procedure	print (this, file_unit)
	Print the sub-model data.

Additional Inherited Members
Public Attributes inherited from camp_sub_model_data::sub_model_data_t
character(len=:), allocatable, public	model_name
	Name of the sub-model.
type(property_t), pointer, public	property_set => null()
	Sub model parameters. These will be available during initialization, but not during integration. All information required by the sub model during solving must be saved by the extending type to the condensed data arrays.
real(kind=dp), dimension(:), allocatable, public	condensed_data_real
	Condensed sub-model data. These arrays will be available during integration, and should contain any information required by the sub-model that cannot be obtained from the camp_camp_state::camp_state_t object. (floating point)
integer(kind=i_kind), dimension(:), allocatable, public	condensed_data_int
	Condensed sub-model data. These arrays will be available during integration, and should contain any information required by the sub-model that cannot be obtained from the camp_camp_state::camp_state_t object. (integer)
integer(kind=i_kind), public	num_env_params = 0
	Number of environment-dependent parameters These are parameters that need updated when environmental conditions change.

Detailed Description

UNIFAC activity coefficient calculation.

Time-invariant data required by the UNIFAC activity coefficient sub model

Definition at line 198 of file sub_model_UNIFAC.F90.

Constructor & Destructor Documentation

finalize()

final camp_sub_model_unifac::sub_model_unifac_t::finalize ( type(sub_model_unifac_t), intent(inout)  this )

final

Finalize the sub-model.

Parameters

[in,out]

this

Sub-model data

Definition at line 212 of file sub_model_UNIFAC.F90.

Here is the call graph for this function:

Member Function/Subroutine Documentation

initialize()

procedure camp_sub_model_unifac::sub_model_unifac_t::initialize	(	class(sub_model_unifac_t), intent(inout)	this,
		type(aero_rep_data_ptr), dimension(:), intent(in), pointer	aero_rep_set,
		type(aero_phase_data_ptr), dimension(:), intent(in), pointer	aero_phase_set,
		type(chem_spec_data_t), intent(in)	chem_spec_data
	)

Initialize the sub model data, validating input parameters and loading any required information form the sub_model_data_t::property_set. This routine should be called once for each sub model at the beginning of the model run after all the input files have been read in. It ensures all data required during the model run are included in the condensed data arrays.

Parameters

[in,out]	this	Sub model data
[in]	aero_rep_set	The set of aerosol representations
[in]	aero_phase_set	The set of aerosol phases
[in]	chem_spec_data	Chemical species data

Definition at line 206 of file sub_model_UNIFAC.F90.

priority()

procedure camp_sub_model_unifac::sub_model_unifac_t::priority

(

class(sub_model_unifac_t), intent(in)

this

)

Return a real number representing the priority of the sub-model calculations. Low priority sub models may depend on the results of higher priority sub models.

UNIFAC calculations may depend on water concentrations, so must be lower priority than the ZSR sub model.

Returns

Sub model priority

Parameters

[in]

this

Sub model data

Definition at line 210 of file sub_model_UNIFAC.F90.

---

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

• sub_model_UNIFAC.F90