create_model
Initialize a new CFAST fire simulation by defining the first compartment's dimensions, title, and optional environmental parameters, then get a model ID for subsequent configuration and execution.
Instructions
Create a new CFAST model with its first compartment and register it.
A CFAST model must contain at least one compartment, so creation includes the first one. Add materials, further compartments, wall vents and fires with the add_* tools, then use inspect_model and run_model.
Parameters
title : str Title of the simulation. May consist of letters, numbers, and/or symbols and may be up to 50 characters. room_id : str Unique alphanumeric name of the first compartment, referenced later by fires and wall vents. room_width : float Width of the compartment as measured on the X axis from its origin. Default units: m. room_depth : float Depth of the compartment as measured on the Y axis from its origin. Default units: m. room_height : float Height of the compartment as measured on the Z axis from its origin. Default units: m. time_simulation : int, optional Length of time over which the simulation takes place. Default units: s, default value: 900 s. interior_temperature : float, optional Initial ambient temperature inside the structure. Default units: °C, default value: 20 °C. exterior_temperature : float, optional Initial ambient temperature outside the structure. Default units: °C, default value: 20 °C. relative_humidity : float, optional Initial relative humidity, only specified for the interior. Default units: % RH, default value: 50 %.
Returns
str The new model_id, the model summary, and any warnings.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| title | Yes | ||
| room_id | Yes | ||
| room_depth | Yes | ||
| room_width | Yes | ||
| room_height | Yes | ||
| time_simulation | No | ||
| relative_humidity | No | ||
| exterior_temperature | No | ||
| interior_temperature | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |