Opm::BaseAquiferModel< TypeTag > Class Template Reference

The base class which specifies the API of aquifer models. More...

#include <BaseAquiferModel.hpp>

Public Member Functions
	BaseAquiferModel (Simulator &simulator)
void	initialSolutionApplied ()
	Called once the problem has been fully initialized and the initial condition has been applied. More...
void	initFromRestart (const data::Aquifers &)
	Called if aquifers are being initialized from values retrieved from a restart file. More...
void	beginEpisode ()
	This method is called when a new episode (report step) starts. More...
void	beginTimeStep ()
	This method is called when a new time step (substep) starts. More...
void	beginIteration ()
	This method is called before each Newton-Raphson iteration. More...
template<class Context >
void	addToSource (RateVector &, const Context &, unsigned, unsigned) const
	Add the water which enters or leaves the reservoir due to aquifiers. More...
void	endIteration ()
	This method is called after each Newton-Raphson successful iteration. More...
void	endTimeStep ()
	This method is called after each successful time step (substep). More...
void	endEpisode ()
	This method is called once an episode (report step) has been finished successfully. More...
template<class Restarter >
void	serialize (Restarter &)
	Write the internal state of the aquifer model to disk using an ad-hoc file format. More...
template<class Restarter >
void	deserialize (Restarter &)
	Load the internal state of the aquifer model to disk using an ad-hoc file format. More...
data::Aquifers	aquiferData () const

Protected Attributes
Simulator &	simulator_

Detailed Description

template<class TypeTag>
class Opm::BaseAquiferModel< TypeTag >

The base class which specifies the API of aquifer models.

This class only provides the API for the actual aquifer model, it does not do anything on its own.

Constructor & Destructor Documentation

BaseAquiferModel()

template<class TypeTag >

Opm::BaseAquiferModel< TypeTag >::BaseAquiferModel ( Simulator &  simulator )

inline

Member Function Documentation

addToSource()

template<class TypeTag >

template<class Context >

void Opm::BaseAquiferModel< TypeTag >::addToSource ( RateVector &  , const Context &  , unsigned  , unsigned    ) const

inline

Add the water which enters or leaves the reservoir due to aquifiers.

aquiferData()

template<class TypeTag >

data::Aquifers Opm::BaseAquiferModel< TypeTag >::aquiferData ( ) const

inline

beginEpisode()

template<class TypeTag >

void Opm::BaseAquiferModel< TypeTag >::beginEpisode ( )

inline

This method is called when a new episode (report step) starts.

beginIteration()

template<class TypeTag >

void Opm::BaseAquiferModel< TypeTag >::beginIteration ( )

inline

This method is called before each Newton-Raphson iteration.

beginTimeStep()

template<class TypeTag >

void Opm::BaseAquiferModel< TypeTag >::beginTimeStep ( )

inline

This method is called when a new time step (substep) starts.

deserialize()

template<class TypeTag >

template<class Restarter >

void Opm::BaseAquiferModel< TypeTag >::deserialize ( Restarter &  )

inline

Load the internal state of the aquifer model to disk using an ad-hoc file format.

endEpisode()

template<class TypeTag >

void Opm::BaseAquiferModel< TypeTag >::endEpisode ( )

inline

This method is called once an episode (report step) has been finished successfully.

endIteration()

template<class TypeTag >

void Opm::BaseAquiferModel< TypeTag >::endIteration ( )

inline

This method is called after each Newton-Raphson successful iteration.

I.e., no exceptions were thrown during the linearization and linear solution procedures.

endTimeStep()

template<class TypeTag >

void Opm::BaseAquiferModel< TypeTag >::endTimeStep ( )

inline

This method is called after each successful time step (substep).

I.e., all iterations of the time step were successful and the Newton-Raphson algorithm converged.

initFromRestart()

template<class TypeTag >

void Opm::BaseAquiferModel< TypeTag >::initFromRestart ( const data::Aquifers &  )

inline

Called if aquifers are being initialized from values retrieved from a restart file.

Parameters

[in]

aquiferSoln

Set of aquifer-related initial values, mostly pertaining to analytic aquifers. Contains at minimum the aquifer pressure and the base run's total produced liquid volume from the model's aquifers.

initialSolutionApplied()

template<class TypeTag >

void Opm::BaseAquiferModel< TypeTag >::initialSolutionApplied ( )

inline

Called once the problem has been fully initialized and the initial condition has been applied.

serialize()

template<class TypeTag >

template<class Restarter >

void Opm::BaseAquiferModel< TypeTag >::serialize ( Restarter &  )

inline

Write the internal state of the aquifer model to disk using an ad-hoc file format.

Member Data Documentation

simulator_

template<class TypeTag >

Simulator& Opm::BaseAquiferModel< TypeTag >::simulator_

protected

---

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

• BaseAquiferModel.hpp