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

Complete input of runJob(): source geometry, optional attributes, sizing inputs, metadata and options. More...

#include <meshkit/job.hpp>

Collaboration diagram for meshkit::JobRequest:

Public Attributes

std::vector< Point2 > points
 Mandatory source points: at least three, at most Limits::maxVertices.
 
std::vector< Path > paths
 Source paths indexing points; at least one PathKind::Outer path is required (no bounding box is inferred).
 
std::vector< double > pointElevations
 Optional authored Z per point; NaN samples the elevation provider, or uses JobOptions::flatElevation when there is none.
 
std::vector< std::int64_t > pointIds
 Positive, unique external ids of points; empty means 1, 2, 3, ... Generated vertices get ids above the largest source id.
 
std::vector< std::int32_t > pointMarkers
 Markers of points, delivered as vertex markers; empty means all zero.
 
std::vector< Label > labels
 Region names copied to Mesh::labels; ids must be unique and names UTF-8.
 
std::vector< RegionSeed > regions
 Seeds that assign region ids to constrained components.
 
std::vector< plan::QuadRegion > quadRegions
 Quad region policies (see plan::QuadRegion).
 
std::vector< plan::PatchMesh > fixedPatches
 Local quad patches inserted as given after validation; every cell centre must lie in the domain.
 
std::optional< plan::SizeFieldOptions > sizeField
 Optional graded size field built from the source paths and marked points; its bound is combined with Providers::maximumSize (smallest positive value).
 
Metadata metadata
 Units, CRS text and description; copied to the delivered mesh.
 
JobOptions options
 Meshing policy and limits.
 

Detailed Description

Complete input of runJob(): source geometry, optional attributes, sizing inputs, metadata and options.

runJob() only reads it. Coordinates are XY plane units of one Cartesian frame. Each optional per-point array is either empty or exactly as long as points.

Member Data Documentation

◆ fixedPatches

std::vector<plan::PatchMesh> meshkit::JobRequest::fixedPatches

Local quad patches inserted as given after validation; every cell centre must lie in the domain.

Rejected when options.cells is CellPlan::Triangles.

◆ labels

std::vector<Label> meshkit::JobRequest::labels

Region names copied to Mesh::labels; ids must be unique and names UTF-8.

◆ metadata

Metadata meshkit::JobRequest::metadata

Units, CRS text and description; copied to the delivered mesh.

◆ options

JobOptions meshkit::JobRequest::options

Meshing policy and limits.

◆ paths

std::vector<Path> meshkit::JobRequest::paths

Source paths indexing points; at least one PathKind::Outer path is required (no bounding box is inferred).

Crossing paths must be noded by the caller (NATIVE_API.md).

◆ pointElevations

std::vector<double> meshkit::JobRequest::pointElevations

Optional authored Z per point; NaN samples the elevation provider, or uses JobOptions::flatElevation when there is none.

◆ pointIds

std::vector<std::int64_t> meshkit::JobRequest::pointIds

Positive, unique external ids of points; empty means 1, 2, 3, ... Generated vertices get ids above the largest source id.

◆ pointMarkers

std::vector<std::int32_t> meshkit::JobRequest::pointMarkers

Markers of points, delivered as vertex markers; empty means all zero.

With sizeField, points with a nonzero marker also seed the size field.

◆ points

std::vector<Point2> meshkit::JobRequest::points

Mandatory source points: at least three, at most Limits::maxVertices.

A point outside the delivered domain or inside a hole fails the job (code "unused_source_point"). Exactly equal XY points share one output vertex (see VertexAlias).

◆ quadRegions

std::vector<plan::QuadRegion> meshkit::JobRequest::quadRegions

Quad region policies (see plan::QuadRegion).

A positive spacing also caps the size of every cell whose footprint meets the region's bounding box; the attribute becomes the Cell::region of the region's quads.

◆ regions

std::vector<RegionSeed> meshkit::JobRequest::regions

Seeds that assign region ids to constrained components.

◆ sizeField

std::optional<plan::SizeFieldOptions> meshkit::JobRequest::sizeField

Optional graded size field built from the source paths and marked points; its bound is combined with Providers::maximumSize (smallest positive value).

footprintBounds is forced on.


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