version 3.9.0
Loading...
Searching...
No Matches
Dumux::StaggeredFreeFlowVelocityOutput< GridVariables, SolutionVector > Class Template Reference

Velocity output for staggered free-flow models.

#include <dumux/discretization/staggered/freeflow/velocityoutput.hh>

Inheritance diagram for Dumux::StaggeredFreeFlowVelocityOutput< GridVariables, SolutionVector >:

Public Types

using VelocityVector = typename ParentType::VelocityVector
 
enum class  FieldType { element , vertex , automatic }
 A container for possible velocity data types. More...
 

Public Member Functions

 StaggeredFreeFlowVelocityOutput (const GridVariables &gridVariables, const SolutionVector &sol)
 Constructor initializes the static data with the initial solution.
 
bool enableOutput () const override
 Returns whether to enable the velocity output or not.
 
std::string phaseName (int phaseIdx) const override
 returns the phase name of a given phase index
 
int numFluidPhases () const override
 returns the number of phases
 
void calculateVelocity (VelocityVector &velocity, const Element &element, const FVElementGeometry &fvGeometry, const ElementVolumeVariables &elemVolVars, const ElementFluxVarsCache &elemFluxVarsCache, int phaseIdx) const override
 
virtual FieldType fieldType () const
 returns the field type
 
virtual void calculateVelocity (VelocityVector &velocity, const Element &element, const FVElementGeometry &fvGeometry, const ElementVolumeVariables &elemVolVars, const ElementFluxVarsCache &elemFluxVarsCache, int phaseIdx) const
 

Member Typedef Documentation

◆ VelocityVector

template<class GridVariables , class SolutionVector >
using Dumux::StaggeredFreeFlowVelocityOutput< GridVariables, SolutionVector >::VelocityVector = typename ParentType::VelocityVector

Member Enumeration Documentation

◆ FieldType

template<class GridVariables >
enum class Dumux::VelocityOutput::FieldType
stronginherited
Enumerator
element 
vertex 
automatic 

Constructor & Destructor Documentation

◆ StaggeredFreeFlowVelocityOutput()

template<class GridVariables , class SolutionVector >
Dumux::StaggeredFreeFlowVelocityOutput< GridVariables, SolutionVector >::StaggeredFreeFlowVelocityOutput ( const GridVariables & gridVariables,
const SolutionVector & sol )
inline
Parameters
gridVariablesThe gridVariables
solThe solution vector

Member Function Documentation

◆ calculateVelocity() [1/2]

template<class GridVariables , class SolutionVector >
void Dumux::StaggeredFreeFlowVelocityOutput< GridVariables, SolutionVector >::calculateVelocity ( VelocityVector & velocity,
const Element & element,
const FVElementGeometry & fvGeometry,
const ElementVolumeVariables & elemVolVars,
const ElementFluxVarsCache & elemFluxVarsCache,
int phaseIdx ) const
inlineoverride

Calculate the velocities for the scvs in the element We assume the local containers to be bound to the complete stencil

◆ calculateVelocity() [2/2]

template<class GridVariables >
virtual void Dumux::VelocityOutput< GridVariables >::calculateVelocity ( VelocityVector & velocity,
const Element & element,
const FVElementGeometry & fvGeometry,
const ElementVolumeVariables & elemVolVars,
const ElementFluxVarsCache & elemFluxVarsCache,
int phaseIdx ) const
inlinevirtualinherited

Calculate the velocities for the scvs in the element We assume the local containers to be bound to the complete stencil

◆ enableOutput()

template<class GridVariables , class SolutionVector >
bool Dumux::StaggeredFreeFlowVelocityOutput< GridVariables, SolutionVector >::enableOutput ( ) const
inlineoverridevirtual

◆ fieldType()

template<class GridVariables >
virtual FieldType Dumux::VelocityOutput< GridVariables >::fieldType ( ) const
inlinevirtualinherited

◆ numFluidPhases()

template<class GridVariables , class SolutionVector >
int Dumux::StaggeredFreeFlowVelocityOutput< GridVariables, SolutionVector >::numFluidPhases ( ) const
inlineoverridevirtual

◆ phaseName()

template<class GridVariables , class SolutionVector >
std::string Dumux::StaggeredFreeFlowVelocityOutput< GridVariables, SolutionVector >::phaseName ( int phaseIdx) const
inlineoverridevirtual

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