refactor: Move the paraview plugin and create a VTK filter for CreateConstantAttributePerRegion

docs/geos_mesh_docs/processing.rst

@@ -3,6 +3,13 @@ Processing filters
 
 The `processing` module of `geos-mesh` package contains filters to process meshes.
 
+geos.mesh.processing.CreateConstantAttributePerRegion filter
+-------------------------------------------------------------
+
+.. automodule:: geos.mesh.processing.CreateConstantAttributePerRegion
+    :members:
+    :undoc-members:
+    :show-inheritance:
 
 geos.mesh.processing.meshQualityMetricHelpers module
 -----------------------------------------------------

docs/geos_posp_docs/PVplugins.rst

@@ -16,12 +16,6 @@ PVAttributeMapping plugin
 .. automodule:: PVplugins.PVAttributeMapping
 
 
-PVCreateConstantAttributePerRegion plugin
----------------------------------------------------
-
-.. automodule:: PVplugins.PVCreateConstantAttributePerRegion
-
-
 PVExtractMergeBlocksVolume plugin
 -------------------------------------------
 

docs/geos_pv_docs/processing.rst

@@ -1,6 +1,13 @@
 Post-/Pre-processing
 =========================
 
+PVCreateConstantAttributePerRegion
+-----------------------------------
+
+.. automodule:: geos.pv.plugins.PVCreateConstantAttributePerRegion
+
+
+
 PVSplitMesh
 ----------------------------------
 

geos-mesh/src/geos/mesh/utils/arrayHelpers.py

@@ -368,6 +368,24 @@ def getArrayInObject( object: vtkDataSet, attributeName: str, onPoints: bool ) -
     return npArray
 
 
+def getVtkDataTypeInObject( object: Union[ vtkDataSet, vtkMultiBlockDataSet ], attributeName: str,
+                            onPoints: bool ) -> int:
+    """Return VTK type of requested array from input mesh.
+
+    Args:
+        object (Union[vtkDataSet, vtkMultiBlockDataSet]): Input object.
+        attributeName (str): Name of the attribute.
+        onPoints (bool): True if attributes are on points, False if they are on cells.
+
+    Returns:
+        int: The type of the vtk array corresponding to input attribute name.
+    """
+    if isinstance( object, vtkDataSet ):
+        return getVtkArrayTypeInObject( object, attributeName, onPoints )
+    else:
+        return getVtkArrayTypeInMultiBlock( object, attributeName, onPoints )
+
+
 def getVtkArrayTypeInObject( object: vtkDataSet, attributeName: str, onPoints: bool ) -> int:
     """Return VTK type of requested array from dataset input.
 

geos-mesh/tests/test_CreateConstantAttributePerRegion.py

@@ -0,0 +1,122 @@
+# SPDX-License-Identifier: Apache-2.0
+# SPDX-FileCopyrightText: Copyright 2023-2024 TotalEnergies.
+# SPDX-FileContributor: Romain Baville
+# SPDX-License-Identifier: Apache 2.0
+# ruff: noqa: E402 # disable Module level import not at top of file
+# mypy: disable-error-code="operator"
+import pytest
+from typing import Union, Any
+from vtkmodules.vtkCommonDataModel import ( vtkDataSet, vtkMultiBlockDataSet )
+
+from geos.mesh.processing.CreateConstantAttributePerRegion import CreateConstantAttributePerRegion, np
+
+
+@pytest.mark.parametrize(
+    "meshType, newAttributeName, regionName, dictRegionValues, componentNames, componentNamesTest, valueNpType, succeed",
+    [
+        # Test the name of the new attribute (new on the mesh, one present on the other piece).
+        ## For vtkDataSet.
+        ( "dataset", "newAttribute", "GLOBAL_IDS_POINTS", {}, (), (), np.float32, True ),
+        ( "dataset", "CellAttribute", "GLOBAL_IDS_POINTS", {}, (), (), np.float32, True ),
+        ## For vtkMultiBlockDataSet.
+        ( "multiblock", "newAttribute", "GLOBAL_IDS_POINTS", {}, (), (), np.float32, True ),
+        ( "multiblock", "CellAttribute", "GLOBAL_IDS_POINTS", {}, (), (), np.float32, True ),
+        ( "multiblock", "GLOBAL_IDS_CELLS", "GLOBAL_IDS_POINTS", {}, (), (), np.float32, True ),
+        # Test if the region attribute is on cells or on points.
+        ( "dataset", "newAttribute", "FAULT", {}, (), (), np.float32, True ),
+        # Test the component name.
+        ( "dataset", "newAttribute", "FAULT", {}, ( "X" ), (), np.float32, True ),
+        ( "dataset", "newAttribute", "FAULT", {}, (), ( "Component0", "Component1" ), np.float32, True ),
+        ( "dataset", "newAttribute", "FAULT", {}, ( "X" ), ( "Component0", "Component1" ), np.float32, True ),
+        ( "dataset", "newAttribute", "FAULT", {}, ( "X", "Y" ), ( "X", "Y" ), np.float32, True ),
+        ( "dataset", "newAttribute", "FAULT", {}, ( "X", "Y", "Z" ), ( "X", "Y" ), np.float32, True ),
+        # Test the type of value.
+        ( "dataset", "newAttribute", "FAULT", {}, (), (), np.int8, True ),
+        ( "dataset", "newAttribute", "FAULT", {}, (), (), np.int16, True ),
+        ( "dataset", "newAttribute", "FAULT", {}, (), (), np.int32, True ),
+        ( "dataset", "newAttribute", "FAULT", {}, (), (), np.int64, True ),
+        ( "dataset", "newAttribute", "FAULT", {}, (), (), np.uint8, True ),
+        ( "dataset", "newAttribute", "FAULT", {}, (), (), np.uint16, True ),
+        ( "dataset", "newAttribute", "FAULT", {}, (), (), np.uint32, True ),
+        ( "dataset", "newAttribute", "FAULT", {}, (), (), np.uint64, True ),
+        ( "dataset", "newAttribute", "FAULT", {}, (), (), np.float64, True ),
+        # Test index/value.
+        ( "dataset", "newAttribute", "FAULT", {
+            0: [ 0 ],
+            100: [ 1 ]
+        }, (), (), np.float32, True ),
+        ( "dataset", "newAttribute", "FAULT", {
+            0: [ 0 ],
+            100: [ 1 ],
+            101: [ 2 ]
+        }, (), (), np.float32, True ),
+        ( "dataset", "newAttribute", "FAULT", {
+            0: [ 0 ],
+            100: [ 1 ],
+            101: [ 2 ],
+            2: [ 3 ]
+        }, (), (), np.float32, True ),
+        ( "dataset", "newAttribute", "FAULT", {
+            0: [ 0, 0 ],
+            100: [ 1, 1 ]
+        }, (), ( "Component0", "Component1" ), np.float32, True ),
+        ( "dataset", "newAttribute", "FAULT", {
+            0: [ 0, 0 ],
+            100: [ 1, 1 ],
+            101: [ 2, 2 ]
+        }, (), ( "Component0", "Component1" ), np.float32, True ),
+        ( "dataset", "newAttribute", "FAULT", {
+            0: [ 0, 0 ],
+            100: [ 1, 1 ],
+            101: [ 2, 2 ],
+            2: [ 3, 3 ]
+        }, (), ( "Component0", "Component1" ), np.float32, True ),
+        # Test common error.
+        ## Number of components.
+        ( "dataset", "newAttribute", "FAULT", {
+            0: [ 0 ],
+            100: [ 1, 1 ]
+        }, (), (), np.float32, False ),  # Number of value inconsistent.
+        ( "dataset", "newAttribute", "FAULT", {
+            0: [ 0, 0 ],
+            100: [ 1, 1 ]
+        }, (), (), np.float32, False ),  # More values than components.
+        ( "dataset", "newAttribute", "FAULT", {
+            0: [ 0 ],
+            100: [ 1 ]
+        }, ( "X", "Y" ), ( "X", "Y" ), np.float32, False ),  # More components than value.
+        ## Attribute name.
+        ( "dataset", "PERM", "FAULT", {}, (), (), np.float32, False ),  # The attribute name already exist.
+        ## Region attribute.
+        ( "dataset", "newAttribute", "PERM", {}, (),
+          (), np.float32, False ),  # Region attribute has too many components.
+        ( "multiblock", "newAttribute", "FAULT", {}, (), (), np.float32, False ),  # Region attribute is partial.
+    ] )
+def test_CreateConstantAttributePerRegion(
+    dataSetTest: Union[ vtkMultiBlockDataSet, vtkDataSet ],
+    meshType: str,
+    newAttributeName: str,
+    regionName: str,
+    dictRegionValues: dict[ Any, Any ],
+    componentNames: tuple[ str, ...],
+    componentNamesTest: tuple[ str, ...],
+    valueNpType: int,
+    succeed: bool,
+) -> None:
+    """Test CreateConstantAttributePerRegion."""
+    mesh: Union[ vtkMultiBlockDataSet, vtkDataSet ] = dataSetTest( meshType )
+    nbComponents: int = len( componentNamesTest )
+    if nbComponents == 0:  # If one component their is no name.
+        nbComponents += 1
+
+    filter: CreateConstantAttributePerRegion = CreateConstantAttributePerRegion(
+        mesh,
+        regionName,
+        dictRegionValues,
+        newAttributeName,
+        valueNpType=valueNpType,
+        nbComponents=nbComponents,
+        componentNames=componentNames,
+    )
+
+    assert filter.applyFilter() == succeed