Namespace so4chemprocesscreator_mod¶
Namespace List > so4chemprocesscreator_mod
Public Functions¶
| Type | Name |
|---|---|
| subroutine, public | create_so4chem_process (class(processinterface), intent(out), allocatable process, integer, intent(out) rc) Create a new so4chem process instance. |
| subroutine, public | get_so4chem_default_config (character(len=*), intent(out) config_data) Get default configuration for so4chem process. |
| subroutine, public | register_so4chem_process (type(processmanagertype), intent(inout) process_mgr, integer, intent(out) rc) Register the so4chem process with a ProcessManager. |
Public Functions Documentation¶
function create_so4chem_process¶
Create a new so4chem process instance.
subroutine, public so4chemprocesscreator_mod::create_so4chem_process (
class( processinterface ), intent(out), allocatable process,
integer, intent(out) rc
)
This factory function creates and returns a new instance of the so4chem process. The process is not initialized - the caller must call the init() method with appropriate configuration.
Parameters:
processAllocated process instancercReturn code
function get_so4chem_default_config¶
Get default configuration for so4chem process.
subroutine, public so4chemprocesscreator_mod::get_so4chem_default_config (
character(len=*), intent(out) config_data
)
This function returns a default configuration string that can be used to initialize the so4chem process with reasonable defaults.
Parameters:
config_dataDefault configuration string
function register_so4chem_process¶
Register the so4chem process with a ProcessManager.
subroutine, public so4chemprocesscreator_mod::register_so4chem_process (
type( processmanagertype ), intent(inout) process_mgr,
integer, intent(out) rc
)
This subroutine registers the so4chem process with a ProcessManager's factory. This is the correct way to register processes for use in applications and integration tests.
Parameters:
process_mgrThe ProcessManager to register withrcReturn code
The documentation for this class was generated from the following file src/process/so4chem/SO4chemProcessCreator_Mod.F90