equationMaxIterCondition Class Reference

Maximum number of equation iterations run time condition. More...

Inheritance diagram for equationMaxIterCondition:

Collaboration diagram for equationMaxIterCondition:

Public Member Functions
	TypeName ("equationMaxIter")
	Runtime type information. More...
	equationMaxIterCondition (const word &name, const objectRegistry &obr, const dictionary &dict, functionObjectState &state)
	Constructor. More...
virtual	~equationMaxIterCondition ()
	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 Attributes
const wordList	fieldNames_
	Field name. More...
const label	threshold_
	Threshold for maximum number of iterations. More...
label	startIter_
	Start checking from iteration - always skips first iteration. 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...
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...

Detailed Description

Maximum number of equation iterations run time condition.

Source files

• equationMaxIterCondition.H
• equationMaxIterCondition.H
• equationMaxIterCondition.C

Definition at line 50 of file equationMaxIterCondition.H.

Constructor & Destructor Documentation

equationMaxIterCondition()

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

Constructor.

Definition at line 48 of file equationMaxIterCondition.C.

References Foam::endl(), Foam::max(), and WarningInFunction.

Here is the call graph for this function:

~equationMaxIterCondition()

~equationMaxIterCondition ( )

virtual

Destructor.

Definition at line 74 of file equationMaxIterCondition.C.

Member Function Documentation

TypeName()

TypeName

(

"equationMaxIter"

)

Runtime type information.

apply()

bool apply ( )

virtual

Apply the condition.

Implements runTimeCondition.

Definition at line 80 of file equationMaxIterCondition.C.

References Foam::endl(), forAll, dictionary::found(), Foam::Info, dictionary::lookup(), mesh, Foam::nl, data::solverPerformanceDict(), Foam::type(), and WarningInFunction.

Here is the call graph for this function:

write()

void write ( )

virtual

Write.

Implements runTimeCondition.

Definition at line 167 of file equationMaxIterCondition.C.

Field Documentation

fieldNames_

const wordList fieldNames_

protected

Field name.

Definition at line 59 of file equationMaxIterCondition.H.

threshold_

const label threshold_

protected

Threshold for maximum number of iterations.

Definition at line 62 of file equationMaxIterCondition.H.

startIter_

label startIter_

protected

Start checking from iteration - always skips first iteration.

Definition at line 65 of file equationMaxIterCondition.H.

---

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

• src/postProcessing/functionObjects/jobControl/runTimeControl/runTimeCondition/equationMaxIterCondition/equationMaxIterCondition.H
• src/postProcessing/functionObjects/jobControl/runTimeControl/runTimeCondition/equationMaxIterCondition/equationMaxIterCondition.C