add_compartment
Add a compartment with specified dimensions to a CFAST fire model. Optionally assign surface materials for ceiling, walls, and floor.
Instructions
Add a compartment to a model.
Any surface material id given (ceiling, wall, floor) must already exist in the model — add it first with add_material. If the thermophysical properties of a surface are not included, CFAST treats it as adiabatic (no heat transfer).
Parameters
model_id : str Id of the model to modify. id : str Unique alphanumeric name of the compartment, referenced later by fires and wall vents. width : float Width of the compartment as measured on the X axis from its origin. Default units: m. depth : float Depth of the compartment as measured on the Y axis from its origin. Default units: m. height : float Height of the compartment as measured on the Z axis from its origin. Default units: m. ceiling_mat_id : str or None, optional Material id defining the ceiling surface. Default value: Off. ceiling_thickness : float or None, optional Thickness of the ceiling surface. Default units: m, default value: thickness of the material. wall_mat_id : str or None, optional Material id defining the wall surfaces. Default value: Off. wall_thickness : float or None, optional Thickness of the wall surfaces. Default units: m, default value: thickness of the material. floor_mat_id : str or None, optional Material id defining the floor surface. Default value: Off. floor_thickness : float or None, optional Thickness of the floor surface. Default units: m, default value: thickness of the material. origin_x : float, optional Absolute x coordinate of the lower, left, front corner of the room. Negative values are not allowed. Default units: m, default value: 0.0 m. origin_y : float, optional Absolute y coordinate of the lower, left, front corner of the room. Negative values are not allowed. Default units: m, default value: 0.0 m. origin_z : float, optional Height of the floor of the compartment with respect to the station elevation. Default units: m, default value: 0.0 m.
Returns
str Confirmation, the updated model summary, and any warnings.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| depth | Yes | ||
| width | Yes | ||
| height | Yes | ||
| model_id | Yes | ||
| origin_x | No | ||
| origin_y | No | ||
| origin_z | No | ||
| wall_mat_id | No | ||
| floor_mat_id | No | ||
| ceiling_mat_id | No | ||
| wall_thickness | No | ||
| floor_thickness | No | ||
| ceiling_thickness | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |