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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
//-----------------------------------------------------------------
// Main solver function
//-----------------------------------------------------------------
use super::*;
use log::warn;
impl<P, LS, NLS, TolC> Ida<P, LS, NLS, TolC>
where
P: IdaProblem,
LS: linear::LSolver<P::Scalar>,
NLS: nonlinear::NLSolver<P>,
TolC: TolControl<P::Scalar>,
<P as ModelSpec>::Scalar: num_traits::Float
+ num_traits::float::FloatConst
+ num_traits::NumRef
+ num_traits::NumAssignRef
+ ndarray::ScalarOperand
+ std::fmt::Debug
+ std::fmt::LowerExp
+ IdaConst<Scalar = P::Scalar>,
{
/// This routine is the main driver of the IDA package.
///
/// This is the central step in the solution process, the call to perform the integration of
/// the DAE. One of the input arguments (itask) specifies one of two modes as to where ida is
/// to return a solution. But these modes are modified if the user has set a stop time (with
/// `set_stop_time()`) or requested rootfinding.
///
/// It integrates over an independent variable interval defined by the user, by calling `step()`
/// to take internal independent variable steps.
///
/// The first time that `solve()` is called for a successfully initialized problem, it computes
/// a tentative initial step size.
///
/// `solve()` supports two modes, specified by `itask`:
/// * In the `Normal` mode, the solver steps until it passes `tout` and then interpolates to obtain
/// `y(tout)` and `yp(tout)`.
/// * In the `OneStep` mode, it takes one internal step and returns.
///
/// # Arguments
///
/// * `tout` The next time at which a computed solution is desired.
/// * `tret` The time reached by the solver (output).
/// * `itask` A flag indicating the job of the solver for the next user step. The IDA NORMAL task is to have the solver take internal steps until it has reached or just passed the user specified tout parameter. The solver then interpolates in order to return approximate values of y(tout) and ˙y(tout). The IDA ONE STEP option tells the solver to just take one internal step and return the solution at the point reached by that step
///
/// # Returns
///
/// * `IdaSolveStatus::Success` - general success.
/// * `IdaSolveStatus::TStop` - `solve()` succeeded by reaching the stop point specified through
/// the optional input function `set_stop_time()`.
/// * `IdaSolveStatus::Root` - `solve()` succeeded and found one or more roots. In this case,
/// tret is the location of the root. If nrtfn > 1, call `get_root_info()` to see which gi were
/// found to have a root.
///
/// # Errors
///
/// IDA_ILL_INPUT
/// IDA_TOO_MUCH_WORK
/// IDA_MEM_NULL
/// IDA_TOO_MUCH_ACC
/// IDA_CONV_FAIL
/// IDA_LSETUP_FAIL
/// IDA_LSOLVE_FAIL
/// IDA_CONSTR_FAIL
/// IDA_ERR_FAIL
/// IDA_REP_RES_ERR
/// IDA_RES_FAIL
pub fn solve(
&mut self,
tout: P::Scalar,
tret: &mut P::Scalar,
itask: IdaTask,
) -> Result<IdaSolveStatus, failure::Error> {
#[cfg(feature = "profiler")]
profile_scope!(format!("solve(tout={:?})", tout));
if let IdaTask::Normal = itask {
self.ida_toutc = tout;
}
self.ida_taskc = itask;
if self.counters.ida_nst == 0 {
// This is the first call
// Check inputs to IDA for correctness and consistency */
if !self.ida_setup_done {
self.initial_setup();
self.ida_setup_done = true;
}
// On first call, check for tout - tn too small, set initial hh, check for approach to
// tstop, and scale phi[1] by hh.
// Also check for zeros of root function g at and near t0.
let tdist = (tout - self.nlp.ida_tn).abs();
if tdist == P::Scalar::zero() {
Err(IdaError::IllegalInput {
msg: format!("tout too close to t0 to start integration."),
})?
}
let troundoff =
P::Scalar::two() * P::Scalar::epsilon() * (self.nlp.ida_tn.abs() + tout.abs());
if tdist < troundoff {
Err(IdaError::IllegalInput {
msg: format!("tout too close to t0 to start integration."),
})?
}
self.ida_hh = self.ida_hin;
if (self.ida_hh != P::Scalar::zero())
&& ((tout - self.nlp.ida_tn) * self.ida_hh < P::Scalar::zero())
{
Err(IdaError::IllegalInput {
msg: format!("Initial step is not towards tout."),
})?
}
if self.ida_hh == P::Scalar::zero() {
self.ida_hh = P::Scalar::pt001() * tdist;
let ypnorm = self.wrms_norm(
&self.ida_phi.index_axis(Axis(0), 1),
&self.nlp.ida_ewt,
self.ida_suppressalg,
);
if ypnorm > P::Scalar::two() / self.ida_hh {
self.ida_hh = P::Scalar::half() / ypnorm;
}
if tout < self.nlp.ida_tn {
self.ida_hh = -self.ida_hh;
}
}
let rh = (self.ida_hh).abs() * self.ida_hmax_inv;
if rh > P::Scalar::one() {
self.ida_hh /= rh;
}
if let Some(tstop) = self.ida_tstop {
if (tstop - self.nlp.ida_tn) * self.ida_hh <= P::Scalar::zero() {
Err(IdaError::IllegalInput {
msg: format!(
"The value tstop = {:?} \
is behind current t = {:?} \
in the direction of integration.",
tstop, self.nlp.ida_tn
),
})?
}
if (self.nlp.ida_tn + self.ida_hh - tstop) * self.ida_hh > P::Scalar::zero() {
self.ida_hh = (tstop - self.nlp.ida_tn)
* (P::Scalar::one() - P::Scalar::four() * P::Scalar::epsilon());
}
}
self.ida_h0u = self.ida_hh;
self.ida_kk = 0;
self.ida_kused = 0; // set in case of an error return before a step
// Check for exact zeros of the root functions at or near t0.
if self.ida_nrtfn > 0 {
self.r_check1()?;
}
// set phi[1] = hh*y'
let mut phi = self.ida_phi.index_axis_mut(Axis(0), 1);
phi *= self.ida_hh;
// Set the convergence test constants epsNewt and toldel
self.ida_eps_newt = self.ida_epcon;
self.nlp.ida_toldel = P::Scalar::pt0001() * self.ida_eps_newt;
} // end of first-call block.
// Call lperf function and set nstloc for later performance testing.
self.nlp.lp.ls_perf(&self.counters, false);
let mut nstloc = 0;
// If not the first call, perform all stopping tests.
if self.counters.ida_nst > 0 {
// First, check for a root in the last step taken, other than the last root found, if
// any. If itask = IDA_ONE_STEP and y(tn) was not returned because of an intervening
// root, return y(tn) now.
if self.ida_nrtfn > 0 {
let irfndp = self.ida_irfnd;
let ier = self.r_check2()?;
if let RootStatus::RootFound = ier {
self.ida_tretlast = self.ida_tlo;
*tret = self.ida_tlo;
return Ok(IdaSolveStatus::Root);
}
// If tn is distinct from tretlast (within roundoff), check remaining interval for roots
let troundoff = ((self.nlp.ida_tn).abs() + (self.ida_hh).abs())
* P::Scalar::epsilon()
* P::Scalar::hundred();
if (self.nlp.ida_tn - self.ida_tretlast).abs() > troundoff {
let ier = self.r_check3()?;
match ier {
// no root found
RootStatus::Continue => {
self.ida_irfnd = false;
match itask {
IdaTask::OneStep if irfndp => {
self.ida_tretlast = self.nlp.ida_tn;
*tret = self.nlp.ida_tn;
let _ier = self.get_solution(self.nlp.ida_tn);
return Ok(IdaSolveStatus::Success);
}
_ => {}
}
}
// a new root was found
RootStatus::RootFound => {
self.ida_irfnd = true;
self.ida_tretlast = self.ida_tlo;
*tret = self.ida_tlo;
return Ok(IdaSolveStatus::Root);
}
}
}
} // end of root stop check
// Now test for all other stop conditions.
let istate = self.stop_test1(tout, tret, itask);
match istate {
Err(_)
| Ok(IdaSolveStatus::Root)
| Ok(IdaSolveStatus::Success)
| Ok(IdaSolveStatus::TStop) => {
return istate;
}
_ => {}
}
}
// Looping point for internal steps.
#[cfg(feature = "profiler")]
profile_scope!(format!("solve loop"));
loop {
// Check for too many steps taken.
if (self.ida_mxstep > 0) && (nstloc >= self.ida_mxstep) {
*tret = self.nlp.ida_tn;
self.ida_tretlast = self.nlp.ida_tn;
// Here yy=yret and yp=ypret already have the current solution.
Err(IdaError::IllegalInput {
msg: format!(
"At t = {:.5e}, mxstep steps ({}) taken before reaching tout.",
self.nlp.ida_tn, self.ida_mxstep
),
})?
//istate = IDA_TOO_MUCH_WORK;
}
// Call lperf to generate warnings of poor performance.
self.nlp.lp.ls_perf(&self.counters, true);
// Reset and check ewt (if not first call).
if self.counters.ida_nst > 0 {
self.tol_control.ewt_set(
self.ida_phi.index_axis(Axis(0), 0),
self.nlp.ida_ewt.view_mut(),
);
if self.nlp.ida_ewt.iter().any(|&x| x <= P::Scalar::zero()) {
let _ier = self.get_solution(self.nlp.ida_tn);
*tret = self.nlp.ida_tn;
self.ida_tretlast = self.nlp.ida_tn;
//IDAProcessError(IDA_mem, IDA_ILL_INPUT, "IDA", "IDASolve", MSG_EWT_NOW_BAD, self.nlp.ida_tn);
Err(IdaError::IllegalInput {
msg: format!(
"At t = {:?} some ewt component has become <= 0.0.",
self.nlp.ida_tn
),
})?
}
}
// Check for too much accuracy requested.
let nrm = self.wrms_norm(
&self.ida_phi.index_axis(Axis(0), 0),
&self.nlp.ida_ewt,
self.ida_suppressalg,
);
self.ida_tolsf = P::Scalar::epsilon() * nrm;
if self.ida_tolsf > P::Scalar::one() {
self.ida_tolsf *= P::Scalar::ten();
*tret = self.nlp.ida_tn;
self.ida_tretlast = self.nlp.ida_tn;
if self.counters.ida_nst > 0 {
let _ier = self.get_solution(self.nlp.ida_tn);
}
//IDAProcessError(IDA_mem, IDA_ILL_INPUT, "IDA", "IDASolve", MSG_TOO_MUCH_ACC, self.nlp.ida_tn);
Err(IdaError::TooMuchAccuracy {
t: self.nlp.ida_tn.to_f64().unwrap(),
})?
}
// Call IDAStep to take a step.
let sflag = self.step();
// Process all failed-step cases, and exit loop.
sflag.map_err(|err| {
let ier = self.get_solution(self.nlp.ida_tn);
match ier {
Ok(_) => {
*tret = self.nlp.ida_tn;
self.ida_tretlast = self.nlp.ida_tn;
}
Err(e2) => {
error!("Error occured with get_solution: {:?}", e2.as_fail());
}
}
// Forward the error
err
})?;
nstloc += 1;
// After successful step, check for stop conditions; continue or break.
// First check for root in the last step taken.
if self.ida_nrtfn > 0 {
let ier = self.r_check3()?;
if let RootStatus::RootFound = ier {
// A new root was found
self.ida_irfnd = true;
self.ida_tretlast = self.ida_tlo;
*tret = self.ida_tlo;
return Ok(IdaSolveStatus::Root);
}
// If we are at the end of the first step and we still have some event functions
// that are inactive, issue a warning as this may indicate a user error in the
// implementation of the root function.
if self.counters.ida_nst == 1 {
let inactive_roots = self
.ida_gactive
.iter()
.fold(false, |inactive_roots, &gactive| inactive_roots | !gactive);
if (self.ida_mxgnull > 0) && inactive_roots {
warn!("At the end of the first step, there are still some root functions identically 0. This warning will not be issued again.");
}
}
}
// Now check all other stop conditions.
let istate = self.stop_test2(tout, tret, itask);
match istate {
Err(_)
| Ok(IdaSolveStatus::Root)
| Ok(IdaSolveStatus::Success)
| Ok(IdaSolveStatus::TStop) => {
return istate;
}
_ => {}
}
} // End of step loop
//return(istate);
}
}