Meshing policy of a JobRequest. More...
#include <meshkit/job.hpp>
Public Attributes | |
| CellPlan | cells = CellPlan::Triangles |
| Cell types to deliver; default triangles only. | |
| double | minimumTarget = 0 |
| Advisory minimum nominal cell size, finite and >= 0; 0 (default) disables it. | |
| double | maximumSize = 0 |
| Global upper bound on nominal cell size, finite and >= 0; 0 (default) means no global bound. | |
| double | minimumEdge = 0 |
| Minimum actual edge length, finite and >= 0; 0 (default) disables it. | |
| double | minimumAngleDegrees = 30 |
| Smallest triangle angle sought by refinement, in degrees from 0 to 34; default. | |
| double | adjacentRatio = 0 |
| Largest allowed ratio between the nominal sizes of two cells sharing a side: 0 (default) disables it, otherwise it must be >= 1. | |
| double | flatElevation = 0 |
| Elevation (Z units, finite; default 0) given to vertices without a finite authored height when Providers::elevation is not set. | |
| int | smoothingPasses = 0 |
| Passes of non-degrading smoothing of free vertices after size and angle refinement, 0 to 10; default 0 (off). | |
| int | coarsenPasses = 0 |
| Maximum coarsening (removal) attempts per free vertex, i.e. | |
| int | sizingRepairPasses = 2 |
| Bounded sizing-repair passes after smoothing, terrain insertion and coarsening, 0 to 3; default 2. | |
| std::uint32_t | repairInsertions = 200000 |
| Cap on vertices inserted by sizing repair; default 200 000. | |
| CoarseningOrder | coarseningOrder = CoarseningOrder::LegacyFlatness |
| Order in which coarsening tries vertices; default CoarseningOrder::LegacyFlatness. | |
| double | coarseningReferenceSize = 10 |
| Positive finite size (XY units; default 10) that resolution-aware coarsening uses as the target where no size bound applies. | |
| double | terrainTolerance = 0 |
| Reference terrain tolerance in Z units, finite and >= 0; 0 (default) disables terrain checks. | |
| TerrainTolerancePolicy | terrainPolicy |
| Footprint tolerance policy; must be TerrainTolerancePolicy::valid(), and its TargetSize mode needs a positive terrainTolerance. | |
| bool | strictSizing = true |
| When true (default), remaining size, edge or transition conflicts fail the job (code "unresolved_size", Infeasible) instead of returning CompleteWithExceptions; with quad patches, transition conflicts first trigger up to three planning retries. | |
| bool | requireTerrainCertification = false |
| When true, any terrain conflict or unknown terrain bound fails the job (code "unverified_terrain", Infeasible); it requires a positive terrainTolerance. | |
| bool | retainInputMapping = true |
| When true (default), JobResult::inputVertexToOutput is filled. | |
| std::uint64_t | maximumPatchCells = 250000 |
| Most cells one mapped patch may hold; default 250 000. | |
| bool | automaticBlocks = false |
| Whether patch planning also places automatic open-area quad blocks; default false. | |
| int | maximumAutomaticBlocks = 4096 |
| Cap on automatic block tiles; default 4096. | |
| Limits | limits |
| Resource caps of the job. | |
Meshing policy of a JobRequest.
Sizes and edge lengths are in XY plane units; elevations and terrain tolerances are in Z units (see Metadata). runJob() checks the values first and fails with code "option" (or "size_range") when one is out of range. The nominal size of a triangle is the side of the equilateral triangle of equal area; that of a quadrilateral is the square root of its area.
| double meshkit::JobOptions::adjacentRatio = 0 |
Largest allowed ratio between the nominal sizes of two cells sharing a side: 0 (default) disables it, otherwise it must be >= 1.
Exceeding sides are counted in JobReport::transitionConflicts, and sizing repair refines towards it.
| bool meshkit::JobOptions::automaticBlocks = false |
Whether patch planning also places automatic open-area quad blocks; default false.
Takes effect only when planning runs (cells is AutomaticMixed, or quad regions or fixed patches are given).
| CellPlan meshkit::JobOptions::cells = CellPlan::Triangles |
Cell types to deliver; default triangles only.
| CoarseningOrder meshkit::JobOptions::coarseningOrder = CoarseningOrder::LegacyFlatness |
Order in which coarsening tries vertices; default CoarseningOrder::LegacyFlatness.
| double meshkit::JobOptions::coarseningReferenceSize = 10 |
Positive finite size (XY units; default 10) that resolution-aware coarsening uses as the target where no size bound applies.
| int meshkit::JobOptions::coarsenPasses = 0 |
Maximum coarsening (removal) attempts per free vertex, i.e.
one inserted by refinement and not on a constraint, 0 to 10; default 0 (off).
| double meshkit::JobOptions::flatElevation = 0 |
Elevation (Z units, finite; default 0) given to vertices without a finite authored height when Providers::elevation is not set.
| Limits meshkit::JobOptions::limits |
Resource caps of the job.
| int meshkit::JobOptions::maximumAutomaticBlocks = 4096 |
Cap on automatic block tiles; default 4096.
| std::uint64_t meshkit::JobOptions::maximumPatchCells = 250000 |
Most cells one mapped patch may hold; default 250 000.
A larger preferred patch is declined; a larger required patch fails the job with RunStatus::ResourceLimit. It also scales the tiles of automatic blocks.
| double meshkit::JobOptions::maximumSize = 0 |
Global upper bound on nominal cell size, finite and >= 0; 0 (default) means no global bound.
Combined with Providers::maximumSize and quad region spacing by taking the smallest positive value; larger cells are counted in JobReport::sizeConflicts.
| double meshkit::JobOptions::minimumAngleDegrees = 30 |
Smallest triangle angle sought by refinement, in degrees from 0 to 34; default.
| double meshkit::JobOptions::minimumEdge = 0 |
Minimum actual edge length, finite and >= 0; 0 (default) disables it.
Shorter cell sides are counted in JobReport::edgeConflicts; refinement also stops splitting for angle quality below it.
| double meshkit::JobOptions::minimumTarget = 0 |
Advisory minimum nominal cell size, finite and >= 0; 0 (default) disables it.
Smaller delivered cells are counted in JobReport::belowMinimum (CompleteWithExceptions) but never refused. It must not exceed a positive maximumSize. It also sets the spacing floor of terrain points, and a quarter of it is an edge length below which refinement stops splitting for angle quality; when 0, maximumSize / 4 takes its place there.
| std::uint32_t meshkit::JobOptions::repairInsertions = 200000 |
Cap on vertices inserted by sizing repair; default 200 000.
Reaching it ends the job with RunStatus::ResourceLimit (code "refinement_limit"), so 0 does so whenever sizingRepairPasses is positive.
| bool meshkit::JobOptions::requireTerrainCertification = false |
When true, any terrain conflict or unknown terrain bound fails the job (code "unverified_terrain", Infeasible); it requires a positive terrainTolerance.
Default false.
| bool meshkit::JobOptions::retainInputMapping = true |
When true (default), JobResult::inputVertexToOutput is filled.
| int meshkit::JobOptions::sizingRepairPasses = 2 |
Bounded sizing-repair passes after smoothing, terrain insertion and coarsening, 0 to 3; default 2.
| int meshkit::JobOptions::smoothingPasses = 0 |
Passes of non-degrading smoothing of free vertices after size and angle refinement, 0 to 10; default 0 (off).
| bool meshkit::JobOptions::strictSizing = true |
When true (default), remaining size, edge or transition conflicts fail the job (code "unresolved_size", Infeasible) instead of returning CompleteWithExceptions; with quad patches, transition conflicts first trigger up to three planning retries.
Cells below minimumTarget never fail the job.
| TerrainTolerancePolicy meshkit::JobOptions::terrainPolicy |
Footprint tolerance policy; must be TerrainTolerancePolicy::valid(), and its TargetSize mode needs a positive terrainTolerance.
| double meshkit::JobOptions::terrainTolerance = 0 |
Reference terrain tolerance in Z units, finite and >= 0; 0 (default) disables terrain checks.
When positive, Providers::elevation, Providers::terrainWitness and Providers::terrainBound are all required, and terrainPolicy derives each footprint's tolerance from it.