G4MTBarrier Class Reference

#include <G4MTBarrier.hh>

Public Member Functions
	G4MTBarrier ()
virtual	~G4MTBarrier ()
	G4MTBarrier (const G4MTBarrier &)=delete
G4MTBarrier &	operator= (const G4MTBarrier &)=delete
	G4MTBarrier (unsigned int numThreads)
void	ThisWorkerReady ()
virtual void	WaitForReadyWorkers ()
void	SetActiveThreads (unsigned int val)
void	ResetCounter ()
unsigned int	GetCounter ()
void	Wait ()
void	ReleaseBarrier ()
void	Wait (unsigned int numt)

Detailed Description

Definition at line 122 of file G4MTBarrier.hh.

Constructor & Destructor Documentation

G4MTBarrier() [1/3]

G4MTBarrier::G4MTBarrier ( )

inline

Definition at line 125 of file G4MTBarrier.hh.

    : G4MTBarrier(1)
  {}

~G4MTBarrier()

virtual G4MTBarrier::~G4MTBarrier ( )

inlinevirtual

Definition at line 128 of file G4MTBarrier.hh.

{}

G4MTBarrier() [2/3]

G4MTBarrier::G4MTBarrier ( const G4MTBarrier &  )

delete

G4MTBarrier() [3/3]

G4MTBarrier::G4MTBarrier

(

unsigned int

numThreads

)

Definition at line 35 of file G4MTBarrier.cc.

  : m_numActiveThreads(numThreads)
{}

Member Function Documentation

GetCounter()

unsigned int G4MTBarrier::GetCounter

(

)

Definition at line 97 of file G4MTBarrier.cc.

{
  G4AutoLock l(&m_mutex);
  const unsigned int result = m_counter;
  return result;
}

operator=()

G4MTBarrier & G4MTBarrier::operator= ( const G4MTBarrier &  )

delete

ReleaseBarrier()

void G4MTBarrier::ReleaseBarrier

(

)

Definition at line 72 of file G4MTBarrier.cc.

{
  // Step-4: re-aquire lock and re-set shared resource for future re-use
  G4AutoLock lock(&m_mutex);
  m_counter = 0;
  G4CONDITIONBROADCAST(&m_continue);
}

Referenced by G4MTRunManager::NewActionRequest(), G4MTRunManager::WaitForEndEventLoopWorkers(), WaitForReadyWorkers(), and G4MTRunManager::WaitForReadyWorkers().

ResetCounter()

void G4MTBarrier::ResetCounter

(

)

Definition at line 90 of file G4MTBarrier.cc.

{
  G4AutoLock l(&m_mutex);
  m_counter = 0;
}

Referenced by G4MTRunManager::WaitForEndEventLoopWorkers(), and G4MTRunManager::WaitForReadyWorkers().

SetActiveThreads()

void G4MTBarrier::SetActiveThreads ( unsigned int  val )

inline

Definition at line 140 of file G4MTBarrier.hh.

{ m_numActiveThreads = val; }

Referenced by G4MTRunManager::RequestWorkersProcessCommandsStack(), and Wait().

ThisWorkerReady()

void G4MTBarrier::ThisWorkerReady

(

)

Definition at line 40 of file G4MTBarrier.cc.

{
  // Step-1: Worker acquires lock on shared resource (the counter)
  G4AutoLock lock(&m_mutex);
  // Step-2: Worker increases counter
  ++m_counter;
  // Step-3: Worker broadcasts that the counter has changed
  G4CONDITIONBROADCAST(&m_counterChanged);
  // Step-4: Worker waits on condition to continue
  G4CONDITIONWAIT(&m_continue, &lock);
}

Referenced by G4MTRunManager::ThisWorkerEndEventLoop(), G4MTRunManager::ThisWorkerProcessCommandsStackDone(), G4MTRunManager::ThisWorkerReady(), and G4MTRunManager::ThisWorkerWaitForNextAction().

Wait() [1/2]

void G4MTBarrier::Wait

(

)

Definition at line 53 of file G4MTBarrier.cc.

{
  while(true)
  {
    // Step-2: Acquires lock on shared resource (the counter)
    G4AutoLock lock(&m_mutex);
    // If the counter equals active threads, all threads are ready, exit the
    // loop
    if(m_counter == m_numActiveThreads)
    {
      break;
    }
    // Step-3: Not all workers are ready, wait for the number to change
    // before repeating the check
    G4CONDITIONWAIT(&m_counterChanged, &lock);
  }
}

Referenced by G4MTRunManager::NewActionRequest(), Wait(), G4MTRunManager::WaitForEndEventLoopWorkers(), WaitForReadyWorkers(), and G4MTRunManager::WaitForReadyWorkers().

Wait() [2/2]

void G4MTBarrier::Wait ( unsigned int  numt )

inline

Definition at line 145 of file G4MTBarrier.hh.

  {
    SetActiveThreads(numt);
    Wait();
  }

WaitForReadyWorkers()

void G4MTBarrier::WaitForReadyWorkers ( )

virtual

Definition at line 81 of file G4MTBarrier.cc.

{
  // Step-1: Master enters a loop to wait all workers to be ready
  Wait();
  // Done, all workers are ready, broadcast a continue signal
  ReleaseBarrier();
}

Referenced by G4MTRunManager::RequestWorkersProcessCommandsStack().

---

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

• G4MTBarrier.hh
• G4MTBarrier.cc