Class used to calculate fluxes over surfaces. This only works for the staggered grid discretization.
#include <dumux/freeflow/navierstokes/staggered/fluxoversurface.hh>
|
| template<class Sol> |
| | FluxOverSurface (const GridVariables &gridVariables, const Sol &sol) |
| | The constructor.
|
| |
| void | addSurface (const std::string &name, SurfaceList &&surfaces) |
| | Add a collection of sub surfaces under a given name.
|
| |
| void | addSurface (const std::string &name, const GlobalPosition &p0, const GlobalPosition &p1) |
| | Add a surface under a given name, specifying the surface's corner points. This is a specialization for 2D, therefore the surface is actually a line.
|
| |
| void | addSurface (const std::string &name, const GlobalPosition &p0, const GlobalPosition &p1, const GlobalPosition &p2, const GlobalPosition &p3) |
| | Add a surface under a given name, specifying the surface's corner points. This is a specialization for 3D.
|
| |
| void | calculateMassOrMoleFluxes () |
| | Calculate the mass or mole fluxes over all surfaces.
|
| |
| void | calculateVolumeFluxes () |
| | Calculate the volume fluxes over all surfaces.
|
| |
| template<class FluxType> |
| void | calculateFluxes (const FluxType &fluxType) |
| | Calculate the fluxes over all surfaces for a given flux type.
|
| |
| auto & | values (const std::string &name) const |
| | Return the fluxes of the individual sub surface of a given name.
|
| |
| auto | netFlux (const std::string &name) const |
| | Return the cumulative net fluxes of a surface of a given name.
|
| |
|
| static SurfaceGeometryType | makeSurface (const std::vector< Dune::FieldVector< Scalar, 2 > > &corners) |
| | Creates a geometrical surface object for (2D).
|
| |
| static SurfaceGeometryType | makeSurface (const std::vector< Dune::FieldVector< Scalar, 3 > > &corners) |
| | Creates a geometrical surface object for (3D).
|
| |
◆ SurfaceList
template<class GridVariables, class SolutionVector, class ModelTraits, class LocalResidual>
| using Dumux::FluxOverSurface< GridVariables, SolutionVector, ModelTraits, LocalResidual >::SurfaceList = std::vector<SurfaceGeometryType> |
◆ FluxOverSurface()
template<class GridVariables, class SolutionVector, class ModelTraits, class LocalResidual>
template<class Sol>
| Dumux::FluxOverSurface< GridVariables, SolutionVector, ModelTraits, LocalResidual >::FluxOverSurface |
( |
const GridVariables & | gridVariables, |
|
|
const Sol & | sol ) |
|
inline |
◆ addSurface() [1/3]
template<class GridVariables, class SolutionVector, class ModelTraits, class LocalResidual>
| void Dumux::FluxOverSurface< GridVariables, SolutionVector, ModelTraits, LocalResidual >::addSurface |
( |
const std::string & | name, |
|
|
const GlobalPosition & | p0, |
|
|
const GlobalPosition & | p1 ) |
|
inline |
- Parameters
-
| name | The name of the surface |
| p0 | The first corner |
| p1 | The second corner |
◆ addSurface() [2/3]
template<class GridVariables, class SolutionVector, class ModelTraits, class LocalResidual>
| void Dumux::FluxOverSurface< GridVariables, SolutionVector, ModelTraits, LocalResidual >::addSurface |
( |
const std::string & | name, |
|
|
const GlobalPosition & | p0, |
|
|
const GlobalPosition & | p1, |
|
|
const GlobalPosition & | p2, |
|
|
const GlobalPosition & | p3 ) |
|
inline |
- Parameters
-
| name | The name of the surface |
| p0 | The first corner |
| p1 | The second corner |
| p2 | The third corner |
| p3 | The fourth corner |
◆ addSurface() [3/3]
template<class GridVariables, class SolutionVector, class ModelTraits, class LocalResidual>
- Parameters
-
| name | The name of the surface |
| surfaces | The list of sub surfaces |
◆ calculateFluxes()
template<class GridVariables, class SolutionVector, class ModelTraits, class LocalResidual>
template<class FluxType>
| void Dumux::FluxOverSurface< GridVariables, SolutionVector, ModelTraits, LocalResidual >::calculateFluxes |
( |
const FluxType & | fluxType | ) |
|
|
inline |
- Parameters
-
| fluxType | The flux type. This can be a lambda of the following form: [](const auto& element, const auto& fvGeometry, const auto& elemVolVars, const auto& elemFaceVars, const auto& scvf, const auto& elemFluxVarsCache) { return ... ; } |
◆ calculateMassOrMoleFluxes()
template<class GridVariables, class SolutionVector, class ModelTraits, class LocalResidual>
| void Dumux::FluxOverSurface< GridVariables, SolutionVector, ModelTraits, LocalResidual >::calculateMassOrMoleFluxes |
( |
| ) |
|
|
inline |
◆ calculateVolumeFluxes()
template<class GridVariables, class SolutionVector, class ModelTraits, class LocalResidual>
| void Dumux::FluxOverSurface< GridVariables, SolutionVector, ModelTraits, LocalResidual >::calculateVolumeFluxes |
( |
| ) |
|
|
inline |
◆ makeSurface() [1/2]
template<class GridVariables, class SolutionVector, class ModelTraits, class LocalResidual>
| static SurfaceGeometryType Dumux::FluxOverSurface< GridVariables, SolutionVector, ModelTraits, LocalResidual >::makeSurface |
( |
const std::vector< Dune::FieldVector< Scalar, 2 > > & | corners | ) |
|
|
inlinestatic |
- Parameters
-
| corners | The vector storing the surface's corners |
◆ makeSurface() [2/2]
template<class GridVariables, class SolutionVector, class ModelTraits, class LocalResidual>
| static SurfaceGeometryType Dumux::FluxOverSurface< GridVariables, SolutionVector, ModelTraits, LocalResidual >::makeSurface |
( |
const std::vector< Dune::FieldVector< Scalar, 3 > > & | corners | ) |
|
|
inlinestatic |
- Parameters
-
| corners | The vector storing the surface's corners |
◆ netFlux()
template<class GridVariables, class SolutionVector, class ModelTraits, class LocalResidual>
| auto Dumux::FluxOverSurface< GridVariables, SolutionVector, ModelTraits, LocalResidual >::netFlux |
( |
const std::string & | name | ) |
const |
|
inline |
- Parameters
-
| name | The name of the surface |
◆ values()
template<class GridVariables, class SolutionVector, class ModelTraits, class LocalResidual>
| auto & Dumux::FluxOverSurface< GridVariables, SolutionVector, ModelTraits, LocalResidual >::values |
( |
const std::string & | name | ) |
const |
|
inline |
- Parameters
-
| name | The name of the surface |
The documentation for this class was generated from the following file: