Controls when the calculation is terminated based on satisfying user-specified conditions. More...

#include <runTimeControl.H>

Detailed Description

Controls when the calculation is terminated based on satisfying user-specified conditions.

Optionally specify a number of write steps before the calculation is terminated. Here, a write is performed each time that all conditions are satisfied.

Usage

Minimal example by using system/controlDict.functions:

runTimeControlFO
{
    // Mandatory entries
    type            runTimeControl;
    libs            (utilityFunctionObjects);
    conditions      <dictionary>;

    // Optional entries
    nWriteStep      <label>;
    satisfiedAction <satisfiedAction>;

    // Conditional entries

        // when 'satisfiedAction' is 'setTrigger'
        trigger     <label>;

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: runTimeControl	word	yes	-
`libs`	Library name: utilityFunctionObjects	word	yes	-
`conditions`	List of conditions to satisfy	dictionary	yes	-
`nWriteStep`	Number of write steps before exiting	label	no	0
`satisfiedAction`	Operand action	word	no	end

Options for the satisfiedAction entry:

      abort      | Write and emit a FatalError, terminating the run abnormally
      end        | Write and exit cleanly, terminating the run normally
      setTrigger | Trigger another condition, allowing chained control logic

The inherited entries are elaborated in:

functionObject.H

Source files

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

src/functionObjects/utilities/runTimeControl/runTimeControl.H