MCP_plan_mesh_OctreePrismOptions

Generated from the central API contract. Availability and permissions are checked by the connected service.

Field

Type / accepted values

Required

Default

Constraints / meaning

input_unit

"mm" / "cm" / "m" / "in" or null

No

null

workflow

"external" / "internal" / "cht_step"

No

"external"

internal_small_feature_size

number or null

No

null

exclusiveMinimum: 0; Explicit internal-only cleanup: remove disconnected boundary shells whose full extent is below this size in meters, including isolated solid islands. Main boundary is retained. Omit to preserve all features.

internal_component_policy

"require_single" / "largest_connected"

No

"require_single"

Internal surface route only. Explicit largest_connected keeps the largest closed fluid component and records excluded pockets; cavity shells or tied volumes are refused. Default requires one connected volume.

controls

OctreeControls or null

No

null

Meshing intent (flow, wake, layers, sizes) for an external mesh. The mesher resolves the domain, spacings and every other field left out from the geometry, with the settings the development meshes were validated with. Other fields given beside it override the resolved values: set them only for a value the user asked for.

named_surfaces

array of NamedSurface

No

Omitted

maxItems: 64; Parts of the wall, each an uploaded STL in the surface’s units, named for controls.surfaces, wake parts and around regions; each also becomes a wall patch. A STEP’s solids are named by the mesher, so leave this out for a STEP.

domain_min

array [number, number, number] or null

No

null

minItems: 3; maxItems: 3; Required without controls.

domain_max

array [number, number, number] or null

No

null

minItems: 3; maxItems: 3; Required without controls.

minimum_spacing

number or null

No

null

exclusiveMinimum: 0; Required without controls.

maximum_spacing

number or null

No

null

exclusiveMinimum: 0; Required without controls.

surface_target_edge

number or null

No

null

exclusiveMinimum: 0

surface_preparation

"auto" / "preserve" / "shrinkwrap"

No

"auto"

surface_remesh

boolean

No

true

Remesh the wall; false preserves an already-final meshing tessellation. fidelity and quality checks still apply.

surface_sizing

"uniform" / "adaptive"

No

"uniform"

Adaptive resolves curvature, gaps and thin walls; surface_target_edge is the largest edge.

surface_minimum_edge

number or null

No

null

exclusiveMinimum: 0; Adaptive curvature floor in metres; default is surface_target_edge / 8. Narrow gaps can require smaller edges.

surface_curvature_angle_degrees

number

No

18.0

maximum: 90; exclusiveMinimum: 0; Maximum surface turning per adaptive edge, in degrees.

surface_gap_cells

number

No

3.0

minimum: 1; maximum: 10; Target edges across narrow gaps for adaptive sizing.

surface_sag_height

number or null

No

null

exclusiveMinimum: 0; Adaptive curvature sag tolerance in metres.

surface_feature_angle_degrees

number

No

180.0

maximum: 180; exclusiveMinimum: 0; Sharp-edge preservation angle during remeshing, in degrees; 180 disables feature detection.

surface_remesh_iterations

integer

No

8

minimum: 1; maximum: 20

surface_maximum_p95_deviation

number or null

No

null

exclusiveMinimum: 0; Two-sided prepared-wall/source p95 distance tolerance in metres; omitted derives two surface resolutions. Set from the requested geometry fidelity.

surface_maximum_feature_deviation

number or null

No

null

exclusiveMinimum: 0; Sharp-feature distance tolerance in metres; omitted derives one surface resolution.

shrinkwrap_pitch

number or null

No

null

exclusiveMinimum: 0; Voxel pitch in metres for dirty-source wrapping.

shrinkwrap_alpha

integer

No

2

minimum: 0; maximum: 32; Morphological closing radius in voxels; wrapping can alter small gaps.

shrinkwrap_taubin_iterations

integer

No

12

minimum: 0; maximum: 100

surface_gap_reopening_voxels

number

No

2.0

minimum: 0; maximum: 8; Reopen accessible clearances wider than approximately twice this voxel count after closing; 0 leaves them sealed.

surface_rewrap_pitch

number or null

No

null

exclusiveMinimum: 0; Optional second topology-preserving voxel pass, pitch in metres.

surface_rewrap_taubin_iterations

integer

No

20

minimum: 0; maximum: 100

surface_close_gaps_below

number or null

No

null

exclusiveMinimum: 0; Auto preparation may fill clean-source gaps below this width in metres. Changes geometry: use only for an explicit simplification intent and disclose it.

surface_conformity_passes

integer

No

0

minimum: 0; maximum: 8

surface_conformity_smoothing_iterations

integer

No

10

minimum: 0; maximum: 100

surface_cleanup_iterations

integer

No

0

minimum: 0; maximum: 20

surface_direct_clean_remesh

boolean

No

false

Direct clean-wall remeshing and conditioning before considering wrapping; dirty sources still use the robust preparation path.

surface_direct_conditioning_iterations

integer

No

4

minimum: 0; maximum: 12

surface_direct_conditioning_feature_angle_degrees

number

No

180.0

maximum: 180; exclusiveMinimum: 0

surface_source_feature_constraints

boolean

No

false

Immutable source-feature constraints; requires direct clean remeshing with no wrapping, conformity or cleanup.

n_prism_layers

integer

No

3

minimum: 0; maximum: 100; Requested prism layers. External requires at least 1. For cht_step, set it explicitly: 0 runs the octree CHT route, more puts layers on the coolant walls (layered CHT). Public baseline is 3; library baseline is 14. Check achieved coverage.

first_layer_height

number

No

0.00025

exclusiveMinimum: 0; First layer height in metres; choose for the geometry and flow, not an assumed achieved y+.

prism_growth_rate

number

No

1.2

minimum: 1; maximum: 2

normal_smoothing_iterations

integer

No

8

minimum: 0; maximum: 200

prism_feature_termination_angle_degrees

number

No

180.0

maximum: 180; exclusiveMinimum: 0; Specialist angle for terminating prism columns at creases; 180 disables. Independent of surface feature preservation; coverage gates remain active.

prism_ridge_cut_degrees

number

No

180.0

maximum: 180; exclusiveMinimum: 0; Median-dual convex ridges above this angle use separate prism sectors; 180 disables.

clearance_adaptive_compression

boolean

No

false

Compress stacks in narrow passages while retaining collision, underfill, coverage and quality gates.

clearance_minimum_first_layer_ratio

number

No

1.0

maximum: 1; exclusiveMinimum: 0; Smallest compressed/requested first-height ratio; values below 1 change the near-wall resolution and must be disclosed.

clearance_maximum_first_layer_aspect

number

No

0.0

minimum: 0; Compression first-layer floor: mean wall edge divided by this value; 0 disables this optional floor.

clearance_maximum_thickness_slope

number

No

0.2

exclusiveMinimum: 0

clearance_curvature_cap_factor

number or null

No

null

exclusiveMinimum: 0

clearance_convex_curvature_cap_factor

number or null

No

null

exclusiveMinimum: 0

clearance_thickness_cap_factor

number or null

No

null

exclusiveMinimum: 0

clearance_gap_cells

number

No

0.0

minimum: 0; maximum: 8; Mean wall edges of fluid core to retain between opposing compressed stacks; 0 disables this extra spacing.

prism_layer_cap_regions

array of array [number, number, number, number, integer] or null

No

null

maxItems: 64; Local (x,y,z,radius,max_layers) regions in metres. Layer cap tapers to the full stack at twice radius; cannot increase requested layers. Coverage gates remain active.

surface_refine_regions

array of array [number, number, number, number, number] or null

No

null

maxItems: 64; Adaptive wall (x,y,z,radius,size_factor) regions; metres and 0 < factor <= 1, tapering to full size at twice radius.

refinement_boxes

array of OpenFoamRefinementBox

No

Omitted

maxItems: 64

fixed_refinement_boxes

array of OpenFoamRefinementBox

No

Omitted

maxItems: 64; Hard geometric spacing constraints in metres, unchanged by target-count calibration; may prevent the requested count.

refinement_shapes

array of MCP_plan_mesh_OctreeRefinementShape

No

Omitted

maxItems: 64; External workflow only: boxes, cylinders/annuli and spheres/shells in metres. Named-part around/wake uses controls.volume.regions. Internal and layered CHT do not support local refinement; zero-layer CHT supports refinement_boxes.

fine_collar_cells

number

No

3.0

minimum: 1; Fine octree collar thickness in local cells.

level_band_cells

number

No

3.0

minimum: 1; Cells per octree level before coarsening by two; larger values produce slower growth.

cap_spacing_ratio_min

number

No

0.5

maximum: 1; exclusiveMinimum: 0

cap_spacing_ratio_max

number

No

1.5

minimum: 0.5; maximum: 2

bridge_clearance_cells

number or null

No

null

minimum: 0; Cap-to-octree bridge clearance in cells; omitted selects the geometry-specific profile.

feature_bridge_clearance_cells

number or null

No

null

minimum: 0

feature_bridge_dihedral_degrees

number

No

12.0

minimum: 0; maximum: 180

feature_bridge_dilation_rings

integer

No

1

minimum: 0; maximum: 8

transition_buffer_rings

integer

No

0

minimum: 0; maximum: 2

transition_cell_style

"hanging_node_polyhedra" / "compact_face_pyramids" / "tet_fans"

No

"hanging_node_polyhedra"

connector_cell_style

"median_dual"

No

"median_dual"

Use the live schema and the applicable workflow guide for semantics.

cap_curvature_refinement

boolean

No

false

Opt-in local near-wall octree refinement. safeguards may fall back to the cap-spacing contract when incompatible; inspect the manifest.

cap_curvature_dihedral_degrees

number

No

12.0

exclusiveMinimum: 0; exclusiveMaximum: 90

cap_curvature_spacing_factor

number

No

0.5

maximum: 1; exclusiveMinimum: 0

cap_curvature_dilation_rings

integer

No

1

minimum: 0; maximum: 4

face_preserving_surface_feature_angle_degrees

number or null

No

null

maximum: 180; exclusiveMinimum: 0; Whole-face Polycell surface conditioning angle; omitted inherits prism termination angle. Applies only to face_preserving_polycell.

face_preserving_cap_ratio_minimum

number

No

0.5

maximum: 1; exclusiveMinimum: 0

face_preserving_cap_ratio_maximum

number

No

1.25

minimum: 0.5; maximum: 2

face_preserving_cap_plateau_rings

integer

No

2

minimum: 0; maximum: 8

face_preserving_cap_maximum_extra_levels

integer

No

2

minimum: 0; maximum: 8

face_preserving_cap_maximum_refinement_rounds

integer

No

3

minimum: 0; maximum: 8

mrf_zones

array of MCP_plan_mesh_MeshMRFZone

No

Omitted

maxItems: 32; Rotating cylinders for external and single-fluid internal workflows; CHT does not support MRF. Internal cylinders tag finished cells without local sizing. Empty and overlapping memberships fail.

patch_names

map of string

No

Omitted

patch_types

object

No

Omitted

protected_tet_boundary_patches

array of string

No

Omitted

maxItems: 512; boundary names whose tetrahedral boundary construction must be preserved, before patch_names renaming. Keep ground for vehicle/rolling-road intent; explicitly [] is valid for free-air cases with no protected boundary.

domain_contact_patches

array of "ground" / "top" / "inlet" / "outlet" / "side_left" / "side_right"

No

Omitted

maxItems: 6; axis-fixed domain faces contacting the body; supplements automatic detection, not a simulation boundary condition.

cell_count_tolerance

number

No

0.3

minimum: 0.01; maximum: 0.5; Target tolerance; quality gates and a hard 20M final-cell ceiling also apply.

max_remesh_iterations

integer

No

2

minimum: 1; maximum: 6

retry_policy

"review" / "automatic"

No

"review"

Review stops before another full mesh or memory-escalation attempt and retains eligible out-of-tolerance results for a decision. Automatic allows only the explicitly authorized bounded retry budget, within the credential’s retry allowance.

retry_authorization_reason

string or null

No

null

minLength: 1; maxLength: 1000; Explicit user or authorized-agent delegation for bounded automatic mesh retries; required for retry_policy=automatic.

cell_count_retries

boolean

No

false

Allow count-only rebuilds within the authorized retry budget. Requires retry_policy=automatic; otherwise a verified out-of-tolerance mesh awaits an explicit decision.

count_calibration

"probe" / "measured"

No

"probe"

Probe predicts spacing before the first full mesh; measured starts from requested sizes. Count corrections still depend on cell_count_retries.

cht_tessellation_tolerance

number

No

0.3

exclusiveMinimum: 0; CHT STEP tessellation tolerance in source CAD coordinates, BEFORE input_unit conversion (usually mm); exception to SI meshing lengths.

cht_weld_tolerance

number

No

0.003

exclusiveMinimum: 0; CHT weld distance in source CAD coordinates BEFORE input_unit conversion (usually mm).

cht_boundary_transition_layers

integer

No

0

minimum: 0; maximum: 3

cht_force_minimum_spacing_at_material_surfaces

boolean

No

true

CHT material interfaces use minimum_spacing unless an explicit material spacing applies.

cht_material_surface_spacings

object

No

Omitted

Actual CHT region names to interface spacing in metres, within minimum_spacing and maximum_spacing.

cht_fluid_regions

array of string

No

Omitted

maxItems: 512; Layered CHT: the actual STEP regions meshed as fluid, each named with fluid or coolant. Omitted: every region so named.

cht_ports

array of ChtPort

No

Omitted

maxItems: 16; Layered CHT: named flat coolant openings, such as the inlet and outlet.

expected_region_names

array of string

No

Omitted

maxItems: 512; For CHT: actual named STEP regions, never inferred from display labels.

expected_interface_pairs

array of array [string, string]

No

Omitted

maxItems: 512

Omission and explicit null are different. Defaults shown are schema defaults; validators may resolve conditional defaults or reject incompatible combinations. See the workflow guide and validate the complete request before submission.