Meshing requests

Studio, REST and MCP submit meshes through the same central API. Select the engineering route separately from the exported file format.

Product

Request engine

Configuration

GD Structured Meshing

structured

structured

GD Hex-core Meshing

octree_prism

octree_prism

The retained openfoam engine identifier is a compatibility route, available only where the service advertises it. An OpenFOAM export does not require selecting that engine.

Before submission

Inspect the owned source artifact, its units and physical regions. Use get_mesh_controls to discover fields with types, bounds, defaults and units. Use check_geometry for Hex-core geometry readiness and plan_mesh for supported external intent requests. validate_mesh checks the complete request without starting a mesh.

Action

REST

MCP

Controls

GET /v1/meshes/controls

get_mesh_controls

Inspect geometry

GET /v1/artifacts/{id}/mesh-profile

inspect_mesh_geometry

Check geometry

GET /v1/artifacts/{id}/geometry-check

check_geometry

Plan

POST /v1/meshes/plan

plan_mesh

Validate

POST /v1/meshes/validate

validate_mesh

Submit

POST /v1/meshes

create_mesh

Hex-core intent example

Replace the artifact ID with a ready owned surface. The illustration assumes metre-based sizing, external air flow along +x and a ground at the body’s minimum height. These choices are not defaults for every geometry.

{
  "surface_artifact_id": "REPLACE_WITH_SURFACE_ARTIFACT_ID",
  "engine": "octree_prism",
  "target_cells": 3000000,
  "octree_prism": {
    "controls": {
      "flow": {"direction": "+x", "up": "+z", "ground": "body_min", "speed": 40},
      "volume": {"domain": "standard", "wake": {"length": 2, "levels": 2}},
      "boundary_layer": {"layers": 8, "y_plus": 30}
    }
  }
}

Send this body to planning and validation first; submission additionally needs an idempotency key. Intent controls allow the service to resolve sizing. Explicit fixed surface/refinement sizes can prevent the requested count from being achieved. The plan’s predicted count is an estimate, not a measured mesh.

Structured example

Use measured bounds in mm; this example is only a request-shape illustration. A structured route has no extruded prism layers.

{
  "surface_artifact_id": "REPLACE_WITH_SURFACE_ARTIFACT_ID",
  "engine": "structured",
  "target_cells": 1000000,
  "structured": {
    "workflow": "external",
    "mesh_type": "cut_cell",
    "flow_region": {
      "kind": "external",
      "minimum_mm": [-100, -100, -100],
      "maximum_mm": [300, 100, 100]
    }
  }
}

For internal or solid selection, obtain component_id from inspection. Do not invent IDs or substitute an external box for an internal volume.

CHT, quality and review

Hex-core workflow="cht_step" requires the named material regions, actual fluid-region names and explicit layer count. It uses its own sizing controls rather than the external intent example. See multi-region meshing.

Inspect the completed mesh’s measured count, quality, boundaries and zones. awaiting_decision requires review_job before simulation. Automatic retries require explicit bounded authorisation and a sufficient credential retry allowance. A memory-limit failure requires a fresh decision; increasing allocation is not itself permission to retry.

See quality, exports, units and the generated MeshRequest.