update_fire
Modify parameters of an existing fire instance in a CFAST fire model using its unique ID. Update compartment, fuel type, location, heat release rate, or fuel composition without changing the fire identity.
Instructions
Update an existing fire.
Selects the fire by its instance id and changes only the parameters you provide; any left as None is unchanged. The fire instance id is the selector and is not changed here. Changing comp_id moves the fire to another compartment, which must already exist.
Parameters
model_id : str Id of the model to modify. id : str Id of the fire instance to update. comp_id : str or None, optional Name of the compartment where the fire occurs. None leaves it unchanged. fire_id : str or None, optional Name of the fire definition (fuel composition and HRR curve). None leaves it unchanged. location : list[float] or None, optional Position [x, y] of the center of the base of the fire relative to the front left corner of the compartment. Default units: m. None leaves it unchanged. data_table : list[list[float]] or None, optional Time-dependent fire properties: one row per time point, with columns [TIME (s), HRR (kW), HEIGHT (m), AREA (m²), CO_YIELD, SOOT_YIELD, HCN_YIELD, HCL_YIELD, TRACE_YIELD], yields in kg/kg. None leaves it unchanged. carbon : float or None, optional Number of carbon atoms in the fuel molecule. None leaves it unchanged. chlorine : float or None, optional Number of chlorine atoms in the fuel molecule; assumed to completely react to form HCl. None leaves it unchanged. hydrogen : float or None, optional Number of hydrogen atoms in the fuel molecule. None leaves it unchanged. nitrogen : float or None, optional Number of nitrogen atoms in the fuel molecule; assumed to completely react to form HCN. None leaves it unchanged. oxygen : float or None, optional Number of oxygen atoms in the fuel molecule. None leaves it unchanged. heat_of_combustion : float or None, optional The energy released per unit mass of fuel consumed. Default units: kJ/kg. None leaves it unchanged. radiative_fraction : float or None, optional The fraction of the combustion energy that is emitted in the form of thermal radiation. Default units: none. None leaves it unchanged.
Returns
str Confirmation, the updated model summary, and any warnings (for example a fire located outside the compartment footprint).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| carbon | No | ||
| oxygen | No | ||
| comp_id | No | ||
| fire_id | No | ||
| chlorine | No | ||
| hydrogen | No | ||
| location | No | ||
| model_id | Yes | ||
| nitrogen | No | ||
| data_table | No | ||
| heat_of_combustion | No | ||
| radiative_fraction | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |