Dumux::FreeFlowSpatialParams< GridGeometry, Scalar, Implementation > Class Template Reference

Definition of the spatial parameters for the freeflow problems. More...

#include <dumux/freeflow/spatialparams.hh>

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

Description

template<class GridGeometry, class Scalar, class Implementation>
class Dumux::FreeFlowSpatialParams< GridGeometry, Scalar, Implementation >

Definition of the spatial parameters for the freeflow problems.

Public Member Functions
	FreeFlowSpatialParams (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.
Scalar	extrusionFactorAtPos (const GlobalPosition &globalPos) const
	Return how much the domain is extruded at a given position.
template<class ElementSolution>
Scalar	temperature (const Element &element, const SubControlVolume &scv, const ElementSolution &elemSol) const
	Return the temperature in the given sub-control volume.
Scalar	temperatureAtPos (const GlobalPosition &globalPos) const
	Return the temperature in the domain at the given position.
const GravityVector &	gravity (const GlobalPosition &pos) const
	Returns the acceleration due to gravity \(\mathrm{[m/s^2]}\).
const GridGeometry &	gridGeometry () const
	The finite volume grid geometry.

Protected Member Functions
Implementation &	asImp_ ()
	Returns the implementation of the spatial parameters (static polymorphism).
const Implementation &	asImp_ () const
	Returns the implementation of the spatial parameters (static polymorphism).

Constructor & Destructor Documentation

FreeFlowSpatialParams()

template<class GridGeometry, class Scalar, class Implementation>

Dumux::FreeFlowSpatialParams< GridGeometry, Scalar, Implementation >::FreeFlowSpatialParams ( 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_ ( )

inlineprotectedinherited

Returns the implementation of the spatial parameters (static polymorphism).

asImp_() [2/2]

template<class GridGeometry, class Scalar, class Implementation>

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

inlineprotectedinherited

Returns the implementation of the spatial parameters (static polymorphism).

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

inlineinherited

Return how much the domain is extruded at a given sub-control volume.

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

inlineinherited

Return how much the domain is extruded at a given position.

gravity()

template<class GridGeometry, class Scalar, class Implementation>

const GravityVector & Dumux::FVSpatialParams< GridGeometry, Scalar, 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

pos	the 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

inlineinherited

The finite volume grid geometry.

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

inlineinherited

Return the temperature in the given sub-control volume.

temperatureAtPos()

template<class GridGeometry, class Scalar, class Implementation>

Scalar Dumux::FVSpatialParams< GridGeometry, Scalar, Implementation >::temperatureAtPos ( const GlobalPosition & globalPos ) const

inlineinherited

Return the temperature in the domain at the given position.

Parameters

globalPos

The position in global coordinates where the temperature should be specified.

---

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

• freeflow/spatialparams.hh