OPM - Reference Documentation for ewoms

A fully-implicit multi-phase flow model which assumes immiscibility of the phases. More...

#include <immisciblemodel.hh>

Inheritance diagram for Ewoms::ImmiscibleModel< TypeTag >:

Inheritance graph

Public Member Functions
	ImmiscibleModel (Simulator &simulator)

std::string	primaryVarName (int pvIdx) const
	Given an primary variable index, return a human readable name. More...

std::string	eqName (int eqIdx) const
	Given an equation index, return a human readable name. More...

void	updateBegin ()
	Called by the update() method before it tries to apply the newton method. This is primary a hook which the actual model can overload. More...

Scalar	primaryVarWeight (int globalDofIdx, int pvIdx) const

Scalar	eqWeight (int globalDofIdx, int eqIdx) const

void	registerOutputModules_ ()

void	finishInit ()
	Apply the initial conditions to the model. More...

bool	phaseIsConsidered (int phaseIdx) const
	Returns true iff a fluid phase is used by the model. More...

void	globalPhaseStorage (EqVector &storage, int phaseIdx)
	Compute the total storage inside one phase of all conservation quantities. More...

Static Public Member Functions
static void	registerParameters ()
	Register all run-time parameters for the immiscible model. More...

static std::string	name ()

Detailed Description

template<class TypeTag>
class Ewoms::ImmiscibleModel< TypeTag >

A fully-implicit multi-phase flow model which assumes immiscibility of the phases.

This model implements multi-phase flow of $M > 0$ immiscible fluids $\alpha$ . By default, the standard multi-phase Darcy approach is used to determine the velocity, i.e.

$\mathbf{v}_\alpha = - \frac{k_{r\alpha}}{\mu_\alpha} \mathbf{K}\left(\mathbf{grad}\, p_\alpha - \varrho_{\alpha} \mathbf{g} \right) \;,$

although the actual approach which is used can be specified via the FluxModule property. For example, the velocity model can by changed to the Forchheimer approach by

SET_TYPE_PROP(MyProblemTypeTag, FluxModule, Ewoms::ForchheimerFluxModule<TypeTag>);

The core of the model is the conservation mass of each component by means of the equation

$\frac{\partial\;\phi S_\alpha \rho_\alpha }{\partial t} - \mathrm{div} \left\{ \rho_\alpha \mathbf{v}_\alpha \right\} - q_\alpha = 0 \;.$

The model uses the following primary variables:

The pressure in Pascal of the phase with the lowest index
The saturations $S_\alpha$ of the phases that exhibit the lowest indices
The absolute temperature in Kelvin if energy is conserved via the energy equation

Constructor & Destructor Documentation

template<class TypeTag >

Ewoms::ImmiscibleModel< TypeTag >::ImmiscibleModel ( Simulator & simulator )

inline

Member Function Documentation

template<class TypeTag >

std::string Ewoms::ImmiscibleModel< TypeTag >::eqName ( int eqIdx ) const

inline

Given an equation index, return a human readable name.

Parameters

eqIdx The index of the conservation equation of interest.

template<class TypeTag >

Scalar Ewoms::ImmiscibleModel< TypeTag >::eqWeight	(	int	globalDofIdx,
		int	eqIdx
	)		const

inline

Parameters

globalVertexIdx	The global index of the vertex
eqIdx	The index of the equation

template<class TypeTag >

void Ewoms::MultiPhaseBaseModel< TypeTag >::finishInit ( )

inlineinherited

Apply the initial conditions to the model.

References EWOMS_GET_PARAM.

Referenced by Ewoms::BlackOilModel< TypeTag >::finishInit(), and Ewoms::NcpModel< TypeTag >::finishInit().

template<class TypeTag >

void Ewoms::MultiPhaseBaseModel< TypeTag >::globalPhaseStorage	(	EqVector &	storage,
		int	phaseIdx
	)

inlineinherited

Compute the total storage inside one phase of all conservation quantities.

Parameters

storage	Stores the total amount of each conserved quantity inside the domain.
phaseIdx	The index of the fluid phase of interest.

References Ewoms::ThreadedEntityIterator< GridView, codim >::beginParallel(), Ewoms::ThreadedEntityIterator< GridView, codim >::increment(), Ewoms::ThreadedEntityIterator< GridView, codim >::isFinished(), Ewoms::ThreadManager< TypeTag >::threadId(), and OmpMutex::unlock().

template<class TypeTag >

static std::string Ewoms::ImmiscibleModel< TypeTag >::name ( )

inlinestatic

template<class TypeTag >

bool Ewoms::MultiPhaseBaseModel< TypeTag >::phaseIsConsidered ( int phaseIdx ) const

inlineinherited

Returns true iff a fluid phase is used by the model.

Parameters

phaseIdx The index of the fluid phase in question

template<class TypeTag >

std::string Ewoms::ImmiscibleModel< TypeTag >::primaryVarName ( int pvIdx ) const

inline

Given an primary variable index, return a human readable name.

Parameters

pvIdx The index of the primary variable of interest.

template<class TypeTag >

Scalar Ewoms::ImmiscibleModel< TypeTag >::primaryVarWeight	(	int	globalDofIdx,
		int	pvIdx
	)		const

inline

Parameters

globalDofIdx	The global index of the degree of freedom
pvIdx	The index of the primary variable

template<class TypeTag >

void Ewoms::ImmiscibleModel< TypeTag >::registerOutputModules_ ( )

inline

References Ewoms::MultiPhaseBaseModel< TypeTag >::registerOutputModules_().

Referenced by Ewoms::DiscreteFractureModel< TypeTag >::registerOutputModules_().

template<class TypeTag >

static void Ewoms::ImmiscibleModel< TypeTag >::registerParameters ( )

inlinestatic

Register all run-time parameters for the immiscible model.

References Ewoms::VtkEnergyModule< TypeTag >::registerParameters(), and Ewoms::MultiPhaseBaseModel< TypeTag >::registerParameters().

Referenced by Ewoms::DiscreteFractureModel< TypeTag >::registerParameters().

template<class TypeTag >

void Ewoms::ImmiscibleModel< TypeTag >::updateBegin ( )

inline

Called by the update() method before it tries to apply the newton method. This is primary a hook which the actual model can overload.

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

immisciblemodel.hh