Paraview plugins

Paraview plugins were developed using Python 3.9.13 and are compatible with Paraview v5.12.0.

The plugins include:

A reader that parse GEOS output log file;
3D mesh cleanning plugins;
Processing plugins to compute additional geomechanical properties;
Visualization plugins to plot Mohr’s circles and cross plots using Paraview Python View.

PVplugins.PVAttributeMapping module

Map the attributes from a source mesh to a client mesh.

Input and output are vtkUnstructuredGrid.

To use it:

Load the module in Paraview: Tools>Manage Plugins…>Load new>PVAttributeMapping.
Select the server mesh.
Search and Select Attribute Mapping Filter.
Select the client mesh.
Select the attributes to transfer and Apply.

PVplugins.PVCreateConstantAttributePerRegion module

PVCreateConstantAttributePerRegion is a Paraview plugin that allows to create 2 attributes whom values are constant for each region index.

Input and output are either vtkMultiBlockDataSet or vtkUnstructuredGrid.

To use it:

Load the module in Paraview: Tools>Manage Plugins…>Load new>PVCreateConstantAttributePerRegion.
Select the mesh you want to create the attributes and containing a region attribute.
Search and Apply Create Constant Attribute Per Region Filter.

PVplugins.PVExtractMergeBlocksVolume module

PVExtractMergeBlocksVolume is a Paraview plugin that allows to merge ranks of a Geos output objects containing only a volumic mesh.

Input and output types are vtkMultiBlockDataSet.

This filter results in a single output pipeline that contains the volume mesh. If multiple regions were defined in the volume mesh, they are preserved as distinct blocks.

To use it:

Load the module in Paraview: Tools>Manage Plugins…>Load new>PVExtractMergeBlocksVolume.
Select the Geos output .pvd file loaded in Paraview.
Search and Apply PVExtractMergeBlocksVolume Filter.

PVplugins.PVExtractMergeBlocksVolumeSurface module

PVExtractMergeBlocksVolumeSurface is a Paraview plugin that allows to merge ranks of a Geos output objects containing a volumic mesh and surfaces.

Input and output types are vtkMultiBlockDataSet.

This filter results in 2 output pipelines:

first pipeline contains the volume mesh. If multiple regions were defined in
the volume mesh, they are preserved as distinct blocks.
second pipeline contains surfaces. If multiple surfaces were used, they are
preserved as distinct blocks.

To use it:

Load the module in Paraview: Tools>Manage Plugins…>Load new>PVExtractMergeBlocksVolumeSurface.
Select the Geos output .pvd file loaded in Paraview.
Search and Apply PVExtractMergeBlocksVolumeSurface Filter.

PVplugins.PVExtractMergeBlocksVolumeSurfaceWell module

PVExtractMergeBlocksVolumeSurfaceWell is a Paraview plugin that allows to merge ranks of a Geos output objects containing a volumic mesh, surfaces, and wells.

Input and output types are vtkMultiBlockDataSet.

This filter results in 3 output pipelines:

first pipeline contains the volume mesh. If multiple regions were defined in
the volume mesh, they are preserved as distinct blocks.
second pipeline contains surfaces. If multiple surfaces were used, they are
preserved as distinct blocks.
third pipeline contains wells. If multiple wells were used, they are preserved
as distinct blocks.

To use it:

Load the module in Paraview: Tools>Manage Plugins…>Load new>PVExtractMergeBlocksVolumeSurfaceWell.
Select the Geos output .pvd file loaded in Paraview.
Search and Apply PVExtractMergeBlocksVolumeSurfaceWell Filter.

PVplugins.PVExtractMergeBlocksVolumeWell module

PVExtractMergeBlocksVolumeWell is a Paraview plugin that allows to merge ranks of a Geos output objects containing a volumic mesh and wells.

Input and output types are vtkMultiBlockDataSet.

This filter results in 2 output pipelines:

first pipeline contains the volume mesh. If multiple regions were defined in
the volume mesh, they are preserved as distinct blocks.
second pipeline contains wells. If multiple wells were used, they are preserved
as distinct blocks.

To use it:

Load the module in Paraview: Tools>Manage Plugins…>Load new>PVExtractMergeBlocksVolumeWell.
Select the Geos output .pvd file loaded in Paraview.
Search and Apply PVExtractMergeBlocksVolumeWell Filter.

PVplugins.PVGeomechanicsAnalysis module

PVGeomechanicsAnalysis is a Paraview plugin that allows to compute additional geomechanical attributes from the input mesh.

Input and output types are vtkMultiBlockDataSet.

To use it:

Load the module in Paraview: Tools>Manage Plugins…>Load new>PVGeomechanicsAnalysis.
Select any pipeline child of the first ouput from PVExtractMergeBlocksVolume* filter.
Search and Apply PVGeomechanicsAnalysis Filter.

PVplugins.PVGeomechanicsWorkflowVolume module

PVGeomechanicsWorkflowVolume is a Paraview plugin that execute multiple filters to clean GEOS outputs and compute additional geomechanical outputs on volume.

Input and output types are vtkMultiBlockDataSet.

This filter results in the volume mesh. If multiple regions were defined in the volume mesh, they are preserved as distinct blocks.

To use it:

Load the module in Paraview: Tools>Manage Plugins…>Load new>PVGeomechanicsWorkflowVolume.
Select the Geos output .pvd file loaded in Paraview.
Search and Apply PVGeomechanicsWorkflowVolume Filter.

PVplugins.PVGeomechanicsWorkflowVolumeSurface module

PVGeomechanicsWorkflowVolumeSurface is a Paraview plugin that execute multiple filters to clean GEOS outputs and compute additional geomechanical outputs on volume and surface.

Input and output types are vtkMultiBlockDataSet.

This filter results in 2 output pipelines:

first pipeline contains the volume mesh. If multiple regions were defined in
the volume mesh, they are preserved as distinct blocks.
second pipeline contains surfaces. If multiple surfaces were used, they are
preserved as distinct blocks.

To use it:

Load the module in Paraview: Tools>Manage Plugins…>Load new>PVGeomechanicsWorkflowVolumeSurface.
Select the Geos output .pvd file loaded in Paraview.
Search and Apply PVGeomechanicsWorkflowVolumeSurface Filter.

PVplugins.PVGeomechanicsWorkflowVolumeSurfaceWell module

PVGeomechanicsWorkflowVolumeSurfaceWell is a Paraview plugin that execute multiple filters to clean GEOS outputs and compute additional geomechanical outputs on volume, surface and wells.

Input and output types are vtkMultiBlockDataSet.

This filter results in 3 output pipelines:

first pipeline contains the volume mesh. If multiple regions were defined in
the volume mesh, they are preserved as distinct blocks.
second pipeline contains surfaces. If multiple surfaces were used, they are
preserved as distinct blocks.
third pipeline contains wells. If multiple wells were used, they are preserved
as distinct blocks.

To use it:

Load the module in Paraview: Tools>Manage Plugins…>Load new>PVGeomechanicsWorkflowVolumeSurfaceWell.
Select the Geos output .pvd file loaded in Paraview.
Search and Apply PVGeomechanicsWorkflowVolumeSurfaceWell Filter.

PVplugins.PVGeomechanicsWorkflowVolumeWell module

PVGeomechanicsWorkflowVolumeWell is a Paraview plugin that execute multiple filters to clean GEOS outputs and compute additional geomechanical outputs on volume and wells.

Input and output types are vtkMultiBlockDataSet.

This filter results in 2 output pipelines:

first pipeline contains the volume mesh. If multiple regions were defined in
the volume mesh, they are preserved as distinct blocks.
second pipeline contains wells. If multiple wells were used, they are preserved
as distinct blocks.

To use it:

Load the module in Paraview: Tools>Manage Plugins…>Load new>PVGeomechanicsWorkflowVolumeWell.
Select the Geos output .pvd file loaded in Paraview.
Search and Apply PVGeomechanicsWorkflowVolumeWell Filter.

PVplugins.PVGeosLogReader module

GeosLogRePVGeosLogReaderader is a Paraview plugin that allows to read Geos output log.

Input is a file and output is a vtkTable containing log information.

..WARNING:

The reader is compliant with GEOS log before commit version #9365098.
For more recent version, use the csv or hdf5 export options from GEOS.

To use it:

Load the module in Paraview: Tools>Manage Plugins…>Load new>PVGeosLogReader.
Open (File>Open…) and Select Geos output log .out/.txt file.
In the “Open data with…” window, Select PVGeosLogReader reader.

class PVplugins.PVGeosLogReader.PVGeosLogReader(*args, **kwargs)

Paraview reader for Geos log files .”txt” or “.out”.

Output is a vtkTable with data extracted from the log.

RequestData()

RequestInformation()

a04PropertyGroup()

a05SetPropertiesFlow()

a06GroupFlow()

a07SetPropertiesWells()

a08SetTheNumberOfWellsMean()

a09GroupWells()

a10SetPropertiesAquifers()

a11GroupAquifers()

a12SetConvergence()

a13GroupSolvers()

b09GroupUnitsToUse()

createDataframe()

getDataframeChoice()

getFilepath()

getIdsToUse()

getNumberOfWellsMean()

getPhasesUserChoice()

getUnitChoices()

getUseSIUnits()

PVplugins.PVMergeBlocksEnhanced module

Merge filter that keep partial attributes using nan values.

Input is a vtkMultiBlockDataSet and output is a vtkUnstructuredGrid.

To use it:

Load the module in Paraview: Tools>Manage Plugins…>Load new>PVMergeBlocksEnhanced.
Select the mesh you want to create the attributes and containing a region attribute.
Search and Apply Merge Blocks Keeping Partial Attributes Filter.

PVplugins.PVMohrCirclePlot module

PVMohrCirclePlot is a Paraview plugin that allows to compute and plot Mohr’s circles of selected cells and times from effective stress attribute.

Input is a vtkMultiBlockDataSet or vtkUnstructuredGrid.

This filter results in opening a new Python View window and displaying Mohr’s circle plot.

To use it:

Load the module in Paraview: Tools>Manage Plugins…>Load new>PVMohrCirclePlot.
Select the mesh containing the cells you want to plot Mohr’s circles.
Search and Apply Mohr’s Circle Plot Filter.

Warning

Input vtk must contains a limited number of cells, Paraview may crash otherwise. In addition, input pipeline should consist of the minimum number of filters since this filter repeats the operations at every time steps.

PVplugins.PVPythonViewConfigurator module

PVPythonViewConfigurator is a Paraview plugin that allows to create cross-plots from input data using the PythonView.

Input type is vtkDataObject.

This filter results in opening a new Python View window and displaying cross-plot.

To use it:

Load the module in Paraview: Tools>Manage Plugins…>Load new>PVPythonViewConfigurator.
Select the vtkDataObject containing the data to plot.
Search and Apply PVPythonViewConfigurator Filter.

PVplugins.PVSurfaceGeomechanics module

PVSurfaceGeomechanics is a Paraview plugin that allows to compute additional geomechanical attributes from the input surfaces.

Input and output types are vtkMultiBlockDataSet.

To use it:

Load the module in Paraview: Tools>Manage Plugins…>Load new>PVSurfaceGeomechanics.
Select any pipeline child of the second ouput from
GeosExtractMergeBlocksVolumeSurface* filter.
Search and Apply PVSurfaceGeomechanics Filter.

PVplugins.PVTransferAttributesVolumeSurface module

PVTransferAttributesVolumeSurface is a Paraview plugin that allows to map face ids from surface mesh with cell ids from volume mesh.

Input and output types are vtkMultiBlockDataSet.

To use it:

Load the module in Paraview: Tools>Manage Plugins…>Load new>PVTransferAttributesVolumeSurface.
Select first a volume mesh, then a surface mesh, both of type vtkMultiBlockDataSet
Search and Apply ‘Geos Volume Surface Mesh Mapper’ Filter.