Abstract reaction data type. More...
Public Member Functions | |
| procedure(initialize), deferred | initialize |
| Reaction initialization. Takes species, phase and reaction parameters and packs required information into the condensed data arrays for use during the model run. More... | |
| procedure | load |
| Load data from an input file. More... | |
| procedure | check_phase |
| Check the phase of the reaction against the phase being solved for. During GAS_RXN integrations, only GAS_RXN reactions are solved. During AERO_RXN integrations, only AERO_RXN and GAS_AERO_RXN reactions are solved. During GAS_AERO_RXN integrations, all reactions are solved. More... | |
| procedure | pack_size |
| Determine the number of bytes required to pack the given value. More... | |
| procedure | bin_pack |
| Packs the given value into the buffer, advancing position. More... | |
| procedure | bin_unpack |
| Unpacks the given value from the buffer, advancing position. More... | |
| procedure | print => do_print |
| Print the reaction data. More... | |
Public Attributes | |
| integer(kind=i_kind), public | rxn_phase |
| Reaction phase. More... | |
| type(property_t), pointer, public | property_set => null() |
| Reaction parameters. These will be available during initialization, but not during integration. All information required to calculate the time derivatives and Jacobian matrix constributions must be saved by the exdending type. More... | |
| real(kind=dp), dimension(:), allocatable, public | condensed_data_real |
Condensed reaction data. Theses arrays will be available during integration, and should contain any information required by the rate and Jacobian constribution functions 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 reaction data. Theses arrays will be available during integration, and should contain any information required by the rate and Jacobian constribution functions 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
Abstract reaction data type.
Time-invariant data related to a reaction. Types extending rxn_data_t should represent specific reaction types, with unique rate equations. Extending types should not have data members, as these will not be passed to the child nodes after initialization. Instead all data required by an extending type during a model run should be packed into the condensed_data arrays during initialization.
Definition at line 98 of file rxn_data.F90.
Member Function/Subroutine Documentation
◆ bin_pack()
| procedure camp_rxn_data::rxn_data_t::bin_pack |
Packs the given value into the buffer, advancing position.
Definition at line 141 of file rxn_data.F90.
◆ bin_unpack()
| procedure camp_rxn_data::rxn_data_t::bin_unpack |
Unpacks the given value from the buffer, advancing position.
Definition at line 143 of file rxn_data.F90.
◆ check_phase()
| procedure camp_rxn_data::rxn_data_t::check_phase |
Check the phase of the reaction against the phase being solved for. During GAS_RXN integrations, only GAS_RXN reactions are solved. During AERO_RXN integrations, only AERO_RXN and GAS_AERO_RXN reactions are solved. During GAS_AERO_RXN integrations, all reactions are solved.
Definition at line 137 of file rxn_data.F90.
◆ initialize()
| procedure(initialize), deferred camp_rxn_data::rxn_data_t::initialize |
Reaction initialization. Takes species, phase and reaction parameters and packs required information into the condensed data arrays for use during the model run.
This routine should be called once for each reaction at the beginning of a model run after all the input files have been read in.
Definition at line 129 of file rxn_data.F90.
◆ load()
| procedure camp_rxn_data::rxn_data_t::load |
Load data from an input file.
Definition at line 131 of file rxn_data.F90.
◆ pack_size()
| procedure camp_rxn_data::rxn_data_t::pack_size |
Determine the number of bytes required to pack the given value.
Definition at line 139 of file rxn_data.F90.
◆ print()
| procedure camp_rxn_data::rxn_data_t::print |
Print the reaction data.
Definition at line 145 of file rxn_data.F90.
Member Data Documentation
◆ condensed_data_int
| integer(kind=i_kind), dimension(:), allocatable, public camp_rxn_data::rxn_data_t::condensed_data_int |
Condensed reaction data. Theses arrays will be available during integration, and should contain any information required by the rate and Jacobian constribution functions that cannot be obtained from the camp_camp_state::camp_state_t object. (integer)
Definition at line 116 of file rxn_data.F90.
◆ condensed_data_real
| real(kind=dp), dimension(:), allocatable, public camp_rxn_data::rxn_data_t::condensed_data_real |
Condensed reaction data. Theses arrays will be available during integration, and should contain any information required by the rate and Jacobian constribution functions that cannot be obtained from the camp_camp_state::camp_state_t object. (floating-point)
Definition at line 111 of file rxn_data.F90.
◆ num_env_params
| integer(kind=i_kind), public camp_rxn_data::rxn_data_t::num_env_params = 0 |
Number of environment-dependent parameters These are parameters that need updated when environmental conditions change.
Definition at line 120 of file rxn_data.F90.
◆ property_set
| type(property_t), pointer, public camp_rxn_data::rxn_data_t::property_set => null() |
Reaction parameters. These will be available during initialization, but not during integration. All information required to calculate the time derivatives and Jacobian matrix constributions must be saved by the exdending type.
Definition at line 106 of file rxn_data.F90.
◆ rxn_phase
| integer(kind=i_kind), public camp_rxn_data::rxn_data_t::rxn_phase |
Reaction phase.
Definition at line 101 of file rxn_data.F90.
The documentation for this type was generated from the following file: