version 3.8
Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation > Class Template Reference

The base class for spatial parameters used with finite-volume schemes.

#include <dumux/common/fvspatialparams.hh>

Inheritance diagram for Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation >:

Public Member Functions

 FVSpatialParams (std::shared_ptr< const GridGeometry > gridGeometry)
 
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 GridGeometry & gridGeometry () const
 The finite volume grid geometry. 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...
 

Constructor & Destructor Documentation

◆ FVSpatialParams()

template<class GridGeometry , class Scalar , class Implementation >
Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation >::FVSpatialParams ( 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_ ( )
inlineprotected

◆ asImp_() [2/2]

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

◆ 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
inline

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
inline

◆ gravity()

template<class GridGeometry , class Scalar , class Implementation >
const GravityVector & Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation >::gravity ( const GlobalPosition &  pos) const
inline

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
inline

◆ 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
inline

◆ temperatureAtPos()

template<class GridGeometry , class Scalar , class Implementation >
Scalar Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation >::temperatureAtPos ( const GlobalPosition &  globalPos) const
inline
Parameters
globalPosThe position in global coordinates where the temperature should be specified.

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