NumericalPropagatorPropagate Method (Duration, Int32, ITrackCalculationProgress) |
Namespace:
AGI.Foundation.Propagators
Assembly:
AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.3.420.0 (24.3.420.0)
Syntax public NumericalPropagationStateHistory Propagate(
Duration propagationTime,
int outputSparsity,
ITrackCalculationProgress tracker
)
Public Function Propagate (
propagationTime As Duration,
outputSparsity As Integer,
tracker As ITrackCalculationProgress
) As NumericalPropagationStateHistory
public:
NumericalPropagationStateHistory^ Propagate(
Duration propagationTime,
int outputSparsity,
ITrackCalculationProgress^ tracker
)
member Propagate :
propagationTime : Duration *
outputSparsity : int *
tracker : ITrackCalculationProgress -> NumericalPropagationStateHistory
Parameters
- propagationTime
- Type: AGI.Foundation.TimeDuration
The (positive or negative) total time, measured from
the CurrentTime, over which to propagate.
A negative duration will indicate that the propagator should propagate backwards
in time. - 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 state history
for every integration 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, etc. - tracker
- Type: AGI.FoundationITrackCalculationProgress
A progress tracker which will report the progress of the propagation
from 0 percent to 100 percent.
Return Value
Type:
NumericalPropagationStateHistoryA collection of arrays containing the raw state information,
and if
IncludeIntegratorInformationInOutput is true it also contains the combined
integration information over the propagation and the average step size.
See Also