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