reservoirflow.grids.RegularCartesian.get_cell_A#

RegularCartesian.get_cell_A(dir, id=None, coords=None)#

Returns cell cross-sectional area A.

Parameters:

dir (str) – direction str in [‘x’, ‘y’, ‘z’].
id (int, iterable of int) – cell id based on natural order as int. For multiple cells, list of int [id,id,..] or tuple of int (id,id,…). NotFullyImplemented.
coords (iterable of int, iterable of tuples of int, by default) – None cell coordinates (i,j,k) as a tuple of int. For multiple cells, tuple of tuples of int as ((i,j,k),(i,j,k),..). NotFullyImplemented.

Returns:

scaler of A based on dir argument.

Return type:

int, float

Raises:

ValueError – id or coords argument must be defined.