Namespace settlingprocesscreator_mod¶

Namespace List > settlingprocesscreator_mod

Public Functions¶

Public Functions Documentation¶

function create_settling_process¶

Create a new settling process instance.

subroutine, public settlingprocesscreator_mod::create_settling_process (
    class( processinterface ), intent(out), allocatable process,
    integer, intent(out) rc
) 

This factory function creates and returns a new instance of the settling process. The process is not initialized - the caller must call the init() method with appropriate configuration.

Parameters:

• process Allocated process instance
• rc Return code

function get_settling_default_config¶

Get default configuration for settling process.

subroutine, public settlingprocesscreator_mod::get_settling_default_config (
    character(len=*), intent(out) config_data
) 

This function returns a default configuration string that can be used to initialize the settling process with reasonable defaults.

Parameters:

• config_data Default configuration string

function register_settling_process¶

Register the settling process with a ProcessManager.

subroutine, public settlingprocesscreator_mod::register_settling_process (
    type( processmanagertype ), intent(inout) process_mgr,
    integer, intent(out) rc
) 

This subroutine registers the settling process with a ProcessManager's factory. This is the correct way to register processes for use in applications and integration tests.

Parameters:

• process_mgr The ProcessManager to register with
• rc Return code

The documentation for this class was generated from the following file src/process/settling/SettlingProcessCreator_Mod.F90