add_mechanical_vent
Add a mechanical vent with constant volumetric flow between two compartments or to the outside. Specify flow rate, duct geometry, and pressure cutoffs for fan ventilation.
Instructions
Add a mechanical vent between two compartments.
Mechanical ventilation moves air at a user-specified volume flow between two compartments, or between a compartment and the outside. Both compartments must already exist in the model; comp_from or comp_to may be "OUTSIDE".
Parameters
model_id : str Id of the model to modify. id : str Unique name of the mechanical ventilation system. comp_from : str Compartment from which the fan flow originates, or "OUTSIDE". comp_to : str Compartment to which the fan flow terminates, or "OUTSIDE". flow : float Constant volumetric flow rate of the fan. Default units: m³/s. area : list[float] or None, optional Cross-sectional area of the opening for each connection [area_from, area_to]. Default units: m², default value: [0, 0] m². heights : list[float] or None, optional Height of the midpoint of the duct opening above the floor for each connection [height_from, height_to]. Default units: m, default value: [0, 0] m. orientations : list[str] or None, optional Flow orientation for each connection, HORIZONTAL or VERTICAL. A horizontal diffuser implies vertical flow through the ceiling or floor; a vertical diffuser implies horizontal flow through a wall. Default value: ["VERTICAL", "VERTICAL"]. cutoffs : list[float] or None, optional Pressure control values [begin_drop_off_pressure, zero_flow_pressure]: above the first the flow drops off, above the second it is zero. Default units: Pa, default value: [200, 300] Pa. 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 first compartment. Default units: m, default value: [0, 0] m. filter_time : float, optional Time at which mechanical vent filtering begins. Default units: s, default value: 0 s. filter_efficiency : float, optional Portion of soot and trace species mass removed from the flow, specified as a percentage (0-100). Default value: 0.
Returns
str Confirmation, the updated model summary, and any warnings.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| area | No | ||
| flow | Yes | ||
| comp_to | Yes | ||
| cutoffs | No | ||
| heights | No | ||
| offsets | No | ||
| model_id | Yes | ||
| comp_from | Yes | ||
| filter_time | No | ||
| orientations | No | ||
| filter_efficiency | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |