agi.foundation.propagators

(agi.foundation.models-2024r3.jar)

Class NumericalIntegrationInformation

java.lang.Object

agi.foundation.propagators.NumericalIntegrationInformation

public class NumericalIntegrationInformation
extends Object

Contains information about the behavior of an integrator in a given integration step.

Constructor Summary

Constructors

Constructor and Description
NumericalIntegrationInformation(StepSizeInformation info, double stepSize) Create an instance based on the given information.

Method Summary

Modifier and Type	Method and Description
StepSizeInformation	getStepSizeInformation() Gets information about the behavior of the step size during the integration step including whether it was altered or not.
double	getStepSizeTaken() Gets the size of the step which was taken to produce the current state.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NumericalIntegrationInformation

public NumericalIntegrationInformation(@Nonnull
                                       StepSizeInformation info,
                                       double stepSize)

Create an instance based on the given information.

Parameters:

info - Information on the behavior of the step size during integration.

stepSize - The size of the given integration step.

Method Detail

getStepSizeInformation

@Nonnull
public final StepSizeInformation getStepSizeInformation()

Gets information about the behavior of the step size during the integration step including whether it was altered or not.

getStepSizeTaken

public final double getStepSizeTaken()

Gets the size of the step which was taken to produce the current state.