Skip to content

Commit 1b7fd0e

Browse files
committed
added doxygen links
1 parent 2941cc3 commit 1b7fd0e

File tree

5 files changed

+6
-5
lines changed

5 files changed

+6
-5
lines changed

_posts/2000-01-04-mission_solver.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Most of the missions in SUAVE, including this one, are broken into several point
4040

4141
<img src="http://suave.stanford.edu/images/drag_components_2.png" width="800" height="234" />
4242

43-
At each of these points the aerodynamic analysis is queried to find CL and CD, which are then converted to lift and drag. These values will be dependent on the body angle unknown and other aerodynamic parameters. Thrust is found from the vehicle's energy network, which is dependent on the throttle unknown. A weight is determined by looking at the initial weight and subsequent mass rate (typically corresponding with fuel burn). In this cruise segment, these forces are summed in 2D and the results are put in the residuals. The functions needed to arrive these forces are found in the Update Conditions section of the [Analysis file](dox_link). This section is also shown below in one of the steps to create a new mission.
43+
At each of these points the aerodynamic analysis is queried to find CL and CD, which are then converted to lift and drag. These values will be dependent on the body angle unknown and other aerodynamic parameters. Thrust is found from the vehicle's energy network, which is dependent on the throttle unknown. A weight is determined by looking at the initial weight and subsequent mass rate (typically corresponding with fuel burn). In this cruise segment, these forces are summed in 2D and the results are put in the residuals. The functions needed to arrive these forces are found in the Update Conditions section of the Analysis file. This section is also shown below in one of the steps to create a new mission.
4444

4545
Once the evaluation process has been performed at all points, the unknowns and residuals are fed back to the solve routine, which in this case is scipy's fsolve. The file that performs this process is [here](https://github.com/suavecode/SUAVE/blob/develop/trunk/SUAVE/Methods/Missions/Segments/converge_root.py). This routine continues evaluating the points until convergence is reached. Once this happens, post processing is done to put the data in the results output.
4646

_posts/2000-01-06-optimization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This is an overview of how optimization is done in SUAVE. A specific tutorial ca
1414

1515
### Nexus Class
1616

17-
The Nexus class is the underlying data structure that is used for optimization. It is created to hold all data and functionality needed to link together optimizers and the various analysis modules in SUAVE. Detailed information on each of the functions can be found in our [doxygen site](dox_link).
17+
The Nexus class is the underlying data structure that is used for optimization. It is created to hold all data and functionality needed to link together optimizers and the various analysis modules in SUAVE. Detailed information on each of the functions can be found on our [doxygen page](/doxygen).
1818

1919
### Standard Optimization File Structure
2020

_posts/2015-06-14-doc_instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ permalink: /guides/docs.html
1010

1111
### How to Read (and Write) the Documentation
1212

13-
This is an explanation of how documentation is built in SUAVE so that the user can know what to look for and how to write it if they wish to add their own code.
13+
This is an explanation of how documentation is built in SUAVE so that the user can know what to look for and how to write it if they wish to add their own code. The doxygen page is available [here](/doxygen).
1414

1515
### Docstrings
1616

guides/index.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ <h1 class="title">Guides</h1>
1515

1616

1717
<section class="content">
18-
<p>These are code structure/style guides and tutorials for SUAVE. The first set give general information on how SUAVE operated and how our code is formatted. The tutorials will then help you get started with SUAVE. We recommend starting with the Boeing 737-800 tutorial and then moving to the Transport Optimization or the Turbofan Network tutorial. These will allow you to explore the capabilities of SUAVE.</p>
18+
<p>These are code structure/style guides and tutorials for SUAVE. The first set gives general information on how SUAVE is operated and how our code is formatted. The tutorials will then help you get started with SUAVE. We recommend starting with the Boeing 737-800 tutorial and then moving to the Transport Optimization or the Turbofan Network tutorial. These will allow you to explore the capabilities of SUAVE. A direct link
19+
to the documentation for individual functions is <a href="http://suave.stanford.edu/doxygen">here</a></p>
1920

2021
<ul class="posts">
2122
{% for post in site.posts %}

index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ <h1 class="title">SUAVE</h1>
1616

1717
<p><img src="../images/bwb_inside.png" alt="Blended Wing Body" /></p>
1818

19-
<p>SUAVE is an open source suite constructed as a modular set of analysis tools written in Python. Additional capabilities can be incorporated using extensible interfaces and prototyped with a top-level script. The flexibility of the environment allows the creation of arbitrary mission profiles, unconventional propulsion networks, and right-fidelity at right-time discipline analyses. SUAVE is currently being developed in the <a href="http://adl.stanford.edu">Aerospace Design Lab at Stanford University</a>. </p>
19+
<p>SUAVE is an open source suite constructed as a modular set of analysis tools written in Python. Additional capabilities can be incorporated using extensible interfaces and prototyped with a top-level script. The flexibility of the environment allows the creation of arbitrary mission profiles, unconventional propulsion networks, and right-fidelity at right-time discipline analyses. SUAVE is currently being developed in the <a href="http://adl.stanford.edu">Aerospace Design Lab</a> at Stanford University. </p>
2020

2121
<h3> Capabilities Available </h3>
2222

0 commit comments

Comments
 (0)