Chemical species data. More...
Public Member Functions | |
| procedure | load |
| Load species from an input file. More... | |
| procedure | initialize |
| Initialize the species set. More... | |
| procedure | size => get_size |
| Get the number of species with specified conditions. More... | |
| procedure | exists |
| Check if a species name is in the set of chemical species. More... | |
| procedure | get_spec_names |
| Get a list of species names. More... | |
| procedure | get_property_set |
| Get a species properties. More... | |
| procedure | get_type |
| Get a species type. More... | |
| procedure | get_phase |
| Get a species phase. More... | |
| procedure | get_abs_tol |
| Get the absolute integration tolerance of a species. More... | |
| procedure | gas_state_id |
Get a gas-phase species index in the camp_camp_state::camp_state_t::state_var array. Note that aerosol-phase species indices on the camp_camp_state::camp_state_t::state_var array must be accessed from camp_aero_rep_data::aero_rep_data_t::spec_state_id() for a particular aerosol representation. More... | |
| procedure | gas_state_name |
Get the name of a gas-phase species in the camp_camp_state::camp_state_t::state_var array. Note that aerosol-phase species names on the camp_camp_state::camp_state_t::state_var array must be accessed from camp_aero_rep_data::aero_rep_data_t::spec_state_id() for a particular aerosol representation. More... | |
| procedure | print => do_print |
| Print out the species data. More... | |
| final | finalize |
| Finalize the chemical species data. More... | |
Public Attributes | |
| type(string_t), dimension(:), pointer | spec_name => null() |
| Species name. More... | |
| integer(kind=i_kind), dimension(:), pointer | spec_type => null() |
| Species type. More... | |
| integer(kind=i_kind), dimension(:), pointer | spec_phase => null() |
| Species phase. More... | |
| type(property_t), dimension(:), pointer | property_set => null() |
| Species property set. More... | |
Private Member Functions | |
| procedure, private | ensure_size |
| Ensure there is enough room in the species dataset to add a specified number of species. More... | |
| procedure, private | add |
| Add a species. More... | |
| procedure, private | find |
| Find a species index by name. More... | |
Private Attributes | |
| integer(kind=i_kind) | num_spec = 0 |
| Number of species. More... | |
Detailed Description
Chemical species data.
Time-invariant data related to a chemical species
Definition at line 68 of file chem_spec_data.F90.
Member Function/Subroutine Documentation
◆ add()
|
private |
Add a species.
Definition at line 123 of file chem_spec_data.F90.
◆ ensure_size()
|
private |
Ensure there is enough room in the species dataset to add a specified number of species.
Definition at line 121 of file chem_spec_data.F90.
◆ exists()
| procedure camp_chem_spec_data::chem_spec_data_t::exists |
Check if a species name is in the set of chemical species.
Definition at line 88 of file chem_spec_data.F90.
◆ finalize()
|
final |
Finalize the chemical species data.
Definition at line 116 of file chem_spec_data.F90.
◆ find()
|
private |
Find a species index by name.
Definition at line 125 of file chem_spec_data.F90.
◆ gas_state_id()
| procedure camp_chem_spec_data::chem_spec_data_t::gas_state_id |
Get a gas-phase species index in the camp_camp_state::camp_state_t::state_var array. Note that aerosol-phase species indices on the camp_camp_state::camp_state_t::state_var array must be accessed from camp_aero_rep_data::aero_rep_data_t::spec_state_id() for a particular aerosol representation.
Definition at line 105 of file chem_spec_data.F90.
◆ gas_state_name()
| procedure camp_chem_spec_data::chem_spec_data_t::gas_state_name |
Get the name of a gas-phase species in the camp_camp_state::camp_state_t::state_var array. Note that aerosol-phase species names on the camp_camp_state::camp_state_t::state_var array must be accessed from camp_aero_rep_data::aero_rep_data_t::spec_state_id() for a particular aerosol representation.
Definition at line 112 of file chem_spec_data.F90.
◆ get_abs_tol()
| procedure camp_chem_spec_data::chem_spec_data_t::get_abs_tol |
Get the absolute integration tolerance of a species.
Definition at line 98 of file chem_spec_data.F90.
◆ get_phase()
| procedure camp_chem_spec_data::chem_spec_data_t::get_phase |
Get a species phase.
Definition at line 96 of file chem_spec_data.F90.
◆ get_property_set()
| procedure camp_chem_spec_data::chem_spec_data_t::get_property_set |
Get a species properties.
Definition at line 92 of file chem_spec_data.F90.
◆ get_spec_names()
| procedure camp_chem_spec_data::chem_spec_data_t::get_spec_names |
Get a list of species names.
Definition at line 90 of file chem_spec_data.F90.
◆ get_type()
| procedure camp_chem_spec_data::chem_spec_data_t::get_type |
Get a species type.
Definition at line 94 of file chem_spec_data.F90.
◆ initialize()
| procedure camp_chem_spec_data::chem_spec_data_t::initialize |
Initialize the species set.
Definition at line 84 of file chem_spec_data.F90.
◆ load()
| procedure camp_chem_spec_data::chem_spec_data_t::load |
Load species from an input file.
Definition at line 82 of file chem_spec_data.F90.
◆ print()
| procedure camp_chem_spec_data::chem_spec_data_t::print |
Print out the species data.
Definition at line 114 of file chem_spec_data.F90.
◆ size()
| procedure camp_chem_spec_data::chem_spec_data_t::size |
Get the number of species with specified conditions.
Definition at line 86 of file chem_spec_data.F90.
Member Data Documentation
◆ num_spec
|
private |
Number of species.
Definition at line 71 of file chem_spec_data.F90.
◆ property_set
| type(property_t), dimension(:), pointer camp_chem_spec_data::chem_spec_data_t::property_set => null() |
Species property set.
Definition at line 79 of file chem_spec_data.F90.
◆ spec_name
| type(string_t), dimension(:), pointer camp_chem_spec_data::chem_spec_data_t::spec_name => null() |
Species name.
Definition at line 73 of file chem_spec_data.F90.
◆ spec_phase
| integer(kind=i_kind), dimension(:), pointer camp_chem_spec_data::chem_spec_data_t::spec_phase => null() |
Species phase.
Definition at line 77 of file chem_spec_data.F90.
◆ spec_type
| integer(kind=i_kind), dimension(:), pointer camp_chem_spec_data::chem_spec_data_t::spec_type => null() |
Species type.
Definition at line 75 of file chem_spec_data.F90.
The documentation for this interface was generated from the following file: