Click or drag to resize

NumericalPropagatorPropagateUntilStop Method (IEnumerableStoppingConditionEvaluator, IntegrationSense, Boolean, Int32, ITrackCalculationProgress)

Propagates until one of the conditions are tripped.

Namespace:  AGI.Foundation.Propagators
Assembly:  AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 23.1.416.0 (23.1.416.0)
public StoppableNumericalPropagatorResults PropagateUntilStop(
	IEnumerable<StoppingConditionEvaluator> conditions,
	IntegrationSense direction,
	bool initializeStoppingCondition,
	int outputSparsity,
	ITrackCalculationProgress progressTracker


Type: System.Collections.GenericIEnumerableStoppingConditionEvaluator
The conditions to stop on.
Type: AGI.Foundation.NumericalMethodsIntegrationSense
The direction to search for an event.
Type: SystemBoolean
Indicates if the conditions should be initialized. Set this to if the conditions have been initialized prior to this method being called.
Type: SystemInt32
The interval at which to produce output samples. By default this should be set to one, meaning that output will be saved in the state history for every integration step. If a coarser (but less accurate) ephemeris is desired you can set this to a higher number. Two means that output is saved every other integration step, etc, etc.
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: StoppableNumericalPropagatorResults
The ephemeris and information about the stopping event.
See Also