add_ceiling_floor_vent
Add a vertical flow vent connecting a top compartment's floor to a bottom compartment's ceiling, or to outside. Specify compartments, vent area, type, and shape.
Instructions
Add a ceiling/floor vent (vertical flow opening) between compartments.
Vertical flow vents connect compartments stacked in elevation, or a compartment to the outside (e.g. a hole in a roof). Both compartments must already exist in the model; comp_bottom may be "OUTSIDE".
Parameters
model_id : str Id of the model to modify. id : str Unique name of the vent. comp_top : str Top compartment id, where the vent is in the floor. comp_bottom : str Bottom compartment id, where the vent is in the ceiling, or "OUTSIDE" for the exterior. area : float Cross-sectional area of the vent opening. Default units: m². type : str, optional Type of ceiling/floor vent: FLOOR or CEILING. Default value: FLOOR. shape : str, optional Shape factor used to compute the effective diameter and flow coefficients: ROUND or SQUARE. Default value: ROUND. offsets : list[float] or None, optional For visualization only, [x_offset, y_offset] horizontal distances between the center of the vent and the origin of the X and Y axes in the upper compartment. 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 | ||
| area | Yes | ||
| type | No | FLOOR | |
| shape | No | ROUND | |
| offsets | No | ||
| comp_top | Yes | ||
| model_id | Yes | ||
| comp_bottom | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |