A stream of weather that gets used by a Scenario every Iteration.
More...
#include <FireWeather.h>
|
| | 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.
|
| |
|
| | FireWeather (const set< const FuelType * > &used_fuels, Day min_date, Day max_date, vector< ptr< const FwiWeather > > &&weather_by_hour_by_day) |
| | Constructor.
|
| |
|
|
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.
|
| |
A stream of weather that gets used by a Scenario every Iteration.
◆ FireWeather() [1/3]
| fs::FireWeather::FireWeather |
( |
const set< const FuelType * > & | used_fuels, |
|
|
const map< Day, FwiWeather > & | data ) |
Constructor.
- Parameters
-
| used_fuels | set of FuelTypes that are used in the simulation |
| data | map 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
-
| fuel | Fuel to use |
| start_date | Start date for stream |
| dc | Drought Code |
| bui | Build-up Index |
| dmc | Duff Moisture Code |
| ffmc | Fine Fuel Moisture Code |
| wind | Wind |
◆ 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_fuels | set of FuelTypes that are used in the simulation |
| min_date | Minimum date present in stream |
| max_date | Maximum date present in stream |
| weather_by_hour_by_day | FwiWeather by hour by Day |
◆ at()
| ptr< const FwiWeather > fs::FireWeather::at |
( |
const DurationSize | time | ) |
const |
|
nodiscard |
Get FwiWeather for given time.
- Parameters
-
| time | Time to get weather for |
- Returns
- FwiWeather for given time
◆ getWeather()
| const vector< ptr< const FwiWeather > > & fs::FireWeather::getWeather |
( |
| ) |
|
|
inlinenodiscard |
◆ maxDate()
| Day fs::FireWeather::maxDate |
( |
| ) |
const |
|
inlinenodiscardconstexpr |
◆ minDate()
| Day fs::FireWeather::minDate |
( |
| ) |
const |
|
inlinenodiscardconstexpr |
◆ survivalProbability()
| ThresholdSize fs::FireWeather::survivalProbability |
( |
const DurationSize | time, |
|
|
const FuelCodeSize & | in_fuel ) const |
|
nodiscard |
Probability of survival in given fuel at given time.
- Parameters
-
| time | Time to get survival probability for |
| in_fuel | FuelCodeSize 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: