NumericalPropagatorPropagateUntilStop Method (IEnumerableStoppingConditionEvaluator, IntegrationSense, Boolean, ITrackCalculationProgress) |
Propagates until one of the conditions are tripped.
Namespace:
AGI.Foundation.Propagators
Assembly:
AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.3.420.0 (24.3.420.0)
Syntax public StoppableNumericalPropagatorResults PropagateUntilStop(
IEnumerable<StoppingConditionEvaluator> conditions,
IntegrationSense direction,
bool initializeStoppingCondition,
ITrackCalculationProgress progressTracker
)
Public Function PropagateUntilStop (
conditions As IEnumerable(Of StoppingConditionEvaluator),
direction As IntegrationSense,
initializeStoppingCondition As Boolean,
progressTracker As ITrackCalculationProgress
) As StoppableNumericalPropagatorResults
public:
StoppableNumericalPropagatorResults^ PropagateUntilStop(
IEnumerable<StoppingConditionEvaluator^>^ conditions,
IntegrationSense direction,
bool initializeStoppingCondition,
ITrackCalculationProgress^ progressTracker
)
member PropagateUntilStop :
conditions : IEnumerable<StoppingConditionEvaluator> *
direction : IntegrationSense *
initializeStoppingCondition : bool *
progressTracker : ITrackCalculationProgress -> StoppableNumericalPropagatorResults
Parameters
- conditions
- Type: System.Collections.GenericIEnumerableStoppingConditionEvaluator
The conditions to stop on. - direction
- Type: AGI.Foundation.NumericalMethodsIntegrationSense
The direction to search for an event. - initializeStoppingCondition
- Type: SystemBoolean
Indicates if the conditions should be
initialized. Set this to if
the conditions have been initialized prior to this method being called. - progressTracker
- Type: AGI.FoundationITrackCalculationProgress
An optional progress tracker.
How long the segment will take to propagate generally is not known ahead of time, so the reported
progress completed is set to -1. But you can cancel propagation with the tracker.
Return Value
Type:
StoppableNumericalPropagatorResultsThe ephemeris and information about the stopping event.
See Also