Class PythonAdditionalDerivativesProvider
- java.lang.Object
-
- org.orekit.propagation.integration.PythonAdditionalDerivativesProvider
-
- All Implemented Interfaces:
AdditionalDerivativesProvider
public class PythonAdditionalDerivativesProvider extends Object implements AdditionalDerivativesProvider
-
-
Constructor Summary
Constructors Constructor Description PythonAdditionalDerivativesProvider()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CombinedDerivatives
combinedDerivatives(SpacecraftState s)
Compute the derivatives related to the additional state (and optionally main state increments).void
finalize()
Part of JCC Python interface to objectint
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(SpacecraftState initialState, AbsoluteDate target)
Initialize the generator at the start of propagation.void
pythonDecRef()
Part of JCC Python interface to objectlong
pythonExtension()
Part of JCC Python interface to objectvoid
pythonExtension(long pythonObject)
Part of JCC Python interface to objectboolean
yields(SpacecraftState 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)
Part of JCC Python interface to object
-
pythonExtension
public long pythonExtension()
Part of JCC Python interface to object
-
finalize
public void finalize() throws Throwable
Part of JCC Python interface to object
-
pythonDecRef
public void pythonDecRef()
Part of JCC Python interface to object
-
getName
public String getName()
Get the name of the additional derivatives (which will become state once integrated).- Specified by:
getName
in interfaceAdditionalDerivativesProvider
- 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 interfaceAdditionalDerivativesProvider
- Returns:
- dimension of the generated
-
init
public void init(SpacecraftState initialState, AbsoluteDate target)
Initialize the generator at the start of propagation.- Specified by:
init
in interfaceAdditionalDerivativesProvider
- Parameters:
initialState
- initial state information at the start of propagationtarget
- date of propagation
-
yields
public boolean yields(SpacecraftState state)
Description copied from interface:AdditionalDerivativesProvider
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 SpacecraftState state) { return !state.getAdditionalStates().containsKey("STM"); }
The default implementation returns
false
, meaning that derivative data can becomputed
immediately.- Specified by:
yields
in interfaceAdditionalDerivativesProvider
- 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 CombinedDerivatives combinedDerivatives(SpacecraftState s)
Description copied from interface:AdditionalDerivativesProvider
Compute the derivatives related to the additional state (and optionally main state increments).- Specified by:
combinedDerivatives
in interfaceAdditionalDerivativesProvider
- 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
-
-