Public Member Functions | List of all members
Ewoms::ThreadedEntityIterator< GridView, codim > Class Template Reference

Provides an STL-iterator like interface to iterate over the enties of a GridView in OpenMP threaded applications. More...

#include <threadedentityiterator.hh>

Public Member Functions

 ThreadedEntityIterator (const GridView &gridView)
 
 ThreadedEntityIterator (const ThreadedEntityIterator &other)=default
 
void beginParallel (EntityIterator &threadPrivateIt)
 
bool isFinished (const EntityIterator &threadPrivateIt) const
 
void increment (EntityIterator &threadPrivateIt)
 

Detailed Description

template<class GridView, int codim>
class Ewoms::ThreadedEntityIterator< GridView, codim >

Provides an STL-iterator like interface to iterate over the enties of a GridView in OpenMP threaded applications.

ATTENTION: This class must be instantiated in a sequential context!

Constructor & Destructor Documentation

template<class GridView , int codim>
Ewoms::ThreadedEntityIterator< GridView, codim >::ThreadedEntityIterator ( const GridView &  gridView)
inline
template<class GridView , int codim>
Ewoms::ThreadedEntityIterator< GridView, codim >::ThreadedEntityIterator ( const ThreadedEntityIterator< GridView, codim > &  other)
default

Member Function Documentation

template<class GridView , int codim>
void Ewoms::ThreadedEntityIterator< GridView, codim >::beginParallel ( EntityIterator &  threadPrivateIt)
inline

References OmpMutex::lock(), and OmpMutex::unlock().

Referenced by Ewoms::MultiPhaseBaseModel< TypeTag >::globalPhaseStorage(), Ewoms::FvBaseDiscretization< TypeTag >::globalResidual(), and Ewoms::FvBaseDiscretization< TypeTag >::globalStorage().

template<class GridView , int codim>
void Ewoms::ThreadedEntityIterator< GridView, codim >::increment ( EntityIterator &  threadPrivateIt)
inline

References OmpMutex::lock(), and OmpMutex::unlock().

Referenced by Ewoms::MultiPhaseBaseModel< TypeTag >::globalPhaseStorage(), Ewoms::FvBaseDiscretization< TypeTag >::globalResidual(), and Ewoms::FvBaseDiscretization< TypeTag >::globalStorage().

template<class GridView , int codim>
bool Ewoms::ThreadedEntityIterator< GridView, codim >::isFinished ( const EntityIterator &  threadPrivateIt) const
inline

Referenced by Ewoms::MultiPhaseBaseModel< TypeTag >::globalPhaseStorage(), Ewoms::FvBaseDiscretization< TypeTag >::globalResidual(), and Ewoms::FvBaseDiscretization< TypeTag >::globalStorage().

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