> For the complete documentation index, see [llms.txt](https://docs.openbrim.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.openbrim.org/templates/retaining-wall-workflow/retaining-wall-rw/retaining-wall-segment-rw.md).

# Retaining Wall Segment \[RW]

The Retaining Wall Segment is the primary object of this workflow. Each segment models one continuous run of cantilever retaining wall between two stations: its stem, its spread footing, an optional footing key, and the analytical shell model used for design.

## General

**Structure Definition:** The retaining wall structure this segment belongs to. The segment takes its alignment and station reference from the selected structure.

**Segment Start Station:** Station along the layout line where the segment begins (default: 0).

**Segment End Station:** Station along the layout line where the segment ends (default: 240).

**Wall Material:** Concrete material assigned to the stem and footing of the segment.

**Segment ID:** Identifier used to label the segment in drawings, reports and quantity take-offs (default: S001).

**Orientation \[Left=1/Right=2]:** Side of the layout line the retained soil sits on, which fixes the direction the stem faces (default: Right=2).

**Standard Plan Type by Design H \[Custom=0/6ft=1/8ft=2/10ft=3/12ft=4/14ft=5/16ft=6/18ft=7/20ft=8/22ft=9/24ft=10/26ft=11/28ft=12/30ft=13/32ft=14]:** Selects a standard-plan wall type by design height. **Custom** leaves every stem and footing dimension under user control; choosing a standard height drives those dimensions from the corresponding standard plan (default: Custom=0).

## Stem

**Top-of-Wall Thickness:** Stem thickness at the top of the wall (default: 12).

**Batter (1 in X) \[Vertical=0/]:** Batter of the stem face, expressed as 1 horizontal in X vertical. Enter 0 for a vertical stem (default: 6).

**Has Stem-Top Haunch \[NO=0/YES=1]:** When YES, a haunch is formed at the top of the stem to seat a barrier (default: YES=1).

**Haunch Seat Width (barrier seat at top of wall):** Width of the barrier seat formed by the haunch (default: 18).

**Haunch Height (below top of wall):** Height of the haunch measured down from the top of the wall (default: 12).

**Haunch Bottom Chamfer Horizontal:** Horizontal leg of the chamfer at the bottom of the haunch (default: 6).

**Haunch Bottom Chamfer Vertical:** Vertical leg of the chamfer at the bottom of the haunch (default: 6).

## Footing

**Bottom of Footing Elevation:** Elevation of the underside of the footing, in the global coordinate system (default: 0).

**Footing Toe (exterior face to near edge):** Distance from the exterior face of the stem to the near (toe) edge of the footing (default: 24).

**Footing Heel (exterior face to far edge):** Distance from the exterior face of the stem to the far (heel) edge of the footing (default: 96).

**Footing Thickness:** Thickness of the footing (default: 18).

**Has Footing Key \[NO=0/YES=1]:** When YES, a shear key is cast under the footing to increase sliding resistance (default: NO=0).

**Footing Key Depth:** Depth of the footing key below the underside of the footing (default: 12).

**Footing Key Width:** Width of the footing key (default: 12).

**Footing Key Offset (from closest toe edge):** Distance from the toe edge of the footing to the near face of the key (default: 36).

## FEA

**Generate FEM \[NO=0/YES=1]:** Setting this to NO disables the analytical (finite-element) representation of the segment (default: YES=1).

**Mesh Size:** Maximum finite-element size used when meshing the segment (default: 60).

**Mesh Algorithm\[MeshAdapt=1/Automatic=2/Initial mesh only=3/Delaunay=5/Frontal-Delaunay=6/BAMG=7/Frontal-Delaunay for Quads=8/Packing of Parallelograms=9/Quasi-structured Quad=11]:** Meshing algorithm used to generate the shell mesh of the segment (default: MeshAdapt=1).

## Reinforcement

**Show 3D Rebar \[No=0/Yes=1]:** When Yes, the reinforcement is drawn in the 3D view (default: No=0).

## Referencing Objects

**Barriers on this Segment:** Barrier objects hosted by this segment. (Read-only)

**Piles on this Segment:** Single Pile objects that reference this segment. (Read-only)

**Pile Groups on this Segment:** Pile Layout objects that reference this segment. (Read-only)

## Quantities

**Total Volume:** Concrete volume of the segment. (Read-only)

**Total Weight:** Concrete weight of the segment. (Read-only)

**Material:** Material reported for the segment in quantity take-offs. (Read-only)

**Rebar Calculation Method\[By Density=0/By Length=1]:** Chooses how reinforcement quantities are estimated — from a rebar density per unit volume, or by summing explicit reinforcement lengths (default: By Density=0).

**Rebar Density(per cubic yard):** Reinforcement weight per cubic yard, used when Rebar Calculation Method is By Density.

**Rebar Weight (By Density):** Reinforcement weight computed from the density. (Read-only)

**Stem Rebar Length:** Total length of stem reinforcement. (Read-only)

**Stem Rebar Weight:** Weight of the stem reinforcement. (Read-only)

**Footing Rebar Length:** Total length of footing reinforcement. (Read-only)

**Footing Rebar Weight:** Weight of the footing reinforcement. (Read-only)

**Total Rebar Length (By Length):** Combined stem and footing reinforcement length. (Read-only)

**Total Rebar Weight (By Length):** Combined stem and footing reinforcement weight. (Read-only)

## IFC

**Type:** IFC entity used when exporting the segment. Default `IfcWall`.

**Predefined Type:** IFC predefined type. Default `RETAININGWALL`.

**Parent:** IFC parent the segment is attached to in the export hierarchy. Default `RETAINING_STRUCTURE`.

## Reinforcement Data

**Stem Reinforcement Rows:** Table of reinforcement rows in the stem. Each row defines a rebar layer used for capacity computation and detailing.

**Footing Reinforcement Rows:** Table of reinforcement rows in the footing. Each row defines a rebar layer used for capacity computation and detailing.

**Rebar Render Segments (tube facets):** Number of facets used when drawing rebar as tubes in the 3D view. Higher values look smoother and render more slowly.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.openbrim.org/templates/retaining-wall-workflow/retaining-wall-rw/retaining-wall-segment-rw.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.