FireSTARR
Loading...
Searching...
No Matches
fs::fuel::fbp::FuelM3< PercentDeadFir > Class Template Reference

FBP fuel type M-3. More...

#include <FBP45.h>

Inheritance diagram for fs::fuel::fbp::FuelM3< PercentDeadFir >:
Collaboration diagram for fs::fuel::fbp::FuelM3< PercentDeadFir >:

Public Member Functions

 FuelM3 (const FuelM3 &rhs) noexcept=delete
 
 FuelM3 (FuelM3 &&rhs) noexcept=delete
 
FuelM3operator= (const FuelM3 &rhs) noexcept=delete
 
FuelM3operator= (FuelM3 &&rhs) noexcept=delete
 
constexpr FuelM3 (const FuelCodeSize &code, const char *name)
 FBP fuel type M-3.
 
- Public Member Functions inherited from fs::fuel::FuelMixedDead< 120, 572, 140, 50, 10, PercentDeadFir >
 FuelMixedDead (const FuelMixedDead &rhs) noexcept=delete
 
 FuelMixedDead (FuelMixedDead &&rhs) noexcept=delete
 
constexpr FuelMixedDead (const FuelCodeSize &code, const char *name, const LogValue log_q)
 A mixed dead FBP fuel type.
 
FuelMixedDeadoperator= (const FuelMixedDead &rhs) noexcept=delete
 
FuelMixedDeadoperator= (FuelMixedDead &&rhs) noexcept=delete
 
- Public Member Functions inherited from fs::fuel::FuelMixed< A, B, C, Bui0, RosMultiplier, PercentDeadFir, 61, 15, 75 >
 FuelMixed (const FuelMixed &rhs) noexcept=delete
 
 FuelMixed (FuelMixed &&rhs) noexcept=delete
 
constexpr FuelMixed (const FuelCodeSize &code, const char *name, const LogValue log_q)
 A mixed FBP fuel type.
 
FuelMixedoperator= (const FuelMixed &rhs) noexcept=delete
 
FuelMixedoperator= (FuelMixed &&rhs) noexcept=delete
 
MathSize surfaceFuelConsumption (const SpreadInfo &spread) const noexcept override
 Surface Fuel Consumption (SFC) (kg/m^2) [ST-X-3 eq 10].
 
MathSize crownConsumption (const MathSize cfb) const noexcept override
 Crown Fuel Consumption (CFC) (kg/m^2) [ST-X-3 eq 66, pg 38].
 
MathSize calculateRos (const int, const wx::FwiWeather &, const MathSize isi) const noexcept override
 Calculate rate of spread (m/min) [ST-X-3 27/28, GLC-X-10 29/31].
 
MathSize calculateIsf (const SpreadInfo &spread, const MathSize isi) const noexcept override
 Calculate ISI with slope influence and zero wind (ISF) [ST-X-3 eq 42].
 
- Public Member Functions inherited from fs::fuel::StandardFuel< A, B, C, Bui0, 6, 80, BulkDensity, InorganicPercent, DuffDepth >
constexpr StandardFuel (const FuelCodeSize &code, const char *name, const bool can_crown, const LogValue log_q, const Duff *duff_ffmc, const Duff *duff_dmc) noexcept
 Constructor.
 
constexpr StandardFuel (const FuelCodeSize &code, const char *name, const bool can_crown, const LogValue log_q, const Duff *duff) noexcept
 Constructor.
 
 StandardFuel (StandardFuel &&rhs) noexcept=delete
 
 StandardFuel (const StandardFuel &rhs) noexcept=delete
 
StandardFueloperator= (StandardFuel &&rhs) noexcept=delete
 
StandardFueloperator= (const StandardFuel &rhs)=delete
 
MathSize rosBasic (const MathSize isi) const noexcept
 Initial rate of spread (m/min) [ST-X-3 eq 26].
 
MathSize limitIsf (const MathSize mu, const MathSize rsf) const noexcept
 ISI with slope influence and zero wind (ISF) [ST-X-3 eq 41].
 
MathSize criticalSurfaceIntensity (const SpreadInfo &spread) const noexcept override
 Critical Surface Fire Intensity (CSI) [ST-X-3 eq 56].
 
MathSize lengthToBreadth (const MathSize ws) const noexcept override
 Length to Breadth ratio [ST-X-3 eq 79].
 
MathSize finalRos (const SpreadInfo &, MathSize, MathSize, const MathSize rss) const noexcept override
 Final rate of spread (m/min)
 
MathSize buiEffect (const MathSize bui) const noexcept override
 BUI Effect on surface fire rate of spread [ST-X-3 eq 54].
 
- Public Member Functions inherited from fs::fuel::FuelBase< BulkDensity, InorganicPercent, DuffDepth >
constexpr FuelBase (const FuelCodeSize &code, const char *name, const bool can_crown, const Duff *duff_ffmc, const Duff *duff_dmc)
 Constructor.
 
 FuelBase (FuelBase &&rhs) noexcept=delete
 
 FuelBase (const FuelBase &rhs)=delete
 
FuelBaseoperator= (FuelBase &&rhs) noexcept=delete
 
FuelBaseoperator= (const FuelBase &rhs)=delete
 
MathSize crownFractionBurned (const MathSize rss, const MathSize rso) const noexcept override
 Crown Fraction Burned (CFB) [ST-X-3 eq 58].
 
ThresholdSize probabilityPeat (const MathSize mc_fraction) const noexcept override
 Calculate probability of burning [Anderson eq 1].
 
ThresholdSize survivalProbability (const wx::FwiWeather &wx) const noexcept override
 Survival probability calculated using probability of ony survival based on multiple formulae.
 
constexpr const DuffduffDmcType () const
 Type of duff deeper underground.
 
constexpr const DuffduffFfmcType () const
 Type of duff near the surface.
 
- 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.
 
virtual MathSize grass_curing (const int, const wx::FwiWeather &) const
 Grass curing.
 
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::FuelMixed< A, B, C, Bui0, RosMultiplier, PercentDeadFir, 61, 15, 75 >
static constexpr MathSize ratioConifer ()
 Percent Conifer (% / 100)
 
static constexpr MathSize ratioDeciduous ()
 Percent Deciduous (% / 100)
 
- Static Public Member Functions inherited from fs::fuel::FuelBase< BulkDensity, InorganicPercent, DuffDepth >
static constexpr MathSize bulkDensity ()
 Duff Bulk Density (kg/m^3) [Anderson table 1].
 
static constexpr MathSize inorganicPercent ()
 Inorganic Percent (% / 100) [Anderson table 1].
 
static constexpr MathSize duffDepth ()
 DuffDepth Depth of Duff layer (cm) [Anderson table 1].
 
static constexpr MathSize ffmcRatio ()
 What fraction of the duff layer should use FFMC to determine moisture.
 
static constexpr MathSize dmcRatio ()
 What fraction of the duff layer should use DMC to determine moisture.
 
- 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.
 
- Protected Member Functions inherited from fs::fuel::StandardFuel< A, B, C, Bui0, 6, 80, BulkDensity, InorganicPercent, DuffDepth >
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].
 
- Static Protected Member Functions inherited from fs::fuel::FuelMixed< A, B, C, Bui0, RosMultiplier, PercentDeadFir, 61, 15, 75 >
static constexpr MathSize rosMultiplier ()
 Rate of spread multiplier [ST-X-3 eq 27/28, GLC-X-10 eq 29/30].
 
static MathSize isfD1 (const SpreadInfo &spread, const MathSize isi) noexcept
 Calculate ISI with slope influence and zero wind (ISF) for D-1 [ST-X-3 eq 41].
 
- Static Protected Member Functions inherited from fs::fuel::StandardFuel< A, B, C, Bui0, 6, 80, BulkDensity, InorganicPercent, DuffDepth >
static constexpr MathSize bui0 () noexcept
 Average Build-up Index for the fuel type [ST-X-3 table 7].
 
static constexpr MathSize a () noexcept
 Rate of spread parameter a [ST-X-3 table 6].
 
static constexpr MathSize negB () noexcept
 Negative of rate of spread parameter b [ST-X-3 table 6].
 
static constexpr MathSize c () noexcept
 Rate of spread parameter c [ST-X-3 table 6].
 
static constexpr MathSize crownRateOfSpread (const MathSize isi, const MathSize fmc) noexcept
 Crown fire spread rate (RSC) (m/min) [ST-X-3 eq 64].
 

Detailed Description

template<int PercentDeadFir>
class fs::fuel::fbp::FuelM3< PercentDeadFir >

FBP fuel type M-3.

Template Parameters
PercentDeadFirPercent dead fir

Constructor & Destructor Documentation

◆ FuelM3()

template<int PercentDeadFir>
fs::fuel::fbp::FuelM3< PercentDeadFir >::FuelM3 ( const FuelCodeSize & code,
const char * name )
inlineconstexpr

FBP fuel type M-3.

Parameters
codeCode to identify fuel with
nameName of the fuel

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