3.1-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Member Functions | List of all members
Dumux::EvalCflFlux< TypeTag > Class Template Reference

Base class for implementations of different kinds of fluxes to evaluate a CFL-Condition. More...

#include <dumux/porousmediumflow/2p/sequential/transport/cellcentered/evalcflflux.hh>

Inheritance diagram for Dumux::EvalCflFlux< TypeTag >:
Inheritance graph

Description

template<class TypeTag>
class Dumux::EvalCflFlux< TypeTag >

Base class for implementations of different kinds of fluxes to evaluate a CFL-Condition.

Base class for implementations of different kinds of fluxes to evaluate a CFL-Condition of the form

\[ \frac{F_i \Delta t}{V_{p_i}} < 1 \]

where \( V_{p_i} \) is the pore volume of cell i and

\[ F_i = \sum f_{ij} \]

with \( f_{ij} \) being the CFL-flux over edge \( ij \).

Template Parameters
TypeTagThe problem TypeTag

Public Member Functions

void initialize ()
 For initialization. More...
 
void addFlux (Scalar &lambdaW, Scalar &lambdaNw, Scalar &viscosityW, Scalar &viscosityNw, Scalar flux, const Intersection &intersection, int phaseIdx)
 adds a flux to the cfl-criterion evaluation More...
 
void addFlux (Scalar &lambdaW, Scalar &lambdaNw, Scalar &viscosityW, Scalar &viscosityNw, Scalar flux, const Element &element, int phaseIdx)
 adds a flux to the cfl-criterion evaluation More...
 
Scalar getCflFluxFunction (const Element &element)
 Returns the CFL flux-function. More...
 
Scalar getDt (const Element &element)
 Returns the CFL time-step. More...
 
void reset ()
 reset function More...
 
 EvalCflFlux ()
 Constructs a EvalCflFlux instance. More...
 

Constructor & Destructor Documentation

◆ EvalCflFlux()

template<class TypeTag >
Dumux::EvalCflFlux< TypeTag >::EvalCflFlux ( )
inline

Constructs a EvalCflFlux instance.

Member Function Documentation

◆ addFlux() [1/2]

template<class TypeTag >
void Dumux::EvalCflFlux< TypeTag >::addFlux ( Scalar &  lambdaW,
Scalar &  lambdaNw,
Scalar &  viscosityW,
Scalar &  viscosityNw,
Scalar  flux,
const Element &  element,
int  phaseIdx 
)
inline

adds a flux to the cfl-criterion evaluation

Parameters
lambdaWwetting phase mobility
lambdaNwnon-wetting phase mobility
viscosityWwetting phase viscosity
viscosityNwnon-wetting phase viscosity
fluxflux to add
elementelement corresponding to the flux
phaseIdxindex of the phase (wetting, non-wetting)

◆ addFlux() [2/2]

template<class TypeTag >
void Dumux::EvalCflFlux< TypeTag >::addFlux ( Scalar &  lambdaW,
Scalar &  lambdaNw,
Scalar &  viscosityW,
Scalar &  viscosityNw,
Scalar  flux,
const Intersection &  intersection,
int  phaseIdx 
)
inline

adds a flux to the cfl-criterion evaluation

Parameters
lambdaWwetting phase mobility
lambdaNwnon-wetting phase mobility
viscosityWwetting phase viscosity
viscosityNwnon-wetting phase viscosity
fluxflux to add
intersectionintersection corresponding to the flux
phaseIdxindex of the phase (wetting, non-wetting)

◆ getCflFluxFunction()

template<class TypeTag >
Scalar Dumux::EvalCflFlux< TypeTag >::getCflFluxFunction ( const Element &  element)
inline

Returns the CFL flux-function.

Parameters
elementelement on which the CFL-criterion is evaluated
Returns
fluxFunction for the calculation of the CFL time-step ( \( 1/F_i \))

◆ getDt()

template<class TypeTag >
Scalar Dumux::EvalCflFlux< TypeTag >::getDt ( const Element &  element)
inline

Returns the CFL time-step.

Parameters
elementelement on which the CFL-criterion is evaluated
Returns
CFL time-step

◆ initialize()

template<class TypeTag >
void Dumux::EvalCflFlux< TypeTag >::initialize ( )
inline

For initialization.

◆ reset()

template<class TypeTag >
void Dumux::EvalCflFlux< TypeTag >::reset ( )
inline

reset function


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