Public Member Functions | Static Public Member Functions | List of all members
Opm::DiscreteFractureModel< TypeTag > Class Template Reference

A fully-implicit multi-phase flow model which assumes immiscibility of the phases and is able to include fractures in the domain. More...

#include <discretefracturemodel.hh>

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

Public Member Functions

 DiscreteFractureModel (Simulator &simulator)
 
void registerOutputModules_ ()
 
std::string primaryVarName (unsigned pvIdx) const
 Given an primary variable index, return a human readable name. More...
 
std::string eqName (unsigned 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 (unsigned globalDofIdx, unsigned pvIdx) const
 
Scalar eqWeight (unsigned globalDofIdx, unsigned eqIdx) const
 
bool phaseIsConsidered (unsigned) const
 Returns true iff a fluid phase is used by the model. More...
 
void globalPhaseStorage (EqVector &storage, unsigned 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 Opm::DiscreteFractureModel< TypeTag >

A fully-implicit multi-phase flow model which assumes immiscibility of the phases and is able to include fractures in the domain.

This model implements multi-phase flow of $M > 0$ immiscible fluids $\alpha$. It also can consider edges of the computational grid as fractures i.e. as a porous medium with different higher permeability than the rest of the domain.

See also
ImmiscibleModel

Constructor & Destructor Documentation

◆ DiscreteFractureModel()

template<class TypeTag >
Opm::DiscreteFractureModel< TypeTag >::DiscreteFractureModel ( Simulator &  simulator)
inline

Member Function Documentation

◆ eqName()

template<class TypeTag >
std::string Opm::ImmiscibleModel< TypeTag >::eqName ( unsigned  eqIdx) const
inlineinherited

Given an equation index, return a human readable name.

Parameters
eqIdxThe index of the conservation equation of interest.

◆ eqWeight()

template<class TypeTag >
Scalar Opm::ImmiscibleModel< TypeTag >::eqWeight ( unsigned  globalDofIdx,
unsigned  eqIdx 
) const
inlineinherited
Parameters
globalVertexIdxThe global index of the vertex
eqIdxThe index of the equation

◆ globalPhaseStorage()

template<class TypeTag >
void Opm::MultiPhaseBaseModel< TypeTag >::globalPhaseStorage ( EqVector &  storage,
unsigned  phaseIdx 
)
inlineinherited

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

References Opm::ThreadedEntityIterator< GridView, codim >::beginParallel(), Opm::ThreadedEntityIterator< GridView, codim >::increment(), Opm::ThreadedEntityIterator< GridView, codim >::isFinished(), and Opm::ThreadManager::threadId().

◆ name()

template<class TypeTag >
static std::string Opm::DiscreteFractureModel< TypeTag >::name ( )
inlinestatic

◆ phaseIsConsidered()

template<class TypeTag >
bool Opm::MultiPhaseBaseModel< TypeTag >::phaseIsConsidered ( unsigned  ) const
inlineinherited

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

Parameters
phaseIdxThe index of the fluid phase in question

◆ primaryVarName()

template<class TypeTag >
std::string Opm::ImmiscibleModel< TypeTag >::primaryVarName ( unsigned  pvIdx) const
inlineinherited

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

Parameters
pvIdxThe index of the primary variable of interest.

◆ primaryVarWeight()

template<class TypeTag >
Scalar Opm::ImmiscibleModel< TypeTag >::primaryVarWeight ( unsigned  globalDofIdx,
unsigned  pvIdx 
) const
inlineinherited
Parameters
globalDofIdxThe global index of the degree of freedom
pvIdxThe index of the primary variable

◆ registerOutputModules_()

template<class TypeTag >
void Opm::DiscreteFractureModel< TypeTag >::registerOutputModules_ ( )
inline

References Opm::ImmiscibleModel< TypeTag >::registerOutputModules_().

◆ registerParameters()

template<class TypeTag >
static void Opm::DiscreteFractureModel< TypeTag >::registerParameters ( )
inlinestatic

Register all run-time parameters for the immiscible model.

References Opm::ImmiscibleModel< TypeTag >::registerParameters(), and Opm::VtkDiscreteFractureModule< TypeTag >::registerParameters().

◆ updateBegin()

template<class TypeTag >
void Opm::ImmiscibleModel< TypeTag >::updateBegin ( )
inlineinherited

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: