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
 Reaction initialization. More...
 
procedure 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. More...
 
final finalize
 Finalize the reaction. More...
 
 finalize_array
 
- Public Member Functions inherited from camp_sub_model_data::sub_model_data_t
procedure(initialize), deferred 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. More...
 
procedure(priority), deferred 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. More...
 
procedure name => get_name
 Get the name of the sub-model. More...
 
procedure pack_size
 Determine the number of bytes required to pack the sub-model data. More...
 
procedure bin_pack
 Packs the sub-model into the buffer, advancing position. More...
 
procedure bin_unpack
 Unpacks the sub-model from the buffer, advancing position. More...
 
procedure load
 Load data from an input file. More...
 
procedure print => do_print
 Print the sub-model data. More...
 

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. More...
 
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. More...
 
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) More...
 
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) More...
 
integer(kind=i_kind), public num_env_params = 0
 Number of environment-dependent parameters These are parameters that need updated when environmental conditions change. More...
 

Detailed Description

Generic test reaction data type.

Constructor for sub_model_PDFiTE_t.

Definition at line 224 of file sub_model_PDFiTE.F90.

Member Function/Subroutine Documentation

◆ finalize()

final camp_sub_model_pdfite::sub_model_pdfite_t::finalize
final

Finalize the reaction.

Definition at line 233 of file sub_model_PDFiTE.F90.

Here is the call graph for this function:

◆ finalize_array()

camp_sub_model_pdfite::sub_model_pdfite_t::finalize_array

Definition at line 233 of file sub_model_PDFiTE.F90.

◆ initialize()

procedure camp_sub_model_pdfite::sub_model_pdfite_t::initialize

Reaction initialization.

Definition at line 227 of file sub_model_PDFiTE.F90.

◆ priority()

procedure camp_sub_model_pdfite::sub_model_pdfite_t::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.

Definition at line 231 of file sub_model_PDFiTE.F90.


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