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

Class FieldQuadraticPenaltyCartesianFuel<T extends CalculusFieldElement<T>>

java.lang.Object

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

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

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

Type Parameters:

T - type of the field elements

All Implemented Interfaces:

FieldCartesianCost<T>

public class FieldQuadraticPenaltyCartesianFuel<T extends CalculusFieldElement<T>>
extends FieldPenalizedCartesianFuelCost<T>

Fuel cost penalized with a quadratic term. For epsilon equal to 1, one gets the bounded energy cost.

Since:

13.0

Author:

Romain Serra

See Also:

• BoundedCartesianEnergy

Nested Class Summary

Nested classes/interfaces inherited from class org.orekit.control.indirect.adjoint.cost.FieldAbstractCartesianCost

FieldAbstractCartesianCost.FieldSwitchFunction

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
T	evaluateFieldPenaltyFunction(T controlNorm)	Evaluate the penalty term (without the weight), assumed to be a function of the control norm.
FieldEventDetectionSettings<T>	getEventDetectionSettings()	Getter for the event detection settings.
Stream<FieldEventDetector<T>>	getFieldEventDetectors(Field<T> field)	Get the detectors needed for propagation.
FieldVector3D<T>	getFieldThrustAccelerationVector(T[] adjointVariables, T mass)	Computes the thrust acceleration vector in propagation frame from the adjoint variables and the mass.
QuadraticPenaltyCartesianFuel	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.FieldPenalizedCartesianFuelCost

getEpsilon, getFieldHamiltonianContribution, getFieldThrustDirection, getMaximumThrustMagnitude

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

buildSwitchDetector, getAdjointDimension, 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

getCostDerivativeProvider

Constructor Details

FieldQuadraticPenaltyCartesianFuel

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

Constructor.

Parameters:

name - adjoint name

massFlowRateFactor - mass flow rate factor

maximumThrustMagnitude - maximum thrust magnitude

epsilon - penalty weight

eventDetectionSettings - detection settings

FieldQuadraticPenaltyCartesianFuel

public FieldQuadraticPenaltyCartesianFuel(String name,
 T massFlowRateFactor,
 T maximumThrustMagnitude,
 T epsilon)

Constructor with default event detection settings.

Parameters:

name - adjoint name

massFlowRateFactor - mass flow rate factor

maximumThrustMagnitude - maximum thrust magnitude

epsilon - penalty weight

Method Details

getEventDetectionSettings

public FieldEventDetectionSettings<T> getEventDetectionSettings()

Getter for the event detection settings.

Returns:

detection settings

evaluateFieldPenaltyFunction

public T evaluateFieldPenaltyFunction(T controlNorm)

Evaluate the penalty term (without the weight), assumed to be a function of the control norm.

Specified by:

evaluateFieldPenaltyFunction in class FieldPenalizedCartesianFuelCost<T extends CalculusFieldElement<T>>

Parameters:

controlNorm - Euclidean norm of control vector

Returns:

penalty function

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

getFieldEventDetectors

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

Get the detectors needed for propagation.

Parameters:

field - field

Returns:

event detectors

toCartesianCost

public QuadraticPenaltyCartesianFuel toCartesianCost()

Method returning equivalent in non-Field.

Returns:

cost function for non-Field applications