reservoirflow.grids.RegularCartesian.set_props#
- RegularCartesian.set_props(kx=None, ky=None, kz=None, phi=None, z=None, comp=None, id=None, coords=None)#
Set properties for all cells or a selected cell.
This method is used to set or change properties. If neither id nor coords are defined, the same value will be assigned to all cells including boundary cells.
- Parameters:
kx (int, float, array-like, optional) – permeability in x-direction (relevant only if ‘x’ was in fluid flow direction). In case of a list or array, the length should be equal to nx+2 for all cells including boundary cells. Vales should be in natural order (i.g. from left to right).
ky (int, float, array-like, optional) – permeability in y-direction (relevant only if ‘y’ was in fluid flow direction). In case of a list or array, the length should be equal to ny+2 for all cells including boundary cells. Vales should be in natural order (i.g.from front to back).
kz (int, float, array-like, optional) – permeability in z-direction (relevant only if ‘z’ was in fluid flow direction). In case of a list or array, the length should be equal to nz+2 for all cells including boundary cells. Vales should be in natural order (i.g. from down to up).
phi (float, array-like, optional) – porosity. In case of an array, the shape should be equal to grid.shape with boundaries. Vales should be in natural order.
z (int, float, array-like, optional) – depth of grid tops (NOT FULLY IMPLEMENTED).
comp (float, optional) – compressibility.
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.