Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Unknown committed Jun 26, 2024
1 parent 2434e5d commit 94bd110
Show file tree
Hide file tree
Showing 202 changed files with 3,013 additions and 3,068 deletions.
62 changes: 0 additions & 62 deletions _modules/dymos/phase/analytic_phase.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -984,65 +984,6 @@ <h1>Source code for dymos.phase.analytic_phase</h1><div class="highlight"><pre>
<span class="sd"> For a polynomial control of a given order, the number of nodes used to define the</span>
<span class="sd"> polynomial is (order + 1).</span>

<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> name : str</span>
<span class="sd"> Name of the controllable parameter in the ODE.</span>
<span class="sd"> order : int</span>
<span class="sd"> The order of the interpolating polynomial used to represent the control value in</span>
<span class="sd"> phase tau space.</span>
<span class="sd"> desc : str</span>
<span class="sd"> A description of the polynomial control.</span>
<span class="sd"> val : float or ndarray</span>
<span class="sd"> Default value of the control at all nodes. If val scalar and the control</span>
<span class="sd"> is dynamic it will be broadcast.</span>
<span class="sd"> units : str or None or 0</span>
<span class="sd"> Units in which the control variable is defined. If 0, use the units declared</span>
<span class="sd"> for the parameter in the ODE.</span>
<span class="sd"> opt : bool</span>
<span class="sd"> If True (default) the value(s) of this control will be design variables in</span>
<span class="sd"> the optimization problem, in the path &#39;phase_name.indep_controls.controls:control_name&#39;.</span>
<span class="sd"> If False, the values of this control will exist as input controls:{name}.</span>
<span class="sd"> fix_initial : bool</span>
<span class="sd"> If True, the given initial value of the polynomial control is not a design variable and</span>
<span class="sd"> will not be changed during the optimization.</span>
<span class="sd"> fix_final : bool</span>
<span class="sd"> If True, the given final value of the polynomial control is not a design variable and</span>
<span class="sd"> will not be changed during the optimization.</span>
<span class="sd"> lower : float or ndarray</span>
<span class="sd"> The lower bound of the control at the nodes of the phase.</span>
<span class="sd"> upper : float or ndarray</span>
<span class="sd"> The upper bound of the control at the nodes of the phase.</span>
<span class="sd"> scaler : float or ndarray</span>
<span class="sd"> The scaler of the control value at the nodes of the phase.</span>
<span class="sd"> adder : float or ndarray</span>
<span class="sd"> The adder of the control value at the nodes of the phase.</span>
<span class="sd"> ref0 : float or ndarray</span>
<span class="sd"> The zero-reference value of the control at the nodes of the phase.</span>
<span class="sd"> ref : float or ndarray</span>
<span class="sd"> The unit-reference value of the control at the nodes of the phase.</span>
<span class="sd"> targets : Sequence of str or None</span>
<span class="sd"> Targets in the ODE to which this polynomial control is connected.</span>
<span class="sd"> rate_targets : None or str</span>
<span class="sd"> The name of the parameter in the ODE to which the first time-derivative</span>
<span class="sd"> of the control value is connected.</span>
<span class="sd"> rate2_targets : None or str</span>
<span class="sd"> The name of the parameter in the ODE to which the second time-derivative</span>
<span class="sd"> of the control value is connected.</span>
<span class="sd"> shape : Sequence of int</span>
<span class="sd"> The shape of the control variable at each point in time.</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;AnalyticPhase does not support polynomial controls.&#39;</span><span class="p">)</span>

<span class="k">def</span> <span class="nf">set_polynomial_control_options</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">order</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">desc</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">val</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span>
<span class="n">units</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">opt</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">fix_initial</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span>
<span class="n">fix_final</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">lower</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">upper</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span>
<span class="n">scaler</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">adder</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">ref0</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span>
<span class="n">ref</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">targets</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">rate_targets</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span>
<span class="n">rate2_targets</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">,</span> <span class="n">shape</span><span class="o">=</span><span class="n">_unspecified</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Set options on an existing polynomial control variable in the phase.</span>

<span class="sd"> Parameters</span>
<span class="sd"> ----------</span>
<span class="sd"> name : str</span>
Expand Down Expand Up @@ -1105,9 +1046,6 @@ <h1>Source code for dymos.phase.analytic_phase</h1><div class="highlight"><pre>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">control_options</span><span class="p">:</span>
<span class="n">transcription</span><span class="o">.</span><span class="n">setup_controls</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>

<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">polynomial_control_options</span><span class="p">:</span>
<span class="n">transcription</span><span class="o">.</span><span class="n">setup_polynomial_controls</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>

<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">parameter_options</span><span class="p">:</span>
<span class="n">transcription</span><span class="o">.</span><span class="n">setup_parameters</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>

Expand Down
Loading

0 comments on commit 94bd110

Please sign in to comment.