Add device
add_deviceAdd a measurement device to fire simulations with full parameter support: point/region quantities, species, statistics, and trip options.
Instructions
Add a measurement device (&DEVC) with full parameter support: point (xyz) or region (xb) quantities, species, statistics, trip options (setpoint/latch/initial_state/trip_direction), post-processing, aspiration, HVAC and particle quantities. Provide xyz for point quantities or xb for flow/HRR/layer/beam/statistics. [bulc-mcp rules] DEVC-001, DEVC-003, DEVC-004 — bulc_knowledge_search ""
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Unique device ID | |
| xb | No | Region [x1,x2,y1,y2,z1,z2] — plane for flow, box for HRR/statistics, segment for beam, column for layer | |
| ior | No | Wall direction for solid quantities: ±1(X) ±2(Y) ±3(Z) | |
| xbp | No | Line endpoints for points>1: [x1,x2,y1,y2,z1,z2] | |
| xyz | No | Point position [x,y,z] (m) | |
| delay | No | Aspiration transport delay (s) | |
| depth | No | DEPTH (m) for INSIDE WALL TEMPERATURE | |
| latch | No | false → re-trips allowed (LATCH=.FALSE.; default true) | |
| output | No | false → omit column from devc.csv (control-only device) | |
| points | No | >1 → expand XBP line into N point devices (ID-01..) | |
| ctrl_id | No | CTRL reference (required for QUANTITY=CONTROL / CONTROL VALUE) | |
| devc_id | No | ASPIRATION unit id (for sampling points) | |
| duct_id | No | HVAC duct id (DUCT quantities) | |
| node_id | No | HVAC node id(s) — 2 for NODE PRESSURE DIFFERENCE | |
| part_id | No | Particle class for MPUV/ADD/AMPUA etc. | |
| prop_id | No | PROP model reference (detector/sprinkler properties) | |
| spec_id | No | Species: OXYGEN, CARBON DIOXIDE, CARBON MONOXIDE, SOOT, WATER VAPOR, or fuel name | |
| flowrate | No | Aspiration sampling flowrate (>0) | |
| quantity | Yes | FDS QUANTITY (e.g. TEMPERATURE, VOLUME FRACTION, MASS FLOW +, LAYER HEIGHT, PATH OBSCURATION, HRR, CONTROL) | |
| relative | No | Subtract first output value | |
| rotation | No | Rotation about orientation axis (deg) | |
| setpoint | No | Trip threshold (device acts as trigger when crossed) | |
| quantity2 | No | Second quantity for COV/CORRCOEF | |
| pipe_index | No | Sprinkler pipe group (default 1) | |
| orientation | No | Sensor direction vector (default 0,0,-1) | |
| initial_state | No | Start in tripped state (INITIAL_STATE) | |
| absolute_value | No | Output |x| | |
| quantity_range | No | Value gate [min,max] for integral statistics | |
| smoothing_time | No | Smoothing time constant (s, overrides factor) | |
| trip_direction | No | +1 ascending (default) / -1 descending crossing | |
| bypass_flowrate | No | Aspiration unit bypass flowrate | |
| smoothing_factor | No | Exponential smoothing 0..1 | |
| conversion_addend | No | Output = factor*x + addend (default 0) | |
| conversion_factor | No | Output = factor*x + addend (default 1) | |
| no_update_devc_id | No | Freeze this output when the referenced device trips | |
| spatial_statistic | No | MEAN, MAX, MIN, VOLUME MEAN/INTEGRAL, MASS MEAN/INTEGRAL, AREA INTEGRAL, SUM, VOLUME, MASS (needs xb) | |
| temporal_statistic | No | TIME AVERAGE, RUNNING AVERAGE, MAX, MIN, MAX TIME, MIN TIME, TIME INTEGRAL, RMS, COV, CORRCOEF, SMOOTHED |