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 >:

Public Types
typedef Face< GridInterface > ::DuneIntersectionIter	DuneIntersectionIter
	Type of low-level intersection iterator. Copied from the Dune grid. More...
enum
typedef GridInterface::GridType::template Codim< 0 >::EntityPointer	CellPtr
typedef GridInterface::GridType::ctype	Scalar
typedef Dune::FieldVector < Scalar, GridInterface::GridType::dimension >	Vector
typedef Dune::FieldVector < Scalar, GridInterface::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

GridInterface

Interface to a Dune grid (e.g., Dune::CpGrid).

Member Typedef Documentation

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

inherited

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

inherited

template<class GridInterface>

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

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

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

inherited

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

inherited

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

inherited

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

inherited

Member Enumeration Documentation

anonymous enum

inherited

Constructor & Destructor Documentation

template<class GridInterface>

Opm::GIE::FaceIterator< GridInterface >::FaceIterator ( )

inline

Default constructor.

template<class GridInterface>

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

inline

Constructor.

Parameters

[in]	grid	An interface to a Dune grid.
[in]	it	A dune intersection iterator.
[in]	local_index	Local index (number) of this intersection within the encompassing entity (cell).

Member Function Documentation

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

inlineinherited

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

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

inlineinherited

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

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

inlineinherited

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

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

inlineinherited

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

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

inlineinherited

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

Referenced by Opm::GIE::FaceIterator< GridInterface >::operator<().

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

inlineinherited

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

template<class GridInterface>

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

inline

Used by iterator facade.

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_.

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 Opm::GIE::Face< GridInterface >::index ( ) const

inlineinherited

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

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

inlineinherited

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

Referenced by Opm::GIE::FaceIterator< GridInterface >::operator<().

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

inlineinherited

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

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

inlineinherited

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

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

inlineinherited

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

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

inlineinherited

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

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

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

protectedinherited

Referenced by Opm::GIE::FaceIterator< GridInterface >::equal(), and Opm::GIE::FaceIterator< GridInterface >::increment().

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

protectedinherited

Referenced by Opm::GIE::FaceIterator< GridInterface >::increment().

const GridInterface * Opm::GIE::Face< GridInterface >::pgrid_

protectedinherited

---

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

• GridInterfaceEuler.hpp