FireSTARR
Loading...
Searching...
No Matches
fs::fuel::fbp::FuelM1M2< PercentConifer > Class Template Reference

FBP fuel type M-1/M-2. More...

#include <FBP45.h>

Inheritance diagram for fs::fuel::fbp::FuelM1M2< PercentConifer >:
Collaboration diagram for fs::fuel::fbp::FuelM1M2< PercentConifer >:

Public Member Functions

 FuelM1M2 (const FuelM1M2 &rhs) noexcept=delete
 
 FuelM1M2 (FuelM1M2 &&rhs) noexcept=delete
 
FuelM1M2operator= (const FuelM1M2 &rhs) noexcept=delete
 
FuelM1M2operator= (FuelM1M2 &&rhs) noexcept=delete
 
constexpr FuelM1M2 (const FuelCodeSize &code, const char *name, const FuelM1< PercentConifer > *m1, const FuelM2< PercentConifer > *m2)
 A fuel that changes between M-1/M-2 depending on green-up.
 
- Public Member Functions inherited from fs::fuel::FuelVariable< FuelM1< PercentConifer >, FuelM2< PercentConifer > >
constexpr FuelVariable (const FuelCodeSize &code, const char *name, const bool can_crown, const FuelM1< PercentConifer > *const spring, const FuelM2< PercentConifer > *const summer)
 A slash fuel type.
 
 FuelVariable (FuelVariable &&rhs) noexcept=delete
 
 FuelVariable (const FuelVariable &rhs)=delete
 
FuelVariableoperator= (FuelVariable &&rhs) noexcept=delete
 
FuelVariableoperator= (const FuelVariable &rhs)=delete
 
MathSize buiEffect (MathSize bui) const override
 BUI Effect on surface fire rate of spread [ST-X-3 eq 54].
 
MathSize grass_curing (const int nd, const wx::FwiWeather &wx) const override
 Grass curing.
 
MathSize cbh () const override
 Crown base height (m) [ST-X-3 table 8].
 
MathSize cfl () const override
 Crown fuel load (kg/m^2) [ST-X-3 table 8].
 
MathSize crownConsumption (const MathSize cfb) const override
 Crown Fuel Consumption (CFC) (kg/m^2) [ST-X-3 eq 66].
 
MathSize calculateRos (const int nd, const wx::FwiWeather &wx, const MathSize isi) const override
 Initial rate of spread (m/min) [ST-X-3 eq 26].
 
MathSize calculateIsf (const SpreadInfo &spread, const MathSize isi) const override
 Calculate ISI with slope influence and zero wind (ISF) [ST-X-3 eq 41].
 
MathSize surfaceFuelConsumption (const SpreadInfo &spread) const override
 Surface Fuel Consumption (SFC) (kg/m^2) [ST-X-3 eq 9-25].
 
MathSize lengthToBreadth (const MathSize ws) const override
 Length to Breadth ratio [ST-X-3 eq 79].
 
MathSize finalRos (const SpreadInfo &spread, const MathSize isi, const MathSize cfb, const MathSize rss) const override
 Final rate of spread (m/min)
 
MathSize criticalSurfaceIntensity (const SpreadInfo &spread) const override
 Critical Surface Fire Intensity (CSI) [ST-X-3 eq 56].
 
MathSize crownFractionBurned (const MathSize rss, const MathSize rso) const noexcept override
 Crown Fraction Burned (CFB) [ST-X-3 eq 58].
 
MathSize probabilityPeat (const MathSize mc_fraction) const noexcept override
 Calculate probability of burning [Anderson eq 1].
 
MathSize survivalProbability (const wx::FwiWeather &wx) const noexcept override
 Survival probability calculated using probability of ony survival based on multiple formulae.
 
constexpr const FuelTypespring () const
 Fuel to use before green-up.
 
constexpr const FuelTypesummer () const
 Fuel to use after green-up.
 
- Public Member Functions inherited from fs::fuel::FuelType
constexpr FuelType (const FuelCodeSize &code, const char *name, const bool can_crown) noexcept
 Fuel type.
 
 FuelType (FuelType &&rhs) noexcept=delete
 
 FuelType (const FuelType &rhs) noexcept=delete
 
FuelTypeoperator= (FuelType &&rhs) noexcept=delete
 
FuelTypeoperator= (const FuelType &rhs) noexcept=delete
 
constexpr bool canCrown () const
 Whether or not this fuel can have a crown fire.
 
constexpr const char * name () const
 Name of the fuel.
 
constexpr FuelCodeSize code () const
 Code for this fuel type.
 

Additional Inherited Members

- Static Public Member Functions inherited from fs::fuel::FuelType
static constexpr FuelCodeSize safeCode (const FuelType *fuel)
 Convert FuelType to its code, or 0 if nullptr.
 
static constexpr const char * safeName (const FuelType *fuel)
 Convert FuelType to its name, or 0 if nullptr.
 
static constexpr MathSize criticalRos (const MathSize sfc, const MathSize csi)
 Critical rate of spread (m/min)
 
static constexpr bool isCrown (const MathSize csi, const MathSize sfi)
 Whether or not this is a crown fire.
 

Detailed Description

template<int PercentConifer>
class fs::fuel::fbp::FuelM1M2< PercentConifer >

FBP fuel type M-1/M-2.

Template Parameters
PercentConiferPercent conifer

Constructor & Destructor Documentation

◆ FuelM1M2()

template<int PercentConifer>
fs::fuel::fbp::FuelM1M2< PercentConifer >::FuelM1M2 ( const FuelCodeSize & code,
const char * name,
const FuelM1< PercentConifer > * m1,
const FuelM2< PercentConifer > * m2 )
inlineconstexpr

A fuel that changes between M-1/M-2 depending on green-up.

Parameters
codeCode to identify fuel with
nameName of the fuel
m1M-1 fuel to use before green-up
m2M-2 fuel to use after green-up

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