annotate liboctave/ODE.h @ 7948:af10baa63915 ss-3-1-50

3.1.50 snapshot
author John W. Eaton <jwe@octave.org>
date Fri, 18 Jul 2008 17:42:48 -0400
parents a1dbe9d80eee
children 4c0cdbe0acca
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
1 /*
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
2
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
3 Copyright (C) 1993, 1994, 1995, 1996, 1997, 2002, 2003, 2005, 2007
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
4 John W. Eaton
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
5
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
6 This file is part of Octave.
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
7
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
8 Octave is free software; you can redistribute it and/or modify it
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
9 under the terms of the GNU General Public License as published by the
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
10 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
11 option) any later version.
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
12
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
13 Octave is distributed in the hope that it will be useful, but WITHOUT
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
16 for more details.
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
17
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
18 You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
19 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5307
diff changeset
20 <http://www.gnu.org/licenses/>.
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
21
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
22 */
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
23
382
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 296
diff changeset
24 #if !defined (octave_ODE_h)
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 296
diff changeset
25 #define octave_ODE_h 1
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 296
diff changeset
26
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
27 #include "ODEFunc.h"
1842
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
28 #include "base-de.h"
289
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
29
1861
620a65533630 [project @ 1996-02-04 10:17:34 by jwe]
jwe
parents: 1842
diff changeset
30 class
620a65533630 [project @ 1996-02-04 10:17:34 by jwe]
jwe
parents: 1842
diff changeset
31 ODE : public base_diff_eqn, public ODEFunc
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
32 {
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
33 public:
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
34
1842
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
35 ODE (void)
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
36 : base_diff_eqn (), ODEFunc () { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
37
4587
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 3984
diff changeset
38 ODE (const ColumnVector& s, double tm, const ODEFunc& f)
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 3984
diff changeset
39 : base_diff_eqn (s, tm), ODEFunc (f) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
40
1842
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
41 ODE (const ODE& a)
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
42 : base_diff_eqn (a), ODEFunc (a) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
43
1842
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
44 ODE& operator = (const ODE& a)
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
45 {
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
46 if (this != &a)
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
47 {
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
48 base_diff_eqn::operator = (a);
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
49 ODEFunc::operator = (a);
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
50 }
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
51 return *this;
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
52 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
53
1842
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
54 ~ODE (void) { }
3984
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
55
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
56 // Derived classes must provide functions to actually do the
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
57 // integration.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
58
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
59 // Return the vector of states at output time t.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
60 virtual ColumnVector do_integrate (double tt) = 0;
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
61
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
62 // Return a matrix of states at each output time specified by t.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
63 // The rows of the result matrix should each correspond to a new
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
64 // output time.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
65 virtual Matrix do_integrate (const ColumnVector& tt) = 0;
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
66
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
67 virtual Matrix do_integrate (const ColumnVector& tt,
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
68 const ColumnVector& ttcrit) = 0;
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
69
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
70 // Lots of ways to call the single function and optionally set and
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
71 // get additional information.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
72
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
73 // Integrate to t from current point.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
74 virtual ColumnVector integrate (double tt)
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
75 { return do_integrate (tt); }
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
76
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
77 // Set new x0, t0 and integrate to t.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
78 virtual ColumnVector integrate (const ColumnVector& x0, double t0, double tt)
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
79 {
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
80 initialize (x0, t0);
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
81 return do_integrate (tt);
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
82 }
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
83
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
84 // Integrate from current point and return output at all points
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
85 // specified by t.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
86 virtual Matrix integrate (const ColumnVector& tt)
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
87 { return do_integrate (tt); }
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
88
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
89 // Set new x0, t0 and integrate to return output at all points
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
90 // specified by t.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
91 virtual Matrix integrate (const ColumnVector& x0, double t0,
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
92 const ColumnVector& tt)
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
93 {
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
94 initialize (x0, t0);
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
95 return do_integrate (tt);
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
96 }
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
97
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
98 // Integrate from current point and return output at all points
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
99 // specified by t.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
100 virtual Matrix integrate (const ColumnVector& tt,
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
101 const ColumnVector& ttcrit)
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
102 { return do_integrate (tt, ttcrit); }
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
103
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
104 // Set new x0, t0 and integrate to return output at all points
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
105 // specified by t.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
106 virtual Matrix integrate (const ColumnVector& x0, double t0,
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
107 const ColumnVector& tt,
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
108 const ColumnVector& ttcrit)
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
109 {
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
110 initialize (x0, t0);
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
111 return do_integrate (tt, ttcrit);
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
112 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
113 };
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
114
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
115 #endif
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
116
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
117 /*
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
118 ;;; Local Variables: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
119 ;;; mode: C++ ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
120 ;;; End: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
121 */