Loading...
Searching...
No Matches
meshkit::plan::PatchInterfaceReport Struct Reference

Result of auditPatchInterfaces(). More...

#include <meshkit/planning.hpp>

Collaboration diagram for meshkit::plan::PatchInterfaceReport:

Public Attributes

bool ok = false
 True when the audit completed; size violations do not clear it (see violations).
 
bool cancelled = false
 True when the cancellation callback stopped the audit.
 
Text error
 Why ok is false; empty on success.
 
std::uint64_t sharedFaces = 0
 Listed edges with exactly two incident cells; edges with one cell are skipped.
 
std::uint64_t violations = 0
 Shared edges whose size ratio exceeds the allowed ratio (relative tolerance 1e-9).
 
double largestRatio = 1
 Largest size ratio over shared edges (>= 1); 1 when none.
 
Vector< PatchInterfaceConflict > examples
 Up to maximumExamples (clamped to [0, 1000]) violations with the smallest (first, second) cell indices, sorted ascending.
 

Detailed Description

Member Data Documentation

◆ cancelled

bool meshkit::plan::PatchInterfaceReport::cancelled = false

True when the cancellation callback stopped the audit.

◆ error

Text meshkit::plan::PatchInterfaceReport::error

Why ok is false; empty on success.

◆ examples

Vector<PatchInterfaceConflict> meshkit::plan::PatchInterfaceReport::examples

Up to maximumExamples (clamped to [0, 1000]) violations with the smallest (first, second) cell indices, sorted ascending.

◆ largestRatio

double meshkit::plan::PatchInterfaceReport::largestRatio = 1

Largest size ratio over shared edges (>= 1); 1 when none.

◆ ok

bool meshkit::plan::PatchInterfaceReport::ok = false

True when the audit completed; size violations do not clear it (see violations).

◆ sharedFaces

std::uint64_t meshkit::plan::PatchInterfaceReport::sharedFaces = 0

Listed edges with exactly two incident cells; edges with one cell are skipped.

◆ violations

std::uint64_t meshkit::plan::PatchInterfaceReport::violations = 0

Shared edges whose size ratio exceeds the allowed ratio (relative tolerance 1e-9).


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