Skip to content

Commit

Permalink
Updated docs for 0.1d
Browse files Browse the repository at this point in the history
  • Loading branch information
dug20 committed Jul 3, 2021
1 parent f4e679b commit 6f463e8
Show file tree
Hide file tree
Showing 13 changed files with 109 additions and 60 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -138,3 +138,5 @@ White Giant - Expander Cycle.ipynb
White Giant - Expander Cycle Iterative.ipynb
White Giant - Spiral Channels 3.ipynb
White Giant - Spiral Channels 4.ipynb
White Giant - Vertical Channels 1.ipynb
White Giant - Vertical Channels 1 (nitrous coolant).ipynb
24 changes: 5 additions & 19 deletions Example - Ariane 5 Vulcain.ipynb

Large diffs are not rendered by default.

13 changes: 8 additions & 5 deletions docs/_autosummary/bamboo.cooling.html
Original file line number Diff line number Diff line change
Expand Up @@ -193,19 +193,22 @@
<tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.cooling.h_coolant_dittus_boelter" title="bamboo.cooling.h_coolant_dittus_boelter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">h_coolant_dittus_boelter</span></code></a>(rho, V, D, mu, Pr, k)</p></td>
<td><p>Dittus-Boelter equation for convective heat transfer coefficient.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.cooling.h_coolant_rpe" title="bamboo.cooling.h_coolant_rpe"><code class="xref py py-obj docutils literal notranslate"><span class="pre">h_coolant_rpe</span></code></a>(A, D, mdot, mu, k, c_bar, rho)</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.cooling.h_coolant_gnielinski" title="bamboo.cooling.h_coolant_gnielinski"><code class="xref py py-obj docutils literal notranslate"><span class="pre">h_coolant_gnielinski</span></code></a>(rho, V, D, mu, Pr, k, f)</p></td>
<td><p>Convective heat transfer coefficient for the coolant side, using Gnielinski’s correlation.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.cooling.h_coolant_rpe" title="bamboo.cooling.h_coolant_rpe"><code class="xref py py-obj docutils literal notranslate"><span class="pre">h_coolant_rpe</span></code></a>(A, D, mdot, mu, k, c_bar, rho)</p></td>
<td><p>Get the convective heat transfer coefficient for the coolant side.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.cooling.h_coolant_sieder_tate" title="bamboo.cooling.h_coolant_sieder_tate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">h_coolant_sieder_tate</span></code></a>(rho, V, D, mu_bulk, …)</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.cooling.h_coolant_sieder_tate" title="bamboo.cooling.h_coolant_sieder_tate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">h_coolant_sieder_tate</span></code></a>(rho, V, D, mu_bulk, …)</p></td>
<td><p>Sieder-Tate equation for convective heat transfer coefficient.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.cooling.h_gas_bartz" title="bamboo.cooling.h_gas_bartz"><code class="xref py py-obj docutils literal notranslate"><span class="pre">h_gas_bartz</span></code></a>(D, cp_inf, mu_inf, Pr_inf, …)</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.cooling.h_gas_bartz" title="bamboo.cooling.h_gas_bartz"><code class="xref py py-obj docutils literal notranslate"><span class="pre">h_gas_bartz</span></code></a>(D, cp_inf, mu_inf, Pr_inf, …)</p></td>
<td><p>Bartz equation, using Equation (8-23) from page 312 of RPE 7th edition (Reference [2]).</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.cooling.h_gas_bartz_sigma" title="bamboo.cooling.h_gas_bartz_sigma"><code class="xref py py-obj docutils literal notranslate"><span class="pre">h_gas_bartz_sigma</span></code></a>(c_star, At, A, pc, Tc, M, …)</p></td>
<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.cooling.h_gas_bartz_sigma" title="bamboo.cooling.h_gas_bartz_sigma"><code class="xref py py-obj docutils literal notranslate"><span class="pre">h_gas_bartz_sigma</span></code></a>(c_star, At, A, pc, Tc, M, …)</p></td>
<td><p>Bartz heat transfer equation using the sigma correlation, from Reference [6].</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.cooling.h_gas_rpe" title="bamboo.cooling.h_gas_rpe"><code class="xref py py-obj docutils literal notranslate"><span class="pre">h_gas_rpe</span></code></a>(D, M, T, rho, gamma, R, mu, k, Pr)</p></td>
<tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.cooling.h_gas_rpe" title="bamboo.cooling.h_gas_rpe"><code class="xref py py-obj docutils literal notranslate"><span class="pre">h_gas_rpe</span></code></a>(D, M, T, rho, gamma, R, mu, k, Pr)</p></td>
<td><p>Get the convective heat transfer coefficient on the gas side.</p></td>
</tr>
</tbody>
Expand Down
6 changes: 1 addition & 5 deletions docs/_autosummary/bamboo.main.html
Original file line number Diff line number Diff line change
Expand Up @@ -164,17 +164,13 @@
<li><p>1D flow.</p></li>
<li><p>Isentropic flow.</p></li>
<li><p>Perfect gases.</p></li>
<li><p>No axial heat transfer (only radial) - this becomes inaccurate when there are large axial temperature gradients (e.g. sometimes along walls near the throat)</p></li>
</ul>
</dd>
<dt>Conventions:</dt><dd><ul class="simple">
<li><p>Position (x) along the nozzle is defined by: x = 0 at the throat, x &lt; 0 in the combustion chamber, x &gt; 0 in the diverging section of the nozzle.</p></li>
</ul>
</dd>
<dt>Known issues:</dt><dd><ul class="simple">
<li><p>A hardcoded fix is in place for using area ratios outside the Rao angle data range (it tricks the code into making something close to a 15 degree cone). A more robust fix would be better.</p></li>
<li><p>h_gas_model = ‘2’ doesn’t seem to work very well (if at all) right now.</p></li>
</ul>
</dd>
<dt>Room for improvement:</dt><dd><ul class="simple">
<li><p>Should check if the Engine.channel_geometry() function is working as intended.</p></li>
<li><p>Unsure if the first step (i = 0) in Engine.steady_heating_analysis() is dealt with correctly when using h_gas_model == ‘3’.</p></li>
Expand Down
1 change: 1 addition & 0 deletions docs/_sources/_autosummary/bamboo.cooling.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@

black_body
h_coolant_dittus_boelter
h_coolant_gnielinski
h_coolant_rpe
h_coolant_sieder_tate
h_gas_bartz
Expand Down
Binary file modified docs/build/doctrees/_autosummary/bamboo.cooling.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
Binary file not shown.
16 changes: 11 additions & 5 deletions docs/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -275,17 +275,21 @@ <h2 id="C">C</h2>
</li>
<li><a href="index.html#bamboo.main.ChamberConditions">ChamberConditions (class in bamboo.main)</a>
</li>
<li><a href="index.html#bamboo.main.Engine.check_separation">check_separation() (bamboo.main.Engine method)</a>
<li><a href="index.html#bamboo.cooling.CoolingJacket.channel_height">channel_height() (bamboo.cooling.CoolingJacket method)</a>
</li>
<li><a href="index.html#bamboo.main.Engine.channel_path_lengths">channel_path_lengths() (bamboo.main.Engine method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#bamboo.cooling.CoolingJacket.channel_width">channel_width() (bamboo.cooling.CoolingJacket method)</a>
</li>
<li><a href="index.html#bamboo.main.Engine.check_separation">check_separation() (bamboo.main.Engine method)</a>
</li>
<li><a href="index.html#bamboo.main.Engine.coolant_dynamic_pressure">coolant_dynamic_pressure() (bamboo.main.Engine method)</a>
</li>
<li><a href="index.html#bamboo.main.Engine.coolant_friction_factor">coolant_friction_factor() (bamboo.main.Engine method)</a>
</li>
<li><a href="index.html#bamboo.main.Engine.coolant_p0_drop">coolant_p0_drop() (bamboo.main.Engine method)</a>
</li>
<li><a href="index.html#bamboo.main.Engine.coolant_path_length">coolant_path_length() (bamboo.main.Engine method)</a>
</li>
<li><a href="index.html#bamboo.cooling.CoolingJacket.coolant_velocity">coolant_velocity() (bamboo.cooling.CoolingJacket method)</a>
</li>
Expand Down Expand Up @@ -353,12 +357,14 @@ <h2 id="H">H</h2>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#bamboo.cooling.h_coolant_dittus_boelter">h_coolant_dittus_boelter() (in module bamboo.cooling)</a>
</li>
<li><a href="index.html#bamboo.cooling.h_coolant_rpe">h_coolant_rpe() (in module bamboo.cooling)</a>
<li><a href="index.html#bamboo.cooling.h_coolant_gnielinski">h_coolant_gnielinski() (in module bamboo.cooling)</a>
</li>
<li><a href="index.html#bamboo.cooling.h_coolant_sieder_tate">h_coolant_sieder_tate() (in module bamboo.cooling)</a>
<li><a href="index.html#bamboo.cooling.h_coolant_rpe">h_coolant_rpe() (in module bamboo.cooling)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="index.html#bamboo.cooling.h_coolant_sieder_tate">h_coolant_sieder_tate() (in module bamboo.cooling)</a>
</li>
<li><a href="index.html#bamboo.cooling.h_gas_bartz">h_gas_bartz() (in module bamboo.cooling)</a>
</li>
<li><a href="index.html#bamboo.cooling.h_gas_bartz_sigma">h_gas_bartz_sigma() (in module bamboo.cooling)</a>
Expand Down
Loading

0 comments on commit 6f463e8

Please sign in to comment.