add_fire
Add a time-dependent fire to an existing compartment in a CFAST fire model, including HRR, location, and fuel composition.
Instructions
Add a fire to a compartment of a model.
A fire in CFAST is specified via a time-dependent heat release rate (HRR). The compartment comp_id must already exist in the model. Fire properties are linearly interpolated between specified time points; if the simulation time is longer than the total duration of the fire, the final values are continued until the end of the simulation.
Parameters
model_id : str Id of the model to modify. id : str Unique name of the fire instance. comp_id : str Name of the compartment where the fire occurs. fire_id : str Unique name of the fire definition (fuel composition and HRR curve). May be the same as id. location : list[float] Position [x, y] of the center of the base of the fire relative to the front left corner of the compartment. Default units: m. data_table : list[list[float]] 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. Example for a fire growing to 1000 kW at 300 s: [[0, 0, 0, 0.3, 0.005, 0.02, 0, 0, 0], [300, 1000, 0, 0.3, 0.005, 0.02, 0, 0, 0]]. carbon : float, optional Number of carbon atoms in the fuel molecule. Default value: 1. chlorine : float, optional Number of chlorine atoms in the fuel molecule; assumed to completely react to form HCl. Default value: 0. hydrogen : float, optional Number of hydrogen atoms in the fuel molecule. Default value: 4. nitrogen : float, optional Number of nitrogen atoms in the fuel molecule; assumed to completely react to form HCN. Default value: 0. oxygen : float, optional Number of oxygen atoms in the fuel molecule. Default value: 0. heat_of_combustion : float, optional The energy released per unit mass of fuel consumed. Default units: kJ/kg, default value: 50000 kJ/kg. radiative_fraction : float, optional The fraction of the combustion energy that is emitted in the form of thermal radiation. Default units: none, default value: 0.35.
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 | Yes | ||
| fire_id | Yes | ||
| chlorine | No | ||
| hydrogen | No | ||
| location | Yes | ||
| model_id | Yes | ||
| nitrogen | No | ||
| data_table | Yes | ||
| heat_of_combustion | No | ||
| radiative_fraction | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |