CADDEE_alpha
latest
Getting started
Background
Theory and Concepts
Examples
1. Basic examples
Building a component hierarchy
2. Intermediate example
Induced drag minimization example
Handling qualities optimization example
Aeroacoustic Optimization
3. Advanced examples
Tutorials
1. Basic tutorials
Built-in meshing functions
Running VLM analysis in CADDEE
2. Advanced tutorials
API reference
Configuration
Component
Condition
CADDEE_alpha
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
X
_
__getattr__() (component.VectorizedAttributes method)
(component.VectorizedComponent method)
(mesh.mesh.VectorizedDiscretization method)
__getitem__() (caddee.ConditionsDict method)
(component.ComponentDict method)
(mesh.mesh.DiscretizationsDict method)
(mesh.mesh.MeshContainer method)
(mesh.meshers.CamberSurfaceDict method)
(mesh.meshers.OneDBoxBeamDict method)
(mesh.meshers.RotorDiscretizationDict method)
__post_init__() (mesh.mesh.Discretization method)
__setattr__() (component.VectorizedAttributes method)
__setitem__() (component.ComponentDict method)
(mesh.mesh.DiscretizationsDict method)
(mesh.meshers.CamberSurfaceDict method)
_add_geometry() (aircraft.components.wing.Wing method)
_aft_points_parametric (mesh.meshers.OneDBoxBeam attribute)
_airfoil_lower_para (mesh.meshers.CamberSurface attribute)
_airfoil_upper_para (mesh.meshers.CamberSurface attribute)
_bottom_grid_parametric (mesh.meshers.OneDBoxBeam attribute)
_check_shape_consistency() (aircraft.conditions.aircraft_condition.AircraftCondition method)
_chordwise_spacing (mesh.meshers.CamberSurface attribute)
_compute_surface_area() (component.Component method)
_constant_b_spline_1_dof_space (component.Component attribute)
_cubic_b_spline_5_dof_space (component.Component attribute)
_disk_parametric (mesh.meshers.RotorDiscretization attribute)
_expand_variables() (aircraft.conditions.aircraft_condition.AircraftCondition method)
_extract_geometric_quantities_from_ffd_block() (aircraft.components.fuselage.Fuselage method)
(aircraft.components.rotor.Rotor method)
(aircraft.components.wing.Wing method)
(component.Component method)
_find_system_component() (component.Component method)
_fit_surface() (aircraft.components.wing.Wing method)
_fore_points_parametric (mesh.meshers.OneDBoxBeam attribute)
_front_grid_parametric (mesh.meshers.OneDBoxBeam attribute)
_front_spar_geom (mesh.meshers.OneDBoxBeam attribute)
_geom (mesh.meshers.CamberSurface attribute)
(mesh.meshers.OneDBoxBeam attribute)
(mesh.meshers.RotorDiscretization attribute)
_half_wing (mesh.meshers.OneDBoxBeam attribute)
_has_been_expanded (mesh.mesh.Discretization attribute)
_instance_count (component.Component attribute)
_is_broadcastable() (aircraft.conditions.aircraft_condition.AircraftCondition method)
_is_copy (component.Component attribute)
_is_vector() (aircraft.conditions.aircraft_condition.AircraftCondition method)
_LE_points_para (mesh.meshers.CamberSurface attribute)
_LE_points_parametric (mesh.meshers.OneDBoxBeam attribute)
_linear_b_spline_2_dof_space (component.Component attribute)
_linear_b_spline_3_dof_space (component.Component attribute)
_lower_wireframe_para (mesh.meshers.CamberSurface attribute)
_make_ffd_block() (aircraft.components.wing.Wing method)
(component.Component method)
_material_properties (mesh.meshers.OneDBoxBeam attribute)
_node_bottom_parametric (mesh.meshers.OneDBoxBeam attribute)
_node_top_parametric (mesh.meshers.OneDBoxBeam attribute)
_norm_beam_width (mesh.meshers.OneDBoxBeam attribute)
_norm_node_center (mesh.meshers.OneDBoxBeam attribute)
_num_chord_wise (mesh.meshers.CamberSurface attribute)
_num_spanwise (mesh.meshers.CamberSurface attribute)
_p1 (mesh.meshers.RotorDiscretization attribute)
_p2 (mesh.meshers.RotorDiscretization attribute)
_p3 (mesh.meshers.RotorDiscretization attribute)
_p4 (mesh.meshers.RotorDiscretization attribute)
_quadratic_b_spline_3_dof_space (component.Component attribute)
_rear_grid_parametric (mesh.meshers.OneDBoxBeam attribute)
_rear_spar_geom (mesh.meshers.OneDBoxBeam attribute)
_setup_condition() (aircraft.conditions.aircraft_condition.ClimbCondition method)
(aircraft.conditions.aircraft_condition.CruiseCondition method)
(aircraft.conditions.aircraft_condition.HoverCondition method)
_setup_ffd_block() (aircraft.components.fuselage.Fuselage method)
(aircraft.components.rotor.Rotor method)
(aircraft.components.wing.Wing method)
(component.Component method)
_setup_ffd_parameterization() (aircraft.components.fuselage.Fuselage method)
(aircraft.components.rotor.Rotor method)
(aircraft.components.wing.Wing method)
(component.Component method)
_setup_geometry() (aircraft.components.fuselage.Fuselage method)
(aircraft.components.rotor.Rotor method)
(aircraft.components.wing.Wing method)
(component.Component method)
_skip_ffd (component.Component attribute)
_spar_geom (mesh.meshers.OneDBoxBeam attribute)
_TE_points_para (mesh.meshers.CamberSurface attribute)
_TE_points_parametric (mesh.meshers.OneDBoxBeam attribute)
_top_grid_parametric (mesh.meshers.OneDBoxBeam attribute)
_update() (mesh.meshers.CamberSurface method)
(mesh.meshers.OneDBoxBeam method)
(mesh.meshers.RotorDiscretization method)
(mesh.meshers.ShellDiscretization method)
_upper_wireframe_para (mesh.meshers.CamberSurface attribute)
A
ac_states (aircraft.conditions.aircraft_condition.ACQuantities attribute)
(aircraft.models.aerodynamics.simple_lift_model.SimpleLiftModelInputs attribute)
accel_norm (aircraft.models.equations_of_motion.six_dof_euler_flat_earth.LinAngAccel attribute)
ACQuantities (class in aircraft.conditions.aircraft_condition)
actuate() (aircraft.components.rotor.Rotor method)
(aircraft.components.wing.Wing method)
(component.Component method)
aircraft
module
Aircraft (class in aircraft.components.aircraft)
aircraft.components
module
aircraft.components.aircraft
module
aircraft.components.fuselage
module
aircraft.components.powertrain
module
aircraft.components.rotor
module
aircraft.components.wing
module
aircraft.conditions
module
aircraft.conditions.aircraft_condition
module
aircraft.models
module
aircraft.models.aerodynamics
module
aircraft.models.aerodynamics.drag_buildup
module
aircraft.models.aerodynamics.simple_lift_model
module
aircraft.models.atmosphere
module
aircraft.models.atmosphere.simple_atmosphere_model
module
aircraft.models.equations_of_motion
module
aircraft.models.equations_of_motion.six_dof_euler_flat_earth
module
aircraft.models.weights
module
aircraft.models.weights.general_aviation
module
aircraft.models.weights.general_aviation.general_aviation_weights
module
aircraft.models.weights.nasa_lpc
module
aircraft.models.weights.nasa_lpc.m4_nasa_lpc
module
aircraft.models.weights.weights_solver
module
AircraftCondition (class in aircraft.conditions.aircraft_condition)
alpha_ML_mid_panel (mesh.meshers.CamberSurface attribute)
altitude (aircraft.conditions.aircraft_condition.CruiseParameters attribute)
(aircraft.conditions.aircraft_condition.HoverParameters attribute)
AR (aircraft.components.wing.WingParameters attribute)
(aircraft.models.aerodynamics.simple_lift_model.SimpleLiftModelInputs attribute)
assemble_forces_and_moments() (aircraft.conditions.aircraft_condition.AircraftCondition method)
(condition.Condition method)
assemble_meshes() (configuration.Configuration method)
assemble_system_mass_properties() (configuration.Configuration method)
(configuration.VectorizedConfig method)
atmos_state (aircraft.models.aerodynamics.simple_lift_model.SimpleLiftModelInputs attribute)
atmos_states (aircraft.conditions.aircraft_condition.ACQuantities attribute)
B
base_configuration (caddee.CADDEE property)
battery
module
beam_height (mesh.meshers.OneDBoxBeam attribute)
beam_width (mesh.meshers.OneDBoxBeam attribute)
BeamMesh (class in mesh.meshers)
bottom_skin_thickness (mesh.meshers.OneDBoxBeam attribute)
C
caddee
module
CADDEE (class in caddee)
CamberSurface (class in mesh.meshers)
CamberSurfaceDict (class in mesh.meshers)
center_chord (aircraft.components.wing.WingGeometricQuantities attribute)
chord_profile (mesh.meshers.RotorDiscretization attribute)
Cl_0 (aircraft.models.aerodynamics.simple_lift_model.SimpleLiftModelInputs attribute)
Cl_alpha (aircraft.models.aerodynamics.simple_lift_model.SimpleLiftModelInputs attribute)
climb_gradient (aircraft.conditions.aircraft_condition.ClimbParameters attribute)
ClimbCondition (class in aircraft.conditions.aircraft_condition)
ClimbParameters (class in aircraft.conditions.aircraft_condition)
component
module
Component (class in component)
ComponentDict (class in component)
ComponentParameters (class in component)
ComponentQuantities (class in component)
compute() (aircraft.conditions.aircraft_condition.EigenValueOperation method)
compute_derivatives() (aircraft.conditions.aircraft_condition.EigenValueOperation method)
compute_drag_build_up() (in module aircraft.models.aerodynamics.drag_buildup)
condition
module
Condition (class in condition)
conditions (caddee.CADDEE property)
ConditionsDict (class in caddee)
configuration
module
Configuration (class in configuration)
configuration (condition.Condition property)
connect_component_geometries() (configuration.Configuration method)
connectivity (mesh.meshers.ShellDiscretization attribute)
construct_ribs_and_spars() (aircraft.components.wing.Wing method)
convert_shape_to_action_string() (in module aircraft.conditions.aircraft_condition)
copy() (configuration.Configuration method)
(mesh.mesh.Discretization method)
(mesh.mesh.SolverMesh method)
(mesh.meshers.CamberSurface method)
cosine_spacing() (in module mesh.meshers)
create_subgeometry() (component.Component method)
CruiseCondition (class in aircraft.conditions.aircraft_condition)
CruiseParameters (class in aircraft.conditions.aircraft_condition)
D
d_fuse (aircraft.models.aerodynamics.simple_lift_model.SimpleLiftModelInputs attribute)
dihedral (aircraft.components.wing.WingParameters attribute)
dihedral_angle_left (aircraft.components.wing.WingGeometricQuantities attribute)
dihedral_angle_right (aircraft.components.wing.WingGeometricQuantities attribute)
Discretization (class in mesh.mesh)
discretizations (mesh.mesh.SolverMesh attribute)
(mesh.meshers.BeamMesh attribute)
(mesh.meshers.RotorMeshes attribute)
(mesh.meshers.VLMMesh attribute)
DiscretizationsDict (class in mesh.mesh)
disk_mesh (mesh.meshers.RotorDiscretization attribute)
dp_dt (aircraft.models.equations_of_motion.six_dof_euler_flat_earth.LinAngAccel attribute)
dq_dt (aircraft.models.equations_of_motion.six_dof_euler_flat_earth.LinAngAccel attribute)
dr_dt (aircraft.models.equations_of_motion.six_dof_euler_flat_earth.LinAngAccel attribute)
drag_parameters (component.ComponentQuantities property)
du_dt (aircraft.models.equations_of_motion.six_dof_euler_flat_earth.LinAngAccel attribute)
dv_dt (aircraft.models.equations_of_motion.six_dof_euler_flat_earth.LinAngAccel attribute)
dw_dt (aircraft.models.equations_of_motion.six_dof_euler_flat_earth.LinAngAccel attribute)
E
EigenValueOperation (class in aircraft.conditions.aircraft_condition)
embedded_airfoil_model_alpha_stall (mesh.meshers.CamberSurface attribute)
embedded_airfoil_model_Cd (mesh.meshers.CamberSurface attribute)
embedded_airfoil_model_Cl (mesh.meshers.CamberSurface attribute)
embedded_airfoil_model_Cp (mesh.meshers.CamberSurface attribute)
evaluate() (aircraft.conditions.aircraft_condition.EigenValueOperation method)
(aircraft.models.aerodynamics.simple_lift_model.SimpleLiftModel method)
(aircraft.models.atmosphere.simple_atmosphere_model.SimpleAtmosphereModel method)
(aircraft.models.equations_of_motion.six_dof_euler_flat_earth.SixDofEulerFlatEarthModel method)
(aircraft.models.weights.general_aviation.general_aviation_weights.GAInstrumentsWeightModel method)
(aircraft.models.weights.weights_solver.WeightsSolverModel method)
evaluate_avionics_weight() (aircraft.models.weights.general_aviation.general_aviation_weights.GeneralAviationWeights method)
evaluate_fuselage_weight() (aircraft.models.weights.general_aviation.general_aviation_weights.GeneralAviationWeights method)
evaluate_horizontal_tail_weight() (aircraft.models.weights.general_aviation.general_aviation_weights.GeneralAviationWeights method)
evaluate_main_landing_gear_weight() (aircraft.models.weights.general_aviation.general_aviation_weights.GeneralAviationWeights method)
evaluate_vertical_tail_weight() (aircraft.models.weights.general_aviation.general_aviation_weights.GeneralAviationWeights method)
evaluate_wing_weight() (aircraft.models.weights.general_aviation.general_aviation_weights.GeneralAviationWeights method)
F
final_altitude (aircraft.conditions.aircraft_condition.ClimbParameters attribute)
finalize_meshes() (aircraft.conditions.aircraft_condition.AircraftCondition method)
(condition.Condition method)
flight_path_angle (aircraft.conditions.aircraft_condition.ClimbParameters attribute)
Fuselage (class in aircraft.components.fuselage)
FuselageGeometricQuantities (class in aircraft.components.fuselage)
FuselageParameters (class in aircraft.components.fuselage)
G
GAInstrumentsWeightInputs (class in aircraft.models.weights.general_aviation.general_aviation_weights)
GAInstrumentsWeightModel (class in aircraft.models.weights.general_aviation.general_aviation_weights)
GeneralAviationWeights (class in aircraft.models.weights.general_aviation.general_aviation_weights)
geometry (mesh.meshers.ShellDiscretization attribute)
H
height (aircraft.components.fuselage.FuselageGeometricQuantities attribute)
HoverCondition (class in aircraft.conditions.aircraft_condition)
HoverParameters (class in aircraft.conditions.aircraft_condition)
hub_radius (aircraft.components.rotor.RotorParameters attribute)
I
import_shell_mesh() (in module mesh.meshers)
incidence (aircraft.components.wing.WingParameters attribute)
inertial_forces (aircraft.conditions.aircraft_condition.ACQuantities attribute)
inertial_moments (aircraft.conditions.aircraft_condition.ACQuantities attribute)
initial_altitude (aircraft.conditions.aircraft_condition.ClimbParameters attribute)
inverter
module
L
LE_center (aircraft.components.wing.Wing property)
LE_left_tip (aircraft.components.wing.Wing property)
LE_right_tip (aircraft.components.wing.Wing property)
left_tip_chord (aircraft.components.wing.WingGeometricQuantities attribute)
length (aircraft.components.fuselage.FuselageGeometricQuantities attribute)
(aircraft.components.fuselage.FuselageParameters attribute)
LinAngAccel (class in aircraft.models.equations_of_motion.six_dof_euler_flat_earth)
M
MAC (aircraft.components.wing.WingParameters attribute)
mach_max (aircraft.models.weights.general_aviation.general_aviation_weights.GAInstrumentsWeightInputs attribute)
mach_number (aircraft.conditions.aircraft_condition.ClimbParameters attribute)
(aircraft.conditions.aircraft_condition.CruiseParameters attribute)
make_1d_box_beam() (in module mesh.meshers)
make_mesh_symmetric() (in module mesh.meshers)
make_rotor_mesh() (in module mesh.meshers)
make_vlm_surface() (in module mesh.meshers)
mass_properties (component.ComponentQuantities property)
material_properties (component.ComponentQuantities property)
max_height (aircraft.components.fuselage.FuselageParameters attribute)
max_sweep (aircraft.models.aerodynamics.simple_lift_model.SimpleLiftModelInputs attribute)
max_width (aircraft.components.fuselage.FuselageParameters attribute)
mesh
module
mesh.mesh
module
mesh.meshers
module
mesh_quality (mesh.mesh.Discretization attribute)
MeshContainer (class in mesh.mesh)
mid_panel_chord_length (mesh.meshers.CamberSurface attribute)
module
aircraft
aircraft.components
aircraft.components.aircraft
aircraft.components.fuselage
aircraft.components.powertrain
aircraft.components.rotor
aircraft.components.wing
aircraft.conditions
aircraft.conditions.aircraft_condition
aircraft.models
aircraft.models.aerodynamics
aircraft.models.aerodynamics.drag_buildup
aircraft.models.aerodynamics.simple_lift_model
aircraft.models.atmosphere
aircraft.models.atmosphere.simple_atmosphere_model
aircraft.models.equations_of_motion
aircraft.models.equations_of_motion.six_dof_euler_flat_earth
aircraft.models.weights
aircraft.models.weights.general_aviation
aircraft.models.weights.general_aviation.general_aviation_weights
aircraft.models.weights.nasa_lpc
aircraft.models.weights.nasa_lpc.m4_nasa_lpc
aircraft.models.weights.weights_solver
battery
caddee
component
condition
configuration
inverter
mesh
mesh.mesh
mesh.meshers
powertrain
N
nodal_coordinates (mesh.mesh.Discretization attribute)
nodal_velocities (mesh.mesh.Discretization attribute)
nodes_parametric (mesh.meshers.ShellDiscretization attribute)
norm_hub_radius (mesh.meshers.RotorDiscretization attribute)
num_azimuthal (mesh.meshers.RotorDiscretization attribute)
num_beam_nodes (mesh.meshers.OneDBoxBeam attribute)
num_blades (mesh.meshers.RotorDiscretization attribute)
num_flight_crew (aircraft.models.weights.general_aviation.general_aviation_weights.GAInstrumentsWeightInputs attribute)
num_fuselage_mounted_engines (aircraft.models.weights.general_aviation.general_aviation_weights.GAInstrumentsWeightInputs attribute)
num_radial (mesh.meshers.RotorDiscretization attribute)
num_wing_mounted_engines (aircraft.models.weights.general_aviation.general_aviation_weights.GAInstrumentsWeightInputs attribute)
O
OneDBoxBeam (class in mesh.meshers)
OneDBoxBeamDict (class in mesh.meshers)
P
parent (component.Component attribute)
perform_linear_stability_analysis() (aircraft.conditions.aircraft_condition.AircraftCondition method)
pitch_angle (aircraft.conditions.aircraft_condition.ClimbParameters attribute)
(aircraft.conditions.aircraft_condition.CruiseParameters attribute)
plot() (component.Component method)
powertrain
module
Powertrain (class in aircraft.components.powertrain)
project_airfoil_points() (mesh.meshers.CamberSurface method)
Q
quarter_chord (aircraft.models.aerodynamics.simple_lift_model.SimpleLiftModelInputs attribute)
R
radius (aircraft.components.rotor.RotorParameters attribute)
(mesh.meshers.RotorDiscretization attribute)
range (aircraft.conditions.aircraft_condition.CruiseParameters attribute)
rate_of_climb (aircraft.conditions.aircraft_condition.ClimbParameters attribute)
recorder (in module aircraft.conditions.aircraft_condition)
(in module aircraft.models.equations_of_motion.six_dof_euler_flat_earth)
remove_component() (configuration.Configuration method)
reynolds_number (mesh.meshers.CamberSurface attribute)
right_tip_chord (aircraft.components.wing.WingGeometricQuantities attribute)
root_twist_delta (aircraft.components.wing.WingParameters attribute)
Rotor (class in aircraft.components.rotor)
RotorDiscretization (class in mesh.meshers)
RotorDiscretizationDict (class in mesh.meshers)
RotorMeshes (class in mesh.meshers)
RotorParameters (class in aircraft.components.rotor)
S
S_fuse_planform (aircraft.models.weights.general_aviation.general_aviation_weights.GAInstrumentsWeightInputs attribute)
S_ref (aircraft.components.wing.WingParameters attribute)
(aircraft.models.aerodynamics.simple_lift_model.SimpleLiftModelInputs attribute)
S_wet (aircraft.components.fuselage.FuselageParameters attribute)
(aircraft.components.wing.WingParameters attribute)
(aircraft.models.aerodynamics.simple_lift_model.SimpleLiftModelInputs attribute)
setup_geometry() (configuration.Configuration method)
shear_web_thickness (mesh.meshers.OneDBoxBeam attribute)
ShellDiscretization (class in mesh.meshers)
ShellMesh (class in mesh.meshers)
SimpleAtmosphereModel (class in aircraft.models.atmosphere.simple_atmosphere_model)
SimpleLiftModel (class in aircraft.models.aerodynamics.simple_lift_model)
SimpleLiftModelInputs (class in aircraft.models.aerodynamics.simple_lift_model)
SixDofEulerFlatEarthModel (class in aircraft.models.equations_of_motion.six_dof_euler_flat_earth)
SolverMesh (class in mesh.mesh)
span (aircraft.components.wing.WingGeometricQuantities attribute)
(aircraft.components.wing.WingParameters attribute)
speed (aircraft.conditions.aircraft_condition.ClimbParameters attribute)
(aircraft.conditions.aircraft_condition.CruiseParameters attribute)
sweep (aircraft.components.wing.WingParameters attribute)
sweep_angle_left (aircraft.components.wing.WingGeometricQuantities attribute)
sweep_angle_right (aircraft.components.wing.WingGeometricQuantities attribute)
T
taper_ratio (aircraft.components.wing.WingParameters attribute)
TE_center (aircraft.components.wing.Wing property)
TE_left_tip (aircraft.components.wing.Wing property)
TE_right_tip (aircraft.components.wing.Wing property)
theta (in module aircraft.models.aerodynamics.simple_lift_model)
thickness_to_chord (aircraft.components.wing.WingParameters attribute)
thickness_to_chord_loc (aircraft.components.wing.WingParameters attribute)
thrust_origin (mesh.meshers.RotorDiscretization attribute)
thrust_vector (mesh.meshers.RotorDiscretization attribute)
time (aircraft.conditions.aircraft_condition.ClimbParameters attribute)
(aircraft.conditions.aircraft_condition.CruiseParameters attribute)
(aircraft.conditions.aircraft_condition.HoverParameters attribute)
tip_twist_delta (aircraft.components.wing.WingParameters attribute)
top_skin_thickness (mesh.meshers.OneDBoxBeam attribute)
twist_profile (mesh.meshers.RotorDiscretization attribute)
U
unpack_attributes() (in module component)
update() (aircraft.conditions.aircraft_condition.AircraftCondition method)
(aircraft.conditions.aircraft_condition.ClimbCondition method)
(aircraft.conditions.aircraft_condition.CruiseCondition method)
(aircraft.conditions.aircraft_condition.HoverCondition method)
V
vectorized_configuration (condition.Condition property)
vectorized_copy() (configuration.Configuration method)
VectorizedAttributes (class in component)
VectorizedComponent (class in component)
VectorizedConfig (class in configuration)
VectorizedDiscretization (class in mesh.mesh)
visualize_component_hierarchy() (configuration.Configuration method)
VLMMesh (class in mesh.meshers)
W
W_wing_est (in module aircraft.models.weights.general_aviation.general_aviation_weights)
WeightsSolverModel (class in aircraft.models.weights.weights_solver)
width (aircraft.components.fuselage.FuselageGeometricQuantities attribute)
Wing (class in aircraft.components.wing)
wing_incidence (aircraft.models.aerodynamics.simple_lift_model.SimpleLiftModelInputs attribute)
WingGeometricQuantities (class in aircraft.components.wing)
WingParameters (class in aircraft.components.wing)
X
xl (aircraft.models.weights.general_aviation.general_aviation_weights.GAInstrumentsWeightInputs attribute)
xlw (aircraft.models.weights.general_aviation.general_aviation_weights.GAInstrumentsWeightInputs attribute)