/usr/share/octave/packages/fpl-1.3.5/doc-cache is in octave-fpl 1.3.5-4.
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 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 | # doc-cache created by Octave 4.2.1
# name: cache
# type: cell
# rows: 3
# columns: 8
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 23
fpl_vtk_assemble_series
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 624
-- Function File: fpl_vtk_assemble_series (COLLECTION, BASENANME,
FORMAT, IDX, TIME)
Assemble a ParaView collection file (pvd) from a set of files
representing data at different time-steps.
COLLECTION is a string containing the base-name of the pvd file
where the data will be saved.
BASENAME, FORMAT, IDX are two strings and a set of integers, the
name of the i-th file in the collection will be computed as
'sprintf ([basename, format, ".vtu"], idx(i))'.
TIME is the set of time-steps to which data correspond
See also: fpl_vtk_write_field, fpl_dx_write_series.
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Assemble a ParaView collection file (pvd) from a set of files
representing data
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 23
fpl_vtk_b64_write_field
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 1307
-- Function File: fpl_vtk_b64_write_field (BASENAME, MESH, NODEDATA,
CELLDATA)
Output data field in binary serial XML-VTK UnstructuredGrid format.
BASENAME is a string containing the base-name of the (vtu) file
where the data will be saved.
MESH is a PDE-tool like mesh, like the ones generated by the "msh"
package.
NODEDATA and CELLDATA are (Ndata x 2) cell arrays containing
respectively <PointData> and <CellData> representing scalars or
vectors:
- *DATA{:,1} = variable data;
- *DATA{:,2} = variable names;
Example:
%% generate msh1, node centered field nc1, cell centered field cc1
fpl_vtk_b64_write_field ("example", msh1, {nc1, "temperature"}, {cc1, "density"});
%% generate msh2, node centered field nc2
fpl_vtk_b64_write_field ("example", msh2, {nc2, "temperature"}, {});
The difference between 'fpl_vtk_write_field' and
'fpl_vtk_b64_write_field' is that the former saves data in ASCII
format while the latter uses base64-encoded binary format. To save
data in un-encoded binary format use 'fpl_vtk_raw_write_field'.
See also: fpl_dx_write_field, fpl_dx_write_series,
fpl_vtk_assemble_series, fpl_vtk_write_field,
fpl_vtk_raw_write_field.
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 67
Output data field in binary serial XML-VTK UnstructuredGrid format.
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 23
fpl_vtk_raw_write_field
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 1297
-- Function File: fpl_vtk_raw_write_field (BASENAME, MESH, NODEDATA,
CELLDATA)
Output data field in binary serial XML-VTK UnstructuredGrid format.
BASENAME is a string containing the base-name of the (vtu) file
where the data will be saved.
MESH is a PDE-tool like mesh, like the ones generated by the "msh"
package.
NODEDATA and CELLDATA are (Ndata x 2) cell arrays containing
respectively <PointData> and <CellData> representing scalars or
vectors:
- *DATA{:,1} = variable data;
- *DATA{:,2} = variable names;
Example:
%% generate msh1, node centered field nc1, cell centered field cc1
fpl_vtk_raw_write_field ("example", msh1, {nc1, "temperature"}, {cc1, "density"});
%% generate msh2, node centered field nc2
fpl_vtk_raw_write_field ("example", msh2, {nc2, "temperature"}, {});
The difference between 'fpl_vtk_write_field' and
'fpl_vtk_raw_write_field' is that the former saves data in ASCII
format while the latter uses raw binary format. To save data in
b64-encoded binary format use 'fpl_vtk_b64_write_field'.
See also: fpl_dx_write_field, fpl_dx_write_series,
fpl_vtk_assemble_series, fpl_vtk_write_field,
fpl_vtk_b64_write_field.
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 67
Output data field in binary serial XML-VTK UnstructuredGrid format.
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 19
fpl_vtk_write_field
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 1134
-- Function File: fpl_vtk_write_field (BASENAME, MESH, NODEDATA,
CELLDATA, ENDFILE)
Output data field in serial XML-VTK UnstructuredGrid format.
BASENAME is a string containing the base-name of the (vtu) file
where the data will be saved.
MESH is a PDE-tool like mesh, like the ones generated by the "msh"
package.
NODEDATA and CELLDATA are (Ndata x 2) cell arrays containing
respectively <PointData> and <CellData> representing scalars or
vectors:
- *DATA{:,1} = variable data;
- *DATA{:,2} = variable names;
ENDFILE should be 0 if you want to add other variables to the same
file, 1 otherwise.
Example:
<generate msh1, node centered field nc1, cell centered field cc1>
fpl_vtk_write_field ("example", msh1, {nc1, "temperature"}, {cc1, "density"}, 0);
<generate msh2, node centered field nc2>
fpl_vtk_write_field ("example", msh2, {nc2, "temperature"}, {}, 1);
will generate a valid XML-VTK UnstructuredGrid file.
See also: fpl_dx_write_field, fpl_dx_write_series,
fpl_vtk_assemble_series.
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 60
Output data field in serial XML-VTK UnstructuredGrid format.
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 7
pdemesh
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 294
-- Function File: H = pdemesh (P, E, T, U)
Plot a triangular mesh in 3D given a mesh structure and node data.
P, T are the mesh vertices and connectivity, U node data. E is
ignored and is accepted only for compatibiity.
See also: fpl_dx_write_field, fpl_vtk_write_field.
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 66
Plot a triangular mesh in 3D given a mesh structure and node data.
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 7
pdesurf
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 249
-- Function File: H = pdesurf (P, T, U)
Plot a 3D surface given node or element data on a triangular mesh.
P, T are the mesh vertices and connectivity, U node or element
data.
See also: fpl_dx_write_field, fpl_vtk_write_field.
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 66
Plot a 3D surface given node or element data on a triangular mesh.
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 7
savevtk
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 710
-- Function File: [STATUS] = savevtk ( X, Y, Z, FILENAME )
Save a 3-D scalar array ARRAY to the file FILENAME in VTK
structured-grid format.
This file format is used by Mayavi2 or ParaView for example. If no
write errors occurred, output argument STATUS is set to 1,
otherwise 0.
Example:
n = 30;
X = zeros (n, n, n);
for x = 1:n
for y = 1:n
for z = 1:n
X(x, y, z) = 1 / sqrt (x*x + y*y + z*z);
endfor
endfor
endfor
X = X * 200 / max (max (max (X)));
savevtk (X, "spherical.vtk");
See also: savevtkvector.
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Save a 3-D scalar array ARRAY to the file FILENAME in VTK
structured-grid format
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 13
savevtkvector
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 461
-- Function File: [STATUS] = savevtkvector (X, Y, Z, FILENAME)
Save a 3-D vector field of components X, Y, Z to the file FILENAME
in VTK format.
This file format is used by Mayavi2 or ParaView for example. X, Y
and Z should be 3-D arrays of the same size, each storing vector
components in a given Cartesian direction.
If no write errors occurred, output argument STATUS is set to 1,
otherwise 0.
See also: savevtk.
# name: <cell-element>
# type: sq_string
# elements: 1
# length: 80
Save a 3-D vector field of components X, Y, Z to the file FILENAME in
VTK format
|