org.orekit.propagation.integration

Class AdditionalEquationsAdapter

java.lang.Object

org.orekit.propagation.integration.AdditionalEquationsAdapter

All Implemented Interfaces:

AdditionalDerivativesProvider

Deprecated.

must be removed in 12.0 when AdditionalEquations is removed

@Deprecated
public class AdditionalEquationsAdapter
extends Object
implements AdditionalDerivativesProvider

Temporary adapter from AdditionalEquations to AdditionalDerivativesProvider.

Since:

11.1

Constructor Summary

Constructors

Constructor and Description
AdditionalEquationsAdapter(AdditionalEquations equations, Supplier<SpacecraftState> stateSupplier) Deprecated. Simple constructor.

Method Summary

Modifier and Type	Method and Description
CombinedDerivatives	combinedDerivatives(SpacecraftState state) Deprecated. Compute the derivatives related to the additional state (and optionally main state increments).
double[]	derivatives(SpacecraftState state) Deprecated.
int	getDimension() Deprecated. Get the dimension of the generated derivative.
String	getName() Deprecated. Get the name of the additional derivatives (which will become state once integrated).
void	init(SpacecraftState initialState, AbsoluteDate target) Deprecated. Initialize the generator at the start of propagation.
boolean	yield(SpacecraftState state) Deprecated. Check if this provider should yield so another provider has an opportunity to add missing parts.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdditionalEquationsAdapter

public AdditionalEquationsAdapter(AdditionalEquations equations,
                                  Supplier<SpacecraftState> stateSupplier)

Deprecated.

Simple constructor.

Parameters:

equations - wrapped equations

stateSupplier - supplier for reference state

Method Detail

getName

public String getName()

Deprecated.

Get the name of the additional derivatives (which will become state once integrated).

Specified by:

getName in interface AdditionalDerivativesProvider

Returns:

name of the additional state (names containing "orekit" with any case are reserved for the library internal use)

getDimension

public int getDimension()

Deprecated.

Get the dimension of the generated derivative.

Specified by:

getDimension in interface AdditionalDerivativesProvider

Returns:

dimension of the generated

yield

public boolean yield(SpacecraftState state)

Deprecated.

Check if this provider should yield so another provider has an opportunity to add missing parts.

Decision to yield is often based on an additional state being already available in the provided state (but it could theoretically also depend on an additional state derivative being already available, or any other criterion). If for example a provider needs the state transition matrix, it could implement this method as:

 public boolean yield(final SpacecraftState state) {
     return !state.getAdditionalStates().containsKey("STM");
 }
 

The default implementation returns false, meaning that derivative data can be computed immediately.

Specified by:

yield in interface AdditionalDerivativesProvider

Parameters:

state - state to handle

Returns:

true if this provider should yield so another provider has an opportunity to add missing parts as the state is incrementally built up

init

public void init(SpacecraftState initialState,
                 AbsoluteDate target)

Deprecated.

Initialize the generator at the start of propagation.

Specified by:

init in interface AdditionalDerivativesProvider

Parameters:

initialState - initial state information at the start of propagation

target - date of propagation

derivatives

@Deprecated
public double[] derivatives(SpacecraftState state)

Deprecated.

Compute the derivatives related to the additional state parameters.

Specified by:

derivatives in interface AdditionalDerivativesProvider

Parameters:

state - current state information: date, kinematics, attitude, and additional states this equations depend on (according to the yield method)

Returns:

computed derivatives

combinedDerivatives

public CombinedDerivatives combinedDerivatives(SpacecraftState state)

Deprecated.

Compute the derivatives related to the additional state (and optionally main state increments).

As of 11.2, there is a default implementation that calls the deprecated AdditionalDerivativesProvider.derivatives(SpacecraftState) method. This has been done for backward compatibility only and will be removed in 12.0.

Specified by:

combinedDerivatives in interface AdditionalDerivativesProvider

Parameters:

state - current state information: date, kinematics, attitude, and additional states this equations depend on (according to the yield method)

Returns:

computed combined derivatives, which may include some incremental coupling effect to add to main state derivatives