3.1-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::ConservationSpatialParams< GridGeometry, Scalar > Class Template Reference

The spatial parameters class for the test problem using the 1p cc model. More...

#include <test/multidomain/boundary/stokesdarcy/1p_2p/spatialparams.hh>

Inheritance diagram for Dumux::ConservationSpatialParams< GridGeometry, Scalar >:
Inheritance graph

Description

template<class GridGeometry, class Scalar>
class Dumux::ConservationSpatialParams< GridGeometry, Scalar >

The spatial parameters class for the test problem using the 1p cc model.

Public Types

using MaterialLaw = EffToAbsLaw< EffectiveLaw >
 
using MaterialLawParams = typename MaterialLaw::Params
 
using PermeabilityType = Scalar
 

Public Member Functions

 ConservationSpatialParams (std::shared_ptr< const GridGeometry > gridGeometry)
 
PermeabilityType permeabilityAtPos (const GlobalPosition &globalPos) const
 Function for defining the (intrinsic) permeability \([m^2]\). More...
 
Scalar porosityAtPos (const GlobalPosition &globalPos) const
 Defines the porosity in [-]. More...
 
Scalar beaversJosephCoeffAtPos (const GlobalPosition &globalPos) const
 Defines the Beavers-Joseph coefficient in [-]. More...
 
template<class ElementSolutionVector >
const MaterialLawParamsmaterialLawParams (const Element &element, const SubControlVolume &scv, const ElementSolutionVector &elemSol) const
 Returns the parameter object for the Brooks-Corey material law. More...
 
template<class FluidSystem >
int wettingPhaseAtPos (const GlobalPosition &globalPos) const
 Function for defining which phase is to be considered as the wetting phase. More...
 
decltype(auto) materialLawParams (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
 Function for defining the parameters needed by constitutive relationships (kr-sw, pc-sw, etc.). More...
 
int wettingPhase (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
 Function for defining which phase is to be considered as the wetting phase. More...
 
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...
 
decltype(auto) permeability (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
 Function for defining the (intrinsic) permeability \([m^2]\). 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 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
 
Scalar forchCoeff (const SubControlVolumeFace &scvf) const
 Apply the Forchheimer coefficient for inertial forces calculation. More...
 
const GridGeometry & fvGridGeometry () const
 The finite volume grid geometry. 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

ConservationSpatialParams< GridGeometry, Scalar > & asImp_ ()
 
const ConservationSpatialParams< GridGeometry, Scalar > & asImp_ () const
 

Member Typedef Documentation

◆ MaterialLaw

template<class GridGeometry , class Scalar >
using Dumux::ConservationSpatialParams< GridGeometry, Scalar >::MaterialLaw = EffToAbsLaw<EffectiveLaw>

◆ MaterialLawParams

template<class GridGeometry , class Scalar >
using Dumux::ConservationSpatialParams< GridGeometry, Scalar >::MaterialLawParams = typename MaterialLaw::Params

◆ PermeabilityType

template<class GridGeometry , class Scalar >
using Dumux::ConservationSpatialParams< GridGeometry, Scalar >::PermeabilityType = Scalar

Constructor & Destructor Documentation

◆ ConservationSpatialParams()

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

Member Function Documentation

◆ asImp_() [1/2]

ConservationSpatialParams< GridGeometry, Scalar > & Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, ConservationSpatialParams< GridGeometry, Scalar > >::asImp_ ( )
inlineprotectedinherited

◆ asImp_() [2/2]

const ConservationSpatialParams< GridGeometry, Scalar > & Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, ConservationSpatialParams< GridGeometry, Scalar > >::asImp_ ( ) const
inlineprotectedinherited

◆ beaversJosephCoeffAtPos()

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

Defines the Beavers-Joseph coefficient in [-].

Parameters
globalPosThe global position

◆ evaluatePermeabilityAtScvfIP()

static constexpr bool Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, ConservationSpatialParams< GridGeometry, Scalar > >::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.

◆ forchCoeff()

Scalar Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, ConservationSpatialParams< GridGeometry, Scalar > >::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.

◆ fvGridGeometry()

const GridGeometry & Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, ConservationSpatialParams< GridGeometry, Scalar > >::fvGridGeometry ( ) const
inlineinherited

The finite volume grid geometry.

◆ gravity()

const GlobalPosition & Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, ConservationSpatialParams< GridGeometry, Scalar > >::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::FVSpatialParamsOneP< GridGeometry, Scalar, ConservationSpatialParams< GridGeometry, Scalar > >::gridGeometry ( ) const
inlineinherited

The finite volume grid geometry.

◆ harmonicMean() [1/2]

DimWorldMatrix Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, ConservationSpatialParams< GridGeometry, Scalar > >::harmonicMean ( const DimWorldMatrix &  T1,
const DimWorldMatrix &  T2,
const GlobalPosition &  normal 
) const
inlineinherited

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]

Scalar Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, ConservationSpatialParams< GridGeometry, Scalar > >::harmonicMean ( const Scalar  T1,
const Scalar  T2,
const GlobalPosition &  normal 
) const
inlineinherited

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]

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

◆ inertVolumeFraction() [3/3]

Scalar Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, ConservationSpatialParams< GridGeometry, Scalar > >::inertVolumeFraction ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol,
int  compIdx 
) const
inlineinherited

◆ materialLawParams() [1/2]

decltype(auto) Dumux::FVSpatialParams< GridGeometry, Scalar, ConservationSpatialParams< GridGeometry, Scalar > >::materialLawParams ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol 
) const
inlineinherited

Function for defining the parameters needed by constitutive relationships (kr-sw, pc-sw, etc.).

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

◆ materialLawParams() [2/2]

template<class GridGeometry , class Scalar >
template<class ElementSolutionVector >
const MaterialLawParams & Dumux::ConservationSpatialParams< GridGeometry, Scalar >::materialLawParams ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolutionVector &  elemSol 
) const
inline

Returns the parameter object for the Brooks-Corey material law.

In this test, we use element-wise distributed material parameters.

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

◆ permeability()

decltype(auto) Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, ConservationSpatialParams< GridGeometry, Scalar > >::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 >
PermeabilityType Dumux::ConservationSpatialParams< GridGeometry, Scalar >::permeabilityAtPos ( const GlobalPosition &  globalPos) const
inline

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

Parameters
globalPosThe global position
Returns
the intrinsic permeability

◆ porosity()

Scalar Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, ConservationSpatialParams< GridGeometry, Scalar > >::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 >
Scalar Dumux::ConservationSpatialParams< GridGeometry, Scalar >::porosityAtPos ( const GlobalPosition &  globalPos) const
inline

Defines the porosity in [-].

Parameters
globalPosThe global position

◆ wettingPhase()

int Dumux::FVSpatialParams< GridGeometry, Scalar, ConservationSpatialParams< GridGeometry, Scalar > >::wettingPhase ( const Element &  element,
const SubControlVolume &  scv,
const ElementSolution &  elemSol 
) const
inlineinherited

Function for defining which phase is to be considered as the wetting phase.

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

◆ wettingPhaseAtPos()

template<class GridGeometry , class Scalar >
template<class FluidSystem >
int Dumux::ConservationSpatialParams< GridGeometry, Scalar >::wettingPhaseAtPos ( const GlobalPosition &  globalPos) const
inline

Function for defining which phase is to be considered as the wetting phase.

Parameters
globalPosThe global position
Returns
The wetting phase index

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