minTimeStepCondition Class Reference

Initial residual run time condition. More...

Inheritance diagram for minTimeStepCondition:

Collaboration diagram for minTimeStepCondition:

Public Member Functions
	TypeName ("minTimeStep")
	Runtime type information. More...
	minTimeStepCondition (const word &name, const objectRegistry &obr, const dictionary &dict, functionObjectState &state)
	Constructor. More...
virtual	~minTimeStepCondition ()
	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 scalar	minValue_
	Minumim time step value to compare. 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

Initial residual run time condition.

Source files

• minTimeStepCondition.H
• minTimeStepCondition.H
• minTimeStepCondition.C

Definition at line 50 of file minTimeStepCondition.H.

Constructor & Destructor Documentation

minTimeStepCondition()

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

Constructor.

Definition at line 47 of file minTimeStepCondition.C.

~minTimeStepCondition()

~minTimeStepCondition ( )

virtual

Destructor.

Definition at line 61 of file minTimeStepCondition.C.

Member Function Documentation

TypeName()

TypeName

(

"minTimeStep"

)

Runtime type information.

apply()

bool apply ( )

virtual

Apply the condition.

Implements runTimeCondition.

Definition at line 67 of file minTimeStepCondition.C.

write()

void write ( )

virtual

Write.

Implements runTimeCondition.

Definition at line 85 of file minTimeStepCondition.C.

Field Documentation

minValue_

const scalar minValue_

protected

Minumim time step value to compare.

Definition at line 59 of file minTimeStepCondition.H.

---

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

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