Field

class Field(path: Path | None = None, logfile=None, loglevel='INFO')[source]

Reservoir model.

Contains reservoir model data and data processing tools.

Parameters:

  • path (str, optional) – Path to source model files.

  • logfile (str, optional) – Path to log file.

  • loglevel (str, optional) – Log level to be printed while loading. Default to ‘INFO’.

property components

Model components.

get_vtk_dataset()[source]

Create vtk dataset with data from rock and states components. Grid is represented in unstructured form.

Returns:

vtk dataset with states and rock data.

Return type:

vtk.vtkUnstructuredGrid

items()[source]

Returns pairs of components’s names and instance.

load(include_binary=True, verbose=1)[source]

Load reservoir model data.

Parameters:

  • include_binary (bool) – Read data from binary files in RESULTS folder. Default to True.

  • verbose (int) – Amount of information about the loading process. If 0, then silent mode; if positive, then standard output. Default is 1.

Returns:

out – Field with loaded components.

Return type:

Field

property logger

Logger.

property name

Model filename without extention.

show(attr, timestep=0, thresholding=False, slicing=False, opacity=0.8, scaling=True, clip_wells=0.05, cmap=None, notebook=False, backend=None, theme='default', show_edges=True, faults_color='red')[source]

Field visualization.

Parameters:

  • attr (str or None) – Attribute of the grid to show. If None, ACTNUM will be shown.

  • timestep (int) – The timestep to show first. Meaningful only for sequential attributes (States). Has no effect for non-sequential attributes.

  • thresholding (bool) – Show slider for thresholding. Cells with attribute value less than threshold will not be shown. Default False.

  • slicing (bool) – Show by slices. Default False.

  • opacity (float) – Opacity value between 0 and 1. Default 0.8.

  • scaling (bool, list or tuple) – The ratio of the axes in case of iterable, if True then it’s (1, 1, 1), if False then no scaling is applied. Default True.

  • clip_wells (float or None) – If not None, wells are clipped to the range of the reservoir model’s bounding box, increased by the ‘clip_wells’ value. Default value is 0.05.

  • cmap (object) – Matplotlib, Colorcet, cmocean, or custom colormap

  • notebook (bool) – When True, the resulting plot is placed inline a jupyter notebook. Assumes a jupyter console is active. Automatically enables off_screen.

  • backend (None or str) – Pyvista backend. Default None.

  • theme (str) – PyVista theme, e.g. ‘default’, ‘dark’, ‘document’, ‘ParaView’. See https://docs.pyvista.org/examples/02-plot/themes.html for more options.

  • show_edges (bool) – Shows the edges of a mesh. Default True.

  • faults_color (str) – Corol to show faults. Default ‘red’.