Loading...
Searching...
No Matches
meshkit::Path Struct Reference

Indexed polyline or ring: a source constraint of a JobRequest, or a delivered path of a Mesh. More...

#include <meshkit/mesh.hpp>

Collaboration diagram for meshkit::Path:

Public Attributes

std::vector< Index > vertices
 Zero-based vertex indices; at least two are required.
 
PathKind kind = PathKind::Line
 Role of the path; defaults to an open Line.
 
std::int32_t marker = 0
 Numeric marker; runJob() copies it to every delivered Edge along this path.
 
std::int64_t id = 0
 Caller identifier.
 
bool closed = false
 Explicit closure of a Line path.
 

Detailed Description

Indexed polyline or ring: a source constraint of a JobRequest, or a delivered path of a Mesh.

In a JobRequest the indices refer to JobRequest::points; in a Mesh they refer to Mesh::vertices. runJob() collapses consecutive duplicate vertices (after merging exactly coincident points), requires a closed ring to keep at least three distinct vertices without revisiting one, and delivers each path as the chain of output vertices along its cell edges, without repeating the first vertex of a closed path.

Member Data Documentation

◆ closed

bool meshkit::Path::closed = false

Explicit closure of a Line path.

Other kinds are closed implicitly, and runJob() sets this to true on every delivered path that is closed.

◆ id

std::int64_t meshkit::Path::id = 0

Caller identifier.

In a delivered mesh runJob() replaces 0 with the path's one-based position in JobRequest::paths.

◆ kind

PathKind meshkit::Path::kind = PathKind::Line

Role of the path; defaults to an open Line.

◆ marker

std::int32_t meshkit::Path::marker = 0

Numeric marker; runJob() copies it to every delivered Edge along this path.

Default 0.

◆ vertices

std::vector<Index> meshkit::Path::vertices

Zero-based vertex indices; at least two are required.


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