org.orekit.forces.maneuvers.jacobians

Class MassDepletionDelay

java.lang.Object

org.orekit.forces.maneuvers.jacobians.MassDepletionDelay

All Implemented Interfaces:

AdditionalDerivativesProvider

public class MassDepletionDelay
extends Object
implements AdditionalDerivativesProvider

Generator for effect of delaying mass depletion when delaying a maneuver.

Since:

11.1

Author:

Luc Maisonobe

Field Summary

Fields

Modifier and Type	Field and Description
static String	PREFIX Prefix for state name.

Constructor Summary

Constructors

Constructor and Description
MassDepletionDelay(String triggerName, boolean manageStart, Maneuver maneuver) Simple constructor.

Method Summary

Modifier and Type	Method and Description
CombinedDerivatives	combinedDerivatives(SpacecraftState state) Compute the derivatives related to the additional state (and optionally main state increments).
double[]	derivatives(SpacecraftState state) Deprecated.
int	getDimension() Get the dimension of the generated column.
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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.orekit.propagation.integration.AdditionalDerivativesProvider

yield

Field Detail

PREFIX

public static final String PREFIX

Prefix for state name.

See Also:

Constant Field Values

Constructor Detail

MassDepletionDelay

public MassDepletionDelay(String triggerName,
                          boolean manageStart,
                          Maneuver maneuver)

Simple constructor.

The generated additional state and derivatives will be named by prepending the PREFIX to the name of the date trigger parameter.

Parameters:

triggerName - name of the date trigger parameter

manageStart - if true, we compute derivatives with respect to maneuver start

maneuver - maneuver that is delayed

Method Detail

getName

public String getName()

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()

Get the dimension of the generated column.

Specified by:

getDimension in interface AdditionalDerivativesProvider

Returns:

dimension of the generated column

init

public void init(SpacecraftState initialState,
                 AbsoluteDate target)

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)

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