Package org.orekit.control.indirect.shooting.propagation

Class CartesianAdjointDynamicsProviderFactory

java.lang.Object

org.orekit.control.indirect.shooting.propagation.CartesianAdjointDynamicsProviderFactory

public class CartesianAdjointDynamicsProviderFactory
extends Object

Factory for common Cartesian adjoint dynamics providers.

Since:

13.0

Author:

Romain Serra

See Also:

• AdjointDynamicsProvider

Method Summary

Modifier and Type	Method	Description
static CartesianAdjointDynamicsProvider	buildBoundedEnergyProvider(String adjointName, double massFlowRateFactor, double maximumThrustMagnitude, EventDetectionSettings eventDetectionSettings, CartesianAdjointEquationTerm... cartesianAdjointEquationTerms)	Method building a provider with bounded Cartesian energy as cost.
static CartesianAdjointDynamicsProvider	buildBoundedFuelCostProvider(String adjointName, double massFlowRateFactor, double maximumThrustMagnitude, EventDetectionSettings eventDetectionSettings, CartesianAdjointEquationTerm... cartesianAdjointEquationTerms)	Method building a provider with bounded Cartesian fuel as cost.
static CartesianAdjointDynamicsProvider	buildFlightDurationProvider(String adjointName, double massFlowRateFactor, double maximumThrustMagnitude, CartesianAdjointEquationTerm... cartesianAdjointEquationTerms)	Method building a provider with unbounded Cartesian energy and vanishing mass flow as cost.
static CartesianAdjointDynamicsProvider	buildLogarithmicBarrierFuelCostProvider(String adjointName, double massFlowRateFactor, double maximumThrustMagnitude, double epsilon, CartesianAdjointEquationTerm... cartesianAdjointEquationTerms)	Method building a provider with bounded Cartesian fuel penalized with a logarithmic barrier.
static CartesianAdjointDynamicsProvider	buildQuadraticPenaltyFuelCostProvider(String adjointName, double massFlowRateFactor, double maximumThrustMagnitude, double epsilon, EventDetectionSettings eventDetectionSettings, CartesianAdjointEquationTerm... cartesianAdjointEquationTerms)	Method building a provider with bounded Cartesian fuel penalized with a quadratic term.
static CartesianAdjointDynamicsProvider	buildUnboundedEnergyProvider(String adjointName, double massFlowRateFactor, EventDetectionSettings eventDetectionSettings, CartesianAdjointEquationTerm... cartesianAdjointEquationTerms)	Method building a provider with unbounded Cartesian energy as cost.
static CartesianAdjointDynamicsProvider	buildUnboundedEnergyProviderNeglectingMass(String adjointName, CartesianAdjointEquationTerm... cartesianAdjointEquationTerms)	Method building a provider with unbounded Cartesian energy and vanishing mass flow as cost.

Methods inherited from class java.lang.Object

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

Method Details

buildFlightDurationProvider

public static CartesianAdjointDynamicsProvider buildFlightDurationProvider(String adjointName,
 double massFlowRateFactor,
 double maximumThrustMagnitude,
 CartesianAdjointEquationTerm... cartesianAdjointEquationTerms)

Method building a provider with unbounded Cartesian energy and vanishing mass flow as cost.

Parameters:

adjointName - adjoint name

massFlowRateFactor - mass flow rate factor

maximumThrustMagnitude - maximum thrust magnitude

cartesianAdjointEquationTerms - Cartesian adjoint equation terms

Returns:

provider

buildUnboundedEnergyProviderNeglectingMass

public static CartesianAdjointDynamicsProvider buildUnboundedEnergyProviderNeglectingMass(String adjointName,
 CartesianAdjointEquationTerm... cartesianAdjointEquationTerms)

Method building a provider with unbounded Cartesian energy and vanishing mass flow as cost.

Parameters:

adjointName - adjoint name

cartesianAdjointEquationTerms - Cartesian adjoint equation terms

Returns:

provider

buildUnboundedEnergyProvider

public static CartesianAdjointDynamicsProvider buildUnboundedEnergyProvider(String adjointName,
 double massFlowRateFactor,
 EventDetectionSettings eventDetectionSettings,
 CartesianAdjointEquationTerm... cartesianAdjointEquationTerms)

Method building a provider with unbounded Cartesian energy as cost.

Parameters:

adjointName - adjoint name

massFlowRateFactor - mass flow rate factor

eventDetectionSettings - detection settings for adjoint-related events

cartesianAdjointEquationTerms - Cartesian adjoint equation terms

Returns:

provider

buildBoundedEnergyProvider

public static CartesianAdjointDynamicsProvider buildBoundedEnergyProvider(String adjointName,
 double massFlowRateFactor,
 double maximumThrustMagnitude,
 EventDetectionSettings eventDetectionSettings,
 CartesianAdjointEquationTerm... cartesianAdjointEquationTerms)

Method building a provider with bounded Cartesian energy as cost.

Parameters:

adjointName - adjoint name

massFlowRateFactor - mass flow rate factor

maximumThrustMagnitude - maximum thrust magnitude

eventDetectionSettings - detection settings for adjoint-related events

cartesianAdjointEquationTerms - Cartesian adjoint equation terms

Returns:

provider

buildBoundedFuelCostProvider

public static CartesianAdjointDynamicsProvider buildBoundedFuelCostProvider(String adjointName,
 double massFlowRateFactor,
 double maximumThrustMagnitude,
 EventDetectionSettings eventDetectionSettings,
 CartesianAdjointEquationTerm... cartesianAdjointEquationTerms)

Method building a provider with bounded Cartesian fuel as cost.

Parameters:

adjointName - adjoint name

massFlowRateFactor - mass flow rate factor

maximumThrustMagnitude - maximum thrust magnitude

eventDetectionSettings - detection settings for adjoint-related events

cartesianAdjointEquationTerms - Cartesian adjoint equation terms

Returns:

provider

buildQuadraticPenaltyFuelCostProvider

public static CartesianAdjointDynamicsProvider buildQuadraticPenaltyFuelCostProvider(String adjointName,
 double massFlowRateFactor,
 double maximumThrustMagnitude,
 double epsilon,
 EventDetectionSettings eventDetectionSettings,
 CartesianAdjointEquationTerm... cartesianAdjointEquationTerms)

Method building a provider with bounded Cartesian fuel penalized with a quadratic term.

Parameters:

adjointName - adjoint name

massFlowRateFactor - mass flow rate factor

maximumThrustMagnitude - maximum thrust magnitude

epsilon - penalty weight

eventDetectionSettings - detection settings for adjoint-related events

cartesianAdjointEquationTerms - Cartesian adjoint equation terms

Returns:

provider

buildLogarithmicBarrierFuelCostProvider

public static CartesianAdjointDynamicsProvider buildLogarithmicBarrierFuelCostProvider(String adjointName,
 double massFlowRateFactor,
 double maximumThrustMagnitude,
 double epsilon,
 CartesianAdjointEquationTerm... cartesianAdjointEquationTerms)

Method building a provider with bounded Cartesian fuel penalized with a logarithmic barrier.

Parameters:

adjointName - adjoint name

massFlowRateFactor - mass flow rate factor

maximumThrustMagnitude - maximum thrust magnitude

epsilon - penalty weight

cartesianAdjointEquationTerms - Cartesian adjoint equation terms

Returns:

provider