csdms

basic_modeling_interface.grid_structured_quad module

Interface that describes structured quadrilateral grids.

class basic_modeling_interface.grid_structured_quad.BmiGridStructuredQuad[source]

Bases: basic_modeling_interface.grid.BmiGrid

Methods that describe a structured grid of quadrilaterals.

An example of a structured quad grid.

Methods

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_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_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_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);