add_wall_vent
Add a wall vent connecting two compartments in a CFAST fire model, specifying its position, size, and wall face.
Instructions
Add a wall vent (door, window or opening) between two compartments.
Wall vents connect compartments that physically overlap in elevation, or connect a compartment to the outside. Both compartments must already exist in the model; comp_b may be "OUTSIDE" to vent to the exterior. All specifications of the vent are made relative to the floor of the first compartment.
Parameters
model_id : str Id of the model to modify. id : str Unique name of the vent. comp_a : str First compartment id; the reference for all vent specifications. comp_b : str Second compartment id, or "OUTSIDE" for the exterior. bottom : float Position of the bottom of the opening relative to the floor of the first compartment. Default units: m. height : float Height of the opening relative to the bottom of the opening. Default units: m. width : float Width of the opening. Default units: m. face : str The wall on which the vent is positioned. Choices are FRONT, REAR, LEFT, RIGHT; Front and Rear faces are parallel to the X axis, Left and Right to the Y axis. offset : float, optional For visualization only, the horizontal distance between the near edge of the vent and the origin of the axis defined by the selected face. Default units: m, default value: 0 m.
Returns
str Confirmation, the updated model summary, and any warnings.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| face | Yes | ||
| width | Yes | ||
| bottom | Yes | ||
| comp_a | Yes | ||
| comp_b | Yes | ||
| height | Yes | ||
| offset | No | ||
| model_id | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |