Supporting reading VTU files

Author: w1th0utnam3

CHANGELOG.md

@@ -8,6 +8,8 @@ The following changes are present in the `main` branch of the repository and are
  - Lib: Support for writing particles as BGEO
  - CLI: Support for new writers in `convert` subcommand
  - Lib: Rename `AxisAlignedBoundingBox*d` typedefs to `Aabb3d` and `Aabb2d` 
+ - Lib: Support reading VTU (VTK XML) files
+ - CLI: Support reconstruction of particles from VTU (VTK XML) files, including attributes
 
 ## Version 0.8.0
 

Cargo.lock

@@ -13,7 +13,7 @@ use std::path::PathBuf;
 /// Command line arguments for the `convert` subcommand
 #[derive(Clone, Debug, clap::Parser)]
 pub struct ConvertSubcommandArgs {
-    /// Path to the input file with particles to read (supported formats: .vtk, .bgeo, .ply, .xyz, .json)
+    /// Path to the input file with particles to read (supported formats: .vtk, .vtu, .bgeo, .ply, .xyz, .json)
     #[arg(
         long = "particles",
         value_parser = value_parser!(PathBuf),

splashsurf/src/convert.rs

@@ -68,6 +68,7 @@ pub fn read_particle_positions<R: Real, P: AsRef<Path>>(
 
         match extension.to_lowercase().as_str() {
             "vtk" => vtk_format::particles_from_vtk(&input_file),
+            "vtu" => vtk_format::particles_from_vtk(&input_file),
             "xyz" => xyz_format::particles_from_xyz(&input_file),
             "ply" => ply_format::particles_from_ply(&input_file),
             "bgeo" => bgeo_format::particles_from_bgeo(&input_file),
@@ -115,11 +116,14 @@ pub fn read_particle_positions_with_attributes<R: Real, P: AsRef<Path>>(
             "Unable to detect file format of particle input file (file name has to end with supported extension)",
         ))?.to_str().ok_or(anyhow!("Invalid extension of input file"))?.to_lowercase();
 
-        if extension != "vtk" {
-            return Err(anyhow!(
-                "Unsupported file format extension \"{}\" for reading particles and attributes",
-                extension
-            ));
+        match extension.as_str() {
+            "vtk" | "vtu" => {}
+            _ => {
+                return Err(anyhow!(
+                    "Unsupported file format extension \"{}\" for reading particles and attributes",
+                    extension
+                ));
+            }
         }
     }
 

splashsurf/src/io.rs

@@ -29,7 +29,7 @@ static ARGS_OTHER: &str = "Remaining options";
 #[clap(group = clap::ArgGroup::new("input").required(true))]
 #[command(next_help_heading = ARGS_OTHER)]
 pub struct ReconstructSubcommandArgs {
-    /// Path to the input file where the particle positions are stored (supported formats: VTK, binary f32 XYZ, PLY, BGEO)
+    /// Path to the input file where the particle positions are stored (supported formats: VTK 4.2, VTU, binary f32 XYZ, PLY, BGEO)
     #[arg(help_heading = ARGS_IO, short = 'i', long, group = "input", value_parser = value_parser!(PathBuf))]
     pub input_file: Option<PathBuf>,
     /// Path to a sequence of particle files that should be processed, use `{}` in the filename to indicate a placeholder
@@ -183,7 +183,7 @@ pub struct ReconstructSubcommandArgs {
         require_equals = true
     )]
     pub sph_normals: Switch,
-    /// List of point attribute field names from the input file that should be interpolated to the reconstructed surface. Currently this is only supported for VTK input files.
+    /// List of point attribute field names from the input file that should be interpolated to the reconstructed surface. Currently this is only supported for VTK and VTU input files.
     #[arg(help_heading = ARGS_INTERP, long)]
     pub interpolate_attributes: Vec<String>,
 

splashsurf/src/reconstruction.rs

@@ -57,7 +57,7 @@ numeric_literals = "0.2"
 rstar = "0.10"
 
 # IO
-vtkio = { version = "0.6", default-features = false, optional = true }  # Disable moden XML format for now (hardly used)
+vtkio = { version = "0.6", optional = true }
 ply-rs = { version = "0.1.3", optional = true }
 flate2 = { version = "1.0", optional = true }
 nom = { version = "7.1.3", optional = true }

splashsurf_lib/Cargo.toml

@@ -188,7 +188,7 @@ pub fn write_vtk<P: AsRef<Path>>(
     title: &str,
 ) -> Result<(), anyhow::Error> {
     let vtk_file = Vtk {
-        version: Version::new((4, 1)),
+        version: Version::new((4, 2)),
         title: title.to_string(),
         file_path: None,
         byte_order: ByteOrder::BigEndian,