Opm::EQUIL::Details::PressureTable< FluidSystem, Region > Class Template Reference

#include <InitStateEquil.hpp>

Public Types

using VSpan = std::array< double, 2 >
 

Public Member Functions

 PressureTable (const double gravity, const int samplePoints=2000)
 
 PressureTable (const PressureTable &rhs)
 
 PressureTable (PressureTable &&rhs)
 
PressureTableoperator= (const PressureTable &rhs)
 
PressureTableoperator= (PressureTable &&rhs)
 
void equilibrate (const Region &reg, const VSpan &span)
 
bool oilActive () const
 Predicate for whether or not oil is an active phase. More...
 
bool gasActive () const
 Predicate for whether or not gas is an active phase. More...
 
bool waterActive () const
 Predicate for whether or not water is an active phase. More...
 
double oil (const double depth) const
 
double gas (const double depth) const
 
double water (const double depth) const
 

Member Typedef Documentation

◆ VSpan

template<class FluidSystem , class Region >
using Opm::EQUIL::Details::PressureTable< FluidSystem, Region >::VSpan = std::array<double, 2>

Constructor & Destructor Documentation

◆ PressureTable() [1/3]

template<class FluidSystem , class Region >
Opm::EQUIL::Details::PressureTable< FluidSystem, Region >::PressureTable ( const double  gravity,
const int  samplePoints = 2000 
)
explicit

Constructor

Parameters
[in]gravityNorm of gravity vector (acceleration strength due to gravity). Normally the standardised value at Tellus equator (9.80665 m/s^2).
[in]samplePointsNumber of equally spaced depth sample points in each internal phase pressure table.

◆ PressureTable() [2/3]

template<class FluidSystem , class Region >
Opm::EQUIL::Details::PressureTable< FluidSystem, Region >::PressureTable ( const PressureTable< FluidSystem, Region > &  rhs)

Copy constructor

Parameters
[in]rhsSource object for copy initialization.

◆ PressureTable() [3/3]

template<class FluidSystem , class Region >
Opm::EQUIL::Details::PressureTable< FluidSystem, Region >::PressureTable ( PressureTable< FluidSystem, Region > &&  rhs)

Move constructor

Parameters
[in,out]rhsSource object for move initialization. On output, left in a moved-from ("valid but unspecified") state. Internal pointers in rhs are null (unique_ptr guarantee).

Member Function Documentation

◆ equilibrate()

template<class FluidSystem , class Region >
void Opm::EQUIL::Details::PressureTable< FluidSystem, Region >::equilibrate ( const Region &  reg,
const VSpan span 
)

◆ gas()

template<class FluidSystem , class Region >
double Opm::EQUIL::Details::PressureTable< FluidSystem, Region >::gas ( const double  depth) const

Evaluate gas phase pressure at specified depth.

Parameters
[in]depthDepth of evaluation point. Should generally be within the span from the previous call to
void equilibrate(const Region &reg, const VSpan &span)
Definition: InitStateEquil_impl.hpp:1007
.
Returns
Gas phase pressure at specified depth.

◆ gasActive()

template<class FluidSystem , class Region >
bool Opm::EQUIL::Details::PressureTable< FluidSystem, Region >::gasActive

◆ oil()

template<class FluidSystem , class Region >
double Opm::EQUIL::Details::PressureTable< FluidSystem, Region >::oil ( const double  depth) const

Evaluate oil phase pressure at specified depth.

Parameters
[in]depthDepth of evaluation point. Should generally be within the span from the previous call to .
Returns
Oil phase pressure at specified depth.

◆ oilActive()

template<class FluidSystem , class Region >
bool Opm::EQUIL::Details::PressureTable< FluidSystem, Region >::oilActive

◆ operator=() [1/2]

template<class FluidSystem , class Region >
PressureTable< FluidSystem, Region > & Opm::EQUIL::Details::PressureTable< FluidSystem, Region >::operator= ( const PressureTable< FluidSystem, Region > &  rhs)

Assignment operator

Parameters
[in]rhsSource object.
Returns
*this
.

◆ operator=() [2/2]

template<class FluidSystem , class Region >
PressureTable< FluidSystem, Region > & Opm::EQUIL::Details::PressureTable< FluidSystem, Region >::operator= ( PressureTable< FluidSystem, Region > &&  rhs)

Move-assignment operator

Parameters
[in]rhsSource object. On output, left in a moved-from ("valid but unspecified") state. Internal pointers in rhs are null (unique_ptr guarantee).
Returns
*this
.

◆ water()

template<class FluidSystem , class Region >
double Opm::EQUIL::Details::PressureTable< FluidSystem, Region >::water ( const double  depth) const

Evaluate water phase pressure at specified depth.

Parameters
[in]depthDepth of evaluation point. Should generally be within the span from the previous call to .
Returns
Water phase pressure at specified depth.

◆ waterActive()

template<class FluidSystem , class Region >
bool Opm::EQUIL::Details::PressureTable< FluidSystem, Region >::waterActive

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