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

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

Description

template<class TypeTag>
class Dumux::FluxData2P< 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

TypeTag The problem TypeTag

Public Member Functions
	FluxData2P ()
	Constructs a FluxData2P object. More...

const DimVector &	velocity (int phaseIdx, int indexInInside)
	Returns the phase velocity vector at a cell-cell interface. More...

const DimVector &	velocity (int phaseIdx, int indexInInside) const
	Returns the phase velocity vector at a cell-cell interface. More...

void	setVelocity (int phaseIdx, int indexInInside, const DimVector &velocity)
	Sets the phase velocity vector at a cell-cell interface. More...

void	addVelocity (int phaseIdx, int indexInInside, const DimVector &velocity)
	Adds a phase velocity vector to the one previously stored. More...

void	resetVelocity ()
	Resets velocities and potentials. More...

DimVector	velocityTotal (int indexInInside)
	Returns the total velocity vector at a cell-cell interface. More...

DimVector	velocityTotal (int indexInInside) const
	Returns the total velocity vector at a cell-cell interface. More...

void	setVelocityMarker (int indexInInside)
	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. More...

bool	haveVelocity (int indexInInside)
	Check the velocity marker Returns `true` if a velocity marker was set, otherwise `false` More...

void	resetVelocityMarker ()
	Resets the velocity marker. More...

bool	isUpwindCell (int phaseIdx, int indexInInside)
	Checks for upwind direction Returns `true` if the cell is the upwind cell, otherwise `false` More...

bool	isUpwindCell (int phaseIdx, int indexInInside) const
	Checks for upwind direction Returns `true` if the cell is the upwind cell, otherwise `false` More...

Scalar	upwindPotential (int phaseIdx, int indexInInside)
	Returns the phase upwind potential at a cell-cell interface. More...

Scalar	upwindPotential (int phaseIdx, int indexInInside) const
	Returns the phase upwind potential at a cell-cell interface. More...

void	setUpwindPotential (int phaseIdx, int indexInInside, Scalar pot)
	Sets the phase upwind potential at a cell-cell interface. More...

void	addUpwindPotential (int phaseIdx, int indexInInside, Scalar pot)
	Adds a phase upwind potential to the one previously stored. More...

Constructor & Destructor Documentation

◆ FluxData2P()

template<class TypeTag >

Dumux::FluxData2P< TypeTag >::FluxData2P ( )

inline

Constructs a FluxData2P object.

Member Function Documentation

◆ addUpwindPotential()

template<class TypeTag >

void Dumux::FluxData2P< TypeTag >::addUpwindPotential	(	int	phaseIdx,
		int	indexInInside,
		Scalar	pot
	)

inline

Adds a phase upwind potential to the one previously stored.

Parameters

phaseIdx	Index of a fluid phase
indexInInside	Index of the cell-cell interface in this cell
pot	Phase upwind potential which is added

◆ addVelocity()

template<class TypeTag >

void Dumux::FluxData2P< TypeTag >::addVelocity	(	int	phaseIdx,
		int	indexInInside,
		const DimVector &	velocity
	)

inline

Adds a phase velocity vector to the one previously stored.

Parameters

phaseIdx	Index of a fluid phase
indexInInside	Index of the cell-cell interface in this cell
velocity	Phase velocity vector which is added

◆ haveVelocity()

template<class TypeTag >

bool Dumux::FluxData2P< TypeTag >::haveVelocity ( int indexInInside )

inline

Check the velocity marker Returns true if a velocity marker was set, otherwise false

Parameters

indexInInside Index of the cell-cell interface in this cell

◆ isUpwindCell() [1/2]

template<class TypeTag >

bool Dumux::FluxData2P< TypeTag >::isUpwindCell	(	int	phaseIdx,
		int	indexInInside
	)

inline

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

Parameters

phaseIdx	Index of a fluid phase
indexInInside	Index of the cell-cell interface in this cell

◆ isUpwindCell() [2/2]

template<class TypeTag >

bool Dumux::FluxData2P< TypeTag >::isUpwindCell	(	int	phaseIdx,
		int	indexInInside
	)		const

inline

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

Parameters

