update_simulation
Update simulation parameters such as title, time duration, interior/exterior temperatures, and relative humidity for a CFAST fire model.
Instructions
Update the simulation environment (scenario and ambient conditions).
A model has a single simulation environment, set at create_model; this changes only the parameters you provide; any left as None is unchanged.
Parameters
model_id : str Id of the model to modify. title : str or None, optional Title of the simulation. May consist of letters, numbers, and/or symbols and may be up to 50 characters. None leaves it unchanged. time_simulation : int or None, optional Length of time over which the simulation takes place. Default units: s. None leaves it unchanged. interior_temperature : float or None, optional Initial ambient temperature inside the structure. Default units: °C. None leaves it unchanged. exterior_temperature : float or None, optional Initial ambient temperature outside the structure. Default units: °C. None leaves it unchanged. relative_humidity : float or None, optional Initial relative humidity, only specified for the interior. Default units: % RH. None leaves it unchanged.
Returns
str Confirmation, the updated model summary, and any warnings.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| title | No | ||
| model_id | Yes | ||
| time_simulation | No | ||
| relative_humidity | No | ||
| exterior_temperature | No | ||
| interior_temperature | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |