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

Settings, budgets and patch limits for planQuadRegions(). More...

#include <meshkit/planning.hpp>

Collaboration diagram for meshkit::plan::QuadPlanningOptions:

Public Attributes

bool allowQuads = true
 False forces triangles everywhere: optional regions fall back and any required region fails the plan.
 
double defaultSize = 1
 Target spacing, XY units, for regions whose QuadRegion::spacing is not > 0; must be finite and > 0.
 
PatchLimits limits
 Base patch limits.
 
int maximumRepairRounds = 3
 Rounds (0..3) in which a repairable failure doubles the station counts of the candidate's sides; a value outside 0..3 makes the settings invalid.
 
std::uint64_t maximumCells = 20000000
 Cell budget for all planned patches together.
 
std::uint64_t maximumPatchCells = 250000
 Cell budget for a single patch.
 
std::uint64_t maximumWorkspaceBytes = std::uint64_t(2) << 30
 Estimated planning memory budget in bytes (about 160 per source segment, 32 per station and 192 per planned cell); 2 GiB by default.
 
std::uint64_t workBudget = 0
 Maximum work units; 0 means maximumCells * 512 + 100000.
 
std::function< bool(const Polygon &)> excluded
 Optional filter called with each candidate's CCW boundary ring (no repeated closing vertex); returning true refuses that candidate.
 

Detailed Description

Settings, budgets and patch limits for planQuadRegions().

Member Data Documentation

◆ allowQuads

bool meshkit::plan::QuadPlanningOptions::allowQuads = true

False forces triangles everywhere: optional regions fall back and any required region fails the plan.

◆ defaultSize

double meshkit::plan::QuadPlanningOptions::defaultSize = 1

Target spacing, XY units, for regions whose QuadRegion::spacing is not > 0; must be finite and > 0.

◆ excluded

std::function<bool(const Polygon &)> meshkit::plan::QuadPlanningOptions::excluded

Optional filter called with each candidate's CCW boundary ring (no repeated closing vertex); returning true refuses that candidate.

◆ limits

PatchLimits meshkit::plan::QuadPlanningOptions::limits

Base patch limits.

Per region, QuadRegion::aspectMax (when >= 0) replaces maximumAspect, a positive spacing caps maximumSize, and directional spacing sets alongSize, acrossSize and alongAngleDegrees. limits.cancelled also cancels planning, and limits.maximumSize also scales initial spacing.

◆ maximumCells

std::uint64_t meshkit::plan::QuadPlanningOptions::maximumCells = 20000000

Cell budget for all planned patches together.

It also caps one side's station count, sets the default workBudget and bounds repair doubling.

◆ maximumPatchCells

std::uint64_t meshkit::plan::QuadPlanningOptions::maximumPatchCells = 250000

Cell budget for a single patch.

◆ maximumRepairRounds

int meshkit::plan::QuadPlanningOptions::maximumRepairRounds = 3

Rounds (0..3) in which a repairable failure doubles the station counts of the candidate's sides; a value outside 0..3 makes the settings invalid.

◆ maximumWorkspaceBytes

std::uint64_t meshkit::plan::QuadPlanningOptions::maximumWorkspaceBytes = std::uint64_t(2) << 30

Estimated planning memory budget in bytes (about 160 per source segment, 32 per station and 192 per planned cell); 2 GiB by default.

◆ workBudget

std::uint64_t meshkit::plan::QuadPlanningOptions::workBudget = 0

Maximum work units; 0 means maximumCells * 512 + 100000.

Running out stops planning with QuadPlan::resourceLimited.


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