equationMaxIterCondition Class Reference

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

#include <equationMaxIterCondition.H>

Inheritance diagram for equationMaxIterCondition:

Collaboration diagram for equationMaxIterCondition:

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

Protected Attributes
const wordList	fieldNames_
	Field name.
const label	threshold_
	Threshold for maximum number of iterations.
label	startIter_
	Start checking from iteration - always skips first iteration.
Protected Attributes inherited from runTimeCondition
word	name_
	Condition name.
const objectRegistry &	obr_
	Reference to the object registry.
stateFunctionObject &	state_
	State.
bool	active_
	On/off switch.
dictionary &	conditionDict_
	Reference to the condition dictionary.
label	groupID_
	Group index - if applied, all conditions in a group must be.

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.
Public Attributes inherited from runTimeCondition
Switch	log
	Switch to send output to Info.
Protected Member Functions inherited from runTimeCondition
dictionary &	setConditionDict ()
	Set the condition dictionary (create if necessary).
const dictionary &	conditionDict () const
	Return const access to the conditions dictionary.
dictionary &	conditionDict ()
	Return non-const access to the conditions dictionary.

Detailed Description

Maximum number of equation iterations run time condition.

Source files

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

Definition at line 52 of file equationMaxIterCondition.H.

Constructor & Destructor Documentation

equationMaxIterCondition()

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

Constructor.

Definition at line 49 of file equationMaxIterCondition.C.

References dict, fieldNames_, Foam::max(), runTimeCondition::name(), runTimeCondition::runTimeCondition(), startIter_, and threshold_.

Here is the call graph for this function:

~equationMaxIterCondition()

virtual ~equationMaxIterCondition ( )

virtualdefault

Destructor.

Member Function Documentation

TypeName()

TypeName

(

"equationMaxIter"

)

Runtime type information.

References dict, and runTimeCondition::name().

Here is the call graph for this function:

apply()

bool apply ( )

virtual

Apply the condition.

Implements runTimeCondition.

Definition at line 77 of file equationMaxIterCondition.C.

References runTimeCondition::active_, Foam::endl(), fieldNames_, Pair< T >::first(), forAll, dictionary::found(), Log, dictionary::lookup(), mesh, runTimeCondition::name_, Foam::nl, runTimeCondition::obr_, Foam::refCast(), startIter_, threshold_, Foam::type(), and WarningInFunction.

Here is the call graph for this function:

write()

void write ( )

virtual

Write.

Implements runTimeCondition.

Definition at line 158 of file equationMaxIterCondition.C.

reset()

void reset ( )

virtual

Reset.

Implements runTimeCondition.

Definition at line 165 of file equationMaxIterCondition.C.

Member Data Documentation

fieldNames_

const wordList fieldNames_

protected

Field name.

Definition at line 63 of file equationMaxIterCondition.H.

Referenced by apply(), and equationMaxIterCondition().

threshold_

const label threshold_

protected

Threshold for maximum number of iterations.

Definition at line 68 of file equationMaxIterCondition.H.

Referenced by apply(), and equationMaxIterCondition().

startIter_

label startIter_

protected

Start checking from iteration - always skips first iteration.

Definition at line 73 of file equationMaxIterCondition.H.

Referenced by apply(), and equationMaxIterCondition().

---

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

• src/functionObjects/utilities/runTimeControl/runTimeCondition/equationMaxIterCondition/equationMaxIterCondition.H
• src/functionObjects/utilities/runTimeControl/runTimeCondition/equationMaxIterCondition/equationMaxIterCondition.C