version 3.9-dev
Public Types | Public Member Functions | List of all members
Dumux::BoxFacetCouplingSubControlVolumeFace< GV, T > Class Template Reference
Multidomain framework » Conforming mixed-dimension facet coupling mode

Class for a sub control volume face in the box method, i.e a part of the boundary of a sub control volume we compute fluxes on. This is a specialization for models considering coupling of different domains across the bulk grid facets. More...

#include <dumux/multidomain/facet/box/subcontrolvolumeface.hh>

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

Description

template<class GV, class T = BoxDefaultScvfGeometryTraits<GV>>
class Dumux::BoxFacetCouplingSubControlVolumeFace< GV, T >
Template Parameters
GVthe type of the grid view
Tthe 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

 BoxFacetCouplingSubControlVolumeFace ()=default
 The default constructor. More...
 
template<class GeometryHelper , class Element >
 BoxFacetCouplingSubControlVolumeFace (const GeometryHelper &geometryHelper, const Element &element, const typename Element::Geometry &elemGeometry, unsigned int scvfIndex, std::vector< LocalIndexType > &&scvIndices)
 Constructor for inner scvfs. More...
 
template<class GeometryHelper , class Intersection >
 BoxFacetCouplingSubControlVolumeFace (const GeometryHelper &geometryHelper, const Intersection &intersection, const typename Intersection::Geometry &isGeometry, LocalIndexType indexInIntersection, GridIndexType scvfIndex, std::vector< LocalIndexType > &&scvIndices, bool boundary, bool interiorBoundary)
 Constructor for domain or interior 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 boundary () const
 returns true if the sub control volume face is on the boundary More...
 
bool interiorBoundary () const
 returns true if the sub control volume face is on an interior boundary More...
 
const GlobalPosition & unitOuterNormal () const
 
LocalIndexType insideScvIdx () const
 index of the inside sub control volume More...
 
GridIndexType index () const
 The element-local index of this sub control volume face. More...
 
LocalIndexType outsideScvIdx (int i=0) const
 Index of the i-th outside sub control volume or boundary scv index. More...
 
std::size_t numOutsideScvs () const
 The number of scvs on the outside of this face. More...
 
LocalIndexType facetIndexInElement () const
 
LocalIndexType indexInElementFacet () const
 
Geometry geometry () const
 The geometry of the sub control volume face. More...
 
BoundaryFlag::value_type boundaryFlag () const
 Return the boundary flag. More...
 

Member Typedef Documentation

◆ GlobalPosition

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
using Dumux::BoxFacetCouplingSubControlVolumeFace< GV, T >::GlobalPosition = typename T::GlobalPosition

◆ Traits

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
using Dumux::BoxFacetCouplingSubControlVolumeFace< GV, T >::Traits = T

Constructor & Destructor Documentation

◆ BoxFacetCouplingSubControlVolumeFace() [1/3]

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
Dumux::BoxFacetCouplingSubControlVolumeFace< GV, T >::BoxFacetCouplingSubControlVolumeFace ( )
default

◆ BoxFacetCouplingSubControlVolumeFace() [2/3]

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
template<class GeometryHelper , class Element >
Dumux::BoxFacetCouplingSubControlVolumeFace< GV, T >::BoxFacetCouplingSubControlVolumeFace ( const GeometryHelper &  geometryHelper,
const Element &  element,
const typename Element::Geometry &  elemGeometry,
unsigned int  scvfIndex,
std::vector< LocalIndexType > &&  scvIndices 
)
inline

◆ BoxFacetCouplingSubControlVolumeFace() [3/3]

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
template<class GeometryHelper , class Intersection >
Dumux::BoxFacetCouplingSubControlVolumeFace< GV, T >::BoxFacetCouplingSubControlVolumeFace ( const GeometryHelper &  geometryHelper,
const Intersection &  intersection,
const typename Intersection::Geometry &  isGeometry,
LocalIndexType  indexInIntersection,
GridIndexType  scvfIndex,
std::vector< LocalIndexType > &&  scvIndices,
bool  boundary,
bool  interiorBoundary 
)
inline

Member Function Documentation

◆ area()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
Scalar Dumux::BoxFacetCouplingSubControlVolumeFace< GV, T >::area ( ) const
inline

◆ boundary()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
bool Dumux::BoxFacetCouplingSubControlVolumeFace< GV, T >::boundary ( ) const
inline

◆ boundaryFlag()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
BoundaryFlag::value_type Dumux::BoxFacetCouplingSubControlVolumeFace< GV, T >::boundaryFlag ( ) const
inline

◆ center()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
const GlobalPosition & Dumux::BoxFacetCouplingSubControlVolumeFace< GV, T >::center ( ) const
inline

◆ facetIndexInElement()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
LocalIndexType Dumux::BoxFacetCouplingSubControlVolumeFace< GV, T >::facetIndexInElement ( ) const
inline

returns the element-local index of the facet this scvf is embedded in. This is only valid to be called for scvfs on domain/interior boundaries.

◆ geometry()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
Geometry Dumux::BoxFacetCouplingSubControlVolumeFace< GV, T >::geometry ( ) const
inline

◆ index()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
GridIndexType Dumux::BoxFacetCouplingSubControlVolumeFace< GV, T >::index ( ) const
inline

◆ indexInElementFacet()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
LocalIndexType Dumux::BoxFacetCouplingSubControlVolumeFace< GV, T >::indexInElementFacet ( ) const
inline

returns the facet-local (intersection-local) index of this scvf. This is only valid to be called for scvfs on domain/interior boundaries.

◆ insideScvIdx()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
LocalIndexType Dumux::BoxFacetCouplingSubControlVolumeFace< GV, T >::insideScvIdx ( ) const
inline

◆ interiorBoundary()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
bool Dumux::BoxFacetCouplingSubControlVolumeFace< GV, T >::interiorBoundary ( ) const
inline

◆ ipGlobal()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
const GlobalPosition & Dumux::BoxFacetCouplingSubControlVolumeFace< GV, T >::ipGlobal ( ) const
inline

◆ numOutsideScvs()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
std::size_t Dumux::BoxFacetCouplingSubControlVolumeFace< GV, T >::numOutsideScvs ( ) const
inline

◆ outsideScvIdx()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
LocalIndexType Dumux::BoxFacetCouplingSubControlVolumeFace< GV, T >::outsideScvIdx ( int  i = 0) const
inline

◆ unitOuterNormal()

template<class GV , class T = BoxDefaultScvfGeometryTraits<GV>>
const GlobalPosition & Dumux::BoxFacetCouplingSubControlVolumeFace< GV, T >::unitOuterNormal ( ) const
inline

returns the unit nurmal vector pointing outwards of the sub-control volume that this scvf encloses

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