You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/source/reference/commands.rst
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -135,7 +135,7 @@ Creates the smallest possible triangular fire front (an ignition point) at the s
135
135
**Arguments:**
136
136
137
137
* ``loc=(x,y,z)``: Starting location using Cartesian coordinates (x,y,z) in meters.
138
-
* ``lonlat=(lon,lat)``: Starting location using WGS84 coordinates (longitude, latitude). *Use either ``loc`` or ``lonlat``.*
138
+
* ``lonlat=(lon,lat)``: Starting location using WGS84 coordinates (longitude, latitude). *Use either loc or lonlat.*
139
139
* ``t=seconds|date=YYYY-MM-DDTHH:MM:SSZ``: Time when the fire is started, either in seconds since simulation start or as an absolute ISO 8601 GMT date/time.
140
140
141
141
**Example:**
@@ -344,7 +344,7 @@ Triggers a change in simulation data at a specific time and location. Can be use
344
344
345
345
Prints a representation of the current simulation state (primarily the fire front location) to the console or to a specified file. The output format is determined by the `dumpMode` parameter (set via `setParameter`).
346
346
347
-
**Output Formats (`dumpMode`):**
347
+
**Output Formats (dumpMode):**
348
348
349
349
* `ff`: Native format, potentially re-parsable by ForeFire.
* ForeFire uses an **event-driven** approach. Instead of fixed time steps for the entire simulation, it maintains a `TimeTable` (a prioritized queue) of future events.
26
26
* Each event typically corresponds to a `FireNode` needing an update at a specific future time.
27
27
* The `Simulator` processes events from the `TimeTable` in chronological order. It retrieves the next event, tells the associated object (like a `FireNode`) to update its state and calculate its next move, and then the object schedules its *next* update event back into the `TimeTable`.
28
28
* **This event-driven approach means the simulation doesn't use fixed global time steps; different parts of the front can advance according to their own calculated timings.**
29
29
30
-
* **`FireDomain` (The Simulation World)**
30
+
* **FireDomain (The Simulation World)**
31
31
32
32
* Represents the overall simulation area and context.
33
33
* Manages the simulation's current time.
@@ -37,7 +37,7 @@ The simulation engine relies on several key C++ components (classes) to manage t
37
37
* Manages the `TimeTable` of simulation events.
38
38
* May handle discretization of the domain into cells (e.g., for flux calculations or burning map outputs).
39
39
40
-
* **`FireFront` & `FireNode` (Representing the Fire)**
40
+
* **FireFront & FireNode (Representing the Fire)**
41
41
42
42
* ForeFire uses a **Lagrangian** approach to track the fire's edge.
43
43
* A `FireFront` represents a continuous segment of the fire perimeter. It is essentially a linked list of `FireNode` objects.
@@ -55,7 +55,7 @@ The simulation engine relies on several key C++ components (classes) to manage t
55
55
* **Splitting:** Not explicitly mentioned in summary, but might occur if front self-intersects or hits complex boundaries.
56
56
* **Inner Fronts:** `FireFront` s can be nested to represent unburned islands within the main fire perimeter.
* The `DataBroker` is the central hub for all environmental data needed by the simulation (terrain, fuel, weather).
61
61
* It manages a collection of `DataLayer` objects. Each `DataLayer` provides access to a specific type of data (e.g., elevation, fuel index, wind speed).
@@ -69,13 +69,13 @@ The simulation engine relies on several key C++ components (classes) to manage t
69
69
* Interpolating data in space and potentially time (e.g., for time-varying wind fields).
70
70
* When a `FireNode` needs environmental data to calculate its speed, it asks the `DataBroker`, which efficiently retrieves the necessary values from the relevant `DataLayer` (s) at the node's location.
71
71
72
-
* **`PropagationModel` & `FluxModel` (The Physics)**
72
+
* **PropagationModel & FluxModel (The Physics)**
73
73
74
74
* ForeFire uses a **Strategy pattern** for physical calculations, allowing different models to be plugged in.
75
75
* `PropagationModel` subclasses (e.g., `Rothermel`, `Balbi`, `Iso`) implement specific algorithms to calculate the Rate of Spread (ROS) based on properties fetched via the `DataBroker`. The active model is chosen using the :ref:`propagationModel <param-propagationmodel>` parameter.
76
76
* `FluxModel` subclasses (e.g., `HeatFluxBasicModel`) calculate fluxes (like heat, water vapor) from the burning area, often needed for coupled simulations or specific research outputs.
77
77
78
-
* **`SimulationParameters` (Configuration)**
78
+
* **SimulationParameters (Configuration)**
79
79
80
80
* A central place (likely a Singleton class internally) holding the global configuration values set by the user via :ref:`setParameter <cmd-setparameter>` or :ref:`setParameters <cmd-setparameters>` commands. This includes things like model choices, resolution parameters, output settings, etc.
81
81
@@ -88,10 +88,10 @@ Simulation Workflow Summary
88
88
* Commands from a script file (or interactive input) are processed.
89
89
* :doc:`Parameters </reference/parameters>` are set.
90
90
* The :ref:`FireDomain <cmd-firedomain>` is created.
91
-
* :ref:`loadData <cmd-loaddata>` populates the `DataBroker` with `DataLayer`s from the :doc:`/user_guide/landscape_file`. The :doc:`/user_guide/fuels_file` information is associated.
91
+
* :ref:`loadData <cmd-loaddata>` populates the `DataBroker` with `DataLayer` from the :doc:`/user_guide/landscape_file`. The :doc:`/user_guide/fuels_file` information is associated.
92
92
* The initial fire state is defined using :ref:`startFire <cmd-startfire>` or custom `FireFront`/`FireNode` commands, scheduling the first update events for the initial nodes into the `TimeTable`.
93
93
94
-
2. **Simulation Loop (driven by `step` or `goTo`):**
94
+
2. **Simulation Loop (driven by step or goTo):**
95
95
96
96
* The `Simulator` gets the chronologically next event (usually a `FireNode` update) from the `TimeTable`.
97
97
* The `Simulator` advances the global simulation time to the event time.
0 commit comments