← Back to branch summary

~ubuntu-branches/ubuntu/natty/octave-odepkg/natty

« back to all changes in this revision

Viewing changes to inst/doc.info

  • Committer: Bazaar Package Importer
  • Author(s): Thomas Weber
  • Date: 2010-05-16 20:37:31 UTC
  • mfrom: (1.1.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20100516203731-a9rey8g4kfkbt3jc
Tags: 0.6.10-1
http://bugs.debian.org/571858
* New upstream release
* debian/control:
  - Remove Rafael Laboissiere from Uploaders (Closes: #571858)
  - Remove Ólafur Jens Sigurðsson <ojsbug@gmail.com> from Uploaders
* Bump Standards-Version to 3.8.4, no changes needed
* Switch to dpkg-source 3.0 (quilt) format
* Dropped patch fix-test (applied upstream)

Show diffs side-by-side

added added

removed removed

Lines of Context:
inst/doc.info
1
 
This is odepkg.info, produced by makeinfo version 4.11 from odepkg.texi.
 
1
Dies ist odepkg.info, hergestellt von Makeinfo Version 4.8 aus
 
2
odepkg.texi.
2
3
 
3
4
 
4
5
File: odepkg.info,  Node: Top,  Next: Beginners Guide,  Prev: (dir),  Up: (dir)
38
39
The "Beginners Guide" is intended for users who are new to OdePkg and
39
40
who want to solve differential equations with the Octave language and
40
41
the package OdePkg. In this section it will be explained what OdePkg is
41
 
about in *note About OdePkg:: and how OdePkg grew up from the beginning
42
 
in *note OdePkg history and roadmap::. In *note Installation and
 
42
about in *Note About OdePkg:: and how OdePkg grew up from the beginning
 
43
in *Note OdePkg history and roadmap::. In *Note Installation and
43
44
deinstallation:: it is explained how OdePkg can be installed in Octave
44
45
and how it can later be removed from Octave if it is not needed
45
46
anymore. If you encounter problems while using OdePkg then have a look
46
 
at *note Reporting Bugs:: how these bugs can be reported. In the *note
 
47
at *Note Reporting Bugs:: how these bugs can be reported. In the *Note
47
48
The "foo" example:: a first example is explained.
48
49
 
49
50
* Menu:
211
212
that can be used to set up user defined constants or control variables.
212
213
 
213
214
   As it is known that `foo' is a set of ordinary differential
214
 
equations we can choose one of the four Runge-Kutta solvers (cf. *note
 
215
equations we can choose one of the four Runge-Kutta solvers (cf. *Note
215
216
Solver families::). It is also known that the time period of interest
216
217
may be between t_0 = 0.0 and t_e = 5.0 as well as that the initial
217
218
values of the ODEs are y_1(t=0) = 0.0 and y_2(t=0) = 0.0.  Solving this
258
259
   The options structure `A' that can be set up with with the command
259
260
`odeset' must always be the fourth input argument when using the ODE
260
261
solvers and the DAE solvers but if you are using an IDE solver then `A'
261
 
must be the fifth input argument (cf. *note Solver families::). The
 
262
must be the fifth input argument (cf. *Note Solver families::). The
262
263
various options that can be set with the command `odeset' are described
263
 
in *note ODE/DAE/IDE/DDE options::.
 
264
in *Note ODE/DAE/IDE/DDE options::.
264
265
 
265
266
   Further examples have also been implemented. These example files and
266
267
functions are of the form `odepkg_examples_*'. Different testsuite
288
289
The "Users Guide" is intended for trained users who already know in
289
290
principal how to solve differential equations with the Octave language
290
291
and OdePkg. In this chapter it will be explained which equations can be
291
 
solved with OdePkg in *note Differential Equations::. It will be
 
292
solved with OdePkg in *Note Differential Equations::. It will be
292
293
explained which solvers can be used for the different kind of equations
293
 
in *note Solver families:: and which options can be set for the
294
 
optimization of the solving process in *note ODE/DAE/IDE/DDE options::.
 
294
in *Note Solver families:: and which options can be set for the
 
295
optimization of the solving process in *Note ODE/DAE/IDE/DDE options::.
295
296
The help text of all M-file functions and all Oct-file functions have
296
 
been extracted and are displayed in the sections *note M-File Function
297
 
Reference:: and *note Oct-File Function Reference::.
 
297
been extracted and are displayed in the sections *Note M-File Function
 
298
Reference:: and *Note Oct-File Function Reference::.
298
299
 
299
300
* Menu:
300
301
 
312
313
 
313
314
In this section the different kind of differential equations that can
314
315
be solved with OdePkg are explained. The formulation of ordinary
315
 
differential equations is described in section *note ODE equations::
 
316
differential equations is described in section *Note ODE equations::
316
317
followed by the description of explicetly formulated differential
317
 
algebraic equations in section *note DAE equations::, implicetely
318
 
formulated differential algebraic equations in section *note IDE
319
 
equations:: and delay differential algebraic equations in section *note
 
318
algebraic equations in section *Note DAE equations::, implicetely
 
319
formulated differential algebraic equations in section *Note IDE
 
320
equations:: and delay differential algebraic equations in section *Note
320
321
DDE equations::.
321
322
 
322
323
* Menu:
336
337
be a scalar or vector of derivatives. The variable t always is a scalar
337
338
describing one point of time and the variable y(t) is a scalar or
338
339
vector of solutions from the last time step of the set of ordinary
339
 
differential equations. If the equation is non-stiff then the *note
 
340
differential equations. If the equation is non-stiff then the *Note
340
341
Runge-Kutta solvers:: can be used to solve such kind of differential
341
342
equations but if the equation is stiff then it is recommended to use
342
 
the *note Hairer-Wanner solvers::. An ODE equation definition in Octave
 
343
the *Note Hairer-Wanner solvers::. An ODE equation definition in Octave
343
344
must look like
344
345
     function [dy] = ODEequation (t, y, varargin)
345
346
 
359
360
equation. If it does not depend on time then it can be defined as a
360
361
constant matrix or a function. If it does depend on time then it must
361
362
be defined as a function. Use the command `odeset' to pass the mass
362
 
matrix information to the solver function (cf. *note ODE/DAE/IDE/DDE
363
 
options::). If the equation is non-stiff then the *note Runge-Kutta
 
363
matrix information to the solver function (cf. *Note ODE/DAE/IDE/DDE
 
364
options::). If the equation is non-stiff then the *Note Runge-Kutta
364
365
solvers:: can be used to solve such kind of differential equations but
365
 
if the equation is stiff then it is recommended to use the *note
 
366
if the equation is stiff then it is recommended to use the *Note
366
367
Hairer-Wanner solvers::. A DAE equation definition in Octave must look
367
368
like
368
369
     function [dy] = DAEequation (t, y, varargin)
369
370
   and the mass matrix definition can either be a constant mass matrix
370
371
or a valid function handle to a mass matrix calculation function that
371
372
can be set with the command `odeset' (cf. option `Mass' of section
372
 
*note ODE/DAE/IDE/DDE options::).
 
373
*Note ODE/DAE/IDE/DDE options::).
373
374
 
374
375
 
375
376
File: odepkg.info,  Node: IDE equations,  Next: DDE equations,  Prev: DAE equations,  Up: Differential Equations
381
382
may be a scalar or vector of derivatives. The variable t always is a
382
383
scalar describing one point of time and the variable y(t) is a scalar
383
384
or vector of solutions from the set of implicit differential equations.
384
 
Only IDE solvers from section *note Cash modified BDF solvers:: or
385
 
section *note DDaskr direct method solver:: can be used to solve such
 
385
Only IDE solvers from section *Note Cash modified BDF solvers:: or
 
386
section *Note DDaskr direct method solver:: can be used to solve such
386
387
kind of differential equations. A DAE equation definition in Octave
387
388
must look like
388
389
     function [residual] = IDEequation (t, y, dy, varargin)
397
398
f(t,y(t),y(t-\tau_1),...,y(t-\tau_n)) where y'(t) may be a scalar or
398
399
vector of derivatives. The variable t always is a scalar describing one
399
400
point of time and the variables y(t-\tau_i) are scalars or vectors from
400
 
the past. Only DDE solvers from section *note Modified Runge-Kutta
 
401
the past. Only DDE solvers from section *Note Modified Runge-Kutta
401
402
solvers:: can be used to solve such kind of differential equations. A
402
403
DDE equation definition in Octave must look like
403
404
     function [dy] = DDEequation (t, y, z, varargin)
412
413
 
413
414
In this section the different kind of solvers are introduced that have
414
415
been implemented in OdePkg. This section starts with the basic
415
 
Runge-Kutta solvers in section *note Runge-Kutta solvers:: and is
416
 
continued with the Mex-file Hairer-Wanner solvers in section *note
 
416
Runge-Kutta solvers in section *Note Runge-Kutta solvers:: and is
 
417
continued with the Mex-file Hairer-Wanner solvers in section *Note
417
418
Hairer-Wanner solvers::. Performance tests have also been added to the
418
419
OdePkg. Some of these performance results have been added to section
419
 
*note ODE solver performances::.
 
420
*Note ODE solver performances::.
420
421
 
421
422
* Menu:
422
423
 
608
609
The modified Runge-Kutta solvers are written in the Octave language and
609
610
that are saved as m-files. There have been implemented four different
610
611
solvers that do have a very similiar structure to that solvers found in
611
 
section *note Runge-Kutta solvers::. Their names are `ode23d',
 
612
section *Note Runge-Kutta solvers::. Their names are `ode23d',
612
613
`ode45d', `ode54d' and `ode78d'. The modified Runge-Kutta solvers have
613
614
been added to the OdePkg to solve non-stiff DDEs with constant delays
614
615
only, stiff equations of that form cannot be solved with these solvers.
615
616
For further information about the error estimation of these solvers cf.
616
 
section *note Runge-Kutta solvers::.
 
617
section *Note Runge-Kutta solvers::.
617
618
 
618
619
   Note: The four DDE solvers of OdePkg are not syntax compatible to
619
620
propietary solvers. The reason is that the input arguments of the
726
727
   There also is an command `odeget' which extracts one or more options
727
728
from an OdePkg options structure. Other values than default values can
728
729
also be set with the command `odeset'. The function description of the
729
 
commands `odeset' and `odeget' can be found in the *note M-File
 
730
commands `odeset' and `odeget' can be found in the *Note M-File
730
731
Function Reference::. The values that can be set with the `odeset'
731
732
command are
732
733
 
1043
1044
     function. Run the following example to illustrate the effect if
1044
1045
     this option is used
1045
1046
          function vdy = fbal (vt, vy, varargin)
1046
 
            vdy(1,1) =  vy(2)+3;
 
1047
            vdy(1,1) =  vy(2);
1047
1048
            vdy(2,1) = -9.81; ## m/s�
1048
1049
          endfunction
1049
1050
 
1090
1091
     `odebdi' and `odebda' solvers all use the backward differentiation
1091
1092
     algorithm to solve the different kind of equations.
1092
1093
 
 
1094
`NewtonTol'
 
1095
     TODO
 
1096
 
 
1097
`MaxNewtonIterations'
 
1098
     TODO
 
1099
 
1093
1100
 
1094
1101
File: odepkg.info,  Node: M-File Function Reference,  Next: Oct-File Function Reference,  Prev: ODE/DAE/IDE/DDE options,  Up: Users Guide
1095
1102
 
1483
1490
          vlag = interp1 (vsol.x, vsol.y, vsol.x - 2);
1484
1491
          plot (vsol.y, vlag); legend ("fcao (t,y,z)");
1485
1492
 
 
1493
 -- Function File: [] = odebwe (@FUN, SLOT, INIT, [OPT], [PAR1, PAR2,
 
1494
          ...])
 
1495
 -- Command: [SOL] = odebwe (@FUN, SLOT, INIT, [OPT], [PAR1, PAR2, ...])
 
1496
 -- Command: [T, Y, [XE, YE, IE]] = odebwe (@FUN, SLOT, INIT, [OPT],
 
1497
          [PAR1, PAR2, ...])
 
1498
     This function file can be used to solve a set of stiff ordinary
 
1499
     differential equations (stiff ODEs) or stiff differential
 
