fastga.utils.postprocessing.analysis_and_plots module
Defines the analysis and plotting functions for postprocessing.
- fastga.utils.postprocessing.analysis_and_plots.aircraft_geometry_plot(aircraft_file_path: str, name='', fig=None, plot_nacelle: bool = True, file_formatter=None, length_unit='m') plotly.graph_objs._figurewidget.FigureWidget[source]
Returns a figure plot of the top view of the wing. Different designs can be superposed by providing an existing fig. Each design can be provided a name.
- Parameters
aircraft_file_path – path of data file
name – name to give to the trace added to the figure
fig – existing figure to which add the plot
plot_nacelle – boolean to turn on or off the plotting of the nacelles
file_formatter – the formatter that defines the format of data file. If not provided,
default format will be assumed. :param length_unit: The length unit of the plot, meter is the default unit :return: wing plot figure.
- fastga.utils.postprocessing.analysis_and_plots.evolution_diagram(aircraft_file_path: str, name='', fig=None, file_formatter=None) plotly.graph_objs._figurewidget.FigureWidget[source]
Returns a figure plot of the V-N diagram of the aircraft. Different designs can be superposed by providing an existing fig. Each design can be provided a name.
- Parameters
aircraft_file_path – path of data file
name – name to give to the trace added to the figure
fig – existing figure to which add the plot
file_formatter – the formatter that defines the format of data file. If not provided,
default format will be assumed. :return: V-N plot figure.
- fastga.utils.postprocessing.analysis_and_plots.compressibility_effects_diagram(aircraft_file_path: str, name: str = '', fig=None, file_formatter=None) plotly.graph_objs._figurewidget.FigureWidget[source]
Returns a figure plot of the evolution of the lift curve slope with Mach number.
- Parameters
aircraft_file_path – path of the aircraft data file
name – name to give to the trace added to the figure
fig – existing figure to which add the plot
file_formatter – the formatter that defines the format of data file. If not provided,
default format will be assumed. :return: Cl_alpha distribution with Mach number.
- fastga.utils.postprocessing.analysis_and_plots.cl_wing_diagram(aircraft_file_path: str, name: str = '', prop_on: bool = False, fig=None, file_formatter=None) plotly.graph_objs._figurewidget.FigureWidget[source]
Returns a figure plot of the CL distribution on the semi-wing.
- Parameters
aircraft_file_path – path of the aircraft data file
name – name to give to the trace added to the figure
prop_on – boolean stating if the rotor is on or off (for single propeller plane)
fig – existing figure to which add the plot
file_formatter – the formatter that defines the format of data file. If not provided,
default format will be assumed. :return: Cl distribution figure along the span.
- fastga.utils.postprocessing.analysis_and_plots.cg_lateral_diagram(aircraft_file_path: str, name='', fig=None, file_formatter=None, color=None, length_unit='m') plotly.graph_objs._figurewidget.FigureWidget[source]
Returns a figure plot of the lateral view of the plane. Different designs can be superposed by providing an existing fig. Each design can be provided a name.
- Parameters
aircraft_file_path – path of data file
name – name to give to the trace added to the figure
color – color that we give to the aft, empty and fwd CGs of the aircraft
fig – existing figure to which add the plot
file_formatter – the formatter that defines the format of data file. If not provided,
default format will be assumed. :param length_unit: The length unit of the plot, meter is the default unit :return: wing plot figure.
- fastga.utils.postprocessing.analysis_and_plots.mass_breakdown_bar_plot(aircraft_file_path: str, name=None, fig=None, file_formatter=None, weight_unit='kg') plotly.graph_objs._figurewidget.FigureWidget[source]
Returns a figure plot of the aircraft mass breakdown using bar plots. Different designs can be superposed by providing an existing fig. Each design can be provided a name.
- Parameters
aircraft_file_path – path of data file
name – name to give to the trace added to the figure
fig – existing figure to which add the plot
file_formatter – the formatter that defines the format of data file. If not provided, default format will be assumed.
weight_unit – The weight unit of the plot, kilogram is the default unit
- Returns
bar plot figure.
- fastga.utils.postprocessing.analysis_and_plots.mass_breakdown_sun_plot(aircraft_file_path: str, file_formatter=None, weight_unit='kg')[source]
Returns a figure sunburst plot of the mass breakdown. On the left a MTOW sunburst and on the right a OWE sunburst.
- Parameters
aircraft_file_path – path of data file
file_formatter – the formatter that defines the format of data file. If not provided, default format will be assumed.
weight_unit – The weight unit of the plot, kilogram is the default unit
- Returns
sunburst plot figure.
- fastga.utils.postprocessing.analysis_and_plots.drag_breakdown_diagram(aircraft_file_path: str, file_formatter=None) plotly.graph_objs._figurewidget.FigureWidget[source]
Return a plot of the drag breakdown of the wing in cruise conditions.
- fastga.utils.postprocessing.analysis_and_plots.payload_range(aircraft_file_path: str, name='', fig=None, file_formatter=None) plotly.graph_objs._figurewidget.FigureWidget[source]
Returns a figure plot of the payload range diagram of the plane. Different designs can be superposed by providing an existing fig. Each design can be provided a name. :param aircraft_file_path: path of data file :param name: name to give to the trace added to the figure :param fig: existing figure to which add the plot :param file_formatter: the formatter that defines the format of data file. If not provided, default format will be assumed. :return: payload range figure.
- fastga.utils.postprocessing.analysis_and_plots.aircraft_polar(aircraft_file_path: str, name=None, fig=None, file_formatter=None, equilibrated=False) plotly.graph_objs._figurewidget.FigureWidget[source]
Returns a figure plot of the polar of the plane. Different designs can be superposed by providing an existing fig. Each design can be provided a name. The value obtained for the finesse for the equilibrated drag polar is quite low.
- Parameters
aircraft_file_path – path of data file
name – name to give to the trace added to the figure
fig – existing figure to which add the plot
file_formatter – the formatter that defines the format of data file. If not provided,
default format will be assumed. :param equilibrated: boolean stating if the polar plotted is the equilibrated one or not :return: plane polar figure.