add_surface_connection
Add a surface connection between compartments to model heat transfer through walls or floors. Specify compartments, connection type, and fraction for wall connections.
Instructions
Add a surface connection between compartments.
Surface connections transfer heat through solid boundaries between two compartments. Both compartments must already exist in the model. Unlike other components, a surface connection has no id; refer to it by its position (index) when updating. For WALL connections you should add one in each direction (comp_id -> comp_ids and comp_ids -> comp_id).
Parameters
model_id : str Id of the model to modify. conn_type : str Type of connection: WALL for horizontal heat transfer through vertical surfaces, FLOOR for vertical heat transfer through horizontal surfaces. comp_id : str First compartment id. For WALL, the compartment whose wall area fraction is given; for FLOOR, the top compartment (through its floor). comp_ids : str Second compartment id. For FLOOR, the bottom compartment (through its ceiling). fraction : float or None, optional Fraction (0-1) of the first compartment's vertical surface area that connects the two compartments. Required for WALL connections; must be None for FLOOR connections.
Returns
str Confirmation, the updated model summary, and any warnings.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| comp_id | Yes | ||
| comp_ids | Yes | ||
| fraction | No | ||
| model_id | Yes | ||
| conn_type | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |