FireSTARR
Loading...
Searching...
No Matches
fs::FwiWeather Struct Reference

A Weather value with calculated FWI indices. More...

#include <FWI.h>

Inheritance diagram for fs::FwiWeather:
Collaboration diagram for fs::FwiWeather:

Public Member Functions

constexpr FwiWeather (const Weather wx, const Ffmc ffmc, const Dmc dmc, const Dc dc, Isi isi=Isi::Invalid(), Bui bui=Bui::Invalid(), Fwi fwi=Fwi::Invalid()) noexcept
 
constexpr FwiWeather (const Temperature temp, const RelativeHumidity rh, const Wind wind, const Precipitation prec, const Ffmc ffmc, const Dmc dmc, const Dc dc, const Isi isi, const Bui bui, const Fwi fwi) noexcept
 
constexpr FwiWeather (const FwiWeather &yesterday, const int month, const MathSize latitude, const Temperature &temp, const RelativeHumidity &rh, const Wind &wind, const Precipitation &prec, Ffmc ffmc=Ffmc::Invalid(), Dmc dmc=Dmc::Invalid(), Dc dc=Dc::Invalid(), Isi isi=Isi::Invalid(), Bui bui=Bui::Invalid(), Fwi fwi=Fwi::Invalid()) noexcept
 
auto operator<=> (const FwiWeather &rhs) const =default
 
MathSize mcFfmcPct () const
 Moisture content (%) based on Ffmc.
 
MathSize mcDmcPct () const
 Moisture content (%) based on Dmc.
 
MathSize mcFfmc () const
 Moisture content (ratio) based on Ffmc.
 
MathSize mcDmc () const
 Moisture content (ratio) based on Dmc.
 
MathSize ffmcEffect () const
 Ffmc effect used for spread.
 
- Public Member Functions inherited from fs::Weather
auto operator<=> (const Weather &rhs) const =default
 

Static Public Member Functions

static consteval FwiWeather Zero ()
 
static consteval FwiWeather Invalid ()
 
- Static Public Member Functions inherited from fs::Weather
static consteval Weather Zero ()
 
static consteval Weather Invalid ()
 

Public Attributes

Ffmc ffmc {}
 Fine Fuel Moisture Code.
 
Dmc dmc {}
 Duff Moisture Code.
 
Dc dc {}
 Drought Code.
 
Isi isi {}
 Initial Spread Index.
 
Bui bui {}
 Build-up Index.
 
Fwi fwi {}
 Fire Weather Index.
 
- Public Attributes inherited from fs::Weather
Temperature temperature {}
 Temperature (Celsius)
 
RelativeHumidity rh {}
 Relative Humidity (%)
 
Wind wind {}
 Wind (km/h)
 
Precipitation prec {}
 Precipitation (1hr accumulation) (mm)
 

Additional Inherited Members

- Static Public Attributes inherited from fs::Weather
static constexpr auto units
 

Detailed Description

A Weather value with calculated FWI indices.

Member Function Documentation

◆ ffmcEffect()

MathSize fs::FwiWeather::ffmcEffect ( ) const
nodiscard

Ffmc effect used for spread.

Returns
Ffmc effect used for spread

◆ mcDmc()

MathSize fs::FwiWeather::mcDmc ( ) const
nodiscard

Moisture content (ratio) based on Dmc.

Returns
Moisture content (ratio) based on Dmc
Here is the call graph for this function:

◆ mcDmcPct()

MathSize fs::FwiWeather::mcDmcPct ( ) const
nodiscard

Moisture content (%) based on Dmc.

Returns
Moisture content (%) based on Dmc
Here is the caller graph for this function:

◆ mcFfmc()

MathSize fs::FwiWeather::mcFfmc ( ) const
nodiscard

Moisture content (ratio) based on Ffmc.

Returns
Moisture content (ratio) based on Ffmc
Here is the call graph for this function:

◆ mcFfmcPct()

MathSize fs::FwiWeather::mcFfmcPct ( ) const
nodiscard

Moisture content (%) based on Ffmc.

Returns
Moisture content (%) based on Ffmc
Here is the caller graph for this function:

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