ForcesConfigΒΆ

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

Field

Type / accepted values

Required

Default

Constraints / meaning

enabled

boolean

No

true

patches

array of string

No

Omitted

maxItems: 512; Actual wall patch names; empty uses automatic wall selection.

exclude_patches

array of string

No

Omitted

maxItems: 512

reference_area_mode

"explicit" / "auto_projected" or null

No

Omitted

Explicit engineering reference area or a disclosed projected-area estimate.

reference_area

number or null

No

Omitted

minimum: 0.0; Reference area in m^2; positive for explicit mode, omitted/0 for auto_projected.

reference_velocity

number

No

0

minimum: 0.0; Reference speed in m/s; zero uses the freestream.

reference_length

number or null

No

Omitted

exclusiveMinimum: 0.0; Moment reference length in metres.

drag_direction

array [number, number, number]

No

[1.0, 0.0, 0.0]

minItems: 3; maxItems: 3

lift_direction

array [number, number, number]

No

[0.0, 1.0, 0.0]

minItems: 3; maxItems: 3

include_fixed_velocity_walls

boolean

No

false

mode

"off" / "end_only" / "interval" / "history" / "both" / "every_step"

No

"end_only"

interval

integer

No

1

minimum: 1.0; maximum: 1000000.0

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.