Skip to content

Commit d74b943

Browse files
committed
Methods Top Level Page
1 parent a481f94 commit d74b943

2 files changed

Lines changed: 158 additions & 30 deletions

File tree

‎.idea/workspace.xml‎

Lines changed: 30 additions & 26 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎user_guide/methods.html‎

Lines changed: 128 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,18 @@ <h3>User Guide</h3>
8282
<li><a href="https://suave.stanford.edu/user_guide/development.html">Development</a></li>
8383
<li><a href="https://suave.stanford.edu/user_guide/support.html">Support</a></li>
8484
</ul>
85+
86+
<h3>Methods</h3>
87+
<ul class="links">
88+
<li><a href="methods/aerodynamics.html">Aerodynamics</a></li>
89+
<li><a href="methods/propulsion.html">Propulsion</a></li>
90+
<li><a href="methods/weights.html">Weights</a></li>
91+
<li><a href="methods/cg.html">Center of Gravity</a></li>
92+
<li><a href="methods/dynamics.html">Flight Dynamics</a></li>
93+
<li><a href="methods/costs.html">Costs</a></li>
94+
<li><a href="methods/geometry.html">Geometry</a></li>
95+
<li><a href="methods/noise.html">Noise</a></li>
96+
</ul>
8597
</section>
8698

8799
</div>
@@ -93,15 +105,127 @@ <h3>User Guide</h3>
93105

94106
<article>
95107
<header>
96-
<h2>User Guide</h2>
108+
<h2>Methods</h2>
109+
<p>
110+
Methods are where the proverbial rubber begins to meet the road in
111+
SUAVE. Up until this point, the User Guide has covered primarily how
112+
SUAVE stores and organizes data. Methods are how SUAVE uses that
113+
data to calculate performance and characteristics of the vehicle.
114+
</p>
115+
<p>
116+
Methods themselves are design to be relatively "atomic" -
117+
self-contained, straight-forward input-output functions. This both
118+
allows some of them to be broken out of SUAVE entirely and used in
119+
much the same way as NumPy or SciPy functions, but "within" SUAVE
120+
it allows them to be swapped in and out or assembled into more
121+
complicated Analyses, which are covered in a separate section.
122+
</p>
123+
<p>
124+
Generally speaking, SUAVE Methods are sensitive to their input
125+
parameters and data types. They are "Garbage In, Garbage Out" and
126+
are not robust against non-physical or physically impossible setups.
127+
If methods seem to be returning non-sensical, non-numerical, or
128+
unconverging values, they are likely reflecting the physical
129+
impossibility of the inputs.
130+
</p>
131+
<p>
132+
Because the Methods can be driven to such extremes by a wide
133+
variety of conditions, there is little customized error handling.
134+
The burden lies on the user to ensure that their input models and
135+
data are sensible and well structured.
136+
</p>
137+
138+
<h3>Aerodynamics</h3>
139+
<p>
140+
Aerodynamic Methods are those used to solve aerodynamic equations
141+
for input vehicle/wing geometries. They include lifting line and
142+
potential flow solvers like the Weissinger Vortex Lattice and
143+
Athena Vortex Lattice methods, as well inviscid and Euler CFD
144+
solutions through interface with the SU2 CFD package.
145+
</p>
146+
<p>
147+
They are typically used to resolve lift and drag vectors for
148+
aerodynamic surfaces and vehicles. Where the solver also
149+
provides pertinent stability information, processing of this
150+
information is performed with a separate and Analysis.
151+
</p>
152+
153+
<h3>Propulsion</h3>
154+
<p>
155+
Propusion Methods include those used in the analysis of propulsion
156+
systems, including turbofans, propeller systems, and rocket motors.
157+
They include methods for sizing these systems and resolving thrust
158+
vectors.
159+
</p>
97160
<p>
98-
Intro Text.
161+
Because propulsors are usually highly coupled to the energy network
162+
of a vehicle, many of these methods are only meaningful when used to
163+
analyze a fully described energy network. For instance, use of
164+
propeller methods on a battery powered vehicle without consideration
165+
of the stateof charge and available voltage of the battery may
166+
overestimate the thrust the propeller could provide.
99167
</p>
100168

101-
<h3>Subsection Header</h3>
169+
<h3>Weights</h3>
102170
<p>
103-
Subsection Text.
171+
Weights are those Methods concerned with estimating the mass and
172+
weight of a vehicle and its various components. At present, these
173+
Methods are separated into two types - Correlations, and Buildups.
104174
</p>
175+
<p>
176+
Correlation methods use historical data to estimate the weight of a
177+
new aircraft of similar configuration and operational plan. SUAVE
178+
utilizes Methods of this type to estimate the weight of most
179+
aircraft including tube-and-wing civil transports, general aviation
180+
craft, and blended-wing-bodies. Buildups use ground-up physics based
181+
component sizing to arrive at a weight estimate. SUAVE uses Methods
182+
of this type for electric vertical take-off and landing aircraft.
183+
</p>
184+
185+
<h3>Center of Gravity</h3>
186+
<p>
187+
Center of Gravity (CG) Methods estimate the location of a vehicle's
188+
CG, the CGs of its components, and fuel loads. These methods are
189+
typically coupled with methods in the Flight Dynamics library for
190+
estimating vehicle stability parameters, but may be used
191+
independently if desired. They require all components to be
192+
assigned individual origin attributes in a consistent and cohesive
193+
manner.
194+
</p>
195+
196+
<h3>Flight Dynamics</h3>
197+
<p>
198+
Flight Dynamics Methods are those concerned with estimating a
199+
vehicle's static and dynamic stability margins and derivatives. They
200+
are built into SUAVE and may therefore be used separately from or
201+
in addition to aerodynamic solvers such as AVL which provide
202+
similar information.
203+
</p>
204+
205+
<h3>Costs</h3>
206+
<p>
207+
Cost Methods estimate the industrial and operating costs of a
208+
vehicle based on the physical and Cost attributes assigned to the
209+
model.
210+
</p>
211+
212+
<h3>Geometry</h3>
213+
<p>
214+
Geometry Methods are largely supporting methods used in substeps of
215+
other Methods, such as processing data for airfoils, cross-sectional
216+
areas inside of jet engines, or projected planforms of aerodynamic
217+
surfaces. They may however, also prove useful when used outside of
218+
SUAVE Methods as independent functions.
219+
</p>
220+
221+
<h3>Noise</h3>
222+
<p>
223+
Noise Methods are used to estimate jet-wash, propeller, airframe,
224+
and other sources of operational noise when the aircraft is in
225+
operation. At present, SUAVE's methods for noise estimation include
226+
a number of correlative and low-fidelity physics based methods.
227+
</p>
228+
105229
</header>
106230

107231

0 commit comments

Comments
 (0)