comin Namespace Reference

Data Structures
class	_descrdata
class	_EntryPoint
class	_variable
class	metadata
class	plugin_info
class	simulation_interval

Functions
	register_callback (ep)
	var_get (context, var_descriptor, flag)
	get variable object, arguments: [entry point], (name string, domain id), access flag)
	current_get_plugin_info ()
	returns object describing the current plugin
	descrdata_get_domain (jg)
	returns descriptive data for a given domain, arguments: jg
	descrdata_get_global ()
	returns global descriptive data object
	var_descr_list ()
	List of exposed variables (descriptors)
	metadata_set (var_descriptor, **kwargs)
	sets metadata for a requested field, arguments: name string, domain id, metadata key, metadata value
	descrdata_get_simulation_interval ()
	returns simulation intervals: exp_start, exp_stop, run_start, run_stop
	_comin_dim_semantics_get_name (ds)

Variables
int	COMIN_ZAXIS_UNDEF = -1
int	COMIN_ZAXIS_NONE = 0
int	COMIN_ZAXIS_2D = 1
int	COMIN_ZAXIS_3D = 2
int	COMIN_ZAXIS_3D_HALF = 3
	name = _comin.callback_get_ep_name(ep)
int	COMIN_FLAG_NONE = 0
int	COMIN_FLAG_READ = 1 << 1
int	COMIN_FLAG_WRITE = 1 << 2
int	COMIN_FLAG_SYNC_HALO = 1 << 3
int	COMIN_FLAG_DEVICE = 1 << 4
int	COMIN_HGRID_UNSTRUCTURED_CELL = 1
int	COMIN_HGRID_UNSTRUCTURED_EDGE = 2
int	COMIN_HGRID_UNSTRUCTURED_VERTEX = 3
int	COMIN_VAR_DATATYPE_DOUBLE = 1
int	COMIN_VAR_DATATYPE_FLOAT = 2
int	COMIN_VAR_DATATYPE_INT = 3
int	COMIN_DIM_SEMANTICS_UNDEF = 1
int	COMIN_DIM_SEMANTICS_NPROMA = 2
int	COMIN_DIM_SEMANTICS_BLOCK = 3
int	COMIN_DIM_SEMANTICS_UNBLOCK = 4
int	COMIN_DIM_SEMANTICS_LEVEL = 5
int	COMIN_DIM_SEMANTICS_CONTAINER = 6
int	COMIN_DIM_SEMANTICS_OTHER = 7
int	COMIN_DIM_SEMANTICS_UNUSED = 8

Function Documentation

_comin_dim_semantics_get_name()

comin._comin_dim_semantics_get_name ( ds )

protected

Definition at line 253 of file comin.py.

current_get_plugin_info()

comin.current_get_plugin_info

(

)

returns object describing the current plugin

Definition at line 146 of file comin.py.

Here is the caller graph for this function:

descrdata_get_domain()

comin.descrdata_get_domain

(

jg

)

returns descriptive data for a given domain, arguments: jg

Definition at line 167 of file comin.py.

Here is the caller graph for this function:

descrdata_get_global()

comin.descrdata_get_global

(

)

returns global descriptive data object

Definition at line 172 of file comin.py.

descrdata_get_simulation_interval()

comin.descrdata_get_simulation_interval

(

)

returns simulation intervals: exp_start, exp_stop, run_start, run_stop

Definition at line 224 of file comin.py.

metadata_set()

comin.metadata_set	(		var_descriptor,
		**	kwargs )

sets metadata for a requested field, arguments: name string, domain id, metadata key, metadata value

Definition at line 189 of file comin.py.

register_callback()

comin.register_callback

(

ep

)

Definition at line 18 of file comin.py.

var_descr_list()

comin.var_descr_list

(

)

List of exposed variables (descriptors)

Definition at line 177 of file comin.py.

Here is the caller graph for this function:

var_get()

comin.var_get	(		context,
			var_descriptor,
			flag )

get variable object, arguments: [entry point], (name string, domain id), access flag)

Definition at line 107 of file comin.py.

Here is the caller graph for this function:

Variable Documentation

COMIN_DIM_SEMANTICS_BLOCK

int comin.COMIN_DIM_SEMANTICS_BLOCK = 3

Definition at line 245 of file comin.py.

COMIN_DIM_SEMANTICS_CONTAINER

int comin.COMIN_DIM_SEMANTICS_CONTAINER = 6

Definition at line 248 of file comin.py.

COMIN_DIM_SEMANTICS_LEVEL

int comin.COMIN_DIM_SEMANTICS_LEVEL = 5

Definition at line 247 of file comin.py.

COMIN_DIM_SEMANTICS_NPROMA

int comin.COMIN_DIM_SEMANTICS_NPROMA = 2

Definition at line 244 of file comin.py.

COMIN_DIM_SEMANTICS_OTHER

int comin.COMIN_DIM_SEMANTICS_OTHER = 7

Definition at line 249 of file comin.py.

COMIN_DIM_SEMANTICS_UNBLOCK

int comin.COMIN_DIM_SEMANTICS_UNBLOCK = 4

Definition at line 246 of file comin.py.

COMIN_DIM_SEMANTICS_UNDEF

int comin.COMIN_DIM_SEMANTICS_UNDEF = 1

Definition at line 243 of file comin.py.

COMIN_DIM_SEMANTICS_UNUSED

int comin.COMIN_DIM_SEMANTICS_UNUSED = 8

Definition at line 250 of file comin.py.

COMIN_FLAG_DEVICE

int comin.COMIN_FLAG_DEVICE = 1 << 4

Definition at line 233 of file comin.py.

COMIN_FLAG_NONE

int comin.COMIN_FLAG_NONE = 0

Definition at line 229 of file comin.py.

COMIN_FLAG_READ

int comin.COMIN_FLAG_READ = 1 << 1

Definition at line 230 of file comin.py.

COMIN_FLAG_SYNC_HALO

int comin.COMIN_FLAG_SYNC_HALO = 1 << 3

Definition at line 232 of file comin.py.

COMIN_FLAG_WRITE

int comin.COMIN_FLAG_WRITE = 1 << 2

Definition at line 231 of file comin.py.

COMIN_HGRID_UNSTRUCTURED_CELL

int comin.COMIN_HGRID_UNSTRUCTURED_CELL = 1

Definition at line 235 of file comin.py.

COMIN_HGRID_UNSTRUCTURED_EDGE

int comin.COMIN_HGRID_UNSTRUCTURED_EDGE = 2

Definition at line 236 of file comin.py.

COMIN_HGRID_UNSTRUCTURED_VERTEX

int comin.COMIN_HGRID_UNSTRUCTURED_VERTEX = 3

Definition at line 237 of file comin.py.

COMIN_VAR_DATATYPE_DOUBLE

int comin.COMIN_VAR_DATATYPE_DOUBLE = 1

Definition at line 239 of file comin.py.

COMIN_VAR_DATATYPE_FLOAT

int comin.COMIN_VAR_DATATYPE_FLOAT = 2

Definition at line 240 of file comin.py.

COMIN_VAR_DATATYPE_INT

int comin.COMIN_VAR_DATATYPE_INT = 3

Definition at line 241 of file comin.py.

COMIN_ZAXIS_2D

int comin.COMIN_ZAXIS_2D = 1

Definition at line 28 of file comin.py.

COMIN_ZAXIS_3D

int comin.COMIN_ZAXIS_3D = 2

Definition at line 29 of file comin.py.

COMIN_ZAXIS_3D_HALF

int comin.COMIN_ZAXIS_3D_HALF = 3

Definition at line 30 of file comin.py.

COMIN_ZAXIS_NONE

int comin.COMIN_ZAXIS_NONE = 0

Definition at line 27 of file comin.py.

COMIN_ZAXIS_UNDEF

int comin.COMIN_ZAXIS_UNDEF = -1

Definition at line 26 of file comin.py.

name

comin.name = _comin.callback_get_ep_name(ep)

Definition at line 125 of file comin.py.