ICON Community Interface 0.4.0
Loading...
Searching...
No Matches
Host Interface

comin_host_interface.F90 More...

Data Types

interface  comin_metadata::comin_metadata_set_host
 Sets metadata for an exposed variable. Note: The host model uses the alias comin_metadata_set. More...
 
type  comin_plugin_types::t_comin_plugin_description
 Data type, describing the dynamic libraries. More...
 

Functions/Subroutines

recursive subroutine, public comin_callback::comin_callback_context_call (entry_point_id, domain_id, lacc)
 Routine to find callback routine associated with current entry point.
 
subroutine, public comin_descrdata::comin_descrdata_set_global (comin_global_info)
 Fill global data.
 
subroutine, public comin_descrdata::comin_descrdata_set_domain (comin_domain_info)
 Set up data type for grid data.
 
subroutine, public comin_descrdata::comin_descrdata_set_simulation_interval (comin_time_info)
 Fill time stamp info.
 
subroutine, public comin_descrdata::comin_current_set_datetime (sim_time_current)
 Update time stamp info, current time information.
 
subroutine, public comin_descrdata::comin_descrdata_set_timesteplength (jg, dt_current)
 Fill array with timestep.
 
subroutine, public comin_descrdata::comin_descrdata_finalize ()
 Clean descriptive data structure in ComIn currently no content but keep for future use.
 
subroutine, public comin_parallel::comin_parallel_mpi_handshake (comm, group_names, component_name)
 Procedure for the communicator splitting ("MPI handshake") that has been harmonized with the respective algorithm of the YAC coupler software.
 
subroutine, public comin_setup::comin_plugin_primaryconstructor (plugin_list)
 Execute primary constructors.
 
subroutine, public comin_setup::comin_setup_check (plugin_str, wp_check)
 Performs basic compatibility checks.
 
subroutine, public comin_setup::comin_setup_init (lstdout, output_unit)
 Initialize the comin stateThis routine needs to be called by the host before any other comin call.
 
subroutine, public comin_setup::comin_setup_finalize ()
 Destructor.
 
subroutine, public comin_setup::comin_descrdata_set_fct_glb2loc_cell (fct)
 Sets the "global-to-local" index lookup function.
 
subroutine, public comin_setup::comin_setup_errhandler (error_handler)
 Sets the global error handler procedure pointer.
 
subroutine, public comin_state::comin_setup_set_verbosity_level (iverbosity)
 Sets verbosity level, related to ICON's msg_level. 0 = silent.
 
integer function, public comin_state::comin_setup_get_verbosity_level ()
 Returns verbosity level.
 
type(c_ptr) function, public comin_variable::comin_request_get_list ()
 
subroutine, public comin_variable::comin_var_list_append (var_descr, cptr, device_ptr, array_shape, type_id, dim_semantics, lcontainer, ncontained, var_handle)
 Append item to variable list.
 
subroutine, public comin_variable::comin_var_list_finalize ()
 Destruct variable list, deallocate memory.
 
subroutine, public comin_variable::comin_var_request_list_finalize ()
 Destruct variable request list, deallocate memory.
 
subroutine, public mo_mpi_handshake::mpi_handshake (comm, group_names, group_comms)
 Procedure for the communicator splitting ("MPI handshake") that has been harmonized with the respective algorithm of the YAC coupler software.
 

Detailed Description

comin_host_interface.F90

ComIn entities exposed to the host model (e.g. ICON).

Entities that are exposed to both, the host interface and the plugin interface are listed in the group Common.

Function/Subroutine Documentation

◆ comin_callback_context_call()

recursive subroutine, public comin_callback::comin_callback_context_call ( integer, intent(in) entry_point_id,
integer, intent(in) domain_id,
logical, intent(in) lacc )

Routine to find callback routine associated with current entry point.

call callback functions given by order in entry_point_order

Definition at line 145 of file comin_callback.F90.

Here is the call graph for this function:

◆ comin_current_set_datetime()

subroutine, public comin_descrdata::comin_current_set_datetime ( character(len=*), intent(in) sim_time_current)

Update time stamp info, current time information.

Definition at line 85 of file comin_descrdata.F90.

◆ comin_descrdata_finalize()

subroutine, public comin_descrdata::comin_descrdata_finalize

Clean descriptive data structure in ComIn currently no content but keep for future use.

Definition at line 193 of file comin_descrdata.F90.

◆ comin_descrdata_set_domain()

subroutine, public comin_descrdata::comin_descrdata_set_domain ( type(t_comin_descrdata_domain), dimension(:), intent(in) comin_domain_info)

Set up data type for grid data.

Definition at line 54 of file comin_descrdata.F90.

◆ comin_descrdata_set_fct_glb2loc_cell()

subroutine, public comin_setup::comin_descrdata_set_fct_glb2loc_cell ( procedure(comin_glb2loc_index_lookup_fct) fct)

Sets the "global-to-local" index lookup function.

Parameters
fctindex lookup function

Definition at line 359 of file comin_setup.F90.

Here is the call graph for this function:

◆ comin_descrdata_set_global()

