Provides the Darcy flux module. More...

#include <darcyfluxmodule.hh>

Inheritance diagram for Opm::DarcyExtensiveQuantities< TypeTag >:

Public Member Functions
const DimMatrix &	intrinsicPermability () const
	Returns the intrinsic permeability tensor for a given sub-control volume face. More...

const EvalDimVector &	potentialGrad (unsigned phaseIdx) const
	Return the pressure potential gradient of a fluid phase at the face's integration point [Pa/m]. More...

const EvalDimVector &	filterVelocity (unsigned phaseIdx) const
	Return the filter velocity of a fluid phase at the face's integration point [m/s]. More...

const Evaluation &	volumeFlux (unsigned phaseIdx) const
	Return the volume flux of a fluid phase at the face's integration point . More...

Protected Member Functions
short	upstreamIndex_ (unsigned phaseIdx) const

short	downstreamIndex_ (unsigned phaseIdx) const

void	calculateGradients_ (const ElementContext &elemCtx, unsigned faceIdx, unsigned timeIdx)
	Calculate the gradients which are required to determine the volumetric fluxes. More...

template<class FluidState >
void	calculateBoundaryGradients_ (const ElementContext &elemCtx, unsigned boundaryFaceIdx, unsigned timeIdx, const FluidState &fluidState)
	Calculate the gradients at the grid boundary which are required to determine the volumetric fluxes. More...

void	calculateFluxes_ (const ElementContext &elemCtx, unsigned scvfIdx, unsigned timeIdx)
	Calculate the volumetric fluxes of all phases. More...

void	calculateBoundaryFluxes_ (const ElementContext &elemCtx, unsigned boundaryFaceIdx, unsigned timeIdx)
	Calculate the volumetric fluxes at a boundary face of all fluid phases. More...

void	calculateFilterVelocity_ (unsigned phaseIdx)

Protected Attributes
DimMatrix	K_

Evaluation	mobility_ [numPhases]

EvalDimVector	filterVelocity_ [numPhases]

Evaluation	volumeFlux_ [numPhases]

EvalDimVector	potentialGrad_ [numPhases]

short	upstreamDofIdx_ [numPhases]

short	downstreamDofIdx_ [numPhases]

short	interiorDofIdx_

short	exteriorDofIdx_

Detailed Description

template<class TypeTag>
class Opm::DarcyExtensiveQuantities< TypeTag >

Provides the Darcy flux module.

The commonly used Darcy relation looses its validity for Reynolds numbers $ Re <
1$ . If one encounters flow velocities in porous media above this threshold, the Forchheimer approach can be used.

The Darcy equation is given by the following relation:

$\vec{v}_\alpha = \left( \nabla p_\alpha - \rho_\alpha \vec{g}\right) \frac{\mu_\alpha}{k_{r,\alpha} K}$

Member Function Documentation

◆ calculateBoundaryFluxes_()

template<class TypeTag >

void Opm::DarcyExtensiveQuantities< TypeTag >::calculateBoundaryFluxes_	(	const ElementContext &	elemCtx,
		unsigned	boundaryFaceIdx,
		unsigned	timeIdx
	)

inlineprotected

Calculate the volumetric fluxes at a boundary face of all fluid phases.

The pressure potentials and upwind directions must already be determined before calling this method!

References Opm::DarcyExtensiveQuantities< TypeTag >::filterVelocity_, and Opm::DarcyExtensiveQuantities< TypeTag >::volumeFlux_.

◆ calculateBoundaryGradients_()

template<class TypeTag >

template<class FluidState >

void Opm::DarcyExtensiveQuantities< TypeTag >::calculateBoundaryGradients_	(	const ElementContext &	elemCtx,
		unsigned	boundaryFaceIdx,
		unsigned	timeIdx,
		const FluidState &	fluidState
	)

inlineprotected

Calculate the gradients at the grid boundary which are required to determine the volumetric fluxes.

The the upwind directions is also determined by method.

References Opm::DarcyExtensiveQuantities< TypeTag >::downstreamDofIdx_, Opm::DarcyExtensiveQuantities< TypeTag >::exteriorDofIdx_, Opm::DarcyExtensiveQuantities< TypeTag >::interiorDofIdx_, Opm::DarcyExtensiveQuantities< TypeTag >::K_, Opm::DarcyExtensiveQuantities< TypeTag >::mobility_, Opm::DarcyExtensiveQuantities< TypeTag >::potentialGrad_, Opm::BoundaryPressureCallback< TypeTag, FluidState >::setPhaseIndex(), and Opm::DarcyExtensiveQuantities< TypeTag >::upstreamDofIdx_.

Referenced by Opm::ForchheimerExtensiveQuantities< TypeTag >::calculateBoundaryGradients_().

◆ calculateFilterVelocity_()

template<class TypeTag >

void Opm::DarcyExtensiveQuantities< TypeTag >::calculateFilterVelocity_ ( unsigned phaseIdx )

inlineprotected

References Opm::DarcyExtensiveQuantities< TypeTag >::filterVelocity_, Opm::DarcyExtensiveQuantities< TypeTag >::K_, Opm::DarcyExtensiveQuantities< TypeTag >::mobility_, and Opm::DarcyExtensiveQuantities< TypeTag >::potentialGrad_.

◆ calculateFluxes_()

template<class TypeTag >

void Opm::DarcyExtensiveQuantities< TypeTag >::calculateFluxes_	(	const ElementContext &	elemCtx,
		unsigned	scvfIdx,
		unsigned	timeIdx
	)

inlineprotected

Calculate the volumetric fluxes of all phases.

The pressure potentials and upwind directions must already be determined before calling this method!

References Opm::DarcyExtensiveQuantities< TypeTag >::filterVelocity_, and Opm::DarcyExtensiveQuantities< TypeTag >::volumeFlux_.

◆ calculateGradients_()

template<class TypeTag >

void Opm::DarcyExtensiveQuantities< TypeTag >::calculateGradients_	(	const ElementContext &	elemCtx,
		unsigned	faceIdx,
		unsigned	timeIdx
	)

inlineprotected

Calculate the gradients which are required to determine the volumetric fluxes.

The the upwind directions is also determined by method.

References Opm::DarcyExtensiveQuantities< TypeTag >::downstreamDofIdx_, Opm::DarcyExtensiveQuantities< TypeTag >::exteriorDofIdx_, Opm::DarcyExtensiveQuantities< TypeTag >::interiorDofIdx_, Opm::DarcyExtensiveQuantities< TypeTag >::K_, Opm::DarcyExtensiveQuantities< TypeTag >::mobility_, Opm::DarcyExtensiveQuantities< TypeTag >::potentialGrad_, Opm::PressureCallback< TypeTag >::setPhaseIndex(), and Opm::DarcyExtensiveQuantities< TypeTag >::upstreamDofIdx_.

Referenced by Opm::ForchheimerExtensiveQuantities< TypeTag >::calculateGradients_().

◆ downstreamIndex_()

template<class TypeTag >

short Opm::DarcyExtensiveQuantities< TypeTag >::downstreamIndex_ ( unsigned phaseIdx ) const

inlineprotected

References Opm::DarcyExtensiveQuantities< TypeTag >::downstreamDofIdx_.

◆ filterVelocity()

template<class TypeTag >

const EvalDimVector & Opm::DarcyExtensiveQuantities< TypeTag >::filterVelocity ( unsigned phaseIdx ) const

inline

Return the filter velocity of a fluid phase at the face's integration point [m/s].

Parameters

phaseIdx The index of the fluid phase

References Opm::DarcyExtensiveQuantities< TypeTag >::filterVelocity_.

◆ intrinsicPermability()

template<class TypeTag >

const DimMatrix & Opm::DarcyExtensiveQuantities< TypeTag >::intrinsicPermability ( ) const

inline

Returns the intrinsic permeability tensor for a given sub-control volume face.

References Opm::DarcyExtensiveQuantities< TypeTag >::K_.

◆ potentialGrad()

template<class TypeTag >

const EvalDimVector & Opm::DarcyExtensiveQuantities< TypeTag >::potentialGrad ( unsigned phaseIdx ) const

inline

Return the pressure potential gradient of a fluid phase at the face's integration point [Pa/m].

Parameters

phaseIdx The index of the fluid phase

References Opm::DarcyExtensiveQuantities< TypeTag >::potentialGrad_.

◆ upstreamIndex_()

template<class TypeTag >

short Opm::DarcyExtensiveQuantities< TypeTag >::upstreamIndex_ ( unsigned phaseIdx ) const

inlineprotected

References Opm::DarcyExtensiveQuantities< TypeTag >::upstreamDofIdx_.

Referenced by Opm::ForchheimerExtensiveQuantities< TypeTag >::calculateGradients_().

◆ volumeFlux()

template<class TypeTag >

const Evaluation & Opm::DarcyExtensiveQuantities< TypeTag >::volumeFlux ( unsigned phaseIdx ) const

inline

Return the volume flux of a fluid phase at the face's integration point $[m^3/s / m^2]$ .

This is the fluid volume of a phase per second and per square meter of face area.

Parameters

phaseIdx The index of the fluid phase

References Opm::DarcyExtensiveQuantities< TypeTag >::volumeFlux_.

Member Data Documentation

◆ downstreamDofIdx_

template<class TypeTag >

short Opm::DarcyExtensiveQuantities< TypeTag >::downstreamDofIdx_[numPhases]

protected

Referenced by Opm::DarcyExtensiveQuantities< TypeTag >::calculateBoundaryGradients_(), Opm::DarcyExtensiveQuantities< TypeTag >::calculateGradients_(), and Opm::DarcyExtensiveQuantities< TypeTag >::downstreamIndex_().

◆ exteriorDofIdx_

template<class TypeTag >

short Opm::DarcyExtensiveQuantities< TypeTag >::exteriorDofIdx_

protected

Referenced by Opm::DarcyExtensiveQuantities< TypeTag >::calculateBoundaryGradients_(), Opm::DarcyExtensiveQuantities< TypeTag >::calculateGradients_(), and Opm::ForchheimerExtensiveQuantities< TypeTag >::calculateGradients_().

◆ filterVelocity_

template<class TypeTag >

EvalDimVector Opm::DarcyExtensiveQuantities< TypeTag >::filterVelocity_[numPhases]

protected

Referenced by Opm::ForchheimerExtensiveQuantities< TypeTag >::calculateBoundaryFluxes_(), Opm::DarcyExtensiveQuantities< TypeTag >::calculateBoundaryFluxes_(), Opm::DarcyExtensiveQuantities< TypeTag >::calculateFilterVelocity_(), Opm::DarcyExtensiveQuantities< TypeTag >::calculateFluxes_(), Opm::ForchheimerExtensiveQuantities< TypeTag >::calculateFluxes_(), Opm::ForchheimerExtensiveQuantities< TypeTag >::calculateForchheimerFlux_(), Opm::DarcyExtensiveQuantities< TypeTag >::filterVelocity(), Opm::ForchheimerExtensiveQuantities< TypeTag >::forchheimerResid_(), and Opm::ForchheimerExtensiveQuantities< TypeTag >::gradForchheimerResid_().

◆ interiorDofIdx_

template<class TypeTag >

short Opm::DarcyExtensiveQuantities< TypeTag >::interiorDofIdx_

protected

Referenced by Opm::DarcyExtensiveQuantities< TypeTag >::calculateBoundaryGradients_(), Opm::ForchheimerExtensiveQuantities< TypeTag >::calculateBoundaryGradients_(), Opm::DarcyExtensiveQuantities< TypeTag >::calculateGradients_(), and Opm::ForchheimerExtensiveQuantities< TypeTag >::calculateGradients_().

