File: Driver.html

package info (click to toggle)
gsl-ref-html 2.3-1
  • links: PTS
  • area: non-free
  • in suites: bullseye, buster, sid
  • size: 6,876 kB
  • ctags: 4,574
  • sloc: makefile: 35
file content (162 lines) | stat: -rw-r--r-- 10,118 bytes parent folder | download
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 The GSL Team.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with the
Invariant Sections being "GNU General Public License" and "Free Software
Needs Free Documentation", the Front-Cover text being "A GNU Manual",
and with the Back-Cover Text being (a) (see below). A copy of the
license is included in the section entitled "GNU Free Documentation
License".

(a) The Back-Cover Text is: "You have the freedom to copy and modify this
GNU Manual." -->
<!-- Created by GNU Texinfo 5.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Scientific Library &ndash; Reference Manual: Driver</title>

<meta name="description" content="GNU Scientific Library &ndash; Reference Manual: Driver">
<meta name="keywords" content="GNU Scientific Library &ndash; Reference Manual: Driver">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Function-Index.html#Function-Index" rel="index" title="Function Index">
<link href="Ordinary-Differential-Equations.html#Ordinary-Differential-Equations" rel="up" title="Ordinary Differential Equations">
<link href="ODE-Example-programs.html#ODE-Example-programs" rel="next" title="ODE Example programs">
<link href="Evolution.html#Evolution" rel="previous" title="Evolution">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Driver"></a>
<div class="header">
<p>
Next: <a href="ODE-Example-programs.html#ODE-Example-programs" accesskey="n" rel="next">ODE Example programs</a>, Previous: <a href="Evolution.html#Evolution" accesskey="p" rel="previous">Evolution</a>, Up: <a href="Ordinary-Differential-Equations.html#Ordinary-Differential-Equations" accesskey="u" rel="up">Ordinary Differential Equations</a> &nbsp; [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Driver-1"></a>
<h3 class="section">27.5 Driver</h3>

<p>The driver object is a high level wrapper that combines the evolution,
control and stepper objects for easy use.
</p>
<dl>
<dt><a name="index-gsl_005fodeiv2_005fdriver_005falloc_005fy_005fnew"></a>Function: <em>gsl_odeiv2_driver *</em> <strong>gsl_odeiv2_driver_alloc_y_new</strong> <em>(const gsl_odeiv2_system * <var>sys</var>, const gsl_odeiv2_step_type * <var>T</var>, const double <var>hstart</var>, const double <var>epsabs</var>, const double <var>epsrel</var>)</em></dt>
<dt><a name="index-gsl_005fodeiv2_005fdriver_005falloc_005fyp_005fnew"></a>Function: <em>gsl_odeiv2_driver *</em> <strong>gsl_odeiv2_driver_alloc_yp_new</strong> <em>(const gsl_odeiv2_system * <var>sys</var>, const gsl_odeiv2_step_type * <var>T</var>, const double <var>hstart</var>, const double <var>epsabs</var>, const double <var>epsrel</var>)</em></dt>
<dt><a name="index-gsl_005fodeiv2_005fdriver_005falloc_005fstandard_005fnew"></a>Function: <em>gsl_odeiv2_driver *</em> <strong>gsl_odeiv2_driver_alloc_standard_new</strong> <em>(const gsl_odeiv2_system * <var>sys</var>, const gsl_odeiv2_step_type * <var>T</var>, const double <var>hstart</var>, const double <var>epsabs</var>, const double <var>epsrel</var>, const double <var>a_y</var>, const double <var>a_dydt</var>)</em></dt>
<dt><a name="index-gsl_005fodeiv2_005fdriver_005falloc_005fscaled_005fnew"></a>Function: <em>gsl_odeiv2_driver *</em> <strong>gsl_odeiv2_driver_alloc_scaled_new</strong> <em>(const gsl_odeiv2_system * <var>sys</var>, const gsl_odeiv2_step_type * <var>T</var>, const double <var>hstart</var>, const double <var>epsabs</var>, const double <var>epsrel</var>, const double <var>a_y</var>, const double <var>a_dydt</var>, const double <var>scale_abs</var>[])</em></dt>
<dd><p>These functions return a pointer to a newly allocated instance of a
driver object. The functions automatically allocate and initialise the
evolve, control and stepper objects for ODE system <var>sys</var> using
stepper type <var>T</var>. The initial step size is given in
<var>hstart</var>. The rest of the arguments follow the syntax and
semantics of the control functions with same name
(<code>gsl_odeiv2_control_*_new</code>).
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005fodeiv2_005fdriver_005fset_005fhmin"></a>Function: <em>int</em> <strong>gsl_odeiv2_driver_set_hmin</strong> <em>(gsl_odeiv2_driver * <var>d</var>, const double <var>hmin</var>)</em></dt>
<dd><p>The function sets a minimum for allowed step size <var>hmin</var> for
driver <var>d</var>. Default value is 0.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005fodeiv2_005fdriver_005fset_005fhmax"></a>Function: <em>int</em> <strong>gsl_odeiv2_driver_set_hmax</strong> <em>(gsl_odeiv2_driver * <var>d</var>, const double <var>hmax</var>)</em></dt>
<dd><p>The function sets a maximum for allowed step size <var>hmax</var> for
driver <var>d</var>. Default value is <code>GSL_DBL_MAX</code>.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005fodeiv2_005fdriver_005fset_005fnmax"></a>Function: <em>int</em> <strong>gsl_odeiv2_driver_set_nmax</strong> <em>(gsl_odeiv2_driver * <var>d</var>, const unsigned long int <var>nmax</var>)</em></dt>
<dd><p>The function sets a maximum for allowed number of steps <var>nmax</var> for
driver <var>d</var>. Default value of 0 sets no limit for steps.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005fodeiv2_005fdriver_005fapply"></a>Function: <em>int</em> <strong>gsl_odeiv2_driver_apply</strong> <em>(gsl_odeiv2_driver * <var>d</var>, double * <var>t</var>, const double <var>t1</var>, double <var>y</var>[])</em></dt>
<dd><p>This function evolves the driver system <var>d</var> from <var>t</var> to
<var>t1</var>. Initially vector <var>y</var> should contain the values of
dependent variables at point <var>t</var>. If the function is unable to
complete the calculation, an error code from
<code>gsl_odeiv2_evolve_apply</code> is returned, and <var>t</var> and <var>y</var>
contain the values from last successful step. 
</p>
<p>If maximum number of steps is reached, a value of <code>GSL_EMAXITER</code>
is returned. If the step size drops below minimum value, the function
returns with <code>GSL_ENOPROG</code>. If the user-supplied functions
defined in the system <var>sys</var> returns <code>GSL_EBADFUNC</code>, the
function returns immediately with the same return code. In this case
the user must call <code>gsl_odeiv2_driver_reset</code> before calling this
function again.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005fodeiv2_005fdriver_005fapply_005ffixed_005fstep"></a>Function: <em>int</em> <strong>gsl_odeiv2_driver_apply_fixed_step</strong> <em>(gsl_odeiv2_driver * <var>d</var>, double * <var>t</var>, const double <var>h</var>, const unsigned long int <var>n</var>, double <var>y</var>[])</em></dt>
<dd><p>This function evolves the driver system <var>d</var> from <var>t</var> with
<var>n</var> steps of size <var>h</var>. If the function is unable to complete
the calculation, an error code from
<code>gsl_odeiv2_evolve_apply_fixed_step</code> is returned, and <var>t</var> and
<var>y</var> contain the values from last successful step.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005fodeiv2_005fdriver_005freset"></a>Function: <em>int</em> <strong>gsl_odeiv2_driver_reset</strong> <em>(gsl_odeiv2_driver * <var>d</var>)</em></dt>
<dd><p>This function resets the evolution and stepper objects.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005fodeiv2_005fdriver_005freset_005fhstart"></a>Function: <em>int</em> <strong>gsl_odeiv2_driver_reset_hstart</strong> <em>(gsl_odeiv2_driver * <var>d</var>, const double <var>hstart</var>)</em></dt>
<dd><p>The routine resets the evolution and stepper objects and sets new
initial step size to <var>hstart</var>. This function can be used e.g. to
change the direction of integration.
</p></dd></dl>

<dl>
<dt><a name="index-gsl_005fodeiv2_005fdriver_005ffree"></a>Function: <em>int</em> <strong>gsl_odeiv2_driver_free</strong> <em>(gsl_odeiv2_driver * <var>d</var>)</em></dt>
<dd><p>This function frees the driver object, and the related evolution,
stepper and control objects.
</p></dd></dl>

<hr>
<div class="header">
<p>
Next: <a href="ODE-Example-programs.html#ODE-Example-programs" accesskey="n" rel="next">ODE Example programs</a>, Previous: <a href="Evolution.html#Evolution" accesskey="p" rel="previous">Evolution</a>, Up: <a href="Ordinary-Differential-Equations.html#Ordinary-Differential-Equations" accesskey="u" rel="up">Ordinary Differential Equations</a> &nbsp; [<a href="Function-Index.html#Function-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>