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

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>

Description

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

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
TypeTagThe problem TypeTag
boolUsed for specialization: in case of incompressible flow bool = false

Public Member Functions

 CellData2P ()
 Constructs a CellData2P object. More...
 
FluxDatafluxData ()
 Returns the flux data of the cell. More...
 
const FluxDatafluxData () const
 Returns the flux data of the cell. More...
 
Scalar pressure (int phaseIdx)
 Returns the cell phase pressure. More...
 
Scalar pressure (int phaseIdx) const
 Returns the cell phase pressure. More...
 
void setPressure (int phaseIdx, Scalar press)
 Sets the cell phase pressure. More...
 
Scalar globalPressure ()
 Returns the global pressure of the cell. More...
 
Scalar globalPressure () const
 Returns the global pressure of the cell. More...
 
void setGlobalPressure (Scalar press)
 Sets the cell global pressure. More...
 
Scalar potential (int phaseIdx)
 Returns the cell phase potential. More...
 
Scalar potential (int phaseIdx) const
 Returns the cell phase potential. More...
 
void setPotential (int phaseIdx, Scalar pot)
 Sets the cell phase potential. More...
 
Scalar saturation (int phaseIdx)
 Returns the cell phase saturation. More...
 
Scalar saturation (int phaseIdx) const
 Returns the cell phase saturation. More...
 
void setSaturation (int phaseIdx, Scalar sat)
 Sets the cell phase saturation. More...
 
Scalar mobility (int phaseIdx)
 Returns the cell phase mobility. More...
 
Scalar mobility (int phaseIdx) const
 Returns the cell phase mobility. More...
 
void setMobility (int phaseIdx, Scalar mobility)
 Sets the cell phase mobility. More...
 
Scalar fracFlowFunc (int phaseIdx)
 Returns the cell phase fractional flow function. More...
 
Scalar fracFlowFunc (int phaseIdx) const
 Returns the cell phase fractional flow function. More...
 
void setFracFlowFunc (int phaseIdx, Scalar fracFlowFunc)
 Sets the cell phase fractional flow function. More...
 
Scalar capillaryPressure ()
 Returns the cell capillary pressure. More...
 
Scalar capillaryPressure () const
 Returns the cell capillary pressure. More...
 
void setCapillaryPressure (Scalar pc)
 Sets the cell capillary pressure. More...
 
void setUpdate (Scalar update)
 Store transport update. More...
 
Scalar volumeCorrection ()
 Returns the cell volume correction needed in the pressure equation. More...
 
Scalar volumeCorrection () const
 Returns the cell volume correction needed in the pressure equation. More...
 

Constructor & Destructor Documentation

◆ CellData2P()

template<class TypeTag >
Dumux::CellData2P< TypeTag, false >::CellData2P ( )
inline

Constructs a CellData2P object.

Member Function Documentation

◆ capillaryPressure() [1/2]

template<class TypeTag >
Scalar Dumux::CellData2P< TypeTag, false >::capillaryPressure ( )
inline

Returns the cell capillary pressure.

◆ capillaryPressure() [2/2]

template<class TypeTag >
Scalar Dumux::CellData2P< TypeTag, false >::capillaryPressure ( ) const
inline

Returns the cell capillary pressure.

◆ fluxData() [1/2]

template<class TypeTag >
FluxData & Dumux::CellData2P< TypeTag, false >::fluxData ( )
inline

Returns the flux data of the cell.

◆ fluxData() [2/2]

template<class TypeTag >
const FluxData & Dumux::CellData2P< TypeTag, false >::fluxData ( ) const
inline

Returns the flux data of the cell.

◆ fracFlowFunc() [1/2]

template<class TypeTag >
Scalar Dumux::CellData2P< TypeTag, false >::fracFlowFunc ( int  phaseIdx)
inline

Returns the cell phase fractional flow function.

Parameters
phaseIdxIndex of a fluid phase

◆ fracFlowFunc() [2/2]

template<class TypeTag >
Scalar Dumux::CellData2P< TypeTag, false >::fracFlowFunc ( int  phaseIdx) const
inline

Returns the cell phase fractional flow function.

Parameters
phaseIdxIndex of a fluid phase

◆ globalPressure() [1/2]

template<class TypeTag >
Scalar Dumux::CellData2P< TypeTag, false >::globalPressure ( )
inline

Returns the global pressure of the cell.

◆ globalPressure() [2/2]

template<class TypeTag >
Scalar Dumux::CellData2P< TypeTag, false >::globalPressure ( ) const
inline

Returns the global pressure of the cell.

◆ mobility() [1/2]

template<class TypeTag >
Scalar Dumux::CellData2P< TypeTag, false >::mobility ( int  phaseIdx)
inline

Returns the cell phase mobility.

Parameters
phaseIdxIndex of a fluid phase

◆ mobility() [2/2]

template<class TypeTag >
Scalar Dumux::CellData2P< TypeTag, false >::mobility ( int  phaseIdx) const
inline

Returns the cell phase mobility.

Parameters
phaseIdxIndex of a fluid phase

◆ potential() [1/2]

template<class TypeTag >
Scalar Dumux::CellData2P< TypeTag, false >::potential ( int  phaseIdx)
inline

Returns the cell phase potential.

Parameters
phaseIdxIndex of a fluid phase

◆ potential() [2/2]

template<class TypeTag >
Scalar Dumux::CellData2P< TypeTag, false >::potential ( int  phaseIdx) const
inline

Returns the cell phase potential.

Parameters
phaseIdxIndex of a fluid phase

◆ pressure() [1/2]

template<class TypeTag >
Scalar Dumux::CellData2P< TypeTag, false >::pressure ( int  phaseIdx)
inline

Returns the cell phase pressure.

Parameters
phaseIdxIndex of a fluid phase

◆ pressure() [2/2]

template<class TypeTag >
Scalar Dumux::CellData2P< TypeTag, false >::pressure ( int  phaseIdx) const
inline

Returns the cell phase pressure.

Parameters
phaseIdxIndex of a fluid phase

◆ saturation() [1/2]

template<class TypeTag >
Scalar Dumux::CellData2P< TypeTag, false >::saturation ( int  phaseIdx)
inline

Returns the cell phase saturation.

Parameters
phaseIdxIndex of a fluid phase

◆ saturation() [2/2]

template<class TypeTag >
Scalar Dumux::CellData2P< TypeTag, false >::saturation ( int  phaseIdx) const
inline

Returns the cell phase saturation.

Parameters
phaseIdxIndex of a fluid phase

◆ setCapillaryPressure()

template<class TypeTag >
void Dumux::CellData2P< TypeTag, false >::setCapillaryPressure ( Scalar  pc)
inline

Sets the cell capillary pressure.

Parameters
pcCapillary pressure which is stored

◆ setFracFlowFunc()

template<class TypeTag >
void Dumux::CellData2P< TypeTag, false >::setFracFlowFunc ( int  phaseIdx,
Scalar  fracFlowFunc 
)
inline

Sets the cell phase fractional flow function.

Parameters
phaseIdxIndex of a fluid phase
fracFlowFuncPhase fractional flow function which is stored

◆ setGlobalPressure()

template<class TypeTag >
void Dumux::CellData2P< TypeTag, false >::setGlobalPressure ( Scalar  press)
inline

Sets the cell global pressure.

Parameters
pressGlobal pressure which is stored

◆ setMobility()

template<class TypeTag >
void Dumux::CellData2P< TypeTag, false >::setMobility ( int  phaseIdx,
Scalar  mobility 
)
inline

Sets the cell phase mobility.

Parameters
phaseIdxIndex of a fluid phase
mobilityPhase mobility with which is stored

◆ setPotential()

template<class TypeTag >
void Dumux::CellData2P< TypeTag, false >::setPotential ( int  phaseIdx,
Scalar  pot 
)
inline

Sets the cell phase potential.

Parameters
phaseIdxIndex of a fluid phase
potPhase potential which is stored

◆ setPressure()

template<class TypeTag >
void Dumux::CellData2P< TypeTag, false >::setPressure ( int  phaseIdx,
Scalar  press 
)
inline

Sets the cell phase pressure.

Parameters
phaseIdxIndex of a fluid phase
pressPhase pressure which is stored

◆ setSaturation()

template<class TypeTag >
void Dumux::CellData2P< TypeTag, false >::setSaturation ( int  phaseIdx,
Scalar  sat 
)
inline

Sets the cell phase saturation.

Parameters
phaseIdxIndex of a fluid phase
satPhase saturation which is stored

◆ setUpdate()

template<class TypeTag >
void Dumux::CellData2P< TypeTag, false >::setUpdate ( Scalar  update)
inline

Store transport update.

Parameters
updateTransport update of the cell

◆ volumeCorrection() [1/2]

template<class TypeTag >
Scalar Dumux::CellData2P< TypeTag, false >::volumeCorrection ( )
inline

Returns the cell volume correction needed in the pressure equation.

◆ volumeCorrection() [2/2]

template<class TypeTag >
Scalar Dumux::CellData2P< TypeTag, false >::volumeCorrection ( ) const
inline

Returns the cell volume correction needed in the pressure equation.


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