-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclassBubbleProfiler_1_1Controlled__step__size__integrator.html
350 lines (333 loc) · 16.6 KB
/
classBubbleProfiler_1_1Controlled__step__size__integrator.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>BubbleProfiler: BubbleProfiler::Controlled_step_size_integrator< Parameter, State, Stepper > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="style.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">BubbleProfiler
 <span id="projectnumber">0.3.0</span>
</div>
<div id="projectbrief">by Peter Athron, Csaba Balazs, Michael Bardsley, Andrew Fowlie, Dylan Harries & Graham White</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceBubbleProfiler.html">BubbleProfiler</a></li><li class="navelem"><a class="el" href="classBubbleProfiler_1_1Controlled__step__size__integrator.html">Controlled_step_size_integrator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pri-attribs">Private Attributes</a> |
<a href="classBubbleProfiler_1_1Controlled__step__size__integrator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">BubbleProfiler::Controlled_step_size_integrator< Parameter, State, Stepper > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="integration__policy_8hpp_source.html">integration_policy.hpp</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af64f63d0603f9be047d3c8175bb6c553"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBubbleProfiler_1_1Controlled__step__size__integrator.html#af64f63d0603f9be047d3c8175bb6c553">set_absolute_error</a> (Parameter err)</td></tr>
<tr class="separator:af64f63d0603f9be047d3c8175bb6c553"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1ad2c0ef0626998adfcf84aa88ddb370"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classBubbleProfiler_1_1Controlled__step__size__integrator.html#a1ad2c0ef0626998adfcf84aa88ddb370">set_relative_error</a> (Parameter err)</td></tr>
<tr class="separator:a1ad2c0ef0626998adfcf84aa88ddb370"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a0cdbf5cb7642e649f91e77b11c3ea391"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classBubbleProfiler_1_1Controlled__step__size__integrator.html#a0cdbf5cb7642e649f91e77b11c3ea391">~Controlled_step_size_integrator</a> ()=default</td></tr>
<tr class="separator:a0cdbf5cb7642e649f91e77b11c3ea391"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a604bc4befdffc5b5b4220877a5c74759"><td class="memTemplParams" colspan="2">template<class System , class Observer > </td></tr>
<tr class="memitem:a604bc4befdffc5b5b4220877a5c74759"><td class="memTemplItemLeft" align="right" valign="top">int </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classBubbleProfiler_1_1Controlled__step__size__integrator.html#a604bc4befdffc5b5b4220877a5c74759">integrate_system</a> (System system, State &state, Parameter from, Parameter to, Parameter step_size, Observer observer) const </td></tr>
<tr class="separator:a604bc4befdffc5b5b4220877a5c74759"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:a488b866e690f78c94def9d0f7c1a8249"><td class="memItemLeft" align="right" valign="top">Parameter </td><td class="memItemRight" valign="bottom"><a class="el" href="classBubbleProfiler_1_1Controlled__step__size__integrator.html#a488b866e690f78c94def9d0f7c1a8249">abs_err</a> {1.e-6}</td></tr>
<tr class="separator:a488b866e690f78c94def9d0f7c1a8249"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a59db48f6663bab9ca6fdf806ad5cd133"><td class="memItemLeft" align="right" valign="top">Parameter </td><td class="memItemRight" valign="bottom"><a class="el" href="classBubbleProfiler_1_1Controlled__step__size__integrator.html#a59db48f6663bab9ca6fdf806ad5cd133">rel_err</a> {1.e-6}</td></tr>
<tr class="separator:a59db48f6663bab9ca6fdf806ad5cd133"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<class Parameter, class State, class Stepper><br />
class BubbleProfiler::Controlled_step_size_integrator< Parameter, State, Stepper ></h3>
<p>Definition at line <a class="el" href="integration__policy_8hpp_source.html#l00057">57</a> of file <a class="el" href="integration__policy_8hpp_source.html">integration_policy.hpp</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a0cdbf5cb7642e649f91e77b11c3ea391"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class Parameter , class State , class Stepper > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classBubbleProfiler_1_1Controlled__step__size__integrator.html">BubbleProfiler::Controlled_step_size_integrator</a>< Parameter, State, Stepper >::~<a class="el" href="classBubbleProfiler_1_1Controlled__step__size__integrator.html">Controlled_step_size_integrator</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a604bc4befdffc5b5b4220877a5c74759"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class Parameter , class State , class Stepper > </div>
<div class="memtemplate">
template<class System , class Observer > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classBubbleProfiler_1_1Controlled__step__size__integrator.html">BubbleProfiler::Controlled_step_size_integrator</a>< Parameter, State, Stepper >::integrate_system </td>
<td>(</td>
<td class="paramtype">System </td>
<td class="paramname"><em>system</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">State & </td>
<td class="paramname"><em>state</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Parameter </td>
<td class="paramname"><em>from</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Parameter </td>
<td class="paramname"><em>to</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Parameter </td>
<td class="paramname"><em>step_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Observer </td>
<td class="paramname"><em>observer</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="integration__policy_8hpp_source.html#l00077">77</a> of file <a class="el" href="integration__policy_8hpp_source.html">integration_policy.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="af64f63d0603f9be047d3c8175bb6c553"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class Parameter , class State , class Stepper > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classBubbleProfiler_1_1Controlled__step__size__integrator.html">BubbleProfiler::Controlled_step_size_integrator</a>< Parameter, State, Stepper >::set_absolute_error </td>
<td>(</td>
<td class="paramtype">Parameter </td>
<td class="paramname"><em>err</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="integration__policy_8hpp_source.html#l00059">59</a> of file <a class="el" href="integration__policy_8hpp_source.html">integration_policy.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1ad2c0ef0626998adfcf84aa88ddb370"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class Parameter , class State , class Stepper > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classBubbleProfiler_1_1Controlled__step__size__integrator.html">BubbleProfiler::Controlled_step_size_integrator</a>< Parameter, State, Stepper >::set_relative_error </td>
<td>(</td>
<td class="paramtype">Parameter </td>
<td class="paramname"><em>err</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="integration__policy_8hpp_source.html#l00060">60</a> of file <a class="el" href="integration__policy_8hpp_source.html">integration_policy.hpp</a>.</p>
<p>References <a class="el" href="integration__policy_8hpp_source.html#l00047">BubbleProfiler::Fixed_step_size_integrator< Parameter, State, Stepper >::integrate_system()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a488b866e690f78c94def9d0f7c1a8249"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class Parameter , class State , class Stepper > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Parameter <a class="el" href="classBubbleProfiler_1_1Controlled__step__size__integrator.html">BubbleProfiler::Controlled_step_size_integrator</a>< Parameter, State, Stepper >::abs_err {1.e-6}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="integration__policy_8hpp_source.html#l00071">71</a> of file <a class="el" href="integration__policy_8hpp_source.html">integration_policy.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a59db48f6663bab9ca6fdf806ad5cd133"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class Parameter , class State , class Stepper > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Parameter <a class="el" href="classBubbleProfiler_1_1Controlled__step__size__integrator.html">BubbleProfiler::Controlled_step_size_integrator</a>< Parameter, State, Stepper >::rel_err {1.e-6}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="integration__policy_8hpp_source.html#l00072">72</a> of file <a class="el" href="integration__policy_8hpp_source.html">integration_policy.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/home/michael/bubbleprofiler_release/include/<a class="el" href="integration__policy_8hpp_source.html">integration_policy.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jan 2 2019 13:08:19 for BubbleProfiler by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>