octave_packages/fpl-1.2.0/doc-cache

   1 # Created by Octave 3.6.1, Fri Mar 23 19:03:15 2012 UTC <root@t61>
   2 # name: cache
   3 # type: cell
   4 # rows: 3
   5 # columns: 19
   6 # name: <cell-element>
   7 # type: sq_string
   8 # elements: 1
   9 # length: 16
  10 FPL2dxappenddata
  11
  12
  13 # name: <cell-element>
  14 # type: sq_string
  15 # elements: 1
  16 # length: 848
  17  -- Function File:  FPL2dxappenddata ( FILENAME,
  18      P, T, U, ATTR_NAME, ATTR_RANK,  ATTR_SHAPE, ENDFLIE )
  19
  20      Apends data to a file in DX form.    Only one variable can be
  21      written to the file   variable must be a scalar, vector or tensor
  22      of doubles   mesh data in the file must be consistent with this
  23      variable
  24
  25      Variable must be a scalar, vector or tensor of doubles
  26
  27         - FILENAME= name of file to save (type string)
  28
  29         - P, T = mesh
  30
  31         - U = variable to save
  32
  33         - ATTR_NAME  = name of the variable (type string)
  34
  35         - ATTR_RANK  = rank of variable data (0 for scalar, 1 for
  36           vector, etc.)
  37
  38         - ATTR_SHAPE = number of components of variable data  (assumed
  39           1 for scalar)
  40
  41         - ENDFILE = 0 if you want to add other variables to the  same
  42           file, 1 otherwise
  43
  44
  45
  46
  47 # name: <cell-element>
  48 # type: sq_string
  49 # elements: 1
  50 # length: 54
  51 P, T, U, ATTR_NAME, ATTR_RANK,  ATTR_SHAPE, ENDFLIE )
  52
  53
  54
  55
  56 # name: <cell-element>
  57 # type: sq_string
  58 # elements: 1
  59 # length: 16
  60 FPL2dxoutputdata
  61
  62
  63 # name: <cell-element>
  64 # type: sq_string
  65 # elements: 1
  66 # length: 660
  67  -- Function File:  FPL2dxoutputdata ( FILENAME, P, T, U, ATTR_NAME,
  68           ATTR_RANK, ATTR_SHAPE, ENDFILE )
  69      Outputs data in DX form.
  70
  71      Variable must be a scalar, vector or tensor of doubles
  72
  73         - FILENAME= name of file to save (type string)
  74
  75         - P, T = mesh
  76
  77         - U = variable to save
  78
  79         - ATTR_NAME  = name of the variable (type string)
  80
  81         - ATTR_RANK  = rank of variable data (0 for scalar, 1 for
  82           vector, etc.)
  83
  84         - ATTR_SHAPE = number of components of variable data  (assumed
  85           1 for scalar)
  86
  87         - ENDFILE = 0 if you want to add other variables to the  same
  88           file, 1 otherwise
  89
  90
  91
  92
  93 # name: <cell-element>
  94 # type: sq_string
  95 # elements: 1
  96 # length: 24
  97 Outputs data in DX form.
  98
  99
 100
 101 # name: <cell-element>
 102 # type: sq_string
 103 # elements: 1
 104 # length: 22
 105 FPL2dxoutputtimeseries
 106
 107
 108 # name: <cell-element>
 109 # type: sq_string
 110 # elements: 1
 111 # length: 606
 112  -- Function File:  FPL2dxoutputtimeseries ( FILENAME, P, T, U,
 113           ATTR_NAME, ATTR_RANK, ATTR_SHAPE, TIME )
 114      Outputs a time series in DX form.    variable must be a scalar,
 115      vector or tensor of doubles
 116         - FILENAME= name of file to save (type string)
 117
 118         - P, T = mesh
 119
 120         - U = variable to save
 121
 122         - ATTR_NAME  = name of the variable (type string)
 123
 124         - ATTR_RANK  = rank of variable data (0 for scalar, 1 for
 125           vector, etc.)
 126
 127         - ATTR_SHAPE = number of components of variable data  (assumed
 128           1 for scalar)
 129
 130         - TIME = time instants
 131
 132
 133
 134
 135 # name: <cell-element>
 136 # type: sq_string
 137 # elements: 1
 138 # length: 33
 139 Outputs a time series in DX form.
 140
 141
 142
 143 # name: <cell-element>
 144 # type: sq_string
 145 # elements: 1
 146 # length: 13
 147 FPL2pdequiver
 148
 149
 150 # name: <cell-element>
 151 # type: sq_string
 152 # elements: 1
 153 # length: 275
 154  -- Function File:  FPL2pdequiver (MESH, VX, VY, [ PROPERTY, VALUE ...])
 155      Plots the 2D vector field VX, VY defined on the triangulation MESH
 156      using opendx.
 157
 158      Options (default values): SAMPLE_DENSITY (100)
 159
 160      See also: FPL2pdesurf, FPL2ptcsurf, FPL2ptcquiver
 161
 162
 163
 164
 165
 166 # name: <cell-element>
 167 # type: sq_string
 168 # elements: 1
 169 # length: 80
 170 Plots the 2D vector field VX, VY defined on the triangulation MESH
 171 using opendx.
 172
 173
 174
 175 # name: <cell-element>
 176 # type: sq_string
 177 # elements: 1
 178 # length: 15
 179 FPL2pdeshowmesh
 180
 181
 182 # name: <cell-element>
 183 # type: sq_string
 184 # elements: 1
 185 # length: 221
 186  -- Function File:  FPL2pdeshowmesh (MESH,COLOR)
 187      Displays one 2-D triangulations using opendx
 188
 189      Examples:
 190
 191           FPL2pdeshowmesh(mesh)
 192           FPL2pdeshowmesh(mesh,"blue")
 193
 194      See also: FPL2ptcshowmesh
 195
 196
 197
 198
 199
 200 # name: <cell-element>
 201 # type: sq_string
 202 # elements: 1
 203 # length: 45
 204 Displays one 2-D triangulations using opendx
 205
 206
 207
 208
 209 # name: <cell-element>
 210 # type: sq_string
 211 # elements: 1
 212 # length: 11
 213 FPL2pdesurf
 214
 215
 216 # name: <cell-element>
 217 # type: sq_string
 218 # elements: 1
 219 # length: 429
 220  -- Function File:  FPL2pdesurf (MESH, U [ PROPERTY, VALUE ...])
 221      plots the scalar field U defined on the triangulation MESH using
 222      opendx.
 223
 224      options (default value):
 225         - data_dep ("positions") defines wether data depends on
 226           positions or connections
 227
 228         - plot_field ("scalar") defines wether to plot the scalar field
 229           itself or its gradient
 230
 231      See also: MSH2Mgmsh, MSH2Mstructmesh
 232
 233
 234
 235
 236
 237 # name: <cell-element>
 238 # type: sq_string
 239 # elements: 1
 240 # length: 72
 241 plots the scalar field U defined on the triangulation MESH using opendx.
 242
 243
 244
 245 # name: <cell-element>
 246 # type: sq_string
 247 # elements: 1
 248 # length: 13
 249 FPL2ptcquiver
 250
 251
 252 # name: <cell-element>
 253 # type: sq_string
 254 # elements: 1
 255 # length: 248
 256  -- Function File:  FPL2ptcquiver (MESH1, COLOR1
 257      VX1, VY1, [ MESH2, COLOR2, VX2, VY2 ...])
 258
 259      Plots the 2D vector fields VX, VY defined on the triangulations
 260      MESH using opendx.
 261
 262      See also: FPL2pdesurf, FPL2ptcsurf, FPL2pdequiver
 263
 264
 265
 266
 267
 268 # name: <cell-element>
 269 # type: sq_string
 270 # elements: 1
 271 # length: 37
 272 VX1, VY1, [ MESH2, COLOR2, VX2, VY2 .
 273
 274
 275
 276 # name: <cell-element>
 277 # type: sq_string
 278 # elements: 1
 279 # length: 15
 280 FPL2ptcshowmesh
 281
 282
 283 # name: <cell-element>
 284 # type: sq_string
 285 # elements: 1
 286 # length: 177
 287  -- Function File:  FPL2ptcshowmesh (MESH1, COLOR1,  [MESH2, COLOR2,
 288           ...])
 289      Displays two or more 2-D triangulations using opendx
 290
 291      See also: FPL2pdeshowmesh
 292
 293
 294
 295
 296
 297 # name: <cell-element>
 298 # type: sq_string
 299 # elements: 1
 300 # length: 53
 301 Displays two or more 2-D triangulations using opendx
 302
 303
 304
 305
 306 # name: <cell-element>
 307 # type: sq_string
 308 # elements: 1
 309 # length: 11
 310 FPL2ptcsurf
 311
 312
 313 # name: <cell-element>
 314 # type: sq_string
 315 # elements: 1
 316 # length: 222
 317  -- Function File:  FPL2ptcsurf (MESH1, COLOR1, DATA1  [MESH2,
 318           COLOR2,DATA2])
 319      Plots the scalar fields DATA over the triangulation MESH using
 320      opendx. Connections will be displayed as defined in COLOR.
 321
 322
 323
 324
 325
 326 # name: <cell-element>
 327 # type: sq_string
 328 # elements: 1
 329 # length: 70
 330 Plots the scalar fields DATA over the triangulation MESH using opendx.
 331
 332
 333
 334 # name: <cell-element>
 335 # type: sq_string
 336 # elements: 1
 337 # length: 14
 338 FPL2trspdesurf
 339
 340
 341 # name: <cell-element>
 342 # type: sq_string
 343 # elements: 1
 344 # length: 311
 345  -- Function File:  FPL2trspdesurf (MESH, COLOR, DATA)
 346      Plots the transient scalar field U defined on the triangulation
 347      MESH using opendx. Connections are rendered as defined by COLOR
 348
 349      Example:
 350
 351           FPL2trspdesurf(mesh,"blue",data)
 352
 353      See also: FPL2pdesurf, FPL2ptcsurf, FPL2trsptcsurf
 354
 355
 356
 357
 358
 359 # name: <cell-element>
 360 # type: sq_string
 361 # elements: 1
 362 # length: 80
 363 Plots the transient scalar field U defined on the triangulation MESH
 364 using opend
 365
 366
 367
 368 # name: <cell-element>
 369 # type: sq_string
 370 # elements: 1
 371 # length: 14
 372 FPL2trsptcsurf
 373
 374
 375 # name: <cell-element>
 376 # type: sq_string
 377 # elements: 1
 378 # length: 373
 379  -- Function File:  FPL2trsptcsurf (MESH1, COLOR1, DATA1, [MESH2,
 380           COLOR2, DATA2])
 381      Plots the transient scalar fields DATA defined on the triangulation
 382      MESH using opendx. Connections are rendered as defined by COLOR
 383
 384      Example:
 385
 386           FPL2trspdesurf(mesh1,"blue",data1, mesh2,"red",data2)
 387
 388      See also: FPL2pdesurf, FPL2ptcsurf, FPL2trspdesurf
 389
 390
 391
 392
 393
 394 # name: <cell-element>
 395 # type: sq_string
 396 # elements: 1
 397 # length: 80
 398 Plots the transient scalar fields DATA defined on the triangulation
 399 MESH using o
 400
 401
 402
 403 # name: <cell-element>
 404 # type: sq_string
 405 # elements: 1
 406 # length: 17
 407 FPL2vtkoutputdata
 408
 409
 410 # name: <cell-element>
 411 # type: sq_string
 412 # elements: 1
 413 # length: 586
 414  -- Function File:  FPL2vtkoutputdata ( FILENAME, P, T, NODEDATA,
 415           CELLDATA, HEADER, VTKVER)
 416      Save data in VTK ASCII format.
 417
 418         - FILENAME = name of file to save into
 419
 420         - P, T = mesh node coordinates and connectivity
 421
 422         - NAME = name of a mesh variable
 423
 424         - NODEDATA/CELLDATA = node/cell centered data  fields
 425           (2xNfields cell array), *DATA{:,1} = variable names;
 426           *DATA{:,2} = variable data;
 427
 428         - HEADER comment to add in the file header
 429
 430         - VTKVER format version (default is 3.0)
 431
 432      See also: FPL2dxoutputdata
 433
 434
 435
 436
 437
 438 # name: <cell-element>
 439 # type: sq_string
 440 # elements: 1
 441 # length: 30
 442 Save data in VTK ASCII format.
 443
 444
 445
 446 # name: <cell-element>
 447 # type: sq_string
 448 # elements: 1
 449 # length: 17
 450 FPL3dxoutputfield
 451
 452
 453 # name: <cell-element>
 454 # type: sq_string
 455 # elements: 1
 456 # length: 730
 457  -- Function File:  FPL3dxoutputfield( FILENAME, MESHFILENAME, DEP, U,
 458           ATTR_NAME, ATTR_RANK, ATTR_SHAPE, ENDFILE )
 459      Outputs data in DX form.
 460
 461      Variable must be a scalar, vector or tensor of doubles
 462
 463         - FILENAME     = name of file to save (type string)
 464
 465         - MESHFILENAME = name of mesh file (type string)
 466
 467         - DEP          = "positions" for node data, "connections" for
 468           element data
 469
 470         - FIELD        = field data to be saved
 471
 472         - ATTR_NAME    = name of the variable (type string)
 473
 474         - ATTR_RANK    = rank of variable data (0 for scalar, 1 for
 475           vector, etc.)
 476
 477         - ATTR_SHAPE   = number of components of variable data
 478           (assumed 1 for scalar)
 479
 480
 481
 482
 483 # name: <cell-element>
 484 # type: sq_string
 485 # elements: 1
 486 # length: 24
 487 Outputs data in DX form.
 488
 489
 490
 491 # name: <cell-element>
 492 # type: sq_string
 493 # elements: 1
 494 # length: 16
 495 FPL3dxoutputmesh
 496
 497
 498 # name: <cell-element>
 499 # type: sq_string
 500 # elements: 1
 501 # length: 246
 502  -- Function File:  FPL3dxoutputmesh ( FILENAME, MESH )
 503      Outputs data in DX form.
 504
 505      Variable must be a scalar, vector or tensor of doubles
 506
 507         - FILENAME = name of file to save (type string)
 508
 509         - MESH     = PDE-tool like mesh
 510
 511
 512
 513
 514 # name: <cell-element>
 515 # type: sq_string
 516 # elements: 1
 517 # length: 24
 518 Outputs data in DX form.
 519
 520
 521
 522 # name: <cell-element>
 523 # type: sq_string
 524 # elements: 1
 525 # length: 18
 526 fpl_dx_write_field
 527
 528
 529 # name: <cell-element>
 530 # type: sq_string
 531 # elements: 1
 532 # length: 1662
 533  -- Function File:  fpl_dx_writefield (BASENAME, MESH, U, ATTR_NAME,
 534           ATTR_RANK, ATTR_SHAPE, ENDFILE)
 535      Output data field in ASCII Open-DX format.
 536
 537      BASENAME is a string containing the base-name of the dx file where
 538      the data will be saved.
 539
 540      MESH is a PDE-tool like mesh, like the ones generated by the "msh"
 541      package.
 542
 543      U is the field to be saved. It should represent scalar, vector or
 544      tensor of doubles.
 545
 546      ATTR_NAME is a descriptive name for the field U, while ATTR_RANK
 547      is the rank of the field (0 for scalar, 1 for vector, etc.) and
 548      ATTR_SHAPE is the number of components of the field (assumed 1 for
 549      scalar).
 550
 551      ENDFILE should be 0 if you want to add other variables to the same
 552      file, 1 otherwise.
 553
 554      Notice that when appending fields to an already existing file:
 555
 556         * MESH will not be printed to FILENAME, but it will be only
 557           used to determine if the field is piece-wise constant or
 558           piece-wise linear
 559
 560         * U is not checked for consistency against the MESH already
 561           printed in FILENAME
 562
 563      Example 1 (wrong usage):
 564           <generate msh1/u1 msh2/u2 in some way>
 565           fpl_dx_write_field("field.dx",msh1,u1,"density",1,0,0);
 566           fpl_dx_write_field("field.dx",msh2,u2,"temperature",1,0,1);
 567      generate a file that fails at OpenDX run-time.
 568
 569      Example 2:
 570           <generate msh1 and two fields u1-u2 in some way>
 571           fpl_dx_write_field("field",msh1,u1,"density",1,0,0);
 572           fpl_dx_write_field("field",msh1,u2,"temperature",1,0,1);
 573      will generate a valid OpenDX ASCII data file.
 574
 575      See also: fpl_dx_write_series
 576
 577
 578
 579
 580
 581 # name: <cell-element>
 582 # type: sq_string
 583 # elements: 1
 584 # length: 42
 585 Output data field in ASCII Open-DX format.
 586
 587
 588
 589 # name: <cell-element>
 590 # type: sq_string
 591 # elements: 1
 592 # length: 19
 593 fpl_dx_write_series
 594
 595
 596 # name: <cell-element>
 597 # type: sq_string
 598 # elements: 1
 599 # length: 812
 600  -- Function File:  fpl_dx_write_series (BASENAME, MESH, U, SP,
 601           ATTR_NAME, ATTR_RANK, ATTR_SHAPE)
 602      Output data series in ASCII Open-DX format.
 603
 604      BASENAME is a string containing the base-name of the dx file where
 605      the data will be saved.
 606
 607      MESH is a PDE-tool like mesh, like the ones generated by the "msh"
 608      package.
 609
 610      U is the series to be saved. It should represent scalar, vector or
 611      tensor of doubles. SP is the vector of the sampled points (e.g.
 612      time points in the case of a time series).
 613
 614      ATTR_NAME is a descriptive name for the series U, while ATTR_RANK
 615      is the rank of the field items (0 for scalar, 1 for vector, etc.)
 616      and ATTR_SHAPE is the number of components of the field items
 617      (assumed 1 for scalar).
 618
 619      See also: fpl_dx_write_field
 620
 621
 622
 623
 624
 625 # name: <cell-element>
 626 # type: sq_string
 627 # elements: 1
 628 # length: 43
 629 Output data series in ASCII Open-DX format.
 630
 631
 632
 633 # name: <cell-element>
 634 # type: sq_string
 635 # elements: 1
 636 # length: 19
 637 fpl_vtk_write_field
 638
 639
 640 # name: <cell-element>
 641 # type: sq_string
 642 # elements: 1
 643 # length: 1099
 644  -- Function File:  fpl_vtk_write_field (BASENAME, MESH, NODEDATA,
 645           CELLDATA, ENDFILE)
 646      Output data field in serial XML-VTK UnstructuredGrid format.
 647
 648      BASENAME is a string containing the base-name of the (vtu) file
 649      where the data will be saved.
 650
 651      MESH is a PDE-tool like mesh, like the ones generated by the "msh"
 652      package.
 653
 654      NODEDATA and CELLDATA are (Ndata x 2) cell arrays containing
 655      respectively <PointData> and <CellData> representing scalars or
 656      vectors:
 657         - *DATA{:,1} = variable data;
 658
 659         - *DATA{:,2} = variable names;
 660
 661      ENDFILE should be 0 if you want to add other variables to the same
 662      file, 1 otherwise.
 663
 664      Example:
 665           <generate msh1, node centered field nc1, cell centered field cc1>
 666           fpl_vtk_write_field("example",msh1,{nc1, "temperature"}, {cc1, "density"},0);
 667           <generate msh2, node centered field nc2>
 668           fpl_vtk_write_field("example",msh2,{nc2, "temperature"}, {},1);
 669      will generate a valid XML-VTK UnstructuredGrid file.
 670
 671      See also: fpl_dx_write_field, fpl_dx_write_series
 672
 673
 674
 675
 676
 677 # name: <cell-element>
 678 # type: sq_string
 679 # elements: 1
 680 # length: 60
 681 Output data field in serial XML-VTK UnstructuredGrid format.
 682
 683
 684
 685 # name: <cell-element>
 686 # type: sq_string
 687 # elements: 1
 688 # length: 7
 689 pdemesh
 690
 691
 692 # name: <cell-element>
 693 # type: sq_string
 694 # elements: 1
 695 # length: 295
 696  -- Function File: H = pdemesh (P, E, T, U)
 697      Plot a triangular mesh in 3D given a mesh structure and node data.
 698      P, T are the mesh vertices and connectivity, U node data.  E is
 699      ignored and is accepted only for compatibiity.
 700
 701      See also: fpl_dx_write_field, fpl_vtk_write_field
 702
 703
 704
 705
 706
 707 # name: <cell-element>
 708 # type: sq_string
 709 # elements: 1
 710 # length: 66
 711 Plot a triangular mesh in 3D given a mesh structure and node data.
 712
 713
 714
 715 # name: <cell-element>
 716 # type: sq_string
 717 # elements: 1
 718 # length: 7
 719 pdesurf
 720
 721
 722 # name: <cell-element>
 723 # type: sq_string
 724 # elements: 1
 725 # length: 250
 726  -- Function File: H = pdesurf (P, T, U)
 727      Plot a 3D surface given node or element data on a triangular mesh.
 728      P, T are the mesh vertices and connectivity, U node or element
 729      data.
 730
 731      See also: fpl_dx_write_field, fpl_vtk_write_field
 732
 733
 734
 735
 736
 737 # name: <cell-element>
 738 # type: sq_string
 739 # elements: 1
 740 # length: 66
 741 Plot a 3D surface given node or element data on a triangular mesh.
 742
 743
 744
 745
 746