Complete phase_info user options reference for all Aviary EquationsOfMotion#
HEIGHT_ENERGY#
The height energy phase_info has been converted to the new system.
om.show_options_table('aviary.mission.flight_phase_builder.FlightPhaseOptions')
| Option | Default | Acceptable Values | Acceptable Types | Description |
|---|---|---|---|---|
| altitude_bounds | ((None, None), 'ft') | N/A | ['tuple'] | Tuple of form ((lower, upper), units) containing the upper and lower bounds for all values of altitude in the phase. The default of None for upper or lower means that bound will not be declared. |
| altitude_final | (None, 'ft') | N/A | ['tuple'] | Tuple of (value, units) containing value of altitude at the end of the phase. If this phase is connected to a downstream phase, final values should be specified with altitude_initial in that phase instead of here. When specified, a constraint is created on the final altitude. |
| altitude_initial | (None, 'ft') | N/A | ['tuple'] | Tuple of (value, units) containing value of altitude at the start of the phase. When unspecified, the value comes from upstream. When specified, a constraint is created on the initial altitude. |
| altitude_optimize | True | [True, False] | ['bool'] | When True, the optimizer will set this value. When False, the initial value for all nodes can be set in the initial_conditions section of the phase. |
| altitude_polynomial_order | N/A | N/A | ['int'] | The order of polynomials for interpolation in the transcription. Default is None, which does not use a polynomial. |
| altitude_rate_constraint | N/A | [None, 'positive', 'negative'] | N/A | Can be (None, positive, negative.) When not None, adds a constraint that keeps the rate positive or negative as requested. For altitude in a flight phase, negative means no climb, and positive means no descent. |
| altitude_ref | (1.0, 'ft') | N/A | ['tuple'] | Multiplicative scale factor "ref" for altitude. Default is 1.0 |
| altitude_ref0 | (None, 'ft') | N/A | ['tuple'] | Additive scale factor "ref0" for altitude. |
| constraints | {} | N/A | ['dict'] | Add in custom constraints i.e. 'flight_path_angle': {'equals': -3., 'loc': 'initial', 'units': 'deg', 'type': 'boundary',}. For more details see _add_user_defined_constraints(). |
| distance_bounds | ((0.0, None), 'm') | N/A | ['tuple'] | Tuple of form ((lower, upper), units) containing the upper and lower bounds for all values of distance in the phase. The default of None for upper or lower means that bound will not be declared. |
| distance_defect_ref | (100000000.0, 'm') | N/A | ['tuple'] | Multiplicative scale factor "ref" for the distance defect constraint. Default is None, which means the ref and defect_ref are the same. |
| distance_final | (None, 'm') | N/A | ['tuple'] | Tuple of (value, units) containing value of distance at the end of the phase. If this phase is connected to a downstream phase, final values should be specified with distance_initial in that phase instead of here. When specified, a constraint is created on the final distance. |
| distance_initial | (None, 'm') | N/A | ['tuple'] | Tuple of (value, units) containing value of distance at the start of the phase. When unspecified, the optimizer controls the value. When specified, a constraint is created on the initial distance. |
| distance_ref | (1000000.0, 'm') | N/A | ['tuple'] | Multiplicative scale factor "ref" for distance. Default is 1.0 |
| distance_ref0 | (None, 'm') | N/A | ['tuple'] | Additive scale factor "ref0" for distance. |
| distance_solve_segments | False | [True, False] | ['bool'] | When True, a solver will be used to converge the collocation defects within a segment. Note that the state continuity defects between segements will still be handled by the optimizer. |
| ground_roll | False | [True, False] | ['bool'] | Set to True only for phases where the aircraft is rolling on the ground. All other phases of flight (climb, cruise, descent) this must be set to False. |
| mach_bounds | ((None, None), 'unitless') | N/A | ['tuple'] | Tuple of form ((lower, upper), units) containing the upper and lower bounds for all values of mach in the phase. The default of None for upper or lower means that bound will not be declared. |
| mach_final | (None, 'unitless') | N/A | ['tuple'] | Tuple of (value, units) containing value of mach at the end of the phase. If this phase is connected to a downstream phase, final values should be specified with mach_initial in that phase instead of here. When specified, a constraint is created on the final mach. |
| mach_initial | (None, 'unitless') | N/A | ['tuple'] | Tuple of (value, units) containing value of mach at the start of the phase. When unspecified, the value comes from upstream. When specified, a constraint is created on the initial mach. |
| mach_optimize | True | [True, False] | ['bool'] | When True, the optimizer will set this value. When False, the initial value for all nodes can be set in the initial_conditions section of the phase. |
| mach_polynomial_order | N/A | N/A | ['int'] | The order of polynomials for interpolation in the transcription. Default is None, which does not use a polynomial. |
| mach_rate_constraint | N/A | [None, 'positive', 'negative'] | N/A | Can be (None, positive, negative.) When not None, adds a constraint that keeps the rate positive or negative as requested. For altitude in a flight phase, negative means no climb, and positive means no descent. |
| mach_ref | (0.5, 'unitless') | N/A | ['tuple'] | Multiplicative scale factor "ref" for mach. Default is 1.0 |
| mach_ref0 | (None, 'unitless') | N/A | ['tuple'] | Additive scale factor "ref0" for mach. |
| mass_bounds | ((0.0, None), 'kg') | N/A | ['tuple'] | Tuple of form ((lower, upper), units) containing the upper and lower bounds for all values of mass in the phase. The default of None for upper or lower means that bound will not be declared. |
| mass_defect_ref | (1000000.0, 'kg') | N/A | ['tuple'] | Multiplicative scale factor "ref" for the mass defect constraint. Default is None, which means the ref and defect_ref are the same. |
| mass_final | (None, 'kg') | N/A | ['tuple'] | Tuple of (value, units) containing value of mass at the end of the phase. If this phase is connected to a downstream phase, final values should be specified with mass_initial in that phase instead of here. When specified, a constraint is created on the final mass. |
| mass_initial | (None, 'kg') | N/A | ['tuple'] | Tuple of (value, units) containing value of mass at the start of the phase. When unspecified, the optimizer controls the value. When specified, a constraint is created on the initial mass. |
| mass_ref | (10000.0, 'kg') | N/A | ['tuple'] | Multiplicative scale factor "ref" for mass. Default is 1.0 |
| mass_ref0 | (None, 'kg') | N/A | ['tuple'] | Additive scale factor "ref0" for mass. |
| mass_solve_segments | False | [True, False] | ['bool'] | When True, a solver will be used to converge the collocation defects within a segment. Note that the state continuity defects between segements will still be handled by the optimizer. |
| no_climb | False | [True, False] | ['bool'] | Set to True to prevent the aircraft from climbing during the phase. This option can be used to prevent unexpected climb during a descent phase. |
| no_descent | False | [True, False] | ['bool'] | Set to True to prevent the aircraft from descending during the phase. This can be used to prevent unexpected descent during a climb phase. |
| num_segments | 1 | N/A | ['int'] | The number of segments in transcription creation in Dymos. The default value is 1. |
| order | 3 | N/A | ['int'] | The order of polynomials for interpolation in the transcription created in Dymos. The default value is 3. |
| required_available_climb_rate | (None, 'ft/s') | N/A | ['tuple'] | Adds a constraint requiring Dynamic.Mission.ALTITUDE_RATE_MAX to be no smaller than required_available_climb_rate. This helps to ensure that the propulsion system is large enough to handle emergency maneuvers at all points throughout the flight envelope. Default value is None for no constraint. |
| reserve | False | [True, False] | ['bool'] | Designate this phase as a reserve phase and contributes its fuel burn towards the reserve mission fuel requirements. Reserve phases should be be placed after all non-reserve phases in the phase_info. |
| target_distance | (None, 'm') | N/A | ['tuple'] | The total distance traveled by the aircraft from takeoff to landing for the primary mission, not including reserve missions. This value must be positive. |
| throttle_allocation | ThrottleAllocation.FIXED | [<ThrottleAllocation.FIXED: 'fixed'>, <ThrottleAllocation.STATIC: 'static'>, <ThrottleAllocation.DYNAMIC: 'dynamic'>] | N/A | Specifies how to handle the throttles for multiple engines. FIXED is a user-specified value. STATIC is specified by the optimizer as one value for the whole phase. DYNAMIC is specified by the optimizer at each point in the phase. |
| throttle_enforcement | path_constraint | ['path_constraint', 'boundary_constraint', 'bounded', None] | N/A | Flag to enforce engine throttle constraints on the path or at the segment boundaries or using solver bounds. |
| time_duration | (None, 's') | N/A | ['tuple'] | Tuple of (value, units) containing value of time_duration at the start of the phase. When unspecified, the value comes from upstream. When specified, a constraint is created on the initial time_duration. |
| time_duration_bounds | ((None, None), 's') | N/A | ['tuple'] | Tuple of form ((lower, upper), units) containing the upper and lower bounds for all values of time_duration in the phase. The default of None for upper or lower means that bound will not be declared. |
| time_duration_ref | (1.0, 's') | N/A | ['tuple'] | Multiplicative scale factor "ref" for time_duration. Default is 1.0 |
| time_initial | (None, 's') | N/A | ['tuple'] | Tuple of (value, units) containing value of time_initial at the start of the phase. When unspecified, the value comes from upstream. When specified, a constraint is created on the initial time_initial. |
| time_initial_bounds | ((None, None), 's') | N/A | ['tuple'] | Tuple of form ((lower, upper), units) containing the upper and lower bounds for all values of time_initial in the phase. The default of None for upper or lower means that bound will not be declared. |
| time_initial_ref | (1.0, 's') | N/A | ['tuple'] | Multiplicative scale factor "ref" for time_initial. Default is 1.0 |
SOLVED_2DOF#
The solved 2dof phase_info has not been converted completely to the new system.
om.show_options_table('aviary.mission.gasp_based.phases.twodof_phase.TwoDOFPhaseOptions')
| Option | Default | Acceptable Values | Acceptable Types | Description |
|---|---|---|---|---|
| altitude_bounds | ((None, None), 'ft') | N/A | ['tuple'] | Tuple of form ((lower, upper), units) containing the upper and lower bounds for all values of altitude in the phase. The default of None for upper or lower means that bound will not be declared. |
| altitude_final | (None, 'ft') | N/A | ['tuple'] | Tuple of (value, units) containing value of altitude at the end of the phase. If this phase is connected to a downstream phase, final values should be specified with altitude_initial in that phase instead of here. When specified, a constraint is created on the final altitude. |
| altitude_initial | (None, 'ft') | N/A | ['tuple'] | Tuple of (value, units) containing value of altitude at the start of the phase. When unspecified, the value comes from upstream. When specified, a constraint is created on the initial altitude. |
| altitude_optimize | False | [True, False] | ['bool'] | Adds the Altitude as a design variable controlled by the optimizer. |
| altitude_polynomial_order | N/A | N/A | ['int'] | The order of polynomials for interpolation in the transcription. Default is None, which does not use a polynomial. |
| altitude_rate_constraint | N/A | [None, 'positive', 'negative'] | N/A | Can be (None, positive, negative.) When not None, adds a constraint that keeps the rate positive or negative as requested. For altitude in a flight phase, negative means no climb, and positive means no descent. |
| altitude_ref | (1.0, 'ft') | N/A | ['tuple'] | Multiplicative scale factor "ref" for altitude. Default is 1.0 |
| altitude_ref0 | (None, 'ft') | N/A | ['tuple'] | Additive scale factor "ref0" for altitude. |
| clean | False | [True, False] | ['bool'] | Set to true to use clean aero with no ground effects. |
| constrain_final | False | [True, False] | ['bool'] | Fixes the final states (mach and altitude) to the values of altitude_final and mach_final. These values will be unable to change during the optimization. |
| constraints | {} | N/A | ['dict'] | Add in custom constraints i.e. 'flight_path_angle': {'equals': -3., 'loc': 'initial', 'units': 'deg', 'type': 'boundary',}. For more details see _add_user_defined_constraints(). |
| control_order | 1 | N/A | ['int'] | The polynomial order for the angle of attack control. |
| distance_bounds | ((0.0, None), 'm') | N/A | ['tuple'] | Tuple of form ((lower, upper), units) containing the upper and lower bounds for all values of distance in the phase. The default of None for upper or lower means that bound will not be declared. |
| distance_defect_ref | (100000000.0, 'm') | N/A | ['tuple'] | Multiplicative scale factor "ref" for the distance defect constraint. Default is None, which means the ref and defect_ref are the same. |
| distance_final | (None, 'm') | N/A | ['tuple'] | Tuple of (value, units) containing value of distance at the end of the phase. If this phase is connected to a downstream phase, final values should be specified with distance_initial in that phase instead of here. When specified, a constraint is created on the final distance. |
| distance_initial | (None, 'm') | N/A | ['tuple'] | Tuple of (value, units) containing value of distance at the start of the phase. When unspecified, the optimizer controls the value. When specified, a constraint is created on the initial distance. |
| distance_ref | (1000000.0, 'm') | N/A | ['tuple'] | Multiplicative scale factor "ref" for distance. Default is 1.0 |
| distance_ref0 | (None, 'm') | N/A | ['tuple'] | Additive scale factor "ref0" for distance. |
| distance_solve_segments | False | [True, False] | ['bool'] | if True, use a nonlinear solver to converge the distance state variable to the desired value. Otherwise uses the optimizer to converge the distance state. |
| fix_duration | False | [True, False] | ['bool'] | If True, the time duration of the phase is not treated as a design variable for the optimization problem. |
| fix_initial | True | [True, False] | ['bool'] | Fixes the initial states (mass, distance) and does not allow them to change during the optimization. |
| ground_roll | False | [True, False] | ['bool'] | Set to True only for phases where the aircraft is rolling on the ground. All other phases of flight (climb, cruise, descent) this must be set to False. |
| input_initial | False | [True, False] | ['bool'] | Links all states (mass, distance) to a calculation external to this phase. |
| mach_bounds | ((None, None), 'unitless') | N/A | ['tuple'] | Tuple of form ((lower, upper), units) containing the upper and lower bounds for all values of mach in the phase. The default of None for upper or lower means that bound will not be declared. |
| mach_final | (None, 'unitless') | N/A | ['tuple'] | Tuple of (value, units) containing value of mach at the end of the phase. If this phase is connected to a downstream phase, final values should be specified with mach_initial in that phase instead of here. When specified, a constraint is created on the final mach. |
| mach_initial | (None, 'unitless') | N/A | ['tuple'] | Tuple of (value, units) containing value of mach at the start of the phase. When unspecified, the value comes from upstream. When specified, a constraint is created on the initial mach. |
| mach_optimize | False | [True, False] | ['bool'] | Adds the Mach number as a design variable controlled by the optimizer. |
| mach_polynomial_order | N/A | N/A | ['int'] | The order of polynomials for interpolation in the transcription. Default is None, which does not use a polynomial. |
| mach_rate_constraint | N/A | [None, 'positive', 'negative'] | N/A | Can be (None, positive, negative.) When not None, adds a constraint that keeps the rate positive or negative as requested. For altitude in a flight phase, negative means no climb, and positive means no descent. |
| mach_ref | (0.5, 'unitless') | N/A | ['tuple'] | Multiplicative scale factor "ref" for mach. Default is 1.0 |
| mach_ref0 | (None, 'unitless') | N/A | ['tuple'] | Additive scale factor "ref0" for mach. |
| mass_bounds | ((0.0, None), 'kg') | N/A | ['tuple'] | Tuple of form ((lower, upper), units) containing the upper and lower bounds for all values of mass in the phase. The default of None for upper or lower means that bound will not be declared. |
| mass_defect_ref | (1000000.0, 'kg') | N/A | ['tuple'] | Multiplicative scale factor "ref" for the mass defect constraint. Default is None, which means the ref and defect_ref are the same. |
| mass_final | (None, 'kg') | N/A | ['tuple'] | Tuple of (value, units) containing value of mass at the end of the phase. If this phase is connected to a downstream phase, final values should be specified with mass_initial in that phase instead of here. When specified, a constraint is created on the final mass. |
| mass_initial | (None, 'kg') | N/A | ['tuple'] | Tuple of (value, units) containing value of mass at the start of the phase. When unspecified, the optimizer controls the value. When specified, a constraint is created on the initial mass. |
| mass_ref | (10000.0, 'kg') | N/A | ['tuple'] | Multiplicative scale factor "ref" for mass. Default is 1.0 |
| mass_ref0 | (None, 'kg') | N/A | ['tuple'] | Additive scale factor "ref0" for mass. |
| mass_solve_segments | False | [True, False] | ['bool'] | When True, a solver will be used to converge the collocation defects within a segment. Note that the state continuity defects between segements will still be handled by the optimizer. |
| no_climb | False | [True, False] | ['bool'] | Set to True to prevent the aircraft from climbing during the phase. This option can be used to prevent unexpected climb during a descent phase. |
| no_descent | False | [True, False] | ['bool'] | Set to True to prevent the aircraft from descending during the phase. This can be used to prevent unexpected descent during a climb phase. |
| num_segments | 1 | N/A | ['int'] | The number of segments in transcription creation in Dymos. The default value is 1. |
| order | 3 | N/A | ['int'] | The order of polynomials for interpolation in the transcription created in Dymos. The default value is 3. |
| polynomial_control_order | 3 | N/A | ['int'] | The order of the polynomial fit to control values. Only used if polynomial_control = True |
| required_available_climb_rate | (None, 'ft/s') | N/A | ['tuple'] | Adds a constraint requiring Dynamic.Mission.ALTITUDE_RATE_MAX to be no smaller than required_available_climb_rate. This helps to ensure that the propulsion system is large enough to handle emergency maneuvers at all points throughout the flight envelope. Default value is None for no constraint. |
| reserve | False | [True, False] | ['bool'] | Designate this phase as a reserve phase and contributes its fuel burn towards the reserve mission fuel requirements. Reserve phases should be be placed after all non-reserve phases in the phase_info. |
| rotation | False | [True, False] | ['bool'] | Set to true if this is a rotation phase. |
| target_distance | (None, 'm') | N/A | ['tuple'] | The total distance traveled by the aircraft from takeoff to landing for the primary mission, not including reserve missions. This value must be positive. |
| throttle_allocation | ThrottleAllocation.FIXED | [<ThrottleAllocation.FIXED: 'fixed'>, <ThrottleAllocation.STATIC: 'static'>, <ThrottleAllocation.DYNAMIC: 'dynamic'>] | N/A | Specifies how to handle the throttles for multiple engines. FIXED is a user-specified value. STATIC is specified by the optimizer as one value for the whole phase. DYNAMIC is specified by the optimizer at each point in the phase. |
| throttle_enforcement | path_constraint | ['path_constraint', 'boundary_constraint', 'bounded', None] | N/A | Flag to enforce engine throttle constraints on the path or at the segment boundaries or using solver bounds. |
| time_duration | (None, 's') | N/A | ['tuple'] | The amount of time taken by this phase added as a constraint. |
| time_duration_bounds | ((None, None), 'ft') | N/A | ['tuple'] | Lower and upper bounds on the integration variable, which is speed. It isin the form of a nested tuple: i.e. ((20, 36), "min") This constrains the duration to be between 20 and 36 min. |
| time_duration_ref | (1000.0, 'ft') | N/A | ['tuple'] | Scale factor duration ref for the phase integration variable, which is range. |
| time_initial_bounds | ((None, None), 'ft') | N/A | ['tuple'] | Lower and upper bounds on the integration variable, which is speed. |
| time_initial_ref | (100.0, 'ft') | N/A | ['tuple'] | Scale factor initial ref for the phase integration variable, which is range. |
| use_polynomial_control | True | [True, False] | ['bool'] | Set fo True to use polynomial controls in this phase, which smooths the control inputs. |
TWO_DEGREES_OF_FREEDOM#
The two degree of freedom phase_info has not been converted completely to the new system.
AccelPhase#
om.show_options_table('aviary.mission.gasp_based.phases.accel_phase.AccelPhaseOptions')
| Option | Default | Acceptable Values | Acceptable Types | Description |
|---|---|---|---|---|
| EAS_constraint_eq | (250.0, 'kn') | N/A | ['tuple'] | Airspeed constraint applied at the end of the phase. |
| alt | (500.0, 'ft') | N/A | ['tuple'] | Constant altitude for this phase. |
| analytic | False | [True, False] | ['bool'] | When set to True, this is an analytic phase. |
| distance_defect_ref | (None, 'ft') | N/A | ['tuple'] | Scale factor ref for distance defect. |
| distance_lower | (0.0, 'NM') | N/A | ['tuple'] | Lower bound for distance. |
| distance_ref | (1.0, 'ft') | N/A | ['tuple'] | Scale factor ref for distance. |
| distance_ref0 | (0.0, 'ft') | N/A | ['tuple'] | Scale factor ref0 for distance. |
| distance_upper | (0.0, 'ft') | N/A | ['tuple'] | Upper bound for distance. |
| fix_initial | False | [True, False] | ['bool'] | Fixes the initial states (mass, distance) and does not allow them to change during the optimization. |
| mass_defect_ref | (0.0, 'lbm') | N/A | ['tuple'] | Scale factor ref for mass defect. |
| mass_lower | (0.0, 'lbm') | N/A | ['tuple'] | Lower bound for mass. |
| mass_ref | (1.0, 'lbm') | N/A | ['tuple'] | Scale factor ref for mass. |
| mass_ref0 | (0.0, 'lbm') | N/A | ['tuple'] | Scale factor ref0 for mass. |
| mass_upper | (0.0, 'lbm') | N/A | ['tuple'] | Upper bound for mass. |
| num_segments | 1 | N/A | ['int'] | The number of segments in transcription creation in Dymos. The default value is 1. |
| order | 3 | N/A | ['int'] | The order of polynomials for interpolation in the transcription created in Dymos. The default value is 3. |
| reserve | False | [True, False] | ['bool'] | Designate this phase as a reserve phase and contributes its fuel burn towards the reserve mission fuel requirements. Reserve phases should be be placed after all non-reserve phases in the phase_info. |
| target_distance | (None, 'm') | N/A | ['tuple'] | The total distance traveled by the aircraft from takeoff to landing for the primary mission, not including reserve missions. This value must be positive. |
| time_duration | (None, 's') | N/A | ['tuple'] | The amount of time taken by this phase added as a constraint. |
| time_duration_bounds | ((None, None), 's') | N/A | ['tuple'] | Lower and upper bounds on the phase duration, in the form of a nested tuple: i.e. ((20, 36), "min") This constrains the duration to be between 20 and 36 min. |
| time_duration_ref | (1.0, 's') | N/A | ['tuple'] | Scale factor ref for duration. |
| velocity_defect_ref | (None, 'kn') | N/A | ['tuple'] | Scale factor ref for velocity defect. |
| velocity_lower | (0.0, 'kn') | N/A | ['tuple'] | Lower bound for velocity. |
| velocity_ref | (1.0, 'kn') | N/A | ['tuple'] | Scale factor ref for velocity. |
| velocity_ref0 | (0.0, 'kn') | N/A | ['tuple'] | Scale factor ref0 for velocity. |
| velocity_upper | (0.0, 'kn') | N/A | ['tuple'] | Upper bound for velocity. |
AscentPhase#
om.show_options_table('aviary.mission.gasp_based.phases.ascent_phase.AscentPhaseOptions')
| Option | Default | Acceptable Values | Acceptable Types | Description |
|---|---|---|---|---|
| alpha_constraint_lower | (-0.5235987755982988, 'rad') | N/A | ['tuple'] | Angle of attack lower bound constraint. |
| alpha_constraint_ref | (0.08726646259971647, 'rad') | N/A | ['tuple'] | Scale factor ref for the Angle of attack constraint. |
| alpha_constraint_upper | (0.5235987755982988, 'rad') | N/A | ['tuple'] | Angle of attack upper bound constraint. |
| alt_constraint_ref | (100.0, 'ft') | N/A | ['tuple'] | Scaling ref for the final altitude constraint. |
| alt_constraint_ref0 | (0.0, 'ft') | N/A | ['tuple'] | Scaling ref0 for the final altitude constraint. |
| alt_defect_ref | (100.0, 'ft') | N/A | ['tuple'] | Scale factor ref for altitude defect. |
| alt_lower | (0.0, 'ft') | N/A | ['tuple'] | Lower bound for altitude. |
| alt_ref | (100.0, 'ft') | N/A | ['tuple'] | Scale factor ref for altitude. |
| alt_ref0 | (0.0, 'ft') | N/A | ['tuple'] | Scale factor ref0 for altitude. |
| alt_upper | (700.0, 'ft') | N/A | ['tuple'] | Upper bound for altitude. |
| altitude_final | (500.0, 'ft') | N/A | ['tuple'] | Altitude for final point in the phase. |
| analytic | False | [True, False] | ['bool'] | When set to True, this is an analytic phase. |
| angle_defect_ref | (0.01, 'rad') | N/A | ['tuple'] | Scale factor ref for angle defect. |
| angle_lower | (-0.2617993877991494, 'rad') | N/A | ['tuple'] | Lower bound for angle. |
| angle_ref | (0.017453292519943295, 'rad') | N/A | ['tuple'] | Scale factor ref for angle. |
| angle_ref0 | (0.0, 'rad') | N/A | ['tuple'] | Scale factor ref0 for angle. |
| angle_upper | (0.4363323129985824, 'rad') | N/A | ['tuple'] | Upper bound for angle. |
| distance_defect_ref | (3000.0, 'ft') | N/A | ['tuple'] | Scale factor ref for distance defect. |
| distance_lower | (0.0, 'ft') | N/A | ['tuple'] | Lower bound for distance. |
| distance_ref | (3000.0, 'ft') | N/A | ['tuple'] | Scale factor ref for distance. |
| distance_ref0 | (0.0, 'ft') | N/A | ['tuple'] | Scale factor ref0 for distance. |
| distance_upper | (10000.0, 'ft') | N/A | ['tuple'] | Upper bound for distance. |
| fix_initial | False | [True, False] | ['bool'] | Fixes the initial states (mass, distance) and does not allow them to change during the optimization. |
| mass_defect_ref | (100.0, 'lbm') | N/A | ['tuple'] | Scale factor ref for mass defect. |
| mass_lower | (0.0, 'lbm') | N/A | ['tuple'] | Lower bound for mass. |
| mass_ref | (100000.0, 'lbm') | N/A | ['tuple'] | Scale factor ref for mass. |
| mass_ref0 | (0.0, 'lbm') | N/A | ['tuple'] | Scale factor ref0 for mass. |
| mass_upper | (190000.0, 'lbm') | N/A | ['tuple'] | Upper bound for mass. |
| num_segments | 1 | N/A | ['int'] | The number of segments in transcription creation in Dymos. The default value is 1. |
| order | N/A | N/A | ['int'] | The order of polynomials for interpolation in the transcription created in Dymos. |
| pitch_constraint_lower | (0.0, 'deg') | N/A | ['tuple'] | Pitch lower bound constraint. |
| pitch_constraint_ref | (1.0, 'deg') | N/A | ['tuple'] | Scale factor ref for the pitch constraint. |
| pitch_constraint_upper | (15.0, 'deg') | N/A | ['tuple'] | Pitch upper bound constraint. |
| reserve | False | [True, False] | ['bool'] | Designate this phase as a reserve phase and contributes its fuel burn towards the reserve mission fuel requirements. Reserve phases should be be placed after all non-reserve phases in the phase_info. |
| target_distance | (None, 'm') | N/A | ['tuple'] | The total distance traveled by the aircraft from takeoff to landing for the primary mission, not including reserve missions. This value must be positive. |
| time_duration | (None, 's') | N/A | ['tuple'] | The amount of time taken by this phase added as a constraint. |
| time_duration_ref | (1.0, 's') | N/A | ['tuple'] | Scale factor ref for duration. |
| velocity_defect_ref | (None, 'kn') | N/A | ['tuple'] | Scale factor ref for velocity defect. |
| velocity_lower | (0.0, 'kn') | N/A | ['tuple'] | Lower bound for velocity. |
| velocity_ref | (100.0, 'kn') | N/A | ['tuple'] | Scale factor ref for velocity. |
| velocity_ref0 | (0.0, 'kn') | N/A | ['tuple'] | Scale factor ref0 for velocity. |
| velocity_upper | (1000.0, 'kn') | N/A | ['tuple'] | Upper bound for velocity. |
ClimbPhase#
om.show_options_table('aviary.mission.gasp_based.phases.climb_phase.ClimbPhaseOptions')
| Option | Default | Acceptable Values | Acceptable Types | Description |
|---|---|---|---|---|
| EAS_target | (0.0, 'kn') | N/A | ['tuple'] | Target airspeed for the balance in this phase. |
| alt_defect_ref | (None, 'ft') | N/A | ['tuple'] | Scale factor ref for altitude defect. |
| alt_lower | (0.0, 'ft') | N/A | ['tuple'] | Lower bound for altitude. |
| alt_ref | (1.0, 'ft') | N/A | ['tuple'] | Scale factor ref for altitude. |
| alt_ref0 | (0.0, 'ft') | N/A | ['tuple'] | Scale factor ref0 for altitude. |
| alt_upper | (0.0, 'ft') | N/A | ['tuple'] | Upper bound for altitude. |
| altitude_final | (0.0, 'ft') | N/A | ['tuple'] | Altitude for final point in the phase. |
| analytic | False | [True, False] | ['bool'] | When set to True, this is an analytic phase. |
| distance_defect_ref | (None, 'NM') | N/A | ['tuple'] | Scale factor ref for distance defect. |
| distance_lower | (0.0, 'NM') | N/A | ['tuple'] | Lower bound for distance. |
| distance_ref | (1.0, 'NM') | N/A | ['tuple'] | Scale factor ref for distance. |
| distance_ref0 | (0.0, 'NM') | N/A | ['tuple'] | Scale factor ref0 for distance. |
| distance_upper | (0.0, 'NM') | N/A | ['tuple'] | Upper bound for distance. |
| fix_initial | False | [True, False] | ['bool'] | Fixes the initial states (mass, distance) and does not allow them to change during the optimization. |
| mach_cruise | 0.0 | N/A | N/A | Defines the mach constraint at the end of the phase. Only valid when target_mach=True. |
| mass_defect_ref | (None, 'lbm') | N/A | ['tuple'] | Scale factor ref for mass defect. |
| mass_lower | (0.0, 'lbm') | N/A | ['tuple'] | Lower bound for mass. |
| mass_ref | (1.0, 'lbm') | N/A | ['tuple'] | Scale factor ref for mass. |
| mass_ref0 | (0.0, 'lbm') | N/A | ['tuple'] | Scale factor ref0 for mass. |
| mass_upper | (0.0, 'lbm') | N/A | ['tuple'] | Upper bound for mass. |
| num_segments | N/A | N/A | ['int'] | The number of segments in transcription creation in Dymos. |
| order | N/A | N/A | ['int'] | The order of polynomials for interpolation in the transcription created in Dymos. |
| required_available_climb_rate | (None, 'ft/min') | N/A | ['tuple'] | Adds a constraint requiring Dynamic.Mission.ALTITUDE_RATE_MAX to be no smaller than required_available_climb_rate. This helps to ensure that the propulsion system is large enough to handle emergency maneuvers at all points throughout the flight envelope. Default value is None for no constraint. |
| reserve | False | [True, False] | ['bool'] | Designate this phase as a reserve phase and contributes its fuel burn towards the reserve mission fuel requirements. Reserve phases should be be placed after all non-reserve phases in the phase_info. |
| target_distance | (None, 'm') | N/A | ['tuple'] | The total distance traveled by the aircraft from takeoff to landing for the primary mission, not including reserve missions. This value must be positive. |
| target_mach | False | [True, False] | ['bool'] | Set to true to enforce a mach_constraint at the phase endpoint. The mach value is set in "mach_cruise". |
| time_duration | (None, 's') | N/A | ['tuple'] | The amount of time taken by this phase added as a constraint. |
| time_duration_bounds | ((0, 0), 's') | N/A | ['tuple'] | Lower and upper bounds on the phase duration, in the form of a nested tuple: i.e. ((20, 36), "min") This constrains the duration to be between 20 and 36 min. |
| time_duration_ref | (1.0, 's') | N/A | ['tuple'] | Scale factor ref for duration. |
CruisePhase#
om.show_options_table('aviary.mission.gasp_based.phases.cruise_phase.CruisePhaseOptions')
| Option | Default | Acceptable Values | Acceptable Types | Description |
|---|---|---|---|---|
| alt_cruise | (0.0, 'ft') | N/A | ['tuple'] | Cruise altitude. |
| analytic | False | [True, False] | ['bool'] | When set to True, this is an analytic phase. |
| fix_duration | False | [True, False] | ['bool'] | If True, the time duration of the phase is not treated as a design variable for the optimization problem. |
| mach_cruise | 0.0 | N/A | N/A | Cruise Mach number. |
| reserve | False | [True, False] | ['bool'] | Designate this phase as a reserve phase and contributes its fuel burn towards the reserve mission fuel requirements. Reserve phases should be be placed after all non-reserve phases in the phase_info. |
| target_distance | (None, 'm') | N/A | ['tuple'] | The total distance traveled by the aircraft from takeoff to landing for the primary mission, not including reserve missions. This value must be positive. |
| time_duration | (None, 's') | N/A | ['tuple'] | The amount of time taken by this phase added as a constraint. |
| time_duration_bounds | ((0, 3600), 's') | N/A | ['tuple'] | Lower and upper bounds on the phase duration, in the form of a nested tuple: i.e. ((20, 36), "min") This constrains the duration to be between 20 and 36 min. |
| time_initial_bounds | ((0.0, 100.0), 's') | N/A | ['tuple'] | Lower and upper bounds on the starting time for this phase relative to the starting time of the mission, i.e., ((25, 45), "min") constrians this phase to start between 25 and 45 minutes after the start of the mission. |
DescentPhase#
om.show_options_table('aviary.mission.gasp_based.phases.descent_phase.DescentPhaseOptions')
| Option | Default | Acceptable Values | Acceptable Types | Description |
|---|---|---|---|---|
| EAS_limit | (0.0, 'kn') | N/A | ['tuple'] | Value for maximum speed constraint in this phase. |
| alt_constraint_ref | (100.0, 'ft') | N/A | ['tuple'] | Scaling ref for the final altitude constraint. |
| alt_defect_ref | (None, 'ft') | N/A | ['tuple'] | Scale factor ref for altitude defect. |
| alt_lower | (0.0, 'ft') | N/A | ['tuple'] | Lower bound for altitude. |
| alt_ref | (1.0, 'ft') | N/A | ['tuple'] | Scale factor ref for altitude. |
| alt_ref0 | (0.0, 'ft') | N/A | ['tuple'] | Scale factor ref0 for altitude. |
| alt_upper | (0.0, 'ft') | N/A | ['tuple'] | Upper bound for altitude. |
| altitude_final | (0.0, 'ft') | N/A | ['tuple'] | Altitude for final point in the phase. |
| analytic | False | [True, False] | ['bool'] | When set to True, this is an analytic phase. |
| distance_defect_ref | (None, 'NM') | N/A | ['tuple'] | Scale factor ref for distance defect. |
| distance_lower | (0.0, 'NM') | N/A | ['tuple'] | Lower bound for distance. |
| distance_ref | (1.0, 'NM') | N/A | ['tuple'] | Scale factor ref for distance. |
| distance_ref0 | (0.0, 'NM') | N/A | ['tuple'] | Scale factor ref0 for distance. |
| distance_upper | (0.0, 'NM') | N/A | ['tuple'] | Upper bound for distance. |
| fix_initial | False | [True, False] | ['bool'] | Fixes the initial states (mass, distance) and does not allow them to change during the optimization. |
| input_initial | False | [True, False] | ['bool'] | Links all states to a calculation external to this phase. |
| input_speed_type | mach | [<SpeedType.MACH: 'mach'>, <SpeedType.EAS: 'EAS'>, <SpeedType.TAS: 'TAS'>] | N/A | Determines which speed variable is independent. The other two will be .computed from it. |
| mach_cruise | 0.0 | N/A | N/A | Defines the mach constraint in this phase. |
| mass_defect_ref | (None, 'lbm') | N/A | ['tuple'] | Scale factor ref for mass defect. |
| mass_lower | (0.0, 'lbm') | N/A | ['tuple'] | Lower bound for mass. |
| mass_ref | (1.0, 'lbm') | N/A | ['tuple'] | Scale factor ref for mass. |
| mass_ref0 | (0.0, 'lbm') | N/A | ['tuple'] | Scale factor ref0 for mass. |
| mass_upper | (0.0, 'lbm') | N/A | ['tuple'] | Upper bound for mass. |
| num_segments | N/A | N/A | ['int'] | The number of segments in transcription creation in Dymos. |
| order | N/A | N/A | ['int'] | The order of polynomials for interpolation in the transcription created in Dymos. |
| reserve | False | [True, False] | ['bool'] | Designate this phase as a reserve phase and contributes its fuel burn towards the reserve mission fuel requirements. Reserve phases should be be placed after all non-reserve phases in the phase_info. |
| target_distance | (None, 'm') | N/A | ['tuple'] | The total distance traveled by the aircraft from takeoff to landing for the primary mission, not including reserve missions. This value must be positive. |
| time_duration | (None, 's') | N/A | ['tuple'] | The amount of time taken by this phase added as a constraint. |
| time_duration_bounds | ((0, 0), 's') | N/A | ['tuple'] | Lower and upper bounds on the phase duration, in the form of a nested tuple: i.e. ((20, 36), "min") This constrains the duration to be between 20 and 36 min. |
| time_duration_ref | (1.0, 's') | N/A | ['tuple'] | Scale factor ref for duration. |
GroundrollPhase#
om.show_options_table('aviary.mission.gasp_based.phases.groundroll_phase.GroundrollPhaseOptions')
| Option | Default | Acceptable Values | Acceptable Types | Description |
|---|---|---|---|---|
| analytic | False | [True, False] | ['bool'] | When set to True, this is an analytic phase. |
| connect_initial_mass | True | [True, False] | ['bool'] | When true, initial mass is connected to an outside value. |
| distance_defect_ref | (3000.0, 'ft') | N/A | ['tuple'] | Scale factor ref for distance defect. |
| distance_lower | (0.0, 'ft') | N/A | ['tuple'] | Lower bound for distance. |
| distance_ref | (3000.0, 'ft') | N/A | ['tuple'] | Scale factor ref for distance. |
| distance_ref0 | (0.0, 'ft') | N/A | ['tuple'] | Scale factor ref0 for distance. |
| distance_upper | (4000.0, 'ft') | N/A | ['tuple'] | Upper bound for distance. |
| fix_initial | True | [True, False] | ['bool'] | Fixes the initial state (distance only) and does not allow it to change during the optimization. |
| fix_initial_mass | False | [True, False] | ['bool'] | Fixes the initial state for mass and does not allow it to change during the optimization. |
| mass_defect_ref | (100.0, 'lbm') | N/A | ['tuple'] | Scale factor ref for mass defect. |
| mass_lower | (0.0, 'lbm') | N/A | ['tuple'] | Lower bound for mass. |
| mass_ref | (100000.0, 'lbm') | N/A | ['tuple'] | Scale factor ref for mass. |
| mass_ref0 | (0.0, 'lbm') | N/A | ['tuple'] | Scale factor ref0 for mass. |
| mass_upper | (200000.0, 'lbm') | N/A | ['tuple'] | Upper bound for mass. |
| num_segments | 1 | N/A | ['int'] | The number of segments in transcription creation in Dymos. The default value is 1. |
| order | 3 | N/A | ['int'] | The order of polynomials for interpolation in the transcription created in Dymos. The default value is 3. |
| t_init_flaps | (100.0, 's') | N/A | ['tuple'] | Time where flaps are retracted. |
| t_init_gear | (100.0, 's') | N/A | ['tuple'] | Time where landing gear is lifted. |
| time_duration_bounds | ((1.0, 100.0), 's') | N/A | ['tuple'] | Lower and upper bounds on the phase duration, in the form of a nested tuple: i.e. ((20, 36), "min") This constrains the duration to be between 20 and 36 min. |
| time_duration_ref | (1.0, 's') | N/A | ['tuple'] | Scale factor ref for duration. |
| velocity_defect_ref | (None, 'kn') | N/A | ['tuple'] | Scale factor ref for velocity defect. |
| velocity_lower | (0.0, 'kn') | N/A | ['tuple'] | Lower bound for velocity. |
| velocity_ref | (100.0, 'kn') | N/A | ['tuple'] | Scale factor ref for velocity. |
| velocity_ref0 | (0.0, 'kn') | N/A | ['tuple'] | Scale factor ref0 for velocity. |
| velocity_upper | (1000.0, 'kn') | N/A | ['tuple'] | Upper bound for velocity. |
RotationPhase#
om.show_options_table('aviary.mission.gasp_based.phases.rotation_phase.RotationPhaseOptions')
| Option | Default | Acceptable Values | Acceptable Types | Description |
|---|---|---|---|---|
| analytic | False | [True, False] | ['bool'] | When set to True, this is an analytic phase. |
| angle_defect_ref | (0.01, 'rad') | N/A | ['tuple'] | Scale factor ref for angle defect. |
| angle_lower | (0.0, 'rad') | N/A | ['tuple'] | Lower bound for angle. |
| angle_ref | (1.0, 'rad') | N/A | ['tuple'] | Scale factor ref for angle. |
| angle_ref0 | (0.0, 'rad') | N/A | ['tuple'] | Scale factor ref0 for angle. |
| angle_upper | (0.4363323129985824, 'rad') | N/A | ['tuple'] | Upper bound for angle. |
| distance_defect_ref | (3000.0, 'ft') | N/A | ['tuple'] | Scale factor ref for distance defect. |
| distance_lower | (0.0, 'ft') | N/A | ['tuple'] | Lower bound for distance. |
| distance_ref | (3000.0, 'ft') | N/A | ['tuple'] | Scale factor ref for distance. |
| distance_ref0 | (0.0, 'ft') | N/A | ['tuple'] | Scale factor ref0 for distance. |
| distance_upper | (10000.0, 'ft') | N/A | ['tuple'] | Upper bound for distance. |
| fix_initial | False | [True, False] | ['bool'] | Fixes the initial states (mass, distance) and does not allow them to change during the optimization. |
| mass_defect_ref | (None, 'lbm') | N/A | ['tuple'] | Scale factor ref for mass defect. |
| mass_lower | (0.0, 'lbm') | N/A | ['tuple'] | Lower bound for mass. |
| mass_ref | (100000.0, 'lbm') | N/A | ['tuple'] | Scale factor ref for mass. |
| mass_ref0 | (0.0, 'lbm') | N/A | ['tuple'] | Scale factor ref0 for mass. |
| mass_upper | (190000.0, 'lbm') | N/A | ['tuple'] | Upper bound for mass. |
| normal_ref | (1.0, 'lbf') | N/A | ['tuple'] | Scale factor ref for the normal force constraint. |
| normal_ref0 | (0.0, 'lbf') | N/A | ['tuple'] | Scale factor ref0 for the normal force constraint. |
| num_segments | N/A | N/A | ['int'] | The number of segments in transcription creation in Dymos. |
| order | N/A | N/A | ['int'] | The order of polynomials for interpolation in the transcription created in Dymos. |
| reserve | False | [True, False] | ['bool'] | Designate this phase as a reserve phase and contributes its fuel burn towards the reserve mission fuel requirements. Reserve phases should be be placed after all non-reserve phases in the phase_info. |
| t_init_flaps | (100.0, 's') | N/A | ['tuple'] | Time where flaps are retracted. |
| t_init_gear | (100.0, 's') | N/A | ['tuple'] | Time where landing gear is lifted. |
| target_distance | (None, 'm') | N/A | ['tuple'] | The total distance traveled by the aircraft from takeoff to landing for the primary mission, not including reserve missions. This value must be positive. |
| time_duration | (None, 's') | N/A | ['tuple'] | The amount of time taken by this phase added as a constraint. |
| time_duration_bounds | ((1.0, 100.0), 's') | N/A | ['tuple'] | Lower and upper bounds on the phase duration, in the form of a nested tuple: i.e. ((20, 36), "min") This constrains the duration to be between 20 and 36 min. |
| time_duration_ref | (1.0, 's') | N/A | ['tuple'] | Scale factor ref for duration. |
| velocity_defect_ref | (None, 'kn') | N/A | ['tuple'] | Scale factor ref for velocity defect. |
| velocity_lower | (0.0, 'kn') | N/A | ['tuple'] | Lower bound for velocity. |
| velocity_ref | (100.0, 'kn') | N/A | ['tuple'] | Scale factor ref for velocity. |
| velocity_ref0 | (0.0, 'kn') | N/A | ['tuple'] | Scale factor ref0 for velocity. |
| velocity_upper | (1000.0, 'kn') | N/A | ['tuple'] | Upper bound for velocity. |