Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Opm::AquiferInterface< TypeTag > Class Template Referenceabstract

#include <AquiferInterface.hpp>

Inheritance diagram for Opm::AquiferInterface< TypeTag >:
Inheritance graph

Public Types

using FluidSystem = GetPropType< TypeTag, Properties::FluidSystem >
 
using RateVector = GetPropType< TypeTag, Properties::RateVector >
 
using Simulator = GetPropType< TypeTag, Properties::Simulator >
 
using Scalar = GetPropType< TypeTag, Properties::Scalar >
 

Public Member Functions

 AquiferInterface (int aqID, const Simulator &simulator)
 
virtual ~AquiferInterface ()=default
 
virtual void initFromRestart (const data::Aquifers &aquiferSoln)=0
 
virtual void initialSolutionApplied ()=0
 
virtual void beginTimeStep ()=0
 
virtual void endTimeStep ()=0
 
virtual data::AquiferData aquiferData () const =0
 
virtual void computeFaceAreaFraction (const std::vector< Scalar > &total_face_area)=0
 
virtual Scalar totalFaceArea () const =0
 
template<class Context >
void addToSource (RateVector &rates, const Context &context, const unsigned spaceIdx, const unsigned timeIdx)
 
virtual void addToSource (RateVector &rates, const unsigned cellIdx, const unsigned timeIdx)=0
 
int aquiferID () const
 

Protected Member Functions

bool co2store_or_h2store_ () const
 
int phaseIdx_ () const
 

Protected Attributes

const int aquiferID_ {}
 
const Simulator & simulator_
 

Member Typedef Documentation

◆ FluidSystem

template<typename TypeTag >
using Opm::AquiferInterface< TypeTag >::FluidSystem = GetPropType<TypeTag, Properties::FluidSystem>

◆ RateVector

template<typename TypeTag >
using Opm::AquiferInterface< TypeTag >::RateVector = GetPropType<TypeTag, Properties::RateVector>

◆ Scalar

template<typename TypeTag >
using Opm::AquiferInterface< TypeTag >::Scalar = GetPropType<TypeTag, Properties::Scalar>

◆ Simulator

template<typename TypeTag >
using Opm::AquiferInterface< TypeTag >::Simulator = GetPropType<TypeTag, Properties::Simulator>

Constructor & Destructor Documentation

◆ AquiferInterface()

template<typename TypeTag >
Opm::AquiferInterface< TypeTag >::AquiferInterface ( int  aqID,
const Simulator &  simulator 
)
inline

◆ ~AquiferInterface()

template<typename TypeTag >
virtual Opm::AquiferInterface< TypeTag >::~AquiferInterface ( )
virtualdefault

Member Function Documentation

◆ addToSource() [1/2]

template<typename TypeTag >
template<class Context >
void Opm::AquiferInterface< TypeTag >::addToSource ( RateVector &  rates,
const Context &  context,
const unsigned  spaceIdx,
const unsigned  timeIdx 
)
inline

References Opm::AquiferInterface< TypeTag >::addToSource().

Referenced by Opm::AquiferInterface< TypeTag >::addToSource().

◆ addToSource() [2/2]

template<typename TypeTag >
virtual void Opm::AquiferInterface< TypeTag >::addToSource ( RateVector &  rates,
const unsigned  cellIdx,
const unsigned  timeIdx 
)
pure virtual

Implemented in Opm::AquiferNumerical< TypeTag >, Opm::AquiferAnalytical< TypeTag >, and Opm::AquiferConstantFlux< TypeTag >.

◆ aquiferData()

template<typename TypeTag >
virtual data::AquiferData Opm::AquiferInterface< TypeTag >::aquiferData ( ) const
pure virtual

Implemented in Opm::AquiferCarterTracy< TypeTag >, Opm::AquiferConstantFlux< TypeTag >, Opm::AquiferFetkovich< TypeTag >, and Opm::AquiferNumerical< TypeTag >.

◆ aquiferID()

template<typename TypeTag >
int Opm::AquiferInterface< TypeTag >::aquiferID ( ) const
inline

References Opm::AquiferInterface< TypeTag >::aquiferID_.

Referenced by Opm::AquiferCarterTracy< TypeTag >::aquiferData(), Opm::AquiferFetkovich< TypeTag >::aquiferData(), Opm::AquiferNumerical< TypeTag >::aquiferData(), Opm::AquiferAnalytical< TypeTag >::computeFaceAreaFraction(), Opm::AquiferConstantFlux< TypeTag >::computeFaceAreaFraction(), Opm::AquiferAnalytical< TypeTag >::initFromRestart(), Opm::AquiferConstantFlux< TypeTag >::initFromRestart(), and Opm::AquiferNumerical< TypeTag >::initFromRestart().

◆ beginTimeStep()

template<typename TypeTag >
virtual void Opm::AquiferInterface< TypeTag >::beginTimeStep ( )
pure virtual

Implemented in Opm::AquiferAnalytical< TypeTag >, Opm::AquiferConstantFlux< TypeTag >, and Opm::AquiferNumerical< TypeTag >.

◆ co2store_or_h2store_()

template<typename TypeTag >
bool Opm::AquiferInterface< TypeTag >::co2store_or_h2store_ ( ) const
inlineprotected

References Opm::AquiferInterface< TypeTag >::simulator_.

Referenced by Opm::AquiferCarterTracy< TypeTag >::aquiferData(), Opm::AquiferCarterTracy< TypeTag >::calculateAquiferCondition(), Opm::AquiferCarterTracy< TypeTag >::calculateAquiferConstants(), Opm::AquiferAnalytical< TypeTag >::compIdx_(), and Opm::AquiferInterface< TypeTag >::phaseIdx_().

◆ computeFaceAreaFraction()

template<typename TypeTag >
virtual void Opm::AquiferInterface< TypeTag >::computeFaceAreaFraction ( const std::vector< Scalar > &  total_face_area)
pure virtual

Implemented in Opm::AquiferConstantFlux< TypeTag >.

◆ endTimeStep()

template<typename TypeTag >
virtual void Opm::AquiferInterface< TypeTag >::endTimeStep ( )
pure virtual

Implemented in Opm::AquiferCarterTracy< TypeTag >, Opm::AquiferConstantFlux< TypeTag >, Opm::AquiferFetkovich< TypeTag >, and Opm::AquiferNumerical< TypeTag >.

◆ initFromRestart()

template<typename TypeTag >
virtual void Opm::AquiferInterface< TypeTag >::initFromRestart ( const data::Aquifers &  aquiferSoln)
pure virtual

Implemented in Opm::AquiferAnalytical< TypeTag >, Opm::AquiferConstantFlux< TypeTag >, and Opm::AquiferNumerical< TypeTag >.

◆ initialSolutionApplied()

template<typename TypeTag >
virtual void Opm::AquiferInterface< TypeTag >::initialSolutionApplied ( )
pure virtual

Implemented in Opm::AquiferAnalytical< TypeTag >, Opm::AquiferConstantFlux< TypeTag >, and Opm::AquiferNumerical< TypeTag >.

◆ phaseIdx_()

template<typename TypeTag >
int Opm::AquiferInterface< TypeTag >::phaseIdx_ ( ) const
inlineprotected

References Opm::AquiferInterface< TypeTag >::co2store_or_h2store_().

Referenced by Opm::AquiferAnalytical< TypeTag >::addToSource(), Opm::AquiferAnalytical< TypeTag >::calculateReservoirEquilibrium(), and Opm::AquiferAnalytical< TypeTag >::updateCellPressure().

◆ totalFaceArea()

template<typename TypeTag >
virtual Scalar Opm::AquiferInterface< TypeTag >::totalFaceArea ( ) const
pure virtual

Implemented in Opm::AquiferAnalytical< TypeTag >, Opm::AquiferConstantFlux< TypeTag >, and Opm::AquiferNumerical< TypeTag >.

Member Data Documentation

◆ aquiferID_

template<typename TypeTag >
const int Opm::AquiferInterface< TypeTag >::aquiferID_ {}
protected

Referenced by Opm::AquiferInterface< TypeTag >::aquiferID().

◆ simulator_

template<typename TypeTag >
const Simulator& Opm::AquiferInterface< TypeTag >::simulator_
protected

Referenced by Opm::AquiferAnalytical< TypeTag >::addToSource(), Opm::AquiferConstantFlux< TypeTag >::addToSource(), Opm::AquiferNumerical< TypeTag >::AquiferNumerical(), Opm::AquiferFetkovich< TypeTag >::aquiferPressure(), Opm::AquiferAnalytical< TypeTag >::beginTimeStep(), Opm::AquiferCarterTracy< TypeTag >::calculateAquiferCondition(), Opm::AquiferFetkovich< TypeTag >::calculateAquiferCondition(), Opm::AquiferAnalytical< TypeTag >::calculateReservoirEquilibrium(), Opm::AquiferInterface< TypeTag >::co2store_or_h2store_(), Opm::AquiferCarterTracy< TypeTag >::endTimeStep(), Opm::AquiferConstantFlux< TypeTag >::endTimeStep(), Opm::AquiferFetkovich< TypeTag >::endTimeStep(), Opm::AquiferNumerical< TypeTag >::endTimeStep(), Opm::AquiferAnalytical< TypeTag >::gravity_(), Opm::AquiferAnalytical< TypeTag >::initializeConnectionDepths(), and Opm::AquiferAnalytical< TypeTag >::initializeConnectionMappings().

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