Nektar::Thread::ThreadStartupManager Class Reference

A default ThreadManager. More...

#include <Thread.h>

Inheritance diagram for Nektar::Thread::ThreadStartupManager:

Public Member Functions
	ThreadStartupManager ()
	ThreadDefaultManager. More...
	ThreadStartupManager (const ThreadStartupManager &src)=default
virtual	~ThreadStartupManager ()
Public Member Functions inherited from Nektar::Thread::ThreadManager
virtual	~ThreadManager ()
	Destructor. More...
void	QueueJobs (std::vector< ThreadJob * > &joblist)
	Pass a list of tasklets to the master queue. More...
void	QueueJob (ThreadJob *job)
	Pass a single job to the master queue. More...
unsigned int	GetNumWorkers ()
	Return the number of active workers. More...
unsigned int	GetWorkerNum ()
	Returns the worker number of the executing thread. More...
void	SetNumWorkers (const unsigned int num)
	Sets the number of active workers. More...
void	SetNumWorkers ()
	Sets the number of active workers to the maximum. More...
unsigned int	GetMaxNumWorkers ()
	Gets the maximum available number of threads. More...
void	Wait ()
	Waits until all queued jobs are finished. More...
void	SetChunkSize (unsigned int chnk)
	Controls how many jobs are sent to each worker at a time. More...
void	SetSchedType (SchedType s)
	Sets the current scheduling algorithm. More...
bool	InThread ()
	Indicates whether the code is in a worker thread or not. More...
void	Hold ()
	A calling threads holds until all active threads call this method. More...
const std::string &	GetType ()
	Returns a description of the type of threading. More...
bool	IsInitialised ()
	ThreadManager implementation. More...
int	GetThrFromPartition (int pPartition)
int	GetRankFromPartition (int pPartition)
int	GetPartitionFromRankThr (int pRank, unsigned int pThr)

Protected Member Functions
virtual void	v_QueueJobs (std::vector< ThreadJob * > &joblist) override
virtual void	v_QueueJob (ThreadJob *job) override
virtual unsigned int	v_GetNumWorkers () override
virtual unsigned int	v_GetWorkerNum () override
virtual void	v_SetNumWorkers (const unsigned int num) override
virtual void	v_SetNumWorkers () override
virtual unsigned int	v_GetMaxNumWorkers () override
virtual void	v_Wait () override
virtual void	v_SetChunkSize (unsigned int chnk) override
virtual void	v_SetSchedType (SchedType s) override
virtual bool	v_InThread () override
virtual void	v_Hold () override
virtual bool	v_IsInitialised () override
virtual const std::string &	v_GetType () const override

Private Member Functions
ThreadStartupManager &	operator= (const ThreadStartupManager &src)
	ThreadDefaultManager copy constructor. More...

Private Attributes
const std::string	m_type

Detailed Description

A default ThreadManager.

This will be returned by ThreadMaster if a ThreadManager has not been initialised, such as if the code is still in static initialisation.

This manager pretends to be a ThreadManager with 1 thread. It will cause an error if anything more than trivial functions are called.

Definition at line 438 of file Thread.h.

Constructor & Destructor Documentation

ThreadStartupManager() [1/2]

Nektar::Thread::ThreadStartupManager::ThreadStartupManager

(

)

ThreadDefaultManager.

Definition at line 196 of file Thread.cpp.

                                           : m_type("Threading starting up")
{
    // empty
}

ThreadStartupManager() [2/2]

Nektar::Thread::ThreadStartupManager::ThreadStartupManager ( const ThreadStartupManager &  src )

default

~ThreadStartupManager()

Nektar::Thread::ThreadStartupManager::~ThreadStartupManager ( )

virtual

Definition at line 204 of file Thread.cpp.

{
    // empty
}

Member Function Documentation

operator=()

ThreadStartupManager & Nektar::Thread::ThreadStartupManager::operator= ( const ThreadStartupManager &  src )

private

ThreadDefaultManager copy constructor.

Definition at line 333 of file Thread.cpp.

