From 34b477094998d205505bd535a8486d11f4ccd591 Mon Sep 17 00:00:00 2001
From: Andrew Heather <>
Date: Fri, 26 Nov 2021 16:06:32 +0000
Subject: [PATCH] TUT: Added glTF export example for field and track data

---
 .../filter/constant/particleTrackProperties   | 29 ++++++++++-
 .../constant/particleTrackProperties.animate  | 51 ++++++++++++++++++
 .../constant/particleTrackProperties.static   | 51 ++++++++++++++++++
 .../filter/system/controlDict                 |  3 +-
 .../reactingParcelFoam/filter/system/sample   | 52 +++++++++++++++++++
 5 files changed, 184 insertions(+), 2 deletions(-)
 create mode 100644 tutorials/lagrangian/reactingParcelFoam/filter/constant/particleTrackProperties.animate
 create mode 100644 tutorials/lagrangian/reactingParcelFoam/filter/constant/particleTrackProperties.static
 create mode 100644 tutorials/lagrangian/reactingParcelFoam/filter/system/sample

diff --git a/tutorials/lagrangian/reactingParcelFoam/filter/constant/particleTrackProperties b/tutorials/lagrangian/reactingParcelFoam/filter/constant/particleTrackProperties
index 5504a76f34..e70b4312de 100644
--- a/tutorials/lagrangian/reactingParcelFoam/filter/constant/particleTrackProperties
+++ b/tutorials/lagrangian/reactingParcelFoam/filter/constant/particleTrackProperties
@@ -1,7 +1,7 @@
 /*--------------------------------*- C++ -*----------------------------------*\
 | =========                 |                                                 |
 | \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox           |
-|  \\    /   O peration     | Version:  v2106                                 |
+|  \\    /   O peration     | Version:  v2112                                 |
 |   \\  /    A nd           | Website:  www.openfoam.com                      |
 |    \\/     M anipulation  |                                                 |
 \*---------------------------------------------------------------------------*/
@@ -20,5 +20,32 @@ sampleFrequency 1;
 
 maxPositions    1000000;
 
+//maxTracks       5;
+
+setFormat       gltf;
+
+formatOptions
+{
+    animate         yes;
+    colour          yes;
+
+    animationInfo
+    {
+        colour          field;
+        colourField     d;
+        //min             0;
+        //max             0.002;
+
+        //alpha           uniform;
+        //alphaValue      1;
+
+        alpha           field;
+        alphaField      d;
+        normalise       yes;
+    }
+}
+
+fields          (d);
+
 
 // ************************************************************************* //
diff --git a/tutorials/lagrangian/reactingParcelFoam/filter/constant/particleTrackProperties.animate b/tutorials/lagrangian/reactingParcelFoam/filter/constant/particleTrackProperties.animate
new file mode 100644
index 0000000000..e70b4312de
--- /dev/null
+++ b/tutorials/lagrangian/reactingParcelFoam/filter/constant/particleTrackProperties.animate
@@ -0,0 +1,51 @@
+/*--------------------------------*- C++ -*----------------------------------*\
+| =========                 |                                                 |
+| \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox           |
+|  \\    /   O peration     | Version:  v2112                                 |
+|   \\  /    A nd           | Website:  www.openfoam.com                      |
+|    \\/     M anipulation  |                                                 |
+\*---------------------------------------------------------------------------*/
+FoamFile
+{
+    version     2.0;
+    format      ascii;
+    class       dictionary;
+    object      particleTrackProperties;
+}
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+cloud           reactingCloud1;
+
+sampleFrequency 1;
+
+maxPositions    1000000;
+
+//maxTracks       5;
+
+setFormat       gltf;
+
+formatOptions
+{
+    animate         yes;
+    colour          yes;
+
+    animationInfo
+    {
+        colour          field;
+        colourField     d;
+        //min             0;
+        //max             0.002;
+
+        //alpha           uniform;
+        //alphaValue      1;
+
+        alpha           field;
+        alphaField      d;
+        normalise       yes;
+    }
+}
+
+fields          (d);
+
+
+// ************************************************************************* //
diff --git a/tutorials/lagrangian/reactingParcelFoam/filter/constant/particleTrackProperties.static b/tutorials/lagrangian/reactingParcelFoam/filter/constant/particleTrackProperties.static
new file mode 100644
index 0000000000..76b844fff6
--- /dev/null
+++ b/tutorials/lagrangian/reactingParcelFoam/filter/constant/particleTrackProperties.static
@@ -0,0 +1,51 @@
+/*--------------------------------*- C++ -*----------------------------------*\
+| =========                 |                                                 |
+| \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox           |
+|  \\    /   O peration     | Version:  v2112                                 |
+|   \\  /    A nd           | Website:  www.openfoam.com                      |
+|    \\/     M anipulation  |                                                 |
+\*---------------------------------------------------------------------------*/
+FoamFile
+{
+    version     2.0;
+    format      ascii;
+    class       dictionary;
+    object      particleTrackProperties;
+}
+// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
+
+cloud           reactingCloud1;
+
+sampleFrequency 1;
+
+maxPositions    1000000;
+
+//maxTracks       5;
+
+setFormat       gltf;
+
+formatOptions
+{
+    animate         no;
+    colour          yes;
+
+    fieldInfo
+    {
+        d
+        {
+            colourMap       rainbow;
+            min             0;
+            max             0.001;
+
+            alpha           field; // uniform | field;
+            //alphaValue      0.1; // uniform alpha value
+            alphaField      d;
+            normalise       yes;
+        }
+    }
+}
+
+fields          (d);
+
+
+// ************************************************************************* //
diff --git a/tutorials/lagrangian/reactingParcelFoam/filter/system/controlDict b/tutorials/lagrangian/reactingParcelFoam/filter/system/controlDict
index c196a53845..aace3d5302 100644
--- a/tutorials/lagrangian/reactingParcelFoam/filter/system/controlDict
+++ b/tutorials/lagrangian/reactingParcelFoam/filter/system/controlDict
@@ -1,7 +1,7 @@
 /*--------------------------------*- C++ -*----------------------------------*\
 | =========                 |                                                 |
 | \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox           |
-|  \\    /   O peration     | Version:  v2106                                 |
+|  \\    /   O peration     | Version:  v2112                                 |
 |   \\  /    A nd           | Website:  www.openfoam.com                      |
 |    \\/     M anipulation  |                                                 |
 \*---------------------------------------------------------------------------*/
@@ -52,6 +52,7 @@ maxDeltaT       1;
 
 functions
 {
+    #include "sample"
     #include "dataCloud"
     #include "vtkCloud"
     #include "vtkWrite"
diff --git a/tutorials/lagrangian/reactingParcelFoam/filter/system/sample b/tutorials/lagrangian/reactingParcelFoam/filter/system/sample
new file mode 100644
index 0000000000..52fecdea3d
--- /dev/null
+++ b/tutorials/lagrangian/reactingParcelFoam/filter/system/sample
@@ -0,0 +1,52 @@
+// -*- C++ -*-
+
+sample1
+{
+    type        sets;
+    libs        (sampling);
+    setFormat   gltf;
+
+    interpolationScheme cellPointFace;
+
+    formatOptions
+    {
+        // Optionally add colours to fields
+        // - default: colour map limits set to field limits
+        colour          yes;
+
+        fieldInfo
+        {
+            T
+            {
+                colourMap       fire;
+
+                alpha           field; // uniform | field;
+                //alphaValue      0.1; // uniform alpha value
+                alphaField      T;
+                normalise       yes;
+            }
+        }
+    }
+
+    fields          ( p T k epsilon U );
+    writeControl    writeTime;
+
+    sets
+    (
+        line
+        {
+            type            face;
+            axis            xyz;
+            start           (0 0.5 0);
+            end             (4 0.5 0.05);
+            nPoints         10;
+        }
+        cells
+        {
+            type            cellCentre;
+        }
+    );
+}
+
+
+// ************************************************************************* //