update_mechanical_vent
Modify an existing mechanical vent in a CFAST fire model by updating its flow, area, height, orientation, cutoffs, offsets, or filter settings. Only parameters you specify are changed.
Instructions
Update an existing mechanical 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 mechanical vent to update. comp_from : str or None, optional Compartment from which the fan flow originates, or "OUTSIDE". To change the connection, provide both comp_from and comp_to. None leaves the connection unchanged. comp_to : str or None, optional Compartment to which the fan flow terminates, or "OUTSIDE". To change the connection, provide both comp_from and comp_to. None leaves the connection unchanged. flow : float or None, optional Constant volumetric flow rate of the fan. Default units: m³/s. None leaves it unchanged. area : list[float] or None, optional Cross-sectional area of the opening for each connection [area_from, area_to]. Default units: m². None leaves it unchanged. 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. None leaves it unchanged. orientations : list[str] or None, optional Flow orientation for each connection, HORIZONTAL or VERTICAL. None leaves it unchanged. cutoffs : list[float] or None, optional Pressure control values [begin_drop_off_pressure, zero_flow_pressure]. Default units: Pa. None leaves it unchanged. offsets : list[float] or None, optional For visualization only, [x_offset, y_offset]. Default units: m. None leaves it unchanged. filter_time : float or None, optional Time at which mechanical vent filtering begins. Default units: s. None leaves it unchanged. filter_efficiency : float or None, optional Portion of soot and trace species mass removed (0-100 %). None leaves it unchanged.
Returns
str Confirmation, the updated model summary, and any warnings.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| area | No | ||
| flow | No | ||
| comp_to | No | ||
| cutoffs | No | ||
| heights | No | ||
| offsets | No | ||
| vent_id | Yes | ||
| model_id | Yes | ||
| comp_from | No | ||
| filter_time | No | ||
| orientations | No | ||
| filter_efficiency | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |