3.6-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Types | Public Member Functions | List of all members
Dumux::GeomechanicsVelocityOutput< GridVariables > Class Template Reference

Velocity output for geomechanical models. This class could be used to compute the temporal derivative of the displacement. Currently this is not implemented and we simply define this here in order to be able to reuse the VtkOutputModule which expects a VelocityOutput class. More...

#include <dumux/geomechanics/velocityoutput.hh>

Inheritance diagram for Dumux::GeomechanicsVelocityOutput< GridVariables >:

Description

template<class GridVariables>
class Dumux::GeomechanicsVelocityOutput< GridVariables >

Velocity output for geomechanical models. This class could be used to compute the temporal derivative of the displacement. Currently this is not implemented and we simply define this here in order to be able to reuse the VtkOutputModule which expects a VelocityOutput class.

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

template<typename... Args>
 GeomechanicsVelocityOutput (Args &&... args)
 The constructor. More...
 
bool enableOutput () const override
 Output is currently disabled (not implemented) 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> >
inherited

Member Enumeration Documentation

◆ FieldType

template<class GridVariables >
enum class Dumux::VelocityOutput::FieldType
stronginherited

A container for possible velocity data types.

Enumerator
element 
vertex 
automatic 

Constructor & Destructor Documentation

◆ GeomechanicsVelocityOutput()

template<class GridVariables >
template<typename... Args>
Dumux::GeomechanicsVelocityOutput< GridVariables >::GeomechanicsVelocityOutput ( Args &&...  args)
inline

The constructor.

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
inlinevirtualinherited

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()

template<class GridVariables >
bool Dumux::GeomechanicsVelocityOutput< GridVariables >::enableOutput ( ) const
inlineoverridevirtual

Output is currently disabled (not implemented)

Reimplemented from Dumux::VelocityOutput< GridVariables >.

◆ fieldType()

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

returns the field type

Reimplemented in Dumux::NavierStokesVelocityOutput< GridVariables >.

◆ numFluidPhases()

template<class GridVariables >
virtual int Dumux::VelocityOutput< GridVariables >::numFluidPhases ( ) const
inlinevirtualinherited

◆ phaseName()

template<class GridVariables >
virtual std::string Dumux::VelocityOutput< GridVariables >::phaseName ( int  phaseIdx) const
inlinevirtualinherited

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