Add Netgen .vol to Gmsh/VTK converter utility

pyproject.toml

@@ -0,0 +1,14 @@
+[build-system]
+requires = [
+    "setuptools",
+    "wheel",
+    "scikit-build",
+    "cmake",
+    "pybind11-stubgen==2.5",
+    "netgen-mesher",
+    "mkl",
+    "intel-cmplr-lib-rt",
+    "requests",
+    "packaging",
+]
+build-backend = "setuptools.build_meta"

utils/vol_to_gmsh/README.md

@@ -0,0 +1,123 @@
+# Netgen .vol to Gmsh/VTK Converter
+
+## Overview
+
+Convert Netgen `.vol` mesh files to Gmsh `.msh` or VTK `.vtk` format for visualization.
+
+## Requirements
+
+- NGSolve / Netgen (installed)
+- Gmsh (optional, for viewing .msh files)
+- ParaView (optional, for viewing .vtk files)
+
+## Usage
+
+### Basic Gmsh Conversion
+
+```bash
+# Convert .vol to .msh (Gmsh format)
+python vol_to_gmsh.py input.vol
+
+# Output: input.msh
+```
+
+### VTK Conversion
+
+```bash
+# Convert .vol to .vtk (VTK format)
+python vol_to_gmsh.py input.vol --vtk
+
+# Output: input.vtk
+```
+
+### Custom Output Name
+
+```bash
+# Specify output filename
+python vol_to_gmsh.py input.vol output.msh
+python vol_to_gmsh.py input.vol output.vtk --vtk
+```
+
+### View in Gmsh
+
+```bash
+# Convert and open in Gmsh
+python vol_to_gmsh.py input.vol --view
+```
+
+## Examples
+
+### Example 1: Convert cube mesh
+
+```bash
+python vol_to_gmsh.py cube.vol
+```
+
+### Example 2: Convert to VTK format for ParaView
+
+```bash
+python vol_to_gmsh.py mesh.vol --vtk
+```
+
+## Gmsh Format Details
+
+The script exports to **Gmsh Format 2.x** (ASCII format):
+
+- Section `$Nodes`: Vertex coordinates (1-indexed)
+- Section `$Elements`: Elements with type IDs
+- Supports up to 2nd order elements
+
+### Element Type IDs (Gmsh 2.x)
+
+| Type ID | Element | Nodes |
+|---------|---------|-------|
+| 2 | Triangle | 3 |
+| 4 | Tetrahedron | 4 |
+| 5 | Hexahedron | 8 |
+| 6 | Wedge/Prism | 6 |
+
+For details, see the [Gmsh documentation](https://gmsh.info/doc/texinfo/gmsh.html).
+
+## VTK Format Details
+
+VTK format is suitable for:
+- ParaView visualization
+- Python analysis with PyVista
+- Legacy VTK readers
+
+## Tested Files
+
+Successfully converted:
+- `cube.vol` (228 vertices, 756 elements)
+- `coil.vol` (331 vertices, 1709 elements)
+- `shaft.vol` (558 vertices, 1622 elements)
+- `square.vol` (2D mesh)
+
+## Troubleshooting
+
+### Error: File not found
+
+Check that the input `.vol` file exists:
+```bash
+ls -l input.vol
+```
+
+### Error: Gmsh not found in PATH
+
+Install Gmsh from https://gmsh.info/ or disable `--view` option.
+
+### Unicode encoding errors (Windows)
+
+Script now uses ASCII characters `[OK]` instead of Unicode checkmarks for Windows cp932 compatibility.
+
+## Related Tools
+
+- **Gmsh**: https://gmsh.info/
+- **ParaView**: https://www.paraview.org/
+- **PyVista**: https://docs.pyvista.org/
+
+## Notes
+
+- Gmsh format version can be selected with `--format gmsh` or `--format gmsh2`
+- Default: Gmsh 2.x format (widely supported)
+- VTK format includes mesh geometry only (no field data)

utils/vol_to_gmsh/test_vol_to_gmsh.py

@@ -0,0 +1,68 @@
+"""Tests for vol_to_gmsh converter."""
+
+import os
+import pytest
+from pathlib import Path
+from vol_to_gmsh import convert_vol_to_gmsh, convert_vol_to_vtk
+
+
+@pytest.fixture
+def sample_mesh(tmp_path):
+    """Create a simple test mesh."""
+    from netgen.csg import unit_cube
+    mesh = unit_cube.GenerateMesh(maxh=0.5)
+    vol_file = str(tmp_path / "test.vol")
+    mesh.Save(vol_file)
+    return vol_file
+
+
+def test_convert_to_gmsh(sample_mesh, tmp_path):
+    """Test basic Gmsh conversion."""
+    output = str(tmp_path / "test.msh")
+    result = convert_vol_to_gmsh(sample_mesh, output)
+    assert os.path.exists(result)
+    assert result == output
+
+    with open(result) as f:
+        content = f.read()
+    assert "$MeshFormat" in content
+    assert "$Nodes" in content
+    assert "$Elements" in content
+
+
+def test_convert_to_gmsh_default_name(sample_mesh):
+    """Test Gmsh conversion with auto-generated filename."""
+    result = convert_vol_to_gmsh(sample_mesh)
+    expected = str(Path(sample_mesh).with_suffix('.msh'))
+    assert result == expected
+    assert os.path.exists(result)
+
+
+def test_convert_to_vtk(sample_mesh, tmp_path):
+    """Test VTK conversion."""
+    output = str(tmp_path / "test")
+    result = convert_vol_to_vtk(sample_mesh, output)
+    assert os.path.exists(result)
+    assert result.endswith('.vtu')
+
+
+def test_missing_file():
+    """Test error handling for missing file."""
+    with pytest.raises(RuntimeError):
+        convert_vol_to_gmsh("nonexistent.vol")
+
+
+def test_mixed_elements(tmp_path):
+    """Test conversion of mesh with multiple element types."""
+    from netgen.occ import Box, OCCGeometry, Pnt
+
+    box = Box(Pnt(0, 0, 0), Pnt(1, 1, 1))
+    geo = OCCGeometry(box)
+    mesh = geo.GenerateMesh(maxh=0.5)
+
+    vol_file = str(tmp_path / "mixed.vol")
+    mesh.Save(vol_file)
+
+    output = str(tmp_path / "mixed.msh")
+    result = convert_vol_to_gmsh(vol_file, output)
+    assert os.path.exists(result)