C Interface

Data Structures
struct	comin_h::t_comin_var_descriptor
struct	comin_h::comin_descrdata_property_t

Typedefs
typedef struct comin_h::t_comin_var_descriptor	comin_h::t_comin_var_descriptor
typedef struct t_comin_var_handle	comin_h::t_comin_var_handle
typedef struct t_comin_var_descr_list_iterator	comin_h::t_comin_var_descr_list_iterator
typedef struct t_comin_metadata_iterator	comin_h::t_comin_metadata_iterator
typedef enum comin_h::t_comin_entry_point	comin_h::t_comin_entry_point
typedef enum comin_h::t_comin_zaxis	comin_h::t_comin_zaxis
typedef enum comin_h::t_comin_var_access_flag	comin_h::t_comin_var_access_flag
typedef enum comin_h::t_comin_error_code	comin_h::t_comin_error_code
typedef enum comin_h::t_comin_hgrid_id	comin_h::t_comin_hgrid_id
typedef enum comin_h::t_comin_metadata_typeid	comin_h::t_comin_metadata_typeid
typedef enum comin_h::t_comin_var_datatype	comin_h::t_comin_var_datatype
typedef enum comin_h::t_comin_dim_semantics	comin_h::t_comin_dim_semantics
typedef void(*	comin_h::t_comin_callback_function) ()

Enumerations
enum	comin_h::t_comin_entry_point {   comin_h::EP_SECONDARY_CONSTRUCTOR = 1 , comin_h::EP_ATM_YAC_DEFCOMP_BEFORE , comin_h::EP_ATM_YAC_DEFCOMP_AFTER , comin_h::EP_ATM_YAC_SYNCDEF_BEFORE ,   comin_h::EP_ATM_YAC_SYNCDEF_AFTER , comin_h::EP_ATM_YAC_ENDDEF_BEFORE , comin_h::EP_ATM_YAC_ENDDEF_AFTER , comin_h::EP_ATM_INIT_FINALIZE ,   comin_h::EP_ATM_TIMELOOP_BEFORE , comin_h::EP_ATM_TIMELOOP_START , comin_h::EP_ATM_TIMELOOP_END , comin_h::EP_ATM_TIMELOOP_AFTER ,   comin_h::EP_ATM_INTEGRATE_BEFORE , comin_h::EP_ATM_INTEGRATE_START , comin_h::EP_ATM_INTEGRATE_END , comin_h::EP_ATM_INTEGRATE_AFTER ,   comin_h::EP_ATM_WRITE_OUTPUT_BEFORE , comin_h::EP_ATM_WRITE_OUTPUT_AFTER , comin_h::EP_ATM_CHECKPOINT_BEFORE , comin_h::EP_ATM_CHECKPOINT_AFTER ,   comin_h::EP_ATM_ADVECTION_BEFORE , comin_h::EP_ATM_ADVECTION_AFTER , comin_h::EP_ATM_PHYSICS_BEFORE , comin_h::EP_ATM_PHYSICS_AFTER ,   comin_h::EP_ATM_NUDGING_BEFORE , comin_h::EP_ATM_NUDGING_AFTER , comin_h::EP_ATM_SURFACE_BEFORE , comin_h::EP_ATM_SURFACE_AFTER ,   comin_h::EP_ATM_TURBULENCE_BEFORE , comin_h::EP_ATM_TURBULENCE_AFTER , comin_h::EP_ATM_MICROPHYSICS_BEFORE , comin_h::EP_ATM_MICROPHYSICS_AFTER ,   comin_h::EP_ATM_CONVECTION_BEFORE , comin_h::EP_ATM_CONVECTION_AFTER , comin_h::EP_ATM_RADIATION_BEFORE , comin_h::EP_ATM_RADIATION_AFTER ,   comin_h::EP_ATM_RADHEAT_BEFORE , comin_h::EP_ATM_RADHEAT_AFTER , comin_h::EP_ATM_GWDRAG_BEFORE , comin_h::EP_ATM_GWDRAG_AFTER ,   comin_h::EP_FINISH , comin_h::EP_DESTRUCTOR }
enum	comin_h::t_comin_zaxis {   comin_h::COMIN_ZAXIS_UNDEF = -1 , comin_h::COMIN_ZAXIS_NONE = 0 , comin_h::COMIN_ZAXIS_2D = 1 , comin_h::COMIN_ZAXIS_3D = 2 ,   comin_h::COMIN_ZAXIS_3D_HALF = 3 }
enum	comin_h::t_comin_var_access_flag {   comin_h::COMIN_FLAG_NONE = 0 , comin_h::COMIN_FLAG_READ = 1 << 1 , comin_h::COMIN_FLAG_WRITE = 1 << 2 , comin_h::COMIN_FLAG_SYNC_HALO = 1 << 3 ,   comin_h::COMIN_FLAG_DEVICE = 1 << 4 }
enum	comin_h::t_comin_error_code {   comin_h::COMIN_SUCCESS = 0 , comin_h::COMIN_INFO , comin_h::COMIN_WARNING , comin_h::COMIN_ERROR_STATUS ,   comin_h::COMIN_ERROR_CALLBACK_REGISTER_OUTSIDE_PRIMARYCONSTRUCTOR , comin_h::COMIN_ERROR_CALLBACK_COMPLETE , comin_h::COMIN_ERROR_CALLBACK_EP_ID_UNKNOWN , comin_h::COMIN_ERROR_DESCRDATA_SET_FCT_GLB2LOC ,   comin_h::COMIN_ERROR_DESCRDATA_FINALIZE , comin_h::COMIN_ERROR_METADATA_SET_OUTSIDE_PRIMARYCONSTRUCTOR , comin_h::COMIN_ERROR_METADATA_KEY_NOT_FOUND , comin_h::COMIN_ERROR_METADATA_GET_INSIDE_PRIMARYCONSTRUCTOR ,   comin_h::COMIN_ERROR_SETUP_FINALIZE , comin_h::COMIN_ERROR_SETUP_COMIN_ALREADY_INITIALIZED , comin_h::COMIN_ERROR_PLUGIN_INIT_COMIN_VERSION , comin_h::COMIN_ERROR_PLUGIN_INIT_PRECISION ,   comin_h::COMIN_ERROR_PLUGIN_INIT_STATE_INITIALIZED , comin_h::COMIN_ERROR_SETUP_ERRHANDLER_NOT_ASSOCIATED , comin_h::COMIN_ERROR_SETUP_ERRHANDLER_NOT_SET , comin_h::COMIN_ERROR_SETUP_PRECISION_TEST_FAILED ,   comin_h::COMIN_ERROR_VAR_REQUEST_AFTER_PRIMARYCONSTRUCTOR , comin_h::COMIN_ERROR_VAR_REQUEST_EXISTS_IS_LMODEXCLUSIVE , comin_h::COMIN_ERROR_VAR_REQUEST_EXISTS_REQUEST_LMODEXCLUSIVE , comin_h::COMIN_ERROR_VAR_DESCRIPTOR_NOT_FOUND ,   comin_h::COMIN_ERROR_VAR_ITEM_NOT_ASSOCIATED , comin_h::COMIN_ERROR_FIELD_NOT_ALLOCATED , comin_h::COMIN_ERROR_POINTER_NOT_ASSOCIATED , comin_h::COMIN_ERROR_TRACER_REQUEST_NOT_FOR_ALL_DOMAINS ,   comin_h::COMIN_ERROR_VAR_SYNC_DEVICE_MEM_NOT_ASSOCIATED , comin_h::COMIN_ERROR_VAR_SYNC_HALO_NOT_ASSOCIATED , comin_h::COMIN_ERROR_VAR_GET_OUTSIDE_SECONDARY_CONSTRUCTOR , comin_h::COMIN_ERROR_VAR_GET_NO_DEVICE ,   comin_h::COMIN_ERROR_VAR_GET_VARIABLE_NOT_FOUND , comin_h::COMIN_ERROR_VAR_GET_CONTAINER_CAN_NOT_HALO_SYNCHRONIZED , comin_h::COMIN_ERROR_VAR_GET_IRREGULAR_VAR_CAN_NOT_HALO_SYNCHRONIZED , comin_h::COMIN_ERROR_VAR_SYNC_HALO_NOT_SUPPORTED_ZAXIS ,   comin_h::COMIN_ERROR_VAR_METADATA_INCONSISTENT_TYPE , comin_h::COMIN_ERROR_FATAL }
enum	comin_h::t_comin_hgrid_id { comin_h::COMIN_HGRID_UNSTRUCTURED_CELL = 1 , comin_h::COMIN_HGRID_UNSTRUCTURED_EDGE = 2 , comin_h::COMIN_HGRID_UNSTRUCTURED_VERTEX = 3 }
enum	comin_h::t_comin_metadata_typeid {   comin_h::COMIN_METADATA_TYPEID_UNDEFINED = -1 , comin_h::COMIN_METADATA_TYPEID_INTEGER , comin_h::COMIN_METADATA_TYPEID_REAL , comin_h::COMIN_METADATA_TYPEID_CHARACTER ,   comin_h::COMIN_METADATA_TYPEID_LOGICAL }
enum	comin_h::t_comin_var_datatype { comin_h::COMIN_VAR_DATATYPE_DOUBLE = 1 , comin_h::COMIN_VAR_DATATYPE_FLOAT , comin_h::COMIN_VAR_DATATYPE_INT }
enum	comin_h::t_comin_dim_semantics {   comin_h::COMIN_DIM_SEMANTICS_UNDEF = 1 , comin_h::COMIN_DIM_SEMANTICS_NPROMA = 2 , comin_h::COMIN_DIM_SEMANTICS_BLOCK = 3 , comin_h::COMIN_DIM_SEMANTICS_UNBLOCK = 4 ,   comin_h::COMIN_DIM_SEMANTICS_LEVEL = 5 , comin_h::COMIN_DIM_SEMANTICS_CONTAINER = 6 , comin_h::COMIN_DIM_SEMANTICS_OTHER = 7 , comin_h::COMIN_DIM_SEMANTICS_UNUSED = 8 }

