parProfiling Class Reference

Simple (simplistic) mpi-profiling. More...

Inheritance diagram for parProfiling:

Collaboration diagram for parProfiling:

Public Member Functions
	TypeName ("parProfiling")
	parProfiling (const word &name, const Time &runTime, const dictionary &dict)
virtual	~parProfiling ()
void	report ()
virtual bool	execute ()
virtual bool	write ()
virtual bool	end ()
Public Member Functions inherited from functionObject
	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
	functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)
autoPtr< functionObject >	clone () const
virtual	~functionObject ()=default
virtual const word &	type () const =0
const word &	name () const noexcept
bool	useNamePrefix () const noexcept
bool	useNamePrefix (bool on) noexcept
virtual bool	read (const dictionary &dict)
virtual bool	execute (const label subIndex)
virtual bool	adjustTimeStep ()
virtual bool	filesModified () const
virtual void	updateMesh (const mapPolyMesh &mpm)
virtual void	movePoints (const polyMesh &mesh)

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)
Public Attributes inherited from functionObject
bool	log
Static Public Attributes inherited from functionObject
static int	debug
static bool	postProcess
static bool	defaultUseNamePrefix
static word	outputPrefix
Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const

Detailed Description

Simple (simplistic) mpi-profiling.

Usage

Example of function object specification:

profiling
{
    type  parProfiling;
    libs  (utilityFunctionObjects);

    // Report stats on exit only (instead of every time step)
    executeControl  onEnd;
    writeControl    none;
}

Source files

• parProfiling.H
• parProfiling.C

Definition at line 69 of file parProfiling.H.

Constructor & Destructor Documentation

parProfiling()

parProfiling	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict
	)

Definition at line 91 of file parProfiling.C.

~parProfiling()

~parProfiling ( )

virtual

Definition at line 105 of file parProfiling.C.

References profilingPstream::disable().

Here is the call graph for this function:

Member Function Documentation

TypeName()

TypeName

(

"parProfiling"

)

report()

void report

(

)

Definition at line 113 of file parProfiling.C.

References profilingPstream::active(), profilingPstream::ALL_TO_ALL, Pstream::combineGather(), Foam::decrIndent(), Foam::endl(), Tuple2::first(), FixedList::first(), profilingPstream::GATHER, Foam::incrIndent(), Foam::indent(), Foam::Info, UPstream::master(), UPstream::myProcNo(), Foam::nl, UPstream::nProcs(), profilingPstream::REDUCE, profilingPstream::resume(), profilingPstream::SCATTER, Tuple2::second(), profilingPstream::suspend(), profilingPstream::times(), Foam::type(), and profilingPstream::WAIT.

Here is the call graph for this function:

execute()

bool execute ( )

virtual

Implements functionObject.

Definition at line 200 of file parProfiling.C.

write()

bool write ( )

virtual

Implements functionObject.

Definition at line 207 of file parProfiling.C.

end()

bool end ( )

virtual

Reimplemented from functionObject.

Definition at line 213 of file parProfiling.C.

References profilingPstream::disable().

Here is the call graph for this function:

---

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

• src/functionObjects/utilities/parProfiling/parProfiling.H
• src/functionObjects/utilities/parProfiling/parProfiling.C