fs::sim::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::sim::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	rows () const
	Number of rows in this extent.
Idx	columns () const
	Number of columns in this extent.
void	applyPerimeter (const topo::Perimeter &perimeter) noexcept
	Set cells in the map to be burned based on Perimeter.
bool	canBurn (const Location &location) const
	Whether or not the Cell with the given hash can burn.
template<class P >
bool	canBurn (const Position< P > &position) const
bool	hasBurned (const Location &location) const
	Whether or not the Location with the given hash can burn.
template<class P >
bool	hasBurned (const Position< P > &position) const
bool	isSurrounded (const Location &location) const
	Whether or not all Locations surrounding the given Location are burned.
template<class P >
bool	isSurrounded (const Position< P > &position) const
void	ignite (const Location &location)
	Mark given location as burned.
template<class P >
void	ignite (const Position< P > &position)
void	burn (const Location &location)
	Update Location with specified values.
template<class P >
void	burn (const Position< P > &position)
MathSize	fireSize () const
	Size of the fire represented by this.
map< Location, IntensitySize >::const_iterator	cbegin () const noexcept
	Iterator for underlying GridMap.
map< Location, 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.
unique_ptr< data::GridMap< IntensitySize > >	intensity_max_
	Map of intensity that cells have burned at.
BurnedData *	is_burned_
	bitset denoting cells that can no longer burn

Detailed Description

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

Constructor & Destructor Documentation

IntensityMap()

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

explicitnoexcept

Constructor.

Parameters

model

Model to use extent from

Member Function Documentation

applyPerimeter()

void fs::sim::IntensityMap::applyPerimeter ( const topo::Perimeter & perimeter )

noexcept

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

Parameters

perimeter

Perimeter to burn cells based on

burn()

void fs::sim::IntensityMap::burn

(

const Location &

location

)

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

Here is the call graph for this function:

Here is the caller graph for this function:

canBurn()

bool fs::sim::IntensityMap::canBurn ( const Location & location ) const

nodiscard

Whether or not the Cell with the given hash can burn.

Parameters

hash	Hash for Cell to check

Returns

Whether or not the Cell with the given hash can burn

Here is the call graph for this function:

cbegin()

map< Location, IntensitySize >::const_iterator fs::sim::IntensityMap::cbegin ( ) const

nodiscardnoexcept

Iterator for underlying GridMap.

Returns

Iterator for underlying GridMap

Here is the caller graph for this function:

cend()

map< Location, IntensitySize >::const_iterator fs::sim::IntensityMap::cend ( ) const

nodiscardnoexcept

Iterator for underlying GridMap.

Returns

Iterator for underlying GridMap

Here is the caller graph for this function:

columns()

Idx fs::sim::IntensityMap::columns ( ) const

inlinenodiscard

Number of columns in this extent.

Returns

Number of columns in this extent

Here is the caller graph for this function:

fireSize()

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

nodiscard

Size of the fire represented by this.

Returns

Size of the fire represented by this

Here is the caller graph for this function:

hasBurned()

bool fs::sim::IntensityMap::hasBurned ( const Location & location ) const

nodiscard

Whether or not the Location with the given hash can burn.

Parameters

hash	Hash for Location to check

Returns

Whether or not the Location with the given hash can burn

Here is the call graph for this function:

Here is the caller graph for this function:

ignite()

void fs::sim::IntensityMap::ignite

(

const Location &

location

)

Mark given location as burned.

Parameters

location

Location to burn

Here is the call graph for this function:

isSurrounded()

bool fs::sim::IntensityMap::isSurrounded ( const Location & location ) const

nodiscard

Whether or not all Locations surrounding the given Location are burned.

Parameters

location

Location to check

Returns

Whether or not all Locations surrounding the given Location are burned

Here is the call graph for this function:

rows()

Idx fs::sim::IntensityMap::rows ( ) const

inlinenodiscard

Number of rows in this extent.

Returns

Number of rows in this extent

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• firestarr/src/cpp/IntensityMap.h
• firestarr/src/cpp/IntensityMap.cpp