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

The base class for spatial parameters for pore-network models. More...

#include <dumux/porenetwork/common/spatialparams.hh>

Inheritance diagram for Dumux::PoreNetwork::SpatialParams< GridGeometry, Scalar, Implementation >:

Description

template<class GridGeometry, class Scalar, class Implementation>
class Dumux::PoreNetwork::SpatialParams< GridGeometry, Scalar, Implementation >

The base class for spatial parameters for pore-network models.

Public Types

using PermeabilityType = Scalar
 

Public Member Functions

 SpatialParams (std::shared_ptr< const GridGeometry > gridGeometry)
 
template<class ElementVolumeVariables >
Scalar throatLength (const Element &element, const ElementVolumeVariables &elemVolVars) const
 Length of the throat \([m]\). Can be solution-dependent. More...
 
template<class ElementVolumeVariables >
Scalar throatInscribedRadius (const Element &element, const ElementVolumeVariables &elemVolVars) const
 Inscribed radius of the throat \([m]\). Can be solution-dependent. More...
 
template<class ElementVolumeVariables >
Scalar throatCrossSectionalArea (const Element &element, const ElementVolumeVariables &elemVolVars) const
 Cross-sectional area of the throat \([m]\). Can be solution-dependent. More...
 
template<class ElementSolutionVector >
Scalar poreInscribedRadius (const Element &element, const SubControlVolume &scv, const ElementSolutionVector &elemSol) const
 Inscribed radius of the pore body \([m]\). Can be solution-dependent. More...
 
const GridView & gridView () const
 Returns a reference to the gridview. More...
 
Scalar permeabilityAtPos (const GlobalPosition &globalPos) const
 Required for compatibility reasons with porous medium-flow models. More...
 
Scalar porosityAtPos (const GlobalPosition &globalPos) const
 Required for compatibility reasons with porous medium-flow models. 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...
 
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...
 
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
 
template<class ElementSolution >
Scalar extrusionFactor (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
 Return how much the domain is extruded at a given sub-control volume. More...
 
Scalar extrusionFactorAtPos (const GlobalPosition &globalPos) const
 Return how much the domain is extruded at a given position. More...
 
template<class ElementSolution >
Scalar temperature (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
 Return the temperature in the given sub-control volume. More...
 
Scalar temperatureAtPos (const GlobalPosition &globalPos) const
 Return the temperature in the domain at the given position. More...
 
const GravityVector & gravity (const GlobalPosition &pos) const
 Returns the acceleration due to gravity \(\mathrm{[m/s^2]}\). More...
 
const GridGeometrygridGeometry () 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_ ()
 Returns the implementation of the spatial parameters (static polymorphism) More...
 
const Implementation & asImp_ () const
 Returns the implementation of the spatial parameters (static polymorphism) More...
 

Member Typedef Documentation

◆ PermeabilityType

template<class GridGeometry , class Scalar , class Implementation >
using Dumux::PoreNetwork::SpatialParams< GridGeometry, Scalar, Implementation >::PermeabilityType = Scalar

Constructor & Destructor Documentation

◆ SpatialParams()

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

Member Function Documentation

◆ asImp_() [1/2]

template<class GridGeometry , class Scalar , class Implementation >
Implementation & Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation >::asImp_ ( )
inlineprotectedinherited

Returns the implementation of the spatial parameters (static polymorphism)

◆ asImp_() [2/2]

template<class GridGeometry , class Scalar , class Implementation >
const Implementation & Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation >::asImp_ ( ) const
inlineprotectedinherited

Returns the implementation of the spatial parameters (static polymorphism)

◆ beaversJosephCoeffAtPos()

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

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::FVPorousMediumFlowSpatialParams< GridGeometry, Scalar, Implementation >::evaluatePermeabilityAtScvfIP ( )
inlinestaticconstexprinherited

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.

◆ extrusionFactor()

template<class GridGeometry , class Scalar , class Implementation >
template<class ElementSolution >
Scalar Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation >::extrusionFactor ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol 
) const
inlineinherited

Return how much the domain is extruded at a given sub-control volume.

This means the factor by which a lower-dimensional (1D or 2D) entity needs to be expanded to get a full dimensional cell. The default is 1.0 which means that 1D problems are actually thought as pipes with a cross section of 1 m^2 and 2D problems are assumed to extend 1 m to the back.

◆ extrusionFactorAtPos()

template<class GridGeometry , class Scalar , class Implementation >
Scalar Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation >::extrusionFactorAtPos ( const GlobalPosition &  globalPos) const
inlineinherited

Return how much the domain is extruded at a given position.

◆ forchCoeff()

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

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 GravityVector & Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation >::gravity ( const GlobalPosition &  pos) const
inlineinherited

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 evaluate the gravity vector

◆ gridGeometry()

template<class GridGeometry , class Scalar , class Implementation >
const GridGeometry & Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation >::gridGeometry ( ) const
inlineinherited

The finite volume grid geometry.

◆ gridView()

template<class GridGeometry , class Scalar , class Implementation >
const GridView & Dumux::PoreNetwork::SpatialParams< GridGeometry, Scalar, Implementation >::gridView ( ) const
inline

Returns a reference to the gridview.

◆ 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::FVPorousMediumSpatialParams< GridGeometry, Scalar, Implementation >::inertVolumeFraction ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol,
int  compIdx 
) const
inlineinherited

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::FVPorousMediumSpatialParams< GridGeometry, Scalar, Implementation >::inertVolumeFraction ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol,
int  compIdx 
) const
inlineinherited

◆ 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::FVPorousMediumSpatialParams< GridGeometry, Scalar, Implementation >::inertVolumeFraction ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol,
int  compIdx 
) const
inlineinherited

◆ permeability()

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

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

◆ permeabilityAtPos()

template<class GridGeometry , class Scalar , class Implementation >
Scalar Dumux::PoreNetwork::SpatialParams< GridGeometry, Scalar, Implementation >::permeabilityAtPos ( const GlobalPosition &  globalPos) const
inline

Required for compatibility reasons with porous medium-flow models.

◆ poreInscribedRadius()

template<class GridGeometry , class Scalar , class Implementation >
template<class ElementSolutionVector >
Scalar Dumux::PoreNetwork::SpatialParams< GridGeometry, Scalar, Implementation >::poreInscribedRadius ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolutionVector &  elemSol 
) const
inline

Inscribed radius of the pore body \([m]\). Can be solution-dependent.

Parameters
elementThe finite volume element
scvThe sub-control volume
elemSolThe element solution

◆ porosity()

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

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

◆ porosityAtPos()

template<class GridGeometry , class Scalar , class Implementation >
Scalar Dumux::PoreNetwork::SpatialParams< GridGeometry, Scalar, Implementation >::porosityAtPos ( const GlobalPosition &  globalPos) const
inline

Required for compatibility reasons with porous medium-flow models.

◆ temperature()

template<class GridGeometry , class Scalar , class Implementation >
template<class ElementSolution >
Scalar Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation >::temperature ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol 
) const
inlineinherited

Return the temperature in the given sub-control volume.

◆ temperatureAtPos()

template<class GridGeometry , class Scalar , class Implementation >
Scalar Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation >::temperatureAtPos ( const GlobalPosition &  globalPos) const
inlineinherited

Return the temperature in the domain at the given position.

Parameters
globalPosThe position in global coordinates where the temperature should be specified.

◆ throatCrossSectionalArea()

template<class GridGeometry , class Scalar , class Implementation >
template<class ElementVolumeVariables >
Scalar Dumux::PoreNetwork::SpatialParams< GridGeometry, Scalar, Implementation >::throatCrossSectionalArea ( const Element &  element,
const ElementVolumeVariables &  elemVolVars 
) const
inline

Cross-sectional area of the throat \([m]\). Can be solution-dependent.

Parameters
elementThe finite volume element
elemVolVarsThe element volume variables.

◆ throatInscribedRadius()

template<class GridGeometry , class Scalar , class Implementation >
template<class ElementVolumeVariables >
Scalar Dumux::PoreNetwork::SpatialParams< GridGeometry, Scalar, Implementation >::throatInscribedRadius ( const Element &  element,
const ElementVolumeVariables &  elemVolVars 
) const
inline

Inscribed radius of the throat \([m]\). Can be solution-dependent.

Parameters
elementThe finite volume element
elemVolVarsThe element volume variables.

◆ throatLength()

template<class GridGeometry , class Scalar , class Implementation >
template<class ElementVolumeVariables >
Scalar Dumux::PoreNetwork::SpatialParams< GridGeometry, Scalar, Implementation >::throatLength ( const Element &  element,
const ElementVolumeVariables &  elemVolVars 
) const
inline

Length of the throat \([m]\). Can be solution-dependent.

Parameters
elementThe finite volume element
elemVolVarsThe element volume variables.

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