fs::fuel::fbp::FuelM3M4< PercentDeadFir > Class Template Reference

FBP fuel type M-3/M-4. More...

#include <FBP45.h>

Inheritance diagram for fs::fuel::fbp::FuelM3M4< PercentDeadFir >:

Collaboration diagram for fs::fuel::fbp::FuelM3M4< PercentDeadFir >:

Public Member Functions
	FuelM3M4 (const FuelM3M4 &rhs) noexcept=delete
	FuelM3M4 (FuelM3M4 &&rhs) noexcept=delete
FuelM3M4 &	operator= (const FuelM3M4 &rhs) noexcept=delete
FuelM3M4 &	operator= (FuelM3M4 &&rhs) noexcept=delete
constexpr	FuelM3M4 (const FuelCodeSize &code, const char *name, const FuelM3< PercentDeadFir > *m3, const FuelM4< PercentDeadFir > *m4)
	A fuel that changes between M-3/M-4 depending on green-up.
Public Member Functions inherited from fs::fuel::FuelVariable< FuelM3< PercentDeadFir >, FuelM4< PercentDeadFir > >
constexpr	FuelVariable (const FuelCodeSize &code, const char *name, const bool can_crown, const FuelM3< PercentDeadFir > *const spring, const FuelM4< PercentDeadFir > *const summer)
	A slash fuel type.
	FuelVariable (FuelVariable &&rhs) noexcept=delete
	FuelVariable (const FuelVariable &rhs)=delete
FuelVariable &	operator= (FuelVariable &&rhs) noexcept=delete
FuelVariable &	operator= (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 FuelType &	spring () const
	Fuel to use before green-up.
constexpr const FuelType &	summer () 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
FuelType &	operator= (FuelType &&rhs) noexcept=delete
FuelType &	operator= (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 PercentDeadFir>
class fs::fuel::fbp::FuelM3M4< PercentDeadFir >

FBP fuel type M-3/M-4.

Template Parameters

PercentDeadFir

Percent dead fir

Constructor & Destructor Documentation

FuelM3M4()

template<int PercentDeadFir>

fs::fuel::fbp::FuelM3M4< PercentDeadFir >::FuelM3M4 ( const FuelCodeSize & code, const char * name, const FuelM3< PercentDeadFir > * m3, const FuelM4< PercentDeadFir > * m4 )

inlineconstexpr

A fuel that changes between M-3/M-4 depending on green-up.

Parameters

code	Code to identify fuel with
name	Name of the fuel
m3	M-3 fuel to use before green-up
m4	M-4 fuel to use after green-up

---

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

• firestarr/src/cpp/FBP45.h