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

Initial Spread Index value. More...

#include <FWI.h>

Inheritance diagram for fs::Isi:
Collaboration diagram for fs::Isi:

Public Member Functions

 Isi (MathSize value, const Speed ws, const Ffmc ffmc) noexcept
 Calculate Initial Spread Index and verify previous value is within tolerance of calculated value.
 
 Isi (const Speed ws, const Ffmc ffmc) noexcept
 Calculate Initial Spread Index.
 
constexpr StrictType ()=default
 
constexpr StrictType (const ValueType value) noexcept
 
constexpr StrictType (T &&rhs) noexcept=default
 
constexpr StrictType (const T &rhs) noexcept=default
 
- Public Member Functions inherited from fs::StrictType< Isi >
constexpr StrictType (const MathSize value) noexcept
 
constexpr StrictType (T &&rhs) noexcept=default
 
constexpr StrictType (const T &rhs) noexcept=default
 
T & operator= (T &&rhs) noexcept=default
 
T & operator= (const T &rhs) noexcept=default
 
constexpr auto operator== (const T &rhs) const
 
constexpr auto operator<=> (const T &rhs) const
 
constexpr Isi operator+ (const T &rhs) const noexcept
 
constexpr Isi operator- (const T &rhs) const noexcept
 
constexpr Isi operator* (const MathSize &rhs) const noexcept
 
constexpr Isi operator/ (const MathSize &rhs) const noexcept
 
constexpr T & operator+= (const T &rhs) noexcept
 
constexpr T & operator-= (const T &rhs) noexcept
 
constexpr T & operator*= (const T &rhs) noexcept
 
constexpr T & operator/= (const T &rhs) noexcept
 
 operator string () noexcept
 

Additional Inherited Members

- Public Types inherited from fs::StrictType< Isi >
using T
 
using concrete_type
 
using value_type
 
- Static Public Member Functions inherited from fs::StrictType< Isi >
static consteval Isi Zero ()
 
static consteval Isi Invalid ()
 
- Public Attributes inherited from fs::StrictType< Isi >
MathSize value
 
- Static Public Attributes inherited from fs::StrictType< Isi >
static constexpr auto units
 
static constexpr auto invalid_value
 

Detailed Description

Initial Spread Index value.

Constructor & Destructor Documentation

◆ Isi() [1/2]

fs::Isi::Isi ( MathSize value,
const Speed ws,
const Ffmc ffmc )
noexcept

Calculate Initial Spread Index and verify previous value is within tolerance of calculated value.

Parameters
valueValue to check is within tolerance of calculated value
wsWind Speed (km/h)
ffmcFine Fuel Moisture Code

◆ Isi() [2/2]

fs::Isi::Isi ( const Speed ws,
const Ffmc ffmc )
noexcept

Calculate Initial Spread Index.

Parameters
wsWind Speed (km/h)
ffmcFine Fuel Moisture Code

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