org.orekit.propagation.integration

Class FieldAdditionalEquationsAdapter<T extends CalculusFieldElement<T>>

java.lang.Object

org.orekit.propagation.integration.FieldAdditionalEquationsAdapter<T>

All Implemented Interfaces:

FieldAdditionalDerivativesProvider<T>

Deprecated.

must be removed in 12.0 when AdditionalEquations is removed

@Deprecated
public class FieldAdditionalEquationsAdapter<T extends CalculusFieldElement<T>>
extends Object
implements FieldAdditionalDerivativesProvider<T>

Temporary adapter from FieldAdditionalEquations to FieldAdditionalDerivativesProvider.

Since:

11.1

Constructor Summary

Constructors

Constructor and Description
FieldAdditionalEquationsAdapter(FieldAdditionalEquations<T> equations, Supplier<FieldSpacecraftState<T>> stateSupplier) Deprecated. Simple constructor.

Method Summary

Modifier and Type	Method and Description
T[]	derivatives(FieldSpacecraftState<T> state) Deprecated. Compute the derivatives related to the additional state parameters.
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(FieldSpacecraftState<T> initialState, FieldAbsoluteDate<T> target) Deprecated. Initialize the generator at the start of propagation.
boolean	yield(FieldSpacecraftState<T> 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

FieldAdditionalEquationsAdapter

public FieldAdditionalEquationsAdapter(FieldAdditionalEquations<T> equations,
                                       Supplier<FieldSpacecraftState<T>> 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 FieldAdditionalDerivativesProvider<T extends CalculusFieldElement<T>>

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 FieldAdditionalDerivativesProvider<T extends CalculusFieldElement<T>>

Returns:

dimension of the generated

yield

public boolean yield(FieldSpacecraftState<T> 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 FieldSpacecraftState<T> state) {
     return !state.getAdditionalStates().containsKey("STM");
 }
 

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

Specified by:

yield in interface FieldAdditionalDerivativesProvider<T extends CalculusFieldElement<T>>

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(FieldSpacecraftState<T> initialState,
                 FieldAbsoluteDate<T> target)

Deprecated.

Initialize the generator at the start of propagation.

Specified by:

init in interface FieldAdditionalDerivativesProvider<T extends CalculusFieldElement<T>>

Parameters:

initialState - initial state information at the start of propagation

target - date of propagation

derivatives

public T[] derivatives(FieldSpacecraftState<T> state)

Deprecated.

Compute the derivatives related to the additional state parameters.

Specified by:

derivatives in interface FieldAdditionalDerivativesProvider<T extends CalculusFieldElement<T>>

Parameters:

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

Returns:

computed derivatives