Update documentation

OpenMDAO · Sep 18, 2024 · a82f7d3 · a82f7d3
1 parent 84079e6
commit a82f7d3
Show file tree

Hide file tree

Showing 78 changed files with 191,380 additions and 191,464 deletions.
diff --git a/_images/05b2344fa08571170fb18d5c21c668a7e3e77a8a7c9467a4ebd15f10ded45822.png b/_images/05b2344fa08571170fb18d5c21c668a7e3e77a8a7c9467a4ebd15f10ded45822.png
diff --git a/_images/0659ca58b2ef4e007d90a1289015fcdc1c7113fa1b0af8961db2acd4cf2432ca.png b/_images/0659ca58b2ef4e007d90a1289015fcdc1c7113fa1b0af8961db2acd4cf2432ca.png
diff --git a/_images/06a7723a6dfdf16404be9fb99374f60547709ccbdca5688b7a6e7405b14c5674.png b/_images/06a7723a6dfdf16404be9fb99374f60547709ccbdca5688b7a6e7405b14c5674.png
diff --git a/_images/35611cf5db64734ede452d60d3f739b4c1af562a9181ce362ad94df2012cca5e.png b/_images/35611cf5db64734ede452d60d3f739b4c1af562a9181ce362ad94df2012cca5e.png
diff --git a/_images/3cb5a190d91aa8986e2cb55c49662db5c6081fd767da845202251f7d181fd79c.png b/_images/3cb5a190d91aa8986e2cb55c49662db5c6081fd767da845202251f7d181fd79c.png
diff --git a/_images/3e24c5040d4f594859ba007d90717e417479f7ec034dc119d9c9f65e475d96b3.png b/_images/3e24c5040d4f594859ba007d90717e417479f7ec034dc119d9c9f65e475d96b3.png
diff --git a/_images/4177cf547ae9d286d795e156a0e5076a59b39fb3132577089a5484c827967da1.png b/_images/4177cf547ae9d286d795e156a0e5076a59b39fb3132577089a5484c827967da1.png
diff --git a/_images/4a42d8442c4528e19bb9c8dd45b0705bc3d07e4ce5facb89dabbad5fa616a502.png b/_images/4a42d8442c4528e19bb9c8dd45b0705bc3d07e4ce5facb89dabbad5fa616a502.png
diff --git a/_images/588e872bc0156155d509a3451aacad0a35865a806216b63482e7bb3b55584704.png b/_images/588e872bc0156155d509a3451aacad0a35865a806216b63482e7bb3b55584704.png
diff --git a/_images/641dbbbf9acf90c98aae44242277ddf462100c19bcc4438bc09478eaec5ea721.png b/_images/641dbbbf9acf90c98aae44242277ddf462100c19bcc4438bc09478eaec5ea721.png
diff --git a/_images/68e91e74c97e619121f4569892fd879f7664f247761ebc21d755cc23f36166fd.png b/_images/68e91e74c97e619121f4569892fd879f7664f247761ebc21d755cc23f36166fd.png
diff --git a/_images/7d0b92cf4655af1364e23bbab5db69a4734977df7bce9b5e991b3b7ce70ea6fc.png b/_images/7d0b92cf4655af1364e23bbab5db69a4734977df7bce9b5e991b3b7ce70ea6fc.png
diff --git a/_images/83b2d60baae08fd74522e85207bb0ec8797dad7ccb6009fcfb8032a424beb035.png b/_images/83b2d60baae08fd74522e85207bb0ec8797dad7ccb6009fcfb8032a424beb035.png
diff --git a/_images/85a647f003013995752af978b1e31e3ccc2e3c5aae3e01e944c6069fc8032981.png b/_images/85a647f003013995752af978b1e31e3ccc2e3c5aae3e01e944c6069fc8032981.png
diff --git a/_images/929a39270b4063bfada8ef2eca55b3f6e77fd4e85c7b3835a71d4aa3a3c464ec.png b/_images/929a39270b4063bfada8ef2eca55b3f6e77fd4e85c7b3835a71d4aa3a3c464ec.png
diff --git a/_images/93d03485f213f5611481515b640a14c330707a8a1e70682e551d3c4dde616d96.png b/_images/93d03485f213f5611481515b640a14c330707a8a1e70682e551d3c4dde616d96.png
diff --git a/_images/95745ee4dc617eb2f6d268eab3648ddb9c23eb191b3443b44a5064108542c60f.png b/_images/95745ee4dc617eb2f6d268eab3648ddb9c23eb191b3443b44a5064108542c60f.png
diff --git a/_images/9ecab3d37540e1b393cfed8aa17914cb18a7fcc2e19f80dcdfa7232716ea35f1.png b/_images/9ecab3d37540e1b393cfed8aa17914cb18a7fcc2e19f80dcdfa7232716ea35f1.png
diff --git a/_images/9f1521749a09bcfe3dd9ef322fbfd97a3ff26b4b7e17040884dd58d863462747.png b/_images/9f1521749a09bcfe3dd9ef322fbfd97a3ff26b4b7e17040884dd58d863462747.png
diff --git a/_images/a49f0c9ff023df28ac35dca26037bf893801707fda70711fa02f6eaed37c596b.png b/_images/a49f0c9ff023df28ac35dca26037bf893801707fda70711fa02f6eaed37c596b.png
diff --git a/_images/bbce8ac7ddfb0e4aa2d47cee73eb8818f7bc96e4a1da74446a39e7130b8d6cb2.png b/_images/bbce8ac7ddfb0e4aa2d47cee73eb8818f7bc96e4a1da74446a39e7130b8d6cb2.png
diff --git a/_images/bdd4e2a79f12bfd09cdb7ba02c2454d6c1dd295913a7ca6071bdb89b07e4333d.png b/_images/bdd4e2a79f12bfd09cdb7ba02c2454d6c1dd295913a7ca6071bdb89b07e4333d.png
diff --git a/_images/be59c9be2c27a8e5ba6d72b28568de32496feffafd6bae5f4069748fe14f8135.png b/_images/be59c9be2c27a8e5ba6d72b28568de32496feffafd6bae5f4069748fe14f8135.png
diff --git a/_images/bf549b676781b7bc0f24f09b991dd5322efe877c151db68cdf7d7f8830d309fb.png b/_images/bf549b676781b7bc0f24f09b991dd5322efe877c151db68cdf7d7f8830d309fb.png
diff --git a/_images/c69a725eb4860c9c3efcd595205879266fd038bfc4ce9e981db3be2749e9d172.png b/_images/c69a725eb4860c9c3efcd595205879266fd038bfc4ce9e981db3be2749e9d172.png
diff --git a/_images/d9a642e7a9d4932c13fe861eadfce9dc9afba344bfbaa27dbcee3570ffd0a776.png b/_images/d9a642e7a9d4932c13fe861eadfce9dc9afba344bfbaa27dbcee3570ffd0a776.png
diff --git a/_images/dea4204bf342ef77f5fdef43d6e40b7d9fdc9233e85193803cbf8c1ff61c6492.png b/_images/dea4204bf342ef77f5fdef43d6e40b7d9fdc9233e85193803cbf8c1ff61c6492.png
diff --git a/_images/df7bbe229679ce7575405f0034efb24da06fdec8343e823323be01d71c346439.png b/_images/df7bbe229679ce7575405f0034efb24da06fdec8343e823323be01d71c346439.png
diff --git a/_images/df9835ef3afb565dff44a81b5593e452da3be63c334f360705e7ca30ee00ef57.png b/_images/df9835ef3afb565dff44a81b5593e452da3be63c334f360705e7ca30ee00ef57.png
diff --git a/_images/e7b8dd6fb5f450a69813c13105312bbe1477bed277be51d4468f25266fd4c987.png b/_images/e7b8dd6fb5f450a69813c13105312bbe1477bed277be51d4468f25266fd4c987.png
diff --git a/_modules/dymos/phase/phase.html b/_modules/dymos/phase/phase.html
@@ -3209,7 +3209,7 @@ <h1>Source code for dymos.phase.phase</h1><div class="highlight"><pre>
 
     <span class="k">def</span> <span class="nf">get_simulation_phase</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">times_per_seg</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span>
                              <span class="n">rtol</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">first_step</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">max_step</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span>
-                             <span class="n">reports</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+                             <span class="n">reports</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">interpolant</span><span class="o">=</span><span class="s1">&#39;cubic&#39;</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Return a SimulationPhase instance that is essentially a copy of this Phase.</span>
 
@@ -3236,6 +3236,8 @@ <h1>Source code for dymos.phase.phase</h1><div class="highlight"><pre>
 <span class="sd">            Maximum step size for the integration.</span>
 <span class="sd">        reports : bool or None or str or Sequence</span>
 <span class="sd">            The reports setting for the subproblem run under each simulation segment.</span>
+<span class="sd">        interpolant : str</span>
+<span class="sd">            The interpolation method to be used for the controls in the simulation phase.</span>
 
 <span class="sd">        Returns</span>
 <span class="sd">        -------</span>
@@ -3292,7 +3294,7 @@ <h1>Source code for dymos.phase.phase</h1><div class="highlight"><pre>
                               <span class="n">rtol</span><span class="o">=</span><span class="n">_rtol</span><span class="p">,</span>
                               <span class="n">first_step</span><span class="o">=</span><span class="n">_first_step</span><span class="p">,</span>
                               <span class="n">max_step</span><span class="o">=</span><span class="n">_max_step</span><span class="p">,</span>
-                              <span class="n">control_interp</span><span class="o">=</span><span class="s1">&#39;barycentric&#39;</span><span class="p">)</span>
+                              <span class="n">control_interp</span><span class="o">=</span><span class="n">interpolant</span><span class="p">)</span>
 
         <span class="n">sim_phase</span> <span class="o">=</span> <span class="n">SimulationPhase</span><span class="p">(</span><span class="n">transcription</span><span class="o">=</span><span class="n">tx</span><span class="p">,</span>
                                     <span class="n">ode_class</span><span class="o">=</span><span class="n">ode_class</span><span class="p">,</span>
@@ -3393,7 +3395,8 @@ <h1>Source code for dymos.phase.phase</h1><div class="highlight"><pre>
             <span class="n">prob</span><span class="o">.</span><span class="n">set_val</span><span class="p">(</span><span class="n">prob_path</span><span class="p">,</span> <span class="n">val</span><span class="p">)</span>
 
 <div class="viewcode-block" id="Phase.simulate"><a class="viewcode-back" href="../../../api/phase_api.html#dymos.Phase.simulate">[docs]</a>    <span class="k">def</span> <span class="nf">simulate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">times_per_seg</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">rtol</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span>
-                 <span class="n">first_step</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">max_step</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">record_file</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">reports</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+                 <span class="n">first_step</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">max_step</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">record_file</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">reports</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
+                 <span class="n">interpolant</span><span class="o">=</span><span class="s1">&#39;cubic&#39;</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Simulate the Phase using scipy.integrate.solve_ivp.</span>
 
@@ -3417,6 +3420,8 @@ <h1>Source code for dymos.phase.phase</h1><div class="highlight"><pre>
 <span class="sd">            If None, no record of the simulation will be saved.</span>
 <span class="sd">        reports : bool or None or str or Sequence</span>
 <span class="sd">            Reports setting for the subproblems run under simualate.</span>
+<span class="sd">        interpolant : str</span>
+<span class="sd">            The interpolation method to be used for the controls in the simulation phase.</span>
 
 <span class="sd">        Returns</span>
 <span class="sd">        -------</span>
@@ -3430,7 +3435,7 @@ <h1>Source code for dymos.phase.phase</h1><div class="highlight"><pre>
                                                   <span class="n">reports</span><span class="o">=</span><span class="n">reports</span><span class="p">)</span>
 
         <span class="n">sim_phase</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_simulation_phase</span><span class="p">(</span><span class="n">times_per_seg</span><span class="o">=</span><span class="n">times_per_seg</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="n">method</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="n">atol</span><span class="p">,</span> <span class="n">rtol</span><span class="o">=</span><span class="n">rtol</span><span class="p">,</span>
-                                              <span class="n">first_step</span><span class="o">=</span><span class="n">first_step</span><span class="p">,</span> <span class="n">max_step</span><span class="o">=</span><span class="n">max_step</span><span class="p">)</span>
+                                              <span class="n">first_step</span><span class="o">=</span><span class="n">first_step</span><span class="p">,</span> <span class="n">max_step</span><span class="o">=</span><span class="n">max_step</span><span class="p">,</span> <span class="n">interpolant</span><span class="o">=</span><span class="n">interpolant</span><span class="p">)</span>
 
         <span class="n">sim_prob</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">add_subsystem</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">sim_phase</span><span class="p">)</span>
 

diff --git a/_modules/dymos/trajectory/trajectory.html b/_modules/dymos/trajectory/trajectory.html
@@ -2118,7 +2118,7 @@ <h1>Source code for dymos.trajectory.trajectory</h1><div class="highlight"><pre>
 
 <div class="viewcode-block" id="Trajectory.simulate"><a class="viewcode-back" href="../../../api/trajectory_api.html#dymos.Trajectory.simulate">[docs]</a>    <span class="k">def</span> <span class="nf">simulate</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">times_per_seg</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">atol</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">rtol</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span>
                  <span class="n">first_step</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">max_step</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">record_file</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">case_prefix</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
-                 <span class="n">reset_iter_counts</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">reports</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+                 <span class="n">reset_iter_counts</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">reports</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">interpolant</span><span class="o">=</span><span class="s1">&#39;cubic&#39;</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Simulate the Trajectory using scipy.integrate.solve_ivp.</span>
 
@@ -2146,6 +2146,8 @@ <h1>Source code for dymos.trajectory.trajectory</h1><div class="highlight"><pre>
 <span class="sd">            If True and model has been run previously, reset all iteration counters.</span>
 <span class="sd">        reports : bool or None or str or Sequence</span>
 <span class="sd">            Reports setting for the subproblems run under simualate.</span>
+<span class="sd">        interpolant : str</span>
+<span class="sd">            The interpolation method to be used for the controls in the simulation phase.</span>
 
 <span class="sd">        Returns</span>
 <span class="sd">        -------</span>
@@ -2161,7 +2163,8 @@ <h1>Source code for dymos.trajectory.trajectory</h1><div class="highlight"><pre>
                 <span class="k">continue</span>
             <span class="n">sim_phs</span> <span class="o">=</span> <span class="n">phs</span><span class="o">.</span><span class="n">get_simulation_phase</span><span class="p">(</span><span class="n">times_per_seg</span><span class="o">=</span><span class="n">times_per_seg</span><span class="p">,</span> <span class="n">method</span><span class="o">=</span><span class="n">method</span><span class="p">,</span>
                                                <span class="n">atol</span><span class="o">=</span><span class="n">atol</span><span class="p">,</span> <span class="n">rtol</span><span class="o">=</span><span class="n">rtol</span><span class="p">,</span> <span class="n">first_step</span><span class="o">=</span><span class="n">first_step</span><span class="p">,</span>
-                                               <span class="n">max_step</span><span class="o">=</span><span class="n">max_step</span><span class="p">,</span> <span class="n">reports</span><span class="o">=</span><span class="n">reports</span><span class="p">)</span>
+                                               <span class="n">max_step</span><span class="o">=</span><span class="n">max_step</span><span class="p">,</span> <span class="n">reports</span><span class="o">=</span><span class="n">reports</span><span class="p">,</span>
+                                               <span class="n">interpolant</span><span class="o">=</span><span class="n">interpolant</span><span class="p">)</span>
             <span class="n">sim_traj</span><span class="o">.</span><span class="n">add_phase</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">sim_phs</span><span class="p">)</span>
 
         <span class="k">if</span> <span class="ow">not</span> <span class="n">sim_traj</span><span class="o">.</span><span class="n">_phases</span><span class="p">:</span>

diff --git a/api/phase_api.html b/api/phase_api.html
@@ -2180,7 +2180,7 @@ <h2>simulate<a class="headerlink" href="#simulate" title="Permalink to this head
 <blockquote>
 <div><dl class="py method">
 <dt class="sig sig-object py">
-<span class="sig-prename descclassname"><span class="pre">Phase.</span></span><span class="sig-name descname"><span class="pre">simulate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">times_per_seg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">method</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">unspecified</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">atol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">unspecified</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rtol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">unspecified</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">first_step</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">unspecified</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_step</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">unspecified</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">record_file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reports</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/dymos/phase/phase.html#Phase.simulate"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
+<span class="sig-prename descclassname"><span class="pre">Phase.</span></span><span class="sig-name descname"><span class="pre">simulate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">times_per_seg</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">method</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">unspecified</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">atol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">unspecified</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">rtol</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">unspecified</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">first_step</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">unspecified</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_step</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">unspecified</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">record_file</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">reports</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">interpolant</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'cubic'</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/dymos/phase/phase.html#Phase.simulate"><span class="viewcode-link"><span class="pre">[source]</span></span></a></dt>
 <dd><p>Simulate the Phase using scipy.integrate.solve_ivp.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
@@ -2203,6 +2203,8 @@ <h2>simulate<a class="headerlink" href="#simulate" title="Permalink to this head
 </dd>
 <dt><strong>reports</strong><span class="classifier">bool or None or str or Sequence</span></dt><dd><p>Reports setting for the subproblems run under simualate.</p>
 </dd>
+<dt><strong>interpolant</strong><span class="classifier">str</span></dt><dd><p>The interpolation method to be used for the controls in the simulation phase.</p>
+</dd>
 </dl>
 </dd>
 <dt class="field-even">Returns<span class="colon">:</span></dt>