Namespace chemspeciesutils_mod¶

Namespace List > chemspeciesutils_mod

Public Functions¶

Type	Name
logical function, public	check_species_exists (type(statemanagertype), intent(inout) container, character(len=), intent(in) species_name, integer, intent(out) rc) Check if a chemical species exists in the mechanism.*
subroutine, public	create_species_mapping (type(statemanagertype), intent(inout) container, character(len=), dimension(:), intent(in) process_species, integer, dimension(:), intent(out) species_mapping, integer, intent(out) rc) Create mapping from process species to mechanism species.*
subroutine, public	filter_species_by_type (type(statemanagertype), intent(inout) container, character(len=), intent(in) species_type, character(len=32), dimension(:), intent(out), allocatable filtered_species, integer, intent(out) rc) Filter species by type.*
subroutine, public	get_aerosol_species_list (type(statemanagertype), intent(inout) container, character(len=32), dimension(:), intent(out), allocatable aerosol_species_list, integer, intent(out) rc) Get list of aerosol species.
subroutine, public	get_dust_species_list (type(statemanagertype), intent(inout) container, character(len=32), dimension(:), intent(out), allocatable dust_species_list, integer, intent(out) rc) Get list of dust species.
subroutine, public	get_gas_species_list (type(statemanagertype), intent(inout) container, character(len=32), dimension(:), intent(out), allocatable gas_species_list, integer, intent(out) rc) Get list of gas species.
subroutine, public	get_seasalt_species_list (type(statemanagertype), intent(inout) container, character(len=32), dimension(:), intent(out), allocatable seasalt_species_list, integer, intent(out) rc) Get list of sea salt species.
subroutine, public	get_species_concentration_units (type(statemanagertype), intent(inout) container, character(len=), intent(in) species_name, character(len=10), intent(out) units, integer, intent(out) rc) Get concentration units for a species.*
integer function, public	get_species_index (type(statemanagertype), intent(inout) container, character(len=), intent(in) species_name, integer, intent(out) rc) Get the index of a single chemical species.*
subroutine, public	get_species_indices (type(statemanagertype), intent(inout) container, character(len=), dimension(:), intent(in) species_names, integer, dimension(:), intent(out) species_indices, integer, intent(out) rc) Get indices for multiple chemical species.*
subroutine, public	get_species_properties (type(statemanagertype), intent(inout) container, character(len=), intent(in) species_name, type(speciestype), intent(out) species, integer, intent(out) rc) Get properties of a chemical species.*
subroutine, public	get_tracer_species_list (type(statemanagertype), intent(inout) container, character(len=32), dimension(:), intent(out), allocatable tracer_species_list, integer, intent(out) rc) Get list of tracer species.
subroutine, public	parse_species_list (character(len=), intent(in) species_string, character(len=32), dimension(:), intent(out) species_array, integer, intent(out) n_species) Parse a comma-separated species list.*

Public Functions Documentation¶

function check_species_exists¶

Check if a chemical species exists in the mechanism.

logical function, public chemspeciesutils_mod::check_species_exists (
    type( statemanagertype ), intent(inout) container,
    character(len=*), intent(in) species_name,
    integer, intent(out) rc
)

Parameters:

container StateManager containing chemical state
species_name Name of the species to check
rc Return code

Returns:

True if species exists, false otherwise

function create_species_mapping¶

Create mapping from process species to mechanism species.

subroutine, public chemspeciesutils_mod::create_species_mapping (
    type( statemanagertype ), intent(inout) container,
    character(len=*), dimension(:), intent(in) process_species,
    integer, dimension(:), intent(out) species_mapping,
    integer, intent(out) rc
)

Parameters:

container StateManager containing chemical state
process_species Array of process species names
species_mapping Array of mechanism species indices
rc Return code

function filter_species_by_type¶

Filter species by type.

subroutine, public chemspeciesutils_mod::filter_species_by_type (
    type( statemanagertype ), intent(inout) container,
    character(len=*), intent(in) species_type,
    character(len=32), dimension(:), intent(out), allocatable filtered_species,
    integer, intent(out) rc
)

Parameters:

container StateManager containing chemical state
species_type Type of species ('gas', 'aerosol', 'dust', 'seasalt', 'tracer')
filtered_species List of species names matching the type
rc Return code

