Complete phase_info user options reference for all Aviary EquationsOfMotion

Complete `phase_info` user options reference for all Aviary EquationsOfMotion#

HEIGHT_ENERGY#

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_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_constraint_ref	(None, 'm')	N/A	['tuple']	Multiplicative scale factor "ref" for the distance boundary constraint. If unspecified, then the value in distance_final is used. At present, only a final constraint is added.
distance_defect_ref	(None, '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_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_constraint_ref	(None, 'kg')	N/A	['tuple']	Multiplicative scale factor "ref" for the mass boundary constraint. If unspecified, then the value in mass_final is used. At present, only a final constraint is added.
mass_defect_ref	(None, '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.
phase_builder	PhaseType.DEFAULT	N/A	['PhaseType']	The phase builder to use for this phase. This is an experimental feature that currently allows a limited ability to select the equations of motion in certain cases. Currently, if you have a steady cruise phase in a two-dof mission, you can select "BREGUET_RANGE" or "SIMPLE_CRUISE".
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_bounds	((0.0, 1.0), 'unitless')	N/A	['tuple']	Tuple of form ((lower, upper), units) containing the upper and lower bounds for all values of throttle in the phase. The default of None for upper or lower means that bound will not be declared.
throttle_enforcement	path_constraint	['path_constraint', 'boundary_constraint', 'bounded', 'control', None]	N/A	Flag to enforce engine throttle bounds as path constraints, boundary constraints, solver bounds. You can also select "control" to turn throttle into a control, which allows you to assign a value or let the optimizer choose it.
throttle_final	(None, 'unitless')	N/A	['tuple']	Tuple of (value, units) containing value of throttle at the end of the phase. If this phase is connected to a downstream phase, final values should be specified with throttle_initial in that phase instead of here. When specified, a constraint is created on the final throttle.
throttle_initial	(None, 'unitless')	N/A	['tuple']	Tuple of (value, units) containing value of throttle at the start of the phase. When unspecified, the value comes from upstream. When specified, a constraint is created on the initial throttle.
throttle_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.
throttle_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.
throttle_ref	(1.0, 'unitless')	N/A	['tuple']	Multiplicative scale factor "ref" for throttle. Default is 1.0
throttle_ref0	(None, 'unitless')	N/A	['tuple']	Additive scale factor "ref0" for throttle.
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
transcription	collocation	N/A	N/A	Set the dymos transcription for the phase. Currently only Collocation and PicardShooting are supported. default = Collocation for backwards compatibility.

SOLVED_2DOF#

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_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.
angle_of_attack_bounds	((0.0, 15.0), 'deg')	N/A	['tuple']	Tuple of form ((lower, upper), units) containing the upper and lower bounds for all values of angle_of_attack in the phase. The default of None for upper or lower means that bound will not be declared.
angle_of_attack_final	(None, 'deg')	N/A	['tuple']	Tuple of (value, units) containing value of angle_of_attack at the end of the phase. If this phase is connected to a downstream phase, final values should be specified with angle_of_attack_initial in that phase instead of here. When specified, a constraint is created on the final angle_of_attack.
angle_of_attack_initial	(0.0, 'deg')	N/A	['tuple']	Tuple of (value, units) containing value of angle_of_attack at the start of the phase. When unspecified, the value comes from upstream. When specified, a constraint is created on the initial angle_of_attack.
angle_of_attack_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.
angle_of_attack_polynomial_order	1	N/A	['int']	The order of polynomials for interpolation in the transcription. Default is None, which does not use a polynomial.
angle_of_attack_ref	(10.0, 'deg')	N/A	['tuple']	Multiplicative scale factor "ref" for angle_of_attack. Default is 1.0
angle_of_attack_ref0	(None, 'deg')	N/A	['tuple']	Additive scale factor "ref0" for angle_of_attack.
clean	False	[True, False]	['bool']	Set to true to use clean aero with no ground effects.
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_constraint_ref	(None, 'm')	N/A	['tuple']	Multiplicative scale factor "ref" for the distance boundary constraint. If unspecified, then the value in distance_final is used. At present, only a final constraint is added.
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_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_constraint_ref	(None, 'kg')	N/A	['tuple']	Multiplicative scale factor "ref" for the mass boundary constraint. If unspecified, then the value in mass_final is used. At present, only a final constraint is added.
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.
phase_builder	PhaseType.DEFAULT	N/A	['PhaseType']	The phase builder to use for this phase. This is an experimental feature that currently allows a limited ability to select the equations of motion in certain cases. Currently, if you have a steady cruise phase in a two-dof mission, you can select "BREGUET_RANGE" or "SIMPLE_CRUISE".
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, 'ft')	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), 'ft')	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, 'ft')	N/A	['tuple']	Multiplicative scale factor "ref" for time_duration. Default is 1.0
time_initial	(None, 'ft')	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), 'ft')	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, 'ft')	N/A	['tuple']	Multiplicative scale factor "ref" for time_initial. Default is 1.0

TWO_DEGREES_OF_FREEDOM#

The TWO_DEGREES_OF_FREEDOM phases contain some options that are unique to each phase.

AccelPhase#

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.
distance_bounds	((0.0, None), 'NM')	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_constraint_ref	(None, 'NM')	N/A	['tuple']	Multiplicative scale factor "ref" for the distance boundary constraint. If unspecified, then the value in distance_final is used. At present, only a final constraint is added.
distance_defect_ref	(None, 'NM')	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, 'NM')	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, 'NM')	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	(1.0, 'NM')	N/A	['tuple']	Multiplicative scale factor "ref" for distance. Default is 1.0
distance_ref0	(None, 'NM')	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.
mass_bounds	((0.0, None), 'lbm')	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_constraint_ref	(None, 'lbm')	N/A	['tuple']	Multiplicative scale factor "ref" for the mass boundary constraint. If unspecified, then the value in mass_final is used. At present, only a final constraint is added.
mass_defect_ref	(None, 'lbm')	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, 'lbm')	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, 'lbm')	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	(1.0, 'lbm')	N/A	['tuple']	Multiplicative scale factor "ref" for mass. Default is 1.0
mass_ref0	(None, 'lbm')	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.
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.
phase_builder	PhaseType.DEFAULT	N/A	['PhaseType']	The phase builder to use for this phase. This is an experimental feature that currently allows a limited ability to select the equations of motion in certain cases. Currently, if you have a steady cruise phase in a two-dof mission, you can select "BREGUET_RANGE" or "SIMPLE_CRUISE".
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']	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
velocity_bounds	((0.0, None), 'kn')	N/A	['tuple']	Tuple of form ((lower, upper), units) containing the upper and lower bounds for all values of velocity in the phase. The default of None for upper or lower means that bound will not be declared.
velocity_constraint_ref	(None, 'kn')	N/A	['tuple']	Multiplicative scale factor "ref" for the velocity boundary constraint. If unspecified, then the value in velocity_final is used. At present, only a final constraint is added.
velocity_defect_ref	(None, 'kn')	N/A	['tuple']	Multiplicative scale factor "ref" for the velocity defect constraint. Default is None, which means the ref and defect_ref are the same.
velocity_final	(None, 'kn')	N/A	['tuple']	Tuple of (value, units) containing value of velocity at the end of the phase. If this phase is connected to a downstream phase, final values should be specified with velocity_initial in that phase instead of here. When specified, a constraint is created on the final velocity.
velocity_initial	(None, 'kn')	N/A	['tuple']	Tuple of (value, units) containing value of velocity at the start of the phase. When unspecified, the optimizer controls the value. When specified, a constraint is created on the initial velocity.
velocity_ref	(1.0, 'kn')	N/A	['tuple']	Multiplicative scale factor "ref" for velocity. Default is 1.0
velocity_ref0	(None, 'kn')	N/A	['tuple']	Additive scale factor "ref0" for velocity.
velocity_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.

AscentPhase#

om.show_options_table('aviary.mission.two_dof.phases.ascent_phase.AscentPhaseOptions')

Option	Default	Acceptable Values	Acceptable Types	Description
altitude_bounds	((0.0, 700.0), '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_constraint_ref	(100.0, 'ft')	N/A	['tuple']	Multiplicative scale factor "ref" for the altitude boundary constraint. If unspecified, then the value in altitude_final is used. At present, only a final constraint is added.
altitude_defect_ref	(None, 'ft')	N/A	['tuple']	Multiplicative scale factor "ref" for the altitude defect constraint. Default is None, which means the ref and defect_ref are the same.
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 optimizer controls the value. When specified, a constraint is created on the initial altitude.
altitude_ref	(100.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.
altitude_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.
angle_of_attack_bounds	((np.float64(-0.5235987755982988), np.float64(0.5235987755982988)), 'rad')	N/A	['tuple']	Tuple of form ((lower, upper), units) containing the upper and lower bounds for all values of angle_of_attack in the phase. The default of None for upper or lower means that bound will not be declared.
angle_of_attack_final	(None, 'rad')	N/A	['tuple']	Tuple of (value, units) containing value of angle_of_attack at the end of the phase. If this phase is connected to a downstream phase, final values should be specified with angle_of_attack_initial in that phase instead of here. When specified, a constraint is created on the final angle_of_attack.
angle_of_attack_initial	(None, 'rad')	N/A	['tuple']	Tuple of (value, units) containing value of angle_of_attack at the start of the phase. When unspecified, the value comes from upstream. When specified, a constraint is created on the initial angle_of_attack.
angle_of_attack_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.
angle_of_attack_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.
angle_of_attack_ref	(np.float64(0.08726646259971647), 'rad')	N/A	['tuple']	Multiplicative scale factor "ref" for angle_of_attack. Default is 1.0
angle_of_attack_ref0	(None, 'rad')	N/A	['tuple']	Additive scale factor "ref0" for angle_of_attack.
distance_bounds	((0.0, 10000.0), 'ft')	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_constraint_ref	(None, 'ft')	N/A	['tuple']	Multiplicative scale factor "ref" for the distance boundary constraint. If unspecified, then the value in distance_final is used. At present, only a final constraint is added.
distance_defect_ref	(None, 'ft')	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, 'ft')	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, 'ft')	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	(3000.0, 'ft')	N/A	['tuple']	Multiplicative scale factor "ref" for distance. Default is 1.0
distance_ref0	(None, 'ft')	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.
flight_path_angle_bounds	((-0.2617993877991494, 0.4363323129985824), 'rad')	N/A	['tuple']	Tuple of form ((lower, upper), units) containing the upper and lower bounds for all values of flight_path_angle in the phase. The default of None for upper or lower means that bound will not be declared.
flight_path_angle_constraint_ref	(None, 'rad')	N/A	['tuple']	Multiplicative scale factor "ref" for the flight_path_angle boundary constraint. If unspecified, then the value in flight_path_angle_final is used. At present, only a final constraint is added.
flight_path_angle_defect_ref	(None, 'rad')	N/A	['tuple']	Multiplicative scale factor "ref" for the flight_path_angle defect constraint. Default is None, which means the ref and defect_ref are the same.
flight_path_angle_final	(None, 'rad')	N/A	['tuple']	Tuple of (value, units) containing value of flight_path_angle at the end of the phase. If this phase is connected to a downstream phase, final values should be specified with flight_path_angle_initial in that phase instead of here. When specified, a constraint is created on the final flight_path_angle.
flight_path_angle_initial	(None, 'rad')	N/A	['tuple']	Tuple of (value, units) containing value of flight_path_angle at the start of the phase. When unspecified, the optimizer controls the value. When specified, a constraint is created on the initial flight_path_angle.
flight_path_angle_ref	(np.float64(0.017453292519943295), 'rad')	N/A	['tuple']	Multiplicative scale factor "ref" for flight_path_angle. Default is 1.0
flight_path_angle_ref0	(None, 'rad')	N/A	['tuple']	Additive scale factor "ref0" for flight_path_angle.
flight_path_angle_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.
mass_bounds	((0.0, 190000.0), 'lbm')	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_constraint_ref	(None, 'lbm')	N/A	['tuple']	Multiplicative scale factor "ref" for the mass boundary constraint. If unspecified, then the value in mass_final is used. At present, only a final constraint is added.
mass_defect_ref	(100.0, 'lbm')	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, 'lbm')	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, 'lbm')	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	(100000.0, 'lbm')	N/A	['tuple']	Multiplicative scale factor "ref" for mass. Default is 1.0
mass_ref0	(None, 'lbm')	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.
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.
phase_builder	PhaseType.DEFAULT	N/A	['PhaseType']	The phase builder to use for this phase. This is an experimental feature that currently allows a limited ability to select the equations of motion in certain cases. Currently, if you have a steady cruise phase in a two-dof mission, you can select "BREGUET_RANGE" or "SIMPLE_CRUISE".
pitch_constraint_bounds	((0.0, 15.0), 'deg')	N/A	['tuple']	Tuple containing the lower and upper bounds of the pitch constraint, with unit string.
pitch_constraint_ref	(1.0, 'deg')	N/A	['tuple']	Scale factor ref for the pitch 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']	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
velocity_bounds	((0.0, 1000.0), 'kn')	N/A	['tuple']	Tuple of form ((lower, upper), units) containing the upper and lower bounds for all values of velocity in the phase. The default of None for upper or lower means that bound will not be declared.
velocity_constraint_ref	(None, 'kn')	N/A	['tuple']	Multiplicative scale factor "ref" for the velocity boundary constraint. If unspecified, then the value in velocity_final is used. At present, only a final constraint is added.
velocity_defect_ref	(None, 'kn')	N/A	['tuple']	Multiplicative scale factor "ref" for the velocity defect constraint. Default is None, which means the ref and defect_ref are the same.
velocity_final	(None, 'kn')	N/A	['tuple']	Tuple of (value, units) containing value of velocity at the end of the phase. If this phase is connected to a downstream phase, final values should be specified with velocity_initial in that phase instead of here. When specified, a constraint is created on the final velocity.
velocity_initial	(None, 'kn')	N/A	['tuple']	Tuple of (value, units) containing value of velocity at the start of the phase. When unspecified, the optimizer controls the value. When specified, a constraint is created on the initial velocity.
velocity_ref	(100.0, 'kn')	N/A	['tuple']	Multiplicative scale factor "ref" for velocity. Default is 1.0
velocity_ref0	(None, 'kn')	N/A	['tuple']	Additive scale factor "ref0" for velocity.
velocity_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.

