Click or drag to resize

StoppingCondition Properties

The StoppingCondition type exposes the following members.

Public propertyAngularSetting
Gets or sets the range a value should be cropped to if the value computed is a angle, or indicates that the value computed is not an angle. By default this is set to NotCircular.
Public propertyConstraints
Gets additional constraints on the stopping condition. The constraints allow you to add extra criteria to whether an event should be considered valid to stop on. See their help for more information.
Public propertyEnabled
Gets or sets if this StoppingCondition will be considered during propagation.
Public propertyFunctionTolerance
Gets or sets how close the function value must get to the threshold to be considered equal to. Note that even if there is unquestionably a threshold, if the event search can not converge to a value at or below this value, it will not satisfy the stopping condition and no event will be logged. This must be larger than machine precision of values near the threshold.
Public propertyIsFrozen
Gets a value indicating whether this object is frozen. A frozen object cannot be modified and an ObjectFrozenException will be thrown if an attempt is made to do so.
(Inherited from DefinitionalObject.)
Public propertyName
Gets or sets an optional name for this stopping condition.
Public propertyRequireFunctionTolerance
Gets or sets a value indicating whether the FunctionTolerance does not need to be satisfied. The search for an event will still attempt to converge to within the FunctionTolerance, but if it is known that an event is there (such as a threshold crossing), the event will be reported and this condition consider satisfied even if the search did not converge within the FunctionTolerance. This is by default.
Public propertySatisfiedCallback
Gets or sets a callback that is executed when this condition is satisfied.
Public propertyStopOnEventNumber
Gets or sets how many times the threshold must be met, or how many extrema must be found before stopping. If a StoppingConditionEvaluator finds a valid stop except for a constraint being unsatisfied, that will not count as a crossing.
Public propertyTypeOfStoppingCondition
Gets or sets the type of the event to stop on (extrema, threshold, ...).
See Also