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

Intersection (face) iterator for solver-near grid interface. More...

#include <GridInterfaceEuler.hpp>

Inheritance diagram for Opm::GIE::FaceIterator< GridInterface >:
Inheritance graph

Public Types

typedef Face< GridInterface >::DuneIntersectionIter DuneIntersectionIter
 Type of low-level intersection iterator. Copied from the Dune grid. More...
 
enum  
 
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< GridInterface, CellPtr > Cell
 

Public Member Functions

 FaceIterator ()
 Default constructor. More...
 
 FaceIterator (const GridInterface &grid, const DuneIntersectionIter &it, const int local_index)
 Constructor. More...
 
const FaceIterator & dereference () const
 Used by iterator facade. More...
 
bool equal (const FaceIterator &other) const
 Used by iterator facade. More...
 
void increment ()
 Used by iterator facade. More...
 
bool operator< (const FaceIterator &other) const
 Gives an ordering of intersectionIterators. More...
 
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 GridInterface * pgrid_
 
DuneIntersectionIter iter_
 
Index local_index_
 

Detailed Description

template<class GridInterface>
class Opm::GIE::FaceIterator< GridInterface >

Intersection (face) iterator for solver-near grid interface.

Template Parameters
GridInterfaceInterface to a Dune grid (e.g., Dune::CpGrid).

Member Typedef Documentation

◆ Cell

typedef GIE::Cell<GridInterface , CellPtr> Opm::GIE::Face< GridInterface >::Cell
inherited

◆ CellPtr

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

◆ DuneIntersectionIter

template<class GridInterface >
typedef Face<GridInterface>::DuneIntersectionIter Opm::GIE::FaceIterator< GridInterface >::DuneIntersectionIter

Type of low-level intersection iterator. Copied from the Dune grid.

◆ Index

typedef int Opm::GIE::Face< GridInterface >::Index
inherited

◆ LocalVector

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

◆ Scalar

typedef GI::GridType::ctype Opm::GIE::Face< GridInterface >::Scalar
inherited

◆ Vector

typedef Dune::FieldVector<Scalar, GI::GridType::dimension> Opm::GIE::Face< GridInterface >::Vector
inherited

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
inherited

Constructor & Destructor Documentation

◆ FaceIterator() [1/2]

template<class GridInterface >
Opm::GIE::FaceIterator< GridInterface >::FaceIterator ( )
inline

Default constructor.

◆ FaceIterator() [2/2]

template<class GridInterface >
Opm::GIE::FaceIterator< GridInterface >::FaceIterator ( const GridInterface &  grid,
const DuneIntersectionIter &  it,
const int  local_index 
)
inline

Constructor.

Parameters
[in]gridAn interface to a Dune grid.
[in]itA dune intersection iterator.
[in]local_indexLocal index (number) of this intersection within the encompassing entity (cell).

Member Function Documentation

◆ area()

Scalar Opm::GIE::Face< GridInterface >::area ( ) const
inlineinherited
Returns

◆ boundary()

bool Opm::GIE::Face< GridInterface >::boundary ( ) const
inlineinherited
Returns

◆ boundaryId()

int Opm::GIE::Face< GridInterface >::boundaryId ( ) const
inlineinherited
Returns

◆ cell()

Cell Opm::GIE::Face< GridInterface >::cell ( ) const
inlineinherited
Returns

◆ cellIndex()

Index Opm::GIE::Face< GridInterface >::cellIndex ( ) const
inlineinherited
Returns

◆ centroid()

Vector Opm::GIE::Face< GridInterface >::centroid ( ) const
inlineinherited
Returns

◆ dereference()

template<class GridInterface >
const FaceIterator & Opm::GIE::FaceIterator< GridInterface >::dereference ( ) const
inline

Used by iterator facade.

◆ equal()

template<class GridInterface >
bool Opm::GIE::FaceIterator< GridInterface >::equal ( const FaceIterator< GridInterface > &  other) const
inline

Used by iterator facade.

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

◆ increment()

template<class GridInterface >
void Opm::GIE::FaceIterator< GridInterface >::increment ( )
inline

Used by iterator facade.

References Opm::GIE::Face< GridInterface >::iter_, and Opm::GIE::Face< GridInterface >::local_index_.

◆ index()

Index Opm::GIE::Face< GridInterface >::index ( ) const
inlineinherited
Returns

◆ localIndex()

Index Opm::GIE::Face< GridInterface >::localIndex ( ) const
inlineinherited
Returns

◆ neighbourCell()

Cell Opm::GIE::Face< GridInterface >::neighbourCell ( ) const
inlineinherited
Returns

◆ neighbourCellIndex()

Index Opm::GIE::Face< GridInterface >::neighbourCellIndex ( ) const
inlineinherited
Returns

◆ neighbourCellVolume()

Scalar Opm::GIE::Face< GridInterface >::neighbourCellVolume ( ) const
inlineinherited
Returns

◆ normal()

Vector Opm::GIE::Face< GridInterface >::normal ( ) const
inlineinherited
Returns

◆ operator<()

template<class GridInterface >
bool Opm::GIE::FaceIterator< GridInterface >::operator< ( const FaceIterator< GridInterface > &  other) const
inline

Gives an ordering of intersectionIterators.

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

Member Data Documentation

◆ iter_

DuneIntersectionIter Opm::GIE::Face< GridInterface >::iter_
protectedinherited

◆ local_index_

Index Opm::GIE::Face< GridInterface >::local_index_
protectedinherited

◆ pgrid_

const GridInterface * Opm::GIE::Face< GridInterface >::pgrid_
protectedinherited
The documentation for this class was generated from the following file: