profilingInformation Class Reference

Code profiling information in terms of time spent, number of calls etc. More...

Public Member Functions
	profilingInformation (profilingInformation *parent, const string &descr, const label id)
	~profilingInformation ()=default
label	id () const
const string &	description () const
profilingInformation &	parent () const
label	calls () const
scalar	totalTime () const
scalar	childTime () const
int	maxMem () const
bool	active () const
void	update (const scalar elapsedTime)
Ostream &	write (Ostream &os, const bool offset=false, const scalar elapsedTime=0, const scalar childTime=0) const

Protected Member Functions
	profilingInformation ()
void	setActive (bool state) const
	profilingInformation (const profilingInformation &)=delete
void	operator= (const profilingInformation &)=delete

Friends
class	profiling

Detailed Description

Code profiling information in terms of time spent, number of calls etc.

Source files

• profilingInformation.H
• profilingInformation.C

Definition at line 52 of file profilingInformation.H.

Constructor & Destructor Documentation

profilingInformation() [1/3]

profilingInformation ( )

protected

Definition at line 28 of file profilingInformation.C.

profilingInformation() [2/3]

profilingInformation ( const profilingInformation &  )

protecteddelete

profilingInformation() [3/3]

profilingInformation	(	profilingInformation *	parent,
		const string &	descr,
		const label	id
	)

Definition at line 42 of file profilingInformation.C.

~profilingInformation()

~profilingInformation ( )

default

Member Function Documentation

setActive()

void setActive ( bool  state ) const

protected

Definition at line 75 of file profilingInformation.C.

Referenced by profiling::beginTimer(), and profiling::endTimer().

Here is the caller graph for this function:

operator=()

void operator= ( const profilingInformation &  )

protecteddelete

id()

label id ( ) const

inline

Definition at line 128 of file profilingInformation.H.

Referenced by profiling::create(), and profiling::unstack().

Here is the caller graph for this function:

description()

const string& description ( ) const

inline

Definition at line 133 of file profilingInformation.H.

Referenced by profiling::unstack().

Here is the caller graph for this function:

parent()

profilingInformation& parent ( ) const

inline

Definition at line 138 of file profilingInformation.H.

calls()

label calls ( ) const

inline

Definition at line 143 of file profilingInformation.H.

totalTime()

scalar totalTime ( ) const

inline

Definition at line 148 of file profilingInformation.H.

childTime()

scalar childTime ( ) const

inline

Definition at line 153 of file profilingInformation.H.

maxMem()

int maxMem ( ) const

inline

Definition at line 158 of file profilingInformation.H.

active()

bool active ( ) const

inline

Definition at line 163 of file profilingInformation.H.

update()

void update

(

const scalar

elapsedTime

)

Definition at line 61 of file profilingInformation.C.

Referenced by profiling::endTimer().

Here is the caller graph for this function:

write()

Foam::Ostream & write	(	Ostream &	os,
		const bool	offset = false,
		const scalar	elapsedTime = 0,
		const scalar	childTime = 0
	)		const

Definition at line 82 of file profilingInformation.C.

References Ostream::beginBlock(), Ostream::endBlock(), Foam::name(), Switch::name(), os(), Ostream::writeEntry(), and Ostream::writeEntryIfDifferent().

Referenced by Foam::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

profiling

friend class profiling

friend

Definition at line 87 of file profilingInformation.H.

---

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

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