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

Velocity output for staggered free-flow models. More...

#include <dumux/discretization/staggered/freeflow/velocityoutput.hh>

Inheritance diagram for Dumux::StaggeredFreeFlowVelocityOutput< GridVariables, SolutionVector >:

Description

template<class GridVariables, class SolutionVector>
class Dumux::StaggeredFreeFlowVelocityOutput< GridVariables, SolutionVector >

Velocity output for staggered free-flow models.

Public Types

using VelocityVector = typename ParentType::VelocityVector
 

Public Member Functions

 StaggeredFreeFlowVelocityOutput (const GridVariables &gridVariables, const SolutionVector &sol)
 Constructor initializes the static data with the initial solution. More...
 
bool enableOutput () const override
 Returns whether to enable the velocity output or not. 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 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 , class SolutionVector >
using Dumux::StaggeredFreeFlowVelocityOutput< GridVariables, SolutionVector >::VelocityVector = typename ParentType::VelocityVector

Constructor & Destructor Documentation

◆ StaggeredFreeFlowVelocityOutput()

template<class GridVariables , class SolutionVector >
Dumux::StaggeredFreeFlowVelocityOutput< GridVariables, SolutionVector >::StaggeredFreeFlowVelocityOutput ( const GridVariables &  gridVariables,
const SolutionVector &  sol 
)
inline

Constructor initializes the static data with the initial solution.

Parameters
gridVariablesThe gridVariables
solThe solution vector

Member Function Documentation

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

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

◆ calculateVelocity() [2/2]

template<class GridVariables , class SolutionVector >
void Dumux::StaggeredFreeFlowVelocityOutput< GridVariables, SolutionVector >::calculateVelocity ( VelocityVector velocity,
const Element &  element,
const FVElementGeometry &  fvGeometry,
const ElementVolumeVariables &  elemVolVars,
const ElementFluxVarsCache &  elemFluxVarsCache,
int  phaseIdx 
) const
inlineoverride

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 SolutionVector >
bool Dumux::StaggeredFreeFlowVelocityOutput< GridVariables, SolutionVector >::enableOutput ( ) const
inlineoverridevirtual

Returns whether to enable the velocity output or not.

Reimplemented from Dumux::VelocityOutput< GridVariables >.

◆ numFluidPhases()

template<class GridVariables , class SolutionVector >
int Dumux::StaggeredFreeFlowVelocityOutput< GridVariables, SolutionVector >::numFluidPhases ( ) const
inlineoverridevirtual

returns the number of phases

Reimplemented from Dumux::VelocityOutput< GridVariables >.

◆ phaseName()

template<class GridVariables , class SolutionVector >
std::string Dumux::StaggeredFreeFlowVelocityOutput< GridVariables, SolutionVector >::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: