User Guide

Attributes

+ Attributes are how SUAVE provides data and information outside of + vehicle and mission parameters, but still necessary or useful for + mission simulation. Not typically modified by the end user, + attributes provide information on material properties, atmospheric + and weather conditions, and basic physical constants +

+ +

Substances

+ SUAVE's material property library includes solids like aluminum and + carbon fiber composites which are given strength, density, and other + pertinent attributes. It also has data on gases and liquids such as + water and steam, CO2, and air including thermochemical constants and + composition proportions for mixtures like air. For propellants and + fuels, SUAVE stores specific energy, and critical temperatures. +

+ +

Locations

+ Location data includes atmospheric data, like the 1976 US Standard + Atmophere, from which data on pressure, density, etc. can be queried + on an altitude basis. It also includes a data structure for + assigning attributes to specific arrival and departure airports, + though at present SUAVE does not come pre-packaged with data for + specific airports. +

- Intro Text. + SUAVE does, however, come pre-packaged with data for Earth as a + planet including its mean radius, sea level gravity and Hitchhiker's + Guide status. It also includes a generalized Planet data structure + for evaluation of vehicles mean for deployment on Mars, Venus, or + in the atmospheres of the gas giants of the solar system.

Subsection Header

Constants

- Subsection Text. + The Constant class in SUAVE inherits from the Data class and is + meant to hold data that does not change. This may be physical + constants or else data that is to be monitored for change through + the progress of a mission. SUAVE does not come with any additional + physical constants hard-coded in this section of the library.

From 075a150a8b48930bd790e3d4045a446056255666 Mon Sep 17 00:00:00 2001 From: Unknown Date: Wed, 26 Jun 2019 14:39:58 -0700 Subject: [PATCH 08/10] Components Top Level Page Plus typo fixes on attributes --- .idea/dictionaries/Jordan_Smart.xml | 7 ++ .idea/workspace.xml | 71 +++++++--------- user_guide/attributes.html | 4 +- user_guide/components.html | 122 ++++++++++++++++++++++++---- 4 files changed, 147 insertions(+), 57 deletions(-) create mode 100644 .idea/dictionaries/Jordan_Smart.xml diff --git a/.idea/dictionaries/Jordan_Smart.xml b/.idea/dictionaries/Jordan_Smart.xml new file mode 100644 index 00000000..19fd4a0f --- /dev/null +++ b/.idea/dictionaries/Jordan_Smart.xml @@ -0,0 +1,7 @@ + + + + empennage + + + \ No newline at end of file diff --git a/.idea/workspace.xml b/.idea/workspace.xml index d424fd05..ead04f14 100644 --- a/.idea/workspace.xml +++ b/.idea/workspace.xml @@ -2,7 +2,10 @@ + + + - @@ -148,18 +135,18 @@ - + - - + - + @@ -231,9 +218,6 @@ - - - @@ -270,12 +254,16 @@ - - + + + + + + - + @@ -291,17 +279,20 @@ - + + + + - - + + - + - - + + diff --git a/user_guide/attributes.html b/user_guide/attributes.html index 05211de8..581261b2 100644 --- a/user_guide/attributes.html +++ b/user_guide/attributes.html @@ -76,8 +76,8 @@

User Guide

Attributes

diff --git a/user_guide/components.html b/user_guide/components.html index 783c4618..239ea3bf 100644 --- a/user_guide/components.html +++ b/user_guide/components.html @@ -70,17 +70,18 @@

User Guide

+ +

Components

@@ -93,15 +94,106 @@

User Guide

Components

+ Components are SUAVE's data structure for modeling and storing + information regarding the various pieces of an aircraft. Each + analysis method in SUAVE requires some component or a combination + of components to be defined and assigned certain paramaters. +

+ Once a component has been defined, it is typically appended to a + Container data structure that holds all of the similar components + for a vehicle model. Main and secondary wings, elevators, etc. are + all collected in a "Wings" Container. Main and nose landing gears + are collected in a "Landing Gear" container. These Containers are + then appended to the Vehicle data structure (covered in the next + section) to assemble a completed vehicle model. +

+ +

+ Most methods and analyses in SUAVE are designed to work on the + Vehicle level, even if they only require a subset of Components to + be defined. Thus, it's good practice to append your Components into + Containers and your Containers into a Vehicle, even if you're only + going to, for example, run a particular aerodynamic analysis on a + wing. +

+ +

Fuselages

+ Fuselages are SUAVE's data type for passenger and cargo storage + bodies. It has attributes for physical location/origin of the body + relative to the reference origin of the vehicle, the body's + aerodynamic center, and a variety of geometric parameters, such as + its height, width, and length. +

+ +

+ Fuselages can be separated into Segments. Each Segment is its own + independent data structure, stored on the fuselage in an Ordered + Container. Segments can be designate particular locations inside + fuselage, such as the cockpit, passenger cabin, and cargo cell, or + to vary the geometry of the fuselage. +

+ +

Wings

+ Wings are SUAVE's data type for most primary aerodynamic surfaces on + an aircraft. This includes main wings and empennage, as well as + designated control surfaces. They store various attributes such as + span, chord, and airfoil, and may be separated into Segments to + vary these properties, as with fuselages. +

+ +

Landing Gear

+ Landing Gear is SUAVE's data type for the wheels and struts used to + support an aircraft while in contact with the ground. The parent + Landing Gear class has few attributes to keep it general across + different types of aircraft, but the Main Landing Gear and Nose + Landing Gear child classes include attritubes for strut length, + number of wheels, tyre diameter, etc. This makes them suitable for + use primarily with tube-and-wing civil transport aircraft. +

+ +

Payloads

- Intro Text. + Payloads are SUAVE's data type for things which may be carried by + the aircraft but are not part of it as it sits empty. This may + include passengers or cargo, and the class therefore has few + native attributes to keep it general.

Subsection Header

Systems

- Subsection Text. + Systems are SUAVE's data type for onboard hydraulic, electric, and + other secondary systems. This may include avionics, environmental + control systems, or anything else which the model must account for. + As such it is also a very general data type with few native + attributes, though it is common to add those necessary to the + analysis methods being used, such as power draw.

+ +

Energy Networks

+ Energy Networks are a complex structure incorporating a wide variety + of components and models, including turbofan engines, battery and + hybrid electric power trains, and rocket motors. Little can be said + in brief about SUAVE's energy networks - each is closely tied to + its associated analytic methods and these must be be considered in + detail to grasp how different sub-components and their attributes + interact. +

+ +

Costs

+ Costs and other non-physical elements of the vehicle may also be + modeled as Components to ensure that they are consistent across + analyses. Attributes such as depreciation lifetime, industrial + costs, and crew rates are stored in this data structure. +

From a481f946601710d483d46652bd6c4f686ac4e87d Mon Sep 17 00:00:00 2001 From: Unknown Date: Wed, 26 Jun 2019 15:18:25 -0700 Subject: [PATCH 09/10] Vehicle Top Level Page Also sidebar navigation changes to make jumping around easier --- .idea/workspace.xml | 71 ++++++++++++++++----------- user_guide/attributes.html | 12 ++++- user_guide/basic_data_structures.html | 12 ++++- user_guide/components.html | 12 ++++- user_guide/vehicles.html | 48 ++++++++++++++++-- 5 files changed, 120 insertions(+), 35 deletions(-) diff --git a/.idea/workspace.xml b/.idea/workspace.xml index ead04f14..9e859ce8 100644 --- a/.idea/workspace.xml +++ b/.idea/workspace.xml @@ -2,10 +2,10 @@ - - + + + @@ -135,18 +146,18 @@ - + - - + @@ -236,9 +247,6 @@ - - - @@ -254,13 +262,6 @@ - - - - - - - @@ -282,17 +283,31 @@ - + - - + + - - + + + + + + + + + + + + + + + + diff --git a/user_guide/attributes.html b/user_guide/attributes.html index 581261b2..d72a47c1 100644 --- a/user_guide/attributes.html +++ b/user_guide/attributes.html @@ -70,7 +70,17 @@

User Guide

Attributes

diff --git a/user_guide/basic_data_structures.html b/user_guide/basic_data_structures.html index cdc042f1..46f2977d 100644 --- a/user_guide/basic_data_structures.html +++ b/user_guide/basic_data_structures.html @@ -70,7 +70,17 @@

User Guide

Basic Data Structures

diff --git a/user_guide/components.html b/user_guide/components.html index 239ea3bf..d67a1825 100644 --- a/user_guide/components.html +++ b/user_guide/components.html @@ -70,7 +70,17 @@

User Guide

Components

diff --git a/user_guide/vehicles.html b/user_guide/vehicles.html index 783c4618..024775cc 100644 --- a/user_guide/vehicles.html +++ b/user_guide/vehicles.html @@ -82,6 +82,11 @@

User Guide

Development

Support

+ +

Vehicles

Configurations

@@ -93,14 +98,49 @@

User Guide

Vehicles

- Intro Text. + Vehicles are SUAVE's over-arching data type for assembling + Containers of Components into one, cohesive data structure. In + addition to the Containers, it stores attributes on total vehicle + mass properties, passenger capacity, and the vehicle's operating + flight envelope. +

+ Most analyses in SUAVE are written to operate on a Vehicle data + structure, and so components should be assembled into Containers + and Containers into Vehicles, even if only certain components or + certain attributes are necessary to run an analysis.

Subsection Header

Configurations

+ It's common for users to wish to study several different slight + variations on the same vehicle, or have that vehicle modify itself + slightly throughout a mission simulation. Studying different + proposed wings appended to the same fuselage, or deployment of slats + or flaps during take-off and landing are typical examples. +

+ The Configuration data-type exists to facilitate such cases. Each + Configuration is created from a reference, "base configuration", and + needs only its differences from that base configuration designated. +

+ Thus, typical procedure in such cases is to define the common set of + Components across all Configurations of the Vehicle, and create a + base configuration comprised of Containers of those Components. + Then, separate Configurations can be created using differentiated + componentry. Then, all the different Configurations are assembled + into one, top-level Vehicle data structure that stores all the + different Configurations. +

- Subsection Text. + Analyses which are designed to run on Vehicle data structure will + either just as easily run on a specific configuration, or if run + inside a mission, will identify the Configuration being used at + the moment, such as the case of flap deployment during a landing + segment.

From d74b9436cd2f821e82f154e294e743456abe769d Mon Sep 17 00:00:00 2001 From: Unknown Date: Wed, 26 Jun 2019 17:38:55 -0700 Subject: [PATCH 10/10] Methods Top Level Page --- .idea/workspace.xml | 56 +++++++++-------- user_guide/methods.html | 132 ++++++++++++++++++++++++++++++++++++++-- 2 files changed, 158 insertions(+), 30 deletions(-) diff --git a/.idea/workspace.xml b/.idea/workspace.xml index 9e859ce8..133cca66 100644 --- a/.idea/workspace.xml +++ b/.idea/workspace.xml @@ -2,10 +2,7 @@ - - - - + @@ -63,17 +69,16 @@ - @@ -93,11 +98,6 @@ - - - - -

Container

Units

Transferring SUAVE Data

User Guide

Attributes

User Guide

User Guide

Attributes

Substances

Locations

Subsection Header

Constants

User Guide

Attributes

User Guide

Components

User Guide

User Guide

Components

Fuselages

Wings

Landing Gear

Payloads

Subsection Header

Systems

Energy Networks

Costs

User Guide

Attributes

User Guide

Basic Data Structures

User Guide

Components

User Guide

Vehicles

User Guide

User Guide

Vehicles

Subsection Header

Configurations