1500
     algebraic equations (stiff DAEs) with the Backward Euler method.
 
1501
 
 
1502
     If this function is called with no return argument then plot the
 
1503
     solution over time in a figure window while solving the set of
 
1504
     ODEs that are defined in a function and specified by the function
 
1505
     handle @FUN. The second input argument SLOT is a double vector
 
1506
     that defines the time slot, INIT is a double vector that defines
 
1507
     the initial values of the states, OPT can optionally be a
 
1508
     structure array that keeps the options created with the command
 
1509
     `odeset' and PAR1, PAR2, ... can optionally be other input
 
1510
     arguments of any type that have to be passed to the function
 
1511
     defined by @FUN.
 
1512
 
 
1513
     If this function is called with one return argument then return
 
1514
     the solution SOL of type structure array after solving the set of
 
1515
     ODEs. The solution SOL has the fields X of type double column
 
1516
     vector for the steps chosen by the solver, Y of type double column
 
1517
     vector for the solutions at each time step of X, SOLVER of type
 
1518
     string for the solver name and optionally the extended time stamp
 
1519
     information XE, the extended solution information YE and the
 
1520
     extended index information IE all of type double column vector
 
1521
     that keep the informations of the event function if an event
 
1522
     function handle is set in the option argument OPT.
 
1523
 
 
1524
     If this function is called with more than one return argument then
 
1525
     return the time stamps T, the solution values Y and optionally the
 
1526
     extended time stamp information XE, the extended solution
 
1527
     information YE and the extended index information IE all of type
 
1528
     double column vector.
 
1529
 
 
1530
     For example, solve an anonymous implementation of the Van der Pol
 
1531
     equation
 
1532
 
 
1533
          fvdb = @(vt,vy) [vy(2); (1 - vy(1)^2) * vy(2) - vy(1)];
 
1534
          vjac = @(vt,vy) [0, 1; -1 - 2 * vy(1) * vy(2), 1 - vy(1)^2];
 
1535
          vopt = odeset ("RelTol", 1e-3, "AbsTol", 1e-3, \
 
1536
                   "NormControl", "on", "OutputFcn", @odeplot, \
 
1537
                   "Jacobian",vjac);
 
1538
          odebwe (fvdb, [0 20], [2 0], vopt);
 
1539
 
1486
1540
 -- Function File: [] = odeexamples ()
1487
1541
     Open the differential equations examples menu and allow the user
1488
1542
     to select a submenu of ODE, DAE, IDE or DDE examples.
2279
2333
     an idea).
2280
2334
 
2281
2335
   * Some options that can be set with propietary solver products are
2282
 
     not available within OdePkg. Have a look at section *note
 
2336
     not available within OdePkg. Have a look at section *Note
2283
2337
     ODE/DAE/IDE/DDE options:: about which options can be set and which
2284
2338
     options are not supported and help improving the command `odeset',
2285
2339
     `odepkg_structure_check' and the solvers that have to deal with
2342
2396
* Menu:
2343
2397
 
2344
2398
* ode23:                                 M-File Function Reference.
2345
 
                                                              (line  11)
 
2399
                                                              (line  14)
2346
2400
* ode23d:                                M-File Function Reference.
2347
 
                                                              (line  58)
 
2401
                                                              (line  60)
2348
2402
* ode2r:                                 Oct-File Function Reference.
2349
 
                                                              (line 161)
 
2403
                                                              (line 164)
2350
2404
* ode45:                                 M-File Function Reference.
2351
 
                                                              (line 107)
 
2405
                                                              (line 108)
2352
2406
* ode45d:                                M-File Function Reference.
2353
 
                                                              (line 154)
 
2407
                                                              (line 156)
2354
2408
* ode54:                                 M-File Function Reference.
2355
 
                                                              (line 203)
 
2409
                                                              (line 204)
2356
2410
* ode54d:                                M-File Function Reference.
2357
2411
                                                              (line 250)
2358
2412
* ode5r:                                 Oct-File Function Reference.
2359
 
                                                              (line 209)
 
2413
                                                              (line 210)
2360
2414
* ode78:                                 M-File Function Reference.
2361
 
                                                              (line 299)
 
2415
                                                              (line 300)
2362
2416
* ode78d:                                M-File Function Reference.
2363
 
                                                              (line 346)
 
2417
                                                              (line 348)
2364
2418
* odebda:                                Oct-File Function Reference.
2365
2419
                                                              (line  12)
2366
2420
* odebdi:                                Oct-File Function Reference.
2367
 
                                                              (line  61)
 
2421
                                                              (line  62)
 
2422
* odebwe:                                M-File Function Reference.
 
2423
                                                              (line 396)
2368
2424
* odeexamples:                           M-File Function Reference.
2369
 
                                                              (line 394)
 
2425
                                                              (line 441)
2370
2426
* odeget:                                M-File Function Reference.
2371
 
                                                              (line 398)
 
2427
                                                              (line 445)
2372
2428
* odekdi:                                Oct-File Function Reference.
2373
 
                                                              (line 110)
 
2429
                                                              (line 113)
2374
2430
* odephas2:                              M-File Function Reference.
2375
 
                                                              (line 422)
 
2431
                                                              (line 469)
2376
2432
* odephas3:                              M-File Function Reference.
2377
 
                                                              (line 456)
 
2433
                                                              (line 503)
2378
2434
* odepkg:                                M-File Function Reference.
2379
 
                                                              (line 495)
 
2435
                                                              (line 542)
2380
2436
* odepkg_event_handle:                   M-File Function Reference.
2381
 
                                                              (line 511)
 
2437
                                                              (line 558)
2382
2438
* odepkg_examples_dae:                   M-File Function Reference.
2383
 
                                                              (line 542)
 
2439
                                                              (line 589)
2384
2440
* odepkg_examples_dde:                   M-File Function Reference.
2385
 
                                                              (line 546)
 
2441
                                                              (line 593)
2386
2442
* odepkg_examples_ide:                   M-File Function Reference.
2387
 
                                                              (line 550)
 
2443
                                                              (line 597)
2388
2444
* odepkg_examples_ode:                   M-File Function Reference.
2389
 
                                                              (line 554)
 
2445
                                                              (line 601)
2390
2446
* odepkg_structure_check:                M-File Function Reference.
2391
 
                                                              (line 559)
 
2447
                                                              (line 606)
2392
2448
* odepkg_testsuite_calcmescd:            M-File Function Reference.
2393
 
                                                              (line 579)
 
2449
                                                              (line 626)
2394
2450
* odepkg_testsuite_calcscd:              M-File Function Reference.
2395
 
                                                              (line 592)
 
2451
                                                              (line 639)
2396
2452
* odepkg_testsuite_chemakzo:             M-File Function Reference.
2397
 
                                                              (line 605)
 
2453
                                                              (line 652)
2398
2454
* odepkg_testsuite_hires:                M-File Function Reference.
2399
 
                                                              (line 617)
 
2455
                                                              (line 664)
2400
2456
* odepkg_testsuite_implakzo:             M-File Function Reference.
2401
 
                                                              (line 629)
 
2457
                                                              (line 676)
2402
2458
* odepkg_testsuite_implrober:            M-File Function Reference.
2403
 
                                                              (line 642)
 
2459
                                                              (line 689)
2404
2460
* odepkg_testsuite_oregonator:           M-File Function Reference.
2405
 
                                                              (line 655)
 
2461
                                                              (line 702)
2406
2462
* odepkg_testsuite_pollution:            M-File Function Reference.
2407
 
                                                              (line 668)
 
2463
                                                              (line 715)
2408
2464
* odepkg_testsuite_robertson:            M-File Function Reference.
2409
 
                                                              (line 681)
 
2465
                                                              (line 728)
2410
2466
* odepkg_testsuite_transistor:           M-File Function Reference.
2411
 
                                                              (line 694)
 
2467
                                                              (line 741)
2412
2468
* odeplot:                               M-File Function Reference.
2413
 
                                                              (line 706)
 
2469
                                                              (line 753)
2414
2470
* odeprint:                              M-File Function Reference.
2415
 
                                                              (line 739)
 
2471
                                                              (line 786)
2416
2472
* oders:                                 Oct-File Function Reference.
2417
 
                                                              (line 258)
 
2473
                                                              (line 259)
2418
2474
* odeset:                                M-File Function Reference.
2419
 
                                                              (line 775)
 
2475
                                                              (line 826)
2420
2476
* odesx:                                 Oct-File Function Reference.
2421
2477
                                                              (line 306)
2422
2478
 
2480
2536
                                                              (line 256)
2481
2537
* MassSingular option:                   ODE/DAE/IDE/DDE options.
2482
2538
                                                              (line 308)
 
2539
* MaxNewtonIterations option:            ODE/DAE/IDE/DDE options.
 
2540
                                                              (line 383)
2483
2541
* MaxOrder option:                       ODE/DAE/IDE/DDE options.
2484
2542
                                                              (line 351)
2485
2543
* MaxStep option:                        ODE/DAE/IDE/DDE options.
2489
2547
                                                              (line 280)
2490
2548
* MvPattern option:                      ODE/DAE/IDE/DDE options.
2491
2549
                                                              (line 306)
 
2550
* NewtonTol option:                      ODE/DAE/IDE/DDE options.
 
2551
                                                              (line 380)
2492
2552
* NonNegative option:                    ODE/DAE/IDE/DDE options.
2493
2553
                                                              (line 311)
2494
2554
* NormControl option:                    ODE/DAE/IDE/DDE options.
2524
2584
 
2525
2585
 
2526
2586
Tag Table:
2527
 
Node: Top0
2528
 
Node: Beginners Guide1172
2529
 
Node: About OdePkg2337
2530
 
Node: OdePkg history and roadmap3445
2531
 
Node: Installation and deinstallation7978
2532
 
Node: Reporting Bugs8854
2533
 
Node: The "foo" example9530
2534
 
Node: Users Guide14575
2535
 
Node: Differential Equations15817
2536
 
Node: ODE equations16776
2537
 
Node: DAE equations17563
2538
 
Node: IDE equations19047
2539
 
Node: DDE equations19768
2540
 
Node: Solver families20484
2541
 
Node: Runge-Kutta solvers21534
2542
 
Ref: Runge-Kutta solvers-Footnote-125449
2543
 
Node: Hairer-Wanner solvers25901
2544
 
Node: Cash modified BDF solvers27728
2545
 
Node: DDaskr direct method solver29369
2546
 
Node: Modified Runge-Kutta solvers31038
2547
 
Node: ODE solver performances32838
2548
 
Node: ODE/DAE/IDE/DDE options38508
2549
 
Node: M-File Function Reference56310
2550
 
Node: Oct-File Function Reference96627
2551
 
Node: Programmers Guide115183
2552
 
Node: Missing features115401
2553
 
Node: Function Index118916
2554
 
Node: Index124576
 
2587
Node: Top77
 
2588
Node: Beginners Guide1175
 
2589
Node: About OdePkg2340
 
2590
Node: OdePkg history and roadmap3448
 
2591
Node: Installation and deinstallation7981
 
2592
Node: Reporting Bugs8857
 
2593
Node: The "foo" example9533
 
2594
Node: Users Guide14578
 
2595
Node: Differential Equations15820
 
2596
Node: ODE equations16779
 
2597
Node: DAE equations17566
 
2598
Node: IDE equations19050
 
2599
Node: DDE equations19771
 
2600
Node: Solver families20487
 
2601
Node: Runge-Kutta solvers21537
 
2602
Ref: Runge-Kutta solvers-Footnote-125452
 
2603
Node: Hairer-Wanner solvers25904
 
2604
Node: Cash modified BDF solvers27731
 
2605
Node: DDaskr direct method solver29372
 
2606
Node: Modified Runge-Kutta solvers31041
 
2607
Node: ODE solver performances32841
 
2608
Node: ODE/DAE/IDE/DDE options38511
 
2609
Node: M-File Function Reference56367
 
2610
Node: Oct-File Function Reference99188
 
2611
Node: Programmers Guide117744
 
2612
Node: Missing features117962
 
2613
Node: Function Index121477
 
2614
Node: Index127278
2555
2615
 
2556
2616
End Tag Table