ComIn 0.5.1
ICON Community Interface
Loading...
Searching...
No Matches
Categories | Data Structures
C Interface

Categories

 Descriptive Data
 

Data Structures

struct  t_comin_var_descriptor
 

Detailed Description

Data Type Documentation

◆ t_comin_var_descriptor

struct t_comin_var_descriptor

Definition at line 36 of file comin.h.

Data Fields
int id
char name[COMIN_MAX_LEN_VAR_NAME+1]

Typedef Documentation

◆ t_comin_callback_function

typedef void(* t_comin_callback_function) (void)

Definition at line 255 of file comin.h.

◆ t_comin_var_descr_list_iterator

typedef struct t_comin_var_descr_list_iterator t_comin_var_descr_list_iterator

Definition at line 46 of file comin.h.

◆ t_comin_var_handle

typedef struct t_comin_var_handle t_comin_var_handle

Definition at line 42 of file comin.h.

Enumeration Type Documentation

◆ t_comin_dim_semantics

enum t_comin_dim_semantics
Enumerator
COMIN_DIM_SEMANTICS_UNDEF 
COMIN_DIM_SEMANTICS_NPROMA 
COMIN_DIM_SEMANTICS_BLOCK 
COMIN_DIM_SEMANTICS_UNBLOCK 
COMIN_DIM_SEMANTICS_LEVEL 
COMIN_DIM_SEMANTICS_CONTAINER 
COMIN_DIM_SEMANTICS_OTHER 
COMIN_DIM_SEMANTICS_UNUSED 

Definition at line 173 of file comin.h.

◆ t_comin_entry_point

enum t_comin_entry_point
Enumerator
EP_SECONDARY_CONSTRUCTOR 
EP_ATM_YAC_DEFCOMP_BEFORE 
EP_ATM_YAC_DEFCOMP_AFTER 
EP_ATM_YAC_SYNCDEF_BEFORE 
EP_ATM_YAC_SYNCDEF_AFTER 
EP_ATM_YAC_ENDDEF_BEFORE 
EP_ATM_YAC_ENDDEF_AFTER 
EP_ATM_INIT_FINALIZE 
EP_ATM_TIMELOOP_BEFORE 
EP_ATM_TIMELOOP_START 
EP_ATM_TIMELOOP_END 
EP_ATM_TIMELOOP_AFTER 
EP_ATM_INTEGRATE_BEFORE 
EP_ATM_INTEGRATE_START 
EP_ATM_INTEGRATE_END 
EP_ATM_INTEGRATE_AFTER 
EP_ATM_WRITE_OUTPUT_BEFORE 
EP_ATM_WRITE_OUTPUT_AFTER 
EP_ATM_CHECKPOINT_BEFORE 
EP_ATM_CHECKPOINT_AFTER 
EP_ATM_ADVECTION_BEFORE 
EP_ATM_ADVECTION_AFTER 
EP_ATM_PHYSICS_BEFORE 
EP_ATM_PHYSICS_AFTER 
EP_ATM_NUDGING_BEFORE 
EP_ATM_NUDGING_AFTER 
EP_ATM_SURFACE_BEFORE 
EP_ATM_SURFACE_AFTER 
EP_ATM_TURBULENCE_BEFORE 
EP_ATM_TURBULENCE_AFTER 
EP_ATM_MICROPHYSICS_BEFORE 
EP_ATM_MICROPHYSICS_AFTER 
EP_ATM_CONVECTION_BEFORE 
EP_ATM_CONVECTION_AFTER 
EP_ATM_RADIATION_BEFORE 
EP_ATM_RADIATION_AFTER 
EP_ATM_RADHEAT_BEFORE 
EP_ATM_RADHEAT_AFTER 
EP_ATM_GWDRAG_BEFORE 
EP_ATM_GWDRAG_AFTER 
EP_FINISH 
EP_DESTRUCTOR 

Definition at line 51 of file comin.h.

◆ t_comin_error_code

enum t_comin_error_code
Enumerator
COMIN_SUCCESS 
COMIN_INFO 
COMIN_WARNING 
COMIN_ERROR_STATUS 
COMIN_ERROR_CALLBACK_REGISTER_OUTSIDE_PRIMARYCONSTRUCTOR 
COMIN_ERROR_CALLBACK_COMPLETE 
COMIN_ERROR_CALLBACK_EP_ID_UNKNOWN 
COMIN_ERROR_DESCRDATA_SET_FCT_GLB2LOC 
COMIN_ERROR_DESCRDATA_FINALIZE 
COMIN_ERROR_METADATA_SET_OUTSIDE_PRIMARYCONSTRUCTOR 
COMIN_ERROR_METADATA_KEY_NOT_FOUND 
COMIN_ERROR_METADATA_GET_INSIDE_PRIMARYCONSTRUCTOR 
COMIN_ERROR_SETUP_FINALIZE 
COMIN_ERROR_SETUP_COMIN_ALREADY_INITIALIZED 
COMIN_ERROR_SETUP_ERRHANDLER_NOT_ASSOCIATED 
COMIN_ERROR_SETUP_ERRHANDLER_NOT_SET 
COMIN_ERROR_SETUP_PRECISION_TEST_FAILED 
COMIN_ERROR_VAR_REQUEST_AFTER_PRIMARYCONSTRUCTOR 
COMIN_ERROR_VAR_REQUEST_EXISTS_IS_LMODEXCLUSIVE 
COMIN_ERROR_VAR_REQUEST_EXISTS_REQUEST_LMODEXCLUSIVE 
COMIN_ERROR_VAR_DESCRIPTOR_NOT_FOUND 
COMIN_ERROR_VAR_ITEM_NOT_ASSOCIATED 
COMIN_ERROR_FIELD_NOT_ALLOCATED 
COMIN_ERROR_POINTER_NOT_ASSOCIATED 
COMIN_ERROR_TRACER_REQUEST_NOT_FOR_ALL_DOMAINS 
COMIN_ERROR_VAR_SYNC_DEVICE_MEM_NOT_ASSOCIATED 
COMIN_ERROR_VAR_SYNC_HALO_NOT_ASSOCIATED 
COMIN_ERROR_VAR_GET_OUTSIDE_SECONDARY_CONSTRUCTOR 
COMIN_ERROR_VAR_GET_NO_DEVICE 
COMIN_ERROR_VAR_GET_VARIABLE_NOT_FOUND 
COMIN_ERROR_VAR_GET_CONTAINER_CAN_NOT_HALO_SYNCHRONIZED 
COMIN_ERROR_VAR_GET_IRREGULAR_VAR_CAN_NOT_HALO_SYNCHRONIZED 
COMIN_ERROR_VAR_SYNC_HALO_NOT_SUPPORTED_ZAXIS 
COMIN_ERROR_VAR_METADATA_INCONSISTENT_TYPE 
COMIN_ERROR_VAR_GET_VARIABLE_WRONG_TYPE 
COMIN_ERROR_INDEX_OUT_OF_BOUNDS 
COMIN_ERROR_DESCRDATA_TIMESTEPLENGTH_NOT_SET 
COMIN_ERROR_FATAL 

Definition at line 112 of file comin.h.

◆ t_comin_hgrid_id

enum t_comin_hgrid_id
Enumerator
COMIN_HGRID_UNSTRUCTURED_CELL 
COMIN_HGRID_UNSTRUCTURED_EDGE 
COMIN_HGRID_UNSTRUCTURED_VERTEX 

Definition at line 153 of file comin.h.

◆ t_comin_log_severity

enum t_comin_log_severity
Enumerator
COMIN_SEVERITY_DEBUG 

Show debug and more severe messages.

COMIN_SEVERITY_INFO 

Show info and more severe messages.

COMIN_SEVERITY_WARNING 

Show warning and more severe messages.

COMIN_SEVERITY_ERROR 

Show only error messages.

Definition at line 184 of file comin.h.

◆ t_comin_metadata_typeid

enum t_comin_metadata_typeid
Enumerator
COMIN_METADATA_TYPEID_UNDEFINED 
COMIN_METADATA_TYPEID_INT 
COMIN_METADATA_TYPEID_DOUBLE 
COMIN_METADATA_TYPEID_STRING 
COMIN_METADATA_TYPEID_BOOL 

Definition at line 159 of file comin.h.

◆ t_comin_var_access_flag

enum t_comin_var_access_flag
Enumerator
COMIN_FLAG_NONE 
COMIN_FLAG_READ 
COMIN_FLAG_WRITE 
COMIN_FLAG_SYNC_HALO 
COMIN_FLAG_DEVICE 

Definition at line 104 of file comin.h.

◆ t_comin_var_datatype

enum t_comin_var_datatype
Enumerator
COMIN_VAR_DATATYPE_DOUBLE 
COMIN_VAR_DATATYPE_FLOAT 
COMIN_VAR_DATATYPE_INT 

Definition at line 167 of file comin.h.

◆ t_comin_zaxis

enum t_comin_zaxis
Enumerator
COMIN_ZAXIS_UNDEF 
COMIN_ZAXIS_NONE 
COMIN_ZAXIS_2D 
COMIN_ZAXIS_3D 
COMIN_ZAXIS_3D_HALF 

Definition at line 96 of file comin.h.

Function Documentation

◆ comin_callback_get_ep_name()

const char * comin_callback_get_ep_name ( t_comin_entry_point iep)

◆ comin_callback_register()

void comin_callback_register ( t_comin_entry_point entry_point_id,
t_comin_callback_function fct_ptr )

◆ comin_current_get_datetime()

const char * comin_current_get_datetime ( void )

◆ comin_current_get_domain_id()

int comin_current_get_domain_id ( void )

◆ comin_current_get_ep()

t_comin_entry_point comin_current_get_ep ( void )

◆ comin_current_get_plugin_comm()

const char * comin_current_get_plugin_comm ( void )

◆ comin_current_get_plugin_id()

int comin_current_get_plugin_id ( void )

◆ comin_current_get_plugin_log_severity()

t_comin_log_severity comin_current_get_plugin_log_severity ( void )

◆ comin_current_get_plugin_name()

const char * comin_current_get_plugin_name ( void )

◆ comin_current_get_plugin_options()

const char * comin_current_get_plugin_options ( void )

◆ comin_descrdata_get_block()

int comin_descrdata_get_block ( int j)

◆ comin_descrdata_get_cell_block_limits()

void comin_descrdata_get_cell_block_limits ( int jg,
int irl_start,
int irl_end,
int * i_startblk,
int * i_endblk )

◆ comin_descrdata_get_cell_indices()

void comin_descrdata_get_cell_indices ( int jg,
int i_blk,
int i_startblk,
int i_endblk,
int * i_startidx,
int * i_endidx,
int irl_start,
int irl_end )

◆ comin_descrdata_get_cell_npromz()

int comin_descrdata_get_cell_npromz ( int jg)

◆ comin_descrdata_get_edge_block_limits()

void comin_descrdata_get_edge_block_limits ( int jg,
int irl_start,
int irl_end,
int * i_startblk,
int * i_endblk )

◆ comin_descrdata_get_edge_indices()

void comin_descrdata_get_edge_indices ( int jg,
int i_blk,
int i_startblk,
int i_endblk,
int * i_startidx,
int * i_endidx,
int irl_start,
int irl_end )

◆ comin_descrdata_get_edge_npromz()

int comin_descrdata_get_edge_npromz ( int jg)

◆ comin_descrdata_get_index()

int comin_descrdata_get_index ( int j)

◆ comin_descrdata_get_simulation_interval_exp_start()

const char * comin_descrdata_get_simulation_interval_exp_start ( )

◆ comin_descrdata_get_simulation_interval_exp_stop()

const char * comin_descrdata_get_simulation_interval_exp_stop ( )

◆ comin_descrdata_get_simulation_interval_run_start()

const char * comin_descrdata_get_simulation_interval_run_start ( )

◆ comin_descrdata_get_simulation_interval_run_stop()

const char * comin_descrdata_get_simulation_interval_run_stop ( )

◆ comin_descrdata_get_timesteplength()

double comin_descrdata_get_timesteplength ( int jg)

◆ comin_descrdata_get_vert_block_limits()

void comin_descrdata_get_vert_block_limits ( int jg,
int irl_start,
int irl_end,
int * i_startblk,
int * i_endblk )

◆ comin_descrdata_get_vert_indices()

void comin_descrdata_get_vert_indices ( int jg,
int i_blk,
int i_startblk,
int i_endblk,
int * i_startidx,
int * i_endidx,
int irl_start,
int irl_end )

◆ comin_descrdata_get_vert_npromz()

int comin_descrdata_get_vert_npromz ( int jg)

◆ comin_descrdata_index_lookup_glb2loc_cell()

int comin_descrdata_index_lookup_glb2loc_cell ( int jg,
int global_idx )

◆ comin_descrdata_index_lookup_glb2loc_edge()

int comin_descrdata_index_lookup_glb2loc_edge ( int jg,
int global_idx )

◆ comin_descrdata_index_lookup_glb2loc_vert()

int comin_descrdata_index_lookup_glb2loc_vert ( int jg,
int global_idx )

◆ comin_error_check()

void comin_error_check ( )

◆ comin_error_get()

t_comin_error_code comin_error_get ( void )

◆ comin_error_get_category()

const char * comin_error_get_category ( t_comin_error_code error_code)

◆ comin_error_get_string()

const char * comin_error_get_string ( t_comin_error_code error_code)

◆ comin_error_reset()

void comin_error_reset ( void )

◆ comin_error_set_errors_return()

void comin_error_set_errors_return ( bool errors_return)

◆ comin_metadata_get_bool()

bool comin_metadata_get_bool ( t_comin_var_descriptor var_descriptor,
const char * key )

◆ comin_metadata_get_double()

double comin_metadata_get_double ( t_comin_var_descriptor var_descriptor,
const char * key )

◆ comin_metadata_get_int()

int comin_metadata_get_int ( t_comin_var_descriptor var_descriptor,
const char * key )

◆ comin_metadata_get_iterator_begin()

t_comin_metadata_iterator * comin_metadata_get_iterator_begin ( t_comin_var_descriptor var_descriptor)

◆ comin_metadata_get_iterator_end()

t_comin_metadata_iterator * comin_metadata_get_iterator_end ( t_comin_var_descriptor var_descriptor)

◆ comin_metadata_get_string()

const char * comin_metadata_get_string ( t_comin_var_descriptor var_descriptor,
const char * key )

◆ comin_metadata_get_typeid()

t_comin_metadata_typeid comin_metadata_get_typeid ( t_comin_var_descriptor var_descriptor,
const char * key )

◆ comin_metadata_iterator_compare()

bool comin_metadata_iterator_compare ( t_comin_metadata_iterator * it1,
t_comin_metadata_iterator * it2 )

◆ comin_metadata_iterator_delete()

void comin_metadata_iterator_delete ( t_comin_metadata_iterator * it)

◆ comin_metadata_iterator_get_key()

const char * comin_metadata_iterator_get_key ( t_comin_metadata_iterator * it)

◆ comin_metadata_iterator_next()

void comin_metadata_iterator_next ( t_comin_metadata_iterator * it)

◆ comin_metadata_set_character()

void comin_metadata_set_character ( t_comin_var_descriptor var_descriptor,
const char * key,
char const * val )

◆ comin_metadata_set_integer()

void comin_metadata_set_integer ( t_comin_var_descriptor var_descriptor,
const char * key,
int val )

◆ comin_metadata_set_logical()

void comin_metadata_set_logical ( t_comin_var_descriptor var_descriptor,
const char * key,
bool val )

◆ comin_metadata_set_real()

