profilingPstream Class Reference

Timers and values for simple (simplistic) mpi-profiling. The entire class behaves as a singleton. More...

Public Types
enum	timingType {   GATHER = 0, SCATTER, REDUCE, WAIT,   ALL_TO_ALL }
typedef FixedList< double, 5 >	timingList

Public Member Functions
	profilingPstream ()
	~profilingPstream ()

Static Public Member Functions
static void	enable ()
static void	disable ()
static void	suspend ()
static void	resume ()
static bool	active ()
static timingList &	times ()
static double	times (const enum timingType idx)
static void	beginTiming ()
static void	addTime (const enum timingType idx)
static void	addGatherTime ()
static void	addScatterTime ()
static void	addReduceTime ()
static void	addWaitTime ()
static void	addAllToAllTime ()

Detailed Description

Timers and values for simple (simplistic) mpi-profiling. The entire class behaves as a singleton.

Source files

• profilingPstream.H
• profilingPstream.C

Definition at line 49 of file profilingPstream.H.

Member Typedef Documentation

timingList

typedef FixedList<double, 5> timingList

Definition at line 66 of file profilingPstream.H.

Member Enumeration Documentation

timingType

enum timingType

Enumerator
GATHER
SCATTER
REDUCE
WAIT
ALL_TO_ALL

Definition at line 56 of file profilingPstream.H.

Constructor & Destructor Documentation

profilingPstream()

profilingPstream

(

)

Definition at line 34 of file profilingPstream.C.

References profilingPstream::enable().

Here is the call graph for this function:

~profilingPstream()

~profilingPstream

(

)

Definition at line 42 of file profilingPstream.C.

Member Function Documentation

enable()

void enable ( )

static

Definition at line 50 of file profilingPstream.C.

References Foam::Zero.

Referenced by profilingPstream::profilingPstream().

Here is the caller graph for this function:

disable()

void disable ( )

static

Definition at line 66 of file profilingPstream.C.

Referenced by parProfiling::end(), and parProfiling::~parProfiling().

Here is the caller graph for this function:

suspend()

static void suspend ( )

inlinestatic

Definition at line 104 of file profilingPstream.H.

References bool.

Referenced by parProfiling::report().

Here is the caller graph for this function:

resume()

static void resume ( )

inlinestatic

Definition at line 110 of file profilingPstream.H.

Referenced by parProfiling::report().

Here is the caller graph for this function:

active()

static bool active ( )

inlinestatic

Definition at line 116 of file profilingPstream.H.

References bool.

Referenced by profilingPstream::addTime(), profilingPstream::beginTiming(), and parProfiling::report().

Here is the caller graph for this function:

times() [1/2]

static timingList& times ( )

inlinestatic

Definition at line 122 of file profilingPstream.H.

Referenced by parProfiling::report().

Here is the caller graph for this function:

times() [2/2]

static double times ( const enum timingType  idx )

inlinestatic

Definition at line 128 of file profilingPstream.H.

beginTiming()

static void beginTiming ( )

inlinestatic

Definition at line 134 of file profilingPstream.H.

References profilingPstream::active().

Referenced by UPstream::allToAll().

Here is the call graph for this function:

Here is the caller graph for this function:

addTime()

static void addTime ( const enum timingType  idx )

inlinestatic

Definition at line 143 of file profilingPstream.H.

References profilingPstream::active().

Referenced by profilingPstream::addAllToAllTime(), profilingPstream::addGatherTime(), profilingPstream::addReduceTime(), profilingPstream::addScatterTime(), and profilingPstream::addWaitTime().

Here is the call graph for this function:

Here is the caller graph for this function:

addGatherTime()

static void addGatherTime ( )

inlinestatic

Definition at line 152 of file profilingPstream.H.

References profilingPstream::addTime(), and profilingPstream::GATHER.

Here is the call graph for this function:

addScatterTime()

static void addScatterTime ( )

inlinestatic

Definition at line 158 of file profilingPstream.H.

References profilingPstream::addTime(), and profilingPstream::SCATTER.

Here is the call graph for this function:

addReduceTime()

static void addReduceTime ( )

inlinestatic

Definition at line 164 of file profilingPstream.H.

References profilingPstream::addTime(), and profilingPstream::REDUCE.

Here is the call graph for this function:

addWaitTime()

static void addWaitTime ( )

inlinestatic

Definition at line 170 of file profilingPstream.H.

References profilingPstream::addTime(), and profilingPstream::WAIT.

Here is the call graph for this function:

addAllToAllTime()

static void addAllToAllTime ( )

inlinestatic

Definition at line 176 of file profilingPstream.H.

References profilingPstream::addTime(), and profilingPstream::ALL_TO_ALL.

Referenced by UPstream::allToAll().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• src/OpenFOAM/global/profiling/profilingPstream.H
• src/OpenFOAM/global/profiling/profilingPstream.C