Public Types | Public Member Functions | Protected Attributes | List of all members
Opm::GIE::Face< GI > Class Template Reference

#include <GridInterfaceEuler.hpp>

Inheritance diagram for Opm::GIE::Face< GI >:
Inheritance graph

Public Types

enum  { BoundaryMarkerIndex = -999 , LocalEndIndex = INT_MAX }
 
typedef GI::DuneIntersectionIterator DuneIntersectionIter
 
typedef GI::GridType::template Codim< 0 >::EntityPointer CellPtr
 
typedef GI::GridType::ctype Scalar
 
typedef Dune::FieldVector< Scalar, GI::GridType::dimension > Vector
 
typedef Dune::FieldVector< Scalar, GI::GridType::dimension-1 > LocalVector
 
typedef int Index
 
typedef GIE::Cell< GI, CellPtr > Cell
 

Public Member Functions

 Face ()
 
 Face (const GI &grid, const DuneIntersectionIter &it, const Index loc_ind)
 
Scalar area () const
 
Vector centroid () const
 
Vector normal () const
 
bool boundary () const
 
int boundaryId () const
 
Cell cell () const
 
Index cellIndex () const
 
Cell neighbourCell () const
 
Index neighbourCellIndex () const
 
Index index () const
 
Index localIndex () const
 
Scalar neighbourCellVolume () const
 

Protected Attributes

const GI * pgrid_
 
DuneIntersectionIter iter_
 
Index local_index_
 

Member Typedef Documentation

◆ Cell

template<class GI >
typedef GIE::Cell<GI, CellPtr> Opm::GIE::Face< GI >::Cell

◆ CellPtr

template<class GI >
typedef GI::GridType::template Codim<0>::EntityPointer Opm::GIE::Face< GI >::CellPtr

◆ DuneIntersectionIter

template<class GI >
typedef GI::DuneIntersectionIterator Opm::GIE::Face< GI >::DuneIntersectionIter

◆ Index

template<class GI >
typedef int Opm::GIE::Face< GI >::Index

◆ LocalVector

template<class GI >
typedef Dune::FieldVector<Scalar, GI::GridType::dimension-1> Opm::GIE::Face< GI >::LocalVector

◆ Scalar

template<class GI >
typedef GI::GridType::ctype Opm::GIE::Face< GI >::Scalar

◆ Vector

template<class GI >
typedef Dune::FieldVector<Scalar, GI::GridType::dimension> Opm::GIE::Face< GI >::Vector

Member Enumeration Documentation

◆ anonymous enum

template<class GI >
anonymous enum
Enumerator
BoundaryMarkerIndex 
LocalEndIndex 

Constructor & Destructor Documentation

◆ Face() [1/2]

template<class GI >
Opm::GIE::Face< GI >::Face ( )
inline

◆ Face() [2/2]

template<class GI >
Opm::GIE::Face< GI >::Face ( const GI &  grid,
const DuneIntersectionIter &  it,
const Index  loc_ind 
)
inline

Member Function Documentation

◆ area()

template<class GI >
Scalar Opm::GIE::Face< GI >::area ( ) const
inline
Returns

References Opm::GIE::Face< GI >::iter_.

◆ boundary()

template<class GI >
bool Opm::GIE::Face< GI >::boundary ( ) const
inline
Returns

References Opm::GIE::Face< GI >::iter_.

◆ boundaryId()

template<class GI >
int Opm::GIE::Face< GI >::boundaryId ( ) const
inline
Returns

References Opm::GIE::Face< GI >::iter_.

◆ cell()

template<class GI >
Cell Opm::GIE::Face< GI >::cell ( ) const
inline
Returns

References Opm::GIE::Face< GI >::iter_, and Opm::GIE::Face< GI >::pgrid_.

◆ cellIndex()

template<class GI >
Index Opm::GIE::Face< GI >::cellIndex ( ) const
inline
Returns

References Opm::GIE::Face< GI >::iter_, and Opm::GIE::Face< GI >::pgrid_.

Referenced by Opm::GIE::Face< GI >::index().

◆ centroid()

template<class GI >
Vector Opm::GIE::Face< GI >::centroid ( ) const
inline
Returns

References Opm::GIE::Face< GI >::iter_.

◆ index()

template<class GI >
Index Opm::GIE::Face< GI >::index ( ) const
inline
Returns

References Opm::GIE::Face< GI >::cellIndex(), Opm::GIE::Face< GI >::localIndex(), and Opm::GIE::Face< GI >::pgrid_.

◆ localIndex()

template<class GI >
Index Opm::GIE::Face< GI >::localIndex ( ) const
inline
Returns

References Opm::GIE::Face< GI >::local_index_.

Referenced by Opm::GIE::Face< GI >::index().

◆ neighbourCell()

template<class GI >
Cell Opm::GIE::Face< GI >::neighbourCell ( ) const
inline
Returns

References Opm::GIE::Face< GI >::iter_, and Opm::GIE::Face< GI >::pgrid_.

◆ neighbourCellIndex()

template<class GI >
Index Opm::GIE::Face< GI >::neighbourCellIndex ( ) const
inline
Returns

References Opm::GIE::Face< GI >::BoundaryMarkerIndex, Opm::GIE::Face< GI >::iter_, and Opm::GIE::Face< GI >::pgrid_.

◆ neighbourCellVolume()

template<class GI >
Scalar Opm::GIE::Face< GI >::neighbourCellVolume ( ) const
inline
Returns

References Opm::GIE::Face< GI >::iter_.

◆ normal()

template<class GI >
Vector Opm::GIE::Face< GI >::normal ( ) const
inline
Returns

References Opm::GIE::Face< GI >::iter_.

Member Data Documentation

◆ iter_

template<class GI >
DuneIntersectionIter Opm::GIE::Face< GI >::iter_
protected

Referenced by Opm::GIE::Face< GI >::area(), Opm::GIE::Face< GI >::boundary(), Opm::GIE::Face< GI >::boundaryId(), Opm::GIE::Face< GI >::cell(), Opm::GIE::Face< GI >::cellIndex(), Opm::GIE::Face< GI >::centroid(), Opm::GIE::Face< GI >::neighbourCell(), Opm::GIE::Face< GI >::neighbourCellIndex(), Opm::GIE::Face< GI >::neighbourCellVolume(), and Opm::GIE::Face< GI >::normal().

◆ local_index_

template<class GI >
Index Opm::GIE::Face< GI >::local_index_
protected

Referenced by Opm::GIE::Face< GI >::localIndex().

◆ pgrid_

template<class GI >
const GI* Opm::GIE::Face< GI >::pgrid_
protected

Referenced by Opm::GIE::Face< GI >::cell(), Opm::GIE::Face< GI >::cellIndex(), Opm::GIE::Face< GI >::index(), Opm::GIE::Face< GI >::neighbourCell(), and Opm::GIE::Face< GI >::neighbourCellIndex().

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