void comin_metadata_set_real ( t_comin_var_descriptor var_descriptor,
const char * key,
double val )

◆ comin_parallel_get_host_mpi_comm()

int comin_parallel_get_host_mpi_comm ( void )

◆ comin_parallel_get_host_mpi_rank()

int comin_parallel_get_host_mpi_rank ( void )

◆ comin_parallel_get_plugin_mpi_comm()

int comin_parallel_get_plugin_mpi_comm ( void )

◆ comin_plugin_finish()

void comin_plugin_finish ( const char * routine,
const char * text )

◆ comin_plugin_finish_f()

void comin_plugin_finish_f ( const char * routine,
const char * fmt,
... )

◆ comin_print_debug()

void comin_print_debug ( const char * msg)

◆ comin_print_debug_f()

void comin_print_debug_f ( const char * fmt,
... )

◆ comin_print_info()

void comin_print_info ( const char * msg)

◆ comin_print_info_f()

void comin_print_info_f ( const char * fmt,
... )

◆ comin_print_warning()

void comin_print_warning ( const char * msg)

◆ comin_print_warning_f()

void comin_print_warning_f ( const char * fmt,
... )

◆ comin_setup_get_version()

void comin_setup_get_version ( unsigned int * major,
unsigned int * minor,
unsigned int * patch )

returns version info.

◆ comin_var_descr_list_iterator_delete()

void comin_var_descr_list_iterator_delete ( t_comin_var_descr_list_iterator ** it)

◆ comin_var_get()

t_comin_var_handle * comin_var_get ( int context_len,
t_comin_entry_point * context,
t_comin_var_descriptor var_descriptor,
int flag )

◆ comin_var_get_descr_list_head()

t_comin_var_descr_list_iterator * comin_var_get_descr_list_head ( void )

◆ comin_var_get_descr_list_next()

t_comin_var_descr_list_iterator * comin_var_get_descr_list_next ( t_comin_var_descr_list_iterator * current)

◆ comin_var_get_descr_list_var_desc()

void comin_var_get_descr_list_var_desc ( t_comin_var_descr_list_iterator * current,
t_comin_var_descriptor * var_desc )

◆ comin_var_get_descriptor()

void comin_var_get_descriptor ( t_comin_var_handle * handle,
t_comin_var_descriptor * descr )

◆ comin_var_get_device_ptr()

void * comin_var_get_device_ptr ( t_comin_var_handle * handle)

◆ comin_var_get_device_ptr_double()

double * comin_var_get_device_ptr_double ( t_comin_var_handle * handle)

◆ comin_var_get_device_ptr_float()

float * comin_var_get_device_ptr_float ( t_comin_var_handle * handle)

◆ comin_var_get_device_ptr_int()

int * comin_var_get_device_ptr_int ( t_comin_var_handle * handle)

◆ comin_var_get_dim_semantics()

void comin_var_get_dim_semantics ( t_comin_var_handle * handle,
int dim_semantics[5] )

◆ comin_var_get_ncontained()

void comin_var_get_ncontained ( t_comin_var_handle * handle,
int * ncontained )

◆ comin_var_get_ptr()

void * comin_var_get_ptr ( t_comin_var_handle * handle)

◆ comin_var_get_ptr_double()

double * comin_var_get_ptr_double ( t_comin_var_handle * handle)

◆ comin_var_get_ptr_float()

float * comin_var_get_ptr_float ( t_comin_var_handle * handle)

◆ comin_var_get_ptr_int()

int * comin_var_get_ptr_int ( t_comin_var_handle * handle)

◆ comin_var_get_shape()

void comin_var_get_shape ( t_comin_var_handle * handle,
int shape[5] )

◆ comin_var_request_add()

void comin_var_request_add ( t_comin_var_descriptor var_descriptor,
bool lmodexclusive )

Variable Documentation

◆ COMIN_DOMAIN_OUTSIDE_LOOP

const int COMIN_DOMAIN_OUTSIDE_LOOP = -1
static

Definition at line 191 of file comin.h.