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

Physical units, coordinate reference text and description of a mesh or job request. More...

#include <meshkit/mesh.hpp>

Collaboration diagram for meshkit::Metadata:

Public Attributes

double horizontalMetresPerUnit = 1
 Metres per XY plane unit, the unit of point and vertex x/y; default 1.
 
double verticalMetresPerUnit = 1
 Metres per Z (elevation) unit; default 1.
 
bool unitsKnown = true
 Whether the unit scales are declared; default true.
 
std::string crs
 Coordinate reference system text (UTF-8), carried through unchanged; may be empty.
 
std::string description
 Free-form description (UTF-8); may be empty.
 

Detailed Description

Physical units, coordinate reference text and description of a mesh or job request.

MeshKit never converts coordinates between reference systems; the strings are carried through unchanged. runJob() and validateMesh() require both unit scales to be positive and finite and both strings to be valid UTF-8, and count the string bytes against Limits::maxMetadataBytes.

Member Data Documentation

◆ crs

std::string meshkit::Metadata::crs

Coordinate reference system text (UTF-8), carried through unchanged; may be empty.

◆ description

std::string meshkit::Metadata::description

Free-form description (UTF-8); may be empty.

◆ horizontalMetresPerUnit

double meshkit::Metadata::horizontalMetresPerUnit = 1

Metres per XY plane unit, the unit of point and vertex x/y; default 1.

◆ unitsKnown

bool meshkit::Metadata::unitsKnown = true

Whether the unit scales are declared; default true.

runJob() refuses a request with false (code "units_required"); the SMS 2DM reader sets false. validateMesh() ignores it.

◆ verticalMetresPerUnit

double meshkit::Metadata::verticalMetresPerUnit = 1

Metres per Z (elevation) unit; default 1.

runJob() scales elevation differences by verticalMetresPerUnit / horizontalMetresPerUnit when it ranks facet normals for resolution-aware coarsening.


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