Public Types | Public Member Functions | Static Public Member Functions | List of all members
Opm::MixingRateControls< FluidSystem > Class Template Reference

Class handling mixing rate controls for a FlowProblem. More...

#include <MixingRateControls.hpp>

Inheritance diagram for Opm::MixingRateControls< FluidSystem >:
Inheritance graph

Public Types

using Scalar = typename FluidSystem::Scalar
 

Public Member Functions

 MixingRateControls (const Schedule &schedule)
 
 MixingRateControls (const MixingRateControls &rhs)
 
bool operator== (const MixingRateControls &rhs) const
 
MixingRateControls & operator= (const MixingRateControls &rhs)
 
void init (std::size_t numDof, int episodeIdx, const unsigned ntpvt)
 
bool drsdtActive (int episodeIdx) const
 
bool drvdtActive (int episodeIdx) const
 
bool drsdtConvective (int episodeIdx) const
 
Scalar drsdtcon (const unsigned elemIdx, int episodeIdx, const int pvtRegionIdx) const
 Returns the dynamic drsdt convective mixing value. More...
 
Scalar maxGasDissolutionFactor (unsigned timeIdx, unsigned globalDofIdx, const int episodeIdx, const int pvtRegionIdx) const
 Returns the maximum value of the gas dissolution factor at the current time for a given degree of freedom. More...
 
Scalar maxOilVaporizationFactor (const unsigned timeIdx, const unsigned globalDofIdx, const int episodeIdx, const int pvtRegionIdx) const
 Returns the maximum value of the oil vaporization factor at the current time for a given degree of freedom. More...
 
void updateExplicitQuantities (const int episodeIdx, const Scalar timeStepSize)
 
void updateLastValues (const unsigned elemIdx, const Scalar Rs, const Scalar Rv)
 
void updateMaxValues (const int episodeIdx, const Scalar timeStepSize)
 
template<class Serializer >
void serializeOp (Serializer &serializer)
 
template<class IntensiveQuantities >
void update (unsigned compressedDofIdx, const IntensiveQuantities &iq, const int episodeIdx, const Scalar gravity, const Scalar permZ, const Scalar distZ, const int pvtRegionIdx, const std::array< bool, 3 > &active)
 

Static Public Member Functions

static MixingRateControls serializationTestObject (const Schedule &schedule)
 

Detailed Description

template<class FluidSystem>
class Opm::MixingRateControls< FluidSystem >

Class handling mixing rate controls for a FlowProblem.

Member Typedef Documentation

◆ Scalar

template<class FluidSystem >
using Opm::MixingRateControls< FluidSystem >::Scalar = typename FluidSystem::Scalar

Constructor & Destructor Documentation

◆ MixingRateControls() [1/2]

template<class FluidSystem >
Opm::MixingRateControls< FluidSystem >::MixingRateControls ( const Schedule &  schedule)

◆ MixingRateControls() [2/2]

template<class FluidSystem >
Opm::MixingRateControls< FluidSystem >::MixingRateControls ( const MixingRateControls< FluidSystem > &  rhs)

Member Function Documentation

◆ drsdtActive()

template<class FluidSystem >
bool Opm::MixingRateControls< FluidSystem >::drsdtActive ( int  episodeIdx) const

◆ drsdtcon()

template<class FluidSystem >
Scalar Opm::MixingRateControls< FluidSystem >::drsdtcon ( const unsigned  elemIdx,
int  episodeIdx,
const int  pvtRegionIdx 
) const

Returns the dynamic drsdt convective mixing value.

◆ drsdtConvective()

template<class FluidSystem >
bool Opm::MixingRateControls< FluidSystem >::drsdtConvective ( int  episodeIdx) const

◆ drvdtActive()

template<class FluidSystem >
bool Opm::MixingRateControls< FluidSystem >::drvdtActive ( int  episodeIdx) const

◆ init()

template<class FluidSystem >
void Opm::MixingRateControls< FluidSystem >::init ( std::size_t  numDof,
int  episodeIdx,
const unsigned  ntpvt 
)

Referenced by Opm::FlowProblem< TypeTag >::finishInit().

◆ maxGasDissolutionFactor()

template<class FluidSystem >
Scalar Opm::MixingRateControls< FluidSystem >::maxGasDissolutionFactor ( unsigned  timeIdx,
unsigned  globalDofIdx,
const int  episodeIdx,
const int  pvtRegionIdx 
) const

Returns the maximum value of the gas dissolution factor at the current time for a given degree of freedom.

◆ maxOilVaporizationFactor()

template<class FluidSystem >
Scalar Opm::MixingRateControls< FluidSystem >::maxOilVaporizationFactor ( const unsigned  timeIdx,
const unsigned  globalDofIdx,
const int  episodeIdx,
const int  pvtRegionIdx 
) const

Returns the maximum value of the oil vaporization factor at the current time for a given degree of freedom.

◆ operator=()

template<class FluidSystem >
MixingRateControls & Opm::MixingRateControls< FluidSystem >::operator= ( const MixingRateControls< FluidSystem > &  rhs)

◆ operator==()

template<class FluidSystem >
bool Opm::MixingRateControls< FluidSystem >::operator== ( const MixingRateControls< FluidSystem > &  rhs) const

◆ serializationTestObject()

template<class FluidSystem >
static MixingRateControls Opm::MixingRateControls< FluidSystem >::serializationTestObject ( const Schedule &  schedule)
static

Referenced by Opm::FlowGenericProblem< GetPropType< TypeTag, Properties::GridView >, GetPropType< TypeTag, Properties::FluidSystem > >::briefDescription().

◆ serializeOp()

template<class FluidSystem >
template<class Serializer >
void Opm::MixingRateControls< FluidSystem >::serializeOp ( Serializer &  serializer)
inline

◆ update()

template<class FluidSystem >
template<class IntensiveQuantities >
void Opm::MixingRateControls< FluidSystem >::update ( unsigned  compressedDofIdx,
const IntensiveQuantities &  iq,
const int  episodeIdx,
const Scalar  gravity,
const Scalar  permZ,
const Scalar  distZ,
const int  pvtRegionIdx,
const std::array< bool, 3 > &  active 
)
inline

◆ updateExplicitQuantities()

template<class FluidSystem >
void Opm::MixingRateControls< FluidSystem >::updateExplicitQuantities ( const int  episodeIdx,
const Scalar  timeStepSize 
)

◆ updateLastValues()

template<class FluidSystem >
void Opm::MixingRateControls< FluidSystem >::updateLastValues ( const unsigned  elemIdx,
const Scalar  Rs,
const Scalar  Rv 
)

◆ updateMaxValues()

template<class FluidSystem >
void Opm::MixingRateControls< FluidSystem >::updateMaxValues ( const int  episodeIdx,
const Scalar  timeStepSize 
)
The documentation for this class was generated from the following file: