octave_packages/ocs-0.1.3/tst/doc-cache

   1 # Created by Octave 3.6.1, Sun Mar 25 17:34:24 2012 UTC <root@t61>
   2 # name: cache
   3 # type: cell
   4 # rows: 3
   5 # columns: 4
   6 # name: <cell-element>
   7 # type: sq_string
   8 # elements: 1
   9 # length: 18
  10 tst_backward_euler
  11
  12
  13 # name: <cell-element>
  14 # type: sq_string
  15 # elements: 1
  16 # length: 1396
  17  -- Function File: [OUT,NITER] = tst_backward_euler(CIRSTRUCT,X,T,TOL,
  18           MAXIT,PLTVARS,VERBOSITY,DAE_FUN)
  19      Perform a transient simulation of the system described by
  20      CIRSTRUCT over the time interval T using the backward Euler
  21      algorithm.
  22
  23      The initial value for the state vector is computed by solving a
  24      steady state problem at T(1), with starting guess X.
  25
  26      TOL and MAXIT are parameters passed to `nls_newton_raphson'.
  27
  28      The output OUT will contain the value of the state vector at each
  29      point of T.
  30
  31      The optional parameter VERBOSITY controls the amount of output
  32      produced:
  33
  34         - if verbosity(1) != 0, information on the progress of the
  35           algorithm are output at runtime
  36
  37         - if verbosity(2) != 0, the plot of the variables whose names
  38           are listed in PLTVARS is produced after the computation
  39
  40      For special purposes one may need to pass modified jacobian and
  41      residual functions. This can be done via the cell array of function
  42      handles DAE_FUN.
  43
  44      Such functions should have the same input and output parameter
  45      list as the default sub-functions TSTBWEFUNJAC0,TSTBWEFUNRES0,
  46      TSTBWEFUNJAC,TSTBWEFUNRES.
  47
  48      The optional output NITER returns the number of Newton iterations
  49      needed to reach convergence.
  50
  51      See also: tst_daspk, tst_theta_method, tst_odepkg,
  52      nls_newton_raphson
  53
  54
  55
  56
  57
  58 # name: <cell-element>
  59 # type: sq_string
  60 # elements: 1
  61 # length: 80
  62 Perform a transient simulation of the system described by CIRSTRUCT
  63 over the tim
  64
  65
  66
  67 # name: <cell-element>
  68 # type: sq_string
  69 # elements: 1
  70 # length: 9
  71 tst_daspk
  72
  73
  74 # name: <cell-element>
  75 # type: sq_string
  76 # elements: 1
  77 # length: 1375
  78  -- Function File: [OUT] = tst_daspk (CIRSTRUCT,X,T,TOL,MAXIT,
  79           PLTVARS,VERBOSITY,DASKOPTS,DAE_FUN);
  80      Perform a transient simulation of the system described by
  81      CIRSTRUCT over the time interval T using `daspk'.
  82
  83      The initial value for the state vector is computed by solving a
  84      steady state problem at T(1), with starting guess X.
  85
  86      TOL and MAXIT are parameters passed to `nls_newton_raphson'.
  87
  88      The output OUT will contain the value of the state vector at each
  89      point of T.
  90
  91      Extra options for `daspk' can be passed as name/value pairs in the
  92      cellarray DASKOPTS.
  93
  94      The optional parameter  VERBOSITY controls the amount of output
  95      produced:
  96
  97         - if verbosity(1) != 0, information on the progress of the
  98           algorithm are output at runtime
  99
 100         - if verbosity(2) != 0, the plot of the variables whose names
 101           are listed in PLTVARS is produced after the computation
 102
 103      For special purposes one may need to pass modified jacobian and
 104      residual functions. This can be done via the cell array of function
 105      handles DAE_FUN.
 106
 107      Such functions should have the same input and output parameter
 108      list as the default sub-functions TSTBWEFUNJAC0,TSTBWEFUNRES0,
 109      TSTBWEFUNJAC,TSTBWEFUNRES.
 110
 111      See also: tst_backward_euler, tst_odepkg, tst_theta_method,
 112      nls_newton_raphson, daspk
 113
 114
 115
 116
 117
 118 # name: <cell-element>
 119 # type: sq_string
 120 # elements: 1
 121 # length: 80
 122 Perform a transient simulation of the system described by CIRSTRUCT
 123 over the tim
 124
 125
 126
 127 # name: <cell-element>
 128 # type: sq_string
 129 # elements: 1
 130 # length: 10
 131 tst_odepkg
 132
 133
 134 # name: <cell-element>
 135 # type: sq_string
 136 # elements: 1
 137 # length: 1325
 138  -- Function File: [OUT, [TOUT]] = tst_odepkg (CIRSTRUCT,X,T,TOL,MAXIT,
 139           PLTVARS,SOLVER,ODESTRUCT,VERBOSITY);
 140      Perform a transient simulation of the system described by
 141      CIRSTRUCT over the time interval T using the `odepkg' DAE solver
 142      specified in SOLVER.
 143
 144      Pssible values for SOLVER are `ode2r', `ode5r', `oders' or `odesx'.
 145
 146      The initial value for the state vector is computed by solving a
 147      steady state problem at T(1), with starting guess X.
 148
 149      TOL and MAXIT are parameters passed to `nls_newton_raphson'.
 150
 151      If one output is requested OUT will contain the value of the state
 152      vector at each point of T.
 153
 154      If two outputs are requested OUT will contain the value of the
 155      state vector at each point of TOUT.
 156
 157      Extra options for options for the solver can be passed to the
 158      solver via ODESTRUCT.
 159
 160      The optional parameter  VERBOSITY controls the amount of output
 161      produced:
 162
 163         - if verbosity(1) != 0, information on the progress of the
 164           algorithm are output at runtime
 165
 166         - if verbosity(2) != 0, the plot of the variables whose names
 167           are listed in PLTVARS is produced after the computation
 168
 169      See also: tst_backward_euler, tst_theta_method, tst_daspk,
 170      nls_newton_raphson, odepkg, odeset,  ode2r, ode5r, oders, odesx
 171
 172
 173
 174
 175
 176 # name: <cell-element>
 177 # type: sq_string
 178 # elements: 1
 179 # length: 80
 180 Perform a transient simulation of the system described by CIRSTRUCT
 181 over the tim
 182
 183
 184
 185 # name: <cell-element>
 186 # type: sq_string
 187 # elements: 1
 188 # length: 16
 189 tst_theta_method
 190
 191
 192 # name: <cell-element>
 193 # type: sq_string
 194 # elements: 1
 195 # length: 1072
 196  -- Function File: [OUT,NITER] = tst_theta_method (CIRSTRUCT,X,T,TOL,
 197           MAXIT,THETA,PLTVARS, VERBOSITY);
 198      Perform a transient simulation of the system described by
 199      CIRSTRUCT over the time interval T using the theta-method with
 200      parameter THETA.
 201
 202      The initial value for the state vector is computed by solving a
 203      steady state problem at T(1), with starting guess X.
 204
 205      TOL and MAXIT are parameters passed to `nls_newton_raphson'.
 206
 207      The output OUT will contain the value of the state vector at each
 208      point of T.
 209
 210      The optional parameter VERBOSITY controls the amount of output
 211      produced:
 212
 213         - if verbosity(1) != 0, information on the progress of the
 214           algorithm are output at runtime
 215
 216         - if verbosity(2) != 0, the plot of the variables whose names
 217           are listed in PLTVARS is produced after the computation
 218
 219      The optional output NITER returns the number of Newton iterations
 220      needed to reach convergence.
 221
 222      See also: tst_backward_euler, tst_daspk, tst_odepkg,
 223      nls_newton_raphson
 224
 225
 226
 227
 228
 229 # name: <cell-element>
 230 # type: sq_string
 231 # elements: 1
 232 # length: 80
 233 Perform a transient simulation of the system described by CIRSTRUCT
 234 over the tim
 235
 236
 237
 238
 239