Package org.orekit.control.indirect.adjoint

Interface CartesianAdjointEquationTerm

All Known Implementing Classes:

AbstractCartesianAdjointEquationTerm, AbstractCartesianAdjointGravitationalTerm, AbstractCartesianAdjointNewtonianTerm, AbstractCartesianAdjointNonCentralBodyTerm, CartesianAdjointInertialTerm, CartesianAdjointJ2Term, CartesianAdjointKeplerianTerm, CartesianAdjointSingleBodyTerm, CartesianAdjointThirdBodyTerm

public interface CartesianAdjointEquationTerm

Interface to define terms in the adjoint equations and Hamiltonian for Cartesian coordinates.

Since:

12.2

Author:

Romain Serra

See Also:

CartesianAdjointDerivativesProvider, FieldCartesianAdjointDerivativesProvider

Method Summary

Modifier and Type	Method	Description
<T extends CalculusFieldElement<T>> T	getFieldHamiltonianContribution(FieldAbsoluteDate<T> date, T[] stateVariables, T[] adjointVariables, Frame frame)	Computes the contribution to the Hamiltonian.
<T extends CalculusFieldElement<T>> T[]	getFieldRatesContribution(FieldAbsoluteDate<T> date, T[] stateVariables, T[] adjointVariables, Frame frame)	Computes the contribution to the rates of the adjoint variables.
double	getHamiltonianContribution(AbsoluteDate date, double[] stateVariables, double[] adjointVariables, Frame frame)	Computes the contribution to the Hamiltonian.
double[]	getRatesContribution(AbsoluteDate date, double[] stateVariables, double[] adjointVariables, Frame frame)	Computes the contribution to the rates of the adjoint variables.

Method Detail

getRatesContribution

double[] getRatesContribution(AbsoluteDate date,
                              double[] stateVariables,
                              double[] adjointVariables,
                              Frame frame)

Computes the contribution to the rates of the adjoint variables.

Parameters:

date - date

stateVariables - state variables

adjointVariables - adjoint variables

frame - propagation frame

Returns:

contribution to the adjoint derivative vector

getFieldRatesContribution

<T extends CalculusFieldElement<T>> T[] getFieldRatesContribution(FieldAbsoluteDate<T> date,
                                                                  T[] stateVariables,
                                                                  T[] adjointVariables,
                                                                  Frame frame)

Computes the contribution to the rates of the adjoint variables.

Type Parameters:

T - field type

Parameters:

date - date

stateVariables - state variables

adjointVariables - adjoint variables

frame - propagation frame

Returns:

contribution to the adjoint derivative vector

getHamiltonianContribution

double getHamiltonianContribution(AbsoluteDate date,
                                  double[] stateVariables,
                                  double[] adjointVariables,
                                  Frame frame)

Computes the contribution to the Hamiltonian.

Parameters:

date - date

stateVariables - state variables

adjointVariables - adjoint variables

frame - propagation frame

Returns:

contribution to the Hamiltonian

getFieldHamiltonianContribution

<T extends CalculusFieldElement<T>> T getFieldHamiltonianContribution(FieldAbsoluteDate<T> date,
                                                                      T[] stateVariables,
                                                                      T[] adjointVariables,
                                                                      Frame frame)

Computes the contribution to the Hamiltonian.

Type Parameters:

T - field type

Parameters:

date - date

stateVariables - state variables

adjointVariables - adjoint variables

frame - propagation frame

Returns:

contribution to the Hamiltonian