parProfiling Class Reference

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

Inheritance diagram for parProfiling:

Collaboration diagram for parProfiling:

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

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. More...
Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info. More...
Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content. More...
static bool	postProcess
	Global post-processing mode switch. More...
static bool	defaultUseNamePrefix
	Global default for useNamePrefix. More...
static word	outputPrefix
	Directory prefix. More...
Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name. More...

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
	)

Construct from Time and dictionary. Enables profilingPstream.

Definition at line 51 of file parProfiling.C.

~parProfiling()

~parProfiling ( )

virtual

Destructor. Disables profilingPstream.

Definition at line 65 of file parProfiling.C.

References profilingPstream::disable().

Here is the call graph for this function:

Member Function Documentation

TypeName()

TypeName

(

"parProfiling"

)

Runtime type information.

report()

void report

(

)

Report the current profiling information.

Definition at line 73 of file parProfiling.C.

References profilingPstream::active(), profilingPstream::ALL_TO_ALL, profilingPstream::BROADCAST, Pstream::combineGather(), Foam::decrIndent(), forAll, profilingPstream::GATHER, Foam::incrIndent(), Foam::indent(), Foam::Info, UPstream::master(), UPstream::myProcNo(), Foam::nl, UPstream::nProcs(), profilingPstream::OTHER, profilingPstream::REDUCE, profilingPstream::resume(), profilingPstream::SCATTER, profilingPstream::suspend(), profilingPstream::times(), Foam::type(), profilingPstream::WAIT, x, and y.

Here is the call graph for this function:

execute()

bool execute ( )

virtual

Report.

Implements functionObject.

Definition at line 193 of file parProfiling.C.

write()

bool write ( )

virtual

Do nothing.

Implements functionObject.

Definition at line 200 of file parProfiling.C.

end()

bool end ( )

virtual

Report.

Reimplemented from functionObject.

Definition at line 206 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