Updated documentation for 0.2.1

docs/_autosummary/bamboo.circuit.html

@@ -113,7 +113,10 @@
 <tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.circuit.h_gas_bartz" title="bamboo.circuit.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 [1]).</p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.circuit.h_gas_bartz_sigma" title="bamboo.circuit.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, p_chamber, …)</p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.circuit.h_gas_bartz_sigma" title="bamboo.circuit.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, A_t, A, p_chamber, …)</p></td>
+<td><p>Bartz heat transfer equation using the sigma correlation, from Reference [3].</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.circuit.h_gas_bartz_sigma_curve" title="bamboo.circuit.h_gas_bartz_sigma_curve"><code class="xref py py-obj docutils literal notranslate"><span class="pre">h_gas_bartz_sigma_curve</span></code></a>(c_star, A_t, A, …)</p></td>
 <td><p>Bartz heat transfer equation using the sigma correlation, from Reference [3].</p></td>
 </tr>
 </tbody>

docs/_autosummary/bamboo.engine.html

@@ -80,11 +80,17 @@
 <li><p>[2] - <a class="reference external" href="https://en.wikipedia.org/wiki/Darcy_friction_factor_formulae">https://en.wikipedia.org/wiki/Darcy_friction_factor_formulae</a></p></li>
 <li><p>[3] - <a class="reference external" href="https://en.wikipedia.org/wiki/Darcy%E2%80%93Weisbach_equation">https://en.wikipedia.org/wiki/Darcy%E2%80%93Weisbach_equation</a></p></li>
 <li><p>[4] - Huang and Huzel, Modern Engineering for Design of Liquid-Propellant Rocket Engines</p></li>
+<li><p>[5] - <a class="reference external" href="https://en.wikipedia.org/wiki/Radius_of_curvature">https://en.wikipedia.org/wiki/Radius_of_curvature</a></p></li>
+<li><p>[6] - <a class="reference external" href="https://en.wikipedia.org/wiki/Hydraulic_diameter">https://en.wikipedia.org/wiki/Hydraulic_diameter</a></p></li>
+<li><p>[7] - <a class="reference external" href="https://mathcurve.com/courbes3d.gb/heliceconic/heliceconic.shtml#:~:text=The%20conical%20helix%20can%20be,a%20geodesic%20of%20the%20cone">https://mathcurve.com/courbes3d.gb/heliceconic/heliceconic.shtml#:~:text=The%20conical%20helix%20can%20be,a%20geodesic%20of%20the%20cone</a></p></li>
+<li><p>[8] - <a class="reference external" href="https://neutrium.net/fluid-flow/pressure-loss-from-fittings-expansion-and-reduction-in-pipe-size/">https://neutrium.net/fluid-flow/pressure-loss-from-fittings-expansion-and-reduction-in-pipe-size/</a></p></li>
+<li><p>[9] - Heister et al., Rocket Propulsion (<a class="reference external" href="https://doi.org/10.1017/9781108381376">https://doi.org/10.1017/9781108381376</a>)</p></li>
+<li><p>[10] - Brkic 2012, Lambert W function in hydraulic problems (<a class="reference external" href="https://www.scipedia.com/public/Brkic_2012a">https://www.scipedia.com/public/Brkic_2012a</a>)</p></li>
 </ul>
 <p class="rubric">Notes</p>
 <ul class="simple">
-<li><p>With some exceptions, fluid properties are currently evaluated at the bulk temperature, instead of the film temperature. This is because the high wall temperature can sometimes
-be above the fluid boiling point, which can cause errors. Ideally you would use nucleate boiling correlations in this case, but this is not always possible, and so use the bulk
+<li><p>With some exceptions, coolant properties are currently evaluated at the bulk temperature, instead of the film temperature. This is because the high wall temperature can sometimes
+be above the coolant boiling point, which can cause errors. Ideally you would use nucleate boiling correlations in this case, but this is not always possible, and so use the bulk
 properties is available as a compromise.</p></li>
 </ul>
 <p class="rubric">Classes</p>
@@ -97,13 +103,13 @@
 <tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.engine.ChamberConditions" title="bamboo.engine.ChamberConditions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ChamberConditions</span></code></a>(p0, T0)</p></td>
 <td><p>Object for storing combustion chamber thermodynamic conditions.</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.engine.CoolingJacket" title="bamboo.engine.CoolingJacket"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CoolingJacket</span></code></a>(T_coolant_in, p0_coolant_in, …)</p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.engine.CoolingJacket" title="bamboo.engine.CoolingJacket"><code class="xref py py-obj docutils literal notranslate"><span class="pre">CoolingJacket</span></code></a>(T_coolant_in, p_coolant_in, …)</p></td>
 <td><p>Class for representing cooling jacket properties.</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.engine.Engine" title="bamboo.engine.Engine"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Engine</span></code></a>(perfect_gas, chamber_conditions, geometry)</p></td>
 <td><p>Class for representing a liquid rocket engine.</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.engine.Geometry" title="bamboo.engine.Geometry"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Geometry</span></code></a>(xs, ys)</p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.engine.Geometry" title="bamboo.engine.Geometry"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Geometry</span></code></a>(xs, rs)</p></td>
 <td><p>Class for representing the inner contour of a rocket engine, from the beginning of the combustion chamber to the nozzle exit.</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.engine.PerfectGas" title="bamboo.engine.PerfectGas"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PerfectGas</span></code></a>(**kwargs)</p></td>

docs/_autosummary/bamboo.hx.html

@@ -89,7 +89,7 @@
 <col style="width: 90%" />
 </colgroup>
 <tbody>
-<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.hx.HXSolver" title="bamboo.hx.HXSolver"><code class="xref py py-obj docutils literal notranslate"><span class="pre">HXSolver</span></code></a>(T_c_in, T_h, p0_c_in, cp_c, mdot_c, …)</p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.hx.HXSolver" title="bamboo.hx.HXSolver"><code class="xref py py-obj docutils literal notranslate"><span class="pre">HXSolver</span></code></a>(T_c_in, T_h, p_c_in, cp_c, mdot_c, …)</p></td>
 <td><p>Class for solving heat exchanger problems.</p></td>
 </tr>
 </tbody>

docs/_autosummary/bamboo.isen.html

@@ -73,22 +73,39 @@
 
   <section id="module-bamboo.isen">
 <span id="bamboo-isen"></span><h1>bamboo.isen<a class="headerlink" href="#module-bamboo.isen" title="Permalink to this headline"></a></h1>
-<p>Isentropic compressible flow relations.</p>
+<dl class="simple">
+<dt>Isentropic compressible flow relations.</dt><dd><ul class="simple">
+<li><p>[1] - Heister et al., Rocket Propulsion (<a class="reference external" href="https://doi.org/10.1017/9781108381376">https://doi.org/10.1017/9781108381376</a>)</p></li>
+</ul>
+</dd>
+</dl>
 <p class="rubric">Functions</p>
 <table class="longtable docutils align-default">
 <colgroup>
 <col style="width: 10%" />
 <col style="width: 90%" />
 </colgroup>
 <tbody>
-<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.isen.M_from_p" title="bamboo.isen.M_from_p"><code class="xref py py-obj docutils literal notranslate"><span class="pre">M_from_p</span></code></a>(p, p0, gamma)</p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.isen.A_At" title="bamboo.isen.A_At"><code class="xref py py-obj docutils literal notranslate"><span class="pre">A_At</span></code></a>(M, gamma)</p></td>
+<td><p>Ratio of local flow area to the throat area, for a given Mach number [1].</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.isen.M_from_A_subsonic" title="bamboo.isen.M_from_A_subsonic"><code class="xref py py-obj docutils literal notranslate"><span class="pre">M_from_A_subsonic</span></code></a>(A, A_t, gamma)</p></td>
+<td><p>Get the Mach number from the local flow area, assuming subsonic flow.</p></td>
+</tr>
+<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.isen.M_from_A_supersonic" title="bamboo.isen.M_from_A_supersonic"><code class="xref py py-obj docutils literal notranslate"><span class="pre">M_from_A_supersonic</span></code></a>(A, A_t, gamma)</p></td>
+<td><p>Get the Mach number from the local flow area, assuming supersonic flow.</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.isen.M_from_p" title="bamboo.isen.M_from_p"><code class="xref py py-obj docutils literal notranslate"><span class="pre">M_from_p</span></code></a>(p, p0, gamma)</p></td>
 <td><p>Mach number from static pressure and stagnation pressure.</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.isen.T" title="bamboo.isen.T"><code class="xref py py-obj docutils literal notranslate"><span class="pre">T</span></code></a>(T0, M, gamma)</p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.isen.T" title="bamboo.isen.T"><code class="xref py py-obj docutils literal notranslate"><span class="pre">T</span></code></a>(T0, M, gamma)</p></td>
 <td><p>Get local temperature from the Mach number and stagnation temperature.</p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.isen.T0" title="bamboo.isen.T0"><code class="xref py py-obj docutils literal notranslate"><span class="pre">T0</span></code></a>(T, M, gamma)</p></td>
-<td><p>Get the stangation temperature from the static temperature and Mach number</p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.isen.T0" title="bamboo.isen.T0"><code class="xref py py-obj docutils literal notranslate"><span class="pre">T0</span></code></a>(T, M, gamma)</p></td>
+<td><p>Get the stangation temperature from the static temperature and Mach number [1]</p></td>
+</tr>
+<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.isen.Tr" title="bamboo.isen.Tr"><code class="xref py py-obj docutils literal notranslate"><span class="pre">Tr</span></code></a>(T, M, gamma, r)</p></td>
+<td><p>Get the recovery temperature, which is the temperature you should use for convective heat transfer (i.e.</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.isen.get_choked_mdot" title="bamboo.isen.get_choked_mdot"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_choked_mdot</span></code></a>(perfect_gas, …)</p></td>
 <td><p>Get the mass flow rate through a choked nozzle.</p></td>
@@ -106,7 +123,7 @@
 <td><p>Get local pressure from the Mach number and stagnation pressure.</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.isen.p0" title="bamboo.isen.p0"><code class="xref py py-obj docutils literal notranslate"><span class="pre">p0</span></code></a>(p, M, gamma)</p></td>
-<td><p>Get stagnation pressure from static pressure and Mach number</p></td>
+<td><p>Get stagnation pressure from static pressure and Mach number [1]</p></td>
 </tr>
 </tbody>
 </table>

docs/_autosummary/bamboo.materials.html

@@ -89,7 +89,7 @@
 <tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.materials.NucleateBoiling" title="bamboo.materials.NucleateBoiling"><code class="xref py py-obj docutils literal notranslate"><span class="pre">NucleateBoiling</span></code></a>(vapour_transport, …)</p></td>
 <td><p>Class for representing the information needed to model nucleate boiling.</p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.materials.TransportProperties" title="bamboo.materials.TransportProperties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TransportProperties</span></code></a>(Pr, mu, k[, cp, rho])</p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.materials.TransportProperties" title="bamboo.materials.TransportProperties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TransportProperties</span></code></a>(Pr, mu, k[, cp, rho, …])</p></td>
 <td><p>Container for specifying your transport properties.</p></td>
 </tr>
 </tbody>

docs/_autosummary/bamboo.plot.html

@@ -81,26 +81,35 @@
 <col style="width: 90%" />
 </colgroup>
 <tbody>
-<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.plot.plot_coolant_velocity" title="bamboo.plot.plot_coolant_velocity"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_coolant_velocity</span></code></a>(data_dict)</p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.plot.plot_T_coolant" title="bamboo.plot.plot_T_coolant"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_T_coolant</span></code></a>(data_dict)</p></td>
+<td><p>Given the output dictionary from a engine cooling analysis, plot the coolant static temperature against postiion</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.plot.plot_coolant_density" title="bamboo.plot.plot_coolant_density"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_coolant_density</span></code></a>(data_dict)</p></td>
+<td><p>Plot the cooling density against axial position.</p></td>
+</tr>
+<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.plot.plot_coolant_h" title="bamboo.plot.plot_coolant_h"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_coolant_h</span></code></a>(data_dict)</p></td>
+<td><p>Plot 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.plot.plot_coolant_velocity" title="bamboo.plot.plot_coolant_velocity"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_coolant_velocity</span></code></a>(data_dict)</p></td>
 <td><p>Given the output dictionary from a engine cooling analysis, plot the cooling velocity against axial position.</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.plot.plot_jacket_pressure" title="bamboo.plot.plot_jacket_pressure"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_jacket_pressure</span></code></a>(data_dict[, …])</p></td>
-<td><p>Given the output dictionary from a engine cooling analysis, plot the cooling jacket pressure against x position.</p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.plot.plot_p_coolant" title="bamboo.plot.plot_p_coolant"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_p_coolant</span></code></a>(data_dict)</p></td>
+<td><p>Given the output dictionary from a engine cooling analysis, plot the cooling jacket static pressure against x position.</p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.plot.plot_q_per_area" title="bamboo.plot.plot_q_per_area"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_q_per_area</span></code></a>(data_dict)</p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.plot.plot_q_per_area" title="bamboo.plot.plot_q_per_area"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_q_per_area</span></code></a>(data_dict)</p></td>
 <td><p>Given the output dictionary from a engine cooling analysis, plot the heat flux against position.</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.plot.plot_resistances" title="bamboo.plot.plot_resistances"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_resistances</span></code></a>(data_dict, **kwargs)</p></td>
-<td><p></p></td>
-</tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.plot.plot_tangential_stress" title="bamboo.plot.plot_tangential_stress"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_tangential_stress</span></code></a>(data_dict[, wall_index])</p></td>
 <td><p>Given the output dictionary from a engine cooling analysis, plot the thermal stress in the inner chamber wall, against position.</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.plot.plot_temperatures" title="bamboo.plot.plot_temperatures"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_temperatures</span></code></a>(data_dict[, only_indexes])</p></td>
 <td><p>Given the output dictionary from an engine cooling analysis, plot the temperatures against position.</p></td>
 </tr>
-<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.plot.show" title="bamboo.plot.show"><code class="xref py py-obj docutils literal notranslate"><span class="pre">show</span></code></a>()</p></td>
-<td><p></p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.plot.plot_thermal_resistances" title="bamboo.plot.plot_thermal_resistances"><code class="xref py py-obj docutils literal notranslate"><span class="pre">plot_thermal_resistances</span></code></a>(data_dict[, …])</p></td>
+<td><p>Given the output dictionary from an engine cooling analysis, plot the local thermal resistances against position.</p></td>
+</tr>
+<tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.plot.show" title="bamboo.plot.show"><code class="xref py py-obj docutils literal notranslate"><span class="pre">show</span></code></a>()</p></td>
+<td><p>Show a plot.</p></td>
 </tr>
 </tbody>
 </table>

docs/_autosummary/bamboo.rao.html

@@ -85,7 +85,7 @@
 <col style="width: 90%" />
 </colgroup>
 <tbody>
-<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.rao.get_rao_contour" title="bamboo.rao.get_rao_contour"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_rao_contour</span></code></a>(Rc, Rt, area_ratio, Lc[, …])</p></td>
+<tr class="row-odd"><td><p><a class="reference internal" href="../index.html#bamboo.rao.get_rao_contour" title="bamboo.rao.get_rao_contour"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_rao_contour</span></code></a>(r_c, r_t, area_ratio, L_c[, …])</p></td>
 <td><p>Get the x and y positions for an 80% Rao bell nozzle</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="../index.html#bamboo.rao.rao_theta_e" title="bamboo.rao.rao_theta_e"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rao_theta_e</span></code></a>(area_ratio[, length_fraction])</p></td>

docs/_sources/_autosummary/bamboo.circuit.rst.txt

@@ -22,6 +22,7 @@
       h_coolant_stable_film
       h_gas_bartz
       h_gas_bartz_sigma
+      h_gas_bartz_sigma_curve
 
 
 

docs/_sources/_autosummary/bamboo.isen.rst.txt

@@ -13,9 +13,13 @@
 
    .. autosummary::
 
+      A_At
+      M_from_A_subsonic
+      M_from_A_supersonic
       M_from_p
       T
       T0
+      Tr
       get_choked_mdot
       get_exit_area
       get_throat_area