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

Optional caller callbacks used by runJob(), plus the provider identity. More...

#include <meshkit/job.hpp>

Collaboration diagram for meshkit::Providers:

Public Attributes

std::function< double(const Box2 &)> maximumSize
 Upper bound on nominal cell size (XY units) over a whole footprint box.
 
std::function< double(double, double)> elevation
 Elevation (Z units) at XY position (x, y).
 
std::function< double(const Point2 *, const double *, Point2 *)> terrainWitness
 Refinement witness: given three XY corners and their heights, returns the triangle's residual against the reference surface (Z units) and writes the point where it occurs to the third argument; NaN means unknown coverage.
 
std::function< double(const Point2 *, const double *)> terrainBound
 Certified maximum residual (Z units) of the linear triangle over three XY corners with the given heights, coverage included.
 
std::function< bool()> cancelled
 Polled during the job; returning true stops it with RunStatus::Cancelled.
 
std::string identity
 Caller supplied dataset/provider version or fingerprint.
 

Detailed Description

Optional caller callbacks used by runJob(), plus the provider identity.

runJob() copies this object and calls the callbacks synchronously on the calling thread. Callbacks may be empty, except that a positive JobOptions::terrainTolerance requires elevation, terrainWitness and terrainBound. An exception thrown by a callback ends the job without a mesh (normally with RunStatus::Failed). Pointer arguments are valid only during the call.

Member Data Documentation

◆ cancelled

std::function<bool()> meshkit::Providers::cancelled

Polled during the job; returning true stops it with RunStatus::Cancelled.

◆ elevation

std::function<double(double, double)> meshkit::Providers::elevation

Elevation (Z units) at XY position (x, y).

Used for every delivered vertex without a finite authored height (JobOptions::flatElevation when empty); a nonfinite result for a delivered vertex fails the job (code "elevation").

◆ identity

std::string meshkit::Providers::identity

Caller supplied dataset/provider version or fingerprint.

◆ maximumSize

std::function<double(const Box2 &)> meshkit::Providers::maximumSize

Upper bound on nominal cell size (XY units) over a whole footprint box.

It must return a finite value >= 0, otherwise the job fails (code "size_provider"); 0 means no limit.

◆ terrainBound

std::function<double(const Point2 *, const double *)> meshkit::Providers::terrainBound

Certified maximum residual (Z units) of the linear triangle over three XY corners with the given heights, coverage included.

Used by coarsening, patch planning and the final check, which tests a quad as two triangles and counts a nonfinite or negative result as unknown.

◆ terrainWitness

std::function<double(const Point2 *, const double *, Point2 *)> meshkit::Providers::terrainWitness

Refinement witness: given three XY corners and their heights, returns the triangle's residual against the reference surface (Z units) and writes the point where it occurs to the third argument; NaN means unknown coverage.


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