{
    boost::ignore_unused(src);
    return *this;
}

v_GetMaxNumWorkers()

unsigned int Nektar::Thread::ThreadStartupManager::v_GetMaxNumWorkers ( )

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 265 of file Thread.cpp.

{
    return 1;
}

v_GetNumWorkers()

unsigned int Nektar::Thread::ThreadStartupManager::v_GetNumWorkers ( )

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 232 of file Thread.cpp.

{
    return 1;
}

v_GetType()

const std::string & Nektar::Thread::ThreadStartupManager::v_GetType ( ) const

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 325 of file Thread.cpp.

{
    return m_type;
}

References m_type.

v_GetWorkerNum()

unsigned int Nektar::Thread::ThreadStartupManager::v_GetWorkerNum ( )

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 240 of file Thread.cpp.

{
    return 0;
}

v_Hold()

void Nektar::Thread::ThreadStartupManager::v_Hold ( )

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 309 of file Thread.cpp.

{
    return;
}

v_InThread()

bool Nektar::Thread::ThreadStartupManager::v_InThread ( )

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 301 of file Thread.cpp.

{
    return false;
}

v_IsInitialised()

bool Nektar::Thread::ThreadStartupManager::v_IsInitialised ( )

overrideprotectedvirtual

Implementations should not override this function, since they are initialised.

Returns

True if this ThreadManager has been initialised.

Reimplemented from Nektar::Thread::ThreadManager.

Definition at line 317 of file Thread.cpp.

{
    return false;
}

v_QueueJob()

void Nektar::Thread::ThreadStartupManager::v_QueueJob ( ThreadJob *  job )

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 222 of file Thread.cpp.

{
    boost::ignore_unused(job);
    NEKERROR(ErrorUtil::efatal,
             "Attempted to QueueJob in ThreadDefaultManager");
}

References Nektar::ErrorUtil::efatal, and NEKERROR.

v_QueueJobs()

void Nektar::Thread::ThreadStartupManager::v_QueueJobs ( std::vector< ThreadJob * > &  joblist )

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 212 of file Thread.cpp.

{
    boost::ignore_unused(joblist);
    NEKERROR(ErrorUtil::efatal,
             "Attempted to QueueJobs in ThreadDefaultManager");
}

References Nektar::ErrorUtil::efatal, and NEKERROR.

v_SetChunkSize()

void Nektar::Thread::ThreadStartupManager::v_SetChunkSize ( unsigned int  chnk )

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 281 of file Thread.cpp.

{
    boost::ignore_unused(chnk);
    NEKERROR(ErrorUtil::efatal,
             "Attempted to SetChunkSize in ThreadDefaultManager");
}

References Nektar::ErrorUtil::efatal, and NEKERROR.

v_SetNumWorkers() [1/2]

void Nektar::Thread::ThreadStartupManager::v_SetNumWorkers ( )

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 257 of file Thread.cpp.

{
    return;
}

v_SetNumWorkers() [2/2]

void Nektar::Thread::ThreadStartupManager::v_SetNumWorkers ( const unsigned int  num )

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 248 of file Thread.cpp.

{
    ASSERTL0(num == 1,
             "Attempted to SetNumWorkers to != 1 in ThreadDefaultManager");
}

References ASSERTL0.

v_SetSchedType()

void Nektar::Thread::ThreadStartupManager::v_SetSchedType ( SchedType  s )

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 291 of file Thread.cpp.

{
    boost::ignore_unused(s);
    NEKERROR(ErrorUtil::efatal,
             "Attempted to SetSchedType in ThreadDefaultManager");
}

References Nektar::ErrorUtil::efatal, and NEKERROR.

v_Wait()

void Nektar::Thread::ThreadStartupManager::v_Wait ( )

overrideprotectedvirtual

Implements Nektar::Thread::ThreadManager.

Definition at line 273 of file Thread.cpp.

{
    return;
}

Member Data Documentation

m_type

const std::string Nektar::Thread::ThreadStartupManager::m_type

private

Definition at line 465 of file Thread.h.

Referenced by v_GetType().