Skip to content
SHD Sim
Menu
Documentation menu

Draft. This manual is new and still growing. If something here does not match what you see in the software, the software is right — tell us and we will fix the page.

Boundary patch

Where it is

reached from the default branch of the node switch in the application return CaseState.bc(root.node) ? cPatch : cPlaceholder

Controls

Assignment

Name

  • Control: value (ValueField)
  • Value modes: none (plain entry)

Must match the patch name in the mesh. Renaming here does not rename it in an already generated mesh.

Show in viewport

  • Control: action (ToolButton2)
  • Enabled when: CaseState.meshExists

Specification

Type

  • Control: choice (ComboRow)
  • Options: ``, Velocity inlet, Pressure inlet, Pressure outlet, Outflow, Wall, Thermal wall, Symmetry, Periodic, Far field, Fan / screen, Wave inlet, Empty (2D), Wedge (axisymmetric)

Not assigned — pick a condition.

Freestream speed

Label changes with the case; the source gives these forms: Freestream speed, Velocity.

  • Control: value (ValueField)
  • Unit: m/s
  • Default: 10.0
  • Writes: 0/U freestreamVelocity, 0/U uniformFixedValue table, 0/U fixedValue
  • Value modes: U
  • Shown when: CaseState.bcNeeds(root.kind, "velocity")

A table's single value column is a speed along the flow direction. Give it three columns for the components.

Gauge pressure

  • Control: value (ValueField)
  • Unit: Pa
  • Default: 0.0
  • Writes: 0/p uniformFixedValue table, 0/p … m²/s² (kinematic)
  • Value modes: p, p_rgh
  • Shown when: CaseState.bcNeeds(root.kind, "pressure")

A table is in gauge pascals, the same as the value beside it.

Pressure rise

  • Control: value (ValueField)
  • Unit: Pa
  • Default: 0.0
  • Writes: 0/p fanPressure jumpTable
  • Value modes: none (plain entry)
  • Shown when: CaseState.bcNeeds(root.kind, "fan")

Temperature

  • Control: value (ValueField)
  • Unit: K
  • Default: 293.15
  • Writes: 0/T uniformFixedValue table, 0/T
  • Value modes: T
  • Shown when: CaseState.bcNeeds(root.kind, "temperature")

… fraction

  • Control: value (ValueField)
  • Default: 0.0
  • Writes: 0/…
  • Value modes: none (plain entry)
  • Shown when: CaseState.twoPhaseVof && CaseState.bcNeeds(root.kind, "phase")

1 is all …, 0 is all ….

Stream

  • Control: choice (ComboRow)
  • Default: oxidiser
  • Options: oxidiser, fuel
  • Writes: 0/Y
  • Shown when: CaseState.physicsFamily === "reacting" && CaseState.bcNeeds(root.kind, "phase")

Decides the mass fractions this inlet carries: pure …, or air.

Wall motion

  • Control: choice (ComboRow)
  • Default: Stationary (no-slip)
  • Options: Stationary (no-slip), Slip, Moving wall, Rotating wall
  • Writes: 0/U …
  • Shown when: CaseState.bcNeeds(root.kind, "wall")

Rotation rate

Label changes with the case; the source gives these forms: Rotation rate, Wall speed.

  • Control: value (ValueField)
  • Default: 0.0
  • Value modes: none (plain entry)
  • Shown when: CaseState.bcNeeds(root.kind, "wall") && root.bc && root.bc.wallMotion !== "Stationary (no-slip)" && root.bc.wallMotion !== "Slip"

Roughness

  • Control: choice (ComboRow)
  • Default: Smooth
  • Options: Smooth, Sand-grain roughness
  • Writes: 0/nut …
  • Shown when: CaseState.bcNeeds(root.kind, "wall") && root.bc && root.bc.wallMotion !== "Slip"

Sand-grain height

  • Control: value (ValueField)
  • Unit: m
  • Default: 0.0
  • Writes: 0/nut Ks
  • Value modes: none (plain entry)
  • Shown when: CaseState.bcNeeds(root.kind, "wall") && root.bc && root.bc.roughness === "Sand-grain roughness" && root.bc.wallMotion !== "Slip"

Roughness constant

  • Control: value (ValueField)
  • Default: 0.5
  • Bound to: CaseState.roughnessConstant
  • Writes: nutkRoughWallFunction/Cs
  • Value modes: none (plain entry)
  • Shown when: root.bc && String(root.bc.roughness) !== "Smooth"

Cs. 0.5 suits packed sand grains; a rougher, more open texture wants more.

Turbulence

Intensity

  • Control: value (ValueField)
  • Unit: %
  • Default: 5.0
  • Value modes: none (plain entry)
  • Shown when: CaseState.bcNeeds(root.kind, "turbulence")

Length scale

  • Control: value (ValueField)
  • Unit: m
  • Default: 0.1
  • Value modes: none (plain entry)
  • Shown when: CaseState.bcNeeds(root.kind, "turbulence")

About 7 % of the body length — … m here.

Discard

  • Control: action (ToolButton2)

Problems reported against this step

The application reports no problems against this step.


marks a value the application computes at run time, so the source carries no fixed text for it.