star-mesh

Define and load a binary data format for meshes
git clone git://git.meso-star.fr/star-mesh.git
Log | Files | Refs | README | LICENSE

vtk-data.1 (3359B)


      1 .\" Copyright (C) 2020-2023, 2025 |Méso|Star> (contact@meso-star.com)
      2 .\"
      3 .\" This program is free software: you can redistribute it and/or modify
      4 .\" it under the terms of the GNU General Public License as published by
      5 .\" the Free Software Foundation, either version 3 of the License, or
      6 .\" (at your option) any later version.
      7 .\"
      8 .\" This program is distributed in the hope that it will be useful,
      9 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
     10 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
     11 .\" GNU General Public License for more details.
     12 .\"
     13 .\" You should have received a copy of the GNU General Public License
     14 .\" along with this program. If not, see <http://www.gnu.org/licenses/>.
     15 .Dd May 9, 2025
     16 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     17 .Dt VTK-CELL-DATA 1
     18 .Os
     19 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     20 .Sh NAME
     21 .Nm vtk-data
     22 .Nd transforms a list of values into cell data in VTK format
     23 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     24 .Sh SYNOPSIS
     25 .Nm
     26 .Op Fl n Ar name No ...
     27 .Op Fl o Ar output
     28 .Fl c Ar cell_count
     29 .Op Ar data
     30 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     31 .Sh DESCRIPTION
     32 .Nm
     33 formats a list of double precision values in cell data sets as defined in the
     34 legacy VTK format.
     35 To describe a valid VTK file, the result must then be concatenated with a VTK
     36 file storing the geometry of the cells to which this data corresponds.
     37 .Pp
     38 As input,
     39 .Nm
     40 reads a set of
     41 .Ar cell_count
     42 floating-point ASCII values from
     43 .Ar data
     44 or from standard input if
     45 .Ar data
     46 is not specified.
     47 This continues until no more data is supplied or 8 sets have been read.
     48 Each set thus represents a data set associated with each cell.
     49 If a set doesn't contain enough data
     50 .Pq i.e. less than Ar cell_count ,
     51 an error is returned.
     52 .Pp
     53 The options are as follows:
     54 .Bl -tag -width Ds
     55 .It Fl n Ar name
     56 Name of a data set.
     57 It cannot contain spaces or tabs.
     58 This option can be repeated as many times as there are data sets to be
     59 processed.
     60 By default, the name of each dataset is
     61 .Qq data Ns Ar i ,
     62 with
     63 .Ar i
     64 in
     65 .Bq 0,7
     66 the dataset index.
     67 .It Fl o Ar output
     68 Output file.
     69 If not defined, VTK output data is written to the standard output.
     70 .It Fl c Ar cell_count
     71 Number of cells, i.e. number of floating-point values provided per data set.
     72 .El
     73 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     74 .Sh EXIT STATUS
     75 .Ex -std
     76 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     77 .Sh EXAMPLES
     78 Formats a list of 200 floating-point ASCII values read from the
     79 .Pa data.txt
     80 file into two sets of
     81 .Ar 100
     82 values, one value per cell.
     83 Name the first set of data per cell
     84 .Qq temperature ,
     85 and the second
     86 .Qq flux .
     87 Output VTK data are written to
     88 .Pa data.vtk .
     89 Next, concatenate the cell data with their corresponding geometry stored in the
     90 .Pa mesh.vtk
     91 file, and thus define the complete VTK file
     92 .Pa results.vtk .
     93 .Bd -literal -offset Ds
     94 vtk-cell-data -c 100 -n temperature -n flux -o data.vtk data.txt
     95 cat mesh.vtk data.vtk > result.vtk
     96 .Ed
     97 .\""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
     98 .Sh STANDARDS
     99 .Rs
    100 .%B The VTK User's Guide
    101 .%O Simple Legacy Formats
    102 .%I Kitware, Inc
    103 .%N 11
    104 .%D 2010
    105 .%P 470--482
    106 .Re