Grid

class rips.Grid(index: int, case: Case, channel: Channel)

Bases: object

Grid Information. Created by methods in Case rips.case.grid() rips.case.grids()

Methods Summary

cell_centers()

The cell center for all cells in given grid

cell_centers_async()

The cells center for all cells in given grid async.

cell_corners()

The cell corners for all cells in given grid

cell_corners_async()

The cell corners for all cells in given grid, async.

cell_count()

Cell count in grid

dimensions()

The dimensions in i, j, k direction

property_data_index_from_ijk(i, j, k)

Compute property index from 1-based IJK cell address.

Methods Documentation

cell_centers() List[Vec3d]

The cell center for all cells in given grid

Returns:

class with double attributes x, y, x giving cell centers

Return type:

List of Vec3d

cell_centers_async()

The cells center for all cells in given grid async.

Returns:

class with double attributes x, y, x giving cell centers

Return type:

Iterator to a list of Vec3d

cell_corners()

The cell corners for all cells in given grid

Returns:

a class with Vec3d for each corner (c0, c1.., c7)

Return type:

list of CellCorners

cell_corners_async()

The cell corners for all cells in given grid, async.

Returns:

a class with Vec3d for each corner (c0, c1.., c7)

Return type:

iterator to a list of CellCorners

cell_count() int

Cell count in grid

Returns:

Cell count in grid

Return type:

int

dimensions() Vec3i | None

The dimensions in i, j, k direction

Returns:

class with integer attributes i, j, k giving extent in all three dimensions.

Return type:

Vec3i

property_data_index_from_ijk(i: int, j: int, k: int) int

Compute property index from 1-based IJK cell address. Cell Property Result data is organized by I, J and K.

property_data_index = dims.i * dims.j * (k - 1) + dims.i * (j - 1) + (i - 1)

Returns:

Cell property result index from IJK

Return type:

int