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

Report of runJob(): the OperationReport fields plus options, provider identity, planning, refinement and certification statistics. More...

#include <meshkit/job.hpp>

Inheritance diagram for meshkit::JobReport:
Collaboration diagram for meshkit::JobReport:

Public Attributes

std::string algorithmVersion = "cdt-1/job-2"
 Algorithm and report version identifier.
 
JobOptions resolvedOptions
 Copy of the options of the returned attempt as supplied (zero defaults such as Limits::maxWork are not expanded); shows automaticBlocks off if a retry disabled it.
 
std::string providerIdentity
 Copy of Providers::identity.
 
bool constraintAuditPassed = false
 Whether the independent audit of the delivered source constraints passed.
 
std::uint64_t constraintSegments = 0
 Source segments checked by that audit.
 
std::uint64_t plannedPatches = 0
 Quad patches (fixed and planned) prepared for the returned attempt.
 
std::uint64_t sharedSides = 0
 Patch sides shared between planned patches.
 
std::uint64_t planningRetries = 0
 Mixed-interface retries before the returned attempt, 0 to 3.
 
std::vector< plan::PatchDecision > planning
 Patch planning decisions of the returned attempt followed by those of earlier retries; at most 256.
 
std::uint64_t inserted = 0
 Vertices inserted by refinement, segment splits included.
 
std::uint64_t removed = 0
 Vertices removed by coarsening.
 
std::uint64_t removalAttempts = 0
 Coarsening removal attempts.
 
std::uint64_t queuePeak = 0
 Peak size of the coarsening priority queue.
 
std::uint64_t belowMinimum = 0
 Cells whose nominal size is below JobOptions::minimumTarget (advisory).
 
std::uint64_t edgeConflicts = 0
 Cell sides shorter than JobOptions::minimumEdge, counted per cell (a shared side counts twice).
 
std::uint64_t sizeConflicts = 0
 Cells whose nominal size exceeds the size bound over their bounding box.
 
std::uint64_t transitionConflicts = 0
 Shared sides whose cell size ratio exceeds JobOptions::adjacentRatio.
 
std::uint64_t terrainConflicts = 0
 Cells whose certified terrain bound exceeds their footprint tolerance.
 
std::uint64_t terrainUnknown = 0
 Cells whose terrain bound is unknown (nonfinite or negative).
 
double largestAdjacentRatio = 1
 Largest nominal-size ratio over all shared sides; 1 when none was measured.
 
double largestTerrainRatio = 0
 Largest terrain bound / tolerance over cells with a known bound; 0 when terrain is not checked.
 
std::vector< JobException > examples
 Up to 64 individual exceptions; the counters above hold the totals.
 
- Public Attributes inherited from meshkit::OperationReport
std::uint32_t schemaVersion = 1
 Report schema version; 1 in this release.
 
RunStatus status = RunStatus::Failed
 Final status; Failed until the operation sets it.
 
std::string code
 Short machine-readable outcome code, e.g.
 
std::string message
 Human-readable description of the outcome.
 
Counts counts
 Vertex and cell counters of the operation; -1 where unavailable.
 
std::uint64_t work = 0
 Work units used by the operation's own counter (see Limits::maxWork).
 
std::uint64_t record = 0
 Record reached by a file reader (the SMS 2DM line number, or the number of MeshKit binary records read), which locates a read error; 0 for operations that read no records.
 
double seconds = 0
 Elapsed time of the operation in seconds (steady clock).
 

Additional Inherited Members

- Public Member Functions inherited from meshkit::OperationReport
bool complete () const noexcept
 Whether the operation delivered a result.
 

Detailed Description

Report of runJob(): the OperationReport fields plus options, provider identity, planning, refinement and certification statistics.

Counters are totals; examples keeps at most 64 individual exceptions. When a job stops early, the fields keep the values reached so far.

Member Data Documentation

◆ algorithmVersion

std::string meshkit::JobReport::algorithmVersion = "cdt-1/job-2"

Algorithm and report version identifier.

◆ belowMinimum

std::uint64_t meshkit::JobReport::belowMinimum = 0

Cells whose nominal size is below JobOptions::minimumTarget (advisory).

◆ constraintAuditPassed

bool meshkit::JobReport::constraintAuditPassed = false

Whether the independent audit of the delivered source constraints passed.

◆ constraintSegments

std::uint64_t meshkit::JobReport::constraintSegments = 0

Source segments checked by that audit.

◆ edgeConflicts

std::uint64_t meshkit::JobReport::edgeConflicts = 0

Cell sides shorter than JobOptions::minimumEdge, counted per cell (a shared side counts twice).

◆ examples

std::vector<JobException> meshkit::JobReport::examples

Up to 64 individual exceptions; the counters above hold the totals.

◆ inserted

std::uint64_t meshkit::JobReport::inserted = 0

Vertices inserted by refinement, segment splits included.

◆ largestAdjacentRatio

double meshkit::JobReport::largestAdjacentRatio = 1

Largest nominal-size ratio over all shared sides; 1 when none was measured.

◆ largestTerrainRatio

double meshkit::JobReport::largestTerrainRatio = 0

Largest terrain bound / tolerance over cells with a known bound; 0 when terrain is not checked.

◆ plannedPatches

std::uint64_t meshkit::JobReport::plannedPatches = 0

Quad patches (fixed and planned) prepared for the returned attempt.

◆ planning

std::vector<plan::PatchDecision> meshkit::JobReport::planning

Patch planning decisions of the returned attempt followed by those of earlier retries; at most 256.

◆ planningRetries

std::uint64_t meshkit::JobReport::planningRetries = 0

Mixed-interface retries before the returned attempt, 0 to 3.

◆ providerIdentity

std::string meshkit::JobReport::providerIdentity

◆ queuePeak

std::uint64_t meshkit::JobReport::queuePeak = 0

Peak size of the coarsening priority queue.

◆ removalAttempts

std::uint64_t meshkit::JobReport::removalAttempts = 0

Coarsening removal attempts.

◆ removed

std::uint64_t meshkit::JobReport::removed = 0

Vertices removed by coarsening.

◆ resolvedOptions

JobOptions meshkit::JobReport::resolvedOptions

Copy of the options of the returned attempt as supplied (zero defaults such as Limits::maxWork are not expanded); shows automaticBlocks off if a retry disabled it.

◆ sharedSides

std::uint64_t meshkit::JobReport::sharedSides = 0

Patch sides shared between planned patches.

◆ sizeConflicts

std::uint64_t meshkit::JobReport::sizeConflicts = 0

Cells whose nominal size exceeds the size bound over their bounding box.

◆ terrainConflicts

std::uint64_t meshkit::JobReport::terrainConflicts = 0

Cells whose certified terrain bound exceeds their footprint tolerance.

◆ terrainUnknown

std::uint64_t meshkit::JobReport::terrainUnknown = 0

Cells whose terrain bound is unknown (nonfinite or negative).

◆ transitionConflicts

std::uint64_t meshkit::JobReport::transitionConflicts = 0

Shared sides whose cell size ratio exceeds JobOptions::adjacentRatio.


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