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.

Initial conditions

The Initial conditions panel open beside the setup tree, showing the Method, Values, Turbulence and Written to 0/ sections.
Initial conditions

Where it is

Setup tree: Initial conditions

Controls

Method

Initialise

  • Control: choice (ComboRow)
  • Default: Uniform
  • Bound to: CaseState.initMethod
  • Options: Uniform, Potential flow, From an existing run
  • Writes: potentialFoam (U only), potentialFoam -writephi, 0/* internalField
  • Shown when: root.wholePage

Source case

  • Control: value (ValueField)
  • Default: empty
  • Bound to: CaseState.initMapSource
  • Value modes: none (plain entry)
  • Shown when: root.wholePage && CaseState.initMethod === "From an existing run"

The case directory to map from. Its latest time is used.

Use this case's own run

  • Control: action (ToolButton2)
  • Enabled when: CaseState.runDirectory !== ""

Track the inlet

  • Control: on/off (ToggleRow)
  • Default: true
  • Bound to: CaseState.initFromInlet
  • Shown when: root.wholePage

Seed the domain with the inlet's velocity and turbulence, so changing the inlet keeps the initial field consistent.

Values

Velocity

  • Control: value (ValueField)
  • Unit: m/s
  • Bound to: CaseState.effectiveInitVelocity
  • Writes: 0/U internalField
  • Shown when: root.showsField("U")

Pressure

  • Control: value (ValueField)
  • Unit: Pa
  • Default: 0
  • Bound to: CaseState.initPressure
  • Writes: 0/p … m²/s² (kinematic)
  • Shown when: root.wholePage || root.fieldFilter === "p" || root.fieldFilter === "p_rgh"

Temperature

  • Control: value (ValueField)
  • Unit: K
  • Default: 293.15
  • Bound to: CaseState.initTemperature
  • Writes: 0/T internalField
  • Shown when: CaseState.energyEnabled && root.showsField("T")

Turbulence

Intensity

  • Control: value (ValueField)
  • Unit: %
  • Bound to: CaseState.effectiveInitIntensity
  • Shown when: CaseState.turbulenceFields.length > 1 && root.turbulencePage

Length scale

  • Control: value (ValueField)
  • Unit: m
  • Bound to: CaseState.effectiveInitLengthScale
  • Shown when: CaseState.turbulenceFields.length > 1 && root.turbulencePage

Written to 0/

+ Add subdomain

Label changes with the case; the source gives these forms: + Add subdomain, + Add subdomain of ….

  • Control: action (ToolButton2)

Conditional and repeated groups

Per item in CaseState.initRegions

repeated once for every entry in CaseState.initRegions

Shape

  • Control: choice (ComboRow)
  • Default: box
  • Options: box, sphere
  • Writes: setFieldsDict/regions
  • Shown when: !regionCard.usesPrimitive

Field

  • Control: choice (ComboRow)

Which field setFields writes here. Changing it moves this subdomain under that field in the tree.

Value

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

A bare number for a scalar, or (x y z) for a vector — which keyword setFields needs depends on it.

Min X

  • Control: value (ValueField)
  • Unit: m
  • Value modes: none (plain entry)
  • Shown when: regionCard.usesPrimitive

Min Y

  • Control: value (ValueField)
  • Unit: m
  • Value modes: none (plain entry)
  • Shown when: regionCard.usesPrimitive

Min Z

  • Control: value (ValueField)
  • Unit: m
  • Value modes: none (plain entry)
  • Shown when: regionCard.usesPrimitive

Max X

  • Control: value (ValueField)
  • Unit: m
  • Value modes: none (plain entry)
  • Shown when: regionCard.usesPrimitive

Max Y

  • Control: value (ValueField)
  • Unit: m
  • Value modes: none (plain entry)
  • Shown when: regionCard.usesPrimitive

Max Z

  • Control: value (ValueField)
  • Unit: m
  • Value modes: none (plain entry)
  • Shown when: regionCard.usesPrimitive

Centre X

  • Control: value (ValueField)
  • Unit: m
  • Value modes: none (plain entry)
  • Shown when: regionCard.usesPrimitive

Centre Y

  • Control: value (ValueField)
  • Unit: m
  • Value modes: none (plain entry)
  • Shown when: regionCard.usesPrimitive

Centre Z

  • Control: value (ValueField)
  • Unit: m
  • Value modes: none (plain entry)
  • Shown when: regionCard.usesPrimitive

Radius

  • Control: value (ValueField)
  • Unit: m
  • Value modes: none (plain entry)
  • Shown when: regionCard.usesPrimitive

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.