CAMP 1.0.0
Chemistry Across Multiple Phases
Data Types | Modules | Functions/Subroutines | Variables
chem_spec_data.F90 File Reference

The camp_chem_spec_data module. More...

Go to the source code of this file.

Data Types

interface  camp_chem_spec_data::chem_spec_data_t
 Chemical species data. More...
 

Modules

module  camp_chem_spec_data
 The chem_spec_data_t structure and associated subroutines.
 

Functions/Subroutines

type(chem_spec_data_t) function, pointer camp_chem_spec_data::constructor (init_size)
 Constructor for chem_spec_data_t.
 
subroutine camp_chem_spec_data::load (this, json, j_obj)
 Load species from an input file.
 
subroutine camp_chem_spec_data::initialize (this)
 Initialize the species set.
 
integer(kind=i_kind) function camp_chem_spec_data::get_size (this, spec_type, spec_phase)
 Get the number of species with the given properties. If no properties are specified, return the total number of species.
 
logical function camp_chem_spec_data::exists (this, spec_name)
 Check if a species name is in the set of chemical species.
 
type(string_t) function, dimension(:), allocatable camp_chem_spec_data::get_spec_names (this, spec_type, spec_phase)
 Get a list of species names.
 
logical function camp_chem_spec_data::get_property_set (this, spec_name, property_set)
 Get a species property set. Returns true if the species is found, or false otherwise.
 
logical function camp_chem_spec_data::get_type (this, spec_name, spec_type)
 Get a species type by species name. Returns true if the species is found or false otherwise.
 
logical function camp_chem_spec_data::get_phase (this, spec_name, spec_phase)
 Get a species phase by name. Returns true if the species is found, or false otherwise.
 
logical function camp_chem_spec_data::get_abs_tol (this, spec_name, abs_tol)
 Get the absolute integration tolerance of a species by name. Returns true if the species is found, or false otherwise.
 
integer(kind=i_kind) function camp_chem_spec_data::gas_state_id (this, spec_name)
 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. Returns a valid state array index if the species is found, or 0 otherwise.
 
character(len=:) function, allocatable camp_chem_spec_data::gas_state_name (this, spec_id)
 Get a gas-phase species name 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. Returns a valid state array index if the species is found, or 0 otherwise.
 
subroutine camp_chem_spec_data::do_print (this, file_unit)
 Print out the species data.
 
elemental subroutine camp_chem_spec_data::finalize (this)
 Finalize the chemical species data.
 
subroutine camp_chem_spec_data::ensure_size (this, num_spec)
 Ensure there is enough room in the species dataset to add a specified number of species.
 
subroutine camp_chem_spec_data::add (this, spec_name, spec_type, spec_phase, property_set)
 Add a new chemical species.
 
logical function camp_chem_spec_data::find (this, spec_name, spec_id)
 Get the index of a chemical species by name. Returns true if the species is found or false otherwise.
 

Variables

integer(kind=i_kind), parameter, public camp_chem_spec_data::chem_spec_unknown_type = 0
 State variable types (Must match values in camp_solver.c)
 
integer(kind=i_kind), parameter, public camp_chem_spec_data::chem_spec_variable = 1
 
integer(kind=i_kind), parameter, public camp_chem_spec_data::chem_spec_constant = 2
 
integer(kind=i_kind), parameter, public camp_chem_spec_data::chem_spec_pssa = 3
 
integer(kind=i_kind), parameter, public camp_chem_spec_data::chem_spec_activity_coeff = 4
 
integer(kind=i_kind), parameter, public camp_chem_spec_data::chem_spec_unknown_phase = 0
 Species phase.
 
integer(kind=i_kind), parameter, public camp_chem_spec_data::chem_spec_gas_phase = 1
 
integer(kind=i_kind), parameter, public camp_chem_spec_data::chem_spec_aero_phase = 2
 
integer(kind=i_kind), parameter camp_chem_spec_data::realloc_inc = 50
 Reallocation increment.
 
real(kind=dp), parameter camp_chem_spec_data::default_abs_tol = 1.0e-14
 Default absolute integration tolerance.
 

Detailed Description

The camp_chem_spec_data module.

Definition in file chem_spec_data.F90.