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

A stream of weather that gets used by a Scenario every Iteration. More...

#include <FireWeather.h>

Collaboration diagram for fs::FireWeather:

Public Member Functions

 FireWeather (const set< const FuelType * > &used_fuels, const map< Day, FwiWeather > &data)
 Constructor.
 
 FireWeather (const set< const FuelType * > &used_fuels, Day min_date, Day max_date, vector< FwiWeather > weather_by_hour_by_day)
 
 FireWeather (const FuelType *fuel, const Day start_date, const Dc &dc, const Dmc &dmc, const Ffmc &ffmc, const Wind &wind)
 A Constant weather stream with only one possible fuel.
 
 FireWeather (const set< const FuelType * > &used_fuels, const Day start_date, const Dc &dc, const Dmc &dmc, const Ffmc &ffmc, const Wind &wind)
 
 FireWeather (FireWeather &&rhs)=default
 
 FireWeather (const FireWeather &rhs)=delete
 
FireWeather & operator= (FireWeather &&rhs) noexcept=default
 
FireWeather & operator= (const FireWeather &rhs)=delete
 
ptr< const FwiWeather > at (const DurationSize time) const
 Get FwiWeather for given time.
 
ThresholdSize survivalProbability (const DurationSize time, const FuelCodeSize &in_fuel) const
 Probability of survival in given fuel at given time.
 
constexpr Day minDate () const
 Minimum date present in FireWeather.
 
constexpr Day maxDate () const
 Maximum date present in FireWeather.
 
const vector< ptr< const FwiWeather > > & getWeather ()
 Weather by hour by day.
 

Protected Member Functions

 FireWeather (const set< const FuelType * > &used_fuels, Day min_date, Day max_date, vector< ptr< const FwiWeather > > &&weather_by_hour_by_day)
 Constructor.
 

Private Attributes

vector< ptr< const FwiWeather > > weather_by_hour_by_day_ {}
 FwiWeather by hour by Day.
 
SurvivalMap survival_probability_ {}
 Probability of survival for fuels fuel at each time.
 
Day min_date_
 Minimum date present in stream.
 
Day max_date_
 Maximum date present in stream.
 

Detailed Description

A stream of weather that gets used by a Scenario every Iteration.

Constructor & Destructor Documentation

◆ FireWeather() [1/3]

fs::FireWeather::FireWeather ( const set< const FuelType * > & used_fuels,
const map< Day, FwiWeather > & data )

Constructor.

Parameters
used_fuelsset of FuelTypes that are used in the simulation
datamap of Day to FwiWeather to use for weather stream with diurnal formula

◆ FireWeather() [2/3]

fs::FireWeather::FireWeather ( const FuelType * fuel,
const Day start_date,
const Dc & dc,
const Dmc & dmc,
const Ffmc & ffmc,
const Wind & wind )

A Constant weather stream with only one possible fuel.

Parameters
fuelFuel to use
start_dateStart date for stream
dcDrought Code
buiBuild-up Index
dmcDuff Moisture Code
ffmcFine Fuel Moisture Code
windWind

◆ FireWeather() [3/3]

fs::FireWeather::FireWeather ( const set< const FuelType * > & used_fuels,
Day min_date,
Day max_date,
vector< ptr< const FwiWeather > > && weather_by_hour_by_day )
protected

Constructor.

Parameters
used_fuelsset of FuelTypes that are used in the simulation
min_dateMinimum date present in stream
max_dateMaximum date present in stream
weather_by_hour_by_dayFwiWeather by hour by Day

Member Function Documentation

◆ at()

ptr< const FwiWeather > fs::FireWeather::at ( const DurationSize time) const
nodiscard

Get FwiWeather for given time.

Parameters
timeTime to get weather for
Returns
FwiWeather for given time

◆ getWeather()

const vector< ptr< const FwiWeather > > & fs::FireWeather::getWeather ( )
inlinenodiscard

Weather by hour by day.

Returns
Weather by hour by day

◆ maxDate()

Day fs::FireWeather::maxDate ( ) const
inlinenodiscardconstexpr

Maximum date present in FireWeather.

Returns
Maximum date present in FireWeather

◆ minDate()

Day fs::FireWeather::minDate ( ) const
inlinenodiscardconstexpr

Minimum date present in FireWeather.

Returns
Minimum date present in FireWeather

◆ survivalProbability()

ThresholdSize fs::FireWeather::survivalProbability ( const DurationSize time,
const FuelCodeSize & in_fuel ) const
nodiscard

Probability of survival in given fuel at given time.

Parameters
timeTime to get survival probability for
in_fuelFuelCodeSize of FuelType to use
Returns
Probability of survival in given fuel at given time

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