Two-phase finite volume model. More...

#include <dumux/porousmediumflow/2p/sequential/diffusion/cellcentered/pressurevelocity.hh>

Inheritance diagram for Dumux::FVPressureVelocity2P< TypeTag >:

Description

template<class TypeTag>
class Dumux::FVPressureVelocity2P< TypeTag >

Two-phase finite volume model.

Template Parameters

TypeTag The Type Tag

Public Member Functions
void	initialize ()
	Initializes the pressure model. More...

void	update ()
	Pressure update. More...

template<class MultiWriter >
void	addOutputVtkFields (MultiWriter &writer)
	Adds velocity output to the output file. More...

	FVPressureVelocity2P (Problem &problem)
	Constructs a FVPressure2P object. More...

void	getSource (EntryType &entry, const Element &element, const CellData &cellData, const bool first)
	Function which calculates the source entry. More...

void	getStorage (EntryType &entry, const Element &element, const CellData &cellData, const bool first)
	Function which calculates the storage entry. More...

void	getFlux (EntryType &entry, const Intersection &intersection, const CellData &cellData, const bool first)
	Function which calculates the flux entry. More...

void	getFluxOnBoundary (EntryType &entry, const Intersection &intersection, const CellData &cellData, const bool first)
	Function which calculates the boundary flux entry. More...

void	updateMaterialLaws ()
	Updates and stores constitutive relations. More...

void	initialize (bool solveTwice=true)
	Initializes the pressure model. More...

void	updateVelocity ()
	Velocity update. More...

void	storePressureSolution ()
	Globally stores the pressure solution. More...

void	storePressureSolution (const Element &element)
	Stores the pressure solution of a cell. More...

const Scalar	pressure (const int eIdxGlobal) const
	Public access function for the primary pressure variable. More...

const Matrix &	globalMatrix ()
	Returns the global matrix of the last pressure solution step. More...

const RHSVector &	rightHandSide ()
	Returns the right hand side vector of the last pressure solution step. More...

void	calculateVelocity ()

void	serializeEntity (std::ostream &outstream, const Element &element)
	Function for serialization of the pressure field. More...

void	deserializeEntity (std::istream &instream, const Element &element)
	Function for deserialization of the pressure field. More...

void	setFixPressureAtIndex (Scalar pressure, int eIdxGlobal)
	Set a pressure to be fixed at a certain cell. More...

void	unsetFixPressureAtIndex (int eIdxGlobal)
	Reset the fixed pressure state. More...

void	resetFixPressureAtIndex ()

Protected Types
enum	{ rhs = 1 , matrix = 0 }
	Indices of matrix and rhs entries. More...

enum	{ pressEqIdx = Indices::pressureEqIdx }

using	EntryType = Dune::FieldVector< Scalar, 2 >

Protected Member Functions
void	initializeMatrix ()
	Initialize the global matrix of the system of equations to solve. More...

void	initializeMatrixRowSize ()
	Initialize the global matrix of the system of equations to solve. More...

void	initializeMatrixIndices ()
	Initialize the global matrix of the system of equations to solve. More...

void	assemble (bool first)
	Function which assembles the system of equations to be solved. More...

void	solve ()
	Solves the global system of equations to get the spatial distribution of the pressure. More...

PressureSolution &	pressure ()
	Returns the vector containing the pressure solution. More...

const PressureSolution &	pressure () const
	Returns the vector containing the pressure solution. More...

void	initializePressure ()
	Initialization of the pressure solution vector: Initialization with meaningful values may. More...

Protected Attributes
Matrix	A_
	Global stiffnes matrix (sparse matrix which is build by the `initializeMatrix()` function) More...

RHSVector	f_
	Right hand side vector. More...

Member Typedef Documentation

◆ EntryType

template<class TypeTag >

using Dumux::FVPressure< TypeTag >::EntryType = Dune::FieldVector<Scalar, 2>

protectedinherited

Type of the vector of entries

Contains the return values of the get*()-functions (matrix or right-hand side entry).

Member Enumeration Documentation

◆ anonymous enum

template<class TypeTag >

anonymous enum

protectedinherited

Indices of matrix and rhs entries.

During the assembling of the global system of equations get-functions are called (getSource(), getFlux(), etc.), which return global matrix or right hand side entries in a vector. These can be accessed using following indices:

Enumerator
rhs	index for the right hand side entry
matrix	index for the global matrix entry

◆ anonymous enum

template<class TypeTag >

anonymous enum

protectedinherited

Enumerator
pressEqIdx

Constructor & Destructor Documentation

◆ FVPressureVelocity2P()

template<class TypeTag >

Dumux::FVPressureVelocity2P< TypeTag >::FVPressureVelocity2P ( Problem & problem )

inline

Constructs a FVPressure2P object.

Parameters

problem A problem class object

Member Function Documentation

◆ addOutputVtkFields()

template<class TypeTag >

template<class MultiWriter >

void Dumux::FVPressureVelocity2P< TypeTag >::addOutputVtkFields ( MultiWriter & writer )

inline

Adds velocity output to the output file.

Adds the velocities to the output.

Template Parameters

MultiWriter Class defining the output writer

Parameters

writer The output writer (usually a VTKMultiWriter object)

◆ assemble()

template<class TypeTag >

void Dumux::FVPressure< TypeTag >::assemble ( bool first )

protectedinherited

Function which assembles the system of equations to be solved.

This function assembles the Matrix and the right hand side (RHS) vector to solve for a pressure field with a Finite-Volume (FV) discretization. Implementations of this base class have to provide the methods getSource(), getStorage(), getFlux() and getFluxOnBoundary() if the assemble() method is called!

Parameters

first Indicates if function is called at the initialization step or during the simulation (If first is true, no pressure field of previous iterations is required)

◆ calculateVelocity()

template<class TypeTag >

void Dumux::FVPressure< TypeTag >::calculateVelocity ( )

inlineinherited

◆ deserializeEntity()

template<class TypeTag >

void Dumux::FVPressure< TypeTag >::deserializeEntity	(	std::istream &	instream,
		const Element &	element
	)

inlineinherited

Function for deserialization of the pressure field.

Function needed for restart option. Reads the pressure of a grid element from a restart file.

Parameters

instream	Stream from the restart file.
element	Grid element

◆ getFlux()

template<class TypeTag >

void Dumux::FVPressure2P< TypeTag >::getFlux	(	EntryType &	entry,
		const Intersection &	intersection,
		const CellData &	cellData,
		const bool	first
	)

inherited

Function which calculates the flux entry.

Function computes the inter-cell flux term and writes it to the corresponding entry of the entry vector

Parameters

entry	Vector containing return values of the function
intersection	Intersection of two grid elements
cellData	Object containing all model relevant cell data
first	Indicates if function is called in the initialization step or during the simulation

◆ getFluxOnBoundary()

template<class TypeTag >

void Dumux::FVPressure2P< TypeTag >::getFluxOnBoundary	(	EntryType &	entry,
		const Intersection &	intersection,
		const CellData &	cellData,
		const bool	first
	)

inherited

Function which calculates the boundary flux entry.

Function which calculates the flux entry at a boundary.

Function computes the boundary-flux term and writes it to the corresponding entry of the entry vector

Parameters

entry	Vector containing return values of the function
intersection	Intersection of two grid elements
cellData	Object containing all model relevant cell data
first	Indicates if function is called in the initialization step or during the simulation

