version 3.9-dev
Dumux::CCTpfaSubControlVolumeFace< GV, T > Class Template Reference

The sub control volume face. More...

#include <dumux/discretization/cellcentered/tpfa/subcontrolvolumeface.hh>

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

Description

template<class GV, class T = CCTpfaDefaultScvfGeometryTraits<GV>>
class Dumux::CCTpfaSubControlVolumeFace< 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

 CCTpfaSubControlVolumeFace ()=default
 
template<class Intersection >
 CCTpfaSubControlVolumeFace (const Intersection &is, const typename Intersection::Geometry &isGeometry, GridIndexType scvfIndex, const GridIndexStorage &scvIndices, bool isBoundary)
 Constructor with intersection. More...
 
const GlobalPositioncenter () const
 The center of the sub control volume face. More...
 
const GlobalPositionipGlobal () 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...
 
const GlobalPositionunitOuterNormal () const
 The unit outer normal of the sub control volume face. More...
 
GridIndexType insideScvIdx () const
 index of the inside sub control volume More...
 
GridIndexType 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...
 
GridIndexType index () const
 The global index of this sub control volume face. More...
 
BoundaryFlag::value_type boundaryFlag () const
 Return the boundary flag. More...
 

Member Typedef Documentation

◆ GlobalPosition

template<class GV , class T = CCTpfaDefaultScvfGeometryTraits<GV>>
using Dumux::CCTpfaSubControlVolumeFace< GV, T >::GlobalPosition = typename T::GlobalPosition

◆ Traits

template<class GV , class T = CCTpfaDefaultScvfGeometryTraits<GV>>
using Dumux::CCTpfaSubControlVolumeFace< GV, T >::Traits = T

Constructor & Destructor Documentation

◆ CCTpfaSubControlVolumeFace() [1/2]

template<class GV , class T = CCTpfaDefaultScvfGeometryTraits<GV>>
Dumux::CCTpfaSubControlVolumeFace< GV, T >::CCTpfaSubControlVolumeFace ( )
default

◆ CCTpfaSubControlVolumeFace() [2/2]

template<class GV , class T = CCTpfaDefaultScvfGeometryTraits<GV>>
template<class Intersection >
Dumux::CCTpfaSubControlVolumeFace< GV, T >::CCTpfaSubControlVolumeFace ( const Intersection &  is,
const typename Intersection::Geometry &  isGeometry,
GridIndexType  scvfIndex,
const GridIndexStorage &  scvIndices,
bool  isBoundary 
)
inline
Parameters
isThe intersection
isGeometryThe geometry of the intersection
scvfIndexThe global index of this scv face
scvIndicesThe inside/outside scv indices connected to this face
isBoundaryBool to specify whether or not the scvf is on an interior or the domain boundary

Member Function Documentation

◆ area()

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

◆ boundary()

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

◆ boundaryFlag()

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

◆ center()

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

◆ index()

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

◆ insideScvIdx()

template<class GV , class T = CCTpfaDefaultScvfGeometryTraits<GV>>
GridIndexType Dumux::CCTpfaSubControlVolumeFace< GV, T >::insideScvIdx ( ) const
inline

◆ ipGlobal()

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

◆ numOutsideScvs()

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

◆ outsideScvIdx()

template<class GV , class T = CCTpfaDefaultScvfGeometryTraits<GV>>
GridIndexType Dumux::CCTpfaSubControlVolumeFace< GV, T >::outsideScvIdx ( int  i = 0) const
inline

◆ unitOuterNormal()

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

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