StoppingCriterion

class StoppingCriterion

Bases: Flow360BaseModel

StoppingCriterion class for RunControl.stopping_criteria settings.

Example

Define a stopping criterion on a ProbeOutput with a tolerance of 0.01. The ProbeOutput monitors the moving range of Helicity in a moving window of 10 steps, at the location of (0, 0, 0,005) * fl.u.m.

>>> monitored_variable = fl.UserVariable(
...     name="Helicity_user",
...     value=fl.math.dot(fl.solution.velocity, fl.solution.vorticity),
... )
>>> criterion = fl.StoppingCriterion(
...     name="Criterion_1",
...     monitor_output=fl.ProbeOutput(
...         name="Helicity_probe",
...         output_fields=[
...             monitored_variable,
...         ],
...         probe_points=fl.Point(name="Point1", location=(0, 0, 0.005) * fl.u.m),
...         moving_statistic = fl.MovingStatistic(method = "range", moving_window_size = 10)
...     ),
...     monitor_field=monitored_variable,
...     tolerance=0.01,
... )

---

Attributes

name: str, optional

Name of this criterion.

Default:

'StoppingCriterion'

monitor_field: UserVariable | str

The field to be monitored. This field must be present in the output_fields of monitor_output.

monitor_output: ForceOutput | SurfaceIntegralOutput | ProbeOutput | SurfaceProbeOutput | str

The monitored output or its id.

tolerance: Expression | UnytQuantity | float

The tolerance threshold of this criterion.

tolerance_window_size: int, optional

The number of data points from the monitor_output to be used to check whether the \(|max-min|/2\) of the monitored field within this window is below tolerance or not. If not set, the criterion will directly compare the latest value with tolerance.

Default:

None

Additional Constructors

classmethod from_file(filename)

Loads a Flow360BaseModel from .json, or .yaml file.

Parameters:

filename (str) – Full path to the .yaml or .json file to load the Flow360BaseModel from.

Returns:

An instance of the component class calling load.

Return type:

Flow360BaseModel

Example

>>> params = Flow360BaseModel.from_file(filename='folder/sim.json') 

Methods

help(methods=False)

Prints message describing the fields and methods of a Flow360BaseModel.

Parameters:

methods (bool = False) – Whether to also print out information about object’s methods.

Return type:

None

Example

>>> params.help(methods=True) 

to_file(filename, **kwargs)

Exports Flow360BaseModel instance to .json or .yaml file

Parameters:

filename (str) – Full path to the .json or .yaml or file to save the Flow360BaseModel to.

Return type:

None

Example

>>> params.to_file(filename='folder/flow360.json')