version 3.11-dev
Dumux::RichardsVelocityOutput< GridVariables, FluxVariables > Class Template Reference

Velocity output policy for the Richards model.

#include <dumux/porousmediumflow/richards/velocityoutput.hh>

Inheritance diagram for Dumux::RichardsVelocityOutput< GridVariables, FluxVariables >:

Public Types

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

Public Member Functions

int numFluidPhases () const override
 Returns the number of phases. More...
 
bool enableOutput () const override
 Returns whether or not velocity output is enabled. More...
 
std::string phaseName (int phaseIdx) const override
 Returns the phase name of a given phase index. More...
 
void calculateVelocity (VelocityVector &velocity, const Element &element, const FVElementGeometry &fvGeometry, const ElementVolumeVariables &elemVolVars, const ElementFluxVarsCache &elemFluxVarsCache, int phaseIdx) const override
 
virtual void calculateVelocity (VelocityVector &velocity, const Element &element, const FVElementGeometry &fvGeometry, const ElementVariables &elemVars, int phaseIdx) const
 
virtual FieldType fieldType () const
 returns the field type More...
 
virtual FieldType fieldType () const
 

Member Typedef Documentation

◆ VelocityVector

template<class GridVariables , class FluxVariables >
using Dumux::PorousMediumFlowVelocityOutput< GridVariables, FluxVariables >::VelocityVector = typename ParentType::VelocityVector
inherited

Member Enumeration Documentation

◆ FieldType [1/2]

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

◆ FieldType [2/2]

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

Member Function Documentation

◆ calculateVelocity() [1/2]

template<Concept::FVGridVariables GridVariables>
virtual void Dumux::VelocityOutput< GridVariables >::calculateVelocity ( VelocityVector velocity,
const Element &  element,
const FVElementGeometry &  fvGeometry,
const ElementVariables &  elemVars,
int  phaseIdx 
) const
inlinevirtualinherited

◆ calculateVelocity() [2/2]

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

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

Reimplemented from Dumux::VelocityOutput< GridVariables >.

◆ enableOutput()

template<class GridVariables , class FluxVariables >
bool Dumux::PorousMediumFlowVelocityOutput< GridVariables, FluxVariables >::enableOutput ( ) const
inlineoverridevirtualinherited

◆ fieldType() [1/2]

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

◆ fieldType() [2/2]

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

◆ numFluidPhases()

template<class GridVariables , class FluxVariables >
int Dumux::RichardsVelocityOutput< GridVariables, FluxVariables >::numFluidPhases ( ) const
inlineoverridevirtual

◆ phaseName()

template<class GridVariables , class FluxVariables >
std::string Dumux::PorousMediumFlowVelocityOutput< GridVariables, FluxVariables >::phaseName ( int  phaseIdx) const
inlineoverridevirtualinherited

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