agi.foundation.propagators.advanced

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

Class PropagationEvaluationInformation

java.lang.Object

agi.foundation.propagators.advanced.PropagationEvaluationInformation

All Implemented Interfaces:

ImmutableValueType, ValueType

public final class PropagationEvaluationInformation
extends Object
implements ImmutableValueType

Represents information about the current integration step during propagation. This is used by the NumericalPropagator to parameterize the geometry based on the raw state and to obtain derivative information from the corresponding differential equations.

Constructor Summary

Constructors

Constructor and Description
PropagationEvaluationInformation() Initializes a new instance.
PropagationEvaluationInformation(DerivativeMode mode, JulianDate epoch, double epochSeconds, double[] state, double[] derivatives) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
DerivativeMode	getDerivativeMode() Gets the current mode in which the derivatives are to be evaluated.
double[]	getDerivatives() Gets the array representing the current derivatives of the dependent variables.
JulianDate	getEpoch() Gets the epoch of propagation from which the SecondsSinceEpoch (get) is measured.
double	getSecondsSinceEpoch() Gets the current value of the independent variable.
double[]	getState() Gets the current values of the dependent variables.
int	hashCode() Returns a hash code value for the object.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropagationEvaluationInformation

public PropagationEvaluationInformation()

Initializes a new instance.

PropagationEvaluationInformation

public PropagationEvaluationInformation(@Nonnull
                                        DerivativeMode mode,
                                        @Nonnull
                                        JulianDate epoch,
                                        double epochSeconds,
                                        double[] state,
                                        double[] derivatives)

Initializes a new instance.

Parameters:

mode - The current mode of derivative evaluation.

epoch - The time at which the independent variable is zero.

epochSeconds - The seconds elapsed since the propagation epoch.

state - The current overall state, including memory for storing the auxiliary variables.

derivatives - The current derivatives of the dependent variables in the state (not including auxiliary variables). This is set by the derivative evaluators during integration.

Method Detail

getDerivativeMode

@Nonnull
public final DerivativeMode getDerivativeMode()

Gets the current mode in which the derivatives are to be evaluated. This specifies whether to evaluate the entire set of derivatives or whether to evaluate an approximation.

getEpoch

@Nonnull
public final JulianDate getEpoch()

Gets the epoch of propagation from which the SecondsSinceEpoch (get) is measured.

getSecondsSinceEpoch

public final double getSecondsSinceEpoch()

Gets the current value of the independent variable.

getState

public final double[] getState()

Gets the current values of the dependent variables.

getDerivatives

public final double[] getDerivatives()

Gets the array representing the current derivatives of the dependent variables.

equals

public boolean equals(Object obj)

Description copied from class: java.lang.Object

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare.

Returns:

true if this object is the same as the obj argument; false otherwise.

See Also:

Object.hashCode(), HashMap

hashCode

public int hashCode()

Description copied from class: java.lang.Object

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals(Object) method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the Object.equals(java.lang.Object) method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the Java™ programming language.)

Overrides:

hashCode in class Object

Returns:

a hash code value for this object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)