RunControl

RunControl#

class RunControl[source]#

Bases: Flow360BaseModel

RunControl class for run control settings.

Example

>>> criterion = fl.StoppingCriterion(...)
>>> fl.RunControl(
...     stopping_criteria = [criterion],
... )

Attributes

stopping_criteria: list[flow360_schema.models.simulation.run_control.stopping_criterion.StoppingCriterion] | None#

A list of StoppingCriterion for the solver. All criteria must be met at the same time to stop the solver.

Default:

None

Additional Constructors

classmethod from_file(filename)#

Load a Flow360BaseModel from a .json file.

Parameters:

filename (str)

Return type:

Flow360BaseModel

Methods

help(methods=False)#

Print fields and methods of a Flow360BaseModel using rich.

Parameters:

methods (bool)

Return type:

None

to_file(filename, **kwargs)#

Export Flow360BaseModel instance to a .json file.

Parameters:
Return type:

None