Opm-core

From opm
Jump to: navigation, search

The opm-core

Build instructions

To get started using the modules, please see the build description.

Content

This is the core library within OPM and contains the following

  • Eclipse deck input and preprosessing
  • Fluid properties (basic PVT models and rock properties)
  • Grid handling (cornerpoint grids, unstructured grid interface)
  • Linear Algebra (interface to different linear solvers)
  • Pressure solvers (various discretization schemes, flow models)
  • Simulators (some basic examples of simulators based on sequential splitting schemes)
  • Transport solvers (various discretization schemes, flow models)
  • Utilities (input and output processing, unit conversion)
  • Wells (basic well handling)

Usage

There are several example programs included with the code, covering several intended uses. The format used for giving parameters is the same for all example programs, and is documented in the next section.

opm-core/examples/compute_tof

This simple program reads a grid and writes a vtk-formatted file suitable for visualizing the grid. It is worth noting, however, that currently the cells are shown only with their (up to) six canonical faces, even if such a face has been split due to faults in the grid. Given a filename <something>.grdecl, the resulting file will be called <something>-cells.vtu. It can be opened for example in paraview. The program accepts the following parameters:

Parameter Type Default value effect
fileformat string cartesian choose type of input grid, use eclipse or cartesian
filename string when fileformat = eclipse, the name of the grid file (.grdecl)
z_tolerance double 0.0 when fileformat = eclipse, points on the same pillar will degenerate to a single point when z-coordinates are within z_tolerance
nx int 1 when fileformat = cartesian, the number of cells in the x direction
ny int 1 when fileformat = cartesian, the number of cells in the y direction
nz int 1 when fileformat = cartesian, the number of cells in the z direction
dx double 1.0 when fileformat = cartesian, the size of a cell in the x direction
dy double 1.0 when fileformat = cartesian, the size of a cell in the y direction
dz double 1.0 when fileformat = cartesian, the size of a cell in the z direction