3.5-git
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::TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, Implementation > Class Template Reference

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

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

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

Description

template<class GridGeometry, class Scalar, class LocalRules, class Implementation>
class Dumux::PoreNetwork::TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, Implementation >

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

Public Types

using PermeabilityType = Scalar
 

Public Member Functions

 TwoPBaseSpatialParams (std::shared_ptr< const GridGeometry > gridGeometry)
 
template<class FS , class ElementVolumeVariables >
int wettingPhase (const Element &, const ElementVolumeVariables &elemVolVars) const
 The index of the wetting phase within a pore throat. More...
 
template<class FS , class ElementSolutionVector >
int wettingPhase (const Element &, const SubControlVolume &scv, const ElementSolutionVector &elemSol) const
 The index of the wetting phase within a pore body. More...
 
template<class ElementVolumeVariables >
Scalar contactAngle (const Element &element, const ElementVolumeVariables &elemVolVars) const
 The contact angle within a pore throat \([rad]\). More...
 
template<class ElementSolutionVector >
Scalar contactAngle (const Element &element, const SubControlVolume &scv, const ElementSolutionVector &elemSol) const
 The contact angle within a pore body \([rad]\). More...
 
template<class ElementVolumeVariables >
const Scalar pcEntry (const Element &element, const ElementVolumeVariables &elemVolVars) const
 Return the element (throat) specific entry capillary pressure \( Pa\). More...
 
template<class ElementVolumeVariables >
const Scalar pcSnapoff (const Element &element, const ElementVolumeVariables &elemVolVars) const
 Return the element (throat) specific snap-off capillary pressure \( Pa\). More...
 
template<class ElementSolution >
Scalar surfaceTension (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
 Returns the surface tension \( [N/m] \). More...
 
template<class ElementSolution >
auto fluidMatrixInteraction (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
 Returns the parameter object for the pore-local pc-Sw law. More...
 
const Dune::ReservedVector< Scalar, 4 > & cornerHalfAngles (const Element &element) const
 
Scalar throatLength (const Element &element, const ElementVolumeVariables &elemVolVars) const
 Length of the throat \([m]\). Can be solution-dependent. More...
 
Scalar throatInscribedRadius (const Element &element, const ElementVolumeVariables &elemVolVars) const
 Inscribed radius of the throat \([m]\). Can be solution-dependent. More...
 
Scalar throatCrossSectionalArea (const Element &element, const ElementVolumeVariables &elemVolVars) const
 Cross-sectional area of the throat \([m]\). Can be solution-dependent. More...
 
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 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...
 
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
 
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...
 
Scalar inertVolumeFraction (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol, int compIdx) const
 
Scalar inertVolumeFraction (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol, int compIdx) const
 

Protected Member Functions

TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, Implementation > & asImp_ ()
 
const TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, Implementation > & asImp_ () const
 

Member Typedef Documentation

◆ PermeabilityType

using Dumux::PoreNetwork::BaseSpatialParams< GridGeometry, Scalar, TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, Implementation > >::PermeabilityType = Scalar
inherited

Constructor & Destructor Documentation

◆ TwoPBaseSpatialParams()

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

Member Function Documentation

◆ asImp_() [1/2]

TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, Implementation > & Dumux::PoreNetwork::BaseSpatialParams< GridGeometry, Scalar, TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, Implementation > >::asImp_ ( )
inlineprotectedinherited

◆ asImp_() [2/2]

const TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, Implementation > & Dumux::PoreNetwork::BaseSpatialParams< GridGeometry, Scalar, TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, Implementation > >::asImp_ ( ) const
inlineprotectedinherited

◆ contactAngle() [1/2]

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

The contact angle within a pore throat \([rad]\).

Note
Overload for solution-dependent values.
Parameters
elementThe element
elemVolVarsThe element volume variables

◆ contactAngle() [2/2]

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

The contact angle within a pore body \([rad]\).

Note
Overload for solution-dependent values.
Parameters
elementThe element
scvThe sub-control volume
elemSolThe element solution

◆ cornerHalfAngles()

template<class GridGeometry , class Scalar , class LocalRules , class Implementation >
const Dune::ReservedVector< Scalar, 4 > & Dumux::PoreNetwork::TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, Implementation >::cornerHalfAngles ( const Element &  element) const
inline

◆ fluidMatrixInteraction()

template<class GridGeometry , class Scalar , class LocalRules , class Implementation >
template<class ElementSolution >
auto Dumux::PoreNetwork::TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, Implementation >::fluidMatrixInteraction ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol 
) const
inline

Returns the parameter object for the pore-local pc-Sw law.

Parameters
elementThe current element
scvThe sub-control volume inside the element.
elemSolThe solution at the dofs connected to the element.
Returns
The material parameters object

◆ gravity()

const GlobalPosition & Dumux::PoreNetwork::BaseSpatialParams< GridGeometry, Scalar, TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, 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 evaulate the gravity vector

◆ gridGeometry()

const GridGeometry & Dumux::PoreNetwork::BaseSpatialParams< GridGeometry, Scalar, TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, Implementation > >::gridGeometry ( ) const
inlineinherited

The finite volume grid geometry.

◆ gridView()

const GridView & Dumux::PoreNetwork::BaseSpatialParams< GridGeometry, Scalar, TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, Implementation > >::gridView ( ) const
inlineinherited

Returns a reference to the gridview.

◆ inertVolumeFraction() [1/3]

Scalar Dumux::PoreNetwork::BaseSpatialParams< GridGeometry, Scalar, TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, 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]

Scalar Dumux::PoreNetwork::BaseSpatialParams< GridGeometry, Scalar, TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, Implementation > >::inertVolumeFraction ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol,
int  compIdx 
) const
inlineinherited

◆ inertVolumeFraction() [3/3]

Scalar Dumux::PoreNetwork::BaseSpatialParams< GridGeometry, Scalar, TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, Implementation > >::inertVolumeFraction ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol,
int  compIdx 
) const
inlineinherited

◆ pcEntry()

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

Return the element (throat) specific entry capillary pressure \( Pa\).

Parameters
elementThe current element
elemVolVarsThe element volume variables

◆ pcSnapoff()

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

Return the element (throat) specific snap-off capillary pressure \( Pa\).

Parameters
elementThe current element
elemVolVarsThe element volume variables

◆ permeability()

Scalar Dumux::PoreNetwork::BaseSpatialParams< GridGeometry, Scalar, TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, Implementation > >::permeability ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolutionVector &  elemSol 
) const
inlineinherited

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

Note
This is only required for compatibility reasons.

◆ poreInscribedRadius()

Scalar Dumux::PoreNetwork::BaseSpatialParams< GridGeometry, Scalar, TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, Implementation > >::poreInscribedRadius ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolutionVector &  elemSol 
) const
inlineinherited

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

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

◆ porosity()

Scalar Dumux::PoreNetwork::BaseSpatialParams< GridGeometry, Scalar, TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, 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()

Scalar Dumux::PoreNetwork::BaseSpatialParams< GridGeometry, Scalar, TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, Implementation > >::porosityAtPos ( const GlobalPosition &  globalPos) const
inlineinherited

◆ surfaceTension()

template<class GridGeometry , class Scalar , class LocalRules , class Implementation >
template<class ElementSolution >
Scalar Dumux::PoreNetwork::TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, Implementation >::surfaceTension ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol 
) const
inline

Returns the surface tension \( [N/m] \).

Parameters
elementThe current element
scvThe sub-control volume inside the element.
elemSolThe solution at the dofs connected to the element.

◆ throatCrossSectionalArea()

Scalar Dumux::PoreNetwork::BaseSpatialParams< GridGeometry, Scalar, TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, Implementation > >::throatCrossSectionalArea ( const Element &  element,
const ElementVolumeVariables &  elemVolVars 
) const
inlineinherited

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

Parameters
elementThe finite volume element
elemVolVarsThe element volume variables.

◆ throatInscribedRadius()

Scalar Dumux::PoreNetwork::BaseSpatialParams< GridGeometry, Scalar, TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, Implementation > >::throatInscribedRadius ( const Element &  element,
const ElementVolumeVariables &  elemVolVars 
) const
inlineinherited

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

Parameters
elementThe finite volume element
elemVolVarsThe element volume variables.

◆ throatLength()

Scalar Dumux::PoreNetwork::BaseSpatialParams< GridGeometry, Scalar, TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, Implementation > >::throatLength ( const Element &  element,
const ElementVolumeVariables &  elemVolVars 
) const
inlineinherited

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

Parameters
elementThe finite volume element
elemVolVarsThe element volume variables.

◆ wettingPhase() [1/2]

template<class GridGeometry , class Scalar , class LocalRules , class Implementation >
template<class FS , class ElementVolumeVariables >
int Dumux::PoreNetwork::TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, Implementation >::wettingPhase ( const Element &  ,
const ElementVolumeVariables &  elemVolVars 
) const
inline

The index of the wetting phase within a pore throat.

◆ wettingPhase() [2/2]

template<class GridGeometry , class Scalar , class LocalRules , class Implementation >
template<class FS , class ElementSolutionVector >
int Dumux::PoreNetwork::TwoPBaseSpatialParams< GridGeometry, Scalar, LocalRules, Implementation >::wettingPhase ( const Element &  ,
const SubControlVolume &  scv,
const ElementSolutionVector &  elemSol 
) const
inline

The index of the wetting phase within a pore body.


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