annotate liboctave/ODE.h @ 4960:ce01dbd7e026 ss-2-1-58

[project @ 2004-09-02 03:47:49 by jwe]
author jwe
date Thu, 02 Sep 2004 03:47:49 +0000
parents 7b957b442818
children 4c8a2e4e0717
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
2847
8b262e771614 [project @ 1997-03-27 16:18:26 by jwe]
jwe
parents: 1993
diff changeset
3 Copyright (C) 1996, 1997 John W. Eaton
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
4
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
6
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
7 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
8 under the terms of the GNU General Public License as published by the
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
10 later version.
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
11
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
12 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
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
14 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
15 for more details.
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
16
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, write to the Free
1315
611d403c7f3d [project @ 1995-06-25 19:56:32 by jwe]
jwe
parents: 1296
diff changeset
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
20
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
382
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 296
diff changeset
23 #if !defined (octave_ODE_h)
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 296
diff changeset
24 #define octave_ODE_h 1
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 296
diff changeset
25
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
26 #include "ODEFunc.h"
1842
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
27 #include "base-de.h"
289
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
28
1861
620a65533630 [project @ 1996-02-04 10:17:34 by jwe]
jwe
parents: 1842
diff changeset
29 class
620a65533630 [project @ 1996-02-04 10:17:34 by jwe]
jwe
parents: 1842
diff changeset
30 ODE : public base_diff_eqn, public ODEFunc
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
31 {
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
32 public:
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
33
1842
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
34 ODE (void)
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
35 : base_diff_eqn (), ODEFunc () { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
36
4587
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 3984
diff changeset
37 ODE (const ColumnVector& s, double tm, const ODEFunc& f)
7b957b442818 [project @ 2003-11-10 15:50:39 by jwe]
jwe
parents: 3984
diff changeset
38 : base_diff_eqn (s, tm), ODEFunc (f) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
39
1842
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
40 ODE (const ODE& a)
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
41 : base_diff_eqn (a), ODEFunc (a) { }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
42
1842
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
43 ODE& operator = (const ODE& a)
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
44 {
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
45 if (this != &a)
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
46 {
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
47 base_diff_eqn::operator = (a);
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
48 ODEFunc::operator = (a);
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
49 }
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
50 return *this;
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
51 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
52
1842
0574a1f3a273 [project @ 1996-02-03 11:44:02 by jwe]
jwe
parents: 1359
diff changeset
53 ~ODE (void) { }
3984
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
54
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
55 // Derived classes must provide functions to actually do the
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
56 // integration.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
57
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
58 // Return the vector of states at output time t.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
59 virtual ColumnVector do_integrate (double tt) = 0;
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
60
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
61 // 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
62 // 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
63 // output time.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
64 virtual Matrix do_integrate (const ColumnVector& tt) = 0;
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
65
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
66 virtual Matrix do_integrate (const ColumnVector& tt,
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
67 const ColumnVector& ttcrit) = 0;
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
68
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
69 // 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
70 // get additional information.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
71
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
72 // Integrate to t from current point.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
73 virtual ColumnVector integrate (double tt)
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
74 { return do_integrate (tt); }
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
75
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
76 // Set new x0, t0 and integrate to t.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
77 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
78 {
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
79 initialize (x0, t0);
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
80 return do_integrate (tt);
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
81 }
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 // 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
84 // specified by t.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
85 virtual Matrix integrate (const ColumnVector& tt)
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
86 { return do_integrate (tt); }
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
87
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
88 // 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
89 // specified by t.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
90 virtual Matrix integrate (const ColumnVector& x0, double t0,
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
91 const ColumnVector& tt)
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
92 {
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
93 initialize (x0, t0);
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
94 return do_integrate (tt);
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
95 }
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 // 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
98 // specified by t.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
99 virtual Matrix integrate (const ColumnVector& tt,
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
100 const ColumnVector& ttcrit)
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
101 { return do_integrate (tt, ttcrit); }
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
102
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
103 // 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
104 // specified by t.
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
105 virtual Matrix integrate (const ColumnVector& x0, double t0,
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
106 const ColumnVector& tt,
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
107 const ColumnVector& ttcrit)
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
108 {
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
109 initialize (x0, t0);
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
110 return do_integrate (tt, ttcrit);
addebffd4961 [project @ 2002-07-11 03:39:33 by jwe]
jwe
parents: 2847
diff changeset
111 }
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
112 };
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 #endif
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
115
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 ;;; Local Variables: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
118 ;;; mode: C++ ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
119 ;;; End: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
120 */