3.4
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, Implementation > Class Template Reference

The base class for spatial parameters of one-phase problems using a fully implicit discretization method. More...

#include <dumux/material/spatialparams/fv1p.hh>

Inheritance diagram for Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, Implementation >:

Description

template<class GridGeometry, class Scalar, class Implementation>
class Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, Implementation >

The base class for spatial parameters of one-phase problems using a fully implicit discretization method.

Public Member Functions

 FVSpatialParamsOneP (std::shared_ptr< const GridGeometry > gridGeometry)
 
const GlobalPosition & gravity (const GlobalPosition &pos) const
 Returns the acceleration due to gravity \(\mathrm{[m/s^2]}\). More...
 
Scalar harmonicMean (const Scalar T1, const Scalar T2, const GlobalPosition &normal) const
 Harmonic average of a discontinuous scalar field at discontinuity interface (for compatibility reasons with the function below) More...
 
DimWorldMatrix harmonicMean (const DimWorldMatrix &T1, const DimWorldMatrix &T2, const GlobalPosition &normal) const
 Harmonic average of a discontinuous tensorial field at discontinuity interface. More...
 
template<class ElementSolution >
decltype(auto) permeability (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
 Function for defining the (intrinsic) permeability \([m^2]\). More...
 
template<class ElementSolution >
Scalar porosity (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
 Function for defining the porosity. That is possibly solution dependent. More...
 
template<class SolidSystem , class ElementSolution , typename std::enable_if_t< SolidSystem::isInert() &&SolidSystem::numInertComponents==1 &&!decltype(isValid(Detail::hasInertVolumeFractionAtPos< GlobalPosition, SolidSystem >())(std::declval< Implementation >()))::value, int > = 0>
Scalar inertVolumeFraction (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol, int compIdx) const
 Function for defining the solid volume fraction. That is possibly solution dependent. More...
 
template<class SolidSystem , class ElementSolution , typename std::enable_if_t< SolidSystem::numInertComponents==0, int > = 0>
Scalar inertVolumeFraction (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol, int compIdx) const
 
template<class SolidSystem , class ElementSolution , typename std::enable_if_t<(SolidSystem::numInertComponents > 1)||((SolidSystem::numInertComponents > 0) &&(!SolidSystem::isInert()||decltype(isValid(Detail::hasInertVolumeFractionAtPos< GlobalPosition, SolidSystem >())(std::declval< Implementation >()))::value)), int > = 0>
Scalar inertVolumeFraction (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol, int compIdx) const
 
Scalar beaversJosephCoeffAtPos (const GlobalPosition &globalPos) const
 Function for defining the Beavers-Joseph coefficient for multidomain problems \(\mathrm{[-]}\). More...
 
Scalar forchCoeff (const SubControlVolumeFace &scvf) const
 Apply the Forchheimer coefficient for inertial forces calculation. More...
 
const GridGeometry & gridGeometry () const
 The finite volume grid geometry. More...
 

Static Public Member Functions

static constexpr bool evaluatePermeabilityAtScvfIP ()
 If the permeability should be evaluated directly at the scvf integration point (for convergence tests with analytical and continuous perm functions) or is evaluated at the scvs (for permeability fields with discontinuities) -> default. More...
 

Protected Member Functions

Implementation & asImp_ ()
 
const Implementation & asImp_ () const
 

Constructor & Destructor Documentation

◆ FVSpatialParamsOneP()

template<class GridGeometry , class Scalar , class Implementation >
Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, Implementation >::FVSpatialParamsOneP ( std::shared_ptr< const GridGeometry >  gridGeometry)
inline

Member Function Documentation

◆ asImp_() [1/2]

template<class GridGeometry , class Scalar , class Implementation >
Implementation & Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, Implementation >::asImp_ ( )
inlineprotected

◆ asImp_() [2/2]

template<class GridGeometry , class Scalar , class Implementation >
const Implementation & Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, Implementation >::asImp_ ( ) const
inlineprotected

◆ beaversJosephCoeffAtPos()

template<class GridGeometry , class Scalar , class Implementation >
Scalar Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, Implementation >::beaversJosephCoeffAtPos ( const GlobalPosition &  globalPos) const
inline

Function for defining the Beavers-Joseph coefficient for multidomain problems \(\mathrm{[-]}\).

Returns
Beavers-Joseph coefficient \(\mathrm{[-]}\)
Parameters
globalPosThe global position

◆ evaluatePermeabilityAtScvfIP()

template<class GridGeometry , class Scalar , class Implementation >
static constexpr bool Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, Implementation >::evaluatePermeabilityAtScvfIP ( )
inlinestaticconstexpr

If the permeability should be evaluated directly at the scvf integration point (for convergence tests with analytical and continuous perm functions) or is evaluated at the scvs (for permeability fields with discontinuities) -> default.

◆ forchCoeff()

template<class GridGeometry , class Scalar , class Implementation >
Scalar Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, Implementation >::forchCoeff ( const SubControlVolumeFace &  scvf) const
inline

Apply the Forchheimer coefficient for inertial forces calculation.

Parameters
scvfThe sub-control volume face where the intrinsic velocity ought to be calculated.

◆ gravity()

template<class GridGeometry , class Scalar , class Implementation >
const GlobalPosition & Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, Implementation >::gravity ( const GlobalPosition &  pos) const
inline

Returns the acceleration due to gravity \(\mathrm{[m/s^2]}\).

The default behaviour is a constant gravity vector; if the Problem.EnableGravity parameter is true, \(\boldsymbol{g} = ( 0,\dots,\ -9.81)^T \), else \(\boldsymbol{g} = ( 0,\dots, 0)^T \).

Parameters
posthe spatial position at which to evaulate the gravity vector

◆ gridGeometry()

template<class GridGeometry , class Scalar , class Implementation >
const GridGeometry & Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, Implementation >::gridGeometry ( ) const
inline

The finite volume grid geometry.

◆ harmonicMean() [1/2]

template<class GridGeometry , class Scalar , class Implementation >
DimWorldMatrix Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, Implementation >::harmonicMean ( const DimWorldMatrix &  T1,
const DimWorldMatrix &  T2,
const GlobalPosition &  normal 
) const
inline

Harmonic average of a discontinuous tensorial field at discontinuity interface.

Note
We do a harmonic average of the part normal to the interface (alpha*I) and an arithmetic average of the tangential part (T - alpha*I).
Returns
the averaged tensor
Parameters
T1first tensor
T2second tensor
normalThe unit normal vector of the interface

◆ harmonicMean() [2/2]

template<class GridGeometry , class Scalar , class Implementation >
Scalar Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, Implementation >::harmonicMean ( const Scalar  T1,
const Scalar  T2,
const GlobalPosition &  normal 
) const
inline

Harmonic average of a discontinuous scalar field at discontinuity interface (for compatibility reasons with the function below)

Returns
the averaged scalar
Parameters
T1first scalar parameter
T2second scalar parameter
normalThe unit normal vector of the interface

◆ inertVolumeFraction() [1/3]

template<class GridGeometry , class Scalar , class Implementation >
template<class SolidSystem , class ElementSolution , typename std::enable_if_t< SolidSystem::isInert() &&SolidSystem::numInertComponents==1 &&!decltype(isValid(Detail::hasInertVolumeFractionAtPos< GlobalPosition, SolidSystem >())(std::declval< Implementation >()))::value, int > = 0>
Scalar Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, Implementation >::inertVolumeFraction ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol,
int  compIdx 
) const
inline

Function for defining the solid volume fraction. That is possibly solution dependent.

Parameters
elementThe current element
scvThe sub-control volume inside the element.
elemSolThe solution at the dofs connected to the element.
compIdxThe solid component index
Returns
the volume fraction of the inert solid component with index compIdx
Note
this overload is enable if there is only one inert solid component and the user didn't choose to implement a inertVolumeFractionAtPos overload. It then forwards to the simpler porosity interface. With more than one solid components or active solid components (i.e. dissolution) please overload the more general inertVolumeFraction/inertVolumeFractionAtPos interface.

◆ inertVolumeFraction() [2/3]

template<class GridGeometry , class Scalar , class Implementation >
template<class SolidSystem , class ElementSolution , typename std::enable_if_t< SolidSystem::numInertComponents==0, int > = 0>
Scalar Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, Implementation >::inertVolumeFraction ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol,
int  compIdx 
) const
inline