SimpleCruisePhase#

This is the best choice for a level cruise when using the two DOF equations. SimpleCruisePhase integrates mass using the specified transcription, but the distance is computed from the fixed velocity. This can be selected by setting the “phase_type” option to PhaseType.SIMPLE_CRUISE.

om.show_options_table('aviary.mission.two_dof.phases.simple_cruise_phase.SimpleCruisePhaseOptions')

Option	Default	Acceptable Values	Acceptable Types	Description
alt_cruise	(0.0, 'ft')	N/A	['tuple']	Cruise altitude.
mach_cruise	0.0	N/A	N/A	Cruise Mach number.
mass_bounds	((0.0, None), 'lbm')	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_constraint_ref	(None, 'lbm')	N/A	['tuple']	Multiplicative scale factor "ref" for the mass boundary constraint. If unspecified, then the value in mass_final is used. At present, only a final constraint is added.
mass_defect_ref	(None, 'lbm')	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, 'lbm')	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, 'lbm')	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	(1.0, 'lbm')	N/A	['tuple']	Multiplicative scale factor "ref" for mass. Default is 1.0
mass_ref0	(None, 'lbm')	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.
num_segments	5	N/A	['int']	The number of segments in transcription creation in Dymos. While this phase is usually an analytic phase, this option is needed if an external subsystem requires a dynamic transcription.
order	3	N/A	['int']	The order of polynomials for interpolation in the transcription created in Dymos. While this phase is usually an analytic phase, this option is needed if an external subsystem requires a dynamic transcription.
phase_builder	PhaseType.DEFAULT	N/A	['PhaseType']	The phase builder to use for this phase. This is an experimental feature that currently allows a limited ability to select the equations of motion in certain cases. Currently, if you have a steady cruise phase in a two-dof mission, you can select "BREGUET_RANGE" or "SIMPLE_CRUISE".
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_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	((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.
time_initial_ref	(1.0, 's')	N/A	['tuple']	Multiplicative scale factor "ref" for time_initial. Default is 1.0

BreguetCruisePhase (Optional)#

The BreguetCruisePhase computes distance analytically using a form of the Breguet Range equation. This will generally be a little faster than SimpleCruisePhase, but it comes with a limitation that no external subsystems can contain a state that requires integration. This can be selected by setting the “phase_type” option to PhaseType.BREGUET_RANGE.

om.show_options_table(
    'aviary.mission.two_dof.phases.breguet_cruise_phase.BreguetCruisePhaseOptions'
)

Option	Default	Acceptable Values	Acceptable Types	Description
alt_cruise	(0.0, 'ft')	N/A	['tuple']	Cruise altitude.
mach_cruise	0.0	N/A	N/A	Cruise Mach number.
phase_builder	PhaseType.DEFAULT	N/A	['PhaseType']	The phase builder to use for this phase. This is an experimental feature that currently allows a limited ability to select the equations of motion in certain cases. Currently, if you have a steady cruise phase in a two-dof mission, you can select "BREGUET_RANGE" or "SIMPLE_CRUISE".
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.

FlightPhase#

The FlightPhase can be used for ascending and descending mission phases.

om.show_options_table('aviary.mission.two_dof.phases.flight_phase.FlightPhaseOptions')

Option	Default	Acceptable Values	Acceptable Types	Description
EAS_target	(0.0, 'kn')	N/A	['tuple']	Value for maximum speed constraint for this phase.
altitude_bounds	((0.0, 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_constraint_ref	(None, 'ft')	N/A	['tuple']	Multiplicative scale factor "ref" for the altitude boundary constraint. If unspecified, then the value in altitude_final is used. At present, only a final constraint is added.
altitude_defect_ref	(None, 'ft')	N/A	['tuple']	Multiplicative scale factor "ref" for the altitude defect constraint. Default is None, which means the ref and defect_ref are the same.
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 optimizer controls the value. When specified, a constraint is created on the initial altitude.
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.
altitude_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.
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), 'NM')	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_constraint_ref	(None, 'NM')	N/A	['tuple']	Multiplicative scale factor "ref" for the distance boundary constraint. If unspecified, then the value in distance_final is used. At present, only a final constraint is added.
distance_defect_ref	(None, 'NM')	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, 'NM')	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, 'NM')	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	(1.0, 'NM')	N/A	['tuple']	Multiplicative scale factor "ref" for distance. Default is 1.0
distance_ref0	(None, 'NM')	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.
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_target	0.0	N/A	N/A	Defines the maximum mach constraint for this phase.
mass_bounds	((0.0, None), 'lbm')	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_constraint_ref	(None, 'lbm')	N/A	['tuple']	Multiplicative scale factor "ref" for the mass boundary constraint. If unspecified, then the value in mass_final is used. At present, only a final constraint is added.
mass_defect_ref	(None, 'lbm')	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, 'lbm')	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, 'lbm')	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	(1.0, 'lbm')	N/A	['tuple']	Multiplicative scale factor "ref" for mass. Default is 1.0
mass_ref0	(None, 'lbm')	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.
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.
phase_builder	PhaseType.DEFAULT	N/A	['PhaseType']	The phase builder to use for this phase. This is an experimental feature that currently allows a limited ability to select the equations of motion in certain cases. Currently, if you have a steady cruise phase in a two-dof mission, you can select "BREGUET_RANGE" or "SIMPLE_CRUISE".
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.
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

GroundrollPhase#

om.show_options_table('aviary.mission.two_dof.phases.groundroll_phase.GroundrollPhaseOptions')

Option	Default	Acceptable Values	Acceptable Types	Description
distance_bounds	((0.0, 4000.0), 'ft')	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_constraint_ref	(None, 'ft')	N/A	['tuple']	Multiplicative scale factor "ref" for the distance boundary constraint. If unspecified, then the value in distance_final is used. At present, only a final constraint is added.
distance_defect_ref	(None, 'ft')	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, 'ft')	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, 'ft')	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	(3000.0, 'ft')	N/A	['tuple']	Multiplicative scale factor "ref" for distance. Default is 1.0
distance_ref0	(None, 'ft')	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.
mass_bounds	((0.0, 200000.0), 'lbm')	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_constraint_ref	(None, 'lbm')	N/A	['tuple']	Multiplicative scale factor "ref" for the mass boundary constraint. If unspecified, then the value in mass_final is used. At present, only a final constraint is added.
mass_defect_ref	(100.0, 'lbm')	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, 'lbm')	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, 'lbm')	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	(100000.0, 'lbm')	N/A	['tuple']	Multiplicative scale factor "ref" for mass. Default is 1.0
mass_ref0	(None, 'lbm')	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.
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.
phase_builder	PhaseType.DEFAULT	N/A	['PhaseType']	The phase builder to use for this phase. This is an experimental feature that currently allows a limited ability to select the equations of motion in certain cases. Currently, if you have a steady cruise phase in a two-dof mission, you can select "BREGUET_RANGE" or "SIMPLE_CRUISE".
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	((1.0, 100.0), '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
velocity_bounds	((0.0, 1000.0), 'kn')	N/A	['tuple']	Tuple of form ((lower, upper), units) containing the upper and lower bounds for all values of velocity in the phase. The default of None for upper or lower means that bound will not be declared.
velocity_constraint_ref	(None, 'kn')	N/A	['tuple']	Multiplicative scale factor "ref" for the velocity boundary constraint. If unspecified, then the value in velocity_final is used. At present, only a final constraint is added.
velocity_defect_ref	(None, 'kn')	N/A	['tuple']	Multiplicative scale factor "ref" for the velocity defect constraint. Default is None, which means the ref and defect_ref are the same.
velocity_final	(None, 'kn')	N/A	['tuple']	Tuple of (value, units) containing value of velocity at the end of the phase. If this phase is connected to a downstream phase, final values should be specified with velocity_initial in that phase instead of here. When specified, a constraint is created on the final velocity.
velocity_initial	(None, 'kn')	N/A	['tuple']	Tuple of (value, units) containing value of velocity at the start of the phase. When unspecified, the optimizer controls the value. When specified, a constraint is created on the initial velocity.
velocity_ref	(100.0, 'kn')	N/A	['tuple']	Multiplicative scale factor "ref" for velocity. Default is 1.0
velocity_ref0	(None, 'kn')	N/A	['tuple']	Additive scale factor "ref0" for velocity.
velocity_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.

RotationPhase#

om.show_options_table('aviary.mission.two_dof.phases.rotation_phase.RotationPhaseOptions')

Option	Default	Acceptable Values	Acceptable Types	Description
angle_of_attack_bounds	((0.0, 0.4363323129985824), 'rad')	N/A	['tuple']	Tuple of form ((lower, upper), units) containing the upper and lower bounds for all values of angle_of_attack in the phase. The default of None for upper or lower means that bound will not be declared.
angle_of_attack_constraint_ref	(None, 'rad')	N/A	['tuple']	Multiplicative scale factor "ref" for the angle_of_attack boundary constraint. If unspecified, then the value in angle_of_attack_final is used. At present, only a final constraint is added.
angle_of_attack_defect_ref	(0.01, 'rad')	N/A	['tuple']	Multiplicative scale factor "ref" for the angle_of_attack defect constraint. Default is None, which means the ref and defect_ref are the same.
angle_of_attack_final	(None, 'rad')	N/A	['tuple']	Tuple of (value, units) containing value of angle_of_attack at the end of the phase. If this phase is connected to a downstream phase, final values should be specified with angle_of_attack_initial in that phase instead of here. When specified, a constraint is created on the final angle_of_attack.
angle_of_attack_initial	(None, 'rad')	N/A	['tuple']	Tuple of (value, units) containing value of angle_of_attack at the start of the phase. When unspecified, the optimizer controls the value. When specified, a constraint is created on the initial angle_of_attack.
angle_of_attack_ref	(1.0, 'rad')	N/A	['tuple']	Multiplicative scale factor "ref" for angle_of_attack. Default is 1.0
angle_of_attack_ref0	(None, 'rad')	N/A	['tuple']	Additive scale factor "ref0" for angle_of_attack.
angle_of_attack_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.
distance_bounds	((0.0, 10000.0), 'ft')	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_constraint_ref	(None, 'ft')	N/A	['tuple']	Multiplicative scale factor "ref" for the distance boundary constraint. If unspecified, then the value in distance_final is used. At present, only a final constraint is added.
distance_defect_ref	(None, 'ft')	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, 'ft')	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, 'ft')	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	(3000.0, 'ft')	N/A	['tuple']	Multiplicative scale factor "ref" for distance. Default is 1.0
distance_ref0	(None, 'ft')	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.
mass_bounds	((0.0, 190000.0), 'lbm')	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_constraint_ref	(None, 'lbm')	N/A	['tuple']	Multiplicative scale factor "ref" for the mass boundary constraint. If unspecified, then the value in mass_final is used. At present, only a final constraint is added.
mass_defect_ref	(None, 'lbm')	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, 'lbm')	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, 'lbm')	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	(100000.0, 'lbm')	N/A	['tuple']	Multiplicative scale factor "ref" for mass. Default is 1.0
mass_ref0	(None, 'lbm')	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.
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.
phase_builder	PhaseType.DEFAULT	N/A	['PhaseType']	The phase builder to use for this phase. This is an experimental feature that currently allows a limited ability to select the equations of motion in certain cases. Currently, if you have a steady cruise phase in a two-dof mission, you can select "BREGUET_RANGE" or "SIMPLE_CRUISE".
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']	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	((1.0, 100.0), '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
velocity_bounds	((0.0, 1000.0), 'kn')	N/A	['tuple']	Tuple of form ((lower, upper), units) containing the upper and lower bounds for all values of velocity in the phase. The default of None for upper or lower means that bound will not be declared.
velocity_constraint_ref	(None, 'kn')	N/A	['tuple']	Multiplicative scale factor "ref" for the velocity boundary constraint. If unspecified, then the value in velocity_final is used. At present, only a final constraint is added.
velocity_defect_ref	(None, 'kn')	N/A	['tuple']	Multiplicative scale factor "ref" for the velocity defect constraint. Default is None, which means the ref and defect_ref are the same.
velocity_final	(None, 'kn')	N/A	['tuple']	Tuple of (value, units) containing value of velocity at the end of the phase. If this phase is connected to a downstream phase, final values should be specified with velocity_initial in that phase instead of here. When specified, a constraint is created on the final velocity.
velocity_initial	(None, 'kn')	N/A	['tuple']	Tuple of (value, units) containing value of velocity at the start of the phase. When unspecified, the optimizer controls the value. When specified, a constraint is created on the initial velocity.
velocity_ref	(100.0, 'kn')	N/A	['tuple']	Multiplicative scale factor "ref" for velocity. Default is 1.0
velocity_ref0	(None, 'kn')	N/A	['tuple']	Additive scale factor "ref0" for velocity.
velocity_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.