Opm::BlackoilPropertiesBasic Class Reference

#include <BlackoilPropertiesBasic.hpp>

Inheritance diagram for Opm::BlackoilPropertiesBasic:

Public Member Functions
	BlackoilPropertiesBasic (const parameter::ParameterGroup &param, const int dim, const int num_cells)
virtual	~BlackoilPropertiesBasic ()
	Destructor. More...
virtual int	numDimensions () const
virtual int	numCells () const
virtual const int *	cellPvtRegionIndex () const
virtual const double *	porosity () const
virtual const double *	permeability () const
virtual int	numPhases () const
virtual PhaseUsage	phaseUsage () const
virtual void	viscosity (const int n, const double *p, const double *T, const double *z, const int *cells, double *mu, double *dmudp) const
virtual void	matrix (const int n, const double *p, const double *T, const double *z, const int *cells, double *A, double *dAdp) const
virtual void	density (const int n, const double *A, const int *cells, double *rho) const
virtual const double *	surfaceDensity (int cellIdx=0) const
virtual void	relperm (const int n, const double *s, const int *cells, double *kr, double *dkrds) const
virtual void	capPress (const int n, const double *s, const int *cells, double *pc, double *dpcds) const
virtual void	satRange (const int n, const int *cells, double *smin, double *smax) const
virtual void	swatInitScaling (const int cell, const double pcow, double &swat)

Detailed Description

Concrete class implementing the blackoil property interface, reading all necessary input from parameters.

Constructor & Destructor Documentation

Opm::BlackoilPropertiesBasic::BlackoilPropertiesBasic	(	const parameter::ParameterGroup &	param,
		const int	dim,
		const int	num_cells
	)

Construct from parameters. The following parameters are accepted (defaults):

• num_phases (2) – Must be 1 or 2.
• relperm_func ("Linear") – Must be "Constant", "Linear" or "Quadratic".
• rho1, rho2, rho3 (1.0e3) – Density in kg/m^3
• mu1, mu2, mu3 (1.0) – Viscosity in cP
• porosity (1.0) – Porosity
• permeability (100.0) – Permeability in mD

virtual Opm::BlackoilPropertiesBasic::~BlackoilPropertiesBasic ( )

virtual

Destructor.

Member Function Documentation

virtual void Opm::BlackoilPropertiesBasic::capPress ( const int  n, const double *  s, const int *  cells, double *  pc, double *  dpcds  ) const

virtual

Parameters

[in]	n	Number of data points.
[in]	s	Array of nP saturation values.
[in]	cells	Array of n cell indices to be associated with the s values.
[out]	pc	Array of nP capillary pressure values, array must be valid before calling.
[out]	dpcds	If non-null: array of nP^2 derivative values, array must be valid before calling. The P^2 derivative matrix is m_{ij} = {dpc_i}{ds^j}, and is output in Fortran order (m_00 m_10 m_20 m_01 ...)

Implements Opm::BlackoilPropertiesInterface.

virtual const int* Opm::BlackoilPropertiesBasic::cellPvtRegionIndex ( ) const

inlinevirtual

Return an array containing the PVT table index for each grid cell

Implements Opm::BlackoilPropertiesInterface.

virtual void Opm::BlackoilPropertiesBasic::density ( const int  n, const double *  A, const int *  cells, double *  rho  ) const

virtual

Densities of stock components at reservoir conditions.

Parameters

[in]	n	Number of data points.
[in]	A	Array of nP^2 values, where the P^2 values for a cell give the matrix A = RB^{-1} which relates z to u by z = Au. The matrices are assumed to be in Fortran order, and are typically the result of a call to the method matrix().
[in]	cells	The index of the grid cell of each data point.
[out]	rho	Array of nP density values, array must be valid before calling.

Implements Opm::BlackoilPropertiesInterface.

virtual void Opm::BlackoilPropertiesBasic::matrix ( const int  n, const double *  p, const double *  T, const double *  z, const int *  cells, double *  A, double *  dAdp  ) const

virtual

Parameters

[in]	n	Number of data points.
[in]	p	Array of n pressure values.
[in]	T	Array of n temperature values.
[in]	z	Array of nP surface volume values.
[in]	cells	Array of n cell indices to be associated with the p and z values.
[out]	A	Array of nP^2 values, array must be valid before calling. The P^2 values for a cell give the matrix A = RB^{-1} which relates z to u by z = Au. The matrices are output in Fortran order.
[out]	dAdp	If non-null: array of nP^2 matrix derivative values, array must be valid before calling. The matrices are output in Fortran order.

Implements Opm::BlackoilPropertiesInterface.

virtual int Opm::BlackoilPropertiesBasic::numCells ( ) const

virtual

Returns

N, the number of cells.

Implements Opm::BlackoilPropertiesInterface.

virtual int Opm::BlackoilPropertiesBasic::numDimensions ( ) const

virtual

Returns

D, the number of spatial dimensions.

Implements Opm::BlackoilPropertiesInterface.

virtual int Opm::BlackoilPropertiesBasic::numPhases ( ) const

virtual

Returns

P, the number of phases (also the number of components).

Implements Opm::BlackoilPropertiesInterface.

virtual const double* Opm::BlackoilPropertiesBasic::permeability ( ) const

virtual

Returns

Array of ND^2 permeability values. The D^2 permeability values for a cell are organized as a matrix, which is symmetric (so ordering does not matter).

Implements Opm::BlackoilPropertiesInterface.

virtual PhaseUsage Opm::BlackoilPropertiesBasic::phaseUsage ( ) const

virtual

Returns

Object describing the active phases.

Implements Opm::BlackoilPropertiesInterface.

virtual const double* Opm::BlackoilPropertiesBasic::porosity ( ) const

virtual

Returns

Array of N porosity values.

Implements Opm::BlackoilPropertiesInterface.

virtual void Opm::BlackoilPropertiesBasic::relperm ( const int  n, const double *  s, const int *  cells, double *  kr, double *  dkrds  ) const

virtual

Parameters

[in]	n	Number of data points.
[in]	s	Array of nP saturation values.
[in]	cells	Array of n cell indices to be associated with the s values.
[out]	kr	Array of nP relperm values, array must be valid before calling.
[out]	dkrds	If non-null: array of nP^2 relperm derivative values, array must be valid before calling. The P^2 derivative matrix is m_{ij} = {dkr_i}{ds^j}, and is output in Fortran order (m_00 m_10 m_20 m_01 ...)

Implements Opm::BlackoilPropertiesInterface.

virtual void Opm::BlackoilPropertiesBasic::satRange ( const int  n, const int *  cells, double *  smin, double *  smax  ) const

virtual

Obtain the range of allowable saturation values. In cell cells[i], saturation of phase p is allowed to be in the interval [smin[i*P + p], smax[i*P + p]].

Parameters

[in]	n	Number of data points.
[in]	cells	Array of n cell indices.
[out]	smin	Array of nP minimum s values, array must be valid before calling.
[out]	smax	Array of nP maximum s values, array must be valid before calling.

Implements Opm::BlackoilPropertiesInterface.

virtual const double* Opm::BlackoilPropertiesBasic::surfaceDensity ( int  cellIdx = 0 ) const

virtual

Densities of stock components at surface conditions.

Parameters

[in]

cellIdx

The index of the cell for which the surface density ought to be calculated

Returns

Array of P density values.

Implements Opm::BlackoilPropertiesInterface.

virtual void Opm::BlackoilPropertiesBasic::swatInitScaling ( const int  cell, const double  pcow, double &  swat  )

virtual

Update capillary pressure scaling according to pressure diff. and initial water saturation.

Parameters

[in]	cell	Cell index.
[in]	pcow	P_oil - P_water.
	in/out]	swat Water saturation. / Possibly modified Water saturation.

Implements Opm::BlackoilPropertiesInterface.

virtual void Opm::BlackoilPropertiesBasic::viscosity ( const int  n, const double *  p, const double *  T, const double *  z, const int *  cells, double *  mu, double *  dmudp  ) const

virtual

Parameters

[in]	n	Number of data points.
[in]	p	Array of n pressure values.
[in]	T	Array of n temperature values.
[in]	z	Array of nP surface volume values.
[in]	cells	Array of n cell indices to be associated with the p and z values.
[out]	mu	Array of nP viscosity values, array must be valid before calling.
[out]	dmudp	If non-null: array of nP viscosity derivative values, array must be valid before calling.

Implements Opm::BlackoilPropertiesInterface.

---

The documentation for this class was generated from the following file:

• BlackoilPropertiesBasic.hpp