Functions
t_comin_entry_point	comin_h::comin_current_get_ep ()
int	comin_h::comin_current_get_domain_id ()
int	comin_h::comin_current_get_plugin_id ()
void	comin_h::comin_current_get_plugin_name (char const **val, int *len)
void	comin_h::comin_current_get_plugin_options (char const **val, int *len)
void	comin_h::comin_current_get_plugin_comm (char const **val, int *len)
void	comin_h::comin_current_get_datetime (char const **val, int *len)
int	comin_h::comin_parallel_get_plugin_mpi_comm ()
int	comin_h::comin_parallel_get_host_mpi_comm ()
int	comin_h::comin_parallel_get_host_mpi_rank ()
void	comin_h::comin_plugin_finish (const char *routine, const char *text)
void	comin_h::comin_print_debug (const char *msg)
void	comin_h::comin_print_info (const char *msg)
void	comin_h::comin_print_warning (const char *msg)
void	comin_h::comin_print_debug_f (const char *fmt,...)
void	comin_h::comin_print_info_f (const char *fmt,...)
void	comin_h::comin_print_warning_f (const char *fmt,...)
void	comin_h::comin_error_get_message (t_comin_error_code error_code, char category[11], char message[COMIN_MAX_LEN_ERR_MESSAGE])
void	comin_h::comin_error_check (t_comin_error_code error_code, const char *scope)
void	comin_h::comin_error_set_errors_return (bool errors_return)
t_comin_error_code	comin_h::comin_error_get ()
void	comin_h::comin_error_reset ()
void	comin_h::comin_var_request_add (t_comin_var_descriptor var_descriptor, bool lmodexclusive)
t_comin_var_handle *	comin_h::comin_var_get (int context_len, t_comin_entry_point *context, t_comin_var_descriptor var_descriptor, int flag)
void *	comin_h::comin_var_get_ptr (t_comin_var_handle *handle)
double *	comin_h::comin_var_get_ptr_double (t_comin_var_handle *handle)
float *	comin_h::comin_var_get_ptr_float (t_comin_var_handle *handle)
int *	comin_h::comin_var_get_ptr_int (t_comin_var_handle *handle)
void *	comin_h::comin_var_get_device_ptr (t_comin_var_handle *handle)
double *	comin_h::comin_var_get_device_ptr_double (t_comin_var_handle *handle)
float *	comin_h::comin_var_get_device_ptr_float (t_comin_var_handle *handle)
int *	comin_h::comin_var_get_device_ptr_int (t_comin_var_handle *handle)
void	comin_h::comin_var_get_shape (t_comin_var_handle *handle, int shape[5])
void	comin_h::comin_var_get_dim_semantics (t_comin_var_handle *handle, int dim_semantics[5])
void	comin_h::comin_var_get_ncontained (t_comin_var_handle *handle, int *ncontained)
void	comin_h::comin_var_get_descriptor (t_comin_var_handle *handle, t_comin_var_descriptor *descr)
t_comin_var_descr_list_iterator *	comin_h::comin_var_get_descr_list_head ()
t_comin_var_descr_list_iterator *	comin_h::comin_var_get_descr_list_next (t_comin_var_descr_list_iterator *current)
void	comin_h::comin_var_get_descr_list_var_desc (t_comin_var_descr_list_iterator *current, t_comin_var_descriptor *var_desc)
void	comin_h::comin_var_descr_list_iterator_delete (t_comin_var_descr_list_iterator **it)
void	comin_h::comin_callback_register (t_comin_entry_point entry_point_id, t_comin_callback_function fct_ptr)
void	comin_h::comin_callback_get_ep_name (t_comin_entry_point iep, char out_ep_name[COMIN_MAX_LEN_EP_NAME+1])
t_comin_metadata_typeid	comin_h::comin_metadata_get_typeid (t_comin_var_descriptor var_descriptor, const char *key)
void	comin_h::comin_metadata_set_integer (t_comin_var_descriptor var_descriptor, const char *key, int val)
void	comin_h::comin_metadata_set_logical (t_comin_var_descriptor var_descriptor, const char *key, bool val)
void	comin_h::comin_metadata_set_real (t_comin_var_descriptor var_descriptor, const char *key, double val)
void	comin_h::comin_metadata_set_character (t_comin_var_descriptor var_descriptor, const char *key, char const *val)
void	comin_h::comin_metadata_get_integer (t_comin_var_descriptor var_descriptor, const char *key, int *val)
void	comin_h::comin_metadata_get_logical (t_comin_var_descriptor var_descriptor, const char *key, bool *val)
void	comin_h::comin_metadata_get_real (t_comin_var_descriptor var_descriptor, const char *key, double *val)
void	comin_h::comin_metadata_get_character (t_comin_var_descriptor var_descriptor, const char *key, char const **val, int *len)
t_comin_metadata_iterator *	comin_h::comin_metadata_get_iterator_begin (t_comin_var_descriptor var_descriptor)
t_comin_metadata_iterator *	comin_h::comin_metadata_get_iterator_end (t_comin_var_descriptor var_descriptor)
const char *	comin_h::comin_metadata_iterator_get_key (t_comin_metadata_iterator *it)
bool	comin_h::comin_metadata_iterator_compare (t_comin_metadata_iterator *it1, t_comin_metadata_iterator *it2)
void	comin_h::comin_metadata_iterator_next (t_comin_metadata_iterator *it)
void	comin_h::comin_metadata_iterator_delete (t_comin_metadata_iterator *it)
double	comin_h::comin_descrdata_get_timesteplength (int jg)
int	comin_h::comin_descrdata_get_index (int j)
int	comin_h::comin_descrdata_get_block (int j)
void	comin_h::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)
void	comin_h::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)
void	comin_h::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)
int	comin_h::comin_descrdata_get_cell_npromz (int jg)
int	comin_h::comin_descrdata_get_edge_npromz (int jg)
int	comin_h::comin_descrdata_get_vert_npromz (int jg)
int	comin_h::comin_descrdata_index_lookup_glb2loc_cell (int jg, int global_idx)
void	comin_h::comin_descrdata_get_simulation_interval_exp_start (char const **val, int *len)
void	comin_h::comin_descrdata_get_simulation_interval_exp_stop (char const **val, int *len)
void	comin_h::comin_descrdata_get_simulation_interval_run_start (char const **val, int *len)
void	comin_h::comin_descrdata_get_simulation_interval_run_stop (char const **val, int *len)
static void	comin_h::comin_setup_get_version (unsigned int *major, unsigned int *minor, unsigned int *patch)
	returns version info.

Variables
static const int	comin_h::COMIN_DOMAIN_OUTSIDE_LOOP = -1

Detailed Description

Typedef Documentation

t_comin_callback_function

typedef void(* comin_h::t_comin_callback_function) ()

Definition at line 244 of file comin.h.

t_comin_dim_semantics

typedef enum comin_h::t_comin_dim_semantics comin_h::t_comin_dim_semantics

t_comin_entry_point

typedef enum comin_h::t_comin_entry_point comin_h::t_comin_entry_point

t_comin_error_code

typedef enum comin_h::t_comin_error_code comin_h::t_comin_error_code

t_comin_hgrid_id

typedef enum comin_h::t_comin_hgrid_id comin_h::t_comin_hgrid_id

t_comin_metadata_iterator

typedef struct t_comin_metadata_iterator comin_h::t_comin_metadata_iterator

Definition at line 49 of file comin.h.

t_comin_metadata_typeid

typedef enum comin_h::t_comin_metadata_typeid comin_h::t_comin_metadata_typeid

t_comin_var_access_flag

typedef enum comin_h::t_comin_var_access_flag comin_h::t_comin_var_access_flag

t_comin_var_datatype

typedef enum comin_h::t_comin_var_datatype comin_h::t_comin_var_datatype

t_comin_var_descr_list_iterator

