ParallelUniqueId Class Reference

#include <ParallelUniqueId.h>

Public Member Functions
	ParallelUniqueId ()
	~ParallelUniqueId ()

Static Public Member Functions
static void	initialize ()
	Must be called by main thread before any threaded computation! Do NOT call in a worker thread! More...

Public Attributes
THREAD_ID	id

Static Private Attributes
static tbb::concurrent_bounded_queue< unsigned int >	_ids
static std::queue< unsigned int >	_ids
static Threads::spin_mutex	_pthread_id_mutex
static bool	_initialized = false

Detailed Description

Definition at line 27 of file ParallelUniqueId.h.

Constructor & Destructor Documentation

ParallelUniqueId()

ParallelUniqueId::ParallelUniqueId ( )

inline

Definition at line 30 of file ParallelUniqueId.h.

  {
#ifdef LIBMESH_HAVE_TBB_API
    _ids.pop(id);
#elif LIBMESH_HAVE_OPENMP
    id = omp_get_thread_num();
#elif LIBMESH_HAVE_PTHREAD
    Threads::spin_mutex::scoped_lock lock(_pthread_id_mutex);

    if (_ids.empty())
      throw MooseException(
          "No Thread IDs available in ParallelUniqueID. Did you forget to initialize()?");

    id = _ids.front();
    _ids.pop();
#else
    // There is no thread model active, so we're always on thread 0.
    id = 0;
#endif
  }

~ParallelUniqueId()

ParallelUniqueId::~ParallelUniqueId ( )

inline

Definition at line 51 of file ParallelUniqueId.h.

  {
#ifdef LIBMESH_HAVE_TBB_API
    _ids.push(id);
#elif !defined(LIBMESH_HAVE_OPENMP) && defined(LIBMESH_HAVE_PTHREAD)
    Threads::spin_mutex::scoped_lock lock(_pthread_id_mutex);

    _ids.push(id);
#endif
  }

Member Function Documentation

initialize()

static void ParallelUniqueId::initialize ( )

inlinestatic

Must be called by main thread before any threaded computation! Do NOT call in a worker thread!

Definition at line 66 of file ParallelUniqueId.h.

Referenced by MooseInit::MooseInit().

  {
    if (!_initialized)
    {
      _initialized = true;

#if defined(LIBMESH_HAVE_TBB_API) ||                                                               \
    (!defined(LIBMESH_HAVE_OPENMP) && defined(LIBMESH_HAVE_PTHREAD))
      for (unsigned int i = 0; i < libMesh::n_threads(); ++i)
        _ids.push(i);
#endif
    }
  }

Member Data Documentation

_ids [1/2]

std::queue< unsigned int > ParallelUniqueId::_ids

staticprivate

Definition at line 84 of file ParallelUniqueId.h.

Referenced by initialize(), ParallelUniqueId(), and ~ParallelUniqueId().

_ids [2/2]

std::queue<unsigned int> ParallelUniqueId::_ids

staticprivate

Definition at line 86 of file ParallelUniqueId.h.

_initialized

bool ParallelUniqueId::_initialized = false

staticprivate

Definition at line 90 of file ParallelUniqueId.h.

Referenced by initialize().

_pthread_id_mutex

Threads::spin_mutex ParallelUniqueId::_pthread_id_mutex

staticprivate

Definition at line 87 of file ParallelUniqueId.h.

Referenced by ParallelUniqueId(), and ~ParallelUniqueId().

id

THREAD_ID ParallelUniqueId::id

Definition at line 80 of file ParallelUniqueId.h.

Referenced by ComputeInitialConditionThread::operator()(), ThreadedNodeLoop< ConstBndNodeRange, ConstBndNodeRange::const_iterator >::operator()(), ComputeFVInitialConditionThread::operator()(), ComputeJacobianForScalingThread::operator()(), ComputeElemAuxBcsThread< AuxKernelType >::operator()(), ThreadedElementLoopBase< ConstElemPointerRange >::operator()(), MaxQpsThread::operator()(), AllLocalDofIndicesThread::operator()(), BoundaryElemIntegrityCheckThread::operator()(), PenetrationThread::operator()(), ComputeLinearFVElementalThread::operator()(), ComputeLinearFVFaceThread::operator()(), ComputeLinearFVGreenGaussGradientFaceThread::operator()(), ComputeLinearFVGreenGaussGradientVolumeThread::operator()(), and ThreadedFaceLoop< RangeType >::operator()().

---

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

• include/utils/ParallelUniqueId.h
• src/utils/ParallelUniqueId.C