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

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

#include <dumux/material/spatialparams/porenetwork/porenetworkbase.hh>

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

Description

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

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

Public Types

using PermeabilityType = Scalar
 

Public Member Functions

 BaseSpatialParams (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...
 
template<class ElementSolutionVector >
Scalar permeability (const Element &element, const SubControlVolume &scv, const ElementSolutionVector &elemSol) const
 
const GlobalPosition & 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...
 
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...
 
Scalar porosityAtPos (const GlobalPosition &globalPos) const
 
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
 

Protected Member Functions

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

Member Typedef Documentation

◆ PermeabilityType

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

Constructor & Destructor Documentation

◆ BaseSpatialParams()

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

Member Function Documentation

◆ asImp_() [1/2]

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

◆ asImp_() [2/2]

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

◆ gravity()

template<class GridGeometry , class Scalar , class Implementation >
const GlobalPosition & Dumux::PoreNetwork::BaseSpatialParams< 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::PoreNetwork::BaseSpatialParams< GridGeometry, Scalar, Implementation >::gridGeometry ( ) const
inline

The finite volume grid geometry.

◆ gridView()

template<class GridGeometry , class Scalar , class Implementation >
const GridView & Dumux::PoreNetwork::BaseSpatialParams< 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::PoreNetwork::BaseSpatialParams< 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::PoreNetwork::BaseSpatialParams< 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::PoreNetwork::BaseSpatialParams< 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 ElementSolutionVector >
Scalar Dumux::PoreNetwork::BaseSpatialParams< GridGeometry, Scalar, Implementation >::permeability ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolutionVector &  elemSol 
) const
inline

Intrinsic permeability tensor K \([m^2]\).

Note
This is only required for compatibility reasons.

◆ poreInscribedRadius()

template<class GridGeometry , class Scalar , class Implementation >
template<class ElementSolutionVector >
Scalar Dumux::PoreNetwork::BaseSpatialParams< 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::PoreNetwork::BaseSpatialParams< 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

◆ porosityAtPos()

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

◆ throatCrossSectionalArea()

template<class GridGeometry , class Scalar , class Implementation >
template<class ElementVolumeVariables >
Scalar Dumux::PoreNetwork::BaseSpatialParams< 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::BaseSpatialParams< 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::BaseSpatialParams< 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: