Click or drag to resize

StoppablePropagatorPropagateUntilStop Method (ITimeBasedState, 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: 24.3.420.0 (24.3.420.0)
Syntax
Copy
public StoppablePropagatorResults PropagateUntilStop(
	ITimeBasedState initialState,
	IEnumerable<StoppingConditionEvaluator> conditions,
	IntegrationSense direction,
	bool initializeStoppingCondition,
	int outputSparsity,
	ITrackCalculationProgress progressTracker
)

Parameters

initialState
Type: AGI.Foundation.CoordinatesITimeBasedState
The initial state to start propagating from.
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.
outputSparsity
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 saved states for every step. If a thinner (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.
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: StoppablePropagatorResults
The ephemeris and information about the stopping event.
See Also