◆ inertVolumeFraction() [3/3]

template<class GridGeometry , class Scalar , class Implementation >
template<class SolidSystem , class ElementSolution , typename std::enable_if_t<(SolidSystem::numInertComponents > 1)||((SolidSystem::numInertComponents > 0) &&(!SolidSystem::isInert()||decltype(isValid(Detail::hasInertVolumeFractionAtPos< GlobalPosition, SolidSystem >())(std::declval< Implementation >()))::value)), int > = 0>
Scalar Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, Implementation >::inertVolumeFraction ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol,
int  compIdx 
) const
inline

◆ permeability()

template<class GridGeometry , class Scalar , class Implementation >
template<class ElementSolution >
decltype(auto) Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, Implementation >::permeability ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol 
) const
inline

Function for defining the (intrinsic) permeability \([m^2]\).

Note
It is possibly solution dependent.
Parameters
elementThe current element
scvThe sub-control volume inside the element.
elemSolThe solution at the dofs connected to the element.
Returns
permeability

◆ porosity()

template<class GridGeometry , class Scalar , class Implementation >
template<class ElementSolution >
Scalar Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, Implementation >::porosity ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol 
) const
inline

Function for defining the porosity. That is possibly solution dependent.

Note
this can only be used for solids with one inert component (see inertVolumeFraction for the more general interface)
Parameters
elementThe current element
scvThe sub-control volume inside the element.
elemSolThe solution at the dofs connected to the element.
Returns
the porosity

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