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

Base class for finite volume velocity reconstruction. More...

#include <dumux/porousmediumflow/sequential/cellcentered/velocity.hh>

Inheritance diagram for Dumux::FVVelocity< TypeTag, Velocity >:
Inheritance graph

Description

template<class TypeTag, class Velocity>
class Dumux::FVVelocity< TypeTag, Velocity >

Base class for finite volume velocity reconstruction.

Provides a basic frame for calculating a global velocity field. The definition of the local velocity calculation as well as the storage or other postprocessing has to be provided by the local velocity implementation. This local implementation has to have the form of VelocityDefault.

Template Parameters
TypeTagThe Type Tag
VelocityThe implementation of the local velocity calculation

Public Member Functions

void initialize ()
 Initialize velocity implementation. More...
 
void calculateVelocity ()
 Function which reconstructs a global velocity field. More...
 
template<class MultiWriter >
void addOutputVtkFields (MultiWriter &writer)
 Adds velocity output to the output file. More...
 
 FVVelocity (Problem &problem)
 Constructs a FVVelocity object. More...
 

Constructor & Destructor Documentation

◆ FVVelocity()

template<class TypeTag , class Velocity >
Dumux::FVVelocity< TypeTag, Velocity >::FVVelocity ( Problem &  problem)
inline

Constructs a FVVelocity object.

Parameters
problemA problem class object

Member Function Documentation

◆ addOutputVtkFields()

template<class TypeTag , class Velocity >
template<class MultiWriter >
void Dumux::FVVelocity< TypeTag, Velocity >::addOutputVtkFields ( MultiWriter &  writer)
inline

Adds velocity output to the output file.

Template Parameters
MultiWriterClass defining the output writer
Parameters
writerThe output writer (usually a VTKMultiWriter object)

◆ calculateVelocity()

template<class TypeTag , class Velocity >
void Dumux::FVVelocity< TypeTag, Velocity >::calculateVelocity

Function which reconstructs a global velocity field.

Iterates through the grid and calls the local calculateVelocity(...) or calculateVelocityOnBoundary(...) functions which have to be provided by the local velocity implementation (see e.g. VelocityDefault )

◆ initialize()

template<class TypeTag , class Velocity >
void Dumux::FVVelocity< TypeTag, Velocity >::initialize ( )
inline

Initialize velocity implementation.


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