A.3. Report Utility Functions

The following functions are available for reporting mesh quality, statistics, face/cell distribution:

FeatureDescriptionUtility Function
Report Mesh TypesReturn zone type as integer(tgapi-util-get-zone-type zone-id)
(tgapi-util-get-zone-type zone-name)
Return cell zone shape as symbol(tgapi-util-get-cell-zone-shape zone-id)
Report Mesh StatisticsReturn count of entities for face zones(tgapi-util-get-face-zone-count '(zone-id-list))
(tgapi-util-get-face-zone-count '(zone-name-list))
(tgapi-util-get-face-zone-count "zone-name-pattern*")
Return count of entities for cell zones(tgapi-util-get-cell-zone-count '(zone-id-list))
(tgapi-util-get-cell-zone-count '(zone-name-list))
(tgapi-util-get-cell-zone-count "zone-name-pattern*")
Returns the node count for the specified face zone.(tgapi-util-get-face-zone-node-count 'zone-id)
(tgapi-util-get-face-zone-node-count 'zone-name)
(tgapi-util-get-face-zone-node-count "zone-name")
Return face zone area for the specified zones(tgapi-util-get-face-zone-area '(zone-id-list))
(tgapi-util-get-face-zone-area '(zone-name-list))
(tgapi-util-get-face-zone-area "zone-name-pattern*")
Return cell zone volume for the specified zones(tgapi-util-get-cell-zone-volume '(zone-id-list))
(tgapi-util-get-cell-zone-volume '(zone-name-list))
(tgapi-util-get-cell-zone-volume "zone-name-pattern*")
Report Mesh DistributionReport the face mesh distribution based on the specified measure, partitions, and range (such as (0.9 1)).

Specify the "measure" as one of the following:

  • "Orthogonal Quality"

  • "Skewness"

  • "Equiangle Skewness"

  • "Size Change"

  • "Edge Ratio"

  • "Size"

  • "Aspect Ratio"

  • "Squish"

  • "Warp"

  • "Dihedral Angle"

  • "ICEMCFD Quality"

  • "Ortho Skew"

  • "FLUENT Aspect Ratio"

  • "Inverse Orthogonal Quality"

(tgapi-util-get-face-mesh-distribution '(face-zone-list) "measure" partitions '(range))
(tgapi-util-get-face-mesh-distribution "face-zone-name-pattern*" "measure" partitions '(range))
Report the cell mesh distribution based on the specified measure, partitions, and range (such as (0.9 1)).

Specify the "measure" as one of the following:

  • "Orthogonal Quality"

  • "Skewness"

  • "Equiangle Skewness"

  • "Size Change"

  • "Edge Ratio"

  • "Size"

  • "Aspect Ratio"

  • "Squish"

  • "Warp"

  • "Dihedral Angle"

  • "ICEMCFD Quality"

  • "Ortho Skew"

  • "FLUENT Aspect Ratio"

  • "Inverse Orthogonal Quality"

(tgapi-util-get-cell-mesh-distribution '(cell-zone-list) "measure" partitions '(range))
(tgapi-util-get-cell-mesh-distribution "cell-zone-name-pattern*" "measure" partitions '(range))
Report Quality/Size LimitsReport the worst quality face and face quality limits (minimum, maximum, average quality) for the list of zones based on the measure specified. You can also report face size limits.

Specify the "measure" as one of the following:

  • "Orthogonal Quality"

  • "Skewness"

  • "Equiangle Skewness"

  • "Size Change"

  • "Edge Ratio"

  • "Size"

  • "Aspect Ratio"

  • "Squish"

  • "Warp"

  • "Dihedral Angle"

  • "ICEMCFD Quality"

  • "Ortho Skew"

  • "FLUENT Aspect Ratio"

  • "Inverse Orthogonal Quality"

(tgapi-util-get-face-quality-limits '(face-zone-list) "measure")
(tgapi-util-get-face-quality-limits "face-zone-name-pattern*" "measure")
Report the number of cells and the cell quality limits (minimum, maximum, average quality) for the list of zones based on the measure specified. You can also report the cell size limits.

Specify the "measure" as one of the following:

  • "Orthogonal Quality"

  • "Skewness"

  • "Equiangle Skewness"

  • "Size Change"

  • "Edge Ratio"

  • "Size"

  • "Aspect Ratio"

  • "Squish"

  • "Warp"

  • "Dihedral Angle"

  • "ICEMCFD Quality"

  • "Ortho Skew"

  • "FLUENT Aspect Ratio"

  • "Inverse Orthogonal Quality"

(tgapi-util-get-cell-quality-limits '(cell-zone-list) "measure")
(tgapi-util-get-cell-quality-limits "cell-zone-name-pattern*" "measure")
Report the worst quality cell (ID and location) for the cell zones based on the measure specified.

Specify the "measure" as one of the following:

  • "Orthogonal Quality"

  • "Skewness"

  • "Equiangle Skewness"

  • "Size Change"

  • "Edge Ratio"

  • "Size"

  • "Aspect Ratio"

  • "Squish"

  • "Warp"

  • "Dihedral Angle"

  • "ICEMCFD Quality"

  • "Ortho Skew"

  • "FLUENT Aspect Ratio"

  • "Inverse Orthogonal Quality"

(tgapi-util-print-worst-quality-cell '(cell-zone-list) "measure")
(tgapi-util-print-worst-quality-cell "cell-zone-name-pattern*" "measure")
Report the edge size limits for the list of face zones(tgapi-util-get-edge-size-limits '(face-zone-list))
(tgapi-util-get-edge-size-limits "face-zone-name-pattern*")
Report countReturns the count of free faces for the face zones specified(tgapi-util-get-free-faces-count '(face-zone-name-list))
(tgapi-util-get-free-faces-count '(face-zone-id-list))
(tgapi-util-get-free-faces-count "face-zone-name-pattern*")
Returns the count of multi-connected faces for the face zones specified(tgapi-util-get-multi-faces-count '(face-zone-name-list))
(tgapi-util-get-multi-faces-count '(face-zone-id-list))
(tgapi-util-get-multi-faces-count "face-zone-name-pattern*")
Returns the count of marked faces for the face zones specified(tgapi-util-count-marked-faces '(face-zone-name-list))
(tgapi-util-count-marked-faces '(face-zone-id-list))
(tgapi-util-count-marked-faces "face-zone-name-pattern*")
Print summaryPrint the diagnostics summary for a list of objects(tgapi-util-print-diagnostics-summary '(object-name-list))
Mesh checkReports the selected mesh check statistics for the zones specified.

  • Specify the "type-name" as one of the following:

    • "bounding-box-statistics"

    • "volume-statistics"

    • "face-area-statistics"

    • "nodes-per-edge"

    • "nodes-per-face"

    • "nodes-per-cell"

    • "faces-or-neighbors-per-cell"

    • "cell-faces-or-neighbors"

    • "isolated-cells"

    • "face-handedness"

    • "periodic-face-pairs"

    • "face-children"

    • "zone-boundary-conditions"

    • "invalid-node-coordinates"

    • "poly-cells"

    • "parallel-invalid-zones"

    • "parallel-invalid-neighborhood"

    • "parallel-invalid-interfaces"

    Refer to Checking the Mesh in the Fluent User's Guide for descriptions of the individual mesh checks.

  • Specify the zones to be checked.

    Specify the edge zones (edge-zone-list or edge-zone-name-pattern*), face zones (face-zone-list or face-zone-name-pattern*), and cell zones (cell-zone-list or cell-zone-name-pattern*).

(tgapi-util-mesh-check "type-name" '(edge-zone-list) '(face-zone-list) '(cell-zone-list))
(tgapi-util-mesh-check "type-name" "edge-zone-name-pattern*" '(face-zone-list) '(cell-zone-list))
(tgapi-util-mesh-check "type-name" '(edge-zone-list) "face-zone-name-pattern*" '(cell-zone-list))
(tgapi-util-mesh-check "type-name" "edge-zone-name-pattern*" "face-zone-name-pattern*" '(cell-zone-list))
(tgapi-util-mesh-check "type-name" '(edge-zone-list) '(face-zone-list) "cell-zone-name-pattern*")
(tgapi-util-mesh-check "type-name" "edge-zone-name-pattern*" "face-zone-name-pattern*" "cell-zone-name-pattern*")