Update documentation

robfalck · Feb 1, 2024 · 4c4a35b · 4c4a35b
1 parent 59122d2
commit 4c4a35b
Show file tree

Hide file tree

Showing 363 changed files with 1,276,951 additions and 16,893 deletions.
diff --git a/_images/07f981485cba67188aca2063b61214175bd67b300bce83e8b9793b548279001b.png b/_images/07f981485cba67188aca2063b61214175bd67b300bce83e8b9793b548279001b.png
diff --git a/...e3a9b0f02a62afbe2ef677017615c22179e9f.png → ...9dfa2bcbdc179d0edaa92798b299e65b781d6.png b/...e3a9b0f02a62afbe2ef677017615c22179e9f.png → ...9dfa2bcbdc179d0edaa92798b299e65b781d6.png
diff --git a/_images/166a246b2f2d373a327fe1740aeed2101509249f6b6029896e7705fdbf511561.png b/_images/166a246b2f2d373a327fe1740aeed2101509249f6b6029896e7705fdbf511561.png
diff --git a/_images/187a167fc1370a3f4caa6f705bcb2b4d1579fbca0d087b875560c318d2c51a88.png b/_images/187a167fc1370a3f4caa6f705bcb2b4d1579fbca0d087b875560c318d2c51a88.png
diff --git a/...b6b91d6bd5b04b53dea9f0ad56491f38302e3.png → ...0399269bca81f400b06a084f52c3cf14b500e.png b/...b6b91d6bd5b04b53dea9f0ad56491f38302e3.png → ...0399269bca81f400b06a084f52c3cf14b500e.png
diff --git a/_images/1adf2baf975e7ad7f8e22b054e104046ab3b9617b56770656493d6901a16ece1.png b/_images/1adf2baf975e7ad7f8e22b054e104046ab3b9617b56770656493d6901a16ece1.png
diff --git a/_images/1becdfb3505a9018547df0ec55bea22a061f7f80b1519c17b4b2944eed7485a6.png b/_images/1becdfb3505a9018547df0ec55bea22a061f7f80b1519c17b4b2944eed7485a6.png
diff --git a/_images/21be9567785e4284eb2ec5e2133be337adc033c0a1bb2309ccb770ddd2e0f716.png b/_images/21be9567785e4284eb2ec5e2133be337adc033c0a1bb2309ccb770ddd2e0f716.png
diff --git a/...f036d6d18a73b23c54ce03dbb6e4d9c913dfb.png → ...225f8dc36682999b39c4fc63a683dfde69d88.png b/...f036d6d18a73b23c54ce03dbb6e4d9c913dfb.png → ...225f8dc36682999b39c4fc63a683dfde69d88.png
diff --git a/...524f3af8f073bbe493833cf5ce8175cdff7a2.png → ...e5dfdcab77f88506d4bbae922163a80036431.png b/...524f3af8f073bbe493833cf5ce8175cdff7a2.png → ...e5dfdcab77f88506d4bbae922163a80036431.png
diff --git a/_images/31820fa1b6182600c30c5e6d96f6069a0d16b7c89e580e4ca2510ee6f6afe822.png b/_images/31820fa1b6182600c30c5e6d96f6069a0d16b7c89e580e4ca2510ee6f6afe822.png
diff --git a/_images/33285cd3a1be5019a41c58ecfdce53547665eb9e3646241968af890f42f26543.png b/_images/33285cd3a1be5019a41c58ecfdce53547665eb9e3646241968af890f42f26543.png
diff --git a/_images/3644dc8d25ea018b7130172905dc1112796a2f92875e9d6594411dceb35afd82.png b/_images/3644dc8d25ea018b7130172905dc1112796a2f92875e9d6594411dceb35afd82.png
diff --git a/_images/3a5abfa6554f9e9aadbebafe867813a5a98d62e1d25406ef4f0837a2da117c3f.png b/_images/3a5abfa6554f9e9aadbebafe867813a5a98d62e1d25406ef4f0837a2da117c3f.png
diff --git a/...a8f0fb71b25c460f1a58f8afa2a6bcb3fe995.png → ...016462de144fff91daebc66197a60eeb9560e.png b/...a8f0fb71b25c460f1a58f8afa2a6bcb3fe995.png → ...016462de144fff91daebc66197a60eeb9560e.png
diff --git a/_images/4b2c2f8fc546a6fced3c682aa9b1152d8146e4f7b2906942b959a9f7390adc2a.png b/_images/4b2c2f8fc546a6fced3c682aa9b1152d8146e4f7b2906942b959a9f7390adc2a.png
diff --git a/_images/515fd3bd9a2fbce978882b22b29d3a3d9aa162776e41d979fc8d9ac5e51c4265.png b/_images/515fd3bd9a2fbce978882b22b29d3a3d9aa162776e41d979fc8d9ac5e51c4265.png
diff --git a/...3b90dbcba6849fb1d1dea7d58d834dc329901.png → ...35fe4af82de35093cba3f409839918ec1d9a3.png b/...3b90dbcba6849fb1d1dea7d58d834dc329901.png → ...35fe4af82de35093cba3f409839918ec1d9a3.png
diff --git a/_images/5ca295e99b6950bae12dab476fa175cf5aef2659a1f782085c842f3bb02a1bb6.png b/_images/5ca295e99b6950bae12dab476fa175cf5aef2659a1f782085c842f3bb02a1bb6.png
diff --git a/_images/5ed3db8a0fc567396c3b5b07afde8f99338732c92b252f3bce9446a3576f00a3.png b/_images/5ed3db8a0fc567396c3b5b07afde8f99338732c92b252f3bce9446a3576f00a3.png
diff --git a/_images/601c3b69e2a06f2bf9f946da5e9d29269f78d9009eacca1e6a3f1bbe0e8e3810.png b/_images/601c3b69e2a06f2bf9f946da5e9d29269f78d9009eacca1e6a3f1bbe0e8e3810.png
diff --git a/_images/6a7cd0dfff5a788cbe269e657f02fd4b53a2efc9b0d00dcb2ca34893db3a9c91.png b/_images/6a7cd0dfff5a788cbe269e657f02fd4b53a2efc9b0d00dcb2ca34893db3a9c91.png
diff --git a/_images/6ae91595b1da88aa6078368ff2101975ad5116aaec7b33660272914e16fb3ccb.png b/_images/6ae91595b1da88aa6078368ff2101975ad5116aaec7b33660272914e16fb3ccb.png
diff --git a/...aae6340edd5c6a4a91f69a42ff38fc66a46cb.png → ...d4d1d2d439dfc8ca37acb3d8655be0b8890f7.png b/...aae6340edd5c6a4a91f69a42ff38fc66a46cb.png → ...d4d1d2d439dfc8ca37acb3d8655be0b8890f7.png
diff --git a/_images/82f467b0a14a7e65af152277f0641306cc012478454913eec5fe2bdbb5a3327f.png b/_images/82f467b0a14a7e65af152277f0641306cc012478454913eec5fe2bdbb5a3327f.png
diff --git a/_images/8608c8b9227681c301f9ccfe4d50f5b8e847b112eded440994af230a74509031.png b/_images/8608c8b9227681c301f9ccfe4d50f5b8e847b112eded440994af230a74509031.png
diff --git a/_images/8bc0e68393d63c7e899e7b691186532fc27a96b6e7f3184a33b56f14ac91f6b8.png b/_images/8bc0e68393d63c7e899e7b691186532fc27a96b6e7f3184a33b56f14ac91f6b8.png
diff --git a/_images/97b494d19c80ea449a7ee37efdecfe6af78d977ec5c14deebff77b43f1e5e7bb.png b/_images/97b494d19c80ea449a7ee37efdecfe6af78d977ec5c14deebff77b43f1e5e7bb.png
diff --git a/_images/9e7509cac0d70e0e95636847778a834314be511093f61014d404d7656fb35220.png b/_images/9e7509cac0d70e0e95636847778a834314be511093f61014d404d7656fb35220.png
diff --git a/_images/a1ad920870bca84f914c3d421664840c3ddaf07cbdf1e051bb241a95d25a3b06.png b/_images/a1ad920870bca84f914c3d421664840c3ddaf07cbdf1e051bb241a95d25a3b06.png
diff --git a/_images/a2847f936dda89a036f79dfd93e101494cbf69c04b450be446a2638b1520cd06.png b/_images/a2847f936dda89a036f79dfd93e101494cbf69c04b450be446a2638b1520cd06.png
diff --git a/_images/a376b4cc6f78680b1d382adc227eefe7d32fce3a92f974f8c04f13d93042d8fd.png b/_images/a376b4cc6f78680b1d382adc227eefe7d32fce3a92f974f8c04f13d93042d8fd.png
diff --git a/...444bfc60d2bf5a11670334ad6f56ef1573937.png → ...09fe397cc26297ff4ac3a473323f04266f6bc.png b/...444bfc60d2bf5a11670334ad6f56ef1573937.png → ...09fe397cc26297ff4ac3a473323f04266f6bc.png
diff --git a/...8c99563b760ed9ee2fac406d230929e7008d0.png → ...89c58f48473c0a4e5fd63ecd164c3bd9313ef.png b/...8c99563b760ed9ee2fac406d230929e7008d0.png → ...89c58f48473c0a4e5fd63ecd164c3bd9313ef.png
diff --git a/_images/a879eb9aaf23a9c663c8c986d69b02eca0223f1f59a473333bde7c466d2b0819.png b/_images/a879eb9aaf23a9c663c8c986d69b02eca0223f1f59a473333bde7c466d2b0819.png
diff --git a/_images/b3f5baaceb7711ff5cfc050bf0390946fc99c134c20d80bfdd08ff7a5df9783d.png b/_images/b3f5baaceb7711ff5cfc050bf0390946fc99c134c20d80bfdd08ff7a5df9783d.png
diff --git a/_images/bac23226f43824f5bcde08586cd67253261b2543791554d1da7f41db77512455.png b/_images/bac23226f43824f5bcde08586cd67253261b2543791554d1da7f41db77512455.png
diff --git a/_images/bc4059d7c588d551b31c34e85dbaf851955bb387d2bca45183ec26007511f843.png b/_images/bc4059d7c588d551b31c34e85dbaf851955bb387d2bca45183ec26007511f843.png
diff --git a/...80a33bb19a478b1cc9ba958f96b569dceb833.png → ...c35fab43ea3aacc0d178b8c55bc49afe39628.png b/...80a33bb19a478b1cc9ba958f96b569dceb833.png → ...c35fab43ea3aacc0d178b8c55bc49afe39628.png
diff --git a/_images/c28acb71f810c774b67aeceb1bc6b2265c89fbc7b6eddf63b1fe8aa9d0eee2e5.png b/_images/c28acb71f810c774b67aeceb1bc6b2265c89fbc7b6eddf63b1fe8aa9d0eee2e5.png
diff --git a/_images/c34e2df0b55f832980341efe190eaa1b3d67fe32eb43eaba0c74300495b835b6.png b/_images/c34e2df0b55f832980341efe190eaa1b3d67fe32eb43eaba0c74300495b835b6.png
diff --git a/_images/c5ae18f1bbd2c9c80f59b4284e9519d6a8988d163e3a4189cf84dc5775d08b06.png b/_images/c5ae18f1bbd2c9c80f59b4284e9519d6a8988d163e3a4189cf84dc5775d08b06.png
diff --git a/_images/d86251f243541723b6f1aa1d0d385d7d9db9ea17fa25b9ebabb40496b34e3c88.png b/_images/d86251f243541723b6f1aa1d0d385d7d9db9ea17fa25b9ebabb40496b34e3c88.png
diff --git a/_images/eceacbb9cd6ae177273f26b41900536eb41224f8fdf13c8ea0c7201a66c8a7ea.png b/_images/eceacbb9cd6ae177273f26b41900536eb41224f8fdf13c8ea0c7201a66c8a7ea.png
diff --git a/...d3820d581429f18e19ee4a37406bc574d5b66.png → ...d3a8bbf0a58b145ed2b3d4769181c7dfbc0bf.png b/...d3820d581429f18e19ee4a37406bc574d5b66.png → ...d3a8bbf0a58b145ed2b3d4769181c7dfbc0bf.png
diff --git a/_images/f12acf888e54dbfa215fd1fee9e6a0ae904712b27a9ef2daaaddf10547e122ad.png b/_images/f12acf888e54dbfa215fd1fee9e6a0ae904712b27a9ef2daaaddf10547e122ad.png
diff --git a/_images/f1fa2b327ef1ce780dc6731af9f3e3524a3116d18f6ad35f51a0b7cdf8b53c1f.png b/_images/f1fa2b327ef1ce780dc6731af9f3e3524a3116d18f6ad35f51a0b7cdf8b53c1f.png
diff --git a/...70f308133f9168b0780e2fdc53eb4e0fe9f89.png → ...8429efc9ab480552923a3679e7ff0f21ffa08.png b/...70f308133f9168b0780e2fdc53eb4e0fe9f89.png → ...8429efc9ab480552923a3679e7ff0f21ffa08.png
diff --git a/...8cbd50c5bef99580ad7376eb97de9ccf385c1.png → ...715e101434ed913cd6ec590bd33344cfa519c.png b/...8cbd50c5bef99580ad7376eb97de9ccf385c1.png → ...715e101434ed913cd6ec590bd33344cfa519c.png
diff --git a/_modules/dymos/phase/analytic_phase.html b/_modules/dymos/phase/analytic_phase.html
@@ -1154,30 +1154,21 @@ <h1>Source code for dymos.phase.analytic_phase</h1><div class="highlight"><pre>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s1">&#39;Method `simulate` is not available for AnalyticPhase.&#39;</span><span class="p">)</span>
 
-    <span class="k">def</span> <span class="nf">set_simulate_options</span><span class="p">(</span><span class="bp">self</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="k">def</span> <span class="nf">set_simulate_options</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Stub to make sure users are informed that simulate cannot be done on AnalyticPhase.</span>
 
 <span class="sd">        Parameters</span>
 <span class="sd">        ----------</span>
-<span class="sd">        method : str</span>
-<span class="sd">            The scipy.integrate.solve_ivp integration method.</span>
-<span class="sd">        atol : float</span>
-<span class="sd">            Absolute convergence tolerance for scipy.integrate.solve_ivp.</span>
-<span class="sd">        rtol : float</span>
-<span class="sd">            Relative convergence tolerance for scipy.integrate.solve_ivp.</span>
-<span class="sd">        first_step : float</span>
-<span class="sd">            Initial step size for the integration.</span>
-<span class="sd">        max_step : float</span>
-<span class="sd">            Maximum step size for the integration.</span>
-
-<span class="sd">        Returns</span>
-<span class="sd">        -------</span>
-<span class="sd">        problem</span>
-<span class="sd">            An OpenMDAO Problem in which the simulation is implemented.  This Problem interface</span>
-<span class="sd">            can be interrogated to obtain timeseries outputs in the same manner as other Phases</span>
-<span class="sd">            to obtain results at the requested times.</span>
+<span class="sd">        *args</span>
+<span class="sd">            Position arguments.</span>
+<span class="sd">        **kwargs : float</span>
+<span class="sd">            Keyword arguments.</span>
+
+<span class="sd">        Raises</span>
+<span class="sd">        ------</span>
+<span class="sd">        NotImplementedError</span>
+<span class="sd">            Simulation cannot be performed on AnalyticPhase.</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s1">&#39;Method set_simulate_options is not available for AnalyticPhase.&#39;</span><span class="p">)</span>
 </pre></div>

diff --git a/_modules/dymos/phase/phase.html b/_modules/dymos/phase/phase.html
diff --git a/_modules/dymos/run_problem.html b/_modules/dymos/run_problem.html
@@ -774,8 +774,7 @@ <h1>Source code for dymos.run_problem</h1><div class="highlight"><pre>
     <span class="k">if</span> <span class="n">solution_record_file</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">[</span><span class="n">rec</span><span class="o">.</span><span class="n">_filepath</span> <span class="k">for</span> <span class="n">rec</span> <span class="ow">in</span> <span class="nb">iter</span><span class="p">(</span><span class="n">problem</span><span class="o">.</span><span class="n">_rec_mgr</span><span class="p">)]:</span>
         <span class="n">recorder</span> <span class="o">=</span> <span class="n">om</span><span class="o">.</span><span class="n">SqliteRecorder</span><span class="p">(</span><span class="n">solution_record_file</span><span class="p">)</span>
         <span class="n">problem</span><span class="o">.</span><span class="n">add_recorder</span><span class="p">(</span><span class="n">recorder</span><span class="p">)</span>
-        <span class="c1"># record_inputs is needed to capture potential input parameters that aren&#39;t connected</span>
-        <span class="n">problem</span><span class="o">.</span><span class="n">recording_options</span><span class="p">[</span><span class="s1">&#39;record_inputs&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>
+
         <span class="c1"># record_outputs is need to capture the timeseries outputs</span>
         <span class="n">problem</span><span class="o">.</span><span class="n">recording_options</span><span class="p">[</span><span class="s1">&#39;record_outputs&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span>