ValueInStateStoppingCondition Properties |
The ValueInStateStoppingCondition type exposes the following members.
Name | Description | |
---|---|---|
AngularSetting |
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.
(Inherited from StoppingCondition.) | |
Constraints |
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.
(Inherited from StoppingCondition.) | |
ElementIdentification |
Gets or sets the name of the element in the state that should be sampled by this condition.
| |
Enabled |
Gets or sets if this StoppingCondition will be considered during propagation.
(Inherited from StoppingCondition.) | |
FunctionTolerance |
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.
(Inherited from StoppingCondition.) | |
IsFrozen |
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.) | |
Name |
Gets or sets an optional name for this stopping condition.
(Inherited from StoppingCondition.) | |
RequireFunctionTolerance |
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.
(Inherited from StoppingCondition.) | |
SatisfiedCallback |
Gets or sets a callback that is executed when this condition is satisfied.
(Inherited from StoppingCondition.) | |
StopOnEventNumber |
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.
(Inherited from StoppingCondition.) | |
Threshold |
Gets or sets the threshold to stop at. This value is ignored if the TypeOfStoppingCondition
indicates to stop on an extrema. This ValueDefinitionT will be evaluated when the
evaluator is initialized and that initial value will
be used as the threshold for the actual root finding that the StoppablePropagator will search for.
Remarks It is possible to assign the same ValueDefinitionT for multiple conditions. This can be useful in cases when you have multiple propagators that you want to be in lock step. Note that a ConstantValueDefinitionT can be used here when the actual threshold value is not known or must be changed at runtime. This ValueDefinitionT by definition cannot vary with time. | |
TypeOfStoppingCondition |
Gets or sets the type of the event to stop on (extrema, threshold, ...).
(Inherited from StoppingCondition.) |