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 Types
enum	windowType { NONE, APPROXIMATE, EXACT }

Public Member Functions
	TypeName ("average")
	Runtime type information. More...

	averageCondition (const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state)
	Constructor. More...

virtual	~averageCondition ()=default
	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, stateFunctionObject &state),(name, obr, dict, state))
	Declare runtime constructor selection table. More...

	runTimeCondition (const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state)
	Constructor. More...

virtual	~runTimeCondition ()=default
	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...

Static Public Attributes
static const Enum< windowType >	windowTypeNames

Protected Member Functions
template<class Type >
void	calc (const label fieldi, 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 retrieve 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...

windowType	windowType_
	Averaging window type. More...

List< scalar >	totalTime_
	Average time per field. More...

Switch	resetOnRestart_
	Reset the averaging process on restart flag. More...

label	nIterStartUp_
	Number of start-up iterations before allowing satisfied checks. More...

label	iter_
	Current iteration count. More...

Protected Attributes inherited from runTimeCondition
word	name_
	Condition name. More...

const objectRegistry &	obr_
	Reference to the object registry. More...

stateFunctionObject &	state_
	State. More...

bool	active_
	On/off switch. More...

dictionary &	conditionDict_
	Reference to the condition dictionary. 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, stateFunctionObject &state)
	Selector. More...

Public Attributes inherited from runTimeCondition
Switch	log
	Switch to send output to Info. More...

Detailed Description

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

Source files

Definition at line 59 of file averageCondition.H.

Member Enumeration Documentation

◆ windowType

enum windowType

strong

Enumerator
NONE
APPROXIMATE
EXACT

Definition at line 67 of file averageCondition.H.

Constructor & Destructor Documentation

◆ averageCondition()

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

Constructor.

Definition at line 62 of file averageCondition.C.

References forAll, dictionary::found(), dictionary::readIfPresent(), dictionary::set(), and dictionary::subDict().

Here is the call graph for this function:

◆ ~averageCondition()

virtual ~averageCondition ( )

virtualdefault

Destructor.

Member Function Documentation

◆ calc()

void calc	(	const label	fieldi,
		bool &	satisfied,
		bool &	processed
	)

protected

Templated function to calculate the average.

Definition at line 36 of file averageConditionTemplates.C.

References Foam::constant::atomic::alpha, beta(), LList< LListBase, T >::cbegin(), delta, dict, Log, Foam::mag(), Foam::nl, FIFOStack< T >::pop(), and FIFOStack< T >::push().

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 115 of file averageCondition.C.

References runTimeCondition::active_, TimeState::deltaTValue(), Foam::endl(), averageCondition::fieldNames_, forAll, averageCondition::functionObjectName_, Foam::Info, averageCondition::iter_, Log, runTimeCondition::name_, averageCondition::nIterStartUp_, Foam::nl, runTimeCondition::obr_, objectRegistry::time(), averageCondition::totalTime_, Foam::type(), and WarningInFunction.

Here is the call graph for this function:

◆ write()

void write ( )

virtual

Write.

Implements runTimeCondition.

Definition at line 172 of file averageCondition.C.

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

Here is the call graph for this function:

Member Data Documentation

◆ windowTypeNames

const Foam::Enum< Foam::functionObjects::runTimeControls::averageCondition::windowType > windowTypeNames

static

Definition at line 74 of file averageCondition.H.

◆ functionObjectName_

word functionObjectName_

protected

Name of function object to retrieve data from.

Definition at line 82 of file averageCondition.H.

Referenced by averageCondition::apply().

◆ fieldNames_

wordList fieldNames_

protected

List of fields on which to operate.

Definition at line 85 of file averageCondition.H.

Referenced by averageCondition::apply().

◆ tolerance_

const scalar tolerance_

protected

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

Definition at line 88 of file averageCondition.H.

◆ window_

const scalar window_

protected

Averaging window.

Definition at line 91 of file averageCondition.H.

◆ windowType_

windowType windowType_

protected

Averaging window type.

Definition at line 94 of file averageCondition.H.

◆ totalTime_

List<scalar> totalTime_

protected

Average time per field.

Definition at line 97 of file averageCondition.H.

Referenced by averageCondition::apply().

◆ resetOnRestart_

Switch resetOnRestart_

protected

Reset the averaging process on restart flag.

Definition at line 100 of file averageCondition.H.

◆ nIterStartUp_

label nIterStartUp_

protected

Number of start-up iterations before allowing satisfied checks.

Definition at line 103 of file averageCondition.H.

Referenced by averageCondition::apply().

◆ iter_

label iter_

protected

Current iteration count.

Definition at line 106 of file averageCondition.H.

Referenced by averageCondition::apply().

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

src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.H
src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageCondition.C
src/functionObjects/utilities/runTimeControl/runTimeCondition/averageCondition/averageConditionTemplates.C

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ windowType

Constructor & Destructor Documentation

◆ averageCondition()

◆ ~averageCondition()

Member Function Documentation

◆ calc()

◆ TypeName()

◆ apply()

◆ write()

Member Data Documentation

◆ windowTypeNames

◆ functionObjectName_

◆ fieldNames_

◆ tolerance_

◆ window_

◆ windowType_

◆ totalTime_

◆ resetOnRestart_

◆ nIterStartUp_

◆ iter_