A StandardFuel that is not made of multiple fuels. More...

#include <FBP45.h>

Inheritance diagram for fs::fuel::FuelNonMixed< A, B, C, Bui0, Cbh, Cfl, BulkDensity, InorganicPercent, DuffDepth >:

[legend]

Collaboration diagram for fs::fuel::FuelNonMixed< A, B, C, Bui0, Cbh, Cfl, BulkDensity, InorganicPercent, DuffDepth >:

[legend]

Public Member Functions
	FuelNonMixed (const FuelNonMixed &rhs) noexcept=delete

	FuelNonMixed (FuelNonMixed &&rhs) noexcept=delete

FuelNonMixed &	operator= (const FuelNonMixed &rhs) noexcept=delete

FuelNonMixed &	operator= (FuelNonMixed &&rhs) noexcept=delete

Public Member Functions inherited from fs::fuel::StandardFuel< A, B, C, Bui0, Cbh, Cfl, 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

StandardFuel &	operator= (StandardFuel &&rhs) noexcept=delete

StandardFuel &	operator= (const StandardFuel &rhs)=delete

MathSize	rosBasic (const MathSize isi) const noexcept
	Initial rate of spread (m/min) [ST-X-3 eq 26].

virtual MathSize	crownConsumption (const MathSize cfb) const noexcept override
	Crown Fuel Consumption (CFC) (kg/m^2) [ST-X-3 eq 66].

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

FuelBase &	operator= (FuelBase &&rhs) noexcept=delete

FuelBase &	operator= (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 Duff *	duffDmcType () const
	Type of duff deeper underground.

constexpr const Duff *	duffFfmcType () 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

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.

virtual MathSize	grass_curing (const int, const wx::FwiWeather &) const
	Grass curing.

virtual MathSize	surfaceFuelConsumption (const SpreadInfo &spread) const =0
	Surface fuel consumption (SFC) (kg/m^2) [ST-X-3 eq 9-25].

constexpr const char *	name () const
	Name of the fuel.

constexpr FuelCodeSize	code () const
	Code for this fuel type.

Protected Member Functions
MathSize	calculateIsf (const SpreadInfo &spread, const MathSize isi) const noexcept override
	ISI with slope influence and zero wind (ISF) [ST-X-3 eq 41].

virtual MathSize	calculateRos (const int, const wx::FwiWeather &, const MathSize isi) const noexcept override
	Initial rate of spread (m/min) [ST-X-3 eq 26].

Protected Member Functions inherited from fs::fuel::StandardFuel< A, B, C, Bui0, Cbh, Cfl, 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].

Additional Inherited Members
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.

Static Protected Member Functions inherited from fs::fuel::StandardFuel< A, B, C, Bui0, Cbh, Cfl, 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 A, int B, int C, int Bui0, int Cbh, int Cfl, int BulkDensity, int InorganicPercent, int DuffDepth>
class fs::fuel::FuelNonMixed< A, B, C, Bui0, Cbh, Cfl, BulkDensity, InorganicPercent, DuffDepth >

A StandardFuel that is not made of multiple fuels.

Template Parameters

A	Rate of spread parameter a [ST-X-3 table 6]
B	Rate of spread parameter b * 10000 [ST-X-3 table 6]
C	Rate of spread parameter c * 100 [ST-X-3 table 6]
Bui0	Average Build-up Index for the fuel type [ST-X-3 table 7]
Cbh	Crown base height (m) [ST-X-3 table 8]
Cfl	Crown fuel load (kg/m^2) [ST-X-3 table 8]
BulkDensity	Duff Bulk Density (kg/m^3) [Anderson table 1] * 1000
InorganicPercent	Inorganic percent of Duff layer (%) [Anderson table 1]
DuffDepth	Depth of Duff layer (cm * 10) [Anderson table 1]

Member Function Documentation

◆ calculateIsf()

template<int A, int B, int C, int Bui0, int Cbh, int Cfl, int BulkDensity, int InorganicPercent, int DuffDepth>

MathSize fs::fuel::FuelNonMixed< A, B, C, Bui0, Cbh, Cfl, BulkDensity, InorganicPercent, DuffDepth >::calculateIsf	(	const SpreadInfo &	spread,
		const MathSize	isi ) const

inlinenodiscardoverrideprotectedvirtualnoexcept

ISI with slope influence and zero wind (ISF) [ST-X-3 eq 41].

Parameters

spread	SpreadInfo to use in calculations
isi	Initial Spread Index

Returns: ISI with slope influence and zero wind (ISF) [ST-X-3 eq 41]

Implements fs::fuel::FuelType.

Here is the call graph for this function:

◆ calculateRos()

template<int A, int B, int C, int Bui0, int Cbh, int Cfl, int BulkDensity, int InorganicPercent, int DuffDepth>

virtual MathSize fs::fuel::FuelNonMixed< A, B, C, Bui0, Cbh, Cfl, BulkDensity, InorganicPercent, DuffDepth >::calculateRos	(	const int	,
		const wx::FwiWeather &	,
		const MathSize	isi ) const