3.5-git
DUNE for Multi-{Phase, Component, Scale, Physics, ...} flow and transport in porous media
Public Types | Public Member Functions | List of all members
Dumux::CCMpfaOInteractionVolumeLocalScvf< IvIndexSet > Struct Template Reference

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

#include <dumux/discretization/cellcentered/mpfa/omethod/localsubcontrolentities.hh>

Inheritance diagram for Dumux::CCMpfaOInteractionVolumeLocalScvf< IvIndexSet >:

Description

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

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

Template Parameters
IvIndexSetThe type used for index sets within interaction volumes

Public Types

using ScvfNeighborLocalIndexSet = typename IvIndexSet::ScvfNeighborLocalIndexSet
 
using GridIndexType = typename IvIndexSet::GridIndexType
 
using LocalIndexType = typename IvIndexSet::LocalIndexType
 

Public Member Functions

 CCMpfaOInteractionVolumeLocalScvf ()=default
 The default constructor. More...
 
template<class SubControlVolumeFace >
 CCMpfaOInteractionVolumeLocalScvf (const SubControlVolumeFace &scvf, const ScvfNeighborLocalIndexSet &localScvIndices, const LocalIndexType localDofIdx, const bool isDirichlet)
 The constructor. More...
 
LocalIndexType localDofIndex () const
 
GridIndexType gridScvfIndex () const
 returns the grid view-global index of this scvf More...
 
const ScvfNeighborLocalIndexSetneighboringLocalScvIndices () const
 Returns the local indices of the scvs neighboring 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

◆ ScvfNeighborLocalIndexSet

template<class IvIndexSet >
using Dumux::CCMpfaOInteractionVolumeLocalScvf< IvIndexSet >::ScvfNeighborLocalIndexSet = typename IvIndexSet::ScvfNeighborLocalIndexSet

Constructor & Destructor Documentation

◆ CCMpfaOInteractionVolumeLocalScvf() [1/2]

template<class IvIndexSet >
Dumux::CCMpfaOInteractionVolumeLocalScvf< IvIndexSet >::CCMpfaOInteractionVolumeLocalScvf ( )
default

The default constructor.

◆ CCMpfaOInteractionVolumeLocalScvf() [2/2]

template<class IvIndexSet >
template<class SubControlVolumeFace >
Dumux::CCMpfaOInteractionVolumeLocalScvf< IvIndexSet >::CCMpfaOInteractionVolumeLocalScvf ( const SubControlVolumeFace &  scvf,
const ScvfNeighborLocalIndexSet localScvIndices,
const LocalIndexType  localDofIdx,
const bool  isDirichlet 
)
inline

The constructor.

Parameters
scvfThe grid sub-control volume face
localScvIndicesThe iv-local neighboring scv indices
localDofIdxThis scvf's interaction volume-local dof index
isDirichletSpecifies if this scv is on a Dirichlet boundary

Member Function Documentation

◆ gridScvfIndex()

template<class IvIndexSet >
GridIndexType Dumux::CCMpfaOInteractionVolumeLocalScvf< IvIndexSet >::gridScvfIndex ( ) const
inline

returns the grid view-global index of this scvf

◆ isDirichlet()

template<class IvIndexSet >
bool Dumux::CCMpfaOInteractionVolumeLocalScvf< IvIndexSet >::isDirichlet ( ) const
inline

states if this is scvf is on a Dirichlet boundary

◆ localDofIndex()

template<class IvIndexSet >
LocalIndexType Dumux::CCMpfaOInteractionVolumeLocalScvf< IvIndexSet >::localDofIndex ( ) const
inline

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::CCMpfaOInteractionVolumeLocalScvf< 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: