← Back to branch summary

~ubuntu-branches/ubuntu/hoary/scilab/hoary

« back to all changes in this revision

Viewing changes to man/eng/nonlinear/odeoptions.xml

  • Committer: Bazaar Package Importer
  • Author(s): Torsten Werner
  • Date: 2005-01-09 22:58:21 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050109225821-473xr8vhgugxxx5j
Tags: 3.0-12
http://bugs.debian.org/255869
changed configure.in to build scilab's own malloc.o, closes: #255869

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/eng/nonlinear/odeoptions.xml
 
1
<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
 
2
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
 
3
<MAN>
 
4
  <LANGUAGE>eng</LANGUAGE>
 
5
  <TITLE>odeoptions</TITLE>
 
6
  <TYPE>Scilab Function</TYPE>
 
7
  <DATE>February 1998</DATE>
 
8
  <SHORT_DESCRIPTION name="odeoptions"> set options for ode solvers</SHORT_DESCRIPTION>
 
9
  <CALLING_SEQUENCE>
 
10
    <CALLING_SEQUENCE_ITEM>odeoptions()  </CALLING_SEQUENCE_ITEM>
 
11
  </CALLING_SEQUENCE>
 
12
  <DESCRIPTION>
 
13
    <P>
 
14
    This function interactively displays a command which
 
15
    should be executed to set various options of ode solvers.
 
16
    The global variable <VERB>%ODEOPTIONS</VERB> sets the options.</P>
 
17
    <P>
 
18
    CAUTION: the <VERB>ode</VERB> function checks if this variable
 
19
    exists and in this case it uses it. For using default
 
20
    values you should clear this variable. Note that <VERB>odeoptions</VERB>
 
21
    does not create this variable. To create it you must execute
 
22
    the command line displayed by <VERB>odeoptions</VERB>.</P>
 
23
    <P>
 
24
    The variable <VERB>%ODEOPTIONS</VERB> is a vector with the following elements:</P>
 
25
    <VERBATIM>
 
26
<![CDATA[
 
27
[itask,tcrit,h0,hmax,hmin,jactyp,mxstep,maxordn,maxords,ixpr,ml,mu]
 
28
   ]]>
 
29
    </VERBATIM>
 
30
    <P>
 
31
    The default value is:</P>
 
32
    <VERBATIM>
 
33
<![CDATA[
 
34
[1,0,0,%inf,0,2,500,12,5,0,-1,-1]
 
35
   ]]>
 
36
    </VERBATIM>
 
37
    <P>
 
38
    The meaning of the elements is described below.</P>
 
39
    <P><VERB>itask</VERB>
 
40
     1 : normal computation at specified times
 
41
     2 : computation at mesh points (given in first row of output of <VERB>ode</VERB>)
 
42
     3 : one step at one internal mesh point and return
 
43
     4 : normal computation without overshooting <VERB>tcrit</VERB>
 
44
     5 : one step, without passing <VERB>tcrit</VERB>, and return</P>
 
45
    <P><VERB>tcrit</VERB>
 
46
      assumes <VERB>itask</VERB> equals 4 or 5, described above</P>
 
47
    <P><VERB>h0</VERB>
 
48
      first step tried</P>
 
49
    <P><VERB>hmax</VERB>
 
50
      max step size</P>
 
51
    <P><VERB>hmin</VERB>
 
52
      min step size</P>
 
53
    <P><VERB>jactype</VERB>
 
54
     0 : functional iterations, no jacobian used (<VERB>&quot;adams&quot;</VERB> or
 
55
         <VERB>&quot;stiff&quot;</VERB> only)
 
56
     1 : user-supplied full jacobian
 
57
     2 : internally generated full jacobian
 
58
     3 : internally generated diagonal jacobian (<VERB>&quot;adams&quot;</VERB> or 
 
59
         <VERB>&quot;stiff&quot;</VERB> only)
 
60
     4 : user-supplied banded jacobian (see <VERB>ml</VERB> and <VERB>mu</VERB> below)
 
61
     5 : internally generated banded jacobian (<VERB>see</VERB> ml and <VERB>mu</VERB> below)</P>
 
62
    <P><VERB>maxordn</VERB> 
 
63
     maximum non-stiff order allowed, at most 12</P>
 
64
    <P><VERB>maxords</VERB>
 
65
     maximum stiff order allowed, at most 5</P>
 
66
    <P><VERB>ixpr</VERB> 
 
67
     print level, 0 or 1</P>
 
68
    <P><VERB>ml</VERB>,<VERB>mu</VERB>
 
69
     If <VERB>jactype</VERB> equals 4 or 5, <VERB>ml</VERB> and <VERB>mu</VERB> are the lower
 
70
     and upper half-bandwidths of the banded jacobian: the band is the
 
71
     i,j's with i-ml &lt;= j &lt;= ny-1.
 
72
     If <VERB>jactype</VERB> equals 4 the jacobian function must return
 
73
     a matrix J which is  ml+mu+1 x ny (where ny=dim of y in ydot=f(t,y))
 
74
     such that column 1 of J is made of mu zeros followed by
 
75
     df1/dy1, df2/dy1, df3/dy1, ... (1+ml possibly non-zero entries)
 
76
     column 2 is made of mu-1 zeros followed by df1/dx2, df2/dx2, etc</P>
 
77
  </DESCRIPTION>
 
78
  <SEE_ALSO>
 
79
    <SEE_ALSO_ITEM>
 
80
      <LINK>ode</LINK>
 
81
    </SEE_ALSO_ITEM>
 
82
  </SEE_ALSO>
 
83
</MAN>