version 3.8
Dumux::VelocityOutput< GridVariables > Class Template Reference

Velocity output for implicit (porous media) models.

#include <dumux/io/velocityoutput.hh>

Inheritance diagram for Dumux::VelocityOutput< GridVariables >:

Public Types

enum class  FieldType { element , vertex , automatic }
 A container for possible velocity data types. More...
 
using VelocityVector = std::vector< Dune::FieldVector< Scalar, dimWorld > >
 

Public Member Functions

 VelocityOutput ()=default
 Default constructor. More...
 
virtual ~VelocityOutput ()
 virtual destructor More...
 
virtual bool enableOutput () const
 returns whether or not velocity output is enabled More...
 
virtual std::string phaseName (int phaseIdx) const
 returns the phase name of a given phase index More...
 
virtual FieldType fieldType () const
 returns the field type More...
 
virtual int numFluidPhases () const
 returns the number of phases More...
 
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 >
using Dumux::VelocityOutput< GridVariables >::VelocityVector = std::vector<Dune::FieldVector<Scalar, dimWorld> >

Member Enumeration Documentation

◆ FieldType

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

Constructor & Destructor Documentation

◆ VelocityOutput()

template<class GridVariables >
Dumux::VelocityOutput< GridVariables >::VelocityOutput ( )
default

◆ ~VelocityOutput()

template<class GridVariables >
virtual Dumux::VelocityOutput< GridVariables >::~VelocityOutput ( )
inlinevirtual

Member Function Documentation

◆ calculateVelocity()

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
inlinevirtual

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

Reimplemented in Dumux::PoreNetwork::VelocityOutput< GridVariables, FluxVariables >, and Dumux::PorousMediumFlowVelocityOutput< GridVariables, FluxVariables >.

◆ enableOutput()

◆ fieldType()

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

◆ numFluidPhases()

◆ phaseName()


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