◆ K_

template<class TypeTag >

DimMatrix Opm::DarcyExtensiveQuantities< TypeTag >::K_

protected

Referenced by Opm::DarcyExtensiveQuantities< TypeTag >::calculateBoundaryGradients_(), Opm::ForchheimerExtensiveQuantities< TypeTag >::calculateBoundaryGradients_(), Opm::DarcyExtensiveQuantities< TypeTag >::calculateFilterVelocity_(), Opm::DarcyExtensiveQuantities< TypeTag >::calculateGradients_(), Opm::ForchheimerExtensiveQuantities< TypeTag >::calculateGradients_(), Opm::ForchheimerExtensiveQuantities< TypeTag >::forchheimerResid_(), and Opm::DarcyExtensiveQuantities< TypeTag >::intrinsicPermability().

◆ mobility_

template<class TypeTag >

Evaluation Opm::DarcyExtensiveQuantities< TypeTag >::mobility_[numPhases]

protected

Referenced by Opm::DarcyExtensiveQuantities< TypeTag >::calculateBoundaryGradients_(), Opm::DarcyExtensiveQuantities< TypeTag >::calculateFilterVelocity_(), Opm::DarcyExtensiveQuantities< TypeTag >::calculateGradients_(), and Opm::ForchheimerExtensiveQuantities< TypeTag >::forchheimerResid_().

◆ potentialGrad_

template<class TypeTag >

EvalDimVector Opm::DarcyExtensiveQuantities< TypeTag >::potentialGrad_[numPhases]

protected

Referenced by Opm::DarcyExtensiveQuantities< TypeTag >::calculateBoundaryGradients_(), Opm::DarcyExtensiveQuantities< TypeTag >::calculateFilterVelocity_(), Opm::DarcyExtensiveQuantities< TypeTag >::calculateGradients_(), Opm::ForchheimerExtensiveQuantities< TypeTag >::forchheimerResid_(), and Opm::DarcyExtensiveQuantities< TypeTag >::potentialGrad().

◆ upstreamDofIdx_

template<class TypeTag >

short Opm::DarcyExtensiveQuantities< TypeTag >::upstreamDofIdx_[numPhases]

protected

Referenced by Opm::DarcyExtensiveQuantities< TypeTag >::calculateBoundaryGradients_(), Opm::DarcyExtensiveQuantities< TypeTag >::calculateGradients_(), and Opm::DarcyExtensiveQuantities< TypeTag >::upstreamIndex_().

◆ volumeFlux_

template<class TypeTag >

Evaluation Opm::DarcyExtensiveQuantities< TypeTag >::volumeFlux_[numPhases]

protected

Referenced by Opm::ForchheimerExtensiveQuantities< TypeTag >::calculateBoundaryFluxes_(), Opm::DarcyExtensiveQuantities< TypeTag >::calculateBoundaryFluxes_(), Opm::DarcyExtensiveQuantities< TypeTag >::calculateFluxes_(), Opm::ForchheimerExtensiveQuantities< TypeTag >::calculateFluxes_(), and Opm::DarcyExtensiveQuantities< TypeTag >::volumeFlux().

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

darcyfluxmodule.hh

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ calculateBoundaryFluxes_()

◆ calculateBoundaryGradients_()

◆ calculateFilterVelocity_()

◆ calculateFluxes_()

◆ calculateGradients_()

◆ downstreamIndex_()

◆ filterVelocity()

◆ intrinsicPermability()

◆ potentialGrad()

◆ upstreamIndex_()

◆ volumeFlux()

Member Data Documentation

◆ downstreamDofIdx_

◆ exteriorDofIdx_

◆ filterVelocity_

◆ interiorDofIdx_

◆ K_

◆ mobility_

◆ potentialGrad_

◆ upstreamDofIdx_

◆ volumeFlux_