csdms

basic_modeling_interface.grid_uniform_rectilinear module

Interface that describes uniform rectilinear grids.

class basic_modeling_interface.grid_uniform_rectilinear.BmiGridUniformRectilinear[source]

Bases: basic_modeling_interface.grid.BmiGrid

Methods that describe a uniform rectilinear grid.

In a 2D uniform grid, every grid cell (or element) is a rectangle and all cells have the same dimensions. If the dimensions are equal, then the grid is a tiling of squares.

Each of these functions returns information about each dimension of a grid. The dimensions are ordered with “ij” indexing (as opposed to “xy”). For example, the get_grid_shape() function for the example grid would return the array [4, 5]. If there were a third dimension, the length of the z dimension would be listed first. This same convention is used in NumPy. Note that the grid shape is the number of nodes in the coordinate directions and not the number of cells or elements. It is possible for grid values to be associated with the nodes or with the cells.

An example of a uniform rectilinear grid

Methods

get_grid_origin(grid_id) Get coordinates for the origin of the computational grid.
get_grid_rank(grid_id) Get number of dimensions of the computational grid.
get_grid_shape(grid_id) Get dimensions of the computational grid.
get_grid_size(grid_id) Get the total number of elements in the computational grid.
get_grid_spacing(grid_id) Get distance between nodes of the computational grid.
get_grid_type(grid_id) Get the grid type as a string.
get_grid_origin(grid_id)[source]

Get coordinates for the origin of the computational grid.

Parameters:

grid_id : int

A grid identifier.

Returns:

array_like

The coordinates of the lower left corner of the grid.

See also

bmi.vars.BmiVars.get_var_grid
Obtain a grid_id.

Notes

/* C */
int get_grid_origin(void * self, int grid_id, double * origin);
get_grid_shape(grid_id)[source]

Get dimensions of the computational grid.

Parameters:

grid_id : int

A grid identifier.

Returns:

array_like

The dimensions of the grid.

See also

bmi.vars.BmiVars.get_var_grid
Obtain a grid_id.

Notes

/* C */
int get_grid_shape(void * self, int grid_id, int * shape);
get_grid_spacing(grid_id)[source]

Get distance between nodes of the computational grid.

Parameters:

grid_id : int

A grid identifier.

Returns:

array_like

The grid spacing.

See also

bmi.vars.BmiVars.get_var_grid
Obtain a grid_id.

Notes

/* C */
int get_grid_spacing(void * self, int grid_id, double * spacing);