update_surface_connection
Update a surface connection in a CFAST fire model by its index to change type, compartments, or fraction.
Instructions
Update an existing surface connection.
Surface connections have no id, so they are selected by index (their 0-based position in the order they were added). Only the parameters you provide change; any left as None is unchanged.
Parameters
model_id : str Id of the model to modify. index : int 0-based position of the surface connection to update. conn_type : str or None, optional Type of connection: WALL or FLOOR. None leaves it unchanged. comp_id : str or None, optional First compartment id. None leaves it unchanged. comp_ids : str or None, optional Second compartment id. None leaves it unchanged. fraction : float or None, optional Fraction (0-1) of connected vertical surface area, for WALL connections. None leaves it unchanged.
Returns
str Confirmation, the updated model summary, and any warnings.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| index | Yes | ||
| comp_id | No | ||
| comp_ids | No | ||
| fraction | No | ||
| model_id | Yes | ||
| conn_type | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |