StopCondition¶

class StopCondition(sensor: SensorBase, threshold: UnitBase, operator: OperatorBase)¶

Attributes¶

sensorSensorBase: The sensor to be monitored to check if the stop condition is valid.
thresholdUnitBase: The threshold value that triggers the stop condition.
operatorOperatorBase: The comparison operator to use to check if the stop condition is valid.

check_condition(): It applies the comparison operator to the sensor value and the threshold value to check if the stop condition is valid.

check_condition() → bool¶

It applies the comparison operator to the sensor value and the threshold value to check if the stop condition is valid.

If the stop condition is valid, then the Solver stops the computation even if it is not completed to the final simulation time.

property operator: OperatorBase¶

The comparison operator to use to check if the stop condition is valid.

The available operators are:

StopCondition.greater_than to check if the sensor value is greater than the threshold value,
StopCondition.greater_than_or_equal_to to check if the sensor value is greater than or equal to the threshold value,
StopCondition.equal_to to check if the sensor value is equal to the threshold value,
StopCondition.less_than to check if the sensor value is less than the threshold value,
StopCondition.less_than_or_equal_to to check if the sensor value is less than or equal to the threshold value.

OperatorBase: The comparison operator to use to check if the stop condition is valid.

Raises

property sensor: SensorBase¶

The sensor to be monitored to check if the stop condition is valid.

SensorBase: The sensor to be monitored to check if the stop condition is valid.

Raises

Raises