FireSTARR
Loading...
Searching...
No Matches
fs::IntensityMap Class Reference

Represents a map of intensities that cells have burned at for a single Scenario. More...

#include <IntensityMap.h>

Collaboration diagram for fs::IntensityMap:

Public Member Functions

 IntensityMap (const Model &model) noexcept
 Constructor.
 
 IntensityMap (const IntensityMap &rhs)
 
 IntensityMap (IntensityMap &&rhs)=delete
 
IntensityMap & operator= (const IntensityMap &rhs)=delete
 
IntensityMap & operator= (IntensityMap &&rhs) noexcept=delete
 
Idx height () const
 
Idx width () const
 
void applyPerimeter (const Perimeter &perimeter) noexcept
 Set cells in the map to be burned based on Perimeter.
 
bool canBurn (const XYIdx &location) const
 
bool hasBurned (const XYIdx &location) const
 
bool isSurrounded (const XYIdx &location) const
 
void ignite (const XYIdx &location)
 
void burn (const XYIdx &location, IntensitySize intensity, MathSize ros, fs::Direction raz)
 Update Location with specified values.
 
FileList save (const string_view dir, const string_view base_name) const
 Save contents to file.
 
MathSize fireSize () const
 Size of the fire represented by this.
 
map< XYIdx, IntensitySize >::const_iterator cbegin () const noexcept
 Iterator for underlying GridMap.
 
map< XYIdx, IntensitySize >::const_iterator cend () const noexcept
 Iterator for underlying GridMap.
 

Private Attributes

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_ {}
 

Detailed Description

Represents a map of intensities that cells have burned at for a single Scenario.

Constructor & Destructor Documentation

◆ IntensityMap()

fs::IntensityMap::IntensityMap ( const Model & model)
explicitnoexcept

Constructor.

Parameters
modelModel to use extent from

Member Function Documentation

◆ applyPerimeter()

void fs::IntensityMap::applyPerimeter ( const Perimeter & perimeter)
noexcept

Set cells in the map to be burned based on Perimeter.

Parameters
perimeterPerimeter to burn cells based on

◆ burn()

void fs::IntensityMap::burn ( const XYIdx & location,
IntensitySize intensity,
MathSize ros,
fs::Direction raz )

Update Location with specified values.

Parameters
locationLocation to burn
intensityIntensity to burn with (kW/m)
rosRate of spread to check against maximu (m/min)
razSpread azimuth for ros
Here is the call graph for this function:

◆ cbegin()

map< XYIdx, IntensitySize >::const_iterator fs::IntensityMap::cbegin ( ) const
nodiscardnoexcept

Iterator for underlying GridMap.

Returns
Iterator for underlying GridMap
Here is the caller graph for this function:

◆ cend()

map< XYIdx, IntensitySize >::const_iterator fs::IntensityMap::cend ( ) const
nodiscardnoexcept

Iterator for underlying GridMap.

Returns
Iterator for underlying GridMap
Here is the caller graph for this function:

◆ fireSize()

MathSize fs::IntensityMap::fireSize ( ) const
inlinenodiscard

Size of the fire represented by this.

Returns
Size of the fire represented by this
Here is the call graph for this function:

◆ save()

FileList fs::IntensityMap::save ( const string_view dir,
const string_view base_name ) const
nodiscard

Save contents to file.

Parameters
dirDirectory to save to
base_nameBase file name to save to
Returns
FileList of file names saved to
Here is the call graph for this function:

The documentation for this class was generated from the following files: