 |
ComIn 0.5.1
ICON Community Interface
|
|
ComIn 0.5.1
ICON Community Interface
|
Data Structures | |
| class | variable |
| class | entry_point |
| class | plugin_info |
| class | metadata |
| class | simulation_interval |
Functions | |
| void | comin_callback_register (t_comin_entry_point entry_point, t_comin_callback_function fct_ptr) |
| static PyObject * | callback_get_ep_name (PyObject *, PyObject *args, PyObject *kwargs) |
| register_callback (entry_point ep) | |
| simulation_interval | descrdata_get_simulation_interval () |
| static PyObject * | descrdata_get_timesteplength (PyObject *, PyObject *args, PyObject *kwargs) |
| static PyObject * | descrdata_get_index (PyObject *, PyObject *args, PyObject *kwargs) |
| static PyObject * | descrdata_get_block (PyObject *, PyObject *args, PyObject *kwargs) |
| template<BlockLimitGetterFn get_block_limits> | |
| static PyObject * | descrdata_get_block_limits (PyObject *, PyObject *args, PyObject *kwargs) |
| template<IndexGetterFn get_indices> | |
| static PyObject * | descrdata_get_indices (PyObject *, PyObject *args, PyObject *kwargs) |
| static PyObject * | descrdata_get_cell_npromz (PyObject *, PyObject *args, PyObject *kwargs) |
| static PyObject * | descrdata_get_edge_npromz (PyObject *, PyObject *args, PyObject *kwargs) |
| static PyObject * | descrdata_get_vert_npromz (PyObject *, PyObject *args, PyObject *kwargs) |
| static PyObject * | current_get_datetime (PyObject *, PyObject *) |
| static PyObject * | current_get_domain_id (PyObject *, PyObject *) |
| static PyObject * | descrdata_index_lookup_glb2loc_cell (PyObject *, PyObject *args, PyObject *kwargs) |
| static PyObject * | descrdata_index_lookup_glb2loc_edge (PyObject *, PyObject *args, PyObject *kwargs) |
| static PyObject * | descrdata_index_lookup_glb2loc_vert (PyObject *, PyObject *args, PyObject *kwargs) |
| static PyObject * | setup_get_version (PyObject *, PyObject *) |
| static PyObject * | parallel_get_host_mpi_comm (PyObject *, PyObject *) |
| static PyObject * | parallel_get_plugin_mpi_comm (PyObject *, PyObject *) |
| static PyObject * | parallel_get_host_mpi_rank (PyObject *, PyObject *) |
| static PyObject * | print_debug (PyObject *, PyObject *args, PyObject *kwargs) |
| static PyObject * | print_info (PyObject *, PyObject *args, PyObject *kwargs) |
| static PyObject * | print_warning (PyObject *, PyObject *args, PyObject *kwargs) |
| static PyObject * | var_request_add (PyObject *, PyObject *args, PyObject *kwargs) |
| static PyObject * | metadata_get (PyObject *, PyObject *args, PyObject *kwargs) |
| class comin::variable |
| class comin::entry_point |
| class comin::plugin_info |
| class comin::metadata |
| class comin::simulation_interval |
|
static |
Get the name of an entry point.
Python signature: callback_get_ep_name(entry_point : EntryPoint) -> str
Definition at line 81 of file callbacks.cpp.
| void comin_callback_register | ( | t_comin_entry_point | entry_point, |
| t_comin_callback_function | fct_ptr ) |
Routine to register new callbacks during primary constructor.
| entry_point | ID of the entry point (1-based). |
| fct_ptr | Function to call. |
If the plugin has already registered a callback for this entry point, this function prints a warning and ignores the new callback.
Definition at line 33 of file comin_callback.cpp.
|
static |
Get current datetime string.
Python function name: current_get_datetime() -> str
Definition at line 271 of file descrdata.cpp.
|
static |
Get current domain ID.
Python function name: current_get_domain_id() -> int
Definition at line 286 of file descrdata.cpp.
| plugin_info current_get_plugin_info | ( | ) |
|
static |
get block index.
Python signature: descrdata_get_block(i : int) -> int
Definition at line 114 of file descrdata.cpp.
|
static |
get block limits.
Python signature: descrdata_get_cell_block_limits(jg : int, irl_start : int,
irl_end : int) -> Tuple[int,int]
Python signature: descrdata_get_edge_block_limits(jg : int, irl_start : int,
irl_end : int) -> Tuple[int,int]
Python signature: descrdata_get_vert_block_limits(jg : int, irl_start : int,
irl_end : int) -> Tuple[int,int]
Definition at line 147 of file descrdata.cpp.
|
static |
get npromz.
Python signature: descrdata_get_cell_npromz(jg : int) -> int
Definition at line 211 of file descrdata.cpp.
| _descrdata descrdata_get_domain | ( | int | jg | ) |
|
static |
get npromz.
Python signature: descrdata_get_edge_npromz(jg : int) -> int
Definition at line 231 of file descrdata.cpp.
| _descrdata descrdata_get_global | ( | ) |
|
static |
get nproma index.
Python signature: descrdata_get_index(i : int) -> int
Definition at line 94 of file descrdata.cpp.
|
static |
get indices.
Python signature: descrdata_get_cell_indices(jg : int, i_blk : int,
i_startblk : int, i_endblk : int, irl_start : int, irl_end :int) -> Tuple[int,int]
Python signature: descrdata_get_edge_indices(jg : int, i_blk : int,
i_startblk : int, i_endblk : int, irl_start : int, irl_end :int) -> Tuple[int,int]
Python signature: descrdata_get_vert_indices(jg : int, i_blk : int,
i_startblk : int, i_endblk : int, irl_start : int, irl_end :int) -> Tuple[int,int]
Definition at line 186 of file descrdata.cpp.
| simulation_interval descrdata_get_simulation_interval | ( | ) |
|
static |
Get timestep length for domain.
Python signature: descrdata_get_timesteplength(jg : int) -> float
Definition at line 73 of file descrdata.cpp.
|
static |
get npromz.
Python signature: descrdata_get_vert_npromz(jg : int) -> int
Definition at line 251 of file descrdata.cpp.
|
static |
Maps global to local indices.
Python function name: descrdata_index_lookup_glb2loc_cell(jg : int,
global_index : int) -> int
Definition at line 305 of file descrdata.cpp.
|
static |
Maps global to local indices.
Python function name: descrdata_index_lookup_glb2loc_edge(jg : int,
global_index : int) -> int
Definition at line 328 of file descrdata.cpp.
|
static |
Maps global to local indices.
Python function name: descrdata_index_lookup_glb2loc_vert(jg : int,
global_index : int) -> int
Definition at line 351 of file descrdata.cpp.
|
static |
Retrieve metadata for a variable.
Python function: metadata_get(var_descriptor : Tuple[str, int], key : str) -> int | float | str
Definition at line 126 of file variables.cpp.
| metadata_set | ( | Tuple[str, int] | var_descriptor, |
| ** | kwargs ) |
|
static |
Host MPI Communicator.
Python function name: parallel_get_host_mpi_comm() -> int
Definition at line 389 of file descrdata.cpp.
|
static |
Rank number in host communicator.
Python function name: parallel_get_host_mpi_rank() -> int
Definition at line 421 of file descrdata.cpp.
|
static |
Plugin MPI Communicator.
Python function name: parallel_get_plugin_mpi_comm() -> int
Definition at line 405 of file descrdata.cpp.
|
static |
Print debug message through ComIn's message system.
Python signature: print_debug(msg : str) -> None
Definition at line 435 of file descrdata.cpp.
|
static |
Print info message through ComIn's message system.
Python signature: print_info(msg : str) -> None
Definition at line 461 of file descrdata.cpp.
|
static |
Print warning message through ComIn's message system.
Python signature: print_warning(msg : str) -> None
Definition at line 487 of file descrdata.cpp.
| register_callback | ( | entry_point | ep | ) |
|
static |
Get version.
Python function name: setup_get_version() -> Tuple[int, int, int]
Definition at line 373 of file descrdata.cpp.
| var_get | ( | List[entry_point] | context, |
| Tuple[str, int] | var_descriptor, | ||
| int | flag ) |
|
static |
Request the host model to add a variable.
Python signature: var_request_add(var_descriptor : Tuple[str,int], lmodexclusive : bool = False) -> None
Definition at line 35 of file variables.cpp.
1.13.2