Namespace species_mod¶

Namespace List > species_mod

Public Attributes¶

Public Functions¶

Public Attributes Documentation¶

variable missing_vv¶

Missing species concentration value.

real(fp), parameter, public species_mod::missing_vv;

Public Functions Documentation¶

function create_species_database¶

Create basic species database.

subroutine, public species_mod::create_species_database (
    type( speciesmanagertype ), intent(out) species_mgr,
    integer, intent(out) rc
) 

This subroutine creates a basic species database with common species.

Parameters:

• species_mgr Initialized species manager
• rc Return code

function find_species_by_name¶

Find species by name (standalone function)

integer function, public species_mod::find_species_by_name (
    type( speciestype ), dimension(:), intent(in) species_db,
    integer, intent(in) num_species,
    character(len=*), intent(in) species_name,
    integer, intent(out) rc
) 

This function provides species lookup functionality.

Parameters:

• species_db Array of species
• num_species Number of species in database
• species_name Name to search for
• rc Return code

function validate_species¶

Standalone species validation function.

logical function, public species_mod::validate_species (
    type( speciestype ), intent(in) species,
    integer, intent(out) rc
) 

This function provides species validation outside of the class methods.

Parameters:

• species Species to validate
• rc Return code

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