Package org.orekit.control.indirect.adjoint.cost

Class FieldCartesianFuelCost<T extends CalculusFieldElement<T>>

java.lang.Object

org.orekit.control.indirect.adjoint.cost.FieldAbstractCartesianCost<T>

org.orekit.control.indirect.adjoint.cost.FieldCartesianFuelCost<T>

All Implemented Interfaces:

FieldCartesianCost<T>

public class FieldCartesianFuelCost<T extends CalculusFieldElement<T>>
extends FieldAbstractCartesianCost<T>

Class for fuel cost with Cartesian coordinates. It is the integral over time of the Euclidean norm of the thrust vector.

Since:

13.0

Author:

Romain Serra

See Also:

CartesianCost

Constructor Summary

Constructors

Constructor	Description
FieldCartesianFuelCost(String name, T massFlowRateFactor, T maximumThrustMagnitude)	Constructor with default detection settings.
FieldCartesianFuelCost(String name, T massFlowRateFactor, T maximumThrustMagnitude, FieldEventDetectionSettings<T> eventDetectionSettings)	Constructor.

Method Summary

Modifier and Type	Method	Description
FieldEventDetectionSettings<T>	getEventDetectionSettings()	Getter for event detection settings.
Stream<FieldEventDetector<T>>	getFieldEventDetectors(Field<T> field)	Get the detectors needed for propagation.
T	getFieldHamiltonianContribution(T[] adjointVariables, T mass)	Computes the Hamiltonian contribution of the cost function.
FieldVector3D<T>	getFieldThrustAccelerationVector(T[] adjointVariables, T mass)	Computes the thrust acceleration vector in propagation frame from the adjoint variables and the mass.
T	getMaximumThrustMagnitude()	Getter for maximum thrust magnitude.
CartesianFuelCost	toCartesianCost()	Method returning equivalent in non-Field.
void	updateFieldAdjointDerivatives(T[] adjointVariables, T mass, T[] adjointDerivatives)	Update the adjoint derivatives if necessary.

Methods inherited from class org.orekit.control.indirect.adjoint.cost.FieldAbstractCartesianCost

getAdjointName, getFieldAdjointVelocityNorm, getMassFlowRateFactor

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.orekit.control.indirect.adjoint.cost.FieldCartesianCost

getAdjointDimension

Constructor Detail

FieldCartesianFuelCost

public FieldCartesianFuelCost(String name,
                              T massFlowRateFactor,
                              T maximumThrustMagnitude)

Constructor with default detection settings.

Parameters:

name - name

massFlowRateFactor - mass flow rate factor

maximumThrustMagnitude - maximum thrust magnitude

FieldCartesianFuelCost

public FieldCartesianFuelCost(String name,
                              T massFlowRateFactor,
                              T maximumThrustMagnitude,
                              FieldEventDetectionSettings<T> eventDetectionSettings)

Constructor.

Parameters:

name - name

massFlowRateFactor - mass flow rate factor

maximumThrustMagnitude - maximum thrust magnitude

eventDetectionSettings - singularity event detection settings

Method Detail

getEventDetectionSettings

public FieldEventDetectionSettings<T> getEventDetectionSettings()

Getter for event detection settings.

Returns:

detection settings.

getMaximumThrustMagnitude

public T getMaximumThrustMagnitude()

Getter for maximum thrust magnitude.

Returns:

maximum thrust

getFieldThrustAccelerationVector

public FieldVector3D<T> getFieldThrustAccelerationVector(T[] adjointVariables,
                                                         T mass)

Computes the thrust acceleration vector in propagation frame from the adjoint variables and the mass.

Parameters:

adjointVariables - adjoint vector

mass - mass

Returns:

thrust vector

updateFieldAdjointDerivatives

public void updateFieldAdjointDerivatives(T[] adjointVariables,
                                          T mass,
                                          T[] adjointDerivatives)

Update the adjoint derivatives if necessary.

Parameters:

adjointVariables - adjoint vector

mass - mass

adjointDerivatives - derivatives to update

getFieldHamiltonianContribution

public T getFieldHamiltonianContribution(T[] adjointVariables,
                                         T mass)

Computes the Hamiltonian contribution of the cost function.

Parameters:

adjointVariables - adjoint vector

mass - mass

Returns:

contribution to Hamiltonian

getFieldEventDetectors

public Stream<FieldEventDetector<T>> getFieldEventDetectors(Field<T> field)

Get the detectors needed for propagation.

Parameters:

field - field

Returns:

event detectors

toCartesianCost

public CartesianFuelCost toCartesianCost()

Description copied from interface: FieldCartesianCost

Method returning equivalent in non-Field.

Returns:

cost function for non-Field applications