function get_aerosol_species_list¶

Get list of aerosol species.

subroutine, public chemspeciesutils_mod::get_aerosol_species_list (
    type( statemanagertype ), intent(inout) container,
    character(len=32), dimension(:), intent(out), allocatable aerosol_species_list,
    integer, intent(out) rc
)

Parameters:

container StateManager containing chemical state
aerosol_species_list List of aerosol species names
rc Return code

function get_dust_species_list¶

Get list of dust species.

subroutine, public chemspeciesutils_mod::get_dust_species_list (
    type( statemanagertype ), intent(inout) container,
    character(len=32), dimension(:), intent(out), allocatable dust_species_list,
    integer, intent(out) rc
)

Parameters:

container StateManager containing chemical state
dust_species_list List of dust species names
rc Return code

function get_gas_species_list¶

Get list of gas species.

subroutine, public chemspeciesutils_mod::get_gas_species_list (
    type( statemanagertype ), intent(inout) container,
    character(len=32), dimension(:), intent(out), allocatable gas_species_list,
    integer, intent(out) rc
)

Parameters:

container StateManager containing chemical state
gas_species_list List of gas species names
rc Return code

function get_seasalt_species_list¶

Get list of sea salt species.

subroutine, public chemspeciesutils_mod::get_seasalt_species_list (
    type( statemanagertype ), intent(inout) container,
    character(len=32), dimension(:), intent(out), allocatable seasalt_species_list,
    integer, intent(out) rc
)

Parameters:

container StateManager containing chemical state
seasalt_species_list List of sea salt species names
rc Return code

function get_species_concentration_units¶

Get concentration units for a species.

subroutine, public chemspeciesutils_mod::get_species_concentration_units (
    type( statemanagertype ), intent(inout) container,
    character(len=*), intent(in) species_name,
    character(len=10), intent(out) units,
    integer, intent(out) rc
)

Parameters:

container StateManager containing chemical state
species_name Name of the species
units Units string ('v/v', 'kg/kg', etc.)
rc Return code

function get_species_index¶

Get the index of a single chemical species.

integer function, public chemspeciesutils_mod::get_species_index (
    type( statemanagertype ), intent(inout) container,
    character(len=*), intent(in) species_name,
    integer, intent(out) rc
)

Parameters:

container StateManager containing chemical state
species_name Name of the species to find
rc Return code

Returns:

Species index (> 0 if found, 0 if not found)

function get_species_indices¶

Get indices for multiple chemical species.

subroutine, public chemspeciesutils_mod::get_species_indices (
    type( statemanagertype ), intent(inout) container,
    character(len=*), dimension(:), intent(in) species_names,
    integer, dimension(:), intent(out) species_indices,
    integer, intent(out) rc
)

Parameters:

container StateManager containing chemical state
species_names Array of species names to find
species_indices Array of species indices (0 if not found)
rc Return code

function get_species_properties¶

Get properties of a chemical species.

subroutine, public chemspeciesutils_mod::get_species_properties (
    type( statemanagertype ), intent(inout) container,
    character(len=*), intent(in) species_name,
    type( speciestype ), intent(out) species,
    integer, intent(out) rc
)

Parameters:

container StateManager containing chemical state
species_name Name of the species
species Properties of the species
rc Return code

function get_tracer_species_list¶

Get list of tracer species.

subroutine, public chemspeciesutils_mod::get_tracer_species_list (
    type( statemanagertype ), intent(inout) container,
    character(len=32), dimension(:), intent(out), allocatable tracer_species_list,
    integer, intent(out) rc
)

Parameters:

container StateManager containing chemical state
tracer_species_list List of tracer species names
rc Return code

function parse_species_list¶

Parse a comma-separated species list.

subroutine, public chemspeciesutils_mod::parse_species_list (
    character(len=*), intent(in) species_string,
    character(len=32), dimension(:), intent(out) species_array,
    integer, intent(out) n_species
)

Parameters:

species_string Comma-separated species names
species_array Array of parsed species names
n_species Number of species parsed

The documentation for this class was generated from the following file src/core/ChemSpeciesUtils_Mod.F90