averageCondition Class Reference

Average run time condition - satisfied when average does not change by more than a given value. More...

Inheritance diagram for averageCondition:

Collaboration diagram for averageCondition:

Public Member Functions
	TypeName ("average")
	Runtime type information. More...
	averageCondition (const word &name, const objectRegistry &obr, const dictionary &dict, functionObjectState &state)
	Constructor. More...
virtual	~averageCondition ()
	Destructor. More...
virtual bool	apply ()
	Apply the condition. More...
virtual void	write ()
	Write. More...
Public Member Functions inherited from runTimeCondition
	TypeName ("runTimeCondition")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, runTimeCondition, dictionary,(const word &name, const objectRegistry &obr, const dictionary &dict, functionObjectState &state),(name, obr, dict, state))
	Declare runtime constructor selection table. More...
	runTimeCondition (const word &name, const objectRegistry &obr, const dictionary &dict, functionObjectState &state)
	Constructor. More...
virtual	~runTimeCondition ()
	Destructor. More...
virtual const word &	name () const
	Return the condition name. More...
virtual bool	active () const
	Return the active flag. More...
virtual label	groupID () const
	Return the group index. More...

Protected Member Functions
template<class Type >
void	calc (const word &fieldName, const scalar alpha, const scalar beta, bool &satisfied, bool &processed)
	Templated function to calculate the average. More...
Protected Member Functions inherited from runTimeCondition
dictionary &	setConditionDict ()
	Set the condition dictionary (create if necessary) More...
const dictionary &	conditionDict () const
	Return const access to the conditions dictionary. More...
dictionary &	conditionDict ()
	Return non-const access to the conditions dictionary. More...

Protected Attributes
word	functionObjectName_
	Name of function object to retrueve data from. More...
wordList	fieldNames_
	List of fields on which to operate. More...
const scalar	tolerance_
	Satisfied when difference in mean values is less than this value. More...
const scalar	window_
	Averaging window. More...
List< scalar >	totalTime_
	Average time per field. More...
Switch	resetOnRestart_
	Reset the averaging process on restart flag. More...
Protected Attributes inherited from runTimeCondition
word	name_
	Condition name. More...
const objectRegistry &	obr_
	Reference to the object registry. More...
functionObjectState &	state_
	State. More...
bool	active_
	On/off switch. More...
dictionary &	conditionDict_
	Reference to the condition dictionary. More...
Switch	log_
	Switch to send output to Info. More...
label	groupID_
	Group index - if applied, all conditions in a group must be. More...

Additional Inherited Members
Static Public Member Functions inherited from runTimeCondition
static autoPtr< runTimeCondition >	New (const word &conditionName, const objectRegistry &obr, const dictionary &dict, functionObjectState &state)
	Selector. More...

Detailed Description

Average run time condition - satisfied when average does not change by more than a given value.

Source files

• averageCondition.H
• averageCondition.H
• averageCondition.C

Definition at line 52 of file averageCondition.H.

Constructor & Destructor Documentation

averageCondition()

averageCondition	(	const word &	name,
		const objectRegistry &	obr,
		const dictionary &	dict,
		functionObjectState &	state
	)

Constructor.

Definition at line 42 of file averageCondition.C.

References dict, forAll, dictionary::lookup(), and readScalar.

Here is the call graph for this function:

~averageCondition()

~averageCondition ( )

virtual

Destructor.

Definition at line 77 of file averageCondition.C.

Member Function Documentation

calc()

void calc ( const word &  fieldName, const scalar  alpha, const scalar  beta, bool &  satisfied, bool &  processed  )

protected

Templated function to calculate the average.

Definition at line 30 of file averageConditionTemplates.C.

References Foam::constant::atomic::alpha, beta(), delta, Foam::Info, Foam::mag(), and Foam::nl.

Here is the call graph for this function:

TypeName()

TypeName

(

"average"

)

Runtime type information.

apply()

bool apply ( )

virtual

Apply the condition.

Implements runTimeCondition.

Definition at line 83 of file averageCondition.C.

References Foam::constant::atomic::alpha, DynamicList::append(), beta(), Foam::endl(), forAll, Foam::Info, Foam::nl, Foam::type(), and WarningInFunction.

Here is the call graph for this function:

write()

void write ( )

virtual

Write.

Implements runTimeCondition.

Definition at line 155 of file averageCondition.C.

References dictionary::add(), forAll, dictionary::found(), and dictionary::subDict().

Here is the call graph for this function:

Field Documentation

functionObjectName_

word functionObjectName_

protected

Name of function object to retrueve data from.

Definition at line 61 of file averageCondition.H.

fieldNames_

wordList fieldNames_

protected

List of fields on which to operate.

Definition at line 64 of file averageCondition.H.

tolerance_

const scalar tolerance_

protected

Satisfied when difference in mean values is less than this value.

Definition at line 67 of file averageCondition.H.

window_

const scalar window_

protected

Averaging window.

Definition at line 70 of file averageCondition.H.

totalTime_

List<scalar> totalTime_

protected

Average time per field.

Definition at line 73 of file averageCondition.H.

resetOnRestart_

Switch resetOnRestart_

protected

Reset the averaging process on restart flag.

Definition at line 76 of file averageCondition.H.

---

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

• src/postProcessing/functionObjects/jobControl/runTimeControl/runTimeCondition/averageCondition/averageCondition.H
• src/postProcessing/functionObjects/jobControl/runTimeControl/runTimeCondition/averageCondition/averageCondition.C
• src/postProcessing/functionObjects/jobControl/runTimeControl/runTimeCondition/averageCondition/averageConditionTemplates.C