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

Class storing data assigned to a cell-cell interfaces, so-called flux-data. More...

#include <dumux/porousmediumflow/1p/sequential/fluxdata.hh>

Description

template<class TypeTag>
class Dumux::FluxData1P< TypeTag >

Class storing data assigned to a cell-cell interfaces, so-called flux-data.

Stores velocities and potentials at cell-cell interfaces. Further it provides methods which interpret stored phase potentials for upwind decisions.

Template Parameters
TypeTagThe problem TypeTag

Public Member Functions

 FluxData1P ()
 Constructs a FluxData1P object. More...
 
const DimVector & velocity (int indexInInside)
 Returns the velocity vector at a cell-cell interface. More...
 
const DimVector & velocity (int indexInInside) const
 Returns the velocity vector at a cell-cell interface. More...
 
void setVelocity (int indexInInside, DimVector &velocity)
 Sets the velocity vector at a cell-cell interface. More...
 
void resetVelocity ()
 Resets velocities and potentials. More...
 
void setVelocityMarker (int indexInInside)
 Sets the velocity marker at a cell-cell interface. More...
 
bool haveVelocity (int indexInInside)
 Check the velocity marker. More...
 
void resetVelocityMarker ()
 Resets the velocity marker. More...
 
bool isUpwindCell (int indexInInside)
 Checks for upwind direction. More...
 
bool isUpwindCell (int indexInInside) const
 Checks for upwind direction Returns true if the cell is the upwind cell, otherwise false More...
 
Scalar potential (int indexInInside)
 Returns the potential at a cell-cell interface. More...
 
Scalar potential (int indexInInside) const
 Returns the potential at a cell-cell interface. More...
 
void setPotential (int indexInInside, Scalar pot)
 Sets the potential at a cell-cell interface. More...
 

Constructor & Destructor Documentation

◆ FluxData1P()

template<class TypeTag >
Dumux::FluxData1P< TypeTag >::FluxData1P ( )
inline

Constructs a FluxData1P object.

Member Function Documentation

◆ haveVelocity()

template<class TypeTag >
bool Dumux::FluxData1P< TypeTag >::haveVelocity ( int  indexInInside)
inline

Check the velocity marker.

Returns true if a velocity marker was set, otherwise false

Parameters
indexInInsideIndex of the cell-cell interface in this cell

◆ isUpwindCell() [1/2]

template<class TypeTag >
bool Dumux::FluxData1P< TypeTag >::isUpwindCell ( int  indexInInside)
inline

Checks for upwind direction.

Returns true if the cell is the upwind cell, otherwise false

Parameters
indexInInsideIndex of the cell-cell interface in this cell

◆ isUpwindCell() [2/2]

template<class TypeTag >
bool Dumux::FluxData1P< TypeTag >::isUpwindCell ( int  indexInInside) const
inline

Checks for upwind direction Returns true if the cell is the upwind cell, otherwise false

Parameters
indexInInsideIndex of the cell-cell interface in this cell

◆ potential() [1/2]

template<class TypeTag >
Scalar Dumux::FluxData1P< TypeTag >::potential ( int  indexInInside)
inline

Returns the potential at a cell-cell interface.

Parameters
indexInInsideIndex of the cell-cell interface in this cell

◆ potential() [2/2]

template<class TypeTag >
Scalar Dumux::FluxData1P< TypeTag >::potential ( int  indexInInside) const
inline

Returns the potential at a cell-cell interface.

Parameters
indexInInsideIndex of the cell-cell interface in this cell

◆ resetVelocity()

template<class TypeTag >
void Dumux::FluxData1P< TypeTag >::resetVelocity ( )
inline

Resets velocities and potentials.

◆ resetVelocityMarker()

template<class TypeTag >
void Dumux::FluxData1P< TypeTag >::resetVelocityMarker ( )
inline

Resets the velocity marker.

◆ setPotential()

template<class TypeTag >
void Dumux::FluxData1P< TypeTag >::setPotential ( int  indexInInside,
Scalar  pot 
)
inline

Sets the potential at a cell-cell interface.

Parameters
indexInInsideIndex of the cell-cell interface in this cell
potPhase potential which is stored

◆ setVelocity()

template<class TypeTag >
void Dumux::FluxData1P< TypeTag >::setVelocity ( int  indexInInside,
DimVector &  velocity 
)
inline

Sets the velocity vector at a cell-cell interface.

Parameters
indexInInsideIndex of the cell-cell interface in this cell
velocityVelocity vector which is stored

◆ setVelocityMarker()

template<class TypeTag >
void Dumux::FluxData1P< TypeTag >::setVelocityMarker ( int  indexInInside)
inline

Sets the velocity marker at a cell-cell interface.

This marker can be used to check if a velocity has already been stored for this interface

Parameters
indexInInsideIndex of the cell-cell interface in this cell

◆ velocity() [1/2]

template<class TypeTag >
const DimVector & Dumux::FluxData1P< TypeTag >::velocity ( int  indexInInside)
inline

Returns the velocity vector at a cell-cell interface.

Parameters
indexInInsideIndex of the cell-cell interface in this cell

◆ velocity() [2/2]

template<class TypeTag >
const DimVector & Dumux::FluxData1P< TypeTag >::velocity ( int  indexInInside) const
inline

Returns the velocity vector at a cell-cell interface.

Parameters
indexInInsideIndex of the cell-cell interface in this cell

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