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

Information regarding spread within a Cell for a specific Scenario and time. More...

#include <FireSpread.h>

Collaboration diagram for fs::SpreadInfo:

Public Member Functions

 SpreadInfo (const Scenario &scenario, DurationSize time, const SpreadKey &key, int nd, const ptr< const FwiWeather > weather)
 
constexpr SpreadInfo (SpreadInfo &&rhs) noexcept=default
 
 SpreadInfo (const SpreadInfo &rhs) noexcept=default
 
constexpr SpreadInfo & operator= (SpreadInfo &&rhs) noexcept=default
 
SpreadInfo & operator= (const SpreadInfo &rhs) noexcept=default
 
MathSize maxIntensity () const noexcept
 Maximum intensity in any direction for spread (kW/m)
 
const OffsetSet & offsets () const
 Offsets from origin point that represent spread under these conditions.
 
constexpr bool isNotSpreading () const
 Whether or not there is no spread.
 
constexpr int nd () const
 Difference between date and the date of minimum foliar moisture content.
 
constexpr DurationSize time () const
 Time used for spread.
 
constexpr MathSize lengthToBreadth () const
 Length to breadth ratio used for spread.
 
constexpr SlopeSize percentSlope () const
 Slope used for spread (%)
 
constexpr AspectSize slopeAzimuth () const
 Aspect used for spread (degrees)
 
constexpr MathSize headRos () const
 Head fire rate of spread (m/min)
 
constexpr Direction headDirection () const
 Head fire spread direction.
 
constexpr MathSize slopeFactor () const
 Slope factor calculated from percent slope.
 
double foliarMoisture () const
 Calculate foliar moisture.
 
constexpr bool isInvalid () const
 Whether or not there is no spread for given conditions.
 
 SpreadInfo (const YearSize year, const int month, const int day, const int hour, const int minute, const Point &start_point, const ElevationSize elevation, const SlopeSize slope, const AspectSize aspect, const char *fuel_name, const ptr< const FwiWeather > weather)
 
 SpreadInfo (const tm &start_date, const Point &start_point, const ElevationSize elevation, const SlopeSize slope, const AspectSize aspect, const char *fuel_name, const ptr< const FwiWeather > weather)
 
MathSize crownFractionBurned () const
 
MathSize crownFuelConsumption () const
 
char fireDescription () const
 
MathSize surfaceFuelConsumption () const
 
MathSize totalFuelConsumption () const
 

Static Public Member Functions

static double foliarMoisture (int nd)
 Calculate foliar moisture.
 

Public Attributes

ptr< const FwiWeather > weather {nullptr}
 FwiWeather determining spread.
 
Direction raz_ {Direction::Invalid()}
 Head fire spread direction.
 

Static Public Attributes

static const SlopeTableArray SlopeTable = make_slope_table()
 Lookup table for Slope Factor calculated from Percent Slope.
 

Private Member Functions

 SpreadInfo (const Scenario &scenario, DurationSize time, const SpreadKey &key, int nd, const ptr< const FwiWeather > weather, const ptr< const FwiWeather > weather_daily)
 Calculate fire spread for time and place.
 
 SpreadInfo (DurationSize time, MathSize min_ros, MathSize cell_size, const SlopeSize slope, const AspectSize aspect, const char *fuel_name, int nd, const ptr< const FwiWeather > weather)
 
 SpreadInfo (DurationSize time, MathSize min_ros, MathSize cell_size, const SpreadKey &key, int nd, const ptr< const FwiWeather > weather)
 
 SpreadInfo (DurationSize time, MathSize min_ros, MathSize cell_size, const SpreadKey &key, int nd, const ptr< const FwiWeather > weather, const ptr< const FwiWeather > weather_daily)
 

Static Private Member Functions

static MathSize initial (SpreadInfo &spread, const FwiWeather &weather, MathSize &ffmc_effect, MathSize &wsv, MathSize &rso, const FuelType *const fuel, bool has_no_slope, MathSize heading_sin, MathSize heading_cos, MathSize bui_eff, MathSize min_ros, MathSize critical_surface_intensity)
 

Private Attributes

OffsetSet offsets_ {}
 Offsets from origin point that represent spread under these conditions.
 
MathSize max_intensity_ = INVALID_INTENSITY
 Maximum intensity in any direction for spread (kW/m)
 
SpreadKey key_ = 0
 Attributes for Cell spread is occurring in.
 
DurationSize time_ = -1
 Time that spread is occurring.
 
MathSize l_b_ = -1
 
MathSize head_ros_ = INVALID_ROS
 Head fire rate of spread (m/min)
 
MathSize cfb_ = -1
 
MathSize cfc_ = -1
 
MathSize tfc_ = -1
 
MathSize sfc_ = -1
 
bool is_crown_ = false
 
int nd_ = -1
 Difference between date and the date of minimum foliar moisture content (from ST-X-3)
 

Detailed Description

Information regarding spread within a Cell for a specific Scenario and time.

Constructor & Destructor Documentation

◆ SpreadInfo() [1/2]

fs::SpreadInfo::SpreadInfo ( const Scenario & scenario,
DurationSize time,
const SpreadKey & key,
int nd,
const ptr< const FwiWeather > weather,
const ptr< const FwiWeather > weather_daily )
private

Calculate fire spread for time and place.

Parameters
scenarioScenario this is spreading in
timeTime spread is occurring
keyAttributes for Cell spread is occurring in
ndDifference between date and the date of minimum foliar moisture content DurationSize timether FwiWeather to use for calculations
weather_dailyFwiWeather to use for spread event probability

◆ SpreadInfo() [2/2]

fs::SpreadInfo::SpreadInfo ( DurationSize time,
MathSize min_ros,
MathSize cell_size,
const SlopeSize slope,
const AspectSize aspect,
const char * fuel_name,
int nd,
const ptr< const FwiWeather > weather )
private

Actual fire spread calculation without needing to worry about settings or scenarios

Member Function Documentation

◆ foliarMoisture() [1/2]

double fs::SpreadInfo::foliarMoisture ( ) const
inlinenodiscard

Calculate foliar moisture.

Returns
Calculated foliar moisture
Here is the call graph for this function:
Here is the caller graph for this function:

◆ foliarMoisture() [2/2]

static double fs::SpreadInfo::foliarMoisture ( int nd)
inlinestaticnodiscard

Calculate foliar moisture.

Returns
Calculated foliar moisture
Here is the call graph for this function:

◆ headDirection()

Direction fs::SpreadInfo::headDirection ( ) const
inlinenodiscardconstexpr

Head fire spread direction.

Returns
Head fire spread direction

◆ headRos()

MathSize fs::SpreadInfo::headRos ( ) const
inlinenodiscardconstexpr

Head fire rate of spread (m/min)

Returns
Head fire rate of spread (m/min)

◆ initial()

MathSize fs::SpreadInfo::initial ( SpreadInfo & spread,
const FwiWeather & weather,
MathSize & ffmc_effect,
MathSize & wsv,
MathSize & rso,
const FuelType *const fuel,
bool has_no_slope,
MathSize heading_sin,
MathSize heading_cos,
MathSize bui_eff,
MathSize min_ros,
MathSize critical_surface_intensity )
staticprivate

Do initial spread calculations

Returns
Initial head ros calculation (-1 for none)
Here is the call graph for this function:

◆ isInvalid()

bool fs::SpreadInfo::isInvalid ( ) const
inlinenodiscardconstexpr

Whether or not there is no spread for given conditions.

Returns
Whether or not there is no spread for given conditions
Here is the caller graph for this function:

◆ isNotSpreading()

bool fs::SpreadInfo::isNotSpreading ( ) const
inlinenodiscardconstexpr

Whether or not there is no spread.

Returns
Whether or not there is no spread
Here is the call graph for this function:

◆ lengthToBreadth()

MathSize fs::SpreadInfo::lengthToBreadth ( ) const
inlinenodiscardconstexpr

Length to breadth ratio used for spread.

Returns
Length to breadth ratio used for spread

◆ maxIntensity()

MathSize fs::SpreadInfo::maxIntensity ( ) const
inlinenodiscardnoexcept

Maximum intensity in any direction for spread (kW/m)

Returns
Maximum intensity in any direction for spread (kW/m)

◆ nd()

int fs::SpreadInfo::nd ( ) const
inlinenodiscardconstexpr

Difference between date and the date of minimum foliar moisture content.

Returns
Difference between date and the date of minimum foliar moisture content
Here is the caller graph for this function:

◆ offsets()

const OffsetSet & fs::SpreadInfo::offsets ( ) const
inlinenodiscard

Offsets from origin point that represent spread under these conditions.

Returns
Offsets from origin point that represent spread under these conditions

◆ percentSlope()

SlopeSize fs::SpreadInfo::percentSlope ( ) const
inlinenodiscardconstexpr

Slope used for spread (%)

Returns
Slope used for spread (%)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ slopeAzimuth()

AspectSize fs::SpreadInfo::slopeAzimuth ( ) const
inlinenodiscardconstexpr

Aspect used for spread (degrees)

Returns
Aspect used for spread (degrees)
Here is the call graph for this function:

◆ slopeFactor()

MathSize fs::SpreadInfo::slopeFactor ( ) const
inlinenodiscardconstexpr

Slope factor calculated from percent slope.

Returns
Slope factor calculated from percent slope
Here is the call graph for this function:

◆ time()

DurationSize fs::SpreadInfo::time ( ) const
inlinenodiscardconstexpr

Time used for spread.

Returns
Time used for spread

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