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

#include <parProfiling.H>

Inheritance diagram for parProfiling:

Collaboration diagram for parProfiling:

Public Member Functions
	parProfiling (const parProfiling &)=delete
	No copy construct.
void	operator= (const parProfiling &)=delete
	No copy assignment.
	TypeName ("parProfiling")
	Runtime type information.
	parProfiling (const word &name, const Time &runTime, const dictionary &dict)
	Construct from name, Time and dictionary. Enables profilingPstream.
virtual	~parProfiling ()
	Destructor. Disables profilingPstream.
void	report ()
	Report the current profiling information.
virtual bool	execute ()
	Execute the function-object operations.
virtual bool	write ()
	Write the function-object results (no-op).
virtual bool	end ()
	Disables profilingPstream.
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)
	Construct from components.
autoPtr< functionObject >	clone () const
	Return clone.
virtual	~functionObject ()=default
	Destructor.
virtual const word &	type () const =0
	Runtime type information.
const word &	name () const noexcept
	Return the name of this functionObject.
bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix.
bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix.
virtual bool	read (const dictionary &dict)
	Read and set the function object if its data have changed.
virtual bool	execute (const label subIndex)
	Execute using the specified subIndex.
virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true.
virtual bool	filesModified () const
	Did any file get changed during execution?
virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh.
virtual void	movePoints (const polyMesh &mesh)
	Update for changes of mesh.

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)
	Select from dictionary, based on its "type" entry.
Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info.
Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content.
static bool	postProcess
	Global post-processing mode switch.
static bool	defaultUseNamePrefix
	Global default for useNamePrefix.
static word	outputPrefix
	Directory prefix.
Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name.

Detailed Description

Simple (simplistic) mpi-profiling.

Usage

Minimal example by using system/controlDict.functions:

profilingFO
{
    // Mandatory entries
    type                parProfiling;
    libs                (utilityFunctionObjects);

    // Optional entries
    detail              <int>;  // 0;

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

where the entries mean: