Package org.orekit.control.indirect.adjoint

Class AbstractCartesianAdjointGravitationalTerm

java.lang.Object

org.orekit.control.indirect.adjoint.AbstractCartesianAdjointEquationTerm

org.orekit.control.indirect.adjoint.AbstractCartesianAdjointGravitationalTerm

All Implemented Interfaces:

CartesianAdjointEquationTerm

Direct Known Subclasses:

AbstractCartesianAdjointNewtonianTerm, CartesianAdjointJ2Term

public abstract class AbstractCartesianAdjointGravitationalTerm
extends AbstractCartesianAdjointEquationTerm

Abstract class for common computations regarding adjoint dynamics and gravity for Cartesian coordinates.

Since:

12.2

Author:

Romain Serra

See Also:

CartesianAdjointEquationTerm

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCartesianAdjointGravitationalTerm(double mu)	Constructor.

Method Summary

Modifier and Type	Method	Description
<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	getMu()	Getter for the gravitational constant.
protected abstract double[]	getPositionAdjointContribution(AbsoluteDate date, double[] stateVariables, double[] adjointVariables, Frame frame)	Computes the contribution to position adjoint derivatives.
protected abstract <T extends CalculusFieldElement<T>> T[]	getPositionAdjointFieldContribution(FieldAbsoluteDate<T> date, T[] stateVariables, T[] adjointVariables, Frame frame)	Computes the contribution to position adjoint derivatives.
double[]	getRatesContribution(AbsoluteDate date, double[] stateVariables, double[] adjointVariables, Frame frame)	Computes the contribution to the rates of the adjoint variables.

Methods inherited from class org.orekit.control.indirect.adjoint.AbstractCartesianAdjointEquationTerm

buildFieldGradientCartesianVector, buildGradientCartesianVector, getAcceleration, getFieldAcceleration, getFieldHamiltonianContribution, getHamiltonianContribution

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCartesianAdjointGravitationalTerm

protected AbstractCartesianAdjointGravitationalTerm(double mu)

Constructor.

Parameters:

mu - body gravitational parameter

Method Detail

getMu

public double getMu()

Getter for the gravitational constant.

Returns:

mu

getRatesContribution

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

Computes the contribution to the rates of the adjoint variables.

Specified by:

getRatesContribution in interface CartesianAdjointEquationTerm

Overrides:

getRatesContribution in class AbstractCartesianAdjointEquationTerm

Parameters:

date - date

stateVariables - state variables

adjointVariables - adjoint variables

frame - propagation frame

Returns:

contribution to the adjoint derivative vector

getPositionAdjointContribution

protected abstract double[] getPositionAdjointContribution(AbsoluteDate date,
                                                           double[] stateVariables,
                                                           double[] adjointVariables,
                                                           Frame frame)

Computes the contribution to position adjoint derivatives.

Parameters:

date - date

stateVariables - state variables

adjointVariables - adjoint variables

frame - propagation frame

Returns:

contribution to position adjoint derivatives

getFieldRatesContribution

public <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.

Specified by:

getFieldRatesContribution in interface CartesianAdjointEquationTerm

Overrides:

getFieldRatesContribution in class AbstractCartesianAdjointEquationTerm

Type Parameters:

T - field type

Parameters:

date - date

stateVariables - state variables

adjointVariables - adjoint variables

frame - propagation frame

Returns:

contribution to the adjoint derivative vector

getPositionAdjointFieldContribution

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

Computes the contribution to position adjoint derivatives.

Type Parameters:

T - field type

Parameters:

date - date

stateVariables - state variables

adjointVariables - adjoint variables

frame - propagation frame

Returns:

contribution to position adjoint derivatives