subroutine, public comin_descrdata::comin_descrdata_set_global ( type(t_comin_descrdata_global), intent(in) comin_global_info)

Fill global data.

Definition at line 47 of file comin_descrdata.F90.

◆ comin_descrdata_set_simulation_interval()

subroutine, public comin_descrdata::comin_descrdata_set_simulation_interval ( type(t_comin_descrdata_simulation_interval), intent(in) comin_time_info)

Fill time stamp info.

Definition at line 61 of file comin_descrdata.F90.

◆ comin_descrdata_set_timesteplength()

subroutine, public comin_descrdata::comin_descrdata_set_timesteplength ( integer, intent(in) jg,
real(wp), intent(in) dt_current )

Fill array with timestep.

Definition at line 180 of file comin_descrdata.F90.

◆ comin_parallel_mpi_handshake()

subroutine, public comin_parallel::comin_parallel_mpi_handshake ( integer, intent(in) comm,
character(len=max_grpnamelen), dimension(:), intent(in) group_names,
character(len=*), intent(in) component_name )

Procedure for the communicator splitting ("MPI handshake") that has been harmonized with the respective algorithm of the YAC coupler software.

Definition at line 48 of file comin_parallel.F90.

Here is the call graph for this function:

◆ comin_plugin_primaryconstructor()

subroutine, public comin_setup::comin_plugin_primaryconstructor ( type(t_comin_plugin_description), dimension(:), intent(in), target plugin_list)

Execute primary constructors.

Parameters
[in]plugin_listlist of dynamic libs:

Definition at line 137 of file comin_setup.F90.

Here is the call graph for this function:

◆ comin_request_get_list()

type(c_ptr) function, public comin_variable::comin_request_get_list
Returns
head of variable list.

Definition at line 107 of file comin_variable.F90.

Here is the call graph for this function:

◆ comin_setup_check()

subroutine, public comin_setup::comin_setup_check ( character(len=*), intent(in) plugin_str,
integer, intent(in) wp_check )

Performs basic compatibility checks.

Parameters
[in]plugin_strplugin name
[in]wp_checkKIND value for compatibility checks.

Definition at line 206 of file comin_setup.F90.

Here is the call graph for this function:

◆ comin_setup_errhandler()

subroutine, public comin_setup::comin_setup_errhandler ( procedure(comin_host_errhandler_fct) error_handler)

Sets the global error handler procedure pointer.

To be called by the host application (ICON).

Aborts with an error code if the error handler has already been set.

Parameters
error_handlererror handler

Definition at line 374 of file comin_setup.F90.

Here is the call graph for this function:

◆ comin_setup_finalize()

subroutine, public comin_setup::comin_setup_finalize

Destructor.

Definition at line 289 of file comin_setup.F90.

Here is the call graph for this function:

◆ comin_setup_get_verbosity_level()

integer function, public comin_state::comin_setup_get_verbosity_level

Returns verbosity level.

Definition at line 120 of file comin_state.F90.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ comin_setup_init()

subroutine, public comin_setup::comin_setup_init ( logical, intent(in) lstdout,
integer, intent(in), optional output_unit )

Initialize the comin stateThis routine needs to be called by the host before any other comin call.

Parameters
[in]lstdoutdo print on stdout or not
[in]output_unitoutput unit to print messages to

Definition at line 273 of file comin_setup.F90.

Here is the call graph for this function:

◆ comin_setup_set_verbosity_level()

subroutine, public comin_state::comin_setup_set_verbosity_level ( integer, intent(in) iverbosity)

Sets verbosity level, related to ICON's msg_level. 0 = silent.

Definition at line 112 of file comin_state.F90.

◆ comin_var_list_append()

subroutine, public comin_variable::comin_var_list_append ( type(t_comin_var_descriptor), intent(in) var_descr,
type(c_ptr), intent(in) cptr,
type(c_ptr), intent(in) device_ptr,
integer, dimension(5), intent(in) array_shape,
integer, intent(in) type_id,
integer, dimension(5), intent(in) dim_semantics,
logical, intent(in) lcontainer,
integer, intent(in) ncontained,
type(t_comin_var_handle), intent(out) var_handle )

Append item to variable list.

Definition at line 160 of file comin_variable.F90.

Here is the call graph for this function:

◆ comin_var_list_finalize()

subroutine, public comin_variable::comin_var_list_finalize

Destruct variable list, deallocate memory.

Definition at line 220 of file comin_variable.F90.

◆ comin_var_request_list_finalize()

subroutine, public comin_variable::comin_var_request_list_finalize

Destruct variable request list, deallocate memory.

Definition at line 239 of file comin_variable.F90.

Here is the call graph for this function:

◆ mpi_handshake()

subroutine, public mo_mpi_handshake::mpi_handshake ( integer, intent(in) comm,
character(len=max_groupname_len), dimension(:), intent(in) group_names,
integer, dimension(size(group_names)), intent(inout) group_comms )

Procedure for the communicator splitting ("MPI handshake") that has been harmonized with the respective algorithm of the YAC coupler software.

Definition at line 23 of file mo_mpi_handshake.F90.

Here is the call graph for this function:
Here is the caller graph for this function: