Class for a sub control volume face in the cvfe method, i.e a part of the boundary of a sub control volume we compute fluxes on. We simply use the base class here. More...

#include <dumux/discretization/pq1bubble/subcontrolvolumeface.hh>

Inheritance diagram for Dumux::PQ1BubbleSubControlVolumeFace< GV, T >:

Description

template<class GV, class T = PQ1BubbleDefaultScvfGeometryTraits<GV>>
class Dumux::PQ1BubbleSubControlVolumeFace< GV, T >

Class for a sub control volume face in the cvfe method, i.e a part of the boundary of a sub control volume we compute fluxes on. We simply use the base class here.

Template Parameters

GV	the type of the grid view
T	the scvf geometry traits

Public Types
using	GlobalPosition = typename T::GlobalPosition
	export the type used for global coordinates More...

using	Traits = T
	state the traits public and thus export all types More...

Public Member Functions
	PQ1BubbleSubControlVolumeFace ()=default
	The default constructor. More...

	PQ1BubbleSubControlVolumeFace (const GlobalPosition &center, const Scalar area, const GlobalPosition &normal, const std::array< LocalIndexType, 2 > &scvIndices, const LocalIndexType localScvfIdx, bool overlapping=false)
	Constructor for inner scvfs. More...

	PQ1BubbleSubControlVolumeFace (const GlobalPosition &center, const Scalar area, const GlobalPosition &normal, const std::array< LocalIndexType, 2 > &scvIndices, const LocalIndexType localScvfIdx, const BoundaryFlag &bFlag, bool overlapping=false)
	Constructor for boundary scvfs. More...

const GlobalPosition &	center () const
	The center of the sub control volume face. More...

const GlobalPosition &	ipGlobal () const
	The integration point for flux evaluations in global coordinates. More...

Scalar	area () const
	The area of the sub control volume face. More...

bool	isOverlapping () const
	returns true if the sub control volume face is overlapping with another scv More...

bool	boundary () const

const GlobalPosition	unitOuterNormal () const
	The unit outer normal. More...

GridIndexType	insideScvIdx () const
	Index of the inside sub control volume. More...

GridIndexType	outsideScvIdx () const
	index of the outside sub control volume More...

std::size_t	numOutsideScvs () const
	The number of scvs on the outside of this face. More...

LocalIndexType	index () const
	The local index of this sub control volume face. More...

BoundaryFlag::value_type	boundaryFlag () const
	Return the boundary flag. More...

GridIndexType	outsideScvIdx (int i=0) const

Member Typedef Documentation

◆ GlobalPosition

template<class GV , class T = PQ1BubbleDefaultScvfGeometryTraits<GV>>

using Dumux::PQ1BubbleSubControlVolumeFace< GV, T >::GlobalPosition = typename T::GlobalPosition

export the type used for global coordinates

◆ Traits

template<class GV , class T = PQ1BubbleDefaultScvfGeometryTraits<GV>>

using Dumux::PQ1BubbleSubControlVolumeFace< GV, T >::Traits = T

state the traits public and thus export all types

Constructor & Destructor Documentation

◆ PQ1BubbleSubControlVolumeFace() [1/3]

template<class GV , class T = PQ1BubbleDefaultScvfGeometryTraits<GV>>

Dumux::PQ1BubbleSubControlVolumeFace< GV, T >::PQ1BubbleSubControlVolumeFace ( )

default

The default constructor.

◆ PQ1BubbleSubControlVolumeFace() [2/3]

template<class GV , class T = PQ1BubbleDefaultScvfGeometryTraits<GV>>

Dumux::PQ1BubbleSubControlVolumeFace< GV, T >::PQ1BubbleSubControlVolumeFace	(	const GlobalPosition &	center,
		const Scalar	area,
		const GlobalPosition &	normal,
		const std::array< LocalIndexType, 2 > &	scvIndices,
		const LocalIndexType	localScvfIdx,
		bool	overlapping = `false`
	)

inline

Constructor for inner scvfs.

◆ PQ1BubbleSubControlVolumeFace() [3/3]

template<class GV , class T = PQ1BubbleDefaultScvfGeometryTraits<GV>>

Dumux::PQ1BubbleSubControlVolumeFace< GV, T >::PQ1BubbleSubControlVolumeFace	(	const GlobalPosition &	center,
		const Scalar	area,
		const GlobalPosition &	normal,
		const std::array< LocalIndexType, 2 > &	scvIndices,
		const LocalIndexType	localScvfIdx,
		const BoundaryFlag &	bFlag,
		bool	overlapping = `false`
	)

