fastoad.models.performances.mission.segments.registered.cruise module

Classes for simulating cruise segments.

class fastoad.models.performances.mission.segments.registered.cruise.CruiseSegment(name: str = '', target: fastoad.model_base.flight_point.FlightPoint = <object object>, isa_offset: float = 0.0, propulsion: fastoad.model_base.propulsion.IPropulsion = <object object>, polar: fastoad.models.performances.mission.polar.Polar = <object object>, polar_modifier: fastoad.models.performances.mission.polar_modifier.AbstractPolarModifier = UnchangedPolar(), reference_area: float = <object object>, time_step: float = 60.0, maximum_CL: Optional[float] = None, altitude_bounds: tuple = (-500.0, 40000.0), mach_bounds: tuple = (-1e-06, 5.0), interrupt_if_getting_further_from_target: bool = True, engine_setting: fastoad.constants.EngineSetting = EngineSetting.CLIMB)

Bases: fastoad.models.performances.mission.segments.time_step_base.AbstractRegulatedThrustSegment

Class for computing cruise flight segment at constant altitude and speed.

Mach is considered constant, equal to Mach at starting point. Altitude is constant. Target is a specified ground_distance. The target definition indicates the ground_distance to be covered during the segment, independently of the initial value.

get_distance_to_target(flight_points: List[fastoad.model_base.flight_point.FlightPoint], target: fastoad.model_base.flight_point.FlightPoint) → float

Computes a “distance” from last flight point to target.

Computed does not need to have a real meaning. The important point is that it must be signed so that algorithm knows on which “side” of the target we are. And of course, it should be 0. if flight point is on target.

Parameters

• flight_points – list of all currently computed flight_points

• target – segment target (will not contain relative values)

Returns

15. if target is attained, a non-null value otherwise

property target: fastoad.model_base.flight_point.FlightPoint

The base class of the class hierarchy.

When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

class fastoad.models.performances.mission.segments.registered.cruise.OptimalCruiseSegment(name: str = '', target: fastoad.model_base.flight_point.FlightPoint = <object object>, isa_offset: float = 0.0, propulsion: fastoad.model_base.propulsion.IPropulsion = <object object>, polar: fastoad.models.performances.mission.polar.Polar = <object object>, polar_modifier: fastoad.models.performances.mission.polar_modifier.AbstractPolarModifier = UnchangedPolar(), reference_area: float = <object object>, time_step: float = 60.0, maximum_CL: Optional[float] = None, altitude_bounds: tuple = (-500.0, 40000.0), mach_bounds: tuple = (-1e-06, 5.0), interrupt_if_getting_further_from_target: bool = True, engine_setting: fastoad.constants.EngineSetting = EngineSetting.CLIMB)

Bases: fastoad.models.performances.mission.segments.registered.cruise.CruiseSegment

Class for computing cruise flight segment at maximum lift/drag ratio.

Altitude is set at every point to get the optimum CL according to current mass. Target is a specified ground_distance. The target definition indicates the ground_distance to be covered during the segment, independently of the initial value. Target should also specify a speed parameter set to “constant”, among mach, true_airspeed and equivalent_airspeed. If not, Mach will be assumed constant.

compute_from_start_to_target(start: fastoad.model_base.flight_point.FlightPoint, target: fastoad.model_base.flight_point.FlightPoint) → pandas.core.frame.DataFrame

Here should come the implementation for computing flight points between start and target flight points.

Parameters

• start –

• target – Definition of segment target

Returns

a pandas DataFrame where column names match fields of FlightPoint

property target: fastoad.model_base.flight_point.FlightPoint

The base class of the class hierarchy.

When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

class fastoad.models.performances.mission.segments.registered.cruise.ClimbAndCruiseSegment(name: str = '', target: fastoad.model_base.flight_point.FlightPoint = <object object>, isa_offset: float = 0.0, propulsion: fastoad.model_base.propulsion.IPropulsion = <object object>, polar: fastoad.models.performances.mission.polar.Polar = <object object>, polar_modifier: fastoad.models.performances.mission.polar_modifier.AbstractPolarModifier = UnchangedPolar(), reference_area: float = <object object>, time_step: float = 60.0, maximum_CL: Optional[float] = None, altitude_bounds: tuple = (-500.0, 40000.0), mach_bounds: tuple = (-1e-06, 5.0), interrupt_if_getting_further_from_target: bool = True, engine_setting: fastoad.constants.EngineSetting = EngineSetting.CLIMB, climb_segment: Optional[fastoad.models.performances.mission.segments.registered.altitude_change.AltitudeChangeSegment] = None, maximum_flight_level: float = 500.0)

Bases: fastoad.models.performances.mission.segments.registered.cruise.CruiseSegment

Class for computing cruise flight segment at constant altitude.

Target is a specified ground_distance. The target definition indicates the ground_distance to be covered during the segment, independently of the initial value. Target should also specify a speed parameter set to “constant”, among mach, true_airspeed and equivalent_airspeed. If not, Mach will be assumed constant.

Target altitude can also be set to OPTIMAL_FLIGHT_LEVEL. In that case, the cruise will be preceded by a climb segment and climb_segment must be set at instantiation.

(Target ground distance will be achieved by the sum of ground distances covered during climb and cruise)

In this case, climb will be done up to the IFR Flight Level (as multiple of 100 feet) that ensures minimum mass decrease, while being at most equal to maximum_flight_level.

climb_segment: fastoad.models.performances.mission.segments.registered.altitude_change.AltitudeChangeSegment = None

The AltitudeChangeSegment that can be used if a preliminary climb is needed (its target will be ignored).

maximum_flight_level: float = 500.0

The maximum allowed flight level (i.e. multiple of 100 feet).

compute_from_start_to_target(start: fastoad.model_base.flight_point.FlightPoint, target: fastoad.model_base.flight_point.FlightPoint) → pandas.core.frame.DataFrame

Here should come the implementation for computing flight points between start and target flight points.

Parameters

• start –

• target – Definition of segment target

Returns

a pandas DataFrame where column names match fields of FlightPoint

property target: fastoad.model_base.flight_point.FlightPoint

The base class of the class hierarchy.

When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.

class fastoad.models.performances.mission.segments.registered.cruise.BreguetCruiseSegment(name: str = '', target: fastoad.model_base.flight_point.FlightPoint = <object object>, isa_offset: float = 0.0, propulsion: fastoad.model_base.propulsion.IPropulsion = <object object>, polar: fastoad.models.performances.mission.polar.Polar = <object object>, polar_modifier: fastoad.models.performances.mission.polar_modifier.AbstractPolarModifier = UnchangedPolar(), reference_area: float = 1.0, time_step: float = 60.0, maximum_CL: Optional[float] = None, altitude_bounds: tuple = (-500.0, 40000.0), mach_bounds: tuple = (-1e-06, 5.0), interrupt_if_getting_further_from_target: bool = True, engine_setting: fastoad.constants.EngineSetting = EngineSetting.CLIMB, use_max_lift_drag_ratio: bool = False)

Bases: fastoad.models.performances.mission.segments.registered.cruise.CruiseSegment

Class for computing cruise flight segment at constant altitude using Breguet-Leduc formula.

As formula relies on SFC, the propulsion model must be able to fill FlightPoint.sfc when FlightPoint.thrust is provided.

use_max_lift_drag_ratio: bool = False

if True, max lift/drag ratio will be used instead of the one computed with polar using CL deduced from mass and altitude. In this case, reference_area parameter will be unused

reference_area: float = 1.0

The reference area, in m**2. Used only if use_max_lift_drag_ratio is False.

compute_from_start_to_target(start: fastoad.model_base.flight_point.FlightPoint, target: fastoad.model_base.flight_point.FlightPoint) → pandas.core.frame.DataFrame

Here should come the implementation for computing flight points between start and target flight points.

Parameters

• start –

• target – Definition of segment target

Returns

a pandas DataFrame where column names match fields of FlightPoint

property target: fastoad.model_base.flight_point.FlightPoint

The base class of the class hierarchy.

When called, it accepts no arguments and returns a new featureless instance that has no instance attributes and cannot be given any.