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::PoreNetwork::PNMSubControlVolumeFace< GV, T > Class Template Reference

Class for a sub control volume face for porenetworks. More...

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

Inheritance diagram for Dumux::PoreNetwork::PNMSubControlVolumeFace< GV, T >:

Description

template<class GV, class T = PNMDefaultScvfGeometryTraits<GV>>
class Dumux::PoreNetwork::PNMSubControlVolumeFace< GV, T >

Class for a sub control volume face for porenetworks.

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

 PNMSubControlVolumeFace ()=default
 The default constructor. More...
 
 PNMSubControlVolumeFace (const GlobalPosition &center, const GlobalPosition &unitOuterNormal, const Scalar &area, GridIndexType scvfIndex, std::array< LocalIndexType, 2 > &&scvIndices)
 Constructor for inner scvfs. 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
 We assume to always have a pore body and not a pore throat at the boundary. More...
 
const GlobalPositionunitOuterNormal () const
 The unit outer normal of the sub control volume face. More...
 
LocalIndexType insideScvIdx () const
 Index of the inside sub control volume for spatial param evaluation. More...
 
LocalIndexType outsideScvIdx () const
 Index of the outside sub control volume for spatial param evaluation. More...
 
GridIndexType index () const
 The local index of this sub control volume face. More...
 
GridIndexType outsideScvIdx (int i=0) const
 

Member Typedef Documentation

◆ GlobalPosition

template<class GV , class T = PNMDefaultScvfGeometryTraits<GV>>
using Dumux::PoreNetwork::PNMSubControlVolumeFace< GV, T >::GlobalPosition = typename T::GlobalPosition

export the type used for global coordinates

◆ Traits

template<class GV , class T = PNMDefaultScvfGeometryTraits<GV>>
using Dumux::PoreNetwork::PNMSubControlVolumeFace< GV, T >::Traits = T

state the traits public and thus export all types

Constructor & Destructor Documentation

◆ PNMSubControlVolumeFace() [1/2]

template<class GV , class T = PNMDefaultScvfGeometryTraits<GV>>
Dumux::PoreNetwork::PNMSubControlVolumeFace< GV, T >::PNMSubControlVolumeFace ( )
default

The default constructor.

◆ PNMSubControlVolumeFace() [2/2]

template<class GV , class T = PNMDefaultScvfGeometryTraits<GV>>
Dumux::PoreNetwork::PNMSubControlVolumeFace< GV, T >::PNMSubControlVolumeFace ( const GlobalPosition center,
const GlobalPosition unitOuterNormal,
const Scalar &  area,
GridIndexType  scvfIndex,
std::array< LocalIndexType, 2 > &&  scvIndices 
)
inline

Constructor for inner scvfs.

Member Function Documentation

◆ area()

template<class GV , class T = PNMDefaultScvfGeometryTraits<GV>>
Scalar Dumux::PoreNetwork::PNMSubControlVolumeFace< GV, T >::area ( ) const
inline

The area of the sub control volume face.

◆ boundary()

template<class GV , class T = PNMDefaultScvfGeometryTraits<GV>>
bool Dumux::PoreNetwork::PNMSubControlVolumeFace< GV, T >::boundary ( ) const
inline

We assume to always have a pore body and not a pore throat at the boundary.

◆ center()

template<class GV , class T = PNMDefaultScvfGeometryTraits<GV>>
const GlobalPosition & Dumux::PoreNetwork::PNMSubControlVolumeFace< GV, T >::center ( ) const
inline

The center of the sub control volume face.

◆ index()

template<class GV , class T = PNMDefaultScvfGeometryTraits<GV>>
GridIndexType Dumux::PoreNetwork::PNMSubControlVolumeFace< GV, T >::index ( ) const
inline

The local index of this sub control volume face.

◆ insideScvIdx()

template<class GV , class T = PNMDefaultScvfGeometryTraits<GV>>
LocalIndexType Dumux::PoreNetwork::PNMSubControlVolumeFace< GV, T >::insideScvIdx ( ) const
inline

Index of the inside sub control volume for spatial param evaluation.

◆ ipGlobal()

template<class GV , class T = PNMDefaultScvfGeometryTraits<GV>>
const GlobalPosition & Dumux::PoreNetwork::PNMSubControlVolumeFace< GV, T >::ipGlobal ( ) const
inline

The integration point for flux evaluations in global coordinates.

◆ outsideScvIdx() [1/2]

template<class GV , class T = PNMDefaultScvfGeometryTraits<GV>>
LocalIndexType Dumux::PoreNetwork::PNMSubControlVolumeFace< GV, T >::outsideScvIdx ( ) const
inline

Index of the outside sub control volume for spatial param evaluation.

◆ outsideScvIdx() [2/2]

GridIndexType Dumux::SubControlVolumeFaceBase< PNMSubControlVolumeFace< GV, PNMDefaultScvfGeometryTraits< GV > > , PNMDefaultScvfGeometryTraits< 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 = PNMDefaultScvfGeometryTraits<GV>>
const GlobalPosition & Dumux::PoreNetwork::PNMSubControlVolumeFace< GV, T >::unitOuterNormal ( ) const
inline

The unit outer normal of the sub control volume face.


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