VTK-m MIR

CHANGELOG.md

@@ -38,13 +38,16 @@ and this project aspires to adhere to [Semantic Versioning](https://semver.org/s
 - Added a `vtk` extract that saves each mesh domain to a legacy vtk file grouped, with all domain data grouped by a `.visit` file.
 - Added particle advection for streamline and related rendering support.
 - Added WarpX Streamline filter that uses charged particles.
+- Added Uniform Grid Sampling filter.
+- Added Material Interface Reconstruction (`mir`) filter which produces matset output field.
 - Added seed population options for particle advection: point, point list, line, and box
 - Added more Ascent tutorial examples
 - Added support for implicit points style Blueprint input meshes
 - Added actions for shell commands and simulation code function callbacks
 - Added a `cylinder` option to the clip filter.
 - Added `box`, `plane`, `cylinder`, and `sphere` options to the Threshold filter, enabling sub selecting a mesh spatially.
 
+
 ### Changed
 - Changed the Data Binning filter to accept a `reduction_field` parameter (instead of `var`), and similarly the axis parameters to take `field` (instead of `var`).  The `var` style parameters are still accepted, but deprecated and will be removed in a future release.
 - Changed the Streamline and WarpXStreamline filters to apply the VTK-m Tube filter to their outputs, allowing for the results to be rendered.

src/docs/sphinx/Actions/Examples.rst

@@ -1018,3 +1018,14 @@ YAML actions:
 
 .. literalinclude:: examples/tout_render_amr_complex_ghost100.yaml
 
+
+An example of using the Material Interface Reconstruction filter.
+--------------------------------------------------------------------------------------------------
+
+YAML actions:
+
+.. literalinclude:: examples/tout_mir_venn0.yaml
+
+Resulting image:
+
+.. image:: examples/tout_mir_venn0.png

src/docs/sphinx/Actions/Pipelines.rst

@@ -964,6 +964,25 @@ accurate but slower point based gradients (default).
   params["output_name"] = "my_q";        // (required) name of the output field
   params["use_cell_gradient"] = "false"; // (optional)
 
+Material Interface Reconstruction
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The Material Interface Reconstruction (MIR) filter can be used to represent and track the interfaces between different materials or phases in a multiphase flow. 
+The user must specify the name of the material set (`matset`) they wish to use.  
+Optional parameters include error scaling (`error_scaling`), scaling decay (`scaling_decay`), maximum iterations (`iterations`), and maximum error percentage (`max_error`).
+The output field of the MIR Filter will be the name of the material set and can be used further in scenes or pipelines. 
+
+.. code-block:: c++
+
+  conduit::Node pipelines;
+  // pipeline 1
+  pipelines["pl1/f1/type"] = "mir";
+  //params optional
+  conduit::Node &params = pipelines["pl1/f1/params"];
+  params["matset"] = "matset";   //required
+  params["error_scaling"] = 0.2; //default: 0.0
+  params["scaling_decay"] = 1.0; //default: 0.0
+  params["iterations"] = 8;      //default: 0
+  params["max_error"] = 0.00001; //default: 0.00001
 
 
 Partitioning

src/docs/sphinx/Actions/Scenes.rst

@@ -242,6 +242,11 @@ Color in the table can be reversed through an optional parameter:
 
   scenes["s1/plots/p1/color_table/reverse"] = "true";
 
+The color table can be made (pseudo) discrete through an optional parameter:
+
+.. code-block:: c++
+
+  scenes["s1/plots/p1/color_table/discrete"] = "true";
 
 
 Volume plots are special since ray casting blends colors together.

src/docs/sphinx/Actions/examples/tout_mir_venn100.yaml

@@ -0,0 +1,24 @@
+#An example of using the MIR filter and plotting the field 'cellMat'.
+
+- 
+  action: "add_pipelines"
+  pipelines: 
+    pl1: 
+      f1: 
+        type: "mir"
+        params: 
+          matset: "matset"
+          error_scaling: 0.0
+          scaling_decay: 0.0
+          iterations: 0
+          max_error: 1e-05
+- 
+  action: "add_scenes"
+  scenes: 
+    s1: 
+      plots: 
+        p1: 
+          type: "pseudocolor"
+          field: "cellMat"
+          pipeline: "pl1"
+      image_prefix: "/home/user/ascent/build/tests/_output/tout_mir_venn"