agi.foundation.routedesign

(agi.foundation.routedesign-2024r2.jar)

Class PrescribedAccelerationTransitionProfile

java.lang.Object

agi.foundation.routedesign.RouteProfile

agi.foundation.routedesign.PrescribedAccelerationTransitionProfile

public class PrescribedAccelerationTransitionProfile
extends RouteProfile

A profile defined by a simple incline used to connect two other profiles at different heights. Unlike the StandardTransitionProfile which includes cruising behavior, this profile has a predefined thrust acceleration which defines the change in speeds along the route. The profile will attempt to find an incline which connects the initial and final heights and then will accelerate along the incline according to the prescribed acceleration. It will then update the next profile's initial speed. If the next profile's speed is not configurable, this will produce the error status: SpeedConfigurationStatus.FINAL_SPEED_UNMATCHED in the ConnectionConfigurationResults (get). For more information about error cases, see the remarks section.

To add this as a connection between two procedures, use a ProfileRouteConnection with this profile and simply add the connection between your procedures in the RoutePropagator. The propagator will override the default connection behavior to use this one only between the surrounding segments.

Since this is a transition profile, the initial and final conditions are usually specified by the surrounding procedures, except for the final speed which is determined by the initial speed and acceleration.

Note that this does not use the normal ProfileDynamics used elsewhere and instead only specifies the pitch accelerations and thrust acceleration. The pitch accelerations will define the curves used to connect the surrounding procedures. If the pitch accelerations are too small, this can mean very large curves required to connect the incline with the surrounding height rates and can cause this profile to be invalid if they grow too large. In the event that the profile cannot connect, it will still try to produce a valid profile while returning a SpeedConfigurationStatus.VIOLATES_PROFILE_DYNAMICS status to indicate that the acceleration was too extreme to connect the surrounding profiles.

There are several cases which can cause errors in this profile. Primarily, if the PitchUpAcceleration (get / set) or PushOverAcceleration (get / set) are too small compared to the resulting final speed, this will cause the effective pitch radius to be too large and will limit the amount of space available for the incline. If the final pitch radius is such that a connection is infeasible, the profile will attempt to update the next profile's initial height rate to compensate. If it can't update the next profile, it will return an error in the ConnectionConfigurationResults (get). In addition, if specifying a negative acceleration, cases where the motion decelerates to zero before reaching the end of the segment will cause the profile to adjust the acceleration to decelerate to a surface speed of zero and returns an error (SpeedConfigurationStatus.VIOLATES_PROFILE_DYNAMICS) indicating that the profile violates the specified acceleration.

To avoid problems with the pitch maneuvers, setting the previous and next profiles to be at the same height will simplify the acceleration profile, since no pitch maneuvers will be required. In this case, this profile acts like a ConstantHeightProfile except that instead of specifying an initial and final speed to determine acceleration, this specifies an initial speed and acceleration to determine the final speed.

Constructor Summary

Constructors

Constructor and Description
PrescribedAccelerationTransitionProfile() Create a new instance.
PrescribedAccelerationTransitionProfile(double thrustAcceleration, double pitchUpAcceleration, double pushOverAcceleration, double initialSpeed, TerrainProvider heightReference) Create a new instance based on the given platform properties.
PrescribedAccelerationTransitionProfile(double thrustAcceleration, double pitchUpAcceleration, double pushOverAcceleration, ProfileSpeed initialSpeed, double initialHeight, double initialHeightRate, double finalHeight, double finalHeightRate, TerrainProvider heightReference) Create a new instance based on the given parameters to completely define the incline.

Method Summary

Modifier and Type	Method and Description
ConfigurableProfile	createConfigurableProfile(SurfaceSegment surfacePath) Create a profile based on the given settings that the RoutePropagator can use to configure this profile in relation to all other profiles along the route.
boolean	getAllowModificationOfFinalHeight() Gets a value indicating whether to allow changes to the FinalHeight (get / set) while configuring the route.
boolean	getAllowModificationOfInitialHeight() Gets a value indicating whether to allow changes to the InitialHeight (get / set) while configuring the route.
boolean	getAllowModificationOfInitialSpeed() Gets a value indicating whether to allow changes to the InitialSpeed (get / set) while configuring the route.
double	getFinalHeight() Gets the final height of the incline with respect to the surface path, in meters.
double	getFinalHeightRate() Gets the final vertical velocity, in meters per second.
TerrainProvider	getHeightReferenceSurface() Gets the reference surface above which the height is defined.
double	getInitialHeight() Gets the initial height of the incline with respect to the surface path, in meters.
double	getInitialHeightRate() Gets the initial vertical velocity, in meters per second.
ProfileSpeed	getInitialSpeed() Gets the initial speed at the beginning of the profile.
double	getPitchUpAcceleration() Gets the (vertical) acceleration used to pitch up when climbing, in meters per second squared.
double	getPushOverAcceleration() Gets the (vertical) acceleration used to pitch down when leveling out, in meters per second squared.
double	getThrustAcceleration() Gets the acceleration to use when transitioning from the initial to the final speed.
void	setAllowModificationOfFinalHeight(boolean value) Sets a value indicating whether to allow changes to the FinalHeight (get / set) while configuring the route.
void	setAllowModificationOfInitialHeight(boolean value) Sets a value indicating whether to allow changes to the InitialHeight (get / set) while configuring the route.
void	setAllowModificationOfInitialSpeed(boolean value) Sets a value indicating whether to allow changes to the InitialSpeed (get / set) while configuring the route.
void	setFinalHeight(double value) Sets the final height of the incline with respect to the surface path, in meters.
void	setFinalHeightRate(double value) Sets the final vertical velocity, in meters per second.
void	setHeightReferenceSurface(TerrainProvider value) Sets the reference surface above which the height is defined.
void	setInitialHeight(double value) Sets the initial height of the incline with respect to the surface path, in meters.
void	setInitialHeightRate(double value) Sets the initial vertical velocity, in meters per second.
void	setInitialSpeed(ProfileSpeed value) Sets the initial speed at the beginning of the profile.
void	setPitchUpAcceleration(double value) Sets the (vertical) acceleration used to pitch up when climbing, in meters per second squared.
void	setPushOverAcceleration(double value) Sets the (vertical) acceleration used to pitch down when leveling out, in meters per second squared.
void	setThrustAcceleration(double value) Sets the acceleration to use when transitioning from the initial to the final speed.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrescribedAccelerationTransitionProfile

public PrescribedAccelerationTransitionProfile()

Create a new instance. By default, this uses a ThrustAcceleration (get / set) of zero, indicating that it will update the next profile based on the initial speed which will be determined by the previous profile unless AllowModificationOfInitialSpeed (get / set) is set to false. Similarly, the initial and final conditions for height will be determined by the surrounding profiles unless the properties allowing them to change are set to false. Also by default, the reference surface is set to the surface of the EarthCentralBody in the CentralBodiesFacet.

PrescribedAccelerationTransitionProfile

public PrescribedAccelerationTransitionProfile(double thrustAcceleration,
                                               double pitchUpAcceleration,
                                               double pushOverAcceleration,
                                               double initialSpeed,
                                               TerrainProvider heightReference)

Create a new instance based on the given platform properties.

Parameters:

pitchUpAcceleration - The acceleration used to pitch up when climbing, in meters per seconds squared.

pushOverAcceleration - The acceleration used to pitch down when leveling out, in meters per seconds squared.

thrustAcceleration - The prescribed acceleration along the inclined flight path, in meters per second squared.

initialSpeed - The target initial speed at the start of the profile before any acceleration, in meters per second.

heightReference - The reference above which the height of this profile is defined.

PrescribedAccelerationTransitionProfile

public PrescribedAccelerationTransitionProfile(double thrustAcceleration,
                                               double pitchUpAcceleration,
                                               double pushOverAcceleration,
                                               ProfileSpeed initialSpeed,
                                               double initialHeight,
                                               double initialHeightRate,
                                               double finalHeight,
                                               double finalHeightRate,
                                               TerrainProvider heightReference)

Create a new instance based on the given parameters to completely define the incline. By default, the height and speed parameters will be overridden by surrounding profiles unless the appropriate 'allow' properties are set to fix their values.

Parameters:

pitchUpAcceleration - The acceleration used to pitch up when climbing, in meters per seconds squared.

pushOverAcceleration - The acceleration used to pitch down when leveling out, in meters per seconds squared.

thrustAcceleration - The prescribed acceleration along the inclined flight path, in meters per second squared.

initialSpeed - The initial speed at the start of the profile before any acceleration, in meters.

initialHeight - The fixed initial height of the incline with respect to the surface, in meters.

initialHeightRate - The initial rate of climb (or descent), in meters per second.

finalHeight - The fixed final height of the incline with respect to the surface, in meters.

finalHeightRate - The final rate of climb (or descent), in meters per second.

heightReference - The reference surface above which to define the incline.

Method Detail

getInitialHeight

public final double getInitialHeight()

Gets the initial height of the incline with respect to the surface path, in meters. If AllowModificationOfInitialHeight (get / set) is false, this height will be fixed during the configuration. Otherwise, the surrounding profiles may modify it to configure the route. Unlike the StandardTransitionProfile or TerrainAvoidanceProfile, this profile will defer to the surrounding profiles and will not attempt to modify them.

setInitialHeight

public final void setInitialHeight(double value)

Sets the initial height of the incline with respect to the surface path, in meters. If AllowModificationOfInitialHeight (get / set) is false, this height will be fixed during the configuration. Otherwise, the surrounding profiles may modify it to configure the route. Unlike the StandardTransitionProfile or TerrainAvoidanceProfile, this profile will defer to the surrounding profiles and will not attempt to modify them.

getFinalHeight

public final double getFinalHeight()

Gets the final height of the incline with respect to the surface path, in meters. If AllowModificationOfFinalHeight (get / set) is false, this height will be fixed during the configuration. Otherwise, the surrounding profiles may modify it to configure the route. Unlike the StandardTransitionProfile or TerrainAvoidanceProfile, this profile will defer to the surrounding profiles and will not attempt to modify them.

setFinalHeight

public final void setFinalHeight(double value)

Sets the final height of the incline with respect to the surface path, in meters. If AllowModificationOfFinalHeight (get / set) is false, this height will be fixed during the configuration. Otherwise, the surrounding profiles may modify it to configure the route. Unlike the StandardTransitionProfile or TerrainAvoidanceProfile, this profile will defer to the surrounding profiles and will not attempt to modify them.

getInitialHeightRate

public final double getInitialHeightRate()

Gets the initial vertical velocity, in meters per second. If AllowModificationOfInitialHeight (get / set) is false, this height will be fixed during the configuration. Otherwise, the surrounding profiles may modify it to configure the route.

setInitialHeightRate

public final void setInitialHeightRate(double value)

Sets the initial vertical velocity, in meters per second. If AllowModificationOfInitialHeight (get / set) is false, this height will be fixed during the configuration. Otherwise, the surrounding profiles may modify it to configure the route.

getFinalHeightRate

public final double getFinalHeightRate()

Gets the final vertical velocity, in meters per second. If AllowModificationOfFinalHeight (get / set) is false, this height will be fixed during the configuration. Otherwise, the surrounding profiles may modify it to configure the route.

setFinalHeightRate

public final void setFinalHeightRate(double value)

Sets the final vertical velocity, in meters per second. If AllowModificationOfFinalHeight (get / set) is false, this height will be fixed during the configuration. Otherwise, the surrounding profiles may modify it to configure the route.

getAllowModificationOfInitialHeight

public final boolean getAllowModificationOfInitialHeight()

Gets a value indicating whether to allow changes to the InitialHeight (get / set) while configuring the route. By default, this is true.

setAllowModificationOfInitialHeight

public final void setAllowModificationOfInitialHeight(boolean value)

Sets a value indicating whether to allow changes to the InitialHeight (get / set) while configuring the route. By default, this is true.

getAllowModificationOfFinalHeight

public final boolean getAllowModificationOfFinalHeight()

Gets a value indicating whether to allow changes to the FinalHeight (get / set) while configuring the route. By default, this is true.

setAllowModificationOfFinalHeight

public final void setAllowModificationOfFinalHeight(boolean value)

Sets a value indicating whether to allow changes to the FinalHeight (get / set) while configuring the route. By default, this is true.

getHeightReferenceSurface

public final TerrainProvider getHeightReferenceSurface()

Gets the reference surface above which the height is defined. By default, this is the surface of the Earth.

setHeightReferenceSurface

public final void setHeightReferenceSurface(TerrainProvider value)

Sets the reference surface above which the height is defined. By default, this is the surface of the Earth.

getPitchUpAcceleration

public final double getPitchUpAcceleration()

Gets the (vertical) acceleration used to pitch up when climbing, in meters per second squared. This defines the functional pitch radius when changing the inclination of the flight path. By default, this is ten times Constants.EarthSurfaceGravity. If the ThrustAcceleration (get / set) is such that the final velocity becomes very large, that may cause certain inclined profiles to become invalid due to the time and distance spent to execute pitching maneuvers to achieve the initial or final height rates. To remedy this, make sure your pitch accelerations are sufficient to handle the rapid changes required. For instance, missiles with attitude control systems may have much higher pitch rates than aircraft depending on aerodynamic control surfaces.

setPitchUpAcceleration

public final void setPitchUpAcceleration(double value)

Sets the (vertical) acceleration used to pitch up when climbing, in meters per second squared. This defines the functional pitch radius when changing the inclination of the flight path. By default, this is ten times Constants.EarthSurfaceGravity. If the ThrustAcceleration (get / set) is such that the final velocity becomes very large, that may cause certain inclined profiles to become invalid due to the time and distance spent to execute pitching maneuvers to achieve the initial or final height rates. To remedy this, make sure your pitch accelerations are sufficient to handle the rapid changes required. For instance, missiles with attitude control systems may have much higher pitch rates than aircraft depending on aerodynamic control surfaces.

getPushOverAcceleration

public final double getPushOverAcceleration()

Gets the (vertical) acceleration used to pitch down when leveling out, in meters per second squared. This defines the functional pitch radius when changing the inclination of the flight path. By default, this is ten times Constants.EarthSurfaceGravity. If the ThrustAcceleration (get / set) is such that the final velocity becomes very large, that may cause certain inclined profiles to become invalid due to the time and distance spent to execute pitching maneuvers to achieve the initial or final height rates. To remedy this, make sure your pitch accelerations are sufficient to handle the rapid changes required. For instance, missiles with attitude control systems may have much higher pitch rates than aircraft depending on aerodynamic control surfaces.

setPushOverAcceleration

public final void setPushOverAcceleration(double value)

Sets the (vertical) acceleration used to pitch down when leveling out, in meters per second squared. This defines the functional pitch radius when changing the inclination of the flight path. By default, this is ten times Constants.EarthSurfaceGravity. If the ThrustAcceleration (get / set) is such that the final velocity becomes very large, that may cause certain inclined profiles to become invalid due to the time and distance spent to execute pitching maneuvers to achieve the initial or final height rates. To remedy this, make sure your pitch accelerations are sufficient to handle the rapid changes required. For instance, missiles with attitude control systems may have much higher pitch rates than aircraft depending on aerodynamic control surfaces.

getInitialSpeed

public final ProfileSpeed getInitialSpeed()

Gets the initial speed at the beginning of the profile. In general, when used as a transition between procedures the initial speed is usually set by the previous profile.

setInitialSpeed

public final void setInitialSpeed(ProfileSpeed value)

Sets the initial speed at the beginning of the profile. In general, when used as a transition between procedures the initial speed is usually set by the previous profile.

getAllowModificationOfInitialSpeed

public final boolean getAllowModificationOfInitialSpeed()

Gets a value indicating whether to allow changes to the InitialSpeed (get / set) while configuring the route. In general, when used as a transition between procedures, the initial speed is usually set by the previous profile. By default, this is true.

setAllowModificationOfInitialSpeed

public final void setAllowModificationOfInitialSpeed(boolean value)

Sets a value indicating whether to allow changes to the InitialSpeed (get / set) while configuring the route. In general, when used as a transition between procedures, the initial speed is usually set by the previous profile. By default, this is true.

getThrustAcceleration

public final double getThrustAcceleration()

Gets the acceleration to use when transitioning from the initial to the final speed. By default, this is zero, indicating that the speed will not change and the next profile's initial speed will be updated to be equal to the final speed of the previous profile.

setThrustAcceleration

public final void setThrustAcceleration(double value)

Sets the acceleration to use when transitioning from the initial to the final speed. By default, this is zero, indicating that the speed will not change and the next profile's initial speed will be updated to be equal to the final speed of the previous profile.

createConfigurableProfile

public ConfigurableProfile createConfigurableProfile(SurfaceSegment surfacePath)

Create a profile based on the given settings that the RoutePropagator can use to configure this profile in relation to all other profiles along the route.

Specified by:

createConfigurableProfile in class RouteProfile

Parameters:

surfacePath - The surface path over which the profile is defined.

Returns:

The configurable profile used by the RoutePropagator to configure the route.