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")
	equationMaxIterCondition (const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state)
virtual	~equationMaxIterCondition ()=default
virtual bool	apply ()
virtual void	write ()
Public Member Functions inherited from runTimeCondition
	TypeName ("runTimeCondition")
	declareRunTimeSelectionTable (autoPtr, runTimeCondition, dictionary,(const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state),(name, obr, dict, state))
	runTimeCondition (const word &name, const objectRegistry &obr, const dictionary &dict, stateFunctionObject &state)
virtual	~runTimeCondition ()=default
virtual const word &	name () const
virtual bool	active () const
virtual label	groupID () const

Protected Attributes
const wordList	fieldNames_
const label	threshold_
label	startIter_
Protected Attributes inherited from runTimeCondition
word	name_
const objectRegistry &	obr_
stateFunctionObject &	state_
bool	active_
dictionary &	conditionDict_
label	groupID_

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)
Public Attributes inherited from runTimeCondition
Switch	log
Protected Member Functions inherited from runTimeCondition
dictionary &	setConditionDict ()
const dictionary &	conditionDict () const
dictionary &	conditionDict ()

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
	)

Definition at line 51 of file equationMaxIterCondition.C.

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

Here is the call graph for this function:

~equationMaxIterCondition()

virtual ~equationMaxIterCondition ( )

virtualdefault

Member Function Documentation

TypeName()

TypeName

(

"equationMaxIter"

)

apply()

bool apply ( )

virtual

Implements runTimeCondition.

Definition at line 77 of file equationMaxIterCondition.C.

References runTimeCondition::active_, Foam::endl(), equationMaxIterCondition::fieldNames_, forAll, dictionary::found(), Log, dictionary::lookup(), mesh, runTimeCondition::name_, Foam::nl, runTimeCondition::obr_, equationMaxIterCondition::startIter_, equationMaxIterCondition::threshold_, objectRegistry::time(), TimeState::timeIndex(), Foam::type(), and WarningInFunction.

Here is the call graph for this function:

write()

void write ( )

virtual

Implements runTimeCondition.

Definition at line 158 of file equationMaxIterCondition.C.

Member Data Documentation

fieldNames_

const wordList fieldNames_

protected

Definition at line 61 of file equationMaxIterCondition.H.

Referenced by equationMaxIterCondition::apply().

threshold_

const label threshold_

protected

Definition at line 64 of file equationMaxIterCondition.H.

Referenced by equationMaxIterCondition::apply().

startIter_

label startIter_

protected

Definition at line 67 of file equationMaxIterCondition.H.

Referenced by equationMaxIterCondition::apply().

---

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