Class PythonFieldAdditionalDerivativesProvider<T extends CalculusFieldElement<T>>
- java.lang.Object
-
- org.orekit.propagation.integration.PythonFieldAdditionalDerivativesProvider<T>
-
- All Implemented Interfaces:
FieldAdditionalDerivativesProvider<T>
public class PythonFieldAdditionalDerivativesProvider<T extends CalculusFieldElement<T>> extends Object implements FieldAdditionalDerivativesProvider<T>
-
-
Field Summary
Fields Modifier and Type Field Description protected long
pythonObject
Part of JCC Python interface to object
-
Constructor Summary
Constructors Constructor Description PythonFieldAdditionalDerivativesProvider()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FieldCombinedDerivatives<T>
combinedDerivatives(FieldSpacecraftState<T> s)
Compute the derivatives related to the additional state (and optionally main state increments).void
finalize()
int
getDimension()
Get the dimension of the generated derivative.String
getName()
Get the name of the additional derivatives (which will become state once integrated).void
init(FieldSpacecraftState<T> initialState, FieldAbsoluteDate<T> target)
Initialize the generator at the start of propagation.void
pythonDecRef()
long
pythonExtension()
void
pythonExtension(long pythonObject)
boolean
yields(FieldSpacecraftState<T> state)
Check if this provider should yield so another provider has an opportunity to add missing parts.
-
-
-
Method Detail
-
pythonExtension
public void pythonExtension(long pythonObject)
-
pythonExtension
public long pythonExtension()
-
finalize
public void finalize() throws Throwable
-
pythonDecRef
public void pythonDecRef()
-
getName
public String getName()
Get the name of the additional derivatives (which will become state once integrated).- Specified by:
getName
in interfaceFieldAdditionalDerivativesProvider<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()
Get the dimension of the generated derivative.- Specified by:
getDimension
in interfaceFieldAdditionalDerivativesProvider<T extends CalculusFieldElement<T>>
- Returns:
- dimension of the generated
-
init
public void init(FieldSpacecraftState<T> initialState, FieldAbsoluteDate<T> target)
Description copied from interface:FieldAdditionalDerivativesProvider
Initialize the generator at the start of propagation.- Specified by:
init
in interfaceFieldAdditionalDerivativesProvider<T extends CalculusFieldElement<T>>
- Parameters:
initialState
- initial state information at the start of propagationtarget
- date of propagation
-
yields
public boolean yields(FieldSpacecraftState<T> state)
Description copied from interface:FieldAdditionalDerivativesProvider
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 providedstate
(but it could theoretically also depend on an additional state derivative beingalready 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 becomputed
immediately.- Specified by:
yields
in interfaceFieldAdditionalDerivativesProvider<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
-
combinedDerivatives
public FieldCombinedDerivatives<T> combinedDerivatives(FieldSpacecraftState<T> s)
Description copied from interface:FieldAdditionalDerivativesProvider
Compute the derivatives related to the additional state (and optionally main state increments).- Specified by:
combinedDerivatives
in interfaceFieldAdditionalDerivativesProvider<T extends CalculusFieldElement<T>>
- Parameters:
s
- current state information: date, kinematics, attitude, and additional states this equations depend on (according to theyield
method)- Returns:
- computed combined derivatives, which may include some incremental coupling effect to add to main state derivatives
-
-