Loading...
Searching...
No Matches
mesh::SizingAuditReport Struct Reference

Result of auditMeshSizing(). More...

#include <mesh/sizingaudit.h>

Collaboration diagram for mesh::SizingAuditReport:

Public Member Functions

bool limitsSatisfied () const
 Whether the mesh met every hard limit.
 

Public Attributes

bool complete = false
 Not stopped by cancellation or a work or workspace budget.
 
bool valid = false
 Every check ran on valid limits and mesh geometry.
 
bool cancelled = false
 Cancellation was observed.
 
bool resourceLimited = false
 The work budget or the estimated workspace limit was exceeded.
 
QString error
 English reason when valid is false; empty otherwise.
 
quint64 cellsChecked = 0
 Cells measured.
 
quint64 facesChecked = 0
 Faces shared by exactly two cells.
 
quint64 belowTarget = 0
 Cells below the advisory minimumTarget.
 
quint64 belowEdgeFloor = 0
 Cells with an edge below minimumEdge.
 
quint64 aboveMaximum = 0
 Cells above maximumSize.
 
quint64 aboveLocalMaximum = 0
 Cells above their footprintMaximum bound.
 
quint64 transitionFaces = 0
 Shared faces whose size ratio exceeds adjacentRatio.
 
quint64 workUsed = 0
 Work units consumed.
 
double smallestNominal = 0
 Smallest nominal cell size (XY length).
 
double largestNominal = 0
 Largest nominal cell size (XY length).
 
double largestAdjacentRatio = 1
 Largest nominal-size ratio across a shared face; 1 when there is none.
 
QVector< quint8 > cellFlags
 SizingCellFlag bits per MeshResult::triangles entry; empty if no cell was measured.
 
QVector< SizingAuditExample > examples
 First violations found, up to maximumExamples; BelowTarget is never recorded.
 

Detailed Description

Result of auditMeshSizing().

Counts and extremes are partial unless valid is true.

Member Function Documentation

◆ limitsSatisfied()

bool mesh::SizingAuditReport::limitsSatisfied ( ) const
inline

Whether the mesh met every hard limit.

Returns
True when complete and valid and no cell or face violated minimumEdge, maximumSize, footprintMaximum or adjacentRatio. Advisory belowTarget counts are ignored.

Member Data Documentation

◆ aboveLocalMaximum

quint64 mesh::SizingAuditReport::aboveLocalMaximum = 0

Cells above their footprintMaximum bound.

◆ aboveMaximum

quint64 mesh::SizingAuditReport::aboveMaximum = 0

Cells above maximumSize.

◆ belowEdgeFloor

quint64 mesh::SizingAuditReport::belowEdgeFloor = 0

Cells with an edge below minimumEdge.

◆ belowTarget

quint64 mesh::SizingAuditReport::belowTarget = 0

Cells below the advisory minimumTarget.

◆ cancelled

bool mesh::SizingAuditReport::cancelled = false

Cancellation was observed.

◆ cellFlags

QVector<quint8> mesh::SizingAuditReport::cellFlags

SizingCellFlag bits per MeshResult::triangles entry; empty if no cell was measured.

◆ cellsChecked

quint64 mesh::SizingAuditReport::cellsChecked = 0

Cells measured.

◆ complete

bool mesh::SizingAuditReport::complete = false

Not stopped by cancellation or a work or workspace budget.

Also true when invalid input stopped the audit, so check valid as well.

◆ error

QString mesh::SizingAuditReport::error

English reason when valid is false; empty otherwise.

◆ examples

QVector<SizingAuditExample> mesh::SizingAuditReport::examples

First violations found, up to maximumExamples; BelowTarget is never recorded.

◆ facesChecked

quint64 mesh::SizingAuditReport::facesChecked = 0

Faces shared by exactly two cells.

◆ largestAdjacentRatio

double mesh::SizingAuditReport::largestAdjacentRatio = 1

Largest nominal-size ratio across a shared face; 1 when there is none.

◆ largestNominal

double mesh::SizingAuditReport::largestNominal = 0

Largest nominal cell size (XY length).

◆ resourceLimited

bool mesh::SizingAuditReport::resourceLimited = false

The work budget or the estimated workspace limit was exceeded.

◆ smallestNominal

double mesh::SizingAuditReport::smallestNominal = 0

Smallest nominal cell size (XY length).

◆ transitionFaces

quint64 mesh::SizingAuditReport::transitionFaces = 0

Shared faces whose size ratio exceeds adjacentRatio.

◆ valid

bool mesh::SizingAuditReport::valid = false

Every check ran on valid limits and mesh geometry.

◆ workUsed

quint64 mesh::SizingAuditReport::workUsed = 0

Work units consumed.


The documentation for this struct was generated from the following file: