annotate liboctave/ODE.h @ 382:e02d6b664394

[project @ 1994-03-09 21:08:03 by jwe]
author jwe
date Wed, 09 Mar 1994 21:08:03 +0000
parents 3c23b8ea9099
children 7e870a4ec9bc
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 // ODE.h -*- C++ -*-
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
2 /*
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
3
296
3c23b8ea9099 [project @ 1994-01-17 02:49:15 by jwe]
jwe
parents: 289
diff changeset
4 Copyright (C) 1992, 1993, 1994 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
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
10 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
11 later version.
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
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
19 along with Octave; see the file COPYING. If not, write to the Free
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
20 Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
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
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 296
diff changeset
27 extern "C++" {
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
28
238
780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe]
jwe
parents: 3
diff changeset
29 class ostream;
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
30
238
780cbbc57b7c [project @ 1993-11-30 20:23:04 by jwe]
jwe
parents: 3
diff changeset
31 #include "Matrix.h"
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
32 #include "ODEFunc.h"
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
33
289
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
34 class ODE_options
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
35 {
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
36 public:
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
37
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
38 ODE_options (void);
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
39 ODE_options (const ODE_options& opt);
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
40
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
41 ODE_options& operator = (const ODE_options& opt);
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
42
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
43 ~ODE_options (void);
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
44
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
45 void init (void);
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
46 void copy (const ODE_options& opt);
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
47
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
48 void set_default_options (void);
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
49
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
50 void set_absolute_tolerance (double);
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
51 void set_initial_step_size (double);
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
52 void set_maximum_step_size (double);
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
53 void set_minimum_step_size (double);
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
54 void set_relative_tolerance (double);
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
55
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
56 double absolute_tolerance (void);
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
57 double initial_step_size (void);
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
58 double maximum_step_size (void);
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
59 double minimum_step_size (void);
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
60 double relative_tolerance (void);
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
61
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
62 private:
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
63
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
64 double x_absolute_tolerance;
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
65 double x_initial_step_size;
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
66 double x_maximum_step_size;
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
67 double x_minimum_step_size;
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
68 double x_relative_tolerance;
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
69 };
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
70
c23f50e61c58 [project @ 1994-01-13 06:25:58 by jwe]
jwe
parents: 258
diff changeset
71 class ODE : public ODEFunc, public ODE_options
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
72 {
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
73 public:
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
74
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
75 ODE (void);
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
76
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
77 ODE (int n);
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
78
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
79 ODE (const ColumnVector& state, double time, const ODEFunc& f);
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
80
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
81 virtual ~ODE (void);
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
82
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
83 virtual int size (void) const;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
84 virtual ColumnVector state (void) const;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
85 virtual double time (void) const;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
86
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
87 virtual void force_restart (void);
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
88 virtual void initialize (const ColumnVector& x, double t);
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
89 virtual void set_stop_time (double t);
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
90 virtual void clear_stop_time (void);
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
91
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
92 virtual ColumnVector integrate (double t);
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
93
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
94 void integrate (int nsteps, double tstep, ostream& s);
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
95
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
96 Matrix integrate (const ColumnVector& tout);
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
97 Matrix integrate (const ColumnVector& tout, const ColumnVector& tcrit);
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
98
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
99 protected:
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
100
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
101 /*
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
102 * Some of this is probably too closely related to LSODE, but hey,
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
103 * this is just a first attempt...
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
104 */
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
105
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
106 int n;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
107 double t;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
108 ColumnVector x;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
109
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
110 double stop_time;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
111 int stop_time_set;
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 private:
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
114
258
1c9a678906fb [project @ 1993-12-14 06:24:04 by jwe]
jwe
parents: 238
diff changeset
115 int integration_error;
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
116 int restart;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
117 int method_flag;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
118 int *iwork;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
119 double *rwork;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
120 int istate;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
121 int itol;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
122 int itask;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
123 int iopt;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
124 int liw;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
125 int lrw;
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
126
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
127 friend int lsode_f (int *neq, double *t, double *y, double *ydot);
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
128
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
129 friend int lsode_j (int *neq, double *t, double *y, int *ml, int *mu,
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
130 double *pd, int *nrowpd);
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
131
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
132 };
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
133
382
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 296
diff changeset
134 } // extern "C++"
e02d6b664394 [project @ 1994-03-09 21:08:03 by jwe]
jwe
parents: 296
diff changeset
135
3
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
136 #endif
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
137
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
138 /*
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
139 ;;; Local Variables: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
140 ;;; mode: C++ ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
141 ;;; page-delimiter: "^/\\*" ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
142 ;;; End: ***
9a4c07481e61 [project @ 1993-08-08 01:20:23 by jwe]
jwe
parents:
diff changeset
143 */