Namespace init_mod¶

Namespace List > init_mod

Public Functions¶

Public Functions Documentation¶

function finalize_catchem¶

Finalize CATChem and cleanup resources.

subroutine, public init_mod::finalize_catchem (
    type(statecontainertype), intent(inout) container,
    integer, intent(out) rc
) 

This routine performs cleanup of all CATChem components and resources.

Parameters:

• container StateContainer to finalize
• rc Return code

function initialize_catchem¶

Main CATChem initialization routine.

subroutine, public init_mod::initialize_catchem (
    type(statecontainertype), intent(out) container,
    character(len=*), intent(in) config_file,
    integer, intent(out) rc,
    character(len=*), intent(in), optional container_name
) 

This is the primary initialization routine that sets up a complete CATChem instance using the StateContainer pattern with comprehensive error handling.

Parameters:

• container Initialized StateContainer with all components
• config_file Path to configuration file
• container_name Optional name for the container
• rc Return code

function initialize_core_states¶

Initialize core state objects.

subroutine, public init_mod::initialize_core_states (
    type(statecontainertype), intent(inout) container,
    integer, intent(out) rc
) 

This routine initializes all core state objects (Met, Chem, Emis, Diag) within the StateContainer.

Parameters:

• container StateContainer to initialize
• rc Return code

function initialize_processes¶

Initialize atmospheric chemistry processes.

subroutine, public init_mod::initialize_processes (
    type(statecontainertype), intent(inout) container,
    integer, intent(out) rc
) 

This routine initializes all atmospheric chemistry processes (dust, seasalt, dry deposition, etc.) based on the loaded configuration.

Parameters:

• container StateContainer with processes to initialize
• rc Return code

function validate_initialization¶

Validate complete initialization.

subroutine, public init_mod::validate_initialization (
    type(statecontainertype), intent(inout) container,
    integer, intent(out) rc
) 

This routine performs comprehensive validation of the initialized StateContainer to ensure all components are properly set up and consistent.

Parameters:

• container StateContainer to validate
• rc Return code

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