ComIn 0.5.1
ICON Community Interface
Loading...
Searching...
No Matches
comin_host_interface.F90
Go to the documentation of this file.
1!> comin_host_interface.F90
2!! @brief ComIn entities exposed to the host model (e.g. ICON).
3!!
4!
5! - No actual implementations within this module
6!
7! @authors 01/2023 :: ICON Community Interface <comin@icon-model.org>
8!
9! SPDX-License-Identifier: BSD-3-Clause
10!
11! See LICENSES for license information.
12! Where software is supplied by third parties, it is indicated in the
13! headers of the routines.
14!
16
17 USE comin_setup, ONLY: comin_setup_check, &
26
67 & ep_finish, &
68 & ep_destructor, &
126
127 IMPLICIT NONE
128
129 PRIVATE
130
131#include "comin_global.inc"
132
133 ! From comin_state:
138 PUBLIC :: comin_setup_errhandler
139
140 ! From comin_setup:
141 PUBLIC :: comin_setup_init
144
145 ! From comin_plugin_types:
147
148 ! From comin_callback:
150
151 PUBLIC :: ep_secondary_constructor, &
191 & ep_finish, &
194
196 INTEGER, PARAMETER :: comin_domain_outside_loop = domain_outside_loop
197
208 PUBLIC :: comin_dim_semantics_undef, &
216
217 ! From comin_var_request
222 PUBLIC :: comin_var_request_find
225
226 ! From comin_variable:
236 PUBLIC :: comin_var_set_cptr
237 PUBLIC :: comin_var_is_used
238 ! From comin_metadata:
239 PUBLIC :: comin_metadata_set
242 PUBLIC :: comin_metadata_get_or
243 PUBLIC :: comin_metadata_get
244 ! From comin_metadata_types:
246 PUBLIC :: t_comin_var_metadata
247 ! From comin_parallel:
250
251 ! From comin_descrdata:
257
258 ! From mo_mpi_handshake
260
261 ! From comin_errhandler_types
262 PUBLIC :: comin_success
263
264END MODULE comin_host_interface
const char * comin_callback_get_ep_name(t_comin_entry_point iep)
t_comin_metadata_typeid comin_metadata_get_typeid(t_comin_var_descriptor var_descriptor, const char *key)
void comin_setup_get_version(unsigned int *major, unsigned int *minor, unsigned int *patch)
void comin_plugin_primaryconstructor(const t_comin_plugin_description *plugin_list, int num_plugins)
void comin_descrdata_set_fct_glb2loc_cell(t_comin_glb2loc_index_lookup_fct_ptr fct)
void comin_descrdata_set_fct_glb2loc_edge(t_comin_glb2loc_index_lookup_fct_ptr fct)
void comin_descrdata_set_fct_glb2loc_vert(t_comin_glb2loc_index_lookup_fct_ptr fct)
comin::keyval::Map * comin_var_request_get_metadata(t_comin_request_item *req)
t_comin_request_item * comin_var_request_find(const t_comin_var_descriptor *var_desc)
t_comin_var_descriptor * comin_var_request_get_descriptor(t_comin_request_item *req)
void comin_var_get_descr_list_var_desc(t_comin_var_descr_list_iterator *current, t_comin_var_descriptor *var_desc)
bool comin_var_is_used(const t_comin_var_descriptor *descr)
Global data is invariant wrt the computational grid and never changed or updated.
Read-only access to additional information about a given variable.
Sets metadata for a requested ComIn variable. Note:Plugins use the alias comin_metadata_set.
Variable pointer. Fortran interface for accessing variables.
Get first element of variable descriptor list. Returns a C-pointer that can be evaluated with the aux...
Patch grid data structure, gathering information on grids.
Get next element of variable descriptor list. Returns a C-pointer that can be evaluated with the auxi...
The elements of this derived data type describe the current community interface.
integer function, public comin_parallel_get_host_mpi_comm()
Returns the communicator with all ICON processes.
subroutine, public comin_metadata_get_iterator(var_descriptor, iterator)
Return a metadata container iterator.
Sets metadata for an exposed variable. Note: The host model uses the alias comin_metadata_set.
Create a new request list iterator, at the begin of the list.
Compare the request list iterator with the end of the list.
Advance the iterator to the next element, returning the current one.
subroutine, public comin_descrdata_set_simulation_interval(exp_start, exp_stop, run_start, run_stop)
Fill time stamp info.
subroutine, public comin_descrdata_finalize()
Clean descriptive data structure in ComIn currently no content but keep for future use.
subroutine, public comin_descrdata_set_domain(comin_domain_info)
Set up data type for grid data.
subroutine, public comin_current_set_datetime(sim_time_current)
Update time stamp info, current time information.
subroutine, public comin_descrdata_set_global(comin_global_info)
Fill global data.
comin_host_interface.F90
integer, parameter, public comin_domain_outside_loop
subroutine, public comin_parallel_mpi_handshake(comm, group_names, component_name)
Procedure for the communicator splitting ("MPI handshake") that has been harmonized with the respecti...
subroutine, public comin_setup_finalize()
Destructor.
subroutine, public comin_setup_errhandler(error_handler)
Sets the global error handler procedure pointer.
subroutine, public comin_setup_init(lstdout, output_unit)
Initialize the comin state This routine needs to be called by the host before any other comin call.
subroutine, public comin_setup_check(plugin_str, wp_check)
Performs basic compatibility checks.
logical function comin_var_descr_match(var_descriptor1, var_descriptor2)
compare two variable descriptors.
subroutine, public comin_var_set_cptr(var, cptr)
subroutine, public comin_var_list_finalize()
Destruct variable list, deallocate memory.
subroutine, public comin_var_set_sync_device_mem(sync_device_mem)
subroutine, public comin_var_set_sync_halo(sync_halo)
subroutine, public 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 mpi_handshake(comm, group_names, group_comms)
Procedure for the communicator splitting ("MPI handshake") that has been harmonized with the respecti...
subroutine, public mpi_handshake_dummy(comm)