Class including the information of an interaction volume of a MPFA O-method that does not change with time. More...

#include <dumux/porousmediumflow/sequential/cellcentered/mpfa/ointeractionvolume.hh>

Description

template<class TypeTag>
class Dumux::FVMPFAOInteractionVolume< TypeTag >

Class including the information of an interaction volume of a MPFA O-method that does not change with time.

Includes information needed to calculate the transmissibility matrix of an O-interaction-volume.

Public Types
enum	FaceTypes { inside = 1 , boundary = 0 , outside = -1 }

Public Member Functions
	FVMPFAOInteractionVolume (const Grid &grid)
	Constructs a FVMPFAOInteractionVolume object. More...

void	setStored ()
	Mark storage as completed. More...

bool	isStored () const
	Returns true if information has already been stored. More...

void	setSubVolumeElement (const Element &element, int subVolumeIdx)
	Store an element of the interaction volume. More...

void	setDF (Scalar dF, int subVolumeIdx)
	Store the \( dF \) for the transmissiblity calculation. More...

void	setFaceArea (Scalar &faceArea, int subVolumeIdx, int subVolumeFaceIdxInInside)
	Store a flux face area. More...

void	setPermTimesNu (DimVector &nu, DimMatrix &perm, int subVolumeIdx, int subVolumeFaceIdxInInside)
	Store \( \boldsymbol K \boldsymbol \nu\) for the transmissiblity calculation. More...

void	setNormal (DimVector &normal, int subVolumeIdx, int subVolumeFaceIdxInInside)
	Store a flux face normal. More...

void	setBoundary (BoundaryTypes &boundaryTypes, int subVolumeFaceIdx)
	Store boundary condtion types for a flux face. More...

void	setOutsideFace (int subVolumeFaceIdx)
	Mark a flux face to be outside the model domain. More...

void	setDirichletCondition (PrimaryVariables &condition, int subVolumeFaceIdx)
	Store Dirichlet boundary condtions for a flux face. More...

void	setNeumannCondition (PrimaryVariables &condition, int subVolumeFaceIdx)
	Store Neumann boundary condtions for a flux face. More...

void	setIndexOnElement (int indexInInside, int subVolumeIdx, int subVolumeFaceIdxInInside)
	Store map from local interaction volume numbering to numbering of the Dune reference element. More...

int	getIndexOnElement (int subVolumeIdx, int subVolumeFaceIdx)
	Map from local interaction volume numbering to numbering of the Dune reference element. More...

int	getFaceIndexFromSubVolume (int subVolumeIdx, int subVolumeFaceIdx)
	Map from local interaction volume numbering on element to numbering on interaction volume. More...

Element	getSubVolumeElement (int subVolumeIdx)
	Get an element of the interaction volume. More...

BoundaryTypes &	getBoundaryType (int subVolumeFaceIdx)
	Get boundary condtion types for a flux face. More...

bool	isOutsideFace (int subVolumeFaceIdx)
	Returns true if an interaction volume flux face is outside the model domain. More...

bool	isInsideFace (int subVolumeFaceIdx)
	Returns true if an interaction volume flux face is inside the model domain and no boundary face. More...

bool	isInnerVolume ()
	Returns true if the interaction volume is completely inside the model domain. More...

bool	isBoundaryFace (int subVolumeFaceIdx)
	Returns true if an interaction volume flux face is a boundary face. More...

PrimaryVariables &	getDirichletValues (int subVolumeFaceIdx)
	Get the Dirichlet boundary condtions for a flux face. More...

PrimaryVariables &	getNeumannValues (int subVolumeFaceIdx)
	Get the Neumann boundary condtions for a flux face. More...

DimVector &	getNormal (int subVolumeIdx, int subVolumeFaceIdxInInside)
	Get a flux face normal. More...

Scalar &	getFaceArea (int subVolumeIdx, int subVolumeFaceIdxInInside)
	Get a flux face area. More...

DimVector &	getNu (int subVolumeIdx, int subVolumeFaceIdxInInside)
	Get \( \boldsymbol \nu \) vector used for the transmissiblity calculation. More...

Scalar	getNtkNu (int subVolumeIdx, int subVolumeFaceIdxInInsideN, int subVolumeFaceIdxInInsideNu) const
	Get \( \boldsymbol n^\text{T} \boldsymbol K \boldsymbol \nu \) for the transmissiblity calculation. More...

Scalar	getNtkrkNu (Scalar &relPerm, int subVolumeIdx, int subVolumeFaceIdxInInsideN, int subVolumeFaceIdxInInsideNu) const
	Get \( \boldsymbol n^\text{T} k_{r\alpha} \boldsymbol K \boldsymbol \nu\) for the transmissiblity calculation. More...

Scalar	getNtkNu_df (int subVolumeIdx, int subVolumeFaceIdxInInsideN, int subVolumeFaceIdxInInsideNu) const

Scalar	getNtkrkNu_df (Scalar &relPerm, int subVolumeIdx, int subVolumeFaceIdxInInsideN, int subVolumeFaceIdxInInsideNu) const

Member Enumeration Documentation

◆ FaceTypes

template<class TypeTag >

enum Dumux::FVMPFAOInteractionVolume::FaceTypes

Enumerator
inside
boundary
outside

Constructor & Destructor Documentation

◆ FVMPFAOInteractionVolume()

template<class TypeTag >

Dumux::FVMPFAOInteractionVolume< TypeTag >::FVMPFAOInteractionVolume ( const Grid & grid )

inline

Constructs a FVMPFAOInteractionVolume object.

Member Function Documentation

◆ getBoundaryType()

template<class TypeTag >

BoundaryTypes & Dumux::FVMPFAOInteractionVolume< TypeTag >::getBoundaryType ( int subVolumeFaceIdx )

inline

Get boundary condtion types for a flux face.

Parameters

subVolumeFaceIdx The local face index in the interaction volume

Returns: Object containing information about the boundary types.

◆ getDirichletValues()

template<class TypeTag >

PrimaryVariables & Dumux::FVMPFAOInteractionVolume< TypeTag >::getDirichletValues ( int subVolumeFaceIdx )

inline

Get the Dirichlet boundary condtions for a flux face.

Parameters

subVolumeFaceIdx The local face index in the interaction volume

Returns: Vector of primary variables.

◆ getFaceArea()

template<class TypeTag >

Scalar & Dumux::FVMPFAOInteractionVolume< TypeTag >::getFaceArea	(	int	subVolumeIdx,
		int	subVolumeFaceIdxInInside
	)

inline

Get a flux face area.

Parameters

subVolumeIdx	The local element index in the interaction volume
subVolumeFaceIdxInInside	The local face index in the interaction volume element

Returns: Area of the flux face

◆ getFaceIndexFromSubVolume()

template<class TypeTag >

int Dumux::FVMPFAOInteractionVolume< TypeTag >::getFaceIndexFromSubVolume	(	int	subVolumeIdx,
		int	subVolumeFaceIdx
	)

inline

Map from local interaction volume numbering on element to numbering on interaction volume.

Parameters

subVolumeIdx	The local element index in the interaction volume
subVolumeFaceIdx	The local face index in the interaction volume element

Returns: Local face index int the interaction volume

◆ getIndexOnElement()

template<class TypeTag >

int Dumux::FVMPFAOInteractionVolume< TypeTag >::getIndexOnElement	(	int	subVolumeIdx,
		int	subVolumeFaceIdx
	)

inline

Map from local interaction volume numbering to numbering of the Dune reference element.

Parameters

subVolumeIdx	The local element index in the interaction volume
subVolumeFaceIdx	The local face index in the interaction volume element

Returns: Face index of the Dune reference element

◆ getNeumannValues()

template<class TypeTag >

PrimaryVariables & Dumux::FVMPFAOInteractionVolume< TypeTag >::getNeumannValues ( int subVolumeFaceIdx )

inline

Get the Neumann boundary condtions for a flux face.

Parameters

subVolumeFaceIdx The local face index in the interaction volume

Returns: Vector of phase fluxes.

◆ getNormal()

template<class TypeTag >

DimVector & Dumux::FVMPFAOInteractionVolume< TypeTag >::getNormal	(	int	subVolumeIdx,
		int	subVolumeFaceIdxInInside
	)

inline

Get a flux face normal.

Parameters

subVolumeIdx	The local element index in the interaction volume
subVolumeFaceIdxInInside	The local face index in the interaction volume element

Returns: Normal vector

◆ getNtkNu()

template<class TypeTag >

Scalar Dumux::FVMPFAOInteractionVolume< TypeTag >::getNtkNu	(	int	subVolumeIdx,
		int	subVolumeFaceIdxInInsideN,
		int	subVolumeFaceIdxInInsideNu
	)		const

inline

Get \( \boldsymbol n^\text{T} \boldsymbol K \boldsymbol \nu \) for the transmissiblity calculation.

Parameters

subVolumeIdx	The local element index in the interaction volume
subVolumeFaceIdxInInsideN	The local face index in the interaction volume element for the normal \( \boldsymbol n \)
subVolumeFaceIdxInInsideNu	The local face index in the interaction volume element for the vector \( \boldsymbol \nu \)

Returns: \( \boldsymbol n^\text{T} \boldsymbol K \boldsymbol \nu \)

◆ getNtkNu_df()

template<class TypeTag >

Scalar Dumux::FVMPFAOInteractionVolume< TypeTag >::getNtkNu_df	(	int	subVolumeIdx,
		int	subVolumeFaceIdxInInsideN,
		int	subVolumeFaceIdxInInsideNu
	)		const

inline

Get \( \frac{1}{dF} \left(\boldsymbol n^\text{T} \boldsymbol K \boldsymbol \nu \right) \) for the transmissiblity calculation

Parameters

subVolumeIdx	The local element index in the interaction volume
subVolumeFaceIdxInInsideN	The local face index in the interaction volume element for the normal \( \boldsymbol n \)
subVolumeFaceIdxInInsideNu	The local face index in the interaction volume element for the vector \( \boldsymbol \nu \)

Returns: \( \frac{1}{dF} \left(\boldsymbol n^\text{T} \boldsymbol K \boldsymbol \nu \right) \)

◆ getNtkrkNu()

template<class TypeTag >

Scalar Dumux::FVMPFAOInteractionVolume< TypeTag >::getNtkrkNu	(	Scalar &	relPerm,
		int	subVolumeIdx,
		int	subVolumeFaceIdxInInsideN,
		int	subVolumeFaceIdxInInsideNu
	)		const

inline

Get \( \boldsymbol n^\text{T} k_{r\alpha} \boldsymbol K \boldsymbol \nu\) for the transmissiblity calculation.

Parameters

relPerm	relative permeability value ( \( \boldsymbol n^\text{T} k_{r\alpha} \))
subVolumeIdx	The local element index in the interaction volume
subVolumeFaceIdxInInsideN	The local face index in the interaction volume element for the normal \( \boldsymbol n \)
subVolumeFaceIdxInInsideNu	The local face index in the interaction volume element for the vector \( \boldsymbol \nu \)

Returns: \( \boldsymbol n^\text{T} k_{r\alpha} \boldsymbol K \boldsymbol \nu \)

◆ getNtkrkNu_df()

template<class TypeTag >

Scalar Dumux::FVMPFAOInteractionVolume< TypeTag >::getNtkrkNu_df	(	Scalar &	relPerm,
		int	subVolumeIdx,
		int	subVolumeFaceIdxInInsideN,
		int	subVolumeFaceIdxInInsideNu
	)		const

inline

Get \( \frac{1}{dF} \left(\boldsymbol n^\text{T} k_{r\alpha} \boldsymbol K \boldsymbol \nu \right) \) for the transmissiblity calculation

Parameters

relPerm	relative permeability value ( \( \boldsymbol n^\text{T} k_{r\alpha} \))
subVolumeIdx	The local element index in the interaction volume
subVolumeFaceIdxInInsideN	The local face index in the interaction volume element for the normal \( \boldsymbol n \)
subVolumeFaceIdxInInsideNu	The local face index in the interaction volume element for the vector \( \boldsymbol \nu \)

Returns: \( \frac{1}{dF} \left(\boldsymbol n^\text{T} k_{r\alpha} \boldsymbol K \boldsymbol \nu \right) \)

◆ getNu()

template<class TypeTag >

DimVector & Dumux::FVMPFAOInteractionVolume< TypeTag >::getNu	(	int	subVolumeIdx,
		int	subVolumeFaceIdxInInside
	)

inline

Get \( \boldsymbol \nu \) vector used for the transmissiblity calculation.

Parameters

subVolumeIdx	The local element index in the interaction volume
subVolumeFaceIdxInInside	The local face index in the interaction volume element

Returns: \( \boldsymbol \nu \) vector

◆ getSubVolumeElement()

template<class TypeTag >

Element Dumux::FVMPFAOInteractionVolume< TypeTag >::getSubVolumeElement ( int subVolumeIdx )

inline

Get an element of the interaction volume.

Parameters

subVolumeIdx The local element index in the interaction volume

Returns: The interaction volume sub-element.

◆ isBoundaryFace()

template<class TypeTag >

bool Dumux::FVMPFAOInteractionVolume< TypeTag >::isBoundaryFace ( int subVolumeFaceIdx )

inline

Returns true if an interaction volume flux face is a boundary face.

Parameters

subVolumeFaceIdx The local face index in the interaction volume

◆ isInnerVolume()

template<class TypeTag >

bool Dumux::FVMPFAOInteractionVolume< TypeTag >::isInnerVolume ( )

inline

Returns true if the interaction volume is completely inside the model domain.

◆ isInsideFace()

template<class TypeTag >

bool Dumux::FVMPFAOInteractionVolume< TypeTag >::isInsideFace ( int subVolumeFaceIdx )

inline

Returns true if an interaction volume flux face is inside the model domain and no boundary face.

Parameters

subVolumeFaceIdx The local face index in the interaction volume

◆ isOutsideFace()

template<class TypeTag >

bool Dumux::FVMPFAOInteractionVolume< TypeTag >::isOutsideFace ( int subVolumeFaceIdx )

inline

Returns true if an interaction volume flux face is outside the model domain.

Parameters

subVolumeFaceIdx The local face index in the interaction volume

◆ isStored()

template<class TypeTag >

bool Dumux::FVMPFAOInteractionVolume< TypeTag >::isStored ( ) const

inline

Returns true if information has already been stored.

◆ setBoundary()

template<class TypeTag >

void Dumux::FVMPFAOInteractionVolume< TypeTag >::setBoundary	(	BoundaryTypes &	boundaryTypes,
		int	subVolumeFaceIdx
	)

inline

Store boundary condtion types for a flux face.

Parameters

boundaryTypes	BoundaryTypes object
subVolumeFaceIdx	The local face index in the interaction volume

◆ setDF()

template<class TypeTag >

void Dumux::FVMPFAOInteractionVolume< TypeTag >::setDF	(	Scalar	dF,
		int	subVolumeIdx
	)

inline

Store the \( dF \) for the transmissiblity calculation.

Parameters

dF	Value of \( dF \)
subVolumeIdx	The local element index in the interaction volume

◆ setDirichletCondition()

template<class TypeTag >

void Dumux::FVMPFAOInteractionVolume< TypeTag >::setDirichletCondition	(	PrimaryVariables &	condition,
		int	subVolumeFaceIdx
	)

inline

Store Dirichlet boundary condtions for a flux face.

Parameters

condition	Vector of primary variables
subVolumeFaceIdx	The local face index in the interaction volume

◆ setFaceArea()

template<class TypeTag >

void Dumux::FVMPFAOInteractionVolume< TypeTag >::setFaceArea	(	Scalar &	faceArea,
		int	subVolumeIdx,
		int	subVolumeFaceIdxInInside
	)

inline

Store a flux face area.

Parameters

faceArea	The flux face area
subVolumeIdx	The local element index in the interaction volume
subVolumeFaceIdxInInside	The local face index in the interaction volume element

◆ setIndexOnElement()

template<class TypeTag >

void Dumux::FVMPFAOInteractionVolume< TypeTag >::setIndexOnElement	(	int	indexInInside,
		int	subVolumeIdx,
		int	subVolumeFaceIdxInInside
	)

inline

Store map from local interaction volume numbering to numbering of the Dune reference element.

Parameters

indexInInside	Face index of the Dune reference element
subVolumeIdx	The local element index in the interaction volume
subVolumeFaceIdxInInside	The local face index in the interaction volume element

◆ setNeumannCondition()

template<class TypeTag >

void Dumux::FVMPFAOInteractionVolume< TypeTag >::setNeumannCondition	(	PrimaryVariables &	condition,
		int	subVolumeFaceIdx
	)

inline

Store Neumann boundary condtions for a flux face.

Parameters

condition	Vector phase fluxes
subVolumeFaceIdx	The local face index in the interaction volume

◆ setNormal()

template<class TypeTag >

void Dumux::FVMPFAOInteractionVolume< TypeTag >::setNormal	(	DimVector &	normal,
		int	subVolumeIdx,
		int	subVolumeFaceIdxInInside
	)

inline

Store a flux face normal.

Parameters

normal	The normal vector
subVolumeIdx	The local element index in the interaction volume
subVolumeFaceIdxInInside	The local face index in the interaction volume element

◆ setOutsideFace()

template<class TypeTag >

void Dumux::FVMPFAOInteractionVolume< TypeTag >::setOutsideFace ( int subVolumeFaceIdx )

inline

Mark a flux face to be outside the model domain.

Parameters

subVolumeFaceIdx The local face index in the interaction volume

◆ setPermTimesNu()

template<class TypeTag >

void Dumux::FVMPFAOInteractionVolume< TypeTag >::setPermTimesNu	(	DimVector &	nu,
		DimMatrix &	perm,
		int	subVolumeIdx,
		int	subVolumeFaceIdxInInside
	)

inline

Store \( \boldsymbol K \boldsymbol \nu\) for the transmissiblity calculation.

Parameters

nu	\( \boldsymbol \nu \) vector
perm	Permeability matrix
subVolumeIdx	The local element index in the interaction volume
subVolumeFaceIdxInInside	The local face index in the interaction volume element

◆ setStored()

template<class TypeTag >

void Dumux::FVMPFAOInteractionVolume< TypeTag >::setStored ( )

inline

Mark storage as completed.

◆ setSubVolumeElement()

template<class TypeTag >

void Dumux::FVMPFAOInteractionVolume< TypeTag >::setSubVolumeElement	(	const Element &	element,
		int	subVolumeIdx
	)

inline

Store an element of the interaction volume.

Parameters

element	The element
subVolumeIdx	The local element index in the interaction volume

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

ointeractionvolume.hh

Description

Public Types

Public Member Functions

Member Enumeration Documentation

◆ FaceTypes

Constructor & Destructor Documentation

◆ FVMPFAOInteractionVolume()

Member Function Documentation

◆ getBoundaryType()

◆ getDirichletValues()

◆ getFaceArea()

◆ getFaceIndexFromSubVolume()

◆ getIndexOnElement()

◆ getNeumannValues()

◆ getNormal()

◆ getNtkNu()

◆ getNtkNu_df()

◆ getNtkrkNu()

◆ getNtkrkNu_df()

◆ getNu()

◆ getSubVolumeElement()

◆ isBoundaryFace()

◆ isInnerVolume()

◆ isInsideFace()

◆ isOutsideFace()

◆ isStored()

◆ setBoundary()

◆ setDF()

◆ setDirichletCondition()

◆ setFaceArea()

◆ setIndexOnElement()

◆ setNeumannCondition()

◆ setNormal()

◆ setOutsideFace()

◆ setPermTimesNu()

◆ setStored()

◆ setSubVolumeElement()