Pre-processing filters

The pre_processing module of geos-processing package contains filters to pre-process meshes for GEOS simulation.

geos.processing.pre_processing.CellTypeCounterEnhanced filter

CellTypeCounterEnhanced module is a vtk filter that computes cell type counts.

Filter input is a vtkUnstructuredGrid, output is a vtkTable

To use the filter:

from geos.processing.pre_processing.CellTypeCounterEnhanced import CellTypeCounterEnhanced

# Filter inputs
input: vtkUnstructuredGrid

# Instantiate the filter
cellTypeCounterEnhancedFilter: CellTypeCounterEnhanced = CellTypeCounterEnhanced()

# Set input data object
cellTypeCounterEnhancedFilter.SetInputDataObject(input)

# Do calculations
cellTypeCounterEnhancedFilter.Update()

# Get counts
counts: CellTypeCounts = cellTypeCounterEnhancedFilter.GetCellTypeCountsObject()
class geos.processing.pre_processing.CellTypeCounterEnhanced.CellTypeCounterEnhanced[source]

Bases: VTKPythonAlgorithmBase

CellTypeCounterEnhanced filter computes mesh stats.

FillInputPortInformation(port, info)[source]

Inherited from VTKPythonAlgorithmBase::RequestInformation.

Parameters:

  • port (int) – Input port

  • info (vtkInformationVector) – Info

Returns:

1 if calculation successfully ended, 0 otherwise.

Return type:

int

GetCellTypeCountsObject()[source]

Get CellTypeCounts object.

Returns:

CellTypeCounts object.

Return type:

CellTypeCounts

RequestData(request, inInfoVec, outInfoVec)[source]

Inherited from VTKPythonAlgorithmBase::RequestData.

Parameters:

  • request (vtkInformation) – Request

  • inInfoVec (list[vtkInformationVector]) – Input objects

  • outInfoVec (vtkInformationVector) – Output objects

Returns:

1 if calculation successfully ended, 0 otherwise.

Return type:

int

geos.processing.pre_processing.MeshQualityEnhanced filter

MeshQualityEnhanced module is a vtk filter that computes mesh quality stats.

Mesh quality stats include those from vtkMeshQuality as well as .

Filter input is a vtkUnstructuredGrid.

To use the filter:

from geos.processing.pre_processing.MeshQualityEnhanced import MeshQualityEnhanced

# Filter inputs
input: vtkUnstructuredGrid

# Instantiate the filter
meshQualityEnhancedFilter: MeshQualityEnhanced = MeshQualityEnhanced()

# Set input data object
meshQualityEnhancedFilter.SetInputDataObject(input)

# Set metrics to use
meshQualityEnhancedFilter.SetTriangleMetrics(triangleQualityMetrics)
meshQualityEnhancedFilter.SetQuadMetrics(quadQualityMetrics)
meshQualityEnhancedFilter.SetTetraMetrics(tetraQualityMetrics)
meshQualityEnhancedFilter.SetPyramidMetrics(pyramidQualityMetrics)
meshQualityEnhancedFilter.SetWedgeMetrics(wedgeQualityMetrics)
meshQualityEnhancedFilter.SetHexaMetrics(hexaQualityMetrics)
meshQualityEnhancedFilter.SetOtherMeshQualityMetrics(otherQualityMetrics)

# Do calculations
meshQualityEnhancedFilter.Update()

# Get output mesh quality report
outputMesh: vtkUnstructuredGrid = meshQualityEnhancedFilter.GetOutputDataObject(0)
outputStats: QualityMetricSummary = meshQualityEnhancedFilter.GetQualityMetricSummary()
class geos.processing.pre_processing.MeshQualityEnhanced.MeshQualityEnhanced[source]

Bases: VTKPythonAlgorithmBase

Enhanced vtkMeshQuality filter.

FillInputPortInformation(port, info)[source]

Inherited from VTKPythonAlgorithmBase::RequestInformation.

Parameters:

  • port (int) – Input port

  • info (vtkInformationVector) – Info

Returns:

1 if calculation successfully ended, 0 otherwise.

Return type:

int

GetQualityMetricSummary()[source]

Get QualityMetricSummary object.

Returns:

QualityMetricSummary object

Return type:

QualityMetricSummary

RequestData(request, inInfoVec, outInfoVec)[source]

Inherited from VTKPythonAlgorithmBase::RequestData.

Parameters:

  • request (vtkInformation) – Request

  • inInfoVec (list[vtkInformationVector]) – Input objects

  • outInfoVec (vtkInformationVector) – Output objects

Returns:

1 if calculation successfully ended, 0 otherwise.

Return type:

int

RequestDataObject(request, inInfoVec, outInfoVec)[source]

Inherited from VTKPythonAlgorithmBase::RequestDataObject.

Parameters:

  • request (vtkInformation) – Request

  • inInfoVec (list[vtkInformationVector]) – Input objects

  • outInfoVec (vtkInformationVector) – Output objects

Returns:

1 if calculation successfully ended, 0 otherwise.

Return type:

int

SetCellQualityMetrics(triangleMetrics=None, quadMetrics=None, tetraMetrics=None, pyramidMetrics=None, wedgeMetrics=None, hexaMetrics=None)[source]

Set all quality metrics to compute.

Parameters:

  • triangleMetrics (Iterable[int]) –

    Triangle metrics to compute.

    Defaults to [vtkMeshQuality.QualityMeasureTypes.NONE,].

  • quadMetrics (Iterable[int]) –

    Quad metrics to compute.

    Defaults to [vtkMeshQuality.QualityMeasureTypes.NONE,].

  • tetraMetrics (Iterable[int]) –

    Tetrahedron metrics to compute.

    Defaults to [vtkMeshQuality.QualityMeasureTypes.NONE,].

  • pyramidMetrics (Iterable[int]) –

    Pyramid metrics to compute.

    Defaults to [vtkMeshQuality.QualityMeasureTypes.NONE,].

  • wedgeMetrics (Iterable[int]) –

    Wedge metrics to compute.

    Defaults to [vtkMeshQuality.QualityMeasureTypes.NONE,].

  • hexaMetrics (Iterable[int]) –

    Hexahedron metrics to compute.

    Defaults to [vtkMeshQuality.QualityMeasureTypes.NONE,].

SetHexaMetrics(metrics=None)[source]

Set triangle quality metrics to compute.

Parameters:

metrics (Iterable[int]) – Metrics to compute

SetOtherMeshQualityMetrics(metrics)[source]

Set additional metrics unrelated to cell types.

Parameters:

metrics (set[QualityMetricOtherEnum]) – Set of QualityMetricOtherEnum

SetPyramidMetrics(metrics=None)[source]

Set triangle quality metrics to compute.

Parameters:

metrics (Iterable[int]) – Metrics to compute

SetQuadMetrics(metrics=None)[source]

Set triangle quality metrics to compute.

Parameters:

metrics (Iterable[int]) – Metrics to compute

SetTetraMetrics(metrics=None)[source]

Set triangle quality metrics to compute.

Parameters:

metrics (Iterable[int]) – Metrics to compute

SetTriangleMetrics(metrics)[source]

Set triangle quality metrics to compute.

Parameters:

metrics (Iterable[int]) – Metrics to compute

SetWedgeMetrics(metrics=None)[source]

Set triangle quality metrics to compute.

Parameters:

metrics (Iterable[int]) – Metrics to compute

getComputedMetricsFromCellType(cellType)[source]

Get the set of metrics computed for input cell type.

Parameters:

cellType (int) – Cell type index

Returns:

Set of computed quality metrics

Return type:

Optional[set[int]]

geos.processing.pre_processing.MeshQualityEnhanced.QUALITY_ARRAY_NAME = 'Quality'

name of output quality array from vtkMeshQuality filter

geos.processing.pre_processing.MeshQualityEnhanced.getQualityMetricArrayName(metric)[source]

Get the name of the array from quality metric index.

Parameters:

metric (int) – Metric index

Returns:

Name of output array

Return type:

str