Dumux::CCMpfaOFacetCouplingInteractionVolumeLocalScvf< IvIndexSet > Struct Template Reference

Class for the interaction volume-local sub-control volume face used in the mpfa-o scheme in the context of facet coupling. More...

#include <dumux/multidomain/facet/cellcentered/mpfa/localsubcontrolentities.hh>

Inheritance diagram for Dumux::CCMpfaOFacetCouplingInteractionVolumeLocalScvf< IvIndexSet >:

Description

template<class IvIndexSet>
struct Dumux::CCMpfaOFacetCouplingInteractionVolumeLocalScvf< IvIndexSet >

Class for the interaction volume-local sub-control volume face used in the mpfa-o scheme in the context of facet coupling.

Template Parameters

IvIndexSet

The type used for index sets within interaction volumes

Public Types
using	ParentType = CCMpfaOInteractionVolumeLocalScvf< IvIndexSet >
using	ScvfNeighborLocalIndexSet = typename IvIndexSet::ScvfNeighborLocalIndexSet
using	LocalIndexType = typename IvIndexSet::LocalIndexType
using	GridIndexType = typename IvIndexSet::GridIndexType

Public Member Functions
template<class SubControlVolumeFace >
	CCMpfaOFacetCouplingInteractionVolumeLocalScvf (const SubControlVolumeFace &scvf, const ScvfNeighborLocalIndexSet &localScvIndices, const LocalIndexType localDofIdx, const bool isDirichlet, const LocalIndexType coupledFacetLocalDof)
	The constructor for interior boundary faces. More...
LocalIndexType	coupledFacetLocalDofIndex () const
	Returns the iv-local dof index of the coupled facet element. More...
const ScvfNeighborLocalIndexSet &	neighboringLocalScvIndices () const
	Returns the local indices of the scvs neighboring this scvf. More...
bool	isOnInteriorBoundary () const
	Returns true if this face is on an interior boundary. More...
LocalIndexType	localDofIndex () const
GridIndexType	gridScvfIndex () const
	returns the grid view-global index of this scvf More...
bool	isDirichlet () const
	states if this is scvf is on a Dirichlet boundary More...

Member Typedef Documentation

GridIndexType

template<class IvIndexSet >

using Dumux::CCMpfaOInteractionVolumeLocalScvf< IvIndexSet >::GridIndexType = typename IvIndexSet::GridIndexType

LocalIndexType

template<class IvIndexSet >

using Dumux::CCMpfaOInteractionVolumeLocalScvf< IvIndexSet >::LocalIndexType = typename IvIndexSet::LocalIndexType

ParentType

template<class IvIndexSet >

using Dumux::CCMpfaOFacetCouplingInteractionVolumeLocalScvf< IvIndexSet >::ParentType = CCMpfaOInteractionVolumeLocalScvf< IvIndexSet >

ScvfNeighborLocalIndexSet

template<class IvIndexSet >

using Dumux::CCMpfaOFacetCouplingInteractionVolumeLocalScvf< IvIndexSet >::ScvfNeighborLocalIndexSet = typename IvIndexSet::ScvfNeighborLocalIndexSet

Constructor & Destructor Documentation

CCMpfaOFacetCouplingInteractionVolumeLocalScvf()

template<class IvIndexSet >

template<class SubControlVolumeFace >

Dumux::CCMpfaOFacetCouplingInteractionVolumeLocalScvf< IvIndexSet >::CCMpfaOFacetCouplingInteractionVolumeLocalScvf ( const SubControlVolumeFace &  scvf, const ScvfNeighborLocalIndexSet &  localScvIndices, const LocalIndexType  localDofIdx, const bool  isDirichlet, const LocalIndexType  coupledFacetLocalDof  )

inline

The constructor for interior boundary faces.

Parameters

scvf	The grid sub-control volume face
localScvIndices	The iv-local neighboring scv indices
localDofIdx	This scvf's interaction volume-local dof index
isDirichlet	Specifies if this scv is on a Dirichlet boundary
coupledFacetLocalDof	The local index of the coupled facet element in the set of cell&Dirichlet values.

Member Function Documentation

coupledFacetLocalDofIndex()

template<class IvIndexSet >

LocalIndexType Dumux::CCMpfaOFacetCouplingInteractionVolumeLocalScvf< IvIndexSet >::coupledFacetLocalDofIndex ( ) const

inline

Returns the iv-local dof index of the coupled facet element.

gridScvfIndex()

template<class IvIndexSet >

GridIndexType Dumux::CCMpfaOInteractionVolumeLocalScvf< IvIndexSet >::gridScvfIndex ( ) const

inlineinherited

returns the grid view-global index of this scvf

isDirichlet()

template<class IvIndexSet >

bool Dumux::CCMpfaOInteractionVolumeLocalScvf< IvIndexSet >::isDirichlet ( ) const

inlineinherited

states if this is scvf is on a Dirichlet boundary

isOnInteriorBoundary()

template<class IvIndexSet >

bool Dumux::CCMpfaOFacetCouplingInteractionVolumeLocalScvf< IvIndexSet >::isOnInteriorBoundary ( ) const

inline

Returns true if this face is on an interior boundary.

localDofIndex()

template<class IvIndexSet >

LocalIndexType Dumux::CCMpfaOInteractionVolumeLocalScvf< IvIndexSet >::localDofIndex ( ) const

inlineinherited

This is either the iv-local index of the intermediate unknown (interior/Neumann face) or the index of the Dirichlet boundary within the vol vars (Dirichlet faces)

neighboringLocalScvIndices()

template<class IvIndexSet >

const ScvfNeighborLocalIndexSet & Dumux::CCMpfaOFacetCouplingInteractionVolumeLocalScvf< IvIndexSet >::neighboringLocalScvIndices ( ) const

inline

Returns the local indices of the scvs neighboring this scvf.

---

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

• multidomain/facet/cellcentered/mpfa/localsubcontrolentities.hh