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

Sub control volumes for cell-centered discretization schemes. More...

#include <dumux/discretization/cellcentered/subcontrolvolume.hh>

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

Description

template<class GV, class T = CCDefaultScvGeometryTraits<GV>>
class Dumux::CCSubControlVolume< GV, T >

Sub control volumes for cell-centered discretization schemes.

Template Parameters
GVthe type of the grid view
Tthe scv 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

 CCSubControlVolume ()=default
 
 CCSubControlVolume (GeometryParamType geometry, GridIndexType elementIndex)
 
 CCSubControlVolume (const CCSubControlVolume &other)
 The copy constrcutor. More...
 
 CCSubControlVolume (CCSubControlVolume &&other)=default
 The move constrcutor. More...
 
CCSubControlVolumeoperator= (const CCSubControlVolume &other)
 The copy assignment operator. More...
 
CCSubControlVolumeoperator= (CCSubControlVolume &&other)=default
 The move assignment operator. More...
 
const GlobalPositioncenter () const
 The center of the sub control volume. More...
 
Scalar volume () const
 The volume of the sub control volume. More...
 
const Geometry & geometry () const
 The geometry of the sub control volume. More...
 
GridIndexType dofIndex () const
 The index of the dof this scv is embedded in (the global index of this scv) More...
 
LocalIndexType localDofIndex () const
 The element-local index of the dof this scv is embedded in. More...
 
LocalIndexType indexInElement () const
 
const GlobalPositiondofPosition () const
 
GridIndexType elementIndex () const
 The global index of the element this scv is embedded in. More...
 
GlobalPosition corner (LocalIndexType localIdx) const
 Return the corner for the given local index. More...
 

Member Typedef Documentation

◆ GlobalPosition

template<class GV , class T = CCDefaultScvGeometryTraits<GV>>
using Dumux::CCSubControlVolume< GV, T >::GlobalPosition = typename T::GlobalPosition

export the type used for global coordinates

◆ Traits

template<class GV , class T = CCDefaultScvGeometryTraits<GV>>
using Dumux::CCSubControlVolume< GV, T >::Traits = T

state the traits public and thus export all types

Constructor & Destructor Documentation

◆ CCSubControlVolume() [1/4]

template<class GV , class T = CCDefaultScvGeometryTraits<GV>>
Dumux::CCSubControlVolume< GV, T >::CCSubControlVolume ( )
default

◆ CCSubControlVolume() [2/4]

template<class GV , class T = CCDefaultScvGeometryTraits<GV>>
Dumux::CCSubControlVolume< GV, T >::CCSubControlVolume ( GeometryParamType  geometry,
GridIndexType  elementIndex 
)
inline

◆ CCSubControlVolume() [3/4]

template<class GV , class T = CCDefaultScvGeometryTraits<GV>>
Dumux::CCSubControlVolume< GV, T >::CCSubControlVolume ( const CCSubControlVolume< GV, T > &  other)
inline

The copy constrcutor.

◆ CCSubControlVolume() [4/4]

template<class GV , class T = CCDefaultScvGeometryTraits<GV>>
Dumux::CCSubControlVolume< GV, T >::CCSubControlVolume ( CCSubControlVolume< GV, T > &&  other)
default

The move constrcutor.

Member Function Documentation

◆ center()

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

The center of the sub control volume.

◆ corner()

template<class GV , class T = CCDefaultScvGeometryTraits<GV>>
GlobalPosition Dumux::CCSubControlVolume< GV, T >::corner ( LocalIndexType  localIdx) const
inline

Return the corner for the given local index.

◆ dofIndex()

template<class GV , class T = CCDefaultScvGeometryTraits<GV>>
GridIndexType Dumux::CCSubControlVolume< GV, T >::dofIndex ( ) const
inline

The index of the dof this scv is embedded in (the global index of this scv)

◆ dofPosition()

template<class GV , class T = CCDefaultScvGeometryTraits<GV>>
const GlobalPosition & Dumux::CCSubControlVolume< GV, T >::dofPosition ( ) const
inline

◆ elementIndex()

template<class GV , class T = CCDefaultScvGeometryTraits<GV>>
GridIndexType Dumux::CCSubControlVolume< GV, T >::elementIndex ( ) const
inline

The global index of the element this scv is embedded in.

◆ geometry()

template<class GV , class T = CCDefaultScvGeometryTraits<GV>>
const Geometry & Dumux::CCSubControlVolume< GV, T >::geometry ( ) const
inline

The geometry of the sub control volume.

◆ indexInElement()

template<class GV , class T = CCDefaultScvGeometryTraits<GV>>
LocalIndexType Dumux::CCSubControlVolume< GV, T >::indexInElement ( ) const
inline

The element-local index of this scv. In cell-centered schemes there is always only one scv per element.

◆ localDofIndex()

template<class GV , class T = CCDefaultScvGeometryTraits<GV>>
LocalIndexType Dumux::CCSubControlVolume< GV, T >::localDofIndex ( ) const
inline

The element-local index of the dof this scv is embedded in.

◆ operator=() [1/2]

template<class GV , class T = CCDefaultScvGeometryTraits<GV>>
CCSubControlVolume & Dumux::CCSubControlVolume< GV, T >::operator= ( CCSubControlVolume< GV, T > &&  other)
default

The move assignment operator.

◆ operator=() [2/2]

template<class GV , class T = CCDefaultScvGeometryTraits<GV>>
CCSubControlVolume & Dumux::CCSubControlVolume< GV, T >::operator= ( const CCSubControlVolume< GV, T > &  other)
inline

The copy assignment operator.

◆ volume()

template<class GV , class T = CCDefaultScvGeometryTraits<GV>>
Scalar Dumux::CCSubControlVolume< GV, T >::volume ( ) const
inline

The volume of the sub control volume.


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