Namespace catchem_highlevel_api¶

Namespace List > catchem_highlevel_api

Public Functions¶

Type	Name
subroutine, public	catchem_add_process (type(catchemmodeltype), intent(inout) model, character(len=), intent(in) process_name, character(len=), intent(in), optional process_config, integer, intent(out) rc) Add a process to CATChem.
subroutine, public	catchem_finalize (type(catchemmodeltype), intent(inout) model, integer, intent(out) rc) Finalize CATChem.
subroutine, public	catchem_get_concentrations (type(catchemmodeltype), intent(in) model, real(fp), dimension(:,:,:,:), intent(out), allocatable concentrations, character(len=32), dimension(:), intent(out), allocatable species_names, integer, intent(out) rc) Get chemical concentrations.
subroutine, public	catchem_get_diagnostics (type(catchemmodeltype), intent(in) model, type(catchemdiagnosticstype), intent(out) diagnostics, integer, intent(out) rc) Get diagnostic data.
subroutine, public	catchem_init (type(catchemmodeltype), intent(out) model, type(catchemconfigtype), intent(in) config, integer, intent(out) rc) Initialize CATChem with simple configuration.
subroutine, public	catchem_run_timestep (type(catchemmodeltype), intent(inout) model, type(catchemdatatype), intent(in) met_data, type(catchemdatatype), intent(in) emis_data, integer, intent(out) rc) Run a single CATChem timestep.
subroutine, public	catchem_set_emissions (type(catchemmodeltype), intent(inout) model, type(catchemdatatype), intent(in) emis_data, integer, intent(out) rc) Set emission data.
subroutine, public	catchem_set_meteorology (type(catchemmodeltype), intent(inout) model, type(catchemdatatype), intent(in) met_data, integer, intent(out) rc) Set meteorological data.

Public Functions Documentation¶

function catchem_add_process¶

Add a process to CATChem.

subroutine, public catchem_highlevel_api::catchem_add_process (
    type( catchemmodeltype ), intent(inout) model,
    character(len=*), intent(in) process_name,
    character(len=*), intent(in), optional process_config,
    integer, intent(out) rc
)

function catchem_finalize¶

Finalize CATChem.

subroutine, public catchem_highlevel_api::catchem_finalize (
    type( catchemmodeltype ), intent(inout) model,
    integer, intent(out) rc
)

function catchem_get_concentrations¶

Get chemical concentrations.

subroutine, public catchem_highlevel_api::catchem_get_concentrations (
    type( catchemmodeltype ), intent(in) model,
    real(fp), dimension(:,:,:,:), intent(out), allocatable concentrations,
    character(len=32), dimension(:), intent(out), allocatable species_names,
    integer, intent(out) rc
)

function catchem_get_diagnostics¶

Get diagnostic data.

subroutine, public catchem_highlevel_api::catchem_get_diagnostics (
    type( catchemmodeltype ), intent(in) model,
    type( catchemdiagnosticstype ), intent(out) diagnostics,
    integer, intent(out) rc
)

function catchem_init¶

Initialize CATChem with simple configuration.

subroutine, public catchem_highlevel_api::catchem_init (
    type( catchemmodeltype ), intent(out) model,
    type( catchemconfigtype ), intent(in) config,
    integer, intent(out) rc
)

function catchem_run_timestep¶

Run a single CATChem timestep.

subroutine, public catchem_highlevel_api::catchem_run_timestep (
    type( catchemmodeltype ), intent(inout) model,
    type( catchemdatatype ), intent(in) met_data,
    type( catchemdatatype ), intent(in) emis_data,
    integer, intent(out) rc
)

function catchem_set_emissions¶

Set emission data.

subroutine, public catchem_highlevel_api::catchem_set_emissions (
    type( catchemmodeltype ), intent(inout) model,
    type( catchemdatatype ), intent(in) emis_data,
    integer, intent(out) rc
)

function catchem_set_meteorology¶

Set meteorological data.

subroutine, public catchem_highlevel_api::catchem_set_meteorology (
    type( catchemmodeltype ), intent(inout) model,
    type( catchemdatatype ), intent(in) met_data,
    integer, intent(out) rc
)

The documentation for this class was generated from the following file src/api/CATChem_HighLevel_API.F90