Dumux::TracerTestSpatialParams< GridGeometry, Scalar > Class Template Reference

Definition of the spatial parameters for the tracer problem. More...

#include <test/porousmediumflow/tracer/1ptracer/spatialparams_tracer.hh>

Inheritance diagram for Dumux::TracerTestSpatialParams< GridGeometry, Scalar >:

Description

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

Definition of the spatial parameters for the tracer problem.

Public Member Functions
	TracerTestSpatialParams (std::shared_ptr< const GridGeometry > gridGeometry)
Scalar	porosityAtPos (const GlobalPosition &globalPos) const
	Defines the porosity $\mathrm{[-]}$. More...
template<class ElementSolution >
Scalar	dispersivity (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
	Defines the dispersivity. More...
Scalar	fluidDensity (const Element &element, const SubControlVolume &scv) const
	Fluid density. More...
Scalar	fluidMolarMass (const Element &element, const SubControlVolume &scv) const
	Fluid molar mass. More...
Scalar	fluidMolarMass (const GlobalPosition &globalPos) const
template<class ElementVolumeVariables >
Scalar	volumeFlux (const Element &element, const FVElementGeometry &fvGeometry, const ElementVolumeVariables &elemVolVars, const SubControlVolumeFace &scvf) const
	Velocity field. More...
void	setVolumeFlux (const std::vector< Scalar > &f)
	TracerTestSpatialParams (std::shared_ptr< const GridGeometry > gridGeometry)
Scalar	porosityAtPos (const GlobalPosition &globalPos) const
	Defines the porosity $\mathrm{[-]}$. More...
template<class ElementSolution >
Scalar	dispersivity (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
	Defines the dispersivity. More...
Scalar	fluidDensity (const Element &element, const SubControlVolume &scv) const
	Fluid density. More...
Scalar	fluidMolarMass (const Element &element, const SubControlVolume &scv) const
	Fluid molar mass. More...
Scalar	fluidMolarMass (const GlobalPosition &globalPos) const
GlobalPosition	velocity (const SubControlVolumeFace &scvf) const
	Velocity field. More...
template<class ElementVolumeVariables >
Scalar	volumeFlux (const Element &element, const FVElementGeometry &fvGeometry, const ElementVolumeVariables &elemVolVars, const SubControlVolumeFace &scvf) const
	Velocity field. 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	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 &	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
TracerTestSpatialParams< GridGeometry, Scalar > &	asImp_ ()
const TracerTestSpatialParams< GridGeometry, Scalar > &	asImp_ () const

Constructor & Destructor Documentation

TracerTestSpatialParams() [1/2]

template<class GridGeometry , class Scalar >

Dumux::TracerTestSpatialParams< GridGeometry, Scalar >::TracerTestSpatialParams ( std::shared_ptr< const GridGeometry >  gridGeometry )

inline

TracerTestSpatialParams() [2/2]

template<class GridGeometry , class Scalar >

Dumux::TracerTestSpatialParams< GridGeometry, Scalar >::TracerTestSpatialParams ( std::shared_ptr< const GridGeometry >  gridGeometry )

inline

Member Function Documentation

asImp_() [1/2]

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

inlineprotectedinherited

asImp_() [2/2]

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

inlineprotectedinherited

beaversJosephCoeffAtPos()

Scalar Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, TracerTestSpatialParams< GridGeometry, Scalar > >::beaversJosephCoeffAtPos ( const GlobalPosition &  globalPos ) const

inlineinherited

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

Returns

Beavers-Joseph coefficient $\mathrm{[-]}$

Parameters

globalPos

The global position

dispersivity() [1/2]

template<class GridGeometry , class Scalar >

template<class ElementSolution >

Scalar Dumux::TracerTestSpatialParams< GridGeometry, Scalar >::dispersivity ( const Element &  element, const SubControlVolume &  scv, const ElementSolution &  elemSol  ) const

inline

Defines the dispersivity.

Parameters

element	The finite element
scv	The sub-control volume
elemSol	The solution for all dofs of the element

dispersivity() [2/2]

template<class GridGeometry , class Scalar >

template<class ElementSolution >

Scalar Dumux::TracerTestSpatialParams< GridGeometry, Scalar >::dispersivity ( const Element &  element, const SubControlVolume &  scv, const ElementSolution &  elemSol  ) const

inline

Defines the dispersivity.

Parameters

element	The finite element
scv	The sub-control volume
elemSol	The solution for all dofs of the element

evaluatePermeabilityAtScvfIP()

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

fluidDensity() [1/2]

template<class GridGeometry , class Scalar >

Scalar Dumux::TracerTestSpatialParams< GridGeometry, Scalar >::fluidDensity ( const Element &  element, const SubControlVolume &  scv  ) const

inline

Fluid density.

Fluid properties that are spatial parameters in the tracer model They can possible vary with space but are usually constants

fluidDensity() [2/2]

template<class GridGeometry , class Scalar >

Scalar Dumux::TracerTestSpatialParams< GridGeometry, Scalar >::fluidDensity ( const Element &  element, const SubControlVolume &  scv  ) const

inline

Fluid density.

Fluid properties that are spatial parameters in the tracer model They can possibly vary with space but are usually constants

fluidMolarMass() [1/4]

template<class GridGeometry , class Scalar >

Scalar Dumux::TracerTestSpatialParams< GridGeometry, Scalar >::fluidMolarMass ( const Element &  element, const SubControlVolume &  scv  ) const

inline

Fluid molar mass.

fluidMolarMass() [2/4]

template<class GridGeometry , class Scalar >

Scalar Dumux::TracerTestSpatialParams< GridGeometry, Scalar >::fluidMolarMass ( const Element &  element, const SubControlVolume &  scv  ) const

inline

Fluid molar mass.

fluidMolarMass() [3/4]

template<class GridGeometry , class Scalar >

Scalar Dumux::TracerTestSpatialParams< GridGeometry, Scalar >::fluidMolarMass ( const GlobalPosition &  globalPos ) const

inline

fluidMolarMass() [4/4]

template<class GridGeometry , class Scalar >

Scalar Dumux::TracerTestSpatialParams< GridGeometry, Scalar >::fluidMolarMass ( const GlobalPosition &  globalPos ) const

inline

forchCoeff()

Scalar Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, TracerTestSpatialParams< GridGeometry, Scalar > >::forchCoeff ( const SubControlVolumeFace &  scvf ) const

inlineinherited

Apply the Forchheimer coefficient for inertial forces calculation.

Parameters

scvf	The sub-control volume face where the intrinsic velocity ought to be calculated.

fvGridGeometry()

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

inlineinherited

The finite volume grid geometry.

gravity()

const GlobalPosition & Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, TracerTestSpatialParams< 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

pos	the spatial position at which to evaulate the gravity vector

gridGeometry()

const GridGeometry & Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, TracerTestSpatialParams< GridGeometry, Scalar > >::gridGeometry ( ) const

inlineinherited

The finite volume grid geometry.

harmonicMean() [1/2]

DimWorldMatrix Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, TracerTestSpatialParams< 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

T1	first tensor
T2	second tensor
normal	The unit normal vector of the interface

harmonicMean() [2/2]

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

T1	first scalar parameter
T2	second scalar parameter
normal	The unit normal vector of the interface

inertVolumeFraction() [1/3]

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

element	The current element
scv	The sub-control volume inside the element.
elemSol	The solution at the dofs connected to the element.
compIdx	The 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, TracerTestSpatialParams< GridGeometry, Scalar > >::inertVolumeFraction ( const Element &  element, const SubControlVolume &  scv, const ElementSolution &  elemSol, int  compIdx  ) const

inlineinherited

inertVolumeFraction() [3/3]

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

inlineinherited

permeability()

decltype(auto) Dumux::FVSpatialParamsOneP< GridGeometry, Scalar, TracerTestSpatialParams< 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

element	The current element
scv	The sub-control volume inside the element.
elemSol	The solution at the dofs connected to the element.

Returns

permeability

porosity()

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

element	The current element
scv	The sub-control volume inside the element.
elemSol	The solution at the dofs connected to the element.

Returns

the porosity

porosityAtPos() [1/2]

template<class GridGeometry , class Scalar >

Scalar Dumux::TracerTestSpatialParams< GridGeometry, Scalar >::porosityAtPos ( const GlobalPosition &  globalPos ) const

inline

Defines the porosity $\mathrm{[-]}$.

Parameters

globalPos

The global position

porosityAtPos() [2/2]

template<class GridGeometry , class Scalar >

Scalar Dumux::TracerTestSpatialParams< GridGeometry, Scalar >::porosityAtPos ( const GlobalPosition &  globalPos ) const

inline

Defines the porosity $\mathrm{[-]}$.

Parameters

globalPos

The global position

setVolumeFlux()

template<class GridGeometry , class Scalar >

void Dumux::TracerTestSpatialParams< GridGeometry, Scalar >::setVolumeFlux ( const std::vector< Scalar > &  f )

inline

velocity()

template<class GridGeometry , class Scalar >

GlobalPosition Dumux::TracerTestSpatialParams< GridGeometry, Scalar >::velocity ( const SubControlVolumeFace &  scvf ) const

inline

Velocity field.

volumeFlux() [1/2]

template<class GridGeometry , class Scalar >

template<class ElementVolumeVariables >

Scalar Dumux::TracerTestSpatialParams< GridGeometry, Scalar >::volumeFlux ( const Element &  element, const FVElementGeometry &  fvGeometry, const ElementVolumeVariables &  elemVolVars, const SubControlVolumeFace &  scvf  ) const

inline

Velocity field.

volumeFlux() [2/2]

template<class GridGeometry , class Scalar >

template<class ElementVolumeVariables >

Scalar Dumux::TracerTestSpatialParams< GridGeometry, Scalar >::volumeFlux ( const Element &  element, const FVElementGeometry &  fvGeometry, const ElementVolumeVariables &  elemVolVars, const SubControlVolumeFace &  scvf  ) const

inline

Velocity field.

---

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

• porousmediumflow/tracer/1ptracer/spatialparams_tracer.hh
• porousmediumflow/tracer/constvel/spatialparams.hh