Template Case editor¶

Every table in the Template Case editor, by tab. "Fixed" tables have a set number of rows: you edit them but can't add or delete rows. The File attribute column gives the name used in the .py file (see the Template Case file reference). Lengths are in metres unless you switch the editor to mm.

Which tables you see depends on the Template Case's Methodology group: OpenFoam (OF), OpenFoam with CHT (CHT), Star-CCM+ (CCM) or Acoustic (AC).

Domain¶

Table	Groups	Rows	File attribute	Fields
Inlet Params	OF, CHT, CCM	Fixed	`velocity`, `yaw`	Velocity (m/s), Yaw Angle (°)
Ref Params	OF, CHT, CCM	Fixed	`ref_density`, `ref_pressure`, `ref_temperature`, `ref_viscosity`	Density (kg/m³), Pressure (Pa), Temperature (K), Kinematic Viscosity (m²/s)
Location In Mesh	OF, CHT, CCM	Fixed	`location_in_mesh`	Position: a point inside the fluid
Domain	OF, CHT, CCM	Fixed	`domain`	Point 1–Point 3: ground-plane corners; Height
Domain Nr Cells	OF, CHT, CCM	Fixed	`domain_nr_cells`	Cells in x, y, z
Half Domain	OF, CHT, CCM	Toggle	`half_domain`	Model half the vehicle. Bramble sets yaw to 0, halves the domain and doubles the forces
Ground Patch	OF, CHT, CCM	Toggle	`ground_patch`	Adds a refined ground patch. Shows Near Car Points
Near Car Points	OF, CHT, CCM	Fixed	`nr_car_points`	Minimum, Maximum: ground-cell indices (x, y)
Ground Level	CCM	Fixed	`ground_level`	Ground refinement level
Fixed Ground Temperature	CHT	Toggle	`fixed_ground_temperature`	Holds the ground at the reference temperature
Mapped Inlet	OF, CHT	Add	`mapped_inlet_point`	Inlet Position. Needs the mapped-inlets Account feature

Table	Groups	File attribute	Fields
Mesh Refinement Boxes	OF, CHT, CCM	`mesh_ref_boxes`	Name, Level, Min Bounds, Max Bounds (each Min ≤ Max)

Radiators¶

Table	Groups	File attribute	Fields
Radiators	OF, CHT	`radiators`	Name, Inside Point, Darcy Coefficient, Forchheimer Coefficient, Through Vector, Orthogonal Vector, Factors (default 1, 10, 10), Up/Down (`Off`, `Manual`, `Auto`), Export, Fields. Show Grid Settings adds grid rows, columns and sizes
Radiators (CCM)	CCM	`ccm_radiators`	As above without Factors or Up/Down, plus Frame Regex

Porous Data (the cog next to the coefficients) fits the Darcy and Forchheimer coefficients from at least three Velocity (m/s) / dp (Pa) pairs. It uses Thickness (default 0.05 m), Dynamic Viscosity and Density.
Macro Heat Exchanger (the thermometer icon, OF and CHT) sets the air and coolant properties, geometry, reference temperatures and heat-transfer table for a radiator.

Rotating¶

Table	Groups	File attribute	Fields
Rotating With RRF	OF, CHT	`wheels`	Name, Regex, Zoneless, Axis, Origin, Omega, Mrf Point, Non-Rotating-Patches (standard MRF only), Zoneless Patches (zoneless MRF only), Tags
Rotating With RRF (CCM)	CCM	`ccm_wheels`	Name, Level, Regex, Axis, Origin, Omega, Non-Rotating-Patches, Tags
Rotating Without RRF	OF, CHT, CCM	`rotating`	Name, Regex, Axis, Origin, Omega, Tags: rotating walls such as driveshafts

A standard MRF uses the toint-rrf-<name> region. See zone naming.

Interior Zones¶

Table	Groups	File attribute	Fields
Fan Jumps	OF, CHT, CCM	`fan_jumps`	Name, Function (polynomial coefficients), Direction, Min Velocity, Max Velocity (m/s), Tags, Force Group
Porous Jumps	OF, CHT, CCM	`porous_jumps`	Name, Permeability, Pressure Jump Co-efficient, Thickness, Max Velocity (m/s), Tags, Force Group
Mass Flow Planes	OF, CHT, CCM	`mfps`	Name, Vector, Process During Export, Base Point

Other BCs¶

Each row applies to a Component (one of the file's components) and the zones inside it matching Regex.

Table	Groups	File attribute	Extra fields
Velocity Inlets	OF, CHT, CCM	`velocity_inlets`	Velocity (m/s), Direction, Tags
Velocity Outlets	OF, CHT	`velocity_outlets`	Velocity (m/s), Direction, Tags
Volumetric Flow Intakes	OF, CHT	`flow_rate_intakes`	Velocity, Direction
Mass Flow Outlets	CCM	`ccm_flow_rate_intakes`	Mass Flow Rate (kg/s)
Total Pressure Inlets	OF, CHT, CCM	`total_pressure_inlets`	Total Pressure, Tags
Pressure Outlets	OF, CHT, CCM	`pressure_outlets`	Pressure, Tags
Slippy Walls	OF, CHT, CCM	`slippy_walls`	— (zero-shear wall)
Roughness	OF, CHT, CCM	`roughness`	— (rough wall)
Temperature	OF, CHT, CCM	`temperatures`	Temperature (K). For CHT, a type of `Simple` or `Ramp` (a time–temperature table)
Grounds	OF, CHT, CCM	`grounds`	Tags
Exhausts, Intakes	—	`exhausts`, `intakes`	Deprecated: use Convert to move them to Velocity Inlets / Velocity Outlets

Forces¶

Table	Groups	File attribute	Fields
Solve Forces	OF, CHT, CCM	`solve_forces`	Name, Regex, Extra Moments, Tags. Include an `all` group
Solve Monitors	OF, CHT, CCM	`solve_monitors`	Regex (the `toint`), Type (`Massflow`, `Area Weighted`, `Mass Flow Weighted`, `Mass Flow Weighted Scalar`, `Flow Uniformity`), Variable, Baffle
Solve Balances	OF, CHT, CCM	`solve_balances`	Name (`yaw`, `pitch`, `roll`), Point, Span
Solve Heats	CHT	`solve_heats`	Name, Regex

Solutions¶

Table	Rows	File attribute	Fields
Solution Stage	Fixed	`solution_stages`	Solution: `Steady State` (RANS Iterations), `Steady State(pressure limited)` (plus RANS(Limited) Iteration), `Transient` (RANS Iterations, DES Solution Time in s, DES Time Step), or for CHT `Steady State (CHT)` (Limited Incomp Iterations, Incomp Iterations, Comp Iterations)
Average Window	Fixed	`averaging_window`	Iterations or time steps to average over. For DES: averaging time ÷ time step. Default 500
Resource	Fixed	`resource`	Number Of Partitions (default 96), Number Of Mesh Partitions (96), Memory Per Core (GB, default 3.0)
Convergence Criteria	Fixed	`convergence_criteria`	Start Time, Number of times unconverged (CCM: Number of Samples)
Convergence Criteria (monitors)	Add	`convergence_criteria` → `monitors`	Force Group, Direction (X, Y, Z), Type (`halfIntervalMean`, `halfIntervalMeanAbsolute`, `variance`; CCM `AsymptoticLimit`), Tolerance (e.g. 0.05 = 5 %). Force Group and Direction together must be unique
Convergence Criteria Monitors	Add	`convergence_criteria` → `monitors`	Solve Monitor, Type, Tolerance
Meancalc Settings	Fixed	`meancalc_settings`	MeanCalc workflows: Min Sample Time (s), Preset (`Custom`, `Fast`, `Precise`)
MC Stopping Criteria	Fixed	`mc_stopping_criteria`	MeanCalc workflows: Direction (`Drag Force`, `Side Force`, `Lift`), Relative Accuracy Target (recommended 0.07–0.15)
Coupled Solver	Fixed	`coupled_solver`	CCM: Explicit Relaxation Factor (0–1, recommended 0.6)

The Solution options depend on the workflows. DES and transient workflows offer only Transient. RANS and steady workflows offer only the steady options.

Exports¶

Table	File attribute	Fields
Export Surfaces	`export_surfaces`	Name, Regex. Copy from Force Groups fills it from Solve Forces
Export Surface Groups	`export_surface_groups`	Surface Group Name, Regex, Fields
Export Movies	`export_movies`	One per axis: Axis, Start Position, End Position, Step, Fields, Parallel
Export Custom Movies	`export_custom_movies`	Name, Start Point, Length, Step, Normal, Fields
Export Iso Surfaces	`export_iso_surfaces`	ISO Field, ISO Values, Cut Off Distance
Export Streamlines From Line Source	`export_ls_streamlines`	Name, Number of Points, Start Point, End Point, Direction
Export Streamlines From Surface Source	`export_surface_streamlines`	Name, Part, Direction
Export Volumes	`export_volumes`	Export Name, Fluid Zones (`ALL` for everything), Fields
Export Point Probes, Export Surface Probes	`export_point_probes`, `export_surface_probes`	Name, Position, Output Interval, Fields. Populate by CSV imports many at once

Movie and volume exports always include Cp, CpT and Unorm. Fields adds more variables.

Acoustics (Acoustic group only)¶

Table	File attribute	Fields
zCFD Domain	`zcfd_domain`	Base Point, Lengths
zCFD Refinement Boxes	`zcfd_ref_boxes`	Name, Level, Min Bounds, Max Bounds
zCFD Mesh Refinement	`stl_refinement`, `global_spacing`	STL Refinement, Global Spacing
FRPM Domain	`frpm_domains`	Box, Translation, Rotation (°), Length, Lt, Constant
Simulation Settings	`simulation_settings`	Case Type (`Internal`, `External`), Min Freq, Max Freq (Hz), Output Freq, Order, sponge-layer damping, CFL
Export Microphone	`microphones`	Name, Point, Trim
Export Iso Volumes (Acoustics), Export Movies (Acoustics)	`export_acoustic_iso_volumes`, `export_acoustic_movies`	Iso-volume bounds; movie axis and positions

Not in the editor¶

The component mesh recipe (surface, curvature, feature-edge and proximity refinement), mesh boxes, force groups, Star-CCM+ mesh and wrapper defaults, and wake grids are edited in the 3D model viewer's Templates tab, or in the file. See the Template Case file reference.