Skip to content

Commit 2d322b7

Browse files
1 parent 59335fd commit 2d322b7

8 files changed

+11
-9
lines changed

doxygen_cxx/annotated.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1086,7 +1086,7 @@
10861086
<tr id="row_0_16_87_" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classdrake_1_1systems_1_1_random_source.html" target="_self">RandomSource</a></td><td class="desc">A source block which generates random numbers at a fixed sampling interval, with a zero-order hold between samples </td></tr>
10871087
<tr id="row_0_16_88_" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classdrake_1_1systems_1_1_runge_kutta2_integrator.html" target="_self">RungeKutta2Integrator</a></td><td class="desc">A second-order, explicit Runge Kutta integrator </td></tr>
10881088
<tr id="row_0_16_89_" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classdrake_1_1systems_1_1_runge_kutta3_integrator.html" target="_self">RungeKutta3Integrator</a></td><td class="desc">A third-order Runge Kutta integrator with a third order error estimate </td></tr>
1089-
<tr id="row_0_16_90_" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classdrake_1_1systems_1_1_runge_kutta5_integrator.html" target="_self">RungeKutta5Integrator</a></td><td class="desc">A fifth-order, seven-stage, first-same-as-last (FSAL) Runge Kutta integrator with a fourth order error estimate </td></tr>
1089+
<tr id="row_0_16_90_" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classdrake_1_1systems_1_1_runge_kutta5_integrator.html" target="_self">RungeKutta5Integrator</a></td><td class="desc">A fifth-order, seven-stage, first-same-as-last (FSAL) Runge Kutta integrator with a fifth order error estimate </td></tr>
10901090
<tr id="row_0_16_91_" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classdrake_1_1systems_1_1_saturation.html" target="_self">Saturation</a></td><td class="desc">An element-wise hard saturation block with inputs signal <code>u</code>, saturation values \( u_{min} \) and/or \( u_{max} \), and output <code>y</code> respectively as in: </td></tr>
10911091
<tr id="row_0_16_92_" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classdrake_1_1systems_1_1_scalar_dense_output.html" target="_self">ScalarDenseOutput</a></td><td class="desc">A <a class="el" href="classdrake_1_1systems_1_1_dense_output.html" title="An interface for dense output of ODE solutions, to efficiently approximate them at arbitrarily many p...">DenseOutput</a> class interface extension to deal with scalar ODE solutions </td></tr>
10921092
<tr id="row_0_16_93_" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classdrake_1_1systems_1_1_scalar_initial_value_problem.html" target="_self">ScalarInitialValueProblem</a></td><td class="desc">A thin wrapper of the <a class="el" href="classdrake_1_1systems_1_1_initial_value_problem.html" title="A general initial value problem (or IVP) representation class, that allows evaluating the 𝐱(t; 𝐤) sol...">InitialValueProblem</a> class to provide a simple interface when solving scalar initial value problems i.e </td></tr>

doxygen_cxx/classdrake_1_1systems_1_1_integrator_base.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1182,7 +1182,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab09a2cc2db0a776ca7bb11c8
11821182
e = (y̅ - ŷ) = O(h²)
11831183
</pre><p>If the integrator does not provide an error estimate, the derived class implementation should return 0. </p>
11841184

1185-
<p>Implemented in <a class="el" href="classdrake_1_1systems_1_1_velocity_implicit_euler_integrator.html#a447328b1aaa3ed12450855b792983d24">VelocityImplicitEulerIntegrator&lt; T &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_implicit_euler_integrator.html#a447328b1aaa3ed12450855b792983d24">ImplicitEulerIntegrator&lt; T &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_semi_explicit_euler_integrator.html#a7932e0cc0f116b8a625cb025616d73ab">SemiExplicitEulerIntegrator&lt; T &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_radau_integrator.html#a447328b1aaa3ed12450855b792983d24">RadauIntegrator&lt; T, num_stages &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_runge_kutta3_integrator.html#a7932e0cc0f116b8a625cb025616d73ab">RungeKutta3Integrator&lt; T &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_runge_kutta5_integrator.html#a7932e0cc0f116b8a625cb025616d73ab">RungeKutta5Integrator&lt; T &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_bogacki_shampine3_integrator.html#a7932e0cc0f116b8a625cb025616d73ab">BogackiShampine3Integrator&lt; T &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_explicit_euler_integrator.html#a7932e0cc0f116b8a625cb025616d73ab">ExplicitEulerIntegrator&lt; T &gt;</a>, and <a class="el" href="classdrake_1_1systems_1_1_runge_kutta2_integrator.html#a7932e0cc0f116b8a625cb025616d73ab">RungeKutta2Integrator&lt; T &gt;</a>.</p>
1185+
<p>Implemented in <a class="el" href="classdrake_1_1systems_1_1_velocity_implicit_euler_integrator.html#a447328b1aaa3ed12450855b792983d24">VelocityImplicitEulerIntegrator&lt; T &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_implicit_euler_integrator.html#a447328b1aaa3ed12450855b792983d24">ImplicitEulerIntegrator&lt; T &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_semi_explicit_euler_integrator.html#a7932e0cc0f116b8a625cb025616d73ab">SemiExplicitEulerIntegrator&lt; T &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_radau_integrator.html#a447328b1aaa3ed12450855b792983d24">RadauIntegrator&lt; T, num_stages &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_runge_kutta5_integrator.html#a7932e0cc0f116b8a625cb025616d73ab">RungeKutta5Integrator&lt; T &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_runge_kutta3_integrator.html#a7932e0cc0f116b8a625cb025616d73ab">RungeKutta3Integrator&lt; T &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_bogacki_shampine3_integrator.html#a7932e0cc0f116b8a625cb025616d73ab">BogackiShampine3Integrator&lt; T &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_explicit_euler_integrator.html#a7932e0cc0f116b8a625cb025616d73ab">ExplicitEulerIntegrator&lt; T &gt;</a>, and <a class="el" href="classdrake_1_1systems_1_1_runge_kutta2_integrator.html#a7932e0cc0f116b8a625cb025616d73ab">RungeKutta2Integrator&lt; T &gt;</a>.</p>
11861186

11871187
</div>
11881188
</div>
@@ -2437,7 +2437,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a5fa66573f5abb1dc153098d2
24372437
<p>Derived classes must override this function to indicate whether the integrator supports error estimation. </p>
24382438
<p>Without error estimation, the target accuracy setting (see <a class="el" href="classdrake_1_1systems_1_1_integrator_base.html#integrator-accuracy">accuracy settings</a>) will be unused. </p>
24392439

2440-
<p>Implemented in <a class="el" href="classdrake_1_1systems_1_1_velocity_implicit_euler_integrator.html#acd7fceaaf1d3c2b328b675c8d911f450">VelocityImplicitEulerIntegrator&lt; T &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_implicit_euler_integrator.html#acd7fceaaf1d3c2b328b675c8d911f450">ImplicitEulerIntegrator&lt; T &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_semi_explicit_euler_integrator.html#a52ddb8ce13134e8e8afdfcfde6fd75ec">SemiExplicitEulerIntegrator&lt; T &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_radau_integrator.html#acd7fceaaf1d3c2b328b675c8d911f450">RadauIntegrator&lt; T, num_stages &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_runge_kutta3_integrator.html#a52ddb8ce13134e8e8afdfcfde6fd75ec">RungeKutta3Integrator&lt; T &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_runge_kutta5_integrator.html#a52ddb8ce13134e8e8afdfcfde6fd75ec">RungeKutta5Integrator&lt; T &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_bogacki_shampine3_integrator.html#a52ddb8ce13134e8e8afdfcfde6fd75ec">BogackiShampine3Integrator&lt; T &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_explicit_euler_integrator.html#a52ddb8ce13134e8e8afdfcfde6fd75ec">ExplicitEulerIntegrator&lt; T &gt;</a>, and <a class="el" href="classdrake_1_1systems_1_1_runge_kutta2_integrator.html#a52ddb8ce13134e8e8afdfcfde6fd75ec">RungeKutta2Integrator&lt; T &gt;</a>.</p>
2440+
<p>Implemented in <a class="el" href="classdrake_1_1systems_1_1_velocity_implicit_euler_integrator.html#acd7fceaaf1d3c2b328b675c8d911f450">VelocityImplicitEulerIntegrator&lt; T &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_implicit_euler_integrator.html#acd7fceaaf1d3c2b328b675c8d911f450">ImplicitEulerIntegrator&lt; T &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_semi_explicit_euler_integrator.html#a52ddb8ce13134e8e8afdfcfde6fd75ec">SemiExplicitEulerIntegrator&lt; T &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_runge_kutta5_integrator.html#a52ddb8ce13134e8e8afdfcfde6fd75ec">RungeKutta5Integrator&lt; T &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_radau_integrator.html#acd7fceaaf1d3c2b328b675c8d911f450">RadauIntegrator&lt; T, num_stages &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_runge_kutta3_integrator.html#a52ddb8ce13134e8e8afdfcfde6fd75ec">RungeKutta3Integrator&lt; T &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_bogacki_shampine3_integrator.html#a52ddb8ce13134e8e8afdfcfde6fd75ec">BogackiShampine3Integrator&lt; T &gt;</a>, <a class="el" href="classdrake_1_1systems_1_1_explicit_euler_integrator.html#a52ddb8ce13134e8e8afdfcfde6fd75ec">ExplicitEulerIntegrator&lt; T &gt;</a>, and <a class="el" href="classdrake_1_1systems_1_1_runge_kutta2_integrator.html#a52ddb8ce13134e8e8afdfcfde6fd75ec">RungeKutta2Integrator&lt; T &gt;</a>.</p>
24412441

24422442
</div>
24432443
</div>

doxygen_cxx/classdrake_1_1systems_1_1_runge_kutta5_integrator.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,8 @@
169169
<div class="textblock"><h3>template&lt;typename T&gt;<br />
170170
class drake::systems::RungeKutta5Integrator&lt; T &gt;</h3>
171171

172-
<p>A fifth-order, seven-stage, first-same-as-last (FSAL) Runge Kutta integrator with a fourth order error estimate. </p>
172+
<p>A fifth-order, seven-stage, first-same-as-last (FSAL) Runge Kutta integrator with a fifth order error estimate. </p>
173+
<p>Specifically, this is an explicit Runge-Kutta method of order 5(4), where the higher order estimate is meant to be propagated (unlike the Fehlberg 4(5) method, where the 4th order solution is meant to be propagated).</p>
173174
<p>For a discussion of this Runge-Kutta method, see [Dormand, 1980] and [Hairer, 1993]. The embedded error estimate was derived as described in [Hairer, 1993], where all the coefficients are tabulated.</p>
174175
<p>The Butcher tableau for this integrator follows: </p><pre>
175176
0 |
@@ -187,6 +188,7 @@
187188
<li>[Dormand, 1980] J. Dormand and P. Prince. "A family of embedded
188189
Runge-Kutta formulae", Journal of Computational and Applied Mathematics, 1980, 6(1): 19–26.</li>
189190
<li>[Hairer, 1993] E. Hairer, S. Nørsett, and G. Wanner. Solving ODEs I. 2nd rev. ed. Springer, 1993. pp. 178-9.</li>
191+
<li>[Fehlberg, 1969] E. Fehlberg. Low-order classical Runge-Kutta formulas with stepsize control and their application to some heat transfer problems (Vol. 315). National aeronautics and space administration, 1969.</li>
190192
</ul>
191193
<dl class="tparams"><dt>Template Parameters</dt><dd>
192194
<table class="tparams">

doxygen_cxx/group__integrators.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ <h1><a class="anchor" id="references"></a>
208208
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A third-order Runge Kutta integrator with a third order error estimate. <a href="classdrake_1_1systems_1_1_runge_kutta3_integrator.html#details">More...</a><br /></td></tr>
209209
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
210210
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1systems_1_1_runge_kutta5_integrator.html">RungeKutta5Integrator&lt; T &gt;</a></td></tr>
211-
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A fifth-order, seven-stage, first-same-as-last (FSAL) Runge Kutta integrator with a fourth order error estimate. <a href="classdrake_1_1systems_1_1_runge_kutta5_integrator.html#details">More...</a><br /></td></tr>
211+
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A fifth-order, seven-stage, first-same-as-last (FSAL) Runge Kutta integrator with a fifth order error estimate. <a href="classdrake_1_1systems_1_1_runge_kutta5_integrator.html#details">More...</a><br /></td></tr>
212212
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
213213
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1systems_1_1_semi_explicit_euler_integrator.html">SemiExplicitEulerIntegrator&lt; T &gt;</a></td></tr>
214214
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A first-order, semi-explicit Euler integrator. <a href="classdrake_1_1systems_1_1_semi_explicit_euler_integrator.html#details">More...</a><br /></td></tr>

doxygen_cxx/hierarchy.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -696,7 +696,7 @@
696696
<tr id="row_289_2_2_" class="even" style="display:none;"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classdrake_1_1systems_1_1_velocity_implicit_euler_integrator.html" target="_self">VelocityImplicitEulerIntegrator&lt; T &gt;</a></td><td class="desc">A first-order, fully implicit integrator optimized for second-order systems, with a second-order error estimate </td></tr>
697697
<tr id="row_289_3_" class="even" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classdrake_1_1systems_1_1_runge_kutta2_integrator.html" target="_self">RungeKutta2Integrator&lt; T &gt;</a></td><td class="desc">A second-order, explicit Runge Kutta integrator </td></tr>
698698
<tr id="row_289_4_" class="even" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classdrake_1_1systems_1_1_runge_kutta3_integrator.html" target="_self">RungeKutta3Integrator&lt; T &gt;</a></td><td class="desc">A third-order Runge Kutta integrator with a third order error estimate </td></tr>
699-
<tr id="row_289_5_" class="even" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classdrake_1_1systems_1_1_runge_kutta5_integrator.html" target="_self">RungeKutta5Integrator&lt; T &gt;</a></td><td class="desc">A fifth-order, seven-stage, first-same-as-last (FSAL) Runge Kutta integrator with a fourth order error estimate </td></tr>
699+
<tr id="row_289_5_" class="even" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classdrake_1_1systems_1_1_runge_kutta5_integrator.html" target="_self">RungeKutta5Integrator&lt; T &gt;</a></td><td class="desc">A fifth-order, seven-stage, first-same-as-last (FSAL) Runge Kutta integrator with a fifth order error estimate </td></tr>
700700
<tr id="row_289_6_" class="even" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classdrake_1_1systems_1_1_semi_explicit_euler_integrator.html" target="_self">SemiExplicitEulerIntegrator&lt; T &gt;</a></td><td class="desc">A first-order, semi-explicit Euler integrator </td></tr>
701701
<tr id="row_290_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classdrake_1_1systems_1_1_integrator_base.html" target="_self">IntegratorBase&lt; AutoDiffXd &gt;</a></td><td class="desc"></td></tr>
702702
<tr id="row_291_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classdrake_1_1systems_1_1_integrator_base.html" target="_self">IntegratorBase&lt; double &gt;</a></td><td class="desc"></td></tr>

doxygen_cxx/inherit_graph_306.svg

Lines changed: 1 addition & 1 deletion
Loading

doxygen_cxx/namespacedrake_1_1systems.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -440,7 +440,7 @@
440440
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A third-order Runge Kutta integrator with a third order error estimate. <a href="classdrake_1_1systems_1_1_runge_kutta3_integrator.html#details">More...</a><br /></td></tr>
441441
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
442442
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1systems_1_1_runge_kutta5_integrator.html">RungeKutta5Integrator</a></td></tr>
443-
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A fifth-order, seven-stage, first-same-as-last (FSAL) Runge Kutta integrator with a fourth order error estimate. <a href="classdrake_1_1systems_1_1_runge_kutta5_integrator.html#details">More...</a><br /></td></tr>
443+
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A fifth-order, seven-stage, first-same-as-last (FSAL) Runge Kutta integrator with a fifth order error estimate. <a href="classdrake_1_1systems_1_1_runge_kutta5_integrator.html#details">More...</a><br /></td></tr>
444444
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
445445
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdrake_1_1systems_1_1_saturation.html">Saturation</a></td></tr>
446446
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An element-wise hard saturation block with inputs signal <code>u</code>, saturation values \( u_{min} \) and/or \( u_{max} \), and output <code>y</code> respectively as in: <a href="classdrake_1_1systems_1_1_saturation.html#details">More...</a><br /></td></tr>

0 commit comments

Comments
 (0)