VTKpytools/Barfiletools - Revision history

Jrwrigh: Add Python Category

2022-09-18T17:17:32Z

Add Python Category

2022-06-28T14:25:56Z

Add more back references to bar2vtk

2021-07-09T16:21:51Z

Jrwrigh moved page Barfiletools to VTKpytools/Barfiletools: Use subpages to organize vtkpytool related pages

2021-03-05T19:08:52Z

Add flow charts

2021-03-04T19:47:29Z

‎Load *bar File Data: : Remove TKE reference

2020-10-17T22:23:16Z

‎Creating Blank VTM File

2020-09-07T15:37:47Z

Explicilty add section for VTM file format

2020-09-06T04:48:35Z

2020-09-06T04:48:20Z

2020-09-06T04:40:32Z

‎Load *bar File Data

@@ Line 52: / Line 52: @@
 [[File:Vtkpytools flowchart-Using bar2vtk.png]]
-Now that you have a "blank" VTM file, you can add *bar file data onto it using [[Bar2vtk|bar2vtk]], a CLI program. You can find documentation for it by running <code>bar2vtk --help</code>. It supports:
+Now that you have a "blank" VTM file, you can add *bar file data onto it using [[Bar2vtk|bar2vtk]], a CLI program. You can find documentation for it by running <code>bar2vtk --help</code> or looking at the [[Bar2vtk|Bar2vtk]] wiki page. It supports:
 * Creating timestep windows

@@ Line 26: / Line 26: @@
 == Creating Blank VTM File ==
 The process of creating the blank VTM file is:
@@ Line 49: / Line 50: @@
 == Load *bar File Data ==
 Now that you have a "blank" VTM file, you can add *bar file data onto it using [[Bar2vtk|bar2vtk]], a CLI program. You can find documentation for it by running <code>bar2vtk --help</code>. It supports:

@@ Line 56: / Line 56: @@
 * Custom file names/paths to data
-This process will create "Pressure", "Velocity", "ReynoldsStress", and "TurbulentEnergyKinetic" quantities in both <code>grid</code> and <code>wall</code> objects. Note that the quantity names are from [https://cgns.github.io/CGNS_docs_current/sids/dataname.html Appendix A of the CGNS standard].
+This process will create "Pressure", "Velocity", and "ReynoldsStress" quantities in both <code>grid</code> and <code>wall</code> objects. Note that the quantity names are from [https://cgns.github.io/CGNS_docs_current/sids/dataname.html Appendix A of the CGNS standard].
 An example script demonstrating the shell commands for running <code>bar2vtk</code> is in [https://github.com/PHASTA/vtkpytools/blob/master/example/bar2vtk/runbar2vtk.sh <code>runbar2vtk.sh</code>] in the example directory of the repository.

@@ Line 31: / Line 31: @@
 # Load 2D mesh data
 #* Specifically, the coordinate and connectivity information of the spanwise mesh. Note that the connectivity array should be indexed at 0 (ie. the first node should be zero).
 # Generate <code>grid</code>
 #* Using <code>vpt.form2DGrid()</code> with the coordinate and connectivity information

← Older revision	Revision as of 16:21, 9 July 2021
(No difference)

@@ Line 13: / Line 13: @@
 Examples of each of the three processes listed above can be found in the [https://github.com/PHASTA/vtkpytools/tree/master/example/bar2vtk examples directory of the vtkpytools repository].
-== Creating Blank VTM File ==
+=== VTM File Format ===
-The VTM file simply holds the coordinate, connectivity, and geometry information for the domain. It should contain two blocks: <code>grid</code> and <code>wall</code>.
+The blank VTM file simply holds the coordinate, connectivity, and geometry information for the domain. Data is then loaded onto these points afterwards.
 ; <code>grid</code>
-: A VTK Unstructured Grid of the 2D spanwise mesh and (after running <code>bar2vtk</code>) the data associated with each node
+: A VTK Unstructured Grid of the 2D spanwise mesh and (after data has been loaded onto the VTM file) the data associated with each node
 ; <code>wall</code>
 : A VTK PolyData of the line that defines the wall of the domain. It is a subset of the connectivity and vertices of <code>grid</code>
 The process of creating the blank VTM file is:
@@ Line 62: / Line 68: @@
 Much of this is a function of using pyvista as the primary interface for VTK, so I'd recommend checking out pyvista's documentation, specifically the [https://docs.pyvista.org/getting-started/what-is-a-mesh.html#what-are-attributes section going over attributes] (as this is most relevant to "data extraction" post-processing).
 [[Category:VTKpytools]]
 [[Category:Post-processing]]

@@ Line 1: / Line 1: @@
 '''barfiletools''' is a module within the [[VTKpytools]] package containing functions for converting *bar files (<code>velbar</code>, <code>stsbar</code>, etc.) into VTK files and for post-processing those VTK files.
-As a reminder, all vtkpytools functions and classes have inline documentation via docstrings. API documentation maybe implemented eventually...
+As a reminder, all vtkpytools functions and classes have inline documentation via docstrings. API documentation via Sphinx maybe implemented eventually...
 == Overview of Post-Processing *bar Files ==