typedef struct t_comin_var_descr_list_iterator comin_h::t_comin_var_descr_list_iterator

Definition at line 46 of file comin.h.

t_comin_var_descriptor

typedef struct comin_h::t_comin_var_descriptor comin_h::t_comin_var_descriptor

t_comin_var_handle

typedef struct t_comin_var_handle comin_h::t_comin_var_handle

Definition at line 42 of file comin.h.

t_comin_zaxis

typedef enum comin_h::t_comin_zaxis comin_h::t_comin_zaxis

Enumeration Type Documentation

t_comin_dim_semantics

enum comin_h::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 comin_h::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 comin_h::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_PLUGIN_INIT_COMIN_VERSION
COMIN_ERROR_PLUGIN_INIT_PRECISION
COMIN_ERROR_PLUGIN_INIT_STATE_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_FATAL

Definition at line 112 of file comin.h.

t_comin_hgrid_id

enum comin_h::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_metadata_typeid

enum comin_h::t_comin_metadata_typeid

Enumerator
COMIN_METADATA_TYPEID_UNDEFINED
COMIN_METADATA_TYPEID_INTEGER
COMIN_METADATA_TYPEID_REAL
COMIN_METADATA_TYPEID_CHARACTER
COMIN_METADATA_TYPEID_LOGICAL

Definition at line 159 of file comin.h.

t_comin_var_access_flag

enum comin_h::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 comin_h::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 comin_h::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()

void comin_h::comin_callback_get_ep_name	(	t_comin_entry_point	iep,
		char	out_ep_name[COMIN_MAX_LEN_EP_NAME+1] )

comin_callback_register()

void comin_h::comin_callback_register	(	t_comin_entry_point	entry_point_id,
		t_comin_callback_function	fct_ptr )

comin_current_get_datetime()

void comin_h::comin_current_get_datetime	(	char const **	val,
		int *	len )

comin_current_get_domain_id()

