Grid

class reservoirflow.grids.Grid(unit, dtype, unify, verbose)

Bases: ABC, Base

Abstract grid class.

Grid class represents both the rock geometry and the rock properties using numpy arrays including pyvista object for visualization.

Attention

This is an abstract class and can’t be instantiated. This class is only used as a parent for other classes of grids module.

Returns:

Grid object.

Return type:

Grid

Construct grid object.

Parameters:

• unit (str ('field', 'metric', 'lab'), optional) – unit used in input and output. Both units and factors attributes will be updated based on the selected unit and can be accessed directly from this class.

• dtype (str or np.dtype, optional) – data type used in all arrays. Numpy dtype such as np.single or np.double can be used.

• unify (bool, optional) – unify shape to be always tuple of 3 when set to True. When set to False, shape includes only the number of girds in flow direction as tuple. This option is only relevant in case of 1D or 2D flow. This option may be required to make 1D and 2D shapes shapes of this class more consistent with each other or with 3D shape.

• verbose (bool, optional) – print information for debugging.

Attributes

factors	Returns class factors.
name	Returns class name.
unit	Returns class unit.
units	Returns class units.

Methods

allow_synonyms()	Allow full descriptions.
report([prop, showindex, ifmt])	Print class report.
set_comp(comp)	Set grid compressibility.
set_units([unit])	Set object units.

Comments 💬

Feel free to make a comment, ask a question, or share your opinion about this specific content. Please keep in mind the Commenting Guidelines ⚖.