Opm::EQUIL::Details::PhaseSaturations< MaterialLawManager, FluidSystem, Region, CellID > Class Template Reference

#include <InitStateEquil.hpp>

Classes
struct	Position

Public Types
using	PTable = PressureTable< FluidSystem, Region >
	Convenience type alias. More...

Public Member Functions
	PhaseSaturations (MaterialLawManager &matLawMgr, const std::vector< double > &swatInit)
	PhaseSaturations (const PhaseSaturations &rhs)
PhaseSaturations &	operator= (const PhaseSaturations &)=delete
	Disabled assignment operator. More...
PhaseSaturations &	operator= (PhaseSaturations &&)=delete
	Disabled move-assignment operator. More...
const PhaseQuantityValue &	deriveSaturations (const Position &x, const Region &reg, const PTable &ptable)
const PhaseQuantityValue &	correctedPhasePressures () const

Detailed Description

template<class MaterialLawManager, class FluidSystem, class Region, typename CellID>
class Opm::EQUIL::Details::PhaseSaturations< MaterialLawManager, FluidSystem, Region, CellID >

Calculator for phase saturations

Computes saturation values at arbitrary depths.

Template Parameters

MaterialLawManager	Container for material laws. Typically a specialization of the Opm::EclMaterialLawManager<> template.
FluidSystem	An OPM fluid system type. Typically a specialization of the Opm::BlackOilFluidSystem<> template.
Region	Representation of an equilibration region. Typically Opm::EQUIL::EquilReg from the equilibrationhelpers.
CellID	Representation an equilibration region's cell IDs. Typically std::size_t .

Member Typedef Documentation

PTable

template<class MaterialLawManager , class FluidSystem , class Region , typename CellID >

using Opm::EQUIL::Details::PhaseSaturations< MaterialLawManager, FluidSystem, Region, CellID >::PTable = PressureTable<FluidSystem, Region>

Convenience type alias.

Constructor & Destructor Documentation

PhaseSaturations() [1/2]

template<class MaterialLawManager , class FluidSystem , class Region , typename CellID >

Opm::EQUIL::Details::PhaseSaturations< MaterialLawManager, FluidSystem, Region, CellID >::PhaseSaturations ( MaterialLawManager &  matLawMgr, const std::vector< double > &  swatInit  )

explicit

Constructor

Parameters

[in,out]	matLawMgr	Read/write reference to a material law container. Mutated by member functions.
[in]	swatInit	Initial water saturation array (from SWATINIT data). Empty if SWATINIT is not used in this simulation model.

PhaseSaturations() [2/2]

template<class MaterialLawManager , class FluidSystem , class Region , typename CellID >

Opm::EQUIL::Details::PhaseSaturations< MaterialLawManager, FluidSystem, Region, CellID >::PhaseSaturations

(

const PhaseSaturations< MaterialLawManager, FluidSystem, Region, CellID > &

rhs

)

Copy constructor.

Parameters

[in]

rhs

Source object.

Member Function Documentation

correctedPhasePressures()

template<class MaterialLawManager , class FluidSystem , class Region , typename CellID >

const PhaseQuantityValue & Opm::EQUIL::Details::PhaseSaturations< MaterialLawManager, FluidSystem, Region, CellID >::correctedPhasePressures ( ) const

inline

Retrieve saturation-corrected phase pressures

Values associated with evaluation point of previous call to

deriveSaturations() 

.

deriveSaturations()

template<class MaterialLawManager , class FluidSystem , class Region , typename CellID >

const PhaseQuantityValue & Opm::EQUIL::Details::PhaseSaturations< MaterialLawManager, FluidSystem, Region, CellID >::deriveSaturations	(	const Position &	x,
		const Region &	reg,
		const PTable &	ptable
	)

Calculate phase saturations at particular point of the simulation model geometry.

Parameters

[in]	x	Specific geometric point (depth within a specific cell).
[in]	reg	Equilibration information for a single equilibration region; notably contact depths.
[in]	ptable	Previously equilibrated phase pressure table pertaining to the equilibration region reg.

Returns

Set of phase saturation values defined at particular point.

References Opm::EQUIL::Details::PressureTable< FluidSystem, Region >::gasActive(), Opm::EQUIL::Details::PressureTable< FluidSystem, Region >::oilActive(), and Opm::EQUIL::Details::PressureTable< FluidSystem, Region >::waterActive().

operator=() [1/2]

template<class MaterialLawManager , class FluidSystem , class Region , typename CellID >

PhaseSaturations & Opm::EQUIL::Details::PhaseSaturations< MaterialLawManager, FluidSystem, Region, CellID >::operator= ( const PhaseSaturations< MaterialLawManager, FluidSystem, Region, CellID > &  )

delete

Disabled assignment operator.

operator=() [2/2]

template<class MaterialLawManager , class FluidSystem , class Region , typename CellID >

PhaseSaturations & Opm::EQUIL::Details::PhaseSaturations< MaterialLawManager, FluidSystem, Region, CellID >::operator= ( PhaseSaturations< MaterialLawManager, FluidSystem, Region, CellID > &&  )

delete

Disabled move-assignment operator.

---

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

• InitStateEquil.hpp
• InitStateEquil_impl.hpp