GNU Octave  4.0.0
A high-level interpreted language, primarily intended for numerical computations, mostly compatible with Matlab
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
base-de.h
Go to the documentation of this file.
1 /*
2 
3 Copyright (C) 1996-2015 John W. Eaton
4 
5 This file is part of Octave.
6 
7 Octave is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 3 of the License, or (at your
10 option) any later version.
11 
12 Octave is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 for more details.
16 
17 You should have received a copy of the GNU General Public License
18 along with Octave; see the file COPYING. If not, see
19 <http://www.gnu.org/licenses/>.
20 
21 */
22 
23 #if !defined (octave_base_de_h)
24 #define octave_base_de_h 1
25 
26 #include <string>
27 
28 #include "dColVector.h"
29 #include "dMatrix.h"
30 
31 class
33 {
34 public:
35 
37  : x (), t (0.0), stop_time (0.0), stop_time_set (false),
38  restart (true), integration_error (false), istate (0) { }
39 
40  base_diff_eqn (const ColumnVector& xx, double tt)
41  : x (xx), t (tt), stop_time (0.0), stop_time_set (false),
42  restart (true), integration_error (false), istate (0) { }
43 
45  : x (a.x), t (a.t), stop_time (0.0), stop_time_set (false),
46  restart (true), integration_error (false), istate (0) { }
47 
48  virtual ~base_diff_eqn (void) { }
49 
50  base_diff_eqn& operator = (const base_diff_eqn& a)
51  {
52  if (this != &a)
53  {
54  x = a.x;
55  t = a.t;
56  stop_time = a.stop_time;
57  stop_time_set = a.stop_time_set;
58  restart = a.restart;
59  integration_error = a.integration_error;
60  istate = a.istate;
61  }
62 
63  return *this;
64  }
65 
66  void initialize (const ColumnVector& x0, double t0)
67  {
68  x = x0;
69  t = t0;
70  integration_error = false;
71  istate = 0;
72  force_restart ();
73  }
74 
75  octave_idx_type size (void) const { return x.capacity (); }
76 
77  ColumnVector state (void) const { return x; }
78 
79  double time (void) const { return t; }
80 
81  void set_stop_time (double tt)
82  {
83  stop_time_set = true;
84  stop_time = tt;
85  force_restart ();
86  }
87 
88  void clear_stop_time (void)
89  {
90  stop_time_set = false;
91  force_restart ();
92  }
93 
94  virtual void force_restart (void) { restart = true; }
95 
96  bool integration_ok (void) const { return ! integration_error; }
97 
98  octave_idx_type integration_state (void) const { return istate; }
99 
100  virtual std::string error_message (void) const = 0;
101 
102 protected:
103 
105 
106  double t;
107 
108  double stop_time;
109 
111 
112  bool restart;
113 
115 
117 };
118 
119 #endif
double time(void) const
Definition: base-de.h:79
octave_idx_type size(void) const
Definition: base-de.h:75
ColumnVector state(void) const
Definition: base-de.h:77
bool integration_ok(void) const
Definition: base-de.h:96
void initialize(const ColumnVector &x0, double t0)
Definition: base-de.h:66
bool integration_error
Definition: base-de.h:114
octave_idx_type istate
Definition: base-de.h:116
virtual ~base_diff_eqn(void)
Definition: base-de.h:48
virtual void force_restart(void)
Definition: base-de.h:94
void set_stop_time(double tt)
Definition: base-de.h:81
double t
Definition: base-de.h:106
base_diff_eqn(const ColumnVector &xx, double tt)
Definition: base-de.h:40
void clear_stop_time(void)
Definition: base-de.h:88
double stop_time
Definition: base-de.h:108
ColumnVector x
Definition: base-de.h:104
base_diff_eqn(void)
Definition: base-de.h:36
octave_idx_type integration_state(void) const
Definition: base-de.h:98
bool restart
Definition: base-de.h:112
base_diff_eqn(const base_diff_eqn &a)
Definition: base-de.h:44
bool stop_time_set
Definition: base-de.h:110
F77_RET_T const double * x