DuMuX: Dumux::VelocityOutput< GridVariables > Class Template Reference

3.5-git

DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media

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

#include <dumux/io/velocityoutput.hh>

Inheritance diagram for Dumux::VelocityOutput< GridVariables >:

Description

template<class GridVariables>
class Dumux::VelocityOutput< GridVariables >

Velocity output for implicit (porous media) models.

Public Types
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 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> >

Constructor & Destructor Documentation

◆ VelocityOutput()

template<class GridVariables >

Dumux::VelocityOutput< GridVariables >::VelocityOutput ( )

default

Default constructor.

◆ ~VelocityOutput()

template<class GridVariables >

virtual Dumux::VelocityOutput< GridVariables >::~VelocityOutput ( )

inlinevirtual

virtual destructor

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

template<class GridVariables >

virtual bool Dumux::VelocityOutput< GridVariables >::enableOutput ( ) const

inlinevirtual

returns whether or not velocity output is enabled

Reimplemented in Dumux::StaggeredFreeFlowVelocityOutput< GridVariables, SolutionVector >, Dumux::NavierStokesVelocityOutput< GridVariables >, Dumux::GeomechanicsVelocityOutput< GridVariables >, Dumux::PoreNetwork::VelocityOutput< GridVariables, FluxVariables >, and Dumux::PorousMediumFlowVelocityOutput< GridVariables, FluxVariables >.

◆ numFluidPhases()

template<class GridVariables >

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

inlinevirtual

returns the number of phases

Reimplemented in Dumux::StaggeredFreeFlowVelocityOutput< GridVariables, SolutionVector >, Dumux::NavierStokesVelocityOutput< GridVariables >, Dumux::PoreNetwork::VelocityOutput< GridVariables, FluxVariables >, Dumux::RichardsVelocityOutput< GridVariables, FluxVariables >, and Dumux::PorousMediumFlowVelocityOutput< GridVariables, FluxVariables >.

◆ phaseName()

template<class GridVariables >

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

inlinevirtual

returns the phase name of a given phase index

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

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

io/velocityoutput.hh