OpenFoamOptions

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

Omitted

Surface coordinate units; domain bounds and spacing are always in metres.

workflow

"external" / "internal"

No

"external"

domain_min

array [number, number, number]

Yes

Omitted

minItems: 3; maxItems: 3

domain_max

array [number, number, number]

Yes

Omitted

minItems: 3; maxItems: 3

minimum_spacing

number

Yes

Omitted

exclusiveMinimum: 0.0

maximum_spacing

number

Yes

Omitted

exclusiveMinimum: 0.0

surface_target_edge

number or null

No

Omitted

exclusiveMinimum: 0.0

surface_refinement_buffer_levels

integer

No

1

minimum: 0.0; maximum: 2.0

surface_feature_angle_degrees

number

No

35.0

maximum: 180.0; exclusiveMinimum: 0.0

n_prism_layers

integer

No

3

minimum: 0.0; maximum: 20.0; Requested layers; 0 disables layers. Achieved layers/coverage must be checked after meshing.

first_layer_height

number

No

0.001

exclusiveMinimum: 0.0; Metres. Legacy 1 mm default is not a y+ target; choose for the part and flow, disclose assumptions.

prism_growth_rate

number

No

1.2

minimum: 1.0; maximum: 2.0

refinement_boxes

array of OpenFoamRefinementBox

No

Omitted

maxItems: 64

fixed_refinement_boxes

array of OpenFoamRefinementBox

No

Omitted

maxItems: 64

refinement_regions

array of OpenFoamRefinementRegion

No

Omitted

maxItems: 64

mrf_zones

array of MeshMRFZone

No

Omitted

maxItems: 32

patch_names

map of string

No

Omitted

patch_types

object

No

Omitted

cell_count_tolerance

number

No

0.3

minimum: 0.01; maximum: 0.5; Fractional target cell-count tolerance: default 0.30 means ±30%. A 2-million-cell target allows 1.4–2.6 million, subject to quality and hard limits. Leave omitted unless the user requests a different tolerance; a target count alone does not imply ±5%.

max_remesh_iterations

integer

No

3

minimum: 1.0; maximum: 4.0

retry_policy

"review" / "automatic"

No

"review"

Review stops before another full mesh attempt; automatic allows the explicitly authorized, bounded max_remesh_iterations budget, within the credential’s retry allowance.

retry_authorization_reason

string or null

No

Omitted

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

location_in_mesh

array [number, number, number] or null

No

Omitted

minItems: 3; maxItems: 3; Known fluid seed strictly inside the domain, in metres; inside bounds alone does not prove fluid membership.

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.