Skip to content

Commit db4b9d1

Browse files
Update documentation
1 parent 3ebeae1 commit db4b9d1

File tree

73 files changed

+3156
-1362
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+3156
-1362
lines changed

doc/html/annotated.html

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -114,12 +114,14 @@
114114
<tr id="row_0_11_" class="even"><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="interfaceintegral__core_1_1ode__fcn.html" target="_self">ode_fcn</a></td><td class="desc">Defines a routine containing a system of first order ODEs </td></tr>
115115
<tr id="row_0_12_"><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="structintegral__core_1_1ode__helper.html" target="_self">ode_helper</a></td><td class="desc">Defines a type used to pass information regarding the ODEs to the solver </td></tr>
116116
<tr id="row_0_13_" class="even"><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="structintegral__core_1_1ode__integrator.html" target="_self">ode_integrator</a></td><td class="desc"></td></tr>
117-
<tr id="row_0_14_"><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="interfaceintegral__core_1_1ode__integrator__interface.html" target="_self">ode_integrator_interface</a></td><td class="desc">Defines a routine for computing a single integration step in the direction of <code>xout</code> </td></tr>
118-
<tr id="row_0_15_" class="even"><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="interfaceintegral__core_1_1ode__integrator__reset.html" target="_self">ode_integrator_reset</a></td><td class="desc">Resets the state of the integrator </td></tr>
119-
<tr id="row_0_16_"><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="structintegral__core_1_1ode__irk.html" target="_self">ode_irk</a></td><td class="desc">Defines an integrator for systems of first order ODEs that is capable of solving the system of equations M * Y' = F(X, Y). This system can be linearly implicit, or explicit. The method utilized is an implicit Runge-Kutta method of order 5. <br />
117+
<tr id="row_0_14_"><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="structintegral__core_1_1ode__integrator2.html" target="_self">ode_integrator2</a></td><td class="desc">This class is an extension of the <a class="el" href="structintegral__core_1_1ode__integrator.html">ode_integrator</a> type, but tailored to support the Fortran libraries that require subroutine support to collect output from the integrator (e.g. RADAU5, DOPRI5, etc.) </td></tr>
118+
<tr id="row_0_15_" class="even"><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="interfaceintegral__core_1_1ode__integrator__interface.html" target="_self">ode_integrator_interface</a></td><td class="desc">Defines a routine for computing a single integration step in the direction of <code>xout</code> </td></tr>
119+
<tr id="row_0_16_"><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="interfaceintegral__core_1_1ode__integrator__reset.html" target="_self">ode_integrator_reset</a></td><td class="desc">Resets the state of the integrator </td></tr>
120+
<tr id="row_0_17_" class="even"><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="structintegral__core_1_1ode__irk.html" target="_self">ode_irk</a></td><td class="desc">Defines an integrator for systems of first order ODEs that is capable of solving the system of equations M * Y' = F(X, Y). This system can be linearly implicit, or explicit. The method utilized is an implicit Runge-Kutta method of order 5. <br />
120121
</td></tr>
121-
<tr id="row_0_17_" class="even"><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="interfaceintegral__core_1_1ode__jacobian.html" target="_self">ode_jacobian</a></td><td class="desc">Defines a routine capable of computing the Jacobian matrix of a system of N first order ODEs of N variables </td></tr>
122-
<tr id="row_0_18_"><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="interfaceintegral__core_1_1ode__mass.html" target="_self">ode_mass</a></td><td class="desc">Defines a routine capable of computing the mass matrix of a system of ODE's expressed as M * Y' = F(X, Y) where M is the mass matrix </td></tr>
122+
<tr id="row_0_18_"><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="interfaceintegral__core_1_1ode__jacobian.html" target="_self">ode_jacobian</a></td><td class="desc">Defines a routine capable of computing the Jacobian matrix of a system of N first order ODEs of N variables </td></tr>
123+
<tr id="row_0_19_" class="even"><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="interfaceintegral__core_1_1ode__mass.html" target="_self">ode_mass</a></td><td class="desc">Defines a routine capable of computing the mass matrix of a system of ODE's expressed as M * Y' = F(X, Y) where M is the mass matrix </td></tr>
124+
<tr id="row_0_20_"><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="structintegral__core_1_1ode__rk45.html" target="_self">ode_rk45</a></td><td class="desc">Defines a Runge-Kutta integrator based upon the 4th/5th order Dormand-Prince formulation. This integrator solves the system of equations Y' = F(X, Y), and is best suited for non-stiff problems </td></tr>
123125
</table>
124126
</div><!-- directory -->
125127
</div><!-- contents -->

doc/html/classes.html

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -101,40 +101,44 @@
101101
<table class="classindex">
102102
<tr><td rowspan="2" valign="bottom"><a name="letter_a"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;a&#160;&#160;</div></td></tr></table>
103103
</td>
104-
<td valign="top"><a class="el" href="structintegral__core_1_1finite__interval__integrator.html">finite_interval_integrator</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
105-
<td valign="top"><a class="el" href="structintegral__core_1_1integrator__base.html">integrator_base</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
106-
<td valign="top"><a class="el" href="interfaceintegral__core_1_1ode__collect__results.html">ode_collect_results</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
107-
<td valign="top"><a class="el" href="interfaceintegral__core_1_1ode__integrator__reset.html">ode_integrator_reset</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
108-
</tr>
109-
<tr><td rowspan="2" valign="bottom"><a name="letter_i"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;i&#160;&#160;</div></td></tr></table>
104+
<td rowspan="2" valign="bottom"><a name="letter_i"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;i&#160;&#160;</div></td></tr></table>
110105
</td>
111-
<td rowspan="2" valign="bottom"><a name="letter_n"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;n&#160;&#160;</div></td></tr></table>
106+
<td rowspan="2" valign="bottom"><a name="letter_o"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;o&#160;&#160;</div></td></tr></table>
112107
</td>
113-
<td valign="top"><a class="el" href="interfaceintegral__core_1_1ode__constraint.html">ode_constraint</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
114-
<td valign="top"><a class="el" href="structintegral__core_1_1ode__irk.html">ode_irk</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
108+
<td valign="top"><a class="el" href="structintegral__core_1_1ode__integrator.html">ode_integrator</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
109+
<td valign="top"><a class="el" href="structintegral__core_1_1ode__rk45.html">ode_rk45</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
115110
</tr>
111+
<tr><td valign="top"><a class="el" href="structintegral__core_1_1ode__integrator2.html">ode_integrator2</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
112+
<td></td></tr>
116113
<tr><td valign="top"><a class="el" href="structintegral__core_1_1adaptive__integrator.html">adaptive_integrator</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
114+
<td valign="top"><a class="el" href="structintegral__core_1_1infinite__interval__integrator.html">infinite_interval_integrator</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
115+
<td valign="top"><a class="el" href="structintegral__core_1_1ode__auto.html">ode_auto</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
116+
<td valign="top"><a class="el" href="interfaceintegral__core_1_1ode__integrator__interface.html">ode_integrator_interface</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
117+
<td></td></tr>
118+
<tr><td rowspan="2" valign="bottom"><a name="letter_f"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;f&#160;&#160;</div></td></tr></table>
119+
</td>
120+
<td valign="top"><a class="el" href="interfaceintegral__core_1_1integrand.html">integrand</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
121+
<td valign="top"><a class="el" href="interfaceintegral__core_1_1ode__collect__results.html">ode_collect_results</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
122+
<td valign="top"><a class="el" href="interfaceintegral__core_1_1ode__integrator__reset.html">ode_integrator_reset</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
123+
<td></td></tr>
124+
<tr><td valign="top"><a class="el" href="structintegral__core_1_1integration__behavior.html">integration_behavior</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
125+
<td valign="top"><a class="el" href="interfaceintegral__core_1_1ode__constraint.html">ode_constraint</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
126+
<td valign="top"><a class="el" href="structintegral__core_1_1ode__irk.html">ode_irk</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
127+
<td></td></tr>
128+
<tr><td valign="top"><a class="el" href="interfaceintegral__core_1_1finite__interval__fcn.html">finite_interval_fcn</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
129+
<td valign="top"><a class="el" href="structintegral__core_1_1integrator__base.html">integrator_base</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
117130
<td valign="top"><a class="el" href="interfaceintegral__core_1_1ode__fcn.html">ode_fcn</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
118131
<td valign="top"><a class="el" href="interfaceintegral__core_1_1ode__jacobian.html">ode_jacobian</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
119-
</tr>
120-
<tr><td rowspan="2" valign="bottom"><a name="letter_f"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;f&#160;&#160;</div></td></tr></table>
132+
<td></td></tr>
133+
<tr><td valign="top"><a class="el" href="structintegral__core_1_1finite__interval__integrator.html">finite_interval_integrator</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
134+
<td rowspan="2" valign="bottom"><a name="letter_n"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;n&#160;&#160;</div></td></tr></table>
121135
</td>
122-
<td valign="top"><a class="el" href="structintegral__core_1_1infinite__interval__integrator.html">infinite_interval_integrator</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
123-
<td valign="top"><a class="el" href="structintegral__core_1_1nonadaptive__integrator.html">nonadaptive_integrator</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
124136
<td valign="top"><a class="el" href="structintegral__core_1_1ode__helper.html">ode_helper</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
125137
<td valign="top"><a class="el" href="interfaceintegral__core_1_1ode__mass.html">ode_mass</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
126-
</tr>
127-
<tr><td valign="top"><a class="el" href="interfaceintegral__core_1_1integrand.html">integrand</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
128-
<td rowspan="2" valign="bottom"><a name="letter_o"></a><table border="0" cellspacing="0" cellpadding="0"><tr><td><div class="ah">&#160;&#160;o&#160;&#160;</div></td></tr></table>
129-
</td>
130-
<td valign="top"><a class="el" href="structintegral__core_1_1ode__integrator.html">ode_integrator</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
131-
<td></td></tr>
132-
<tr><td valign="top"><a class="el" href="interfaceintegral__core_1_1finite__interval__fcn.html">finite_interval_fcn</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
133-
<td valign="top"><a class="el" href="structintegral__core_1_1integration__behavior.html">integration_behavior</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
134-
<td valign="top"><a class="el" href="interfaceintegral__core_1_1ode__integrator__interface.html">ode_integrator_interface</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
135138
<td></td></tr>
136-
<tr><td></td><td></td><td valign="top"><a class="el" href="structintegral__core_1_1ode__auto.html">ode_auto</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
137-
<td></td><td></td></tr>
139+
<tr><td></td><td></td><td></td><td></td></tr>
140+
<tr><td></td><td valign="top"><a class="el" href="structintegral__core_1_1nonadaptive__integrator.html">nonadaptive_integrator</a> (<a class="el" href="namespaceintegral__core.html">integral_core</a>)&#160;&#160;&#160;</td>
141+
<td></td><td></td><td></td></tr>
138142
<tr><td></td><td></td><td></td><td></td><td></td></tr>
139143
</table>
140144
<div class="qindex"><a class="qindex" href="#letter_a">a</a>&#160;|&#160;<a class="qindex" href="#letter_f">f</a>&#160;|&#160;<a class="qindex" href="#letter_i">i</a>&#160;|&#160;<a class="qindex" href="#letter_n">n</a>&#160;|&#160;<a class="qindex" href="#letter_o">o</a></div>

doc/html/dir_68267d1309a1af8e8297ef4c3efbcdba.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,7 @@ var dir_68267d1309a1af8e8297ef4c3efbcdba =
88
[ "integral_ode_auto.f90", "integral__ode__auto_8f90_source.html", null ],
99
[ "integral_ode_helper.f90", "integral__ode__helper_8f90_source.html", null ],
1010
[ "integral_ode_integrator.f90", "integral__ode__integrator_8f90_source.html", null ],
11-
[ "integral_ode_irk.f90", "integral__ode__irk_8f90_source.html", null ]
11+
[ "integral_ode_integrator2.f90", "integral__ode__integrator2_8f90_source.html", null ],
12+
[ "integral_ode_irk.f90", "integral__ode__irk_8f90_source.html", null ],
13+
[ "integral_ode_rk45.f90", "integral__ode__rk45_8f90_source.html", null ]
1214
];

doc/html/files.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,9 @@
108108
<tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a href="integral__ode__auto_8f90_source.html"><span class="icondoc"></span></a><b>integral_ode_auto.f90</b></td><td class="desc"></td></tr>
109109
<tr id="row_0_6_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a href="integral__ode__helper_8f90_source.html"><span class="icondoc"></span></a><b>integral_ode_helper.f90</b></td><td class="desc"></td></tr>
110110
<tr id="row_0_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a href="integral__ode__integrator_8f90_source.html"><span class="icondoc"></span></a><b>integral_ode_integrator.f90</b></td><td class="desc"></td></tr>
111-
<tr id="row_0_8_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a href="integral__ode__irk_8f90_source.html"><span class="icondoc"></span></a><b>integral_ode_irk.f90</b></td><td class="desc"></td></tr>
111+
<tr id="row_0_8_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a href="integral__ode__integrator2_8f90_source.html"><span class="icondoc"></span></a><b>integral_ode_integrator2.f90</b></td><td class="desc"></td></tr>
112+
<tr id="row_0_9_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a href="integral__ode__irk_8f90_source.html"><span class="icondoc"></span></a><b>integral_ode_irk.f90</b></td><td class="desc"></td></tr>
113+
<tr id="row_0_10_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a href="integral__ode__rk45_8f90_source.html"><span class="icondoc"></span></a><b>integral_ode_rk45.f90</b></td><td class="desc"></td></tr>
112114
</table>
113115
</div><!-- directory -->
114116
</div><!-- contents -->

0 commit comments

Comments
 (0)