int comin_h::comin_current_get_domain_id

(

)

comin_current_get_ep()

t_comin_entry_point comin_h::comin_current_get_ep

(

)

comin_current_get_plugin_comm()

void comin_h::comin_current_get_plugin_comm	(	char const **	val,
		int *	len )

comin_current_get_plugin_id()

int comin_h::comin_current_get_plugin_id

(

)

comin_current_get_plugin_name()

void comin_h::comin_current_get_plugin_name	(	char const **	val,
		int *	len )

comin_current_get_plugin_options()

void comin_h::comin_current_get_plugin_options	(	char const **	val,
		int *	len )

comin_descrdata_get_block()

int comin_h::comin_descrdata_get_block

(

int

j

)

comin_descrdata_get_cell_indices()

void comin_h::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_h::comin_descrdata_get_cell_npromz

(

int

jg

)

comin_descrdata_get_edge_indices()

void comin_h::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_h::comin_descrdata_get_edge_npromz

(

int

jg

)

comin_descrdata_get_index()

int comin_h::comin_descrdata_get_index

(

int

j

)

comin_descrdata_get_simulation_interval_exp_start()

void comin_h::comin_descrdata_get_simulation_interval_exp_start	(	char const **	val,
		int *	len )

comin_descrdata_get_simulation_interval_exp_stop()

void comin_h::comin_descrdata_get_simulation_interval_exp_stop	(	char const **	val,
		int *	len )

comin_descrdata_get_simulation_interval_run_start()

void comin_h::comin_descrdata_get_simulation_interval_run_start	(	char const **	val,
		int *	len )

comin_descrdata_get_simulation_interval_run_stop()

void comin_h::comin_descrdata_get_simulation_interval_run_stop	(	char const **	val,
		int *	len )

comin_descrdata_get_timesteplength()

double comin_h::comin_descrdata_get_timesteplength

(

int

jg

)

comin_descrdata_get_vert_indices()

void comin_h::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_h::comin_descrdata_get_vert_npromz

(

int

jg

)

comin_descrdata_index_lookup_glb2loc_cell()

int comin_h::comin_descrdata_index_lookup_glb2loc_cell	(	int	jg,
		int	global_idx )

comin_error_check()

void comin_h::comin_error_check	(	t_comin_error_code	error_code,
		const char *	scope )

comin_error_get()

t_comin_error_code comin_h::comin_error_get

(

)

comin_error_get_message()

void comin_h::comin_error_get_message	(	t_comin_error_code	error_code,
		char	category[11],
		char	message[COMIN_MAX_LEN_ERR_MESSAGE] )

comin_error_reset()

void comin_h::comin_error_reset

(

)

comin_error_set_errors_return()

void comin_h::comin_error_set_errors_return

(

bool

errors_return

)

comin_metadata_get_character()

void comin_h::comin_metadata_get_character	(	t_comin_var_descriptor	var_descriptor,
		const char *	key,
		char const **	val,
		int *	len )

comin_metadata_get_integer()

void comin_h::comin_metadata_get_integer	(	t_comin_var_descriptor	var_descriptor,
		const char *	key,
		int *	val )

comin_metadata_get_iterator_begin()

t_comin_metadata_iterator * comin_h::comin_metadata_get_iterator_begin

(

t_comin_var_descriptor

var_descriptor

)

comin_metadata_get_iterator_end()

t_comin_metadata_iterator * comin_h::comin_metadata_get_iterator_end

(

t_comin_var_descriptor

var_descriptor

)

comin_metadata_get_logical()

void comin_h::comin_metadata_get_logical	(	t_comin_var_descriptor	var_descriptor,
		const char *	key,
		bool *	val )

comin_metadata_get_real()

void comin_h::comin_metadata_get_real	(	t_comin_var_descriptor	var_descriptor,
		const char *	key,
		double *	val )

comin_metadata_get_typeid()

t_comin_metadata_typeid comin_h::comin_metadata_get_typeid	(	t_comin_var_descriptor	var_descriptor,
		const char *	key )

comin_metadata_iterator_compare()

bool comin_h::comin_metadata_iterator_compare	(	t_comin_metadata_iterator *	it1,
		t_comin_metadata_iterator *	it2 )

comin_metadata_iterator_delete()

void comin_h::comin_metadata_iterator_delete

(

t_comin_metadata_iterator *

it

)

comin_metadata_iterator_get_key()

const char * comin_h::comin_metadata_iterator_get_key

(

t_comin_metadata_iterator *

it

)

comin_metadata_iterator_next()

void comin_h::comin_metadata_iterator_next

(

t_comin_metadata_iterator *

it

)

comin_metadata_set_character()

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

comin_metadata_set_integer()

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

comin_metadata_set_logical()

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

comin_metadata_set_real()

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

comin_parallel_get_host_mpi_comm()

int comin_h::comin_parallel_get_host_mpi_comm

(

)

comin_parallel_get_host_mpi_rank()

int comin_h::comin_parallel_get_host_mpi_rank

(

)

comin_parallel_get_plugin_mpi_comm()

int comin_h::comin_parallel_get_plugin_mpi_comm

(

)

comin_plugin_finish()

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

comin_print_debug()

void comin_h::comin_print_debug

(

const char *

msg

)

comin_print_debug_f()

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

comin_print_info()

void comin_h::comin_print_info

(

const char *

msg

)

comin_print_info_f()

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

comin_print_warning()

void comin_h::comin_print_warning

(

const char *

msg

)

comin_print_warning_f()

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

comin_setup_get_version()

static void comin_h::comin_setup_get_version ( unsigned int * major, unsigned int * minor, unsigned int * patch )

inlinestatic

returns version info.

Definition at line 310 of file comin.h.

comin_var_descr_list_iterator_delete()

void comin_h::comin_var_descr_list_iterator_delete

(

t_comin_var_descr_list_iterator **

it

)

comin_var_get()

t_comin_var_handle * comin_h::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_h::comin_var_get_descr_list_head

(

)

comin_var_get_descr_list_next()

t_comin_var_descr_list_iterator * comin_h::comin_var_get_descr_list_next

(

t_comin_var_descr_list_iterator *

current

)

comin_var_get_descr_list_var_desc()

void comin_h::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_h::comin_var_get_descriptor	(	t_comin_var_handle *	handle,
		t_comin_var_descriptor *	descr )

comin_var_get_device_ptr()

void * comin_h::comin_var_get_device_ptr

(

t_comin_var_handle *

handle

)

comin_var_get_device_ptr_double()

double * comin_h::comin_var_get_device_ptr_double

(

t_comin_var_handle *

handle

)

comin_var_get_device_ptr_float()

float * comin_h::comin_var_get_device_ptr_float

(

t_comin_var_handle *

handle

)

comin_var_get_device_ptr_int()

int * comin_h::comin_var_get_device_ptr_int

(

t_comin_var_handle *

handle

)

comin_var_get_dim_semantics()

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

comin_var_get_ncontained()

void comin_h::comin_var_get_ncontained	(	t_comin_var_handle *	handle,
		int *	ncontained )

comin_var_get_ptr()

void * comin_h::comin_var_get_ptr

(

t_comin_var_handle *

handle

)

comin_var_get_ptr_double()

double * comin_h::comin_var_get_ptr_double

(

t_comin_var_handle *

handle

)

comin_var_get_ptr_float()

float * comin_h::comin_var_get_ptr_float

(

t_comin_var_handle *

handle

)

comin_var_get_ptr_int()

int * comin_h::comin_var_get_ptr_int

(

t_comin_var_handle *

handle

)

comin_var_get_shape()

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

comin_var_request_add()

void comin_h::comin_var_request_add	(	t_comin_var_descriptor	var_descriptor,
		bool	lmodexclusive )

Variable Documentation

COMIN_DOMAIN_OUTSIDE_LOOP

const int comin_h::COMIN_DOMAIN_OUTSIDE_LOOP = -1

static

Definition at line 184 of file comin.h.