Skip to content

Zone naming

Zones are the named surfaces inside a Part. Template Cases select zones by matching their names against regular expressions, and forces are reported per zone. Kinematic Setups also rely on zone names to find moving parts such as wheels. A consistent naming scheme is what lets Bramble configure your simulations automatically. See geometry for the background.

Where zone names come from

File type Zone names
.stl, .stlb (and .gz copies) You enter one zone name per file when you upload it
.nas, .msh, .blend (and .gz copies) Read from the file. The upload dialog shows N/A

Rules Bramble enforces

A zone name entered on upload must:

  • start with one of your Account's zone keywords, for example fw in fw-main
  • contain no spaces

Until the zone is valid, the file's Start button is disabled with the message "Enter a valid zone".

Zone keywords

Each Account has its own list of zone keywords. To view or change it, click the edit button next to the Zones column heading in the Upload Parts dialog, then Add or remove keywords and click Confirm. The list applies to every User in the Account.

Keywords can contain letters, digits, _ and -, and must not start with a digit.

Default keywords

New Accounts start with these keywords:

body · fw · rw · uf · fr-susp · rr-susp · fr-wh · rr-wh · diff · eb · toint

Restore Default Zone Patterns in the keyword editor resets the list to these keywords, except toint. Add toint back afterwards if you use it.

Some conventions below use prefixes that aren't default keywords, such as fr-int, rr-int and the cycling prefixes. Add those to your Account's keywords before uploading files that use them.

Side tokens

Bramble reads a zone's side (left or right) from a side token in its name. It uses the side when reflecting geometry and kinematics from one side of the model to the other, so a zone meant for one side must carry a recognised token.

Side Recognised tokens
Left lh, lhs, LH, LHS
Right rh, rhs, RH, RHS

A token is only recognised when it isn't directly next to a letter. Hyphens, other special characters, digits, and the start or end of the name can all sit next to it. The token doesn't have to be at the end.

Zone name Side recognised?
fr-wh-rim-lhs Yes, left
fr-wh-rim-LH Yes, left
fw-flap-LHS2 Yes, left (a digit next to the token is fine)
rr-int-rh-upright Yes, right
body-rh-od Yes, right
body-rhod No: rh is followed by a letter
fw-flaplhs No: lhs follows a letter

Don't use these letters for anything else

Any lh or rh that stands on its own is read as a side. Avoid using rh to mean ride height in a zone name, for example uf-rh-sensor, because Bramble will treat that zone as right-hand.

Naming conventions

Bramble's rules are deliberately loose. These conventions are what Bramble's Template Cases and kinematic models are built around. Follow them unless your Template Case author has agreed a different scheme.

Structure

Name every zone <zone>-<description>, adding a side suffix where the model has a left and a right:

  • Characters: letters, numbers and hyphens only. No spaces or underscores.
  • Zone: one of the prefixes below.
  • Description: what the surface is, for example main, flap1, rim.
  • Side: lhs (left-hand side) or rhs (right-hand side), placed last by convention, for example fr-wh-rim-lhs. Bramble recognises other forms too; see side tokens.

Automotive and motorsport

Prefix Use for Example
body Bodywork body-sidepod-lhs
eb Engine bay eb-cover
fw Front wing fw-flap1
rw Rear wing rw-mainplane
uf Underbody / floor uf-plank
diff Diffuser diff-strake-rhs
fr-wh Front wheel parts that rotate with the wheel fr-wh-tyre-lhs
rr-wh Rear wheel parts that rotate with the wheel rr-wh-rim-lhs
fr-int Front wheel parts that move with the wheel but don't rotate fr-int-upright-lhs
rr-int Rear wheel parts that move with the wheel but don't rotate rr-int-upright-lhs
fr-susp Front suspension fr-susp-wishbone-lhs
rr-susp Rear suspension rr-susp-pushrod-rhs
toint Interior and measurement regions (see below) toint-mfp-fr-br-duct-lhs

Getting the wh / int split right matters. Wheel rotation is applied to *-wh-* zones, while *-int-* zones follow the wheel's position (steer, suspension travel) without spinning.

toint zones

toint (short for "to interior") marks regions that aren't solid walls. They are used to define or measure flow inside the model:

Pattern Use for Example
toint-rad-<description> Radiators (porous regions) toint-rad-water-lhs
toint-rrf-<description>-<side> Wheel rotating reference frames (MRF) toint-rrf-fr-lhs
toint-mfp-<description> Mass-flow planes, for measuring flow through a duct toint-mfp-fr-br-duct-lhs

Cycling

Bicycle models use their own prefixes. Apart from fr-wh and rr-wh, add them to your Account's keywords first.

Prefix Use for Example
handlebar Handlebars handlebar-tape
stem Stem stem-cap
saddle Saddle saddle-rails
seat-post Seat post seat-post-clamp
frame Frame frame-downtube
forks Forks forks-crown
gear Drivetrain gear-chainring
fr-wh Front wheel parts that rotate fr-wh-rim
rr-wh Rear wheel parts that rotate rr-wh-brake-disc
toint-rrf Wheel rotating reference frames toint-rrf
toint-mfp Mass-flow planes toint-mfp-fr-br-duct

General advice

Put the component first, then the detail. Template Cases usually match the start of a name, so fw.* catches fw-main and fw-flap1.

Keep variants identical. A modified Part should use the same zone names as the Part it replaces. Then the same Template Case treats both the same way, and the results compare like-for-like.

Use modifiers your Template Case understands. A Template Case can look for words inside a name to change how the zone is meshed. For example, the Template Case in the first simulation tutorial recognises:

Modifier in the name Effect in that Template Case
-coarse, -fine, -extra-fine, -super-fine Surface refinement level
-lyr / -nlyr With or without prism layers
-inner No prism layers

Modifiers are defined by each Template Case, not by Bramble. Check yours before relying on them.

Watch out for broad patterns. .* matches every zone, and fw.* matches anything starting with fw. Choose names so each pattern catches exactly the zones you intend.