KVSMLConverter_EN - CCSEPBVR/CS-IS-PBVR GitHub Wiki

KVSML Converter

Overview

The KVSML converter is a library that converts various file formats used as output in CFD to the KVSML format for CS-PBVR. The output files consist of the KVSML data itself and a PFI/PFL file that describes its metadata.

Environment requirements

How to do it

After a successful build, a binary called kvsml-converter will be generated in Example/Release, or in /bin.
The binary converts a input file to KVSML format and saves it in a output directory.
The output file is a set of KVSML files and PFI/PFL files describing its metadata.
Here is how to do it.

<path>/kvsml-converter <path to Example/Input> <output destination>

If the current directory is CS-IS-PBVR/CS_server/KVSMLConverter, the following command is used.

# path to input file:Example/Input/VTKExamples/src/Testing/Data/fire_ug.vtu
# Destination:fire_ug
Example/Release/kvsml-converter ./Example/Input/VTKExamples/src/Testing/Data/fire_ug.vtu ./fire_ug

When executed, the following files will be created.

  • A set of KVSML files.
    • fire_ug_2_00000_0000001_0000001.kvsml
    • fire_ug_2_00000_0000001_0000001_coord.dat
    • fire_ug_2_00000_0000001_0000001_connect.dat
    • fire_ug_2_00000_0000001_0000001_value.dat
  • fire_ug.pfi
  • fire_ug.pfl

Convert .vtu time series files to KVSML format as an example of a time series file.
Use wildcards(*) to specify time series files as input files.
For macOS or Linux, input files must be enclosed in single quotes.
For Windows, input files must be specified without single quotation marks.
If the current directory is CS-IS-PBVR/CS_server/KVSMLConverter, the following command is used.

# path to input file:Example/Input/Tetra/tetra_only_*.vtu
# Destination:Tetra
(macOS or Linux):Example/Release/kvsml-converter 'Example/Input/Tetra/tetra_only_*.vtu' Tetra
(Windows):Example\Release\kvsml-converter.exe Example\Input\Tetra\tetra_only_*.vtu Tetra

When executed, the following files will be created.

  • A set of KVSML files.(*:0~9)
    • tetra_only_1_0000*_0000001_0000001.kvsml
    • tetra_only_1_00000_0000001_0000001_coord.dat
    • tetra_only_1_00000_0000001_0000001_connect.dat
    • tetra_only_1_0000*_0000001_0000001_value.dat
  • tetra_only_1.pfi
  • tetra_only.pfl

Sample List

The following example is stored below.

File Name Function Name Overview
AVSExample.cpp AvsUcd2Kvsml Reads AVS UCD files.
CgnsExample.cpp Cgns2Kvsml Reads CGNS files
EnSightExample.cpp Case2Kvsml Reads EnSight Gold binary files
Plot3dExample.cpp Plot3d2Kvsml Reads PLOT3D files.
PvtsExample.cpp Pvts2Kvsml Reads PVTS format files.
PvtuExample.cpp Pvtu2Kvsml Reads a single PVTU format file.
PvtuExample.cpp SeriesPvtu2Kvsml Distributed loading of time-series PVTU format files.
PvtuExample.cpp SeriesPvtu2KvsmlWhole PVTU format files for the entire series.
StlExample.cpp Stl2Stl Reads STL files.
StlExample.cpp Stl2Kvsml Reads STL files.
VtiExample.cpp StructuredPoints2Kvsml Reads StructuredPoints format (legacy VTK format).
VtiExample.cpp Vti2Kvsml Reads a single VTI format file.
VtiExample.cpp SeriesVti2Kvsml Reads time-series VTI format files.
VtmExample.cpp AccessToVtm Example of accessing VTK MultiBlock data.
VtmExample.cpp SeriesVtm2Kvsml Reads VTK MultiBlock files for unstructured grids only.
VtpExample.cpp Vtp2Kvsml Reads VTP format files.
VtrExample.cpp Vtr2Kvsml Reads VTR format files.
VtsExample.cpp Vts2Kvsml Reads VTS format files.
VtuExample.cpp Vtu2Kvsml Reads VTU format files.
VtuExample.cpp SeriesVtu2Kvsml Reads time-series VTU format files.
VtuExample.cpp PointVtu2Kvsml Reads VTU format files for points only.
VtuExample.cpp LineVtu2Kvsml Reads VTU format files for lines only.
VtuExample.cpp TriangleVtu2Kvsml Reads VTU format files for triangles only.

List of input examples

It is stored below Example/Input.

Directory Name Overview
Hex Hexahedral non-structured lattice.
MultiBlock Multi-block with multiple data types.
pbvr_sample_data CCSEPBVR/pbvr_sample_data (external repository)
Polygon Polygon data.
Pvts Distributed structured lattice.
Pvtu When the series includes mixed elements of the unstructured lattice.
Tetra Time-series tetrahedral non-structured lattice.
TetraAndHex Time-series mixed tetrahedral and hexahedral non-structured lattice.
Triangle Triangular element non-structured lattice.
UnstructuredMultiBlock Time-series mixed element unstructured lattice multi-block.
Vertex Nodal element unstructured lattice.
Vti Time-series structured grid.
VTKExamples Kitware/vtk-examples (external repository)

Links

⚠️ **GitHub.com Fallback** ⚠️