Class including the variables and data of discretized data of the constitutive relations for one grid cell. More...

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

Inheritance diagram for Dumux::CellData2P< TypeTag, true >:

Description

template<class TypeTag>
class Dumux::CellData2P< TypeTag, true >

Class including the variables and data of discretized data of the constitutive relations for one grid cell.

The variables of two-phase flow, which are phase pressures and saturations are stored in this class. Further, resulting cell values for constitutive relationships like mobilities, fractional flow functions and capillary pressure are stored. Additionally, data assigned to cell-cell interfaces, so-called flux-data are stored.

Template Parameters

TypeTag	The problem TypeTag
bool	Used for specialization: In case of compressible flow bool = true

Public Member Functions
	CellData2P ()
	Constructs a CellData2P object.
FluxData &	fluxData ()
	Returns the flux data of the cell.
const FluxData &	fluxData () const
	Returns the flux data of the cell.
FluidState &	fluidState ()
	Returns the FluidState object for this cell.
const FluidState &	fluidState () const
	Returns the FluidState object for this cell.
Scalar	pressure (int phaseIdx)
	Returns the cell phase pressure.
Scalar	pressure (int phaseIdx) const
	Returns the cell phase pressure.
void	setPressure (int phaseIdx, Scalar press)
	Sets the cell phase pressure.
Scalar	potential (int phaseIdx)
	Returns the cell phase potential.
Scalar	potential (int phaseIdx) const
	Returns the cell phase potential.
void	setPotential (int phaseIdx, Scalar pot)
	Sets the cell phase potential.
Scalar	saturation (int phaseIdx)
	Returns the cell phase saturation.
Scalar	saturation (int phaseIdx) const
	Returns the cell phase saturation.
void	setSaturation (int phaseIdx, Scalar sat)
	Sets the cell phase saturation.
Scalar	mobility (int phaseIdx)
	Returns the cell phase mobility.
Scalar	mobility (int phaseIdx) const
	Returns the cell phase mobility.
void	setMobility (int phaseIdx, Scalar mobility)
	Sets the cell phase mobility.
Scalar	fracFlowFunc (int phaseIdx)
	Returns the cell phase fractional flow function.
Scalar	fracFlowFunc (int phaseIdx) const
	Returns the cell phase fractional flow function.
void	setFracFlowFunc (int phaseIdx, Scalar fracFlowFunc)
	Sets the cell phase fractional flow function.
Scalar	capillaryPressure ()
	Returns the cell capillary pressure.
Scalar	capillaryPressure () const
	Returns the cell capillary pressure.
Scalar	density (int phaseIdx)
	Returns the cell phase density.
Scalar	density (int phaseIdx) const
	Returns the cell phase density.
void	setDensity (int phaseIdx, Scalar density)
	Sets the cell phase density.
Scalar	viscosity (int phaseIdx)
	Returns the cell phase viscosity.
Scalar	viscosity (int phaseIdx) const
	Returns the cell phase viscosity.
void	setViscosity (int phaseIdx, Scalar viscosity)
	Sets the cell phase viscosity.
void	setUpdate (Scalar update)
	Store transport update.
Scalar	volumeCorrection ()
	Returns the cell volume correction needed in the pressure equation.
Scalar	volumeCorrection () const
	Returns the cell volume correction needed in the pressure equation.

Constructor & Destructor Documentation

◆ CellData2P()

template<class TypeTag>

Dumux::CellData2P< TypeTag, true >::CellData2P ( )

inline

Constructs a CellData2P object.

Member Function Documentation

◆ capillaryPressure() [1/2]

template<class TypeTag>

Scalar Dumux::CellData2P< TypeTag, true >::capillaryPressure ( )

inline

Returns the cell capillary pressure.

◆ capillaryPressure() [2/2]

template<class TypeTag>

Scalar Dumux::CellData2P< TypeTag, true >::capillaryPressure ( ) const

inline

Returns the cell capillary pressure.

◆ density() [1/2]

template<class TypeTag>

Scalar Dumux::CellData2P< TypeTag, true >::density ( int phaseIdx )

inline

Returns the cell phase density.

Parameters

phaseIdx Index of a fluid phase

◆ density() [2/2]

template<class TypeTag>

Scalar Dumux::CellData2P< TypeTag, true >::density ( int phaseIdx ) const

inline

Returns the cell phase density.

Parameters

phaseIdx Index of a fluid phase

◆ fluidState() [1/2]

template<class TypeTag>

FluidState & Dumux::CellData2P< TypeTag, true >::fluidState ( )

inline

Returns the FluidState object for this cell.

◆ fluidState() [2/2]

template<class TypeTag>

const FluidState & Dumux::CellData2P< TypeTag, true >::fluidState ( ) const

inline

Returns the FluidState object for this cell.

◆ fluxData() [1/2]

template<class TypeTag>

FluxData & Dumux::CellData2P< TypeTag, true >::fluxData ( )

inline

Returns the flux data of the cell.

◆ fluxData() [2/2]

template<class TypeTag>

const FluxData & Dumux::CellData2P< TypeTag, true >::fluxData ( ) const

inline

Returns the flux data of the cell.

◆ fracFlowFunc() [1/2]

template<class TypeTag>

Scalar Dumux::CellData2P< TypeTag, true >::fracFlowFunc ( int phaseIdx )

inline

Returns the cell phase fractional flow function.

Parameters

phaseIdx Index of a fluid phase

◆ fracFlowFunc() [2/2]

template<class TypeTag>

Scalar Dumux::CellData2P< TypeTag, true >::fracFlowFunc ( int phaseIdx ) const

inline

Returns the cell phase fractional flow function.

Parameters

phaseIdx Index of a fluid phase

◆ mobility() [1/2]

template<class TypeTag>

Scalar Dumux::CellData2P< TypeTag, true >::mobility ( int phaseIdx )

inline

Returns the cell phase mobility.

Parameters

phaseIdx Index of a fluid phase

◆ mobility() [2/2]

template<class TypeTag>

Scalar Dumux::CellData2P< TypeTag, true >::mobility ( int phaseIdx ) const

inline

Returns the cell phase mobility.

Parameters

phaseIdx Index of a fluid phase

◆ potential() [1/2]

template<class TypeTag>

Scalar Dumux::CellData2P< TypeTag, true >::potential ( int phaseIdx )

inline

Returns the cell phase potential.

Parameters

phaseIdx Index of a fluid phase

◆ potential() [2/2]

template<class TypeTag>

Scalar Dumux::CellData2P< TypeTag, true >::potential ( int phaseIdx ) const

inline

Returns the cell phase potential.

Parameters

phaseIdx Index of a fluid phase

◆ pressure() [1/2]

template<class TypeTag>

Scalar Dumux::CellData2P< TypeTag, true >::pressure ( int phaseIdx )

inline

Returns the cell phase pressure.

Parameters

phaseIdx Index of a fluid phase

◆ pressure() [2/2]

template<class TypeTag>

Scalar Dumux::CellData2P< TypeTag, true >::pressure ( int phaseIdx ) const

inline

Returns the cell phase pressure.

Parameters

phaseIdx Index of a fluid phase

◆ saturation() [1/2]

template<class TypeTag>

Scalar Dumux::CellData2P< TypeTag, true >::saturation ( int phaseIdx )

inline

Returns the cell phase saturation.

Parameters

phaseIdx Index of a fluid phase

◆ saturation() [2/2]

template<class TypeTag>

Scalar Dumux::CellData2P< TypeTag, true >::saturation ( int phaseIdx ) const

inline

Returns the cell phase saturation.

Parameters

phaseIdx Index of a fluid phase

◆ setDensity()

template<class TypeTag>

void Dumux::CellData2P< TypeTag, true >::setDensity	(	int	phaseIdx,
		Scalar	density )

inline

Sets the cell phase density.

Parameters

phaseIdx	Index of a fluid phase
density	Phase density which is stored

◆ setFracFlowFunc()

template<class TypeTag>

void Dumux::CellData2P< TypeTag, true >::setFracFlowFunc	(	int	phaseIdx,
		Scalar	fracFlowFunc )

inline

Sets the cell phase fractional flow function.

Parameters

phaseIdx	Index of a fluid phase
fracFlowFunc	Phase fractional flow function which is stored

◆ setMobility()

template<class TypeTag>

void Dumux::CellData2P< TypeTag, true >::setMobility	(	int	phaseIdx,
		Scalar	mobility )

inline

Sets the cell phase mobility.

Parameters

phaseIdx	Index of a fluid phase
mobility	Phase mobility with which is stored

◆ setPotential()

template<class TypeTag>

void Dumux::CellData2P< TypeTag, true >::setPotential	(	int	phaseIdx,
		Scalar	pot )

inline

Sets the cell phase potential.

Parameters

phaseIdx	Index of a fluid phase
pot	Phase potential which is stored

◆ setPressure()

template<class TypeTag>

void Dumux::CellData2P< TypeTag, true >::setPressure	(	int	phaseIdx,
		Scalar	press )

inline

Sets the cell phase pressure.

Parameters

phaseIdx	Index of a fluid phase
press	Phase pressure which is stored

◆ setSaturation()

template<class TypeTag>

void Dumux::CellData2P< TypeTag, true >::setSaturation	(	int	phaseIdx,
		Scalar	sat )

inline

Sets the cell phase saturation.

Parameters

phaseIdx	Index of a fluid phase
sat	Phase saturation which is stored

◆ setUpdate()

template<class TypeTag>

void Dumux::CellData2P< TypeTag, true >::setUpdate ( Scalar update )

inline

Store transport update.

Parameters

update Transport update of the cell

◆ setViscosity()

template<class TypeTag>

void Dumux::CellData2P< TypeTag, true >::setViscosity	(	int	phaseIdx,
		Scalar	viscosity )

inline

Sets the cell phase viscosity.

Parameters

phaseIdx	Index of a fluid phase
viscosity	Phase viscosity which is stored

◆ viscosity() [1/2]

template<class TypeTag>

Scalar Dumux::CellData2P< TypeTag, true >::viscosity ( int phaseIdx )

inline

Returns the cell phase viscosity.

Parameters

phaseIdx Index of a fluid phase

◆ viscosity() [2/2]

template<class TypeTag>

Scalar Dumux::CellData2P< TypeTag, true >::viscosity ( int phaseIdx ) const

inline

Returns the cell phase viscosity.

Parameters

phaseIdx Index of a fluid phase

◆ volumeCorrection() [1/2]

template<class TypeTag>

Scalar Dumux::CellData2P< TypeTag, true >::volumeCorrection ( )

inline

Returns the cell volume correction needed in the pressure equation.

◆ volumeCorrection() [2/2]

template<class TypeTag>

Scalar Dumux::CellData2P< TypeTag, true >::volumeCorrection ( ) const

inline

Returns the cell volume correction needed in the pressure equation.

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

2p/sequential/celldata.hh

Description

Public Member Functions

Constructor & Destructor Documentation

◆ CellData2P()

Member Function Documentation

◆ capillaryPressure() [1/2]

◆ capillaryPressure() [2/2]

◆ density() [1/2]

◆ density() [2/2]

◆ fluidState() [1/2]

◆ fluidState() [2/2]

◆ fluxData() [1/2]

◆ fluxData() [2/2]

◆ fracFlowFunc() [1/2]

◆ fracFlowFunc() [2/2]

◆ mobility() [1/2]

◆ mobility() [2/2]

◆ potential() [1/2]

◆ potential() [2/2]

◆ pressure() [1/2]

◆ pressure() [2/2]

◆ saturation() [1/2]

◆ saturation() [2/2]

◆ setDensity()

◆ setFracFlowFunc()

◆ setMobility()

◆ setPotential()

◆ setPressure()

◆ setSaturation()

◆ setUpdate()

◆ setViscosity()

◆ viscosity() [1/2]

◆ viscosity() [2/2]

◆ volumeCorrection() [1/2]

◆ volumeCorrection() [2/2]