Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 15 additions & 14 deletions docs/geos_processing_docs/generic_processing_tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,36 +12,37 @@ AttributeMapping
:undoc-members:
:show-inheritance:

geos.processing.generic_processing_tools.AttributesDiff filter
----------------------------------------------------------------
AttributesDiff
--------------------------------

.. automodule:: geos.processing.generic_processing_tools.AttributesDiff
:members:
:undoc-members:
:show-inheritance:

CreateConstantAttributePerRegion
--------------------------------------

.. automodule:: geos.processing.generic_processing_tools.CreateConstantAttributePerRegion
ClipToMainFrame
------------------------------

.. automodule:: geos.processing.generic_processing_tools.ClipToMainFrame
:members:
:undoc-members:
:show-inheritance:


FillPartialArrays
------------------------
CreateConstantAttributePerRegion
--------------------------------------

.. automodule:: geos.processing.generic_processing_tools.FillPartialArrays
.. automodule:: geos.processing.generic_processing_tools.CreateConstantAttributePerRegion
:members:
:undoc-members:
:show-inheritance:


SplitMesh
-------------------------
FillPartialArrays
------------------------

.. automodule:: geos.processing.generic_processing_tools.SplitMesh
.. automodule:: geos.processing.generic_processing_tools.FillPartialArrays
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -56,10 +57,10 @@ MergeBlockEnhanced
:show-inheritance:


ClipToMainFrame
------------------------------
SplitMesh
-------------------------

.. automodule:: geos.processing.generic_processing_tools.ClipToMainFrame
.. automodule:: geos.processing.generic_processing_tools.SplitMesh
:members:
:undoc-members:
:show-inheritance:
20 changes: 11 additions & 9 deletions docs/geos_processing_docs/post_processing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,13 @@ GEOS computes many outputs including flow and geomechanic properties if coupled
Several processing filters require the definition of physical parameters. The following list is non-exhaustive. See :ref:`output-constant`.

Default values:

- grainBulkModulus = 38e9 Pa ( quartz value )
- specificDensity = 1000.0 kg/m³ ( water value )
- rock cohesion: 0.0 Pa $( fractured case )
- rock cohesion: 0.0 Pa ( fractured case )
- friction angle: 10°


SurfaceGeomechanics
-----------------------------

.. automodule:: geos.processing.post_processing.SurfaceGeomechanics
:members:
:undoc-members:
:show-inheritance:


GeomechanicsCalculator
--------------------------------
Expand All @@ -53,3 +46,12 @@ GeosBlockMerge
:members:
:undoc-members:
:show-inheritance:


SurfaceGeomechanics
-----------------------------

.. automodule:: geos.processing.post_processing.SurfaceGeomechanics
:members:
:undoc-members:
:show-inheritance:
8 changes: 8 additions & 0 deletions docs/geos_processing_docs/pre_processing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,11 @@ MeshQualityEnhanced filter
:members:
:undoc-members:
:show-inheritance:

TetQualityAnalysis filter
---------------------------------------------------------

.. automodule:: geos.processing.pre_processing.TetQualityAnalysis
:members:
:undoc-members:
:show-inheritance:
17 changes: 8 additions & 9 deletions docs/geos_pv_docs/pv_generic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,26 +13,25 @@ Create Constant Attribute Per Region

.. automodule:: geos.pv.plugins.generic_processing.PVCreateConstantAttributePerRegion

Clip to the main frame
-----------------------------

.. automodule:: geos.pv.plugins.generic_processing.PVClipToMainFrame


Fill Partial Arrays
-----------------------

.. automodule:: geos.pv.plugins.generic_processing.PVFillPartialArrays


Split Mesh
-----------------

.. automodule:: geos.pv.plugins.generic_processing.PVSplitMesh


Merge Blocks Keeping Partial Attributes
---------------------------------------------

.. automodule:: geos.pv.plugins.generic_processing.PVMergeBlocksEnhanced


Clip to the main frame
-----------------------------
Split Mesh
-----------------

.. automodule:: geos.pv.plugins.generic_processing.PVClipToMainFrame
.. automodule:: geos.pv.plugins.generic_processing.PVSplitMesh
6 changes: 6 additions & 0 deletions docs/geos_pv_docs/pv_qc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ Mesh Quality Enhanced
.. automodule:: geos.pv.plugins.qc.PVMeshQualityEnhanced


Tetrahedra QC
---------------------------

.. automodule:: geos.pv.plugins.qc.PVTetQualityAnalysis


Python View Configurator
------------------------------

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
To use the filter:

.. code-block:: python

from geos.processing.pre_processing.TetQualityAnalysis import TetQualityAnalysis

# Filter inputs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
* Convert volume meshes to surface if needed
* Copy "geomechanics" attributes from the initial timestep to the current one if they exist

PVGeomechanicsCalculator is a paraview plugin that allows to compute basic and advanced geomechanics properties from existing ones in the mesh. This is donne on each block of the volume mesh.
PVGeomechanicsCalculator is a paraview plugin that allows to compute basic and advanced geomechanics properties from existing ones in the mesh. This is done on each block of the volume mesh.

The basic geomechanics properties computed on the mesh are:
- The elastic moduli not present on the mesh
Expand All @@ -64,7 +64,7 @@
- Fracture index and threshold
- Critical pore pressure and pressure index

PVSurfaceGeomechanics is a Paraview plugin that allows to compute additional geomechanical attributes from the input surfaces, such as shear capacity utilization (SCU). This is donne on each block of the fault mesh.
PVSurfaceGeomechanics is a Paraview plugin that allows to compute additional geomechanical attributes from the input surfaces, such as shear capacity utilization (SCU). This is done on each block of the fault mesh.

This filter results in 3 output pipelines with the vtkMultiBlockDataSet:
- "Volume" contains the volume domain
Expand Down
2 changes: 1 addition & 1 deletion geos-pv/src/geos/pv/plugins/qc/PVTetQualityAnalysis.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
from geos.utils.Logger import isHandlerInLogger

__doc__ = f"""
Tetrahedra QC is a ParaView plugin filter that analyze and compare the tetrahedras of two given vtkUnstructured grid datasets.
Tetrahedra QC is a ParaView plugin filter that analyzes and compares the tetrahedras of two given vtkUnstructured grid datasets.

A figure with relevant quality metrics is saved at the end of the process for a visual comparison.

Expand Down