Represents a map of intensities that cells have burned at for a single Scenario.
More...
#include <IntensityMap.h>
|
|
mutex | mutex_ {} |
| | Mutex for parallel access.
|
| |
|
const Model & | model_ |
| | Model map is for.
|
| |
|
GridMap< IntensitySize > | intensity_max_ {} |
| |
|
std::optional< GridMap< MathSize > > | rate_of_spread_at_max_ {} |
| |
|
std::optional< GridMap< DegreesSize > > | direction_of_spread_at_max_ {} |
| |
|
BurnedData | is_burned_ {} |
| |
Represents a map of intensities that cells have burned at for a single Scenario.
◆ IntensityMap()
| fs::IntensityMap::IntensityMap |
( |
const Model & | model | ) |
|
|
explicitnoexcept |
Constructor.
- Parameters
-
| model | Model to use extent from |
◆ applyPerimeter()
| void fs::IntensityMap::applyPerimeter |
( |
const Perimeter & | perimeter | ) |
|
|
noexcept |
Set cells in the map to be burned based on Perimeter.
- Parameters
-
◆ burn()
| void fs::IntensityMap::burn |
( |
const XYIdx & | location, |
|
|
IntensitySize | intensity, |
|
|
MathSize | ros, |
|
|
fs::Direction | raz ) |
Update Location with specified values.
- Parameters
-
| location | Location to burn |
| intensity | Intensity to burn with (kW/m) |
| ros | Rate of spread to check against maximu (m/min) |
| raz | Spread azimuth for ros |
◆ cbegin()
| map< XYIdx, IntensitySize >::const_iterator fs::IntensityMap::cbegin |
( |
| ) |
const |
|
nodiscardnoexcept |
Iterator for underlying GridMap.
- Returns
- Iterator for underlying GridMap
◆ cend()
| map< XYIdx, IntensitySize >::const_iterator fs::IntensityMap::cend |
( |
| ) |
const |
|
nodiscardnoexcept |
Iterator for underlying GridMap.
- Returns
- Iterator for underlying GridMap
◆ fireSize()
| MathSize fs::IntensityMap::fireSize |
( |
| ) |
const |
|
inlinenodiscard |
Size of the fire represented by this.
- Returns
- Size of the fire represented by this
◆ save()
| FileList fs::IntensityMap::save |
( |
const string_view | dir, |
|
|
const string_view | base_name ) const |
|
nodiscard |
Save contents to file.
- Parameters
-
| dir | Directory to save to |
| base_name | Base file name to save to |
- Returns
- FileList of file names saved to
The documentation for this class was generated from the following files: