fix import/export of ierode common on Windows
[scilab.git] / scilab / modules / differential_equations / src / fortran / lsodi.f
1 C/MEMBR ADD NAME=LSODI,SSI=0
2       subroutine lsodi (res, adda, jac, neq, y, ydoti, t, tout, itol,
3      1  rtol, atol, itask, istate, iopt, rwork, lrw, iwork, liw, mf )
4       external res, adda, jac
5       integer neq, itol, itask, istate, iopt, lrw, iwork, liw, mf
6       double precision y, ydoti, t, tout, rtol, atol, rwork
7       dimension neq(*), y(*), ydoti(*), rtol(*), atol(*), rwork(lrw),
8      1          iwork(liw)
9 c
10 c!purpose
11 c  livermore solver for ordinary differential equations (implicit form).
12 c lsodi solves the initial value problem for linearly implicit
13 c systems of first order ode-s,
14 c     a(t,y) * dy/dt = g(t,y) ,  where a(t,y) is a square matrix,
15 c or, in component form,
16 c     ( a   * ( dy / dt ))  + ... +  ( a     * ( dy   / dt ))  =
17 c        i,1      1                     i,neq      neq
18 c
19 c      =   g ( t, y , y ,..., y    )   ( i = 1,...,neq )
20 c           i      1   2       neq
21 c
22 c if a is singular, this is a differential-algebraic system.
23 c
24 c lsodi is a variant version of the lsode package.
25 c
26 c!summary of usage.
27 c
28 c communication between the user and the lsodi package, for normal
29 c situations, is summarized here.  this summary describes only a subset
30 c of the full set of options available.  see the full description for
31 c details, including optional communication, nonstandard options,
32 c and instructions for special situations.  see also the example
33 c problem (with program and output) following this summary.
34 c
35 c a. first, provide a subroutine of the form..
36 c               subroutine res (neq, t, y, s, r, ires)
37 c               dimension y(neq), s(neq), r(neq)
38 c which computes the residual function
39 c     r = g(t,y)  -  a(t,y) * s ,
40 c as a function of t and the vectors y and s.  (s is an internally
41 c generated approximation to dy/dt.)  the arrays y and s are inputs
42 c to the res routine and should not be altered.  the residual
43 c vector is to be stored in the array r.  the argument ires should be
44 c ignored for casual use of lsodi.  (for uses of ires, see the
45 c paragraph on res in the full description below.)
46 c
47 c b. next, decide whether full or banded form is more economical
48 c for the storage of matrices.  lsodi must deal internally with the
49 c matrices a and dr/dy, where r is the residual function defined above.
50 c lsodi generates a linear combination of these two matrices, and
51 c this is treated in either full or banded form.
52 c     the matrix structure is communicated by a method flag mf,
53 c which is 21 or 22 for the full case, and 24 or 25 in the band case.
54 c     in the banded case, lsodi requires two half-bandwidth
55 c parameters ml and mu.  these are, respectively, the widths of the
56 c lower and upper parts of the band, excluding the main diagonal.
57 c thus the band consists of the locations (i,j) with
58 c i-ml .le. j .le. i+mu, and the full bandwidth is ml+mu+1.
59 c note that the band must accommodate the nonzero elements of
60 c a(t,y), dg/dy, and d(a*s)/dy (s fixed).  alternatively, one
61 c can define a band that encloses only the elements that are relatively
62 c large in magnitude, and gain some economy in storage and possibly
63 c also efficiency, although the appropriate threshhold for
64 c retaining matrix elements is highly problem-dependent.
65 c
66 c c. you must also provide a subroutine of the form..
67 c               subroutine adda (neq, t, y, ml, mu, p, nrowp)
68 c               dimension y(neq), p(nrowp,neq)
69 c which adds the matrix a = a(t,y) to the contents of the array p.
70 c t and the y array are input and should not be altered.
71 c     in the full matrix case, this routine should add elements of
72 c to p in the usual order.  i.e., add a(i,j) to p(i,j).  (ignore the
73 c ml and mu arguments in this case.)
74 c     in the band matrix case, this routine should add element a(i,j)
75 c to p(i-j+mu+1,j).  i.e., add the diagonal lines of a to the rows of
76 c p from the top down (the top line of a added to the first row of p).
77 c
78 c d. for the sake of efficiency, you are encouraged to supply the
79 c jacobian matrix dr/dy in closed form, where r = g(t,y) - a(t,y)*s
80 c (s = a fixed vector) as above.  if dr/dy is being supplied,
81 c use mf = 21 or 24, and provide a subroutine of the form..
82 c               subroutine jac (neq, t, y, s, ml, mu, p, nrowp)
83 c               dimension y(neq), s(neq), p(nrowp,neq)
84 c which computes dr/dy as a function of t, y, and s.  here t, y, and
85 c s are inputs, and the routine is to load dr/dy into p as follows..
86 c     in the full matrix case (mf = 21), load p(i,j) with dr(i)/dy(j),
87 c the partial derivative of r(i) with respect to y(j).  (ignore the
88 c ml and mu arguments in this case.)
89 c     in the band matrix case (mf = 24), load p(i-j+mu+1,j) with
90 c dr(i)/dy(j), i.e. load the diagonal lines of dr/dy into the rows of
91 c p from the top down.
92 c     in either case, only nonzero elements need be loaded, and the
93 c indexing of p is the same as in the adda routine.
94 c     note that if a is independent of y (or this dependence
95 c is weak enough to be ignored) then jac is to compute dg/dy.
96 c     if it is not feasible to provide a jac routine, use
97 c mf = 22 or 25, and lsodi will compute an approximate jacobian
98 c internally by difference quotients.
99 c
100 c e. next decide whether or not to provide the initial value of the
101 c derivative vector dy/dt.  if the initial value of a(t,y) is
102 c nonsingular (and not too ill-conditioned), you may let lsodi compute
103 c this vector (istate = 0).  (lsodi will solve the system a*s = g for
104 c s, with initial values of a and g.)  if a(t,y) is initially
105 c singular, then the system is a differential-algebraic system, and
106 c you must make use of the particular form of the system to compute the
107 c initial values of y and dy/dt.  in that case, use istate = 1 and
108 c load the initial value of dy/dt into the array ydoti.
109 c the input array ydoti and the initial y array must be consistent with
110 c the equations a*dy/dt = g.  this implies that the initial residual
111 c r = g(t,y) - a(t,y)*ydoti   must be approximately zero.
112 c
113 c f. write a main program which calls subroutine lsodi once for
114 c each point at which answers are desired.  this should also provide
115 c for possible use of logical unit 6 for output of error messages
116 c by lsodi.  on the first call to lsodi, supply arguments as follows..
117 c res    = name of user subroutine for residual function r.
118 c adda   = name of user subroutine for computing and adding a(t,y).
119 c jac    = name of user subroutine for jacobian matrix dr/dy
120 c          (mf = 21 or 24).  if not used, pass a dummy name.
121 c note.. the names for the res and adda routines and (if used) the
122 c        jac routine must be declared external in the calling program.
123 c neq    = number of scalar equations in the system.
124 c y      = array of initial values, of length neq.
125 c ydoti  = array of length neq (containing initial dy/dt if istate = 1).
126 c t      = the initial value of the independent variable.
127 c tout   = first point where output is desired (.ne. t).
128 c itol   = 1 or 2 according as atol (below) is a scalar or array.
129 c rtol   = relative tolerance parameter (scalar).
130 c atol   = absolute tolerance parameter (scalar or array).
131 c          the estimated local error in y(i) will be controlled so as
132 c          to be roughly less (in magnitude) than
133 c             ewt(i) = rtol*abs(y(i)) + atol     if itol = 1, or
134 c             ewt(i) = rtol*abs(y(i)) + atol(i)  if itol = 2.
135 c          thus the local error test passes if, in each component,
136 c          either the absolute error is less than atol (or atol(i)),
137 c          or the relative error is less than rtol.
138 c          use rtol = 0.0 for pure absolute error control, and
139 c          use atol = 0.0 (or atol(i) = 0.0) for pure relative error
140 c          control.  caution.. actual (global) errors may exceed these
141 c          local tolerances, so choose them conservatively.
142 c itask  = 1 for normal computation of output values of y at t = tout.
143 c istate = integer flag (input and output).  set istate = 1 if the
144 c          initial dy/dt is supplied, and 0 otherwise.
145 c iopt   = 0 to indicate no optional inputs used.
146 c rwork  = real work array of length at least..
147 c             22 +  9*neq + neq**2           for mf = 21 or 22,
148 c             22 + 10*neq + (2*ml + mu)*neq  for mf = 24 or 25.
149 c lrw    = declared length of rwork (in user-s dimension).
150 c iwork  = integer work array of length at least 20 + neq.
151 c          if mf = 24 or 25, input in iwork(1),iwork(2) the lower
152 c          and upper half-bandwidths ml,mu.
153 c liw    = declared length of iwork (in user-s dimension).
154 c mf     = method flag.  standard values are..
155 c          21 for a user-supplied full jacobian.
156 c          22 for an internally generated full jacobian.
157 c          24 for a user-supplied banded jacobian.
158 c          25 for an internally generated banded jacobian.
159 c          for other choices of mf, see the paragraph on mf in
160 c          the full description below.
161 c note that the main program must declare arrays y, ydoti, rwork, iwork,
162 c and possibly atol.
163 c
164 c g. the output from the first call (or any call) is..
165 c      y = array of computed values of y(t) vector.
166 c      t = corresponding value of independent variable (normally tout).
167 c istate = 2  if lsodi was successful, negative otherwise.
168 c          -1 means excess work done on this call (check all inputs).
169 c          -2 means excess accuracy requested (tolerances too small).
170 c          -3 means illegal input detected (see printed message).
171 c          -4 means repeated error test failures (check all inputs).
172 c          -5 means repeated convergence failures (perhaps bad jacobian
173 c             supplied or wrong choice of tolerances).
174 c          -6 means error weight became zero during problem. (solution
175 c             component i vanished, and atol or atol(i) = 0.)
176 c          -7 cannot occur in casual use.
177 c          -8 means lsodi was unable to compute the initial dy/dt.
178 c             in casual use, this means a(t,y) is initially singular.
179 c             supply ydoti and use istate = 1 on the first call.
180 c
181 c  if lsodi returns istate = -1, -4, or -5, then the output of
182 c  lsodi also includes ydoti = array containing residual vector
183 c  r = g - a * dy/dt  evaluated at the current t, y, and dy/dt.
184 c
185 c h. to continue the integration after a successful return, simply
186 c reset tout and call lsodi again.  no other parameters need be reset.
187 c
188 c
189 c
190 c!example problem.
191 c
192 c the following is a simple example problem, with the coding
193 c needed for its solution by lsodi.  the problem is from chemical
194 c kinetics, and consists of the following three equations..
195 c     dy1/dt = -.04*y1 + 1.e4*y2*y3
196 c     dy2/dt = .04*y1 - 1.e4*y2*y3 - 3.e7*y2**2
197 c       0.   = y1 + y2 + y3 - 1.
198 c on the interval from t = 0.0 to t = 4.e10, with initial conditions
199 c y1 = 1.0, y2 = y3 = 0.
200 c
201 c the following coding solves this problem with lsodi, using mf = 21
202 c and printing results at t = .4, 4., ..., 4.e10.  it uses
203 c itol = 2 and atol much smaller for y2 than y1 or y3 because
204 c y2 has much smaller values.  dy/dt is supplied in ydoti. we had
205 c obtained the initial value of dy3/dt by differentiating the
206 c third equation and evaluating the first two at t=0.
207 c at the end of the run, statistical quantities of interest are
208 c printed (see optional outputs in the full description below).
209 c
210 c     external resid, aplusp, dgbydy
211 c     double precision atol, rwork, rtol, t, tout, y, ydoti
212 c     dimension y(3), ydoti(3), atol(3), rwork(58), iwork(23)
213 c     neq = 3
214 c     y(1) = 1.0d+0
215 c     y(2) = 0.0d+0
216 c     y(3) = 0.0d+0
217 c     ydoti(1) = -.040d+0
218 c     ydoti(2) =  .040d+0
219 c     ydoti(3) =  0.0d+0
220 c     t = 0.0d+0
221 c     tout = .40d+0
222 c     itol = 2
223 c     rtol = 1.0d-4
224 c     atol(1) = 1.0d-6
225 c     atol(2) = 1.0d-10
226 c     atol(3) = 1.0d-6
227 c     itask = 1
228 c     istate = 1
229 c     iopt = 0
230 c     lrw = 58
231 c     liw = 23
232 c     mf = 21
233 c     do 40  iout = 1,12
234 c        call lsodi(resid, aplusp, dgbydy, neq, y, ydoti, t, tout, itol,
235 c    1      rtol, atol, itask, istate, iopt, rwork, lrw, iwork, liw, mf)
236 c        write (6,20)  t, y(1), y(2), y(3)
237 c  20    format(7h at t =,e12.4,6h   y =,3e14.6)
238 c        if (istate .lt. 0 )  go to 80
239 c  40    tout = tout*10.0d+0
240 c     write (6,60)  iwork(11), iwork(12), iwork(13)
241 c  60 format(/12h no. steps =,i4,11h  no. r-s =,i4,
242 c    1         11h  no. j-s =,i4)
243 c     stop
244 c  80 write (6,90)  istate
245 c  90 format(///22h error halt.. istate =,i3)
246 c     stop
247 c     end
248 c
249 c     subroutine resid(neq, t, y, s, r, ires)
250 c     double precision r, s, t, y
251 c     dimension y(3), s(3), r(3)
252 c     r(1) = -0.040d+0*y(1) + 1.0d+4*y(2)*y(3) - s(1)
253 c     r(2) =  0.040d+0*y(1) - 1.0d+4*y(2)*y(3) - 3.0d+7*y(2)*y(2) - s(2)
254 c     r(3) = y(1) + y(2) + y(3) - 1.0d+0
255 c     return
256 c     end
257 c
258 c     subroutine aplusp(neq, t, y, ml, mu, p, nrowp)
259 c     double precision p, t, y
260 c     dimension y(3), p(nrowp,3)
261 c     p(1,1) = p(1,1) + 1.0d+0
262 c     p(2,2) = p(2,2) + 1.0d+0
263 c     return
264 c     end
265 c
266 c     subroutine dgbydy(neq, t, y, s, ml, mu, p, nrowp)
267 c     double precision s, t, p, y
268 c     dimension y(3), s(3), p(nrowp,3)
269 c     p(1,1) = -0.040d+0
270 c     p(1,2) =  1.0d+4*y(3)
271 c     p(1,3) =  1.0d+4*y(2)
272 c     p(2,1) =  0.040d+0
273 c     p(2,2) = -1.0d+4*y(3) - 6.0d+7*y(2)
274 c     p(2,3) = -1.0d+4*y(2)
275 c     p(3,1) =  1.0d+0
276 c     p(3,2) =  1.0d+0
277 c     p(3,3) =  1.0d+0
278 c     return
279 c     end
280 c
281 c the output of this program (on a cdc-7600 in single precision)
282 c is as follows..
283 c
284 c   at t =  4.0000e-01   y =  9.851726e-01  3.386406e-05  1.479357e-02
285 c   at t =  4.0000e+00   y =  9.055142e-01  2.240418e-05  9.446344e-02
286 c   at t =  4.0000e+01   y =  7.158050e-01  9.184616e-06  2.841858e-01
287 c   at t =  4.0000e+02   y =  4.504846e-01  3.222434e-06  5.495122e-01
288 c   at t =  4.0000e+03   y =  1.831701e-01  8.940379e-07  8.168290e-01
289 c   at t =  4.0000e+04   y =  3.897016e-02  1.621193e-07  9.610297e-01
290 c   at t =  4.0000e+05   y =  4.935213e-03  1.983756e-08  9.950648e-01
291 c   at t =  4.0000e+06   y =  5.159269e-04  2.064759e-09  9.994841e-01
292 c   at t =  4.0000e+07   y =  5.306413e-05  2.122677e-10  9.999469e-01
293 c   at t =  4.0000e+08   y =  5.494532e-06  2.197826e-11  9.999945e-01
294 c   at t =  4.0000e+09   y =  5.129457e-07  2.051784e-12  9.999995e-01
295 c   at t =  4.0000e+10   y = -7.170472e-08 -2.868188e-13  1.000000e+00
296 c
297 c   no. steps = 330  no. r-s = 404  no. j-s =  69
298 c
299 c!full description of user interface to lsodi.
300 c
301 c the user interface to lsodi consists of the following parts.
302 c
303 c i.   the call sequence to subroutine lsodi, which is a driver
304 c      routine for the solver.  this includes descriptions of both
305 c      the call sequence arguments and of user-supplied routines.
306 c      following these descriptions is a description of
307 c      optional inputs available through the call sequence, and then
308 c      a description of optional outputs (in the work arrays).
309 c
310 c ii.  descriptions of other routines in the lsodi package that may be
311 c      (optionally) called by the user.  these provide the ability to
312 c      alter error message handling, save and restore the internal
313 c      common, and obtain specified derivatives of the solution y(t).
314 c
315 c iii. descriptions of common blocks to be declared in overlay
316 c      or similar environments, or to be saved when doing an interrupt
317 c      of the problem and continued solution later.
318 c
319 c iv.  description of two subroutines in the lsodi package, either of
320 c      which the user may replace with his own version, if desired.
321 c      these relate to the measurement of errors.
322 c
323 c
324 c part i.  call sequence.
325 c
326 c the call sequence parameters used for input only are
327 c     res, adda, jac, neq, tout, itol, rtol, atol, itask,
328 c     iopt, lrw, liw, mf,
329 c and those used for both input and output are
330 c     y, t, istate, ydoti.
331 c the work arrays rwork and iwork are also used for conditional and
332 c optional inputs and optional outputs.  (the term output here refers
333 c to the return from subroutine lsodi to the user-s calling program.)
334 c
335 c the legality of input parameters will be thoroughly checked on the
336 c initial call for the problem, but not checked thereafter unless a
337 c change in input parameters is flagged by istate = 3 on input.
338 c
339 c the descriptions of the call arguments are as follows.
340 c
341 c res    = the name of the user-supplied subroutine which supplies
342 c          the residual vector for the ode system, defined by
343 c            r = g(t,y) - a(t,y) * s
344 c          as a function of the scalar t and the vectors
345 c          s and y ( s approximates dy/dt ). this
346 c          subroutine is to have the form
347 c              subroutine res ( neq, t, y, s, r, ires )
348 c              dimension y(*), s(*), r(*)
349 c          where neq, t, y, s, and ires are input, and r and
350 c          ires are output. y, s, and r are arrays of length neq.
351 c          in dimension statements such as that above, 1 is a
352 c          dummy dimension. it can be replaced by any value.
353 c             on input, ires indicates how lsodi will use the
354 c          returned array r, as follows..
355 c             ires = 1  means that lsodi needs the full residual,
356 c                       r = g - a*s, exactly.
357 c             ires = -1 means that lsodi is using r only to compute
358 c                       the jacobian dr/dy by difference quotients.
359 c          the res routine can ignore ires, or it can omit some terms
360 c          if ires = -1.  if a does not depend on y, then res can
361 c          just return r = g when ires = -1.  if g - a*s contains other
362 c          additive terms that are independent of y, these can also be
363 c          dropped, if done consistently, when ires = -1.
364 c             the subroutine should set the flag ires if it
365 c          encounters a halt condition or illegal input.
366 c          otherwise, it should not reset ires.  on output,
367 c             ires = 1 or -1 represents a normal return, and
368 c          lsodi continues integrating the ode.  leave ires
369 c          unchanged from its input value.
370 c             ires = 2 tells lsodi to immediately return control
371 c          to the calling program, with istate = 3.  this lets
372 c          the calling program change parameters of the prob-
373 c          lem if necessary.
374 c             ires = 3 represents an error condition (for example, an
375 c          illegal value of y). lsodi tries to integrate the ode without
376 c          getting ires = 3 from res.  if it cannot, lsodi returns
377 c          with istate = -7 or -1.
378 c            on an lsodi return with istate = 3, -1, or -7, the values
379 c          of t and y returned correspond to the last point reached
380 c          successfully without getting the flag ires = 2 or 3.
381 c            the flag values ires = 2 and 3 should not be used to
382 c          handle switches or root-stop conditions.  this is better
383 c          done by calling lsodi in a one-step mode and checking the
384 c          stopping function for a sign change at each step.
385 c            res must be declared external in the calling
386 c          program. see note below for more about res.
387 c
388 c adda   = the name of the user-supplied subroutine which adds
389 c          the matrix a = a(t,y) to another matrix stored in the same
390 c          form as a. the storage form is determined by miter (see
391 c          mf).  this subroutine is to have the form
392 c               subroutine adda ( neq, t, y, ml, mu, p, nrowp )
393 c               dimension y(*), p(nrowp,*)
394 c          where neq, t, y, ml, mu, and nrowp are input and p is
395 c          output. y is an array of length neq, and the matrix p is
396 c          stored in an nrowp by neq array.
397 c             in the full matrix case ( miter =  1 or 2 ) adda should
398 c          add  a    to p(i,j). ml and mu are ignored.
399 c                i,j
400 c             in the band matrix case ( miter = 4 or 5 ) adda should
401 c          add  a    to  p(i-j+mu+1,j).
402 c                i,j
403 c          see jac for details on this band storage form.
404 c             adda must be declared external in the calling program.
405 c          see note below for more information about adda.
406 c
407 c jac    = the name of the user-supplied subroutine which supplies
408 c          the jacobian matrix, dr/dy, where r = g-a*s. the form of the
409 c          jacobian matrix is determined by miter. jac is required
410 c          if miter = 1 or 4 -- otherwise a dummy name can be
411 c          passed. this subroutine is to have the form
412 c               subroutine jac ( neq, t, y, s, ml, mu, p, nrowp )
413 c               dimension y(*), s(*), p(nrowp,*)
414 c          where neq, t, y, s, ml, mu, and nrowp are input and p
415 c          is output. y and s are arrays of length neq, and the
416 c          matrix p is stored in an nrowp by neq array.
417 c          p is to be loaded with partial derivatives ( elements
418 c          of the jacobian matrix ) on output.
419 c             in the full matrix case ( miter = 1 ), ml and mu
420 c          are ignored and the jacobian is to be loaded into p
421 c          by columns- i.e., dr(i)/dy(j) is loaded into p(i,j).
422 c             in the band matrix case ( miter = 4 ), the ele-
423 c          ments within the band are to be loaded into p by
424 c          by columns, with diagonal lines of dr/dy loaded into
425 c          the rows of p.  thus dr(i)/dy(j) is to be loaded
426 c          into p(i-j+mu+1,j). the locations in p in the two
427 c          triangular areas which correspond to nonexistent matrix
428 c          elements can be ignored or loaded arbitrarily, as they
429 c          they are overwritten by lsodi. ml and mu are the half-
430 c          bandwidth parameters ( see iwork ).
431 c               in either case, p is preset to zero by the solver,
432 c          so that only the nonzero elements need be loaded by jac.
433 c          each call to jac is preceded by a call to res with the same
434 c          arguments neq, t, y, and s.  thus to gain some efficiency,
435 c          intermediate quantities shared by both calculations may be
436 c          saved in a user common block by res and not recomputed by jac
437 c          if desired.  also, jac may alter the y array, if desired.
438 c               jac need not provide dr/dy exactly.  a crude
439 c          approximation (possibly with a smaller bandwidth) will do.
440 c               jac must be declared external in the calling program.
441 c               see note below for more about jac.
442 c
443 c       note on res, adda, and jac--  these
444 c          subroutines may access user-defined quantities in
445 c          neq(2),... and y(neq(1)+1),... if neq is an array
446 c          (dimensioned in the subroutines) and y has length exceeding
447 c          neq(1). however, these subroutines should not alter
448 c          neq(1), y(1),...,y(neq) or any other input variables.
449 c          see the descriptions of neq and y below.
450 c
451 c neq    = the size of the system (number of first order ordinary
452 c          differential equations or scalar algebraic equations).
453 c          used only for input.
454 c          neq may be decreased, but not increased, during the problem.
455 c          if neq is decreased (with istate = 3 on input), the
456 c          remaining components of y should be left undisturbed, if
457 c          these are to be accessed in res, adda, or jac.
458 c
459 c          normally, neq is a scalar, and it is generally referred to
460 c          as a scalar in this user interface description.  however,
461 c          neq may be an array, with neq(1) set to the system size.
462 c          (the lsodi package accesses only neq(1).)  in either case,
463 c          this parameter is passed as the neq argument in all calls
464 c          to res, adda, and jac.  hence, if it is an array,
465 c          locations neq(2),... may be used to store other integer data
466 c          and pass it to  res, adda, or jac.  each such subroutine
467 c          must include neq in a dimension statement in that case.
468 c
469 c y      = a real array for the vector of dependent variables, of
470 c          length neq or more.  used for both input and output on the
471 c          first call (istate = 0 or 1), and only for output on other
472 c          calls.  on the first call, y must contain the vector of
473 c          initial values.  on output, y contains the computed solution
474 c          vector, evaluated at t.  if desired, the y array may be used
475 c          for other purposes between calls to the solver.
476 c
477 c          this array is passed as the y argument in all calls to res,
478 c          adda, and jac.  hence its length may exceed neq,
479 c          and locations y(neq+1),... may be used to store other real
480 c          data and pass it to res, adda, or jac.  (the lsodi
481 c          package accesses only y(1),...,y(neq). )
482 c
483 c ydoti  = a real array for the initial value of the vector
484 c          dy/dt and for work space, of dimension at least neq.
485 c
486 c          on input...
487 c            if istate = 0 then lsodi will compute the initial value
488 c          of dy/dt, if a is nonsingular.  thus ydoti will
489 c          serve only as work space and may have any value.
490 c            if istate = 1 then ydoti must contain the initial value
491 c          of dy/dt.
492 c            if istate = 2 or 3 (continuation calls) then ydoti
493 c          may have any value.
494 c            n.b.- if the initial value of a is singular, then
495 c          lsodi cannot compute the initial value of dy/dt, so
496 c          it must be provided in ydoti, with istate=1.
497 c
498 c          on output, when lsodi terminates abnormally with istate =
499 c          -1, -4, or -5, ydoti will contain the residual
500 c          r = g(t,y) - a(t,y)*(dy/dt).  if r is large, t is near
501 c          its initial value, and ydoti is supplied with istate=1,
502 c          there may have been an incorrect input value of
503 c          ydoti = dy/dt or the problem ( as given to lsodi )
504 c          may not have a solution.
505 c
506 c          if desired, the ydoti array may be used for other
507 c          purposes between calls to the solver.
508 c
509 c t      = the independent variable.  on input, t is used only on the
510 c          first call, as the initial point of the integration.
511 c          on output, after each call, t is the value at which a
512 c          computed solution y is evaluated (usually the same as tout).
513 c          on an error return, t is the farthest point reached.
514 c
515 c tout   = the next value of t at which a computed solution is desired.
516 c          used only for input.
517 c
518 c          when starting the problem (istate = 0 or 1), tout may be
519 c          equal to t for one call, then should .ne. t for the next
520 c          call.  for the initial t, an input value of tout .ne. t is
521 c          used in order to determine the direction of the integration
522 c          (i.e. the algebraic sign of the step sizes) and the rough
523 c          scale of the problem.  integration in either direction
524 c          (forward or backward in t) is permitted.
525 c
526 c          if itask = 2 or 5 (one-step modes), tout is ignored after
527 c          the first call (i.e. the first call with tout .ne. t).
528 c          otherwise, tout is required on every call.
529 c
530 c          if itask = 1, 3, or 4, the values of tout need not be
531 c          monotone, but a value of tout which backs up is limited
532 c          to the current internal t interval, whose endpoints are
533 c          tcur - hu and tcur (see optional outputs, below, for
534 c          tcur and hu).
535 c
536 c itol   = an indicator for the type of error control.  see
537 c          description below under atol.  used only for input.
538 c
539 c rtol   = a relative error tolerance parameter, either a scalar or
540 c          an array of length neq.  see description below under atol.
541 c          input only.
542 c
543 c atol   = an absolute error tolerance parameter, either a scalar or
544 c          an array of length neq.  input only.
545 c
546 c             the input parameters itol, rtol, and atol determine
547 c          the error control performed by the solver.  the solver will
548 c          control the vector e = (e(i)) of estimated local errors
549 c          in y, according to an inequality of the form
550 c                      rms-norm of ( e(i)/ewt(i) )   .le.   1,
551 c          where       ewt(i) = rtol(i)*abs(y(i)) + atol(i),
552 c          and the rms-norm (root-mean-square norm) here is
553 c          rms-norm(v) = sqrt(sum v(i)**2 / neq).  here ewt = (ewt(i))
554 c          is a vector of weights which must always be positive, and
555 c          the values of rtol and atol should all be non-negative.
556 c          the following table gives the types (scalar/array) of
557 c          rtol and atol, and the corresponding form of ewt(i).
558 c
559 c             itol    rtol       atol          ewt(i)
560 c              1     scalar     scalar     rtol*abs(y(i)) + atol
561 c              2     scalar     array      rtol*abs(y(i)) + atol(i)
562 c              3     array      scalar     rtol(i)*abs(y(i)) + atol
563 c              4     array      scalar     rtol(i)*abs(y(i)) + atol(i)
564 c
565 c          when either of these parameters is a scalar, it need not
566 c          be dimensioned in the user-s calling program.
567 c
568 c          if none of the above choices (with itol, rtol, and atol
569 c          fixed throughout the problem) is suitable, more general
570 c          error controls can be obtained by substituting
571 c          user-supplied routines for the setting of ewt and/or for
572 c          the norm calculation.  see part iv below.
573 c
574 c          if global errors are to be estimated by making a repeated
575 c          run on the same problem with smaller tolerances, then all
576 c          components of rtol and atol (i.e. of ewt) should be scaled
577 c          down uniformly
578 c
579 c itask  = an index specifying the task to be performed.
580 c          input only.  itask has the following values and meanings.
581 c          1  means normal computation of output values of y(t) at
582 c             t = tout (by overshooting and interpolating).
583 c          2  means take one step only and return.
584 c          3  means stop at the first internal mesh point at or
585 c             beyond t = tout and return.
586 c          4  means normal computation of output values of y(t) at
587 c             t = tout but without overshooting t = tcrit.
588 c             tcrit must be input as rwork(1).  tcrit may be equal to
589 c             or beyond tout, but not behind it in the direction of
590 c             integration.  this option is useful if the problem
591 c             has a singularity at or beyond t = tcrit.
592 c          5  means take one step, without passing tcrit, and return.
593 c             tcrit must be input as rwork(1).
594 c
595 c          note..  if itask = 4 or 5 and the solver reaches tcrit
596 c          (within roundoff), it will return t = tcrit (exactly) to
597 c          indicate this (unless itask = 4 and tout comes before tcrit,
598 c          in which case answers at t = tout are returned first).
599 c
600 c istate = an index used for input and output to specify the
601 c          state of the calculation.
602 c
603 c          on input, the values of istate are as follows.
604 c          0  means this is the first call for the problem, and
605 c             lsodi is to compute the initial value of dy/dt
606 c             (while doing other initializations).  see note below.
607 c          1  means this is the first call for the problem, and
608 c             the initial value of dy/dt has been supplied in
609 c             ydoti (lsodi will do other initializations). see note
610 c             below.
611 c          2  means this is not the first call, and the calculation
612 c             is to continue normally, with no change in any input
613 c             parameters except possibly tout and itask.
614 c             (if itol, rtol, and/or atol are changed between calls
615 c             with istate = 2, the new values will be used but not
616 c             tested for legality.)
617 c          3  means this is not the first call, and the
618 c             calculation is to continue normally, but with
619 c             a change in input parameters other than
620 c             tout and itask.  changes are allowed in
621 c             neq, itol, rtol, atol, iopt, lrw, liw, mf, ml, mu,
622 c             and any of the optional inputs except h0.
623 c             (see iwork description for ml and mu.)
624 c          note..  a preliminary call with tout = t is not counted
625 c          as a first call here, as no initialization or checking of
626 c          input is done.  (such a call is sometimes useful for the
627 c          purpose of outputting the initial conditions.)
628 c          thus the first call for which tout .ne. t requires
629 c          istate = 0 or 1 on input.
630 c
631 c          on output, istate has the following values and meanings.
632 c           0 or 1  means nothing was done, as tout was equal to t with
633 c              istate = 0 or 1 on input.  (however, an internal counter
634 c              was set to detect and prevent repeated calls of this
635 c              type. )
636 c           2  means that the integration was performed successfully.
637 c           3  means that the user-supplied subroutine res signalled
638 c              lsodi to halt the integration and return (ires=2).
639 c              integration as far as t was achieved with no occurrence
640 c              of ires=2, but this flag was set on attempting the next
641 c              step.
642 c          -1  means an excessive amount of work (more than mxstep
643 c              steps) was done on this call, before completing the
644 c              requested task, but the integration was otherwise
645 c              successful as far as t.  (mxstep is an optional input
646 c              and is normally 500.)  to continue, the user may
647 c              simply reset istate to a value .gt. 1 and call again
648 c              (the excess work step counter will be reset to 0).
649 c              in addition, the user may increase mxstep to avoid
650 c              this error return (see below on optional inputs).
651 c          -2  means too much accuracy was requested for the precision
652 c              of the machine being used.  this was detected before
653 c              completing the requested task, but the integration
654 c              was successful as far as t.  to continue, the tolerance
655 c              parameters must be reset, and istate must be set
656 c              to 3.  the optional output tolsf may be used for this
657 c              purpose.  (note.. if this condition is detected before
658 c              taking any steps, then an illegal input return
659 c              (istate = -3) occurs instead.)
660 c          -3  means illegal input was detected, before taking any
661 c              integration steps.  see written message for details.
662 c              note..  if the solver detects an infinite loop of calls
663 c              to the solver with illegal input, it will cause
664 c              the run to stop.
665 c          -4  means there were repeated error test failures on
666 c              one attempted step, before completing the requested
667 c              task, but the integration was successful as far as t.
668 c              the problem may have a singularity, or the input
669 c              may be inappropriate.
670 c          -5  means there were repeated convergence test failures on
671 c              one attempted step, before completing the requested
672 c              task, but the integration was successful as far as t.
673 c              this may be caused by an inaccurate jacobian matrix.
674 c          -6  means ewt(i) became zero for some i during the
675 c              integration.  pure relative error control (atol(i)=0.0)
676 c              was requested on a variable which has now vanished.
677 c              the integration was successful as far as t.
678 c          -7  means that the user-supplied subroutine res set
679 c              its error flag (ires = 3) despite repeated tries by
680 c              lsodi to avoid that condition.
681 c          -8  means that istate was 0 on input but lsodi was unable
682 c              to compute the initial value of dy/dt.  see the
683 c              printed message for details.
684 c
685 c          note..  since the normal output value of istate is 2,
686 c          it does not need to be reset for normal continuation.
687 c          similarly, istate need not be reset if res told lsodi
688 c          to return because the calling program must change
689 c          the parameters of the problem.
690 c          also, since a negative input value of istate will be
691 c          regarded as illegal, a negative output value requires the
692 c          user to change it, and possibly other inputs, before
693 c          calling the solver again.
694 c
695 c iopt   = an integer flag to specify whether or not any optional
696 c          inputs are being used on this call.  input only.
697 c          the optional inputs are listed separately below.
698 c          iopt = 0 means no optional inputs are being used.
699 c                   default values will be used in all cases.
700 c          iopt = 1 means one or more optional inputs are being used.
701 c
702 c rwork  = a real working array (double precision).
703 c          the length of rwork must be at least
704 c             20 + nyh*(maxord + 1) + 3*neq + lenwm    where
705 c          nyh    = the initial value of neq,
706 c          maxord = 12 (if meth = 1) or 5 (if meth = 2) (unless a
707 c                   smaller value is given as an optional input),
708 c          lenwm   = neq**2 + 2    if miter is 1 or 2, and
709 c          lenwm   = (2*ml+mu+1)*neq + 2 if miter is 4 or 5.
710 c          (see mf description for the definition of meth and miter.)
711 c          thus if maxord has its default value and neq is constant,
712 c          this length is
713 c             22 + 16*neq + neq**2         for mf = 11 or 12,
714 c             22 + 17*neq + (2*ml+mu)*neq  for mf = 14 or 15,
715 c             22 +  9*neq + neq**2         for mf = 21 or 22,
716 c             22 + 10*neq + (2*ml+mu)*neq  for mf = 24 or 25.
717 c          the first 20 words of rwork are reserved for conditional
718 c          and optional inputs and optional outputs.
719 c
720 c          the following word in rwork is a conditional input..
721 c            rwork(1) = tcrit = critical value of t which the solver
722 c                       is not to overshoot.  required if itask is
723 c                       4 or 5, and ignored otherwise.  (see itask.)
724 c
725 c lrw    = the length of the array rwork, as declared by the user.
726 c          (this will be checked by the solver.)
727 c
728 c iwork  = an integer work array.  the length of iwork must be at least
729 c          20 + neq .  the first few words of iwork are used for
730 c          conditional and optional inputs and optional outputs.
731 c
732 c          the following 2 words in iwork are conditional inputs..
733 c            iwork(1) = ml     these are the lower and upper
734 c            iwork(2) = mu     half-bandwidths, respectively, of the
735 c                       matrices in the problem-- the jacobian dr/dy
736 c                       and the left-hand side matrix a. these half-
737 c                       bandwidths exclude the main diagonal, so
738 c                       the total bandwidth is ml + mu + 1 .
739 c                       the band is defined by the matrix locations
740 c                       (i,j) with i-ml .le. j .le. i+mu.  ml and mu
741 c                       must satisfy  0 .le.  ml,mu  .le. neq-1.
742 c                       these are required if miter is 4 or 5, and
743 c                       ignored otherwise.
744 c                       ml and mu may in fact be the band parameters for
745 c                       matrices to which dr/dy and a are only
746 c                       approximately equal.
747 c
748 c liw    = the length of the array iwork, as declared by the user.
749 c          (this will be checked by the solver.)
750 c
751 c note..  the work arrays must not be altered between calls to lsodi
752 c for the same problem, except possibly for the conditional and
753 c optional inputs, and except for the last 3*neq words of rwork.
754 c the latter space is used for internal scratch space, and so is
755 c available for use by the user outside lsodi between calls, if
756 c desired (but not for use by res, adda, or jac).
757 c
758 c mf     = the method flag.  used only for input.  the legal values of
759 c          mf are 11, 12, 14, 15, 21, 22, 24, and 25.
760 c          mf has decimal digits meth and miter.. mf = 10*meth + miter.
761 c            meth indicates the basic linear multistep method..
762 c              meth = 1 means the implicit adams method.
763 c              meth = 2 means the method based on backward
764 c                       differentiation formulas (bdf-s).
765 c                the bdf method is strongly preferred for stiff prob-
766 c              lems, while the adams method is preferred when the prob-
767 c              lem is not stiff. if the matrix a(t,y) is nonsingular,
768 c              stiffness here can be taken to mean that of the explicit
769 c              ode system dy/dt = a**(-1) * g.  if a is singular, the
770 c              concept of stiffness is not well defined.
771 c                if you do not know whether the problem is stiff, we
772 c              recommend using meth = 2.  if it is stiff, the advan-
773 c              tage of meth = 2 over 1 will be great, while if it is
774 c              not stiff, the advantage of meth = 1 will be slight.
775 c              if maximum efficiency is important, some experimentation
776 c              with meth may be necessary.
777 c            miter indicates the corrector iteration method..
778 c              miter = 1 means chord iteration with a user-supplied
779 c                        full (neq by neq) jacobian.
780 c              miter = 2 means chord iteration with an internally
781 c                        generated (difference quotient) full jacobian.
782 c                        this uses neq+1 extra calls to res per dr/dy
783 c                        evaluation.
784 c              miter = 4 means chord iteration with a user-supplied
785 c                        banded jacobian.
786 c              miter = 5 means chord iteration with an internally
787 c                        generated banded jacobian (using ml+mu+2
788 c                        extra calls to res per dr/dy evaluation).
789 c              if miter = 1 or 4, the user must supply a subroutine jac
790 c              (the name is arbitrary) as described above under jac.
791 c              for other values of miter, a dummy argument can be used.
792 c
793 c!optional inputs.
794 c
795 c the following is a list of the optional inputs provided for in the
796 c call sequence.  (see also part ii.)  for each such input variable,
797 c this table lists its name as used in this documentation, its
798 c location in the call sequence, its meaning, and the default value.
799 c the use of any of these inputs requires iopt = 1, and in that
800 c case all of these inputs are examined.  a value of zero for any
801 c of these optional inputs will cause the default value to be used.
802 c thus to use a subset of the optional inputs, simply preload
803 c locations 5 to 10 in rwork and iwork to 0.0 and 0 respectively, and
804 c then set those of interest to nonzero values.
805 c
806 c name    location      meaning and default value
807 c
808 c h0      rwork(5)  the step size to be attempted on the first step.
809 c                   the default value is determined by the solver.
810 c
811 c hmax    rwork(6)  the maximum absolute step size allowed.
812 c                   the default value is infinite.
813 c
814 c hmin    rwork(7)  the minimum absolute step size allowed.
815 c                   the default value is 0.  (this lower bound is not
816 c                   enforced on the final step before reaching tcrit
817 c                   when itask = 4 or 5.)
818 c
819 c maxord  iwork(5)  the maximum order to be allowed.  the default
820 c                   value is 12 if meth = 1, and 5 if meth = 2.
821 c                   if maxord exceeds the default value, it will
822 c                   be reduced to the default value.
823 c                   if maxord is changed during the problem, it may
824 c                   cause the current order to be reduced.
825 c
826 c mxstep  iwork(6)  maximum number of (internally defined) steps
827 c                   allowed during one call to the solver.
828 c                   the default value is 500.
829 c
830 c mxhnil  iwork(7)  maximum number of messages printed (per problem)
831 c                   warning that t + h = t on a step (h = step size).
832 c                   this must be positive to result in a non-default
833 c                   value.  the default value is 10.
834 c
835 c!optional outputs.
836 c
837 c as optional additional output from lsodi, the variables listed
838 c below are quantities related to the performance of lsodi
839 c which are available to the user.  these are communicated by way of
840 c the work arrays, but also have internal mnemonic names as shown.
841 c except where stated otherwise, all of these outputs are defined
842 c on any successful return from lsodi, and on any return with
843 c istate = -1, -2, -4, -5, -6, or -7. on a return with -3 (illegal
844 c input) or -8, they will be unchanged from their existing values
845 c (if any), except possibly for tolsf, lenrw, and leniw.
846 c on any error return, outputs relevant to the error will be defined,
847 c as noted below.
848 c
849 c name    location      meaning
850 c
851 c hu      rwork(11) the step size in t last used (successfully).
852 c
853 c hcur    rwork(12) the step size to be attempted on the next step.
854 c
855 c tcur    rwork(13) the current value of the independent variable
856 c                   which the solver has actually reached, i.e. the
857 c                   current internal mesh point in t.  on output, tcur
858 c                   will always be at least as far as the argument
859 c                   t, but may be farther (if interpolation was done).
860 c
861 c tolsf   rwork(14) a tolerance scale factor, greater than 1.0,
862 c                   computed when a request for too much accuracy was
863 c                   detected (istate = -3 if detected at the start of
864 c                   the problem, istate = -2 otherwise).  if itol is
865 c                   left unaltered but rtol and atol are uniformly
866 c                   scaled up by a factor of tolsf for the next call,
867 c                   then the solver is deemed likely to succeed.
868 c                   (the user may also ignore tolsf and alter the
869 c                   tolerance parameters in any other way appropriate.)
870 c
871 c nst     iwork(11) the number of steps taken for the problem so far.
872 c
873 c nre     iwork(12) the number of residual evaluations (res calls)
874 c                   for the problem so far.
875 c
876 c nje     iwork(13) the number of jacobian evaluations (each involving
877 c                   an evaluation of a and dr/dy) for the problem so
878 c                   far.  this equals the number of calls to adda and
879 c                   (if miter = 1 or 4) jac, and the number of matrix
880 c                   l-u decompositions.
881 c
882 c nqu     iwork(14) the method order last used (successfully).
883 c
884 c nqcur   iwork(15) the order to be attempted on the next step.
885 c
886 c imxer   iwork(16) the index of the component of largest magnitude in
887 c                   the weighted local error vector ( e(i)/ewt(i) ),
888 c                   on an error return with istate = -4 or -5.
889 c
890 c lenrw   iwork(17) the length of rwork actually required.
891 c                   this is defined on normal returns and on an illegal
892 c                   input return for insufficient storage.
893 c
894 c leniw   iwork(18) the length of iwork actually required.
895 c                   this is defined on normal returns and on an illegal
896 c                   input return for insufficient storage.
897 c
898 c
899 c the following two arrays are segments of the rwork array which
900 c may also be of interest to the user as optional outputs.
901 c for each array, the table below gives its internal name,
902 c its base address in rwork, and its description.
903 c
904 c name    base address      description
905 c
906 c yh      21             the nordsieck history array, of size nyh by
907 c                        (nqcur + 1), where nyh is the initial value
908 c                        of neq.  for j = 0,1,...,nqcur, column j+1
909 c                        of yh contains hcur**j/factorial(j) times
910 c                        the j-th derivative of the interpolating
911 c                        polynomial currently representing the solution,
912 c                        evaluated at t = tcur.
913 c
914 c acor     lenrw-neq+1   array of size neq used for the accumulated
915 c                        corrections on each step, scaled on output to
916 c                        represent the estimated local error in y on the
917 c                        last step. this is the vector e in the descrip-
918 c                        tion of the error control.  it is defined only
919 c                        on a return from lsodi with istate = 2.
920 c
921 c
922 c!part ii.  other routines callable.
923 c
924 c the following are optional calls which the user may make to
925 c gain additional capabilities in conjunction with lsodi.
926 c (the routines xsetun and xsetf are designed to conform to the
927 c slatec error handling package.)
928 c
929 c     form of call                  function
930 c   call xsetun(lun)          set the logical unit number, lun, for
931 c                             output of messages from lsodi, if
932 c                             the default is not desired.
933 c                             the default value of lun is 6.
934 c
935 c   call xsetf(mflag)         set a flag to control the printing of
936 c                             messages by lsodi.
937 c                             mflag = 0 means do not print. (danger..
938 c                             this risks losing valuable information.)
939 c                             mflag = 1 means print (the default).
940 c
941 c                             either of the above calls may be made at
942 c                             any time and will take effect immediately.
943 c
944 c   call svcom (rsav, isav)   store in rsav and isav the contents
945 c                             of the internal common blocks used by
946 c                             lsodi (see part iii below).
947 c                             rsav must be a real array of length 219
948 c                             or more, and isav must be an integer
949 c                             array of length 41 or more.
950 c
951 c   call rscom (rsav, isav)   restore, from rsav and isav, the contents
952 c                             of the internal common blocks used by
953 c                             lsodi.  presumes a prior call to svcom
954 c                             with the same arguments.
955 c
956 c                             svcom and rscom are useful if
957 c                             interrupting a run and restarting
958 c                             later, or alternating between two or
959 c                             more problems solved with lsodi.
960 c
961 c   call intdy(,,,,,)         provide derivatives of y, of various
962 c        (see below)          orders, at a specified point t, if
963 c                             desired.  it may be called only after
964 c                             a successful return from lsodi.
965 c
966 c the detailed instructions for using intdy are as follows.
967 c the form of the call is..
968 c
969 c   call intdy (t, k, rwork(21), nyh, dky, iflag)
970 c
971 c the input parameters are..
972 c
973 c t         = value of independent variable where answers are desired
974 c             (normally the same as the t last returned by lsodi).
975 c             for valid results, t must lie between tcur - hu and tcur.
976 c             (see optional outputs for tcur and hu.)
977 c k         = integer order of the derivative desired.  k must satisfy
978 c             0 .le. k .le. nqcur, where nqcur is the current order
979 c             (see optional outputs).  the capability corresponding
980 c             to k = 0, i.e. computing y(t), is already provided
981 c             by lsodi directly.  since nqcur .ge. 1, the first
982 c             derivative dy/dt is always available with intdy.
983 c rwork(21) = the base address of the history array yh.
984 c nyh       = column length of yh, equal to the initial value of neq.
985 c
986 c the output parameters are..
987 c
988 c dky       = a real array of length neq containing the computed value
989 c             of the k-th derivative of y(t).
990 c iflag     = integer flag, returned as 0 if k and t were legal,
991 c             -1 if k was illegal, and -2 if t was illegal.
992 c             on an error return, a message is also written.
993 c
994 c!part iii.  common blocks.
995 c
996 c if lsodi is to be used in an overlay situation, the user
997 c must declare, in the primary overlay, the variables in..
998 c   (1) the call sequence to lsodi,
999 c   (2) the two internal common blocks
1000 c         /ls0001/  of length  258  (219 double precision words
1001 c                         followed by 39 integer words),
1002 c         /eh0001/  of length  2 (integer words).
1003 c
1004 c if lsodi is used on a system in which the contents of internal
1005 c common blocks are not preserved between calls, the user should
1006 c declare the above two common blocks in his main program to insure
1007 c that their contents are preserved.
1008 c
1009 c if the solution of a given problem by lsodi is to be interrupted
1010 c and then later continued, such as when restarting an interrupted run
1011 c or alternating between two or more problems, the user should save,
1012 c following the return from the last lsodi call prior to the
1013 c interruption, the contents of the call sequence variables and the
1014 c internal common blocks, and later restore these values before the
1015 c next lsodi call for that problem.  to save and restore the common
1016 c blocks, use subroutines svcom and rscom (see part ii above).
1017 c
1018 c
1019 c!part iv.  optionally replaceable solver routines.
1020 c
1021 c below are descriptions of two routines in the lsodi package which
1022 c relate to the measurement of errors.  either routine can be
1023 c replaced by a user-supplied version, if desired.  however, since such
1024 c a replacement may have a major impact on performance, it should be
1025 c done only when absolutely necessary, and only with great caution.
1026 c (note.. the means by which the package version of a routine is
1027 c superseded by the user-s version may be system-dependent.)
1028 c
1029 c (a) ewset.
1030 c the following subroutine is called just before each internal
1031 c integration step, and sets the array of error weights, ewt, as
1032 c described under itol/rtol/atol above..
1033 c     subroutine ewset (neq, itol, rtol, atol, ycur, ewt)
1034 c where neq, itol, rtol, and atol are as in the lsodi call sequence,
1035 c ycur contains the current dependent variable vector, and
1036 c ewt is the array of weights set by ewset.
1037 c
1038 c if the user supplies this subroutine, it must return in ewt(i)
1039 c (i = 1,...,neq) a positive quantity suitable for comparing errors
1040 c in y(i) to.  the ewt array returned by ewset is passed to the
1041 c vnorm routine (see below), and also used by lsodi in the computation
1042 c of the optional output imxer, the diagonal jacobian approximation,
1043 c and the increments for difference quotient jacobians.
1044 c
1045 c in the user-supplied version of ewset, it may be desirable to use
1046 c the current values of derivatives of y.  derivatives up to order nq
1047 c are available from the history array yh, described above under
1048 c optional outputs.  in ewset, yh is identical to the ycur array,
1049 c extended to nq + 1 columns with a column length of nyh and scale
1050 c factors of h**j/factorial(j).  on the first call for the problem,
1051 c given by nst = 0, nq is 1 and h is temporarily set to 1.0.
1052 c the quantities nq, nyh, h, and nst can be obtained by including
1053 c in ewset the statements..
1054 c     double precision h, rls
1055 c     common /ls0001/ rls(219),ils(39)
1056 c     nq = ils(35)
1057 c     nyh = ils(14)
1058 c     nst = ils(36)
1059 c     h = rls(213)
1060 c thus, for example, the current value of dy/dt can be obtained as
1061 c ycur(nyh+i)/h  (i=1,...,neq)  (and the division by h is
1062 c unnecessary when nst = 0).
1063 c
1064 c (b) vnorm.
1065 c the following is a real function routine which computes the weighted
1066 c root-mean-square norm of a vector v..
1067 c     d = vnorm (n, v, w)
1068 c where..
1069 c   n = the length of the vector,
1070 c   v = real array of length n containing the vector,
1071 c   w = real array of length n containing weights,
1072 c   d = sqrt( (1/n) * sum(v(i)*w(i))**2 ).
1073 c vnorm is called with n = neq and with w(i) = 1.0/ewt(i), where
1074 c ewt is as set by subroutine ewset.
1075 c
1076 c if the user supplies this function, it should return a non-negative
1077 c value of vnorm suitable for use in the error control in lsodi.
1078 c none of the arguments should be altered by vnorm.
1079 c for example, a user-supplied vnorm routine might..
1080 c   -substitute a max-norm of (v(i)*w(i)) for the rms-norm, or
1081 c   -ignore some components of v in the norm, with the effect of
1082 c    suppressing the error control on those components of y.
1083 c
1084 c
1085 c!other routines in the lsodi package.
1086 c
1087 c in addition to subroutine lsodi, the lsodi package includes the
1088 c following subroutines and function routines..
1089 c  ainvg    computes the initial value of the vector
1090 c             dy/dt = inverse(a) * g
1091 c  intdy    computes an interpolated value of the y vector at t = tout.
1092 c  stodi    is the core integrator, which does one step of the
1093 c           integration and the associated error control.
1094 c  cfode    sets all method coefficients and test constants.
1095 c  prepji   computes and preprocesses the jacobian matrix j = df/dy
1096 c           and the newton iteration matrix p = i - h*l0*j.
1097 c  solsy    manages solution of linear system in chord iteration.
1098 c  ewset    sets the error weight vector ewt before each step.
1099 c  vnorm    computes the weighted r.m.s. norm of a vector.
1100 c  svcom and rscom   are user-callable routines to save and restore,
1101 c           respectively, the contents of the internal common blocks.
1102 c  dgefa and dgesl   are routines from linpack for solving full
1103 c           systems of linear algebraic equations.
1104 c  dgbfa and dgbsl   are routines from linpack for solving banded
1105 c           linear systems.
1106 c  daxpy, dscal, idamax, and ddot   are basic linear algebra modules
1107 c           (blas) used by the above linpack routines.
1108 c  dlamch   computes the unit roundoff in a machine-independent manner.
1109 c  xerrwv, xsetun, and xsetf   handle the printing of all error
1110 c           messages and warnings.  xerrwv is machine-dependent.
1111 c note..  vnorm, idamax, ddot, and dlamch are function routines.
1112 c all the others are subroutines.
1113 c
1114 c the intrinsic and external routines used by lsodi are..  abs,
1115 c max, min, dble, abs, max, min, mod, sign, sqrt, and write.
1116 c
1117 c a block data subprogram is also included with the package,
1118 c for loading some of the variables in internal common.
1119 c
1120 c!authors
1121 c             jeffrey f. painter  and
1122 c             alan c. hindmarsh
1123 c             mathematics and statistics division, l-316
1124 c             lawrence livermore national laboratory
1125 c             livermore, ca 94550.
1126 c
1127 c!reference..
1128 c     alan c. hindmarsh,  lsode and lsodi, two new initial value
1129 c     ordinary differential equation solvers,
1130 c     acm-signum newsletter, vol. 15, no. 4 (1980), pp. 10-11.
1131 c
1132 c!
1133 c this is the may 9, 1983 version of lsodi.
1134 c this version is in double precision.
1135 c-----------------------------------------------------------------------
1136 c the following card is for optimized compilation on llnl compilers.
1137 clll. optimize
1138 c-----------------------------------------------------------------------
1139       include 'stack.h'
1140
1141       external prepji, solsy
1142       integer illin, init, lyh, lewt, lacor, lsavr, lwm, liwm,
1143      1   mxstep, mxhnil, nhnil, ntrep, nslast, nyh, iowns
1144       integer icf, ierpj, iersl, jcur, jstart, kflag, l, meth, miter,
1145      1   maxord, maxcor, msbp, mxncf, n, nq, nst, nre, nje, nqu
1146       integer i, i1, i2, ier, iflag, imxer, ires, kgo,
1147      1   leniw, lenrw, lenwm, lp, lyd0, ml, mord, mu, mxhnl0, mxstp0
1148       double precision tret, rowns,
1149      1   ccmax, el0, h, hmin, hmxi, hu, rc, tn, uround
1150       double precision atoli, ayi, big, ewti, h0, hmax, hmx, rh, rtoli,
1151      1   tcrit, tdist, tnext, tol, tolsf, tp, size, sum, w0,
1152      2   dlamch, vnorm
1153       dimension mord(2)
1154       logical ihit
1155 c-----------------------------------------------------------------------
1156 c the following internal common block contains
1157 c (a) variables which are local to any subroutine but whose values must
1158 c     be preserved between calls to the routine (own variables), and
1159 c (b) variables which are communicated between subroutines.
1160 c common block ls0001 is shared by the lsodi and lsode packages.
1161 c the structure of ls0001 is as follows..  all real variables are
1162 c listed first, followed by all integers.  within each type, the
1163 c variables are grouped with those local to subroutine lsodi first,
1164 c then those local to subroutine stodi, and finally those used
1165 c for communication.  the block is declared in subroutines
1166 c lsodi, intdy, stodi, prepji, and solsy.  groups of variables are
1167 c replaced by dummy arrays in the common declarations in routines
1168 c where those variables are not used.
1169 c-----------------------------------------------------------------------
1170       common /ls0001/ tret, rowns(209),
1171      1   ccmax, el0, h, hmin, hmxi, hu, rc, tn, uround,
1172      2   illin, init, lyh, lewt, lacor, lsavr, lwm, liwm,
1173      3   mxstep, mxhnil, nhnil, ntrep, nslast, nyh, iowns(6),
1174      4   icf, ierpj, iersl, jcur, jstart, kflag, l, meth, miter,
1175      5   maxord, maxcor, msbp, mxncf, n, nq, nst, nre, nje, nqu
1176 c
1177       data  mord(1),mord(2)/12,5/, mxstp0/500/, mxhnl0/10/
1178 c-----------------------------------------------------------------------
1179 c block a.
1180 c this code block is executed on every call.
1181 c it tests istate and itask for legality and branches appropiately.
1182 c if istate .gt. 1 but the flag init shows that initialization has
1183 c not yet been done, an error return occurs.
1184 c if istate = 0 or 1 and tout = t, jump to block g and return
1185 c immediately.
1186 c-----------------------------------------------------------------------
1187       ierror=0
1188       if (istate .lt. 0 .or. istate .gt. 3) go to 601
1189       if (itask .lt. 1 .or. itask .gt. 5) go to 602
1190       if (istate .le. 1) go to 10
1191       if (init .eq. 0) go to 603
1192       if (istate .eq. 2) go to 200
1193       go to 20
1194  10   init = 0
1195       if (tout .eq. t) go to 430
1196  20   ntrep = 0
1197 c-----------------------------------------------------------------------
1198 c block b.
1199 c the next code block is executed for the initial call (istate = 0 or 1)
1200 c or for a continuation call with parameter changes (istate = 3).
1201 c it contains checking of all inputs and various initializations.
1202 c
1203 c first check legality of the non-optional inputs neq, itol, iopt,
1204 c mf, ml, and mu.
1205 c-----------------------------------------------------------------------
1206       if (neq(1) .le. 0) go to 604
1207       if (istate .le. 1) go to 25
1208       if (neq(1) .gt. n) go to 605
1209  25   n = neq(1)
1210       if (itol .lt. 1 .or. itol .gt. 4) go to 606
1211       if (iopt .lt. 0 .or. iopt .gt. 1) go to 607
1212       meth = mf/10
1213       miter = mf - 10*meth
1214       if (meth .lt. 1 .or. meth .gt. 2) go to 608
1215       if (miter .le. 0 .or. miter .gt. 5) go to 608
1216       if (miter .eq. 3)  go to 608
1217       if (miter .lt. 3) go to 30
1218       ml = iwork(1)
1219       mu = iwork(2)
1220       if (ml .lt. 0 .or. ml .ge. n) go to 609
1221       if (mu .lt. 0 .or. mu .ge. n) go to 610
1222  30   continue
1223 c next process and check the optional inputs. --------------------------
1224       if (iopt .eq. 1) go to 40
1225       maxord = mord(meth)
1226       mxstep = mxstp0
1227       mxhnil = mxhnl0
1228       if (istate .le. 1) h0 = 0.0d+0
1229       hmxi = 0.0d+0
1230       hmin = 0.0d+0
1231       go to 60
1232  40   maxord = iwork(5)
1233       if (maxord .lt. 0) go to 611
1234       if (maxord .eq. 0) maxord = 100
1235       maxord = min(maxord,mord(meth))
1236       mxstep = iwork(6)
1237       if (mxstep .lt. 0) go to 612
1238       if (mxstep .eq. 0) mxstep = mxstp0
1239       mxhnil = iwork(7)
1240       if (mxhnil .lt. 0) go to 613
1241       if (mxhnil .eq. 0) mxhnil = mxhnl0
1242       if (istate .gt. 1) go to 50
1243       h0 = rwork(5)
1244       if ((tout - t)*h0 .lt. 0.0d+0) go to 614
1245  50   hmax = rwork(6)
1246       if (hmax .lt. 0.0d+0) go to 615
1247       hmxi = 0.0d+0
1248       if (hmax .gt. 0.0d+0) hmxi = 1.0d+0/hmax
1249       hmin = rwork(7)
1250       if (hmin .lt. 0.0d+0) go to 616
1251 c-----------------------------------------------------------------------
1252 c set work array pointers and check lengths lrw and liw.
1253 c pointers to segments of rwork and iwork are named by prefixing l to
1254 c the name of the segment.  e.g., the segment yh starts at rwork(lyh).
1255 c segments of rwork (in order) are denoted yh, wm, ewt, savr, acor.
1256 c-----------------------------------------------------------------------
1257  60   lyh = 21
1258       if (istate .le. 1) nyh = n
1259       lwm = lyh + (maxord + 1)*nyh
1260       if (miter .le. 2) lenwm = n*n + 2
1261       if (miter .ge. 4) lenwm = (2*ml + mu + 1)*n + 2
1262       lewt = lwm + lenwm
1263       lsavr = lewt + n
1264       lacor = lsavr + n
1265       lenrw = lacor + n - 1
1266       iwork(17) = lenrw
1267       liwm = 1
1268       leniw = 20 + n
1269       iwork(18) = leniw
1270       if (lenrw .gt. lrw) go to 617
1271       if (leniw .gt. liw) go to 618
1272 c check rtol and atol for legality. ------------------------------------
1273       rtoli = rtol(1)
1274       atoli = atol(1)
1275       do 70 i = 1,n
1276         if (itol .ge. 3) rtoli = rtol(i)
1277         if (itol .eq. 2 .or. itol .eq. 4) atoli = atol(i)
1278         if (rtoli .lt. 0.0d+0) go to 619
1279         if (atoli .lt. 0.0d+0) go to 620
1280  70     continue
1281       if (istate .le. 1) go to 100
1282 c if istate = 3, set flag to signal parameter changes to stodi. --------
1283       jstart = -1
1284       if (nq .le. maxord) go to 90
1285 c maxord was reduced below nq.  copy yh(*,maxord+2) into ydoti.---------
1286       do 80 i = 1,n
1287  80     ydoti(i) = rwork(i+lwm-1)
1288 c reload wm(1) = rwork(lwm), since lwm may have changed. ---------------
1289  90   rwork(lwm) = sqrt(uround)
1290       if (n .eq. nyh) go to 200
1291 c neq was reduced.  zero part of yh to avoid undefined references. -----
1292       i1 = lyh + l*nyh
1293       i2 = lyh + (maxord + 1)*nyh - 1
1294       if (i1 .gt. i2) go to 200
1295       do 95 i = i1,i2
1296  95     rwork(i) = 0.0d+0
1297       go to 200
1298 c-----------------------------------------------------------------------
1299 c block c.
1300 c the next block is for the initial call only (istate = 0 or 1).
1301 c it contains all remaining initializations, the call to ainvg
1302 c (if istate = 1), and the calculation of the initial step size.
1303 c the error weights in ewt are inverted after being loaded.
1304 c-----------------------------------------------------------------------
1305  100  uround = dlamch('p')
1306       tn = t
1307       if (itask .ne. 4 .and. itask .ne. 5) go to 105
1308       tcrit = rwork(1)
1309       if ((tcrit - tout)*(tout - t) .lt. 0.0d+0) go to 625
1310       if (h0 .ne. 0.0d+0 .and. (t + h0 - tcrit)*h0 .gt. 0.0d+0)
1311      1   h0 = tcrit - t
1312  105  jstart = 0
1313       rwork(lwm) = sqrt(uround)
1314       nhnil = 0
1315       nst = 0
1316       nre = 0
1317       nje = 0
1318       nslast = 0
1319       hu = 0.0d+0
1320       nqu = 0
1321       ccmax = 0.30d+0
1322       maxcor = 3
1323       msbp = 20
1324       mxncf = 10
1325 c compute initial dy/dt, if necessary, and load it and initial y into yh
1326       lyd0 = lyh + nyh
1327       lp = lwm + 1
1328       if (istate .eq. 1) go to 120
1329 c lsodi must compute initial dy/dt (lyd0 points to yh(*,2)). -----------
1330          call ainvg( res, adda, neq, t, y, rwork(lyd0), miter,
1331      1               ml, mu, rwork(lp), iwork(21), ier )
1332          nre = nre + 1
1333          if (ier .lt. 0) then
1334             goto 560
1335          elseif (ier .eq. 0) then
1336             goto 110
1337          else
1338             goto 565
1339          endif
1340  110     continue
1341          if(ierror.gt.0) return
1342          do 115  i = 1, n
1343  115        rwork(i+lyh-1) = y(i)
1344          go to 130
1345 c initial dy/dt has been supplied. -------------------------------------
1346  120     do 125  i = 1, n
1347             rwork(i+lyh-1) = y(i)
1348  125        rwork(i+lyd0-1) = ydoti(i)
1349 c load and invert the ewt array.  (h is temporarily set to 1.0.) -------
1350  130  continue
1351       nq = 1
1352       h = 1.0d+0
1353       call ewset (n, itol, rtol, atol, rwork(lyh), rwork(lewt))
1354       do 135 i = 1,n
1355         if (rwork(i+lewt-1) .le. 0.0d+0) go to 621
1356  135    rwork(i+lewt-1) = 1.0d+0/rwork(i+lewt-1)
1357 c-----------------------------------------------------------------------
1358 c the coding below computes the step size, h0, to be attempted on the
1359 c first step, unless the user has supplied a value for this.
1360 c first check that tout - t differs significantly from zero.
1361 c a scalar tolerance quantity tol is computed, as max(rtol(i))
1362 c if this is positive, or max(atol(i)/abs(y(i))) otherwise, adjusted
1363 c so as to be between 100*uround and 1.0e-3.
1364 c then the computed value h0 is given by..
1365 c                                      neq
1366 c   h0**2 = tol / ( w0**-2 + (1/neq) * sum ( ydot(i)/ywt(i) )**2  )
1367 c                                       1
1368 c where   w0      = max ( abs(t), abs(tout) ),
1369 c         ydot(i) = i-th component of initial value of dy/dt,
1370 c         ywt(i)  = ewt(i)/tol  (a weight for y(i)).
1371 c the sign of h0 is inferred from the initial values of tout and t.
1372 c-----------------------------------------------------------------------
1373       if (h0 .ne. 0.0d+0) go to 180
1374       tdist = abs(tout - t)
1375       w0 = max(abs(t),abs(tout))
1376       if (tdist .lt. 2.0d+0*uround*w0) go to 622
1377       tol = rtol(1)
1378       if (itol .le. 2) go to 145
1379       do 140 i = 1,n
1380  140    tol = max(tol,rtol(i))
1381  145  if (tol .gt. 0.0d+0) go to 160
1382       atoli = atol(1)
1383       do 150 i = 1,n
1384         if (itol .eq. 2 .or. itol .eq. 4) atoli = atol(i)
1385         ayi = abs(y(i))
1386         if (ayi .ne. 0.0d+0) tol = max(tol,atoli/ayi)
1387  150    continue
1388  160  tol = max(tol,100.0d+0*uround)
1389       tol = min(tol,0.0010d+0)
1390       sum = vnorm (n, rwork(lyd0), rwork(lewt))
1391       sum = 1.0d+0/(tol*w0*w0) + tol*sum**2
1392       h0 = 1.0d+0/sqrt(sum)
1393       h0 = min(h0,tdist)
1394       h0 = sign(h0,tout-t)
1395 c adjust h0 if necessary to meet hmax bound. ---------------------------
1396  180  rh = abs(h0)*hmxi
1397       if (rh .gt. 1.0d+0) h0 = h0/rh
1398 c load h with h0 and scale yh(*,2) by h0. ------------------------------
1399       h = h0
1400       do 190 i = 1,n
1401  190    rwork(i+lyd0-1) = h0*rwork(i+lyd0-1)
1402       go to 270
1403 c-----------------------------------------------------------------------
1404 c block d.
1405 c the next code block is for continuation calls only (istate = 2 or 3)
1406 c and is to check stop conditions before taking a step.
1407 c-----------------------------------------------------------------------
1408  200  nslast = nst
1409       go to (210, 250, 220, 230, 240), itask
1410  210  if ((tn - tout)*h .lt. 0.0d+0) go to 250
1411       call intdy (tout, 0, rwork(lyh), nyh, y, iflag)
1412       if (iflag .ne. 0) go to 627
1413       t = tout
1414       go to 420
1415  220  tp = tn - hu*(1.0d+0 + 100.0d+0*uround)
1416       if ((tp - tout)*h .gt. 0.0d+0) go to 623
1417       if ((tn - tout)*h .lt. 0.0d+0) go to 250
1418       go to 400
1419  230  tcrit = rwork(1)
1420       if ((tn - tcrit)*h .gt. 0.0d+0) go to 624
1421       if ((tcrit - tout)*h .lt. 0.0d+0) go to 625
1422       if ((tn - tout)*h .lt. 0.0d+0) go to 245
1423       call intdy (tout, 0, rwork(lyh), nyh, y, iflag)
1424       if (iflag .ne. 0) go to 627
1425       t = tout
1426       go to 420
1427  240  tcrit = rwork(1)
1428       if ((tn - tcrit)*h .gt. 0.0d+0) go to 624
1429  245  hmx = abs(tn) + abs(h)
1430       ihit = abs(tn - tcrit) .le. 100.0d+0*uround*hmx
1431       if (ihit) go to 400
1432       tnext = tn + h*(1.0d+0 + 4.0d+0*uround)
1433       if ((tnext - tcrit)*h .le. 0.0d+0) go to 250
1434       h = (tcrit - tn)*(1.0d+0 - 4.0d+0*uround)
1435       if (istate .eq. 2) jstart = -2
1436 c-----------------------------------------------------------------------
1437 c block e.
1438 c the next block is normally executed for all calls and contains
1439 c the call to the one-step core integrator stodi.
1440 c
1441 c this is a looping point for the integration steps.
1442 c
1443 c first check for too many steps being taken, update ewt (if not at
1444 c start of problem), check for too much accuracy being requested, and
1445 c check for h below the roundoff level in t.
1446 c-----------------------------------------------------------------------
1447  250  continue
1448       if ((nst-nslast) .ge. mxstep) go to 500
1449       call ewset (n, itol, rtol, atol, rwork(lyh), rwork(lewt))
1450       do 260 i = 1,n
1451         if (rwork(i+lewt-1) .le. 0.0d+0) go to 510
1452  260    rwork(i+lewt-1) = 1.0d+0/rwork(i+lewt-1)
1453  270  tolsf = uround*vnorm (n, rwork(lyh), rwork(lewt))
1454       if (tolsf .le. 1.0d+0) go to 280
1455       tolsf = tolsf*2.0d+0
1456       if (nst .eq. 0) go to 626
1457       go to 520
1458  280  if ((tn + h) .ne. tn) go to 290
1459       nhnil = nhnil + 1
1460       if (nhnil .gt. mxhnil) go to 290
1461       call xerrwv('lsodi--  attention.. t (=r1) and h (=r2) are',
1462      1   50, 101, 1, 0, 0, 0, 0, 0.0d+0, 0.0d+0)
1463       call xerrwv(
1464      1 '    such that  t + h = t at next step',
1465      1   60, 101, 1, 0, 0, 0, 0, 0.0d+0, 0.0d+0)
1466       call xerrwv('      (h = pas). integration continues',
1467      1   50, 101, 1, 0, 0, 0, 2, tn, h)
1468       if (nhnil .lt. mxhnil) go to 290
1469       call xerrwv('lsodi--  previous message has been given i1 times',
1470      1   50, 102, 1, 0, 0, 0, 0, 0.0d+0, 0.0d+0)
1471       call xerrwv('     it will not be repeated',
1472      1   50, 102, 1, 1, mxhnil, 0, 0, 0.0d+0, 0.0d+0)
1473  290  continue
1474 c-----------------------------------------------------------------------
1475 c     call stodi(neq,y,yh,nyh,yh1,ewt,savf,savr,acor,wm,iwm,res,
1476 c                adda,jac,prepji,solsy)
1477 c note... savf in stodi occupies the same space as ydoti in lsodi.
1478 c-----------------------------------------------------------------------
1479       call stodi (neq, y, rwork(lyh), nyh, rwork(lyh), rwork(lewt),
1480      1   ydoti, rwork(lsavr), rwork(lacor), rwork(lwm),
1481      2   iwork(liwm), res, adda, jac, prepji, solsy )
1482       if(ierror.gt.0) return
1483       kgo = 1 - kflag
1484       go to (300, 530, 540, 400, 550), kgo
1485 c
1486 c kgo = 1,success. 2,error test failure. 3,convergence failure.
1487 c       4,res ordered return. 5,res returned error.
1488 c-----------------------------------------------------------------------
1489 c block f.
1490 c the following block handles the case of a successful return from the
1491 c core integrator (kflag = 0).  test for stop conditions.
1492 c-----------------------------------------------------------------------
1493  300  init = 1
1494       go to (310, 400, 330, 340, 350), itask
1495 c itask = 1.  if tout has been reached, interpolate. -------------------
1496  310  if ((tn - tout)*h .lt. 0.0d+0) go to 250
1497       call intdy (tout, 0, rwork(lyh), nyh, y, iflag)
1498       t = tout
1499       go to 420
1500 c itask = 3.  jump to exit if tout was reached. ------------------------
1501  330  if ((tn - tout)*h .ge. 0.0d+0) go to 400
1502       go to 250
1503 c itask = 4.  see if tout or tcrit was reached.  adjust h if necessary.
1504  340  if ((tn - tout)*h .lt. 0.0d+0) go to 345
1505       call intdy (tout, 0, rwork(lyh), nyh, y, iflag)
1506       t = tout
1507       go to 420
1508  345  hmx = abs(tn) + abs(h)
1509       ihit = abs(tn - tcrit) .le. 100.0d+0*uround*hmx
1510       if (ihit) go to 400
1511       tnext = tn + h*(1.0d+0 + 4.0d+0*uround)
1512       if ((tnext - tcrit)*h .le. 0.0d+0) go to 250
1513       h = (tcrit - tn)*(1.0d+0 - 4.0d+0*uround)
1514       jstart = -2
1515       go to 250
1516 c itask = 5.  see if tcrit was reached and jump to exit. ---------------
1517  350  hmx = abs(tn) + abs(h)
1518       ihit = abs(tn - tcrit) .le. 100.0d+0*uround*hmx
1519 c-----------------------------------------------------------------------
1520 c block g.
1521 c the following block handles all successful returns from lsodi.
1522 c if itask .ne. 1, y is loaded from yh and t is set accordingly.
1523 c istate is set to 2, the illegal input counter is zeroed, and the
1524 c optional outputs are loaded into the work arrays before returning.  if
1525 c istate = 0 or 1 and tout = t, there is a return with no action taken,
1526 c except that if this has happened repeatedly, the run is terminated.
1527 c-----------------------------------------------------------------------
1528  400  do 410 i = 1,n
1529  410    y(i) = rwork(i+lyh-1)
1530       t = tn
1531       if (itask .ne. 4 .and. itask .ne. 5) go to 420
1532       if (ihit) t = tcrit
1533  420  istate = 2
1534       if (kflag .eq. -3) istate = 3
1535       illin = 0
1536       rwork(11) = hu
1537       rwork(12) = h
1538       rwork(13) = tn
1539       iwork(11) = nst
1540       iwork(12) = nre
1541       iwork(13) = nje
1542       iwork(14) = nqu
1543       iwork(15) = nq
1544       return
1545 c
1546  430  ntrep = ntrep + 1
1547       if (ntrep .lt. 5) return
1548       call xerrwv(
1549      1  'lsodi--  repeated calls with istate=0 or 1 and tout=t (r1)  ',
1550      1   60, 301, 1, 0, 0, 0, 1, t, 0.0d+0)
1551       go to 800
1552 c-----------------------------------------------------------------------
1553 c block h.
1554 c the following block handles all unsuccessful returns other than
1555 c those for illegal input.  first the error message routine is called.
1556 c if there was an error test or convergence test failure, imxer is set.
1557 c then y is loaded from yh, t is set to tn, and the illegal input
1558 c counter illin is set to 0.  the optional outputs are loaded into
1559 c the work arrays before returning.
1560 c-----------------------------------------------------------------------
1561 c the maximum number of steps was taken before reaching tout. ----------
1562  500  call xerrwv('lsodi--  at t (=r1), mxstep (=i1) steps   ',
1563      1   50, 201, 1, 0, 0, 0, 0, 0.0d+0, 0.0d+0)
1564       call xerrwv('necessary before reaching tout',
1565      1   50, 201, 1, 1, mxstep, 0, 1, tn, 0.0d+0)
1566       istate = -1
1567       go to 580
1568 c ewt(i) .le. 0.0 for some i (not at start of problem). ----------------
1569  510  ewti = rwork(lewt+i-1)
1570       call xerrwv('lsodi--  at t (=r1), ewt(i1) (r2) is .le. 0',
1571      1   50, 202, 1, 1, i, 0, 2, tn, ewti)
1572       istate = -6
1573       go to 590
1574  520  call xerrwv('lsodi--  at t (=r1),  too much precision required',
1575 c too much accuracy requested for machine precision. -------------------
1576      1   50, 203, 1, 0, 0, 0, 0, 0.0d+0, 0.0d+0)
1577       call xerrwv(' w.r.t. machine precision  tolsf (=r2) ',
1578      1   50, 203, 1, 0, 0, 0, 2, tn, tolsf)
1579       rwork(14) = tolsf
1580       istate = -2
1581       go to 590
1582 c kflag = -1.  error test failed repeatedly or with abs(h) = hmin. -----
1583  530  call xerrwv('lsodi--  at t(=r1) anf for h(=r2), error',
1584      1   50, 204, 1, 0, 0, 0, 0, 0.0d+0, 0.0d+0)
1585       call xerrwv('      test failed with abs(h) = hmin',
1586      1   50, 204, 1, 0, 0, 0, 2, tn, h)
1587       istate = -4
1588       go to 570
1589 c kflag = -2.  convergence failed repeatedly or with abs(h) = hmin. ----
1590  540  call xerrwv('lsodi--  at t (=r1) for step h (=r2), le'    ,
1591      1   50, 205, 1, 0, 0, 0, 0, 0.0d+0, 0.0d+0)
1592       call xerrwv('    corrector does not converge ',
1593      1   50, 205, 1, 0, 0, 0, 0, 0.0d+0, 0.0d+0)
1594       call xerrwv('      with abs(h) = hmin   ',
1595      1   30, 205, 1, 0, 0, 0, 2, tn, h)
1596       istate = -5
1597       go to 570
1598 c ires = 3 returned by res, despite retries by stodi. ------------------
1599  550  call xerrwv('lsodi--  at t (=r1) repeated error (ires=3) due to ',
1600      1   50, 206, 1, 0, 0, 0, 0, 0.0d+0, 0.0d+0 )
1601       call xerrwv('routine which evaluates the residue', 30, 206, 1,
1602      1   0, 0, 0, 1, tn, 0.0d+0 )
1603       istate = -7
1604       go to 590
1605 c ainvg failed because a-matrix was singular. --------------------------
1606  560  ier = -ier
1607       call xerrwv(
1608      1 'lsodi-- initialization failed dy/dt: singular matrix',
1609      1   60, 207, 1, 0, 0, 0, 0, 0.0d+0, 0.0d+0 )
1610       call xerrwv('dgefa or dgbfa return info=(i1)',
1611      2   50, 207, 1, 1, ier, 0, 0, 0.0d+0, 0.0d+0 )
1612       istate = -8
1613       return
1614 c ainvg failed because res set ires to 2 or 3. -------------------------
1615  565  call xerrwv('lsodi--  initialisation failed dy/dt:  routine',
1616      1   50, 208, 1, 0, 0, 0, 0, 0.0d+0, 0.0d+0 )
1617       call xerrwv('      of residue evaluation returns:',
1618      1   50, 208, 1, 0, 0, 0, 0, 0.0d+0, 0.0d+0 )
1619       call xerrwv('       ires = (i1)',
1620      1   20, 208, 1, 1, ier, 0, 0, 0.0d+0, 0.0d+0 )
1621       istate = -8
1622       return
1623 c compute imxer if relevant. -------------------------------------------
1624  570  big = 0.0d+0
1625       imxer = 1
1626       do 575 i = 1,n
1627         size = abs(rwork(i+lacor-1)*rwork(i+lewt-1))
1628         if (big .ge. size) go to 575
1629         big = size
1630         imxer = i
1631  575    continue
1632       iwork(16) = imxer
1633 c compute residual if relevant. ----------------------------------------
1634  580  lyd0 = lyh + nyh
1635       do 585  i = 1, n
1636          rwork( i+lsavr-1 ) = rwork( i+lyd0-1 ) / h
1637  585     y(i) = rwork( i+lyh-1 )
1638       ires = 1
1639       call res ( neq, tn, y, rwork(lsavr), ydoti, ires )
1640       if(ierror.gt.0) return
1641       nre = nre + 1
1642       if (ires .le. 1) go to 595
1643       call xerrwv('lsodi--  routine for evaluation od residue returns',
1644      1    50, 210, 1, 0, 0, 0, 0, 0.0d+0, 0.0d+0 )
1645       call xerrwv('    ires=i1 ' ,
1646      1     50, 210, 1, 1, ires, 0, 0, 0.0d+0, 0.0d+0 )
1647       go to 595
1648 c set y vector, t, illin, and optional outputs. ------------------------
1649  590  do 592 i = 1,n
1650  592    y(i) = rwork(i+lyh-1)
1651  595  t = tn
1652       illin = 0
1653       rwork(11) = hu
1654       rwork(12) = h
1655       rwork(13) = tn
1656       iwork(11) = nst
1657       iwork(12) = nre
1658       iwork(13) = nje
1659       iwork(14) = nqu
1660       iwork(15) = nq
1661       return
1662 c-----------------------------------------------------------------------
1663 c block i.
1664 c the following block handles all error returns due to illegal input
1665 c (istate = -3), as detected before calling the core integrator.
1666 c first the error message routine is called.  then if there have been
1667 c 5 consecutive such returns just before this call to the solver,
1668 c the run is halted.
1669 c-----------------------------------------------------------------------
1670  601  call xerrwv('lsodi--  istate (=i1) illegal ',
1671      1   30, 1, 1, 1, istate, 0, 0, 0.0d+0, 0.0d+0)
1672       go to 700
1673  602  call xerrwv('lsodi--  itask (=i1) illegal  ',
1674      1   30, 2, 1, 1, itask, 0, 0, 0.0d+0, 0.0d+0)
1675       go to 700
1676  603  call xerrwv('lsodi--  istate .gt. 1 ',
1677      1   50, 3, 1, 0, 0, 0, 0, 0.0d+0, 0.0d+0)
1678       go to 700
1679  604  call xerrwv('lsodi--  neq (=i1) .lt. 1     ',
1680      1   30, 4, 1, 1, neq(1), 0, 0, 0.0d+0, 0.0d+0)
1681       go to 700
1682  605  call xerrwv('lsodi--  istate = 3 et neq jumps from i1 to i2' ,
1683      1   50, 5, 1, 2, n, neq(1), 0, 0.0d+0, 0.0d+0)
1684       go to 700
1685  606  call xerrwv('lsodi--  itol (=i1) illegal   ',
1686      1   30, 6, 1, 1, itol, 0, 0, 0.0d+0, 0.0d+0)
1687       go to 700
1688  607  call xerrwv('lsodi--  iopt (=i1) illegal   ',
1689      1   30, 7, 1, 1, iopt, 0, 0, 0.0d+0, 0.0d+0)
1690       go to 700
1691  608  call xerrwv('lsodi--  mf (=i1) illegal     ',
1692      1   30, 8, 1, 1, mf, 0, 0, 0.0d+0, 0.0d+0)
1693       go to 700
1694  609  call xerrwv('lsodi--  ml (=i1) illegal.. .lt.0 or .ge.neq (=i2)',
1695      1   50, 9, 1, 2, ml, neq(1), 0, 0.0d+0, 0.0d+0)
1696       go to 700
1697  610  call xerrwv('lsodi--  mu (=i1) illegal.. .lt.0 or .ge.neq (=i2)',
1698      1   50, 10, 1, 2, mu, neq(1), 0, 0.0d+0, 0.0d+0)
1699       go to 700
1700  611  call xerrwv('lsodi--  maxord (=i1) .lt. 0  ',
1701      1   30, 11, 1, 1, maxord, 0, 0, 0.0d+0, 0.0d+0)
1702       go to 700
1703  612  call xerrwv('lsodi--  mxstep (=i1) .lt. 0  ',
1704      1   30, 12, 1, 1, mxstep, 0, 0, 0.0d+0, 0.0d+0)
1705       go to 700
1706  613  call xerrwv('lsodi--  mxhnil (=i1) .lt. 0  ',
1707      1   30, 13, 1, 1, mxhnil, 0, 0, 0.0d+0, 0.0d+0)
1708       go to 700
1709  614  call xerrwv('lsodi--  tout (=r1)  .gt.  t (=r2)      ',
1710      1   40, 14, 1, 0, 0, 0, 2, tout, t)
1711       call xerrwv('      h0 (=r1) gives integration direction'  ,
1712      1   50, 14, 1, 0, 0, 0, 1, h0, 0.0d+0)
1713       go to 700
1714  615  call xerrwv('lsodi--  hmax (=r1) .lt. 0.0  ',
1715      1   30, 15, 1, 0, 0, 0, 1, hmax, 0.0d+0)
1716       go to 700
1717  616  call xerrwv('lsodi--  hmin (=r1) .lt. 0.0  ',
1718      1   30, 16, 1, 0, 0, 0, 1, hmin, 0.0d+0)
1719       go to 700
1720  617  call xerrwv(
1721      1 'lsodi-- necessary size for  rwork (i1) larger than i2',
1722      1   60, 17, 1, 2, lenrw, lrw, 0, 0.0d+0, 0.0d+0)
1723       go to 700
1724  618  call xerrwv(
1725      1 'lsodi-- necessary size for  iwork (i1) larger than i2',
1726      1   60, 18, 1, 2, leniw, liw, 0, 0.0d+0, 0.0d+0)
1727       go to 700
1728  619  call xerrwv('lsodi--  rtol(i1) is r1 .lt. 0.0        ',
1729      1   40, 19, 1, 1, i, 0, 1, rtoli, 0.0d+0)
1730       go to 700
1731  620  call xerrwv('lsodi--  atol(i1) is r1 .lt. 0.0        ',
1732      1   40, 20, 1, 1, i, 0, 1, atoli, 0.0d+0)
1733       go to 700
1734  621  ewti = rwork(lewt+i-1)
1735       call xerrwv('lsodi--  ewt(i1) (=r1) is  .le. 0.0         ',
1736      1   40, 21, 1, 1, i, 0, 1, ewti, 0.0d+0)
1737       go to 700
1738  622  call xerrwv(
1739      1  'lsodi--  tout (=r1) too close to t(=r2) ',
1740      1   60, 22, 1, 0, 0, 0, 2, tout, t)
1741       go to 700
1742  623  call xerrwv(
1743      1  'lsodi--  itask = i1 and tout (=r1) .gt. tcur - hu (= r2)  ',
1744      1   60, 23, 1, 1, itask, 0, 2, tout, tp)
1745       go to 700
1746  624  call xerrwv(
1747      1  'lsodi--  itask = 4 or 5 and tcrit (=r1) .gt. tcur (=r2)   ',
1748      1   60, 24, 1, 0, 0, 0, 2, tcrit, tn)
1749       go to 700
1750  625  call xerrwv(
1751      1  'lsodi--  itask = 4 or 5 and tcrit (=r1)  .gt.  tout (=r2)',
1752      1   60, 25, 1, 0, 0, 0, 2, tcrit, tout)
1753       go to 700
1754  626  call xerrwv('lsodi-- too much accuracy required',
1755      1   50, 26, 1, 0, 0, 0, 0, 0.0d+0, 0.0d+0)
1756       call xerrwv(
1757      1 'w.r.t machine precision tolsf (=r1)',
1758      1   60, 26, 1, 0, 0, 0, 1, tolsf, 0.0d+0)
1759       rwork(14) = tolsf
1760       go to 700
1761  627  call xerrwv('lsodi--  problems due to intdy. itask=i1,tout=r1',
1762      1   50, 27, 1, 1, itask, 0, 1, tout, 0.0d+0)
1763 c
1764  700  if (illin .eq. 5) go to 710
1765       illin = illin + 1
1766       istate = -3
1767       return
1768  710  call xerrwv('lsodi--  incorrect inputs',
1769      1   50, 302, 1, 0, 0, 0, 0, 0.0d+0, 0.0d+0)
1770 c
1771  800  call xerrwv('lsodi-- infinite loop',
1772      1   50, 303, 2, 0, 0, 0, 0, 0.0d+0, 0.0d+0)
1773       return
1774 c----------------------- end of subroutine lsodi -----------------------
1775       end