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

One constraint polyline or ring for simplification and the constraint audits. More...

#include <meshkit/constraints.hpp>

Collaboration diagram for meshkit::plan::SimplificationFeature:

Public Types

enum class  Role {
  Line ,
  Domain ,
  Hole ,
  Protected
}
 Meaning of a feature for auditMeshConstraints(). More...
 

Public Attributes

Text id
 Stable identifier: copied to SimplificationChange::id and prefixed to error messages.
 
Vector< Point2 > xy
 Finite vertex coordinates in the common planar frame (XY units).
 
Vector< double > z
 Optional authored elevations in Z units; compared with maxZDeviation, never changed.
 
Vector< bool > fixed
 Per-vertex flags; a true vertex is never removed. Missing trailing flags are false.
 
bool closed = false
 Treat as a ring even without a repeated closing vertex.
 
ConstraintSimplificationPolicy policy
 Simplification limits for this feature.
 
enum meshkit::plan::SimplificationFeature::Role role = Role::Line
 Meaning for auditMeshConstraints() (default Line); copied unchanged by simplification.
 
int marker = 0
 Boundary marker, copied unchanged by simplification.
 
bool requiredInMesh = true
 True (default): auditMeshConstraints() requires delivered cell edges to cover this feature; false: the mesh audit skips it.
 
Text label
 Optional human-readable label; copied unchanged, not read by simplification or the audits.
 

Detailed Description

One constraint polyline or ring for simplification and the constraint audits.

It is a ring when closed is true or its last XY vertex equals its first; such a closing duplicate is kept in the output and must carry the same elevation as the first vertex.

Member Enumeration Documentation

◆ Role

Meaning of a feature for auditMeshConstraints().

  • Line: constraint path; only coverage by delivered edges is checked.
  • Domain: outer boundary ring; each covered edge needs one incident cell on its inside (two, one per side, where adjacent domains share the edge).
  • Hole: hole ring; each covered edge needs one incident cell outside the hole.
  • Protected: caller label (Python role "protected"); treated like Line here.
Enumerator
Line 

Constraint path; only coverage by delivered edges is checked.

Domain 

Outer boundary ring; covered edges need an incident cell inside.

Hole 

Hole ring; covered edges need an incident cell outside the hole.

Protected 

Caller label (Python role "protected"); treated like Line.

Member Data Documentation

◆ closed

bool meshkit::plan::SimplificationFeature::closed = false

Treat as a ring even without a repeated closing vertex.

◆ fixed

Vector<bool> meshkit::plan::SimplificationFeature::fixed

Per-vertex flags; a true vertex is never removed. Missing trailing flags are false.

◆ id

Text meshkit::plan::SimplificationFeature::id

Stable identifier: copied to SimplificationChange::id and prefixed to error messages.

Uniqueness is not checked.

◆ label

Text meshkit::plan::SimplificationFeature::label

Optional human-readable label; copied unchanged, not read by simplification or the audits.

◆ marker

int meshkit::plan::SimplificationFeature::marker = 0

Boundary marker, copied unchanged by simplification.

When nonzero, auditMeshConstraints() accepts only delivered edges with the same marker.

◆ policy

ConstraintSimplificationPolicy meshkit::plan::SimplificationFeature::policy

Simplification limits for this feature.

◆ requiredInMesh

bool meshkit::plan::SimplificationFeature::requiredInMesh = true

True (default): auditMeshConstraints() requires delivered cell edges to cover this feature; false: the mesh audit skips it.

◆ role

enum meshkit::plan::SimplificationFeature::Role meshkit::plan::SimplificationFeature::role = Role::Line

Meaning for auditMeshConstraints() (default Line); copied unchanged by simplification.

◆ xy

Vector<Point2> meshkit::plan::SimplificationFeature::xy

Finite vertex coordinates in the common planar frame (XY units).

◆ z

Vector<double> meshkit::plan::SimplificationFeature::z

Optional authored elevations in Z units; compared with maxZDeviation, never changed.


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