feat: Adding a diff filter

docs/geos_processing_docs/generic_processing_tools.rst

@@ -12,6 +12,13 @@ AttributeMapping
    :undoc-members:
    :show-inheritance:
 
+geos.processing.generic_processing_tools.AttributesDiff filter
+----------------------------------------------------------------
+
+.. automodule:: geos.processing.generic_processing_tools.AttributesDiff
+   :members:
+   :undoc-members:
+   :show-inheritance:
 
 CreateConstantAttributePerRegion
 --------------------------------------

geos-processing/tests/conftest.py

@@ -44,6 +44,10 @@ def _get_dataset( datasetType: str ) -> Union[ vtkMultiBlockDataSet, vtkPolyData
             vtkFilename = "data/domain_res5_id.vtu"
         elif datasetType == "emptydataset":
             vtkFilename = "data/domain_res5_id_empty.vtu"
+        elif datasetType == "2Ranks":
+            vtkFilename = "data/singlePhasePoromechanics_FaultModel_well_seq/CellElementRegion2Ranks.vtm"
+        elif datasetType == "4Ranks":
+            vtkFilename = "data/singlePhasePoromechanics_FaultModel_well_seq/CellElementRegion4Ranks.vtm"
         elif datasetType == "singlePhasePoromechanicsVTKOutput":
             vtkFilename = "data/singlePhasePoromechanics_FaultModel_well_seq/singlePhasePoromechanicsVTKOutput.vtm"
         elif datasetType == "extractAndMergeVolume":

geos-processing/tests/data/singlePhasePoromechanics_FaultModel_well_seq/CellElementRegion2Ranks.vtm

@@ -0,0 +1,14 @@
+<VTKFile type="vtkMultiBlockDataSet" version="1.0" byte_order="LittleEndian" header_type="UInt64" compressor="vtkZLibDataCompressor">
+  <vtkMultiBlockDataSet>
+    <Block index="0" name="mesh1">
+      <Block index="0" name="Level0">
+        <Block index="0" name="CellElementRegion">
+          <Block index="0" name="Region">
+            <DataSet index="0" name="rank_0" file="CellElementRegion2Ranks/CellElementRegion2Ranks_0_0.vtu"/>
+            <DataSet index="1" name="rank_1" file="CellElementRegion2Ranks/CellElementRegion2Ranks_1_0.vtu"/>
+          </Block>
+        </Block>
+      </Block>
+    </Block>
+  </vtkMultiBlockDataSet>
+</VTKFile>

geos-processing/tests/data/singlePhasePoromechanics_FaultModel_well_seq/CellElementRegion4Ranks.vtm

@@ -0,0 +1,16 @@
+<VTKFile type="vtkMultiBlockDataSet" version="1.0" byte_order="LittleEndian" header_type="UInt64" compressor="vtkZLibDataCompressor">
+  <vtkMultiBlockDataSet>
+    <Block index="0" name="mesh1">
+      <Block index="0" name="Level0">
+        <Block index="0" name="CellElementRegion">
+          <Block index="0" name="Region">
+            <DataSet index="0" name="rank_0" file="CellElementRegion4Ranks/CellElementRegion4Ranks_0_0.vtu"/>
+            <DataSet index="1" name="rank_1" file="CellElementRegion4Ranks/CellElementRegion4Ranks_1_0.vtu"/>
+            <DataSet index="2" name="rank_2" file="CellElementRegion4Ranks/CellElementRegion4Ranks_2_0.vtu"/>
+            <DataSet index="3" name="rank_3" file="CellElementRegion4Ranks/CellElementRegion4Ranks_3_0.vtu"/>
+          </Block>
+        </Block>
+      </Block>
+    </Block>
+  </vtkMultiBlockDataSet>
+</VTKFile>

geos-processing/tests/data/singlePhasePoromechanics_FaultModel_well_seq/README.md

@@ -3,4 +3,6 @@ The XML-files used to launch the simulation came from the integrated tests of GE
 
 The ParaView plugin "PVGeosBlockExtractAndMerge" has been used to get the vtm with the block "CellElementRegion" from the simulation pvd result. The integrated ParaView plugin "merge block" has been used to get a vtu with the data of the second time step.
 
-The mesh singlePhasePoromechanicsVTKOutput.vtm has been save as vtm from the the simulation pvd result with ParaView 6.
+The mesh singlePhasePoromechanicsVTKOutput.vtm has been saved as vtm from the the simulation pvd result with ParaView 6.
+
+The meshes CellElementRegion2Ranks.vtm and CellElementRegion4Ranks.vtm have been extracted with the integrated ParaView plugin 'extract block' from two identical GEOS simulations except for the partitioning, respectively on 2 and 4 ranks. The extraction and save of the meshes have been made for the last time step.

geos-processing/tests/test_AttributesDiff.py

@@ -0,0 +1,47 @@
+# 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 numpy as np
+
+from vtkmodules.vtkCommonDataModel import vtkMultiBlockDataSet, vtkDataSet
+
+from geos.processing.generic_processing_tools.AttributesDiff import AttributesDiff
+from geos.mesh.utils.arrayHelpers import getArrayInObject
+from geos.mesh.utils.multiblockHelpers import getBlockElementIndexesFlatten
+from geos.utils.pieceEnum import Piece
+
+
+def test_AttributesDiff( dataSetTest: vtkMultiBlockDataSet, ) -> None:
+    """Test the filter AttributesDiff."""
+    mesh1: vtkMultiBlockDataSet = dataSetTest( "2Ranks" )
+    mesh2: vtkMultiBlockDataSet = dataSetTest( "4Ranks" )
+
+    attributesDiffFilter: AttributesDiff = AttributesDiff()
+    attributesDiffFilter.setMeshes( [ mesh1, mesh2 ] )
+    attributesDiffFilter.logSharedAttributeInfo()
+    dictAttributesToCompare: dict[ Piece, set[ str ] ] = {
+        Piece.POINTS: { 'totalDisplacement', 'localToGlobalMap', 'mass', 'externalForce' },
+        Piece.CELLS: {
+            'elementVolume', 'pressure', 'rock_bulkModulus', 'rockPorosity_referencePorosity', 'water_dInternalEnergy',
+            'water_dViscosity', 'water_viscosity', 'averageStrain', 'water_dEnthalpy', 'deltaPressure',
+            'rockPerm_permeability', 'rockPorosity_initialPorosity', 'localToGlobalMap', 'averagePlasticStrain',
+            'temperature', 'rock_density', 'averageStress', 'rockPorosity_porosity', 'rock_shearModulus',
+            'water_density', 'mass', 'water_internalEnergy', 'water_dDensity', 'rockPorosity_grainBulkModulus',
+            'elementCenter', 'water_enthalpy', 'rockPorosity_biotCoefficient'
+        },
+    }
+    attributesDiffFilter.setDictAttributesToCompare( dictAttributesToCompare )
+    attributesDiffFilter.applyFilter()
+    mesh: vtkDataSet | vtkMultiBlockDataSet = mesh1.NewInstance()
+    mesh.ShallowCopy( attributesDiffFilter.getOutput() )
+    dictAttributesDiffNames: dict[ Piece, set[ str ] ] = attributesDiffFilter.getDictAttributesDiffNames()
+    listFlattenIndexes = getBlockElementIndexesFlatten( mesh )
+    for it in listFlattenIndexes:
+        dataset: vtkDataSet = vtkDataSet.SafeDownCast( mesh.GetDataSet( it ) )  # type: ignore[union-attr]
+        for piece, listDiffAttributesName in dictAttributesDiffNames.items():
+            for diffAttributeName in listDiffAttributesName:
+                test = getArrayInObject( dataset, diffAttributeName, piece )
+                assert ( test < np.array( [ 0.0001 for _ in range( test.size ) ] ) ).all()