FireSTARR
Loading...
Searching...
No Matches
fs::wx::Ffmc Class Reference

Fine Fuel Moisture Code value. More...

#include <FWI.h>

Inheritance diagram for fs::wx::Ffmc:
Collaboration diagram for fs::wx::Ffmc:

Public Member Functions

 Ffmc (const Temperature &temperature, const RelativeHumidity &rh, const Speed &ws, const Precipitation &prec, const Ffmc &ffmc_previous) noexcept
 Calculate Fine Fuel Moisture Code.
 
- Public Member Functions inherited from fs::data::Index< T >
 ~Index ()=default
 Destructor.
 
constexpr Index () noexcept
 Construct with a value of 0.
 
constexpr Index (const MathSize value) noexcept
 Construct with given value.
 
constexpr Index (Index< T > &&rhs) noexcept=default
 Move constructor.
 
constexpr Index (const Index< T > &rhs) noexcept=default
 Copy constructor.
 
Index< T > & operator= (Index< T > &&rhs) noexcept=default
 Move assignment.
 
Index< T > & operator= (const Index< T > &rhs) noexcept=default
 Copy assignment.
 
constexpr bool operator== (const Index< T > &rhs) const noexcept
 Equality operator.
 
constexpr bool operator!= (const Index< T > &rhs) const noexcept
 Not equals operator.
 
constexpr MathSize asValue () const noexcept
 Returns value as a MathSize.
 
constexpr bool operator< (const Index< T > rhs) const noexcept
 Less than operator.
 
constexpr bool operator> (const Index< T > rhs) const noexcept
 Greater than operator.
 
constexpr bool operator<= (const Index< T > rhs) const noexcept
 Less than or equal to operator.
 
constexpr bool operator>= (const Index< T > rhs) const noexcept
 Greater than or equal to operator.
 
constexpr Index< T > operator+ (const Index< T > rhs) const noexcept
 Addition operator.
 
constexpr Index< T > operator- (const Index< T > rhs) const noexcept
 Subtraction operator.
 
constexpr Index< T > & operator+= (const Index< T > rhs) noexcept
 Addition assignment operator.
 
constexpr Index< T > & operator-= (const Index< T > rhs) noexcept
 Subtraction assignment operator.
 

Static Public Attributes

static const Ffmc Zero = Ffmc(0)
 Fine Fuel Moisture Code of 0.
 
static const Ffmc Invalid = Ffmc(-1)
 

Detailed Description

Fine Fuel Moisture Code value.

Constructor & Destructor Documentation

◆ Ffmc()

fs::wx::Ffmc::Ffmc ( const Temperature & temperature,
const RelativeHumidity & rh,
const Speed & ws,
const Precipitation & prec,
const Ffmc & ffmc_previous )
noexcept

Calculate Fine Fuel Moisture Code.

Parameters
temperatureTemperature (Celsius)
rhRelative Humidity (%)
wsWind Speed (km/h)
precPrecipitation (24hr accumulated, noon-to-noon) (mm)
ffmc_previousFine Fuel Moisture Code for previous day

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