Dumux::RichardsVelocityOutput< GridVariables, FluxVariables > Class Template Reference

Velocity output policy for the Richards model. More...

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

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

Description

template<class GridVariables, class FluxVariables>
class Dumux::RichardsVelocityOutput< GridVariables, FluxVariables >

Velocity output policy for the Richards model.

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

Public Member Functions
int	numFluidPhases () const override
	Returns the number of phases.
bool	enableOutput () const override
	Returns whether or not velocity output is enabled.
std::string	phaseName (int phaseIdx) const override
	Returns the phase name of a given phase index.
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 ElementVolumeVariables &elemVolVars, const ElementFluxVarsCache &elemFluxVarsCache, int phaseIdx) const
virtual FieldType	fieldType () const
	returns the field type

Member Typedef Documentation

VelocityVector

template<class GridVariables, class FluxVariables>

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

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

Member Function Documentation

calculateVelocity() [1/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

inlineoverrideinherited

Calculates 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 FluxVariables>

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

inlineoverridevirtualinherited

Returns whether or not velocity output is enabled.

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, class FluxVariables>

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

inlineoverridevirtual

Returns the number of phases.

Reimplemented from Dumux::PorousMediumFlowVelocityOutput< GridVariables, FluxVariables >.

phaseName()

template<class GridVariables, class FluxVariables>

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

inlineoverridevirtualinherited

Returns the phase name of a given phase index.

Reimplemented from Dumux::VelocityOutput< GridVariables >.

---

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

• porousmediumflow/richards/velocityoutput.hh