csdms

basic_modeling_interface.grid_unstructured module

Interface that describes unstructured grids.

class basic_modeling_interface.grid_unstructured.BmiGridUnstructured[source]

Bases: basic_modeling_interface.grid.BmiGrid

Methods that describe an unstructured grid.

An example of an unstructured grid.

Methods

get_grid_connectivity(grid_id) Get connectivity array of the grid.
get_grid_offset(grid_id) Get offsets for the grid nodes.
get_grid_rank(grid_id) Get number of dimensions of the computational grid.
get_grid_size(grid_id) Get the total number of elements in the computational grid.
get_grid_type(grid_id) Get the grid type as a string.
get_grid_x(grid_id) Get coordinates of grid nodes in the streamwise direction.
get_grid_y(grid_id) Get coordinates of grid nodes in the transverse direction.
get_grid_z(grid_id) Get coordinates of grid nodes in the normal direction.
get_grid_connectivity(grid_id)[source]

Get connectivity array of the grid.

Parameters:

grid_id : int

A grid identifier.

Returns:

array_like or int

The graph of connections between the grid nodes.

See also

bmi.vars.BmiVars.get_var_grid
Obtain a grid_id.

Notes

/* C */
int get_grid_connectivity(void * self, int grid_id,
                          int * connectivity);
get_grid_offset(grid_id)[source]

Get offsets for the grid nodes.

Parameters:

grid_id : int

A grid identifier.

Returns:

array_like of int

The offsets for the grid nodes.

See also

bmi.vars.BmiVars.get_var_grid
Obtain a grid_id.

Notes

/* C */
int get_grid_offset(void * self, int grid_id, int * offset);
get_grid_x(grid_id)[source]

Get coordinates of grid nodes in the streamwise direction.

Parameters:

grid_id : int

A grid identifier.

Returns:

array_like

The positions of the grid nodes.

See also

bmi.vars.BmiVars.get_var_grid
Obtain a grid_id.

Notes

/* C */
int get_grid_x(void * self, int grid_id, double * x);
get_grid_y(grid_id)[source]

Get coordinates of grid nodes in the transverse direction.

Parameters:

grid_id : int

A grid identifier.

Returns:

array_like

The positions of the grid nodes.

See also

bmi.vars.BmiVars.get_var_grid
Obtain a grid_id.

Notes

/* C */
int get_grid_y(void * self, int grid_id, double * y);
get_grid_z(grid_id)[source]

Get coordinates of grid nodes in the normal direction.

Parameters:

grid_id : int

A grid identifier.

Returns:

array_like

The positions of the grid nodes.

See also

bmi.vars.BmiVars.get_var_grid
Obtain a grid_id.

Notes

/* C */
int get_grid_z(void * self, int grid_id, double * z);