inline

Constructor for boundary scvfs.

Member Function Documentation

◆ area()

template<class GV , class T = PQ1BubbleDefaultScvfGeometryTraits<GV>>

Scalar Dumux::PQ1BubbleSubControlVolumeFace< GV, T >::area ( ) const

inline

The area of the sub control volume face.

◆ boundary()

template<class GV , class T = PQ1BubbleDefaultScvfGeometryTraits<GV>>

bool Dumux::PQ1BubbleSubControlVolumeFace< GV, T >::boundary ( ) const

inline

◆ boundaryFlag()

template<class GV , class T = PQ1BubbleDefaultScvfGeometryTraits<GV>>

BoundaryFlag::value_type Dumux::PQ1BubbleSubControlVolumeFace< GV, T >::boundaryFlag ( ) const

inline

Return the boundary flag.

◆ center()

template<class GV , class T = PQ1BubbleDefaultScvfGeometryTraits<GV>>

const GlobalPosition & Dumux::PQ1BubbleSubControlVolumeFace< GV, T >::center ( ) const

inline

The center of the sub control volume face.

◆ index()

template<class GV , class T = PQ1BubbleDefaultScvfGeometryTraits<GV>>

LocalIndexType Dumux::PQ1BubbleSubControlVolumeFace< GV, T >::index ( ) const

inline

The local index of this sub control volume face.

◆ insideScvIdx()

template<class GV , class T = PQ1BubbleDefaultScvfGeometryTraits<GV>>

GridIndexType Dumux::PQ1BubbleSubControlVolumeFace< GV, T >::insideScvIdx ( ) const

inline

Index of the inside sub control volume.

◆ ipGlobal()

template<class GV , class T = PQ1BubbleDefaultScvfGeometryTraits<GV>>

const GlobalPosition & Dumux::PQ1BubbleSubControlVolumeFace< GV, T >::ipGlobal ( ) const

inline

The integration point for flux evaluations in global coordinates.

◆ isOverlapping()

template<class GV , class T = PQ1BubbleDefaultScvfGeometryTraits<GV>>

bool Dumux::PQ1BubbleSubControlVolumeFace< GV, T >::isOverlapping ( ) const

inline

returns true if the sub control volume face is overlapping with another scv

◆ numOutsideScvs()

template<class GV , class T = PQ1BubbleDefaultScvfGeometryTraits<GV>>

std::size_t Dumux::PQ1BubbleSubControlVolumeFace< GV, T >::numOutsideScvs ( ) const

inline

The number of scvs on the outside of this face.

◆ outsideScvIdx() [1/2]

template<class GV , class T = PQ1BubbleDefaultScvfGeometryTraits<GV>>

GridIndexType Dumux::PQ1BubbleSubControlVolumeFace< GV, T >::outsideScvIdx ( ) const

inline

index of the outside sub control volume

◆ outsideScvIdx() [2/2]

GridIndexType Dumux::SubControlVolumeFaceBase< PQ1BubbleSubControlVolumeFace< GV, PQ1BubbleDefaultScvfGeometryTraits< GV > > , PQ1BubbleDefaultScvfGeometryTraits< GV > >::outsideScvIdx ( int i = 0 ) const

inlineinherited

index of the outside sub control volume for spatial param evaluation This results in undefined behaviour if boundary is true In case of multiple outside scv indices (network grids) an index can be supplied

◆ unitOuterNormal()

template<class GV , class T = PQ1BubbleDefaultScvfGeometryTraits<GV>>

const GlobalPosition Dumux::PQ1BubbleSubControlVolumeFace< GV, T >::unitOuterNormal ( ) const

inline

The unit outer normal.

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

discretization/pq1bubble/subcontrolvolumeface.hh

Description

Public Types

Public Member Functions

Member Typedef Documentation

◆ GlobalPosition

◆ Traits

Constructor & Destructor Documentation

◆ PQ1BubbleSubControlVolumeFace() [1/3]

◆ PQ1BubbleSubControlVolumeFace() [2/3]

◆ PQ1BubbleSubControlVolumeFace() [3/3]

Member Function Documentation

◆ area()

◆ boundary()

◆ boundaryFlag()

◆ center()

◆ index()

◆ insideScvIdx()

◆ ipGlobal()

◆ isOverlapping()

◆ numOutsideScvs()

◆ outsideScvIdx() [1/2]

◆ outsideScvIdx() [2/2]

◆ unitOuterNormal()