diff --git a/doc/suave_config b/doc/suave_config index b9132fee4f..f55f38be68 100644 --- a/doc/suave_config +++ b/doc/suave_config @@ -38,7 +38,7 @@ PROJECT_NAME = SUAVE # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 2.5.0 +PROJECT_NUMBER = 2.5.2 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a diff --git a/trunk/SUAVE/Components/Airfoils/Airfoil.py b/trunk/SUAVE/Components/Airfoils/Airfoil.py index a12813e5ef..a411c643c1 100644 --- a/trunk/SUAVE/Components/Airfoils/Airfoil.py +++ b/trunk/SUAVE/Components/Airfoils/Airfoil.py @@ -17,7 +17,7 @@ # Airfoil # ------------------------------------------------------------ -## @ingroup Components-Wings-Airfoils +## @ingroup Components-Airfoils class Airfoil(Lofted_Body.Section): def __defaults__(self): """This sets the default values of a airfoil defined in SUAVE. diff --git a/trunk/SUAVE/Components/Airfoils/__init__.py b/trunk/SUAVE/Components/Airfoils/__init__.py index 64224430e9..04fa64e6c1 100644 --- a/trunk/SUAVE/Components/Airfoils/__init__.py +++ b/trunk/SUAVE/Components/Airfoils/__init__.py @@ -1,5 +1,6 @@ ## @defgroup Components-Airfoils Airfoils # @ingroup Components +## @defgroup Components # # __init__.py # diff --git a/trunk/SUAVE/Components/Energy/Charging/__init__.py b/trunk/SUAVE/Components/Energy/Charging/__init__.py index 2b47f8f1b5..9534feab72 100644 --- a/trunk/SUAVE/Components/Energy/Charging/__init__.py +++ b/trunk/SUAVE/Components/Energy/Charging/__init__.py @@ -1,4 +1,6 @@ ## @defgroup Components-Energy-Charging Charging +## @ingroup Components-Energy + # __init__.py # # Created: Nov 2019, M. Clarke diff --git a/trunk/SUAVE/Components/Landing_Gear/__init__.py b/trunk/SUAVE/Components/Landing_Gear/__init__.py index b7ebc53ac8..51f4cd19c4 100644 --- a/trunk/SUAVE/Components/Landing_Gear/__init__.py +++ b/trunk/SUAVE/Components/Landing_Gear/__init__.py @@ -1,4 +1,4 @@ -## @defgroup components-landing_gear Landing Gear +## @defgroup Components-Landing_Gear Landing Gear # Components considered are the Main and Nose Landing Gear ## @ingroup Components diff --git a/trunk/SUAVE/Components/Lofted_Body_Segment/Segment.py b/trunk/SUAVE/Components/Lofted_Body_Segment/Segment.py index f03e3bddcf..b5bb823dca 100644 --- a/trunk/SUAVE/Components/Lofted_Body_Segment/Segment.py +++ b/trunk/SUAVE/Components/Lofted_Body_Segment/Segment.py @@ -19,7 +19,7 @@ # Fuselage Segments # ------------------------------------------------------------ -## @ingroup Components-Fuselages +## @ingroup Components-Lofted_Body_Segment class Segment(Lofted_Body.Segment): def __defaults__(self): """This sets the defaults for fuselage segments in SUAVE. @@ -51,7 +51,7 @@ def __defaults__(self): self.vsp_data.xsec_id = '' # OpenVSP XSec ID such as 'MWLKSGTGDD' self.vsp_data.shape = '' -## @ingroup Components-Wings +## @ingroup Components-Lofted_Body_Segment class Segment_Container(Lofted_Body.Segment.Container): """ Container for wing segment diff --git a/trunk/SUAVE/Components/Lofted_Body_Segment/__init__.py b/trunk/SUAVE/Components/Lofted_Body_Segment/__init__.py index 9938d7f7c4..8dd16ea0a1 100644 --- a/trunk/SUAVE/Components/Lofted_Body_Segment/__init__.py +++ b/trunk/SUAVE/Components/Lofted_Body_Segment/__init__.py @@ -1,4 +1,4 @@ -## @defgroup components-Lofted_Body_Segment +## @defgroup components-Lofted_Body_Segment Lofted_Body_Segment # Components traditionally considered to be the fuselage of a vehicle. # These typically contain the primary payload of the vehicle. ## @ingroup Components diff --git a/trunk/SUAVE/Components/Nacelles/Nacelle.py b/trunk/SUAVE/Components/Nacelles/Nacelle.py index dd15a1773f..85ecdc0269 100644 --- a/trunk/SUAVE/Components/Nacelles/Nacelle.py +++ b/trunk/SUAVE/Components/Nacelles/Nacelle.py @@ -1,4 +1,4 @@ -## @defgroup Components-Energy-Nacelles Nacelles +## @defgroup Components-Nacelles # Nacelle.py # # Created: Jul 2021, M. Clarke @@ -16,7 +16,7 @@ # Nacalle # ------------------------------------------------------------ -## @ingroup components-nacelles +## @ingroup Components-Nacelles class Nacelle(Lofted_Body): """ This is a nacelle for a generic aircraft. diff --git a/trunk/SUAVE/Methods/Aerodynamics/Common/Gas_Dynamics/Oblique_Shock.py b/trunk/SUAVE/Methods/Aerodynamics/Common/Gas_Dynamics/Oblique_Shock.py index 916bf6efff..8fadad3719 100644 --- a/trunk/SUAVE/Methods/Aerodynamics/Common/Gas_Dynamics/Oblique_Shock.py +++ b/trunk/SUAVE/Methods/Aerodynamics/Common/Gas_Dynamics/Oblique_Shock.py @@ -57,6 +57,7 @@ def oblique_shock_relations(M0,gamma,theta,beta): return M1,Pr,Tr,Ptr +## @ingroup Methods-Aerodynamics-Common-Gas_Dynamics def theta_beta_mach(M0,gamma,theta,n=0): """Computes shock angle of an oblique shock diff --git a/trunk/SUAVE/Methods/Aerodynamics/Common/Gas_Dynamics/__init__.py b/trunk/SUAVE/Methods/Aerodynamics/Common/Gas_Dynamics/__init__.py index 5d76fa0189..083ae880d5 100644 --- a/trunk/SUAVE/Methods/Aerodynamics/Common/Gas_Dynamics/__init__.py +++ b/trunk/SUAVE/Methods/Aerodynamics/Common/Gas_Dynamics/__init__.py @@ -1,5 +1,5 @@ ## @defgroup Methods-Aerodynamics-Common-Gas_Dynamics Gas_Dymamics # Gas Dynamics methods that are directly specified by analyses. -# @ingroup Methods-Aerodynamics-Common-Gas_Dynamics +# @ingroup Methods-Aerodynamics from .Oblique_Shock import oblique_shock_relations, theta_beta_mach \ No newline at end of file diff --git a/trunk/SUAVE/Methods/Noise/Certification/__init__.py b/trunk/SUAVE/Methods/Noise/Certification/__init__.py index bf5d9d7420..20af82b7f3 100644 --- a/trunk/SUAVE/Methods/Noise/Certification/__init__.py +++ b/trunk/SUAVE/Methods/Noise/Certification/__init__.py @@ -1,5 +1,5 @@ -## @defgroup Methods-Noise-Correlation Correlation -# @ingroup Methods-Noise-Correlation +## @defgroup Methods-Noise-Certification Certification +# @ingroup Methods-Noise from .approach_noise import approach_noise from .flyover_noise import flyover_noise diff --git a/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_One/__init__.py b/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_One/__init__.py index 0f7a9acfb7..5fcda87229 100644 --- a/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_One/__init__.py +++ b/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_One/__init__.py @@ -1,5 +1,6 @@ -## @defgroup Methods-Propulsion-Rotor_Wake-Fidelity_One +## @defgroup Methods-Propulsion-Rotor_Wake-Fidelity_One Fidelity_One # Rotor wake methods that are directly specified by analyses. +# @ingroup Methods-Propulsion-Rotor_Wake from .compute_fidelity_one_inflow_velocities import compute_fidelity_one_inflow_velocities from .compute_wake_induced_velocity import compute_wake_induced_velocity \ No newline at end of file diff --git a/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_One/compute_wake_induced_velocity.py b/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_One/compute_wake_induced_velocity.py index 6026bcef76..5dcb29660c 100644 --- a/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_One/compute_wake_induced_velocity.py +++ b/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_One/compute_wake_induced_velocity.py @@ -1,4 +1,4 @@ -## @ingroup Methods-Aerodynamics-Common-Fidelity_Zero-Lift +## @ingroup Methods-Propulsion-Rotor_Wake-Fidelity_One # compute_wake_induced_velocity.py # # Created: Sep 2020, M. Clarke @@ -11,7 +11,7 @@ # package imports import numpy as np -## @ingroup Methods-Aerodynamics-Common-Fidelity_Zero-Lift +## @ingroup Methods-Propulsion-Rotor_Wake-Fidelity_One def compute_wake_induced_velocity(WD,VD,cpts,azi_start_idx=0,sigma=0.11,suppress_root=False): """ This computes the velocity induced by the Fidelity One semi-prescribed vortex wake (PVW) on lifting surface control points @@ -88,7 +88,7 @@ def compute_wake_induced_velocity(WD,VD,cpts,azi_start_idx=0,sigma=0.11,suppress # ------------------------------------------------------------------------------- # vortex strength computation # ------------------------------------------------------------------------------- -## @ingroup Methods-Aerodynamics-Common-Fidelity_Zero-Lift +## @ingroup Methods-Propulsion-Rotor_Wake-Fidelity_One def vortex(X,Y,Z,X1,Y1,Z1,X2,Y2,Z2,sigma, GAMMA = 1, bv=False,WD=None,use_regularization_kernal=True): """ This computes the velocity induced on a control point by a segment of a horseshoe vortex that points from point 1 to point 2 for a filament with @@ -161,7 +161,7 @@ def row_reduction_summation(A): return sum_res -## @ingroup Methods-Aerodynamics-Common-Fidelity_Zero-Lift +## @ingroup Methods-Propulsion-Rotor_Wake-Fidelity_One def regularization_kernel(COEF_in, sigma): """ Regularization kernel used to prevent singularities diff --git a/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_Zero/__init__.py b/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_Zero/__init__.py index 884bd3ab90..5683d8833a 100644 --- a/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_Zero/__init__.py +++ b/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_Zero/__init__.py @@ -1,5 +1,6 @@ -## @defgroup Methods-Aerodynamics-Rotor_Wake-Fidelity_Zero +## @defgroup Methods-Propulsion-Rotor_Wake-Fidelity_Zero Fidelity_Zero # Rotor wake methods that are directly specified by analyses. +# @ingroup Methods-Propulsion-Rotor_Wake from .compute_fidelity_zero_induced_velocity import compute_fidelity_zero_induced_velocity from .compute_wake_contraction_matrix import compute_wake_contraction_matrix \ No newline at end of file diff --git a/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_Zero/compute_fidelity_zero_induced_velocity.py b/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_Zero/compute_fidelity_zero_induced_velocity.py index 5efa98c244..429594d036 100644 --- a/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_Zero/compute_fidelity_zero_induced_velocity.py +++ b/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_Zero/compute_fidelity_zero_induced_velocity.py @@ -1,4 +1,4 @@ -## @ingroup Methods-Aerodynamics-Common-Fidelity_Zero-Lift +## @defgroup Methods-Propulsion-Rotor_Wake-Fidelity_Zero # compute_fidelity_zero_induced_velocity.py # # Created: Jun 2021, R. Erhard @@ -11,7 +11,7 @@ import numpy as np from scipy.interpolate import interp1d -## @ingroup Methods-Aerodynamics-Common-Fidelity_Zero-Lift +## @defgroup Methods-Propulsion-Rotor_Wake-Fidelity_Zero def compute_fidelity_zero_induced_velocity(evaluation_points, props, ctrl_pts, identical_flag=False): """ This computes the velocity induced by the fidelity zero wake on specified evaluation points. diff --git a/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_Zero/compute_wake_contraction_matrix.py b/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_Zero/compute_wake_contraction_matrix.py index 86e8741ad7..df3c0f88db 100644 --- a/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_Zero/compute_wake_contraction_matrix.py +++ b/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_Zero/compute_wake_contraction_matrix.py @@ -1,4 +1,4 @@ -## @ingroup Methods-Aerodynamics-Common-Fidelity_Zero-Lift +## @defgroup Methods-Propulsion-Rotor_Wake-Fidelity_Zero # compute_wake_contraction_matrix.py # # Created: Sep 2020, M. Clarke @@ -11,7 +11,7 @@ # package imports import numpy as np -## @ingroup Methods-Aerodynamics-Common-Fidelity_Zero-Lift +## @defgroup Methods-Propulsion-Rotor_Wake-Fidelity_Zero def compute_wake_contraction_matrix(prop,Nr,m,nts,X_pts,prop_outputs): """ This computes slipstream development factor for all points along slipstream diff --git a/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_Zero/fidelity_zero_wake_convergence.py b/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_Zero/fidelity_zero_wake_convergence.py index 6eba73798b..9bde2d5610 100644 --- a/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_Zero/fidelity_zero_wake_convergence.py +++ b/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/Fidelity_Zero/fidelity_zero_wake_convergence.py @@ -1,4 +1,4 @@ -## @ingroup Methods-Propulsion-Rotor_Wake-Fidelity_Zero +## @defgroup Methods-Propulsion-Rotor_Wake-Fidelity_Zero # fidelity_zero_wake_convergence.py # # Created: Feb 2022, R. Erhard @@ -8,7 +8,7 @@ import numpy as np import copy -## @ingroup Methods-Propulsion-Rotor_Wake-Fidelity_Zero +## @defgroup Methods-Propulsion-Rotor_Wake-Fidelity_Zero def fidelity_zero_wake_convergence(wake,rotor,wake_inputs): """ Wake evaluation is performed using a simplified vortex wake method for Fidelity Zero, @@ -119,7 +119,7 @@ def fidelity_zero_wake_convergence(wake,rotor,wake_inputs): return va, vt -## @ingroup Methods-Propulsion-Rotor_Wake-Fidelity_Zero +## @defgroup Methods-Propulsion-Rotor_Wake-Fidelity_Zero def compute_dR_dpsi(B,beta,r,R,Wt,Wa,U,Ut,Ua,cos_psi,sin_psi,piece): """ Computes the analytical derivative for the BEVW iteration. diff --git a/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/__init__.py b/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/__init__.py index d72104a03a..16292a4749 100644 --- a/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/__init__.py +++ b/trunk/SUAVE/Methods/Propulsion/Rotor_Wake/__init__.py @@ -1,8 +1,10 @@ -## @defgroup Methods-Propulsion-Rotor_Wake +## @defgroup Methods-Propulsion-Rotor_Wake Rotor_Wake # Rotor_Wake provides the functions needed to perform analyses. +# @ingroup Methods-Propulsion -from . import Fidelity_Zero from . import Fidelity_One +from . import Fidelity_Zero + diff --git a/trunk/SUAVE/Methods/Propulsion/__init__.py b/trunk/SUAVE/Methods/Propulsion/__init__.py index fec3a87785..ea8b767ebe 100644 --- a/trunk/SUAVE/Methods/Propulsion/__init__.py +++ b/trunk/SUAVE/Methods/Propulsion/__init__.py @@ -1,6 +1,7 @@ ## @defgroup Methods-Propulsion Propulsion # Description # @ingroup Methods + from . import Rotor_Wake from .ducted_fan_sizing import ducted_fan_sizing from .propeller_design import propeller_design diff --git a/trunk/SUAVE/Methods/Weights/Buildups/eVTOL/__init__.py b/trunk/SUAVE/Methods/Weights/Buildups/eVTOL/__init__.py index 049fec0849..dd45a90723 100644 --- a/trunk/SUAVE/Methods/Weights/Buildups/eVTOL/__init__.py +++ b/trunk/SUAVE/Methods/Weights/Buildups/eVTOL/__init__.py @@ -1,4 +1,6 @@ ## @defgroup Methods-Weights-Buildups-EVTOL EVTOL +# The empty method that is called by the analysis +# @ingroup Methods-Weights-Buildups """SUAVE.Methods.Weights.Buildups.EVTOL contains methods and attributes used for estimating diff --git a/trunk/SUAVE/Plots/Geometry/__init__.py b/trunk/SUAVE/Plots/Geometry/__init__.py index 8e77987e8a..36fcfc266b 100644 --- a/trunk/SUAVE/Plots/Geometry/__init__.py +++ b/trunk/SUAVE/Plots/Geometry/__init__.py @@ -1,6 +1,6 @@ ## @defgroup Plots-Geometry Geometry # Description -# @ingroup Plots-Geometry +# @ingroup Plots from .plot_airfoil import plot_airfoil from .plot_propeller import plot_propeller diff --git a/trunk/SUAVE/Plots/Performance/Mission_Plots.py b/trunk/SUAVE/Plots/Performance/Mission_Plots.py index b9d61afbd0..56e2bc46e4 100644 --- a/trunk/SUAVE/Plots/Performance/Mission_Plots.py +++ b/trunk/SUAVE/Plots/Performance/Mission_Plots.py @@ -1,4 +1,4 @@ -## @ingroup Plots +## @defgroup Plots-Performance # Mission_Plots.py # # Created: Mar 2020, M. Clarke @@ -20,7 +20,7 @@ # ------------------------------------------------------------------ # Altitude, SFC & Weight # ------------------------------------------------------------------ -## @ingroup Plots +## @defgroup Plots-Performance def plot_altitude_sfc_weight(results, line_color = 'bo-', save_figure = False, save_filename = "Altitude_SFC_Weight" , file_type = ".png"): """This plots the altitude, speficic fuel comsumption and vehicle weight @@ -79,7 +79,7 @@ def plot_altitude_sfc_weight(results, line_color = 'bo-', save_figure = False, s # ------------------------------------------------------------------ # Aircraft Velocities # ------------------------------------------------------------------ -## @ingroup Plots +## @defgroup Plots-Performance def plot_aircraft_velocities(results, line_color = 'bo-', save_figure = False, save_filename = "Aircraft_Velocities", file_type = ".png"): """This plots aircraft velocity, mach , true air speed @@ -136,7 +136,7 @@ def plot_aircraft_velocities(results, line_color = 'bo-', save_figure = False, s # ------------------------------------------------------------------ # Disc and Power Loadings # ------------------------------------------------------------------ -## @ingroup Plots +## @defgroup Plots-Performance def plot_disc_power_loading(results, line_color = 'bo-', save_figure = False, save_filename = "Disc_Power_Loading", file_type = ".png"): """This plots the propeller disc and power loadings @@ -186,7 +186,7 @@ def plot_disc_power_loading(results, line_color = 'bo-', save_figure = False, sa # ------------------------------------------------------------------ # Plot Fuel Use # ------------------------------------------------------------------ - +## @defgroup Plots-Performance def plot_fuel_use(results, line_color = 'bo-', save_figure = False, save_filename = "Aircraft_Fuel_Burnt", file_type = ".png"): """This plots aircraft fuel usage Assumptions: @@ -273,7 +273,7 @@ def plot_fuel_use(results, line_color = 'bo-', save_figure = False, save_filenam # ------------------------------------------------------------------ # Aerodynamic Coefficients # ------------------------------------------------------------------ -## @ingroup Plots +## @defgroup Plots-Performance def plot_aerodynamic_coefficients(results, line_color = 'bo-', save_figure = False, save_filename = "Aerodynamic_Coefficients", file_type = ".png"): """This plots the aerodynamic coefficients @@ -337,7 +337,7 @@ def plot_aerodynamic_coefficients(results, line_color = 'bo-', save_figure = Fal # ------------------------------------------------------------------ # Aerodynamic Forces # ------------------------------------------------------------------ -## @ingroup Plots +## @defgroup Plots-Performance def plot_aerodynamic_forces(results, line_color = 'bo-', save_figure = False, save_filename = "Aerodynamic_Forces", file_type = ".png"): """This plots the aerodynamic forces @@ -401,7 +401,7 @@ def plot_aerodynamic_forces(results, line_color = 'bo-', save_figure = False, sa # ------------------------------------------------------------------ # Drag Components # ------------------------------------------------------------------ -## @ingroup Plots +## @defgroup Plots-Performance def plot_drag_components(results, line_color = 'bo-', save_figure = False, save_filename = "Drag_Components", file_type = ".png"): """This plots the drag components of the aircraft @@ -466,7 +466,7 @@ def plot_drag_components(results, line_color = 'bo-', save_figure = False, save_ # ------------------------------------------------------------------ # Electronic Conditions # ------------------------------------------------------------------ -## @ingroup Plots +## @defgroup Plots-Performance def plot_battery_pack_conditions(results, line_color = 'bo-', line_color2 = 'rs--', save_figure = False, save_filename = "Battery_Pack_Conditions", file_type = ".png"): """This plots the battery pack conditions of the network @@ -574,7 +574,7 @@ def plot_battery_pack_conditions(results, line_color = 'bo-', line_color2 = 'rs- # ------------------------------------------------------------------ # Electronic Conditions # ------------------------------------------------------------------ -## @ingroup Plots +## @defgroup Plots-Performance def plot_battery_cell_conditions(results, line_color = 'bo-',line_color2 = 'rs--', save_figure = False, save_filename = "Battery_Cell_Conditions", file_type = ".png"): """This plots the battery pack conditions of the network @@ -699,7 +699,7 @@ def plot_battery_cell_conditions(results, line_color = 'bo-',line_color2 = 'rs-- # ------------------------------------------------------------------ # Battery Degradation # ------------------------------------------------------------------ -## @ingroup Plots +## @defgroup Plots-Performance def plot_battery_degradation(results, line_color = 'bo-',line_color2 = 'rs--', save_figure = False, save_filename = "Battery_Cell_Conditions", file_type = ".png"): """This plots the battery cell degradation @@ -774,7 +774,7 @@ def plot_battery_degradation(results, line_color = 'bo-',line_color2 = 'rs--', s # ------------------------------------------------------------------ # Flight Conditions # ------------------------------------------------------------------ -## @ingroup Plots +## @defgroup Plots-Performance def plot_flight_conditions(results, line_color = 'bo-', save_figure = False, save_filename = "Flight_Conditions", file_type = ".png"): """This plots the flights the conditions @@ -843,7 +843,7 @@ def plot_flight_conditions(results, line_color = 'bo-', save_figure = False, sav # ------------------------------------------------------------------ # Aircraft Trajectory # ------------------------------------------------------------------ -## @ingroup Plots +## @defgroup Plots-Performance def plot_flight_trajectory(results, line_color = 'bo-', line_color2 = 'rs--', save_figure = False, save_filename = "Flight_Trajectory", file_type = ".png"): """This plots the 3D flight trajectory of the aircraft. @@ -914,7 +914,7 @@ def plot_flight_trajectory(results, line_color = 'bo-', line_color2 = 'rs--', sa # ------------------------------------------------------------------ # Propulsion Conditions # ------------------------------------------------------------------ -## @ingroup Plots +## @defgroup Plots-Performance def plot_propeller_conditions(results, line_color = 'bo-', save_figure = False, save_filename = "Propeller", file_type = ".png"): """This plots the propeller performance @@ -1005,7 +1005,7 @@ def plot_propeller_conditions(results, line_color = 'bo-', save_figure = False, # ------------------------------------------------------------------ # Electric Propulsion efficiencies # ------------------------------------------------------------------ -## @ingroup Plots +## @defgroup Plots-Performance def plot_eMotor_Prop_efficiencies(results, line_color = 'bo-', save_figure = False, save_filename = "eMotor_Prop_Propulsor", file_type = ".png"): """This plots the electric driven network propeller efficiencies @@ -1123,7 +1123,7 @@ def plot_stability_coefficients(results, line_color = 'bo-', save_figure = False # ------------------------------------------------------------------ # Solar Flux # ------------------------------------------------------------------ -## @ingroup Plots +## @defgroup Plots-Performance def plot_solar_flux(results, line_color = 'bo-', save_figure = False, save_filename = "Solar_Flux", file_type = ".png"): """This plots the solar flux and power train performance of an solar powered aircraft @@ -1181,7 +1181,7 @@ def plot_solar_flux(results, line_color = 'bo-', save_figure = False, save_filen # ------------------------------------------------------------------ # Lift-Cruise Network # ------------------------------------------------------------------ -## @ingroup Plots +## @defgroup Plots-Performance def plot_lift_cruise_network(results, line_color = 'bo-',line_color2 = 'r^-', save_figure = False, save_filename = "Lift_Cruise_Network", file_type = ".png"): """This plots the electronic and propulsor performance of a vehicle with a lift cruise network @@ -1478,6 +1478,7 @@ def plot_lift_cruise_network(results, line_color = 'bo-',line_color2 = 'r^-', sa # ------------------------------------------------------------------ # Pressure Coefficient # ------------------------------------------------------------------ +## @defgroup Plots-Performance def plot_surface_pressure_contours(results,vehicle, save_figure = False, save_filename = "Surface_Pressure", file_type = ".png"): """This plots the surface pressure distrubtion at all control points on all lifting surfaces of the aircraft @@ -1570,6 +1571,7 @@ def plot_surface_pressure_contours(results,vehicle, save_figure = False, save_fi # ------------------------------------------------------------------ # Sectional Lift Distribution # ------------------------------------------------------------------ +## @defgroup Plots-Performance def plot_lift_distribution(results,vehicle, save_figure = False, save_filename = "Sectional_Lift", file_type = ".png"): """This plots the sectional lift distrubtion at all control points on all lifting surfaces of the aircraft @@ -1625,6 +1627,7 @@ def plot_lift_distribution(results,vehicle, save_figure = False, save_filename = # ------------------------------------------------------------------ # VLM Video # ------------------------------------------------------------------ +## @defgroup Plots-Performance def create_video_frames(results,vehicle, save_figure = True ,flight_profile = True, save_filename = "Flight_Mission_Frame", file_type = ".png"): """This creates video frames of the aerodynamic conditions of the vehicle as well as the surface pressure coefficient throughout a mission @@ -1796,6 +1799,7 @@ def create_video_frames(results,vehicle, save_figure = True ,flight_profile = Tr # ------------------------------------------------------------------ # Rotor/Propeller Acoustics # ------------------------------------------------------------------ +## @defgroup Plots-Performance def plot_ground_noise_levels(results, line_color = 'bo-', save_figure = False, save_filename = "Sideline Noise Levels"): """This plots the A-weighted Sound Pressure Level as a function of time at various aximuthal angles on the ground @@ -1858,7 +1862,7 @@ def plot_ground_noise_levels(results, line_color = 'bo-', save_figure = False, s return - +## @defgroup Plots-Performance def plot_flight_profile_noise_contours(results, line_color = 'bo-', save_figure = False, save_filename = "Noise_Contour",show_figure = True): """This plots two contour surface of the maximum A-weighted Sound Pressure Level in the defined computational domain. The first contour is the that of radiated noise on level ground only while the second contains radiated noise on buildings @@ -2064,7 +2068,7 @@ def colorax(vmin, vmax): # ------------------------------------------------------------------ # Set Axis Parameters # ------------------------------------------------------------------ -## @ingroup Plots +## @defgroup Plots-Performance def set_axes(axes): """This sets the axis parameters for all plots diff --git a/trunk/SUAVE/Plots/Performance/Propeller_Plots.py b/trunk/SUAVE/Plots/Performance/Propeller_Plots.py index b9a44d695a..e3b8bf3fc3 100644 --- a/trunk/SUAVE/Plots/Performance/Propeller_Plots.py +++ b/trunk/SUAVE/Plots/Performance/Propeller_Plots.py @@ -1,4 +1,4 @@ -## @ingroup Plots +## @defgroup Plots-Performance # Propeller_Plots.py # # Created: Mar 2021, R. Erhard @@ -13,7 +13,7 @@ import pylab as plt import numpy as np -## @ingroup Plots +## @defgroup Plots-Performance def plot_propeller_disc_inflow(prop,velocities, grid_points): u = velocities.u_velocities @@ -107,6 +107,7 @@ def plot_propeller_disc_inflow(prop,velocities, grid_points): return +## @defgroup Plots-Performance def plot_propeller_disc_performance(prop,outputs,i=0,title=None): """ Inputs diff --git a/trunk/SUAVE/Plots/Performance/__init__.py b/trunk/SUAVE/Plots/Performance/__init__.py index 6501ea7a05..89804dc1b0 100644 --- a/trunk/SUAVE/Plots/Performance/__init__.py +++ b/trunk/SUAVE/Plots/Performance/__init__.py @@ -1,5 +1,6 @@ -## @defgroup Plots +## @defgroup Plots-Performance Performance # Plots contains functions for generating common figures +# @ingroup Plots from .Mission_Plots import plot_flight_conditions from .Mission_Plots import plot_aerodynamic_coefficients