Update surface
update_surfaceUpdate an existing general surface by ID, changing only the specified properties such as material layers, color, or thermal behavior. Use it to revise FDS surface definitions without rebuilding them.
Instructions
Update an existing general surface (&SURF) by ID. Only the given fields change. [bulc-mcp rules] SURF-001 — bulc_knowledge_search ""
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Surface ID to update | |
| color | No | Display color as #rrggbb (emitted as RGB=r,g,b) | |
| tau_q | No | TAU_Q [s] — ramp-up time (negative = t² growth) | |
| hrrpua | No | HRRPUA [kW/m²] (manual mode) | |
| layers | No | Material layers, outermost first. Each layer: thickness [m] + material composition (mass fractions summing to 1). | |
| mlrpua | No | MLRPUA [kg/(m²·s)] (manual mode, exclusive with hrrpua) | |
| backing | No | BACKING | |
| ramp_id | No | RAMP_Q id (overrides tau_q) | |
| ignition | No | Burn immediately or ignite at a temperature | |
| tmp_back | No | TMP_BACK [°C] | |
| burn_away | No | BURN_AWAY — allow the obstruction to burn away | |
| cell_size | No | CELL_SIZE [m] — solid-phase cell size | |
| tmp_front | No | TMP_FRONT [°C] — fixed surface temperature | |
| tmp_inner | No | TMP_INNER [°C] | |
| emissivity | No | EMISSIVITY | |
| description | No | Free-text description (FYI) | |
| layer_divide | No | LAYER_DIVIDE | |
| surface_type | No | Surface type ('layered' = PyroSim general surface) | |
| e_coefficient | No | E_COEFFICIENT [m²/(kg·s)] — water extinguishing coefficient | |
| external_flux | No | EXTERNAL_FLUX [kW/m²] | |
| net_heat_flux | No | NET_HEAT_FLUX [kW/m²] | |
| reaction_mode | No | 'material' = burning governed by MATL pyrolysis, 'manual' = governed by HRRPUA/MLRPUA on this surface | |
| droplet_surface | No | Water droplets on this surface (Cartesian OBST/WALL faces only): allow_surface_particles=false removes droplets that land on it (drain floor, slab between floors); allow_underside_particles lets films run under horizontal surfaces; particle_extraction_velocity [m/s] removes films faster than this. | |
| species_injection | No | Species injection rows (SPEC_ID/MASS_FLUX/MASS_FRACTION/VEL/VOLUME_FLOW/TAU_V) | |
| particle_injection | No | Particle injection (PART_ID/PARTICLE_MASS_FLUX/NPPC/DT_INSERT/PARTICLE_SURFACE_DENSITY) | |
| heat_transfer_model | No | HEAT_TRANSFER_MODEL — gas-side convective correlation. 'DEFAULT' omits the key; any other string than these is rejected by FDS. | |
| convective_heat_flux | No | CONVECTIVE_HEAT_FLUX [kW/m²] | |
| heat_of_vaporization | No | HEAT_OF_VAPORIZATION [kJ/kg] | |
| ignition_temperature | No | IGNITION_TEMPERATURE [°C] | |
| droplet_surface_unset | No | droplet_surface keys to remove (FDS default) | |
| heat_transfer_coefficient | No | HEAT_TRANSFER_COEFFICIENT [W/(m²·K)] |