CAMP 1.0.0
Chemistry Across Multiple Phases
Public Member Functions | List of all members
camp_sub_model_pdfite::sub_model_pdfite_t Interface Reference

Generic test reaction data type. More...

Inheritance diagram for camp_sub_model_pdfite::sub_model_pdfite_t:
Inheritance graph
[legend]
Collaboration diagram for camp_sub_model_pdfite::sub_model_pdfite_t:
Collaboration graph
[legend]

Public Member Functions

procedure initialize (this, aero_rep_set, aero_phase_set, chem_spec_data)
 Reaction initialization.
 
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 reaction.
 
- 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

Generic test reaction data type.

Constructor for sub_model_PDFiTE_t.

Definition at line 223 of file sub_model_PDFiTE.F90.

Constructor & Destructor Documentation

◆ finalize()

final camp_sub_model_pdfite::sub_model_pdfite_t::finalize ( type(sub_model_pdfite_t), intent(inout)  this)
final

Finalize the reaction.

Parameters
[in,out]thisReaction data

Definition at line 232 of file sub_model_PDFiTE.F90.

Here is the call graph for this function:

Member Function/Subroutine Documentation

◆ initialize()

procedure camp_sub_model_pdfite::sub_model_pdfite_t::initialize ( class(sub_model_pdfite_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 
)

Reaction initialization.

Parameters
[in,out]thisReaction data
[in]aero_rep_setThe set of aerosol representations
[in]aero_phase_setThe set of aerosol phases
[in]chem_spec_dataChemical species data

Definition at line 226 of file sub_model_PDFiTE.F90.

◆ priority()

procedure camp_sub_model_pdfite::sub_model_pdfite_t::priority ( class(sub_model_pdfite_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.

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

Returns
Sub model priority
Parameters
[in]thisSub model data

Definition at line 230 of file sub_model_PDFiTE.F90.


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