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

Velocity output policy for implicit (porous media) models. More...

#include <dumux/porousmediumflow/velocityoutput.hh>

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

Description

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

Velocity output policy for implicit (porous media) models.

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

Public Member Functions
	PorousMediumFlowVelocityOutput (const GridVariables &gridVariables)
	Constructor initializes the static data with the initial solution. 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...
int	numFluidPhases () const override
	Returns the number of phases. More...
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 More...

Member Typedef Documentation

VelocityVector

template<class GridVariables , class FluxVariables >

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

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

PorousMediumFlowVelocityOutput()

template<class GridVariables , class FluxVariables >

Dumux::PorousMediumFlowVelocityOutput< GridVariables, FluxVariables >::PorousMediumFlowVelocityOutput ( const GridVariables &  gridVariables )

inline

Constructor initializes the static data with the initial solution.

Parameters

gridVariables

The grid variables

Member Function Documentation

calculateVelocity()

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

inlineoverridevirtual

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

inlineoverridevirtual

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::PorousMediumFlowVelocityOutput< GridVariables, FluxVariables >::numFluidPhases ( ) const

inlineoverridevirtual

Returns the number of phases.

Reimplemented from Dumux::VelocityOutput< GridVariables >.

phaseName()

template<class GridVariables , class FluxVariables >

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

inlineoverridevirtual

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/velocityoutput.hh