update_ceiling_floor_vent
Modify an existing ceiling or floor vent in a CFAST model by providing its ID and updating parameters like area, type, shape, or connections.
Instructions
Update an existing ceiling/floor vent.
Selects the vent by vent_id and changes only the parameters you provide; any left as None is unchanged. The vent's id is the selector and is not changed here.
Parameters
model_id : str Id of the model to modify. vent_id : str Id of the ceiling/floor vent to update. comp_top : str or None, optional Top compartment id, where the vent is in the floor. To change the connection, provide both comp_top and comp_bottom. None leaves the connection unchanged. comp_bottom : str or None, optional Bottom compartment id, or "OUTSIDE". To change the connection, provide both comp_top and comp_bottom. None leaves the connection unchanged. area : float or None, optional Cross-sectional area of the vent opening. Default units: m². None leaves it unchanged. type : str or None, optional Type of ceiling/floor vent: FLOOR or CEILING. None leaves it unchanged. shape : str or None, optional Shape factor: ROUND or SQUARE. None leaves it unchanged. offsets : list[float] or None, optional For visualization only, [x_offset, y_offset]. Default units: m. None leaves it unchanged.
Returns
str Confirmation, the updated model summary, and any warnings.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| area | No | ||
| type | No | ||
| shape | No | ||
| offsets | No | ||
| vent_id | Yes | ||
| comp_top | No | ||
| model_id | Yes | ||
| comp_bottom | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |