Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Unknown committed Nov 4, 2024
1 parent 2858232 commit a2f7806
Show file tree
Hide file tree
Showing 43 changed files with 745 additions and 754 deletions.
11 changes: 2 additions & 9 deletions _modules/dymos/trajectory/trajectory.html
Original file line number Diff line number Diff line change
Expand Up @@ -705,7 +705,6 @@ <h1>Source code for dymos.trajectory.trajectory</h1><div class="highlight"><pre>
<span class="kn">import</span> <span class="nn">sys</span>

<span class="kn">from</span> <span class="nn">openmdao.utils.om_warnings</span> <span class="kn">import</span> <span class="n">warn_deprecation</span>
<span class="kn">from</span> <span class="nn">openmdao.utils.graph_utils</span> <span class="kn">import</span> <span class="n">get_sccs_topo</span>
<span class="kn">from</span> <span class="nn">openmdao.utils.units</span> <span class="kn">import</span> <span class="n">unit_conversion</span>

<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
Expand Down Expand Up @@ -1411,8 +1410,9 @@ <h1>Source code for dymos.trajectory.trajectory</h1><div class="highlight"><pre>
<span class="n">var_pair</span> <span class="o">=</span> <span class="p">(</span><span class="s1">&#39;*&#39;</span><span class="p">,</span> <span class="s1">&#39;*&#39;</span><span class="p">)</span>
<span class="k">if</span> <span class="n">var_pair</span> <span class="ow">in</span> <span class="n">var_dict</span><span class="p">:</span>
<span class="n">options</span> <span class="o">=</span> <span class="n">var_dict</span><span class="p">[</span><span class="n">var_pair</span><span class="p">]</span>
<span class="n">time_name</span> <span class="o">=</span> <span class="n">phase_b</span><span class="o">.</span><span class="n">time_options</span><span class="p">[</span><span class="s1">&#39;name&#39;</span><span class="p">]</span>
<span class="bp">self</span><span class="o">.</span><span class="n">add_linkage_constraint</span><span class="p">(</span><span class="n">phase_name_a</span><span class="p">,</span> <span class="n">phase_name_b</span><span class="p">,</span>
<span class="n">var_a</span><span class="o">=</span><span class="s1">&#39;time&#39;</span><span class="p">,</span> <span class="n">var_b</span><span class="o">=</span><span class="s1">&#39;time&#39;</span><span class="p">,</span>
<span class="n">var_a</span><span class="o">=</span><span class="n">time_name</span><span class="p">,</span> <span class="n">var_b</span><span class="o">=</span><span class="n">time_name</span><span class="p">,</span>
<span class="n">loc_a</span><span class="o">=</span><span class="n">options</span><span class="p">[</span><span class="s1">&#39;loc_a&#39;</span><span class="p">],</span> <span class="n">loc_b</span><span class="o">=</span><span class="n">options</span><span class="p">[</span><span class="s1">&#39;loc_b&#39;</span><span class="p">],</span>
<span class="n">mult_a</span><span class="o">=</span><span class="n">options</span><span class="p">[</span><span class="s1">&#39;mult_a&#39;</span><span class="p">],</span> <span class="n">mult_b</span><span class="o">=</span><span class="n">options</span><span class="p">[</span><span class="s1">&#39;mult_b&#39;</span><span class="p">],</span>
<span class="n">connected</span><span class="o">=</span><span class="n">options</span><span class="p">[</span><span class="s1">&#39;connected&#39;</span><span class="p">])</span>
Expand Down Expand Up @@ -1681,13 +1681,6 @@ <h1>Source code for dymos.trajectory.trajectory</h1><div class="highlight"><pre>

<span class="n">phase_graph</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_phase_graph</span>

<span class="c1"># since we have a graph, do a quick check that we have no cycles</span>
<span class="n">sccs</span> <span class="o">=</span> <span class="n">get_sccs_topo</span><span class="p">(</span><span class="n">phase_graph</span><span class="p">)</span>
<span class="n">cycles</span> <span class="o">=</span> <span class="nb">sorted</span><span class="p">([</span><span class="n">s</span> <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="n">sccs</span> <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">s</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">],</span> <span class="n">key</span><span class="o">=</span><span class="k">lambda</span> <span class="n">x</span><span class="p">:</span> <span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">))</span>
<span class="k">if</span> <span class="n">cycles</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">msginfo</span><span class="si">}</span><span class="s2">: The following cycles were found in the phase &quot;</span>
<span class="sa">f</span><span class="s2">&quot;linkage graph: </span><span class="si">{</span><span class="p">[</span><span class="nb">sorted</span><span class="p">(</span><span class="n">c</span><span class="p">)</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">c</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">cycles</span><span class="p">]</span><span class="si">}</span><span class="s2">.&quot;</span><span class="p">)</span>

<span class="n">node_data</span> <span class="o">=</span> <span class="n">phase_graph</span><span class="o">.</span><span class="n">nodes</span><span class="p">(</span><span class="n">data</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>

<span class="c1"># only keep the part of the graph where &#39;t&#39; connects phases</span>
Expand Down
16 changes: 8 additions & 8 deletions contributing/contributing.html
Original file line number Diff line number Diff line change
Expand Up @@ -1055,21 +1055,21 @@ <h2>Notebook Creation<a class="headerlink" href="#notebook-creation" title="Perm
+-----------------+------------------+-------------+-------------+-------------+-------------+------------+
| of &#39;&lt;variable&gt;&#39; | wrt &#39;&lt;variable&gt;&#39; | calc mag. | check mag. | a(cal-chk) | r(cal-chk) | error desc |
+=================+==================+=============+=============+=============+=============+============+
| &#39;check&#39; | &#39;theta&#39; | 1.5121e+01 | 1.5121e+01 | 2.0592e-15 | 1.3618e-16 | |
| &#39;check&#39; | &#39;theta&#39; | 2.5200e+04 | 2.5200e+04 | 2.8422e-14 | 1.1278e-18 | |
+-----------------+------------------+-------------+-------------+-------------+-------------+------------+
| &#39;check&#39; | &#39;v&#39; | 3.2006e+00 | 3.2006e+00 | 2.2204e-16 | 6.9376e-17 | |
| &#39;check&#39; | &#39;v&#39; | 5.7293e+01 | 5.7293e+01 | 8.8818e-16 | 1.5502e-17 | |
+-----------------+------------------+-------------+-------------+-------------+-------------+------------+
| &#39;vdot&#39; | &#39;theta&#39; | 1.7559e+01 | 1.7559e+01 | 2.5121e-15 | 1.4307e-16 | |
| &#39;vdot&#39; | &#39;theta&#39; | 9.3953e+00 | 9.3953e+00 | 1.2561e-15 | 1.3369e-16 | |
+-----------------+------------------+-------------+-------------+-------------+-------------+------------+
| &#39;vdot&#39; | &#39;v&#39; | 0.0000e+00 | 0.0000e+00 | 0.0000e+00 | nan | |
+-----------------+------------------+-------------+-------------+-------------+-------------+------------+
| &#39;xdot&#39; | &#39;theta&#39; | 6.2216e+00 | 6.2216e+00 | 0.0000e+00 | 0.0000e+00 | |
| &#39;xdot&#39; | &#39;theta&#39; | 1.3999e+01 | 1.3999e+01 | 2.4825e-16 | 1.7734e-17 | |
+-----------------+------------------+-------------+-------------+-------------+-------------+------------+
| &#39;xdot&#39; | &#39;v&#39; | 1.7905e+00 | 1.7905e+00 | 0.0000e+00 | 0.0000e+00 | |
| &#39;xdot&#39; | &#39;v&#39; | 9.5805e-01 | 9.5805e-01 | 0.0000e+00 | 0.0000e+00 | |
+-----------------+------------------+-------------+-------------+-------------+-------------+------------+
| &#39;ydot&#39; | &#39;theta&#39; | 1.2071e+01 | 1.2071e+01 | 4.4409e-16 | 3.6789e-17 | |
| &#39;ydot&#39; | &#39;theta&#39; | 4.2202e+00 | 4.2202e+00 | 2.4825e-16 | 5.8825e-17 | |
+-----------------+------------------+-------------+-------------+-------------+-------------+------------+
| &#39;ydot&#39; | &#39;v&#39; | 1.3394e+00 | 1.3394e+00 | 1.1444e-16 | 8.5439e-17 | |
| &#39;ydot&#39; | &#39;v&#39; | 2.0204e+00 | 2.0204e+00 | 0.0000e+00 | 0.0000e+00 | |
+-----------------+------------------+-------------+-------------+-------------+-------------+------------+

##################################################################
Expand All @@ -1078,7 +1078,7 @@ <h2>Notebook Creation<a class="headerlink" href="#notebook-creation" title="Perm
+-----------------+------------------+-------------+-------------+-------------+-------------+
| of &#39;&lt;variable&gt;&#39; | wrt &#39;&lt;variable&gt;&#39; | calc mag. | check mag. | a(cal-chk) | r(cal-chk) |
+=================+==================+=============+=============+=============+=============+
| &#39;vdot&#39; | &#39;theta&#39; | 1.7559e+01 | 1.7559e+01 | 2.5121e-15 | 1.4307e-16 |
| &#39;vdot&#39; | &#39;theta&#39; | 9.3953e+00 | 9.3953e+00 | 1.2561e-15 | 1.3369e-16 |
+-----------------+------------------+-------------+-------------+-------------+-------------+
</pre></div>
</div>
Expand Down
Loading

0 comments on commit a2f7806

Please sign in to comment.