Dirichlet boundary condition for pressure depends on the formulation ( \(p_w\) (default), \(p_n\), \(p_{global}\)), Neumann boundary condition are the phase mass fluxes ( \(q_w\) and \(q_n\), [ \(\text{kg}/(\text{m}^2 \text{s}\)])

◆ getSource()

template<class TypeTag >

void Dumux::FVPressure2P< TypeTag >::getSource	(	EntryType &	entry,
		const Element &	element,
		const CellData &	cellData,
		const bool	first
	)

inherited

Function which calculates the source entry.

Function computes the source term and writes it to the corresponding entry of the entry vector

Parameters

entry	Vector containing return values of the function
element	Grid element
cellData	Object containing all model relevant cell data
first	Indicates if function is called in the initialization step or during the simulation

Source of each fluid phase has to be added as mass flux ( \(\text{kg}/(\text{m}^3 \text{s}\)).

◆ getStorage()

template<class TypeTag >

void Dumux::FVPressure2P< TypeTag >::getStorage	(	EntryType &	entry,
		const Element &	element,
		const CellData &	cellData,
		const bool	first
	)

inherited

Function which calculates the storage entry.

Function computes the storage term and writes it to the corresponding entry of the entry vector

Parameters

entry	Vector containing return values of the function
element	Grid element
cellData	Object containing all model relevant cell data
first	Indicates if function is called in the initialization step or during the simulation

If compressibility is enabled this functions calculates the term

\[ \phi \sum_\alpha \varrho_\alpha \frac{\partial S_\alpha}{\partial t} V \]

In the incompressible case an volume correction term is calculated which corrects for non-physical saturation overshoots/undershoots. These can occur if the estimated time step for the explicit transport was too large. Correction by an artificial source term allows to correct this errors due to wrong time-stepping without losing mass conservation. The error term looks as follows:

\[ q_{error} = \begin{cases} S < 0 & a_{error} \frac{S}{\Delta t} V \\ S > 1 & a_{error} \frac{(S - 1)}{\Delta t} V \\ 0 \le S \le 1 & 0 \end{cases} \]

where \(a_{error}\) is a weighting factor (default: \(a_{error} = 0.5\))

◆ globalMatrix()

template<class TypeTag >

const Matrix & Dumux::FVPressure< TypeTag >::globalMatrix ( )

inlineinherited

Returns the global matrix of the last pressure solution step.

◆ initialize() [1/2]

template<class TypeTag >

void Dumux::FVPressureVelocity2P< TypeTag >::initialize ( )

inline

Initializes the pressure model.

Function initializes the sparse matrix to solve the global system of equations and sets/calculates the initial pressure

◆ initialize() [2/2]

template<class TypeTag >

void Dumux::FVPressure2P< TypeTag >::initialize ( bool solveTwice = true )

inlineinherited

Initializes the pressure model.

Function initializes the sparse matrix to solve the global system of equations and sets/calculates the initial pressure

Parameters

solveTwice indicates if more than one iteration is allowed to get an initial pressure solution

◆ initializeMatrix()

template<class TypeTag >

void Dumux::FVPressure< TypeTag >::initializeMatrix

protectedinherited

Initialize the global matrix of the system of equations to solve.

◆ initializeMatrixIndices()

template<class TypeTag >

void Dumux::FVPressure< TypeTag >::initializeMatrixIndices

protectedinherited

Initialize the global matrix of the system of equations to solve.

◆ initializeMatrixRowSize()

template<class TypeTag >

void Dumux::FVPressure< TypeTag >::initializeMatrixRowSize

protectedinherited

Initialize the global matrix of the system of equations to solve.

◆ initializePressure()

template<class TypeTag >

void Dumux::FVPressure< TypeTag >::initializePressure ( )

inlineprotectedinherited

Initialization of the pressure solution vector: Initialization with meaningful values may.

◆ pressure() [1/3]

template<class TypeTag >

PressureSolution & Dumux::FVPressure< TypeTag >::pressure ( )

inlineprotectedinherited

Returns the vector containing the pressure solution.

◆ pressure() [2/3]

template<class TypeTag >

const PressureSolution & Dumux::FVPressure< TypeTag >::pressure ( ) const

inlineprotectedinherited

Returns the vector containing the pressure solution.

◆ pressure() [3/3]

template<class TypeTag >

const Scalar Dumux::FVPressure< TypeTag >::pressure ( const int eIdxGlobal ) const

inlineinherited

Public access function for the primary pressure variable.

Function returns the cell pressure value at index eIdxGlobal

Parameters

eIdxGlobal Global index of a grid cell

◆ resetFixPressureAtIndex()

template<class TypeTag >

void Dumux::FVPressure< TypeTag >::resetFixPressureAtIndex ( )

inlineinherited

◆ rightHandSide()

template<class TypeTag >

const RHSVector & Dumux::FVPressure< TypeTag >::rightHandSide ( )

inlineinherited

Returns the right hand side vector of the last pressure solution step.

◆ serializeEntity()

template<class TypeTag >

void Dumux::FVPressure< TypeTag >::serializeEntity	(	std::ostream &	outstream,
		const Element &	element
	)

inlineinherited

Function for serialization of the pressure field.

Function needed for restart option. Writes the pressure of a grid element to a restart file.

Parameters

outstream	Stream into the restart file.
element	Grid element

◆ setFixPressureAtIndex()

template<class TypeTag >

void Dumux::FVPressure< TypeTag >::setFixPressureAtIndex	(	Scalar	pressure,
		int	eIdxGlobal
	)

inlineinherited

Set a pressure to be fixed at a certain cell.

Allows to fix a pressure somewhere (at one certain cell) in the domain. This can be necessary e.g. if only Neumann boundary conditions are defined. The pressure is fixed until the unsetFixPressureAtIndex() function is called

Parameters

pressure	Pressure value at eIdxGlobal
eIdxGlobal	Global index of a grid cell

◆ solve()

template<class TypeTag >

void Dumux::FVPressure< TypeTag >::solve

protectedinherited

Solves the global system of equations to get the spatial distribution of the pressure.

◆ storePressureSolution() [1/2]

template<class TypeTag >

void Dumux::FVPressure2P< TypeTag >::storePressureSolution ( )

inlineinherited

Globally stores the pressure solution.

◆ storePressureSolution() [2/2]

template<class TypeTag >

void Dumux::FVPressure2P< TypeTag >::storePressureSolution ( const Element & element )

inlineinherited

Stores the pressure solution of a cell.

Calculates secondary pressure variables and stores pressures.

Parameters

element Grid element

◆ unsetFixPressureAtIndex()

template<class TypeTag >

void Dumux::FVPressure< TypeTag >::unsetFixPressureAtIndex ( int eIdxGlobal )

inlineinherited

Reset the fixed pressure state.

No pressure is fixed inside the domain until setFixPressureAtIndex() function is called again.

Parameters

eIdxGlobal Global index of a grid cell

◆ update()

template<class TypeTag >

void Dumux::FVPressureVelocity2P< TypeTag >::update ( )

inline

Pressure update.

Function reassembles the system of equations and solves for a new pressure solution.

◆ updateMaterialLaws()

template<class TypeTag >

void Dumux::FVPressure2P< TypeTag >::updateMaterialLaws

inherited

Updates and stores constitutive relations.

Updates constitutive relations and stores them in the variable class.

Stores mobility, fractional flow function and capillary pressure for all grid cells. In the compressible case additionally the densities and viscosities are stored.

Template Parameters

TypeTag The problem TypeTag

◆ updateVelocity()

template<class TypeTag >

void Dumux::FVPressure2P< TypeTag >::updateVelocity ( )

inlineinherited

Velocity update.

Resets the velocities in the cellData.

Member Data Documentation

◆ A_

template<class TypeTag >

Matrix Dumux::FVPressure< TypeTag >::A_

protectedinherited

Global stiffnes matrix (sparse matrix which is build by the initializeMatrix() function)

◆ f_

template<class TypeTag >

RHSVector Dumux::FVPressure< TypeTag >::f_

protectedinherited

Right hand side vector.

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

2p/sequential/diffusion/cellcentered/pressurevelocity.hh

Description

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ EntryType

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ FVPressureVelocity2P()

Member Function Documentation

◆ addOutputVtkFields()

◆ assemble()

◆ calculateVelocity()

◆ deserializeEntity()

◆ getFlux()

◆ getFluxOnBoundary()

◆ getSource()

◆ getStorage()

◆ globalMatrix()

◆ initialize() [1/2]

◆ initialize() [2/2]

◆ initializeMatrix()

◆ initializeMatrixIndices()

◆ initializeMatrixRowSize()

◆ initializePressure()

◆ pressure() [1/3]

◆ pressure() [2/3]

◆ pressure() [3/3]

◆ resetFixPressureAtIndex()

◆ rightHandSide()

◆ serializeEntity()

◆ setFixPressureAtIndex()

◆ solve()

◆ storePressureSolution() [1/2]

◆ storePressureSolution() [2/2]

◆ unsetFixPressureAtIndex()

◆ update()

◆ updateMaterialLaws()

◆ updateVelocity()

Member Data Documentation

◆ A_

◆ f_