Opm::SaturationPropsFromDeck Class Reference

Interface to saturation functions from deck. More...

#include <SaturationPropsFromDeck.hpp>

Inheritance diagram for Opm::SaturationPropsFromDeck:

Public Types
typedef Opm::ThreePhaseMaterialTraits < double, BlackoilPhases::Aqua, BlackoilPhases::Liquid, BlackoilPhases::Vapour >	MaterialTraits
typedef Opm::EclMaterialLawManager < MaterialTraits >	MaterialLawManager
enum	PhaseIndex { Aqua = 0, Liquid = 1, Vapour = 2 }

Public Member Functions
	SaturationPropsFromDeck ()
	Default constructor. More...
void	init (const PhaseUsage &phaseUsage, std::shared_ptr< MaterialLawManager > materialLawManager)
void	init (Opm::DeckConstPtr deck, std::shared_ptr< MaterialLawManager > materialLawManager)
int	numPhases () const
void	relperm (const int n, const double *s, const int *cells, double *kr, double *dkrds) const
void	capPress (const int n, const double *s, const int *cells, double *pc, double *dpcds) const
void	satRange (const int n, const int *cells, double *smin, double *smax) const
void	updateSatHyst (const int n, const int *cells, const double *s)
void	swatInitScaling (const int cell, const double pcow, double &swat)

Static Public Attributes
static const int	MaxNumPhases = 3

Detailed Description

Interface to saturation functions from deck.

Member Typedef Documentation

typedef Opm::EclMaterialLawManager<MaterialTraits> Opm::SaturationPropsFromDeck::MaterialLawManager

typedef Opm::ThreePhaseMaterialTraits<double, BlackoilPhases::Aqua, BlackoilPhases::Liquid, BlackoilPhases::Vapour> Opm::SaturationPropsFromDeck::MaterialTraits

Member Enumeration Documentation

enum Opm::BlackoilPhases::PhaseIndex

inherited

Enumerator
Aqua
Liquid
Vapour

Constructor & Destructor Documentation

Opm::SaturationPropsFromDeck::SaturationPropsFromDeck

(

)

Default constructor.

Member Function Documentation

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

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} = {dpc_i}{ds^j}, and is output in Fortran order (m_00 m_10 m_20 m01 ...)

Implements Opm::SaturationPropsInterface.

void Opm::SaturationPropsFromDeck::init	(	const PhaseUsage &	phaseUsage,
		std::shared_ptr< MaterialLawManager >	materialLawManager
	)

Initialize from a MaterialLawManager object.

Parameters

[in]	phaseUsage	Phase configuration
[in]	materialLawManager	An initialized MaterialLawManager object

Referenced by init().

void Opm::SaturationPropsFromDeck::init ( Opm::DeckConstPtr  deck, std::shared_ptr< MaterialLawManager >  materialLawManager  )

inline

Initialize from deck and MaterialLawManager.

Parameters

[in]	deck	Input deck
[in]	materialLawManager	An initialized MaterialLawManager object

References init(), and Opm::phaseUsageFromDeck().

int Opm::SaturationPropsFromDeck::numPhases ( ) const

virtual

Returns

P, the number of phases.

Implements Opm::SaturationPropsInterface.

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

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} = {dkr_i}{ds^j}, and is output in Fortran order (m_00 m_10 m_20 m01 ...)

Implements Opm::SaturationPropsInterface.

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

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.

Implements Opm::SaturationPropsInterface.

void Opm::SaturationPropsFromDeck::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::SaturationPropsInterface.

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

virtual

Update saturation state for the hysteresis tracking

Parameters

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

Implements Opm::SaturationPropsInterface.

Member Data Documentation

const int Opm::BlackoilPhases::MaxNumPhases = 3

staticinherited

Referenced by Opm::Equil::isConstPc(), Opm::Equil::PcEq::PcEq(), Opm::Equil::PcEqSum::PcEqSum(), Opm::Equil::phaseSaturations(), Opm::phaseUsageFromDeck(), Opm::Equil::Miscibility::RsSatAtContact::RsSatAtContact(), Opm::Equil::Miscibility::RsVD::RsVD(), Opm::Equil::Miscibility::RvSatAtContact::RvSatAtContact(), Opm::Equil::Miscibility::RvVD::RvVD(), Opm::Equil::satFromDepth(), Opm::Equil::satFromPc(), Opm::Equil::satFromSumOfPcs(), and Opm::ExplicitArraysFluidState::setIndex().

---

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

• SaturationPropsFromDeck.hpp