Opm::SaturationPropsInterface Class Reference

#include <SaturationPropsInterface.hpp>

Inheritance diagram for Opm::SaturationPropsInterface:

Public Types
enum	PhaseIndex {   Aqua = 0 , Liquid = 1 , Vapour = 2 , Solvent = 3 ,   Polymer = 4 , Energy = 5 }

Public Member Functions
virtual	~SaturationPropsInterface ()
	Virtual destructor. More...
virtual int	numPhases () const =0
virtual void	relperm (const int n, const double *s, const int *cells, double *kr, double *dkrds) const =0
virtual void	capPress (const int n, const double *s, const int *cells, double *pc, double *dpcds) const =0
virtual void	satRange (const int n, const int *cells, double *smin, double *smax) const =0
virtual void	updateSatHyst (const int n, const int *cells, const double *s)=0
virtual void	swatInitScaling (const int cell, const double pcow, double &swat)=0

Static Public Attributes
static const int	MaxNumPhases = 3
static const int	NumCryptoPhases = 3

Member Enumeration Documentation

PhaseIndex

enum Opm::BlackoilPhases::PhaseIndex

inherited

Enumerator
Aqua
Liquid
Vapour
Solvent
Polymer
Energy

Constructor & Destructor Documentation

~SaturationPropsInterface()

virtual Opm::SaturationPropsInterface::~SaturationPropsInterface ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

capPress()

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

pure virtual

Capillary pressure.

Parameters

[in]	n	Number of data points.
[in]	s	Array of nP saturation 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} = \frac{dpc_i}{ds^j}, and is output in Fortran order (m_00 m_10 m_20 m01 ...)

Implemented in Opm::SaturationPropsFromDeck.

numPhases()

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

pure virtual

Returns

P, the number of phases.

Implemented in Opm::SaturationPropsFromDeck.

relperm()

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

pure virtual

Relative permeability.

Parameters

[in]	n	Number of data points.
[in]	s	Array of nP saturation 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} = \frac{dkr_i}{ds^j}, and is output in Fortran order (m_00 m_10 m_20 m01 ...)

Implemented in Opm::SaturationPropsFromDeck.

satRange()

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

pure virtual

Obtain the range of allowable saturation values.

Parameters

[in]	n	Number of data points.
[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.

Implemented in Opm::SaturationPropsFromDeck.

swatInitScaling()

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

pure 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.

Implemented in Opm::SaturationPropsFromDeck.

updateSatHyst()

virtual void Opm::SaturationPropsInterface::updateSatHyst ( const int  n, const int *  cells, const double *  s  )

pure virtual

Update saturation state for the hysteresis tracking

Parameters

[in]	n	Number of data points.
[in]	s	Array of nP saturation values.

Implemented in Opm::SaturationPropsFromDeck.

Member Data Documentation

MaxNumPhases

const int Opm::BlackoilPhases::MaxNumPhases = 3

staticinherited

Referenced by Opm::phaseUsageFromDeck(), and Opm::ExplicitArraysFluidState::setIndex().

NumCryptoPhases

const int Opm::BlackoilPhases::NumCryptoPhases = 3

staticinherited

Referenced by Opm::phaseUsageFromDeck().

---

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

• SaturationPropsInterface.hpp