phaseIdx	Index of a fluid phase
indexInInside	Index of the cell-cell interface in this cell

◆ resetVelocity()

template<class TypeTag >

void Dumux::FluxData2P< TypeTag >::resetVelocity ( )

inline

Resets velocities and potentials.

◆ resetVelocityMarker()

template<class TypeTag >

void Dumux::FluxData2P< TypeTag >::resetVelocityMarker ( )

inline

Resets the velocity marker.

◆ setUpwindPotential()

template<class TypeTag >

void Dumux::FluxData2P< TypeTag >::setUpwindPotential	(	int	phaseIdx,
		int	indexInInside,
		Scalar	pot
	)

inline

Sets the phase upwind potential at a cell-cell interface.

Parameters

phaseIdx	Index of a fluid phase
indexInInside	Index of the cell-cell interface in this cell
pot	Phase upwind potential which is stored

◆ setVelocity()

template<class TypeTag >

void Dumux::FluxData2P< TypeTag >::setVelocity	(	int	phaseIdx,
		int	indexInInside,
		const DimVector &	velocity
	)

inline

Sets the phase velocity vector at a cell-cell interface.

Parameters

phaseIdx	Index of a fluid phase
indexInInside	Index of the cell-cell interface in this cell
velocity	Phase velocity vector which is stored

◆ setVelocityMarker()

template<class TypeTag >

void Dumux::FluxData2P< 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

indexInInside Index of the cell-cell interface in this cell

◆ upwindPotential() [1/2]

template<class TypeTag >

Scalar Dumux::FluxData2P< TypeTag >::upwindPotential	(	int	phaseIdx,
		int	indexInInside
	)

inline

Returns the phase upwind potential at a cell-cell interface.

Parameters

phaseIdx	Index of a fluid phase
indexInInside	Index of the cell-cell interface in this cell

◆ upwindPotential() [2/2]

template<class TypeTag >

Scalar Dumux::FluxData2P< TypeTag >::upwindPotential	(	int	phaseIdx,
		int	indexInInside
	)		const

inline

Returns the phase upwind potential at a cell-cell interface.

Parameters

phaseIdx	Index of a fluid phase
indexInInside	Index of the cell-cell interface in this cell

◆ velocity() [1/2]

template<class TypeTag >

const DimVector & Dumux::FluxData2P< TypeTag >::velocity	(	int	phaseIdx,
		int	indexInInside
	)

inline

Returns the phase velocity vector at a cell-cell interface.

Parameters

phaseIdx	Index of a fluid phase
indexInInside	Index of the cell-cell interface in this cell

◆ velocity() [2/2]

template<class TypeTag >

const DimVector & Dumux::FluxData2P< TypeTag >::velocity	(	int	phaseIdx,
		int	indexInInside
	)		const

inline

Returns the phase velocity vector at a cell-cell interface.

Parameters

phaseIdx	Index of a fluid phase
indexInInside	Index of the cell-cell interface in this cell

◆ velocityTotal() [1/2]

template<class TypeTag >

DimVector Dumux::FluxData2P< TypeTag >::velocityTotal ( int indexInInside )

inline

Returns the total velocity vector at a cell-cell interface.

Parameters

indexInInside Index of the cell-cell interface in this cell

◆ velocityTotal() [2/2]

template<class TypeTag >

DimVector Dumux::FluxData2P< TypeTag >::velocityTotal ( int indexInInside ) const

inline

Returns the total velocity vector at a cell-cell interface.

Parameters

indexInInside Index of the cell-cell interface in this cell

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

Description

Public Member Functions

Constructor & Destructor Documentation

◆ FluxData2P()

Member Function Documentation

◆ addUpwindPotential()

◆ addVelocity()

◆ haveVelocity()

◆ isUpwindCell() [1/2]

◆ isUpwindCell() [2/2]

◆ resetVelocity()

◆ resetVelocityMarker()

◆ setUpwindPotential()

◆ setVelocity()

◆ setVelocityMarker()

◆ upwindPotential() [1/2]

◆ upwindPotential() [2/2]

◆ velocity() [1/2]

◆ velocity() [2/2]

◆ velocityTotal() [1/2]

◆ velocityTotal() [2/2]