A slash fuel type. More...

#include <FBP45.h>

Inheritance diagram for fs::fuel::FuelSlash< A, B, C, Bui0, FfcA, FfcB, WfcA, WfcB, BulkDensity >:

[legend]

Collaboration diagram for fs::fuel::FuelSlash< A, B, C, Bui0, FfcA, FfcB, WfcA, WfcB, BulkDensity >:

[legend]

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

	FuelSlash (FuelSlash &&rhs) noexcept=delete

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

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

constexpr	FuelSlash (const FuelCodeSize &code, const char name, const LogValue log_q, const Duff duff_ffmc, const Duff *duff_dmc)
	A slash fuel type.

MathSize	surfaceFuelConsumption (const SpreadInfo &spread) const noexcept override
	Surface Fuel Consumption (SFC) (kg/m^2) [ST-X-3 eq 25].

Public Member Functions inherited from fs::fuel::FuelConifer< A, B, C, Bui0, 0, 0, BulkDensity, 15, 74 >
	FuelConifer (const FuelConifer &rhs) noexcept=delete

	FuelConifer (FuelConifer &&rhs) noexcept=delete

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

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

Public Member Functions inherited from fs::fuel::FuelNonMixed< A, B, C, Bui0, Cbh, Cfl, BulkDensity, InorganicPercent, DuffDepth >
	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.

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

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

Static Private Member Functions
static constexpr MathSize	ffcA ()
	Forest Floor Consumption parameter a [ST-X-3 eq 19/21/23].

static constexpr MathSize	ffcB ()
	Forest Floor Consumption parameter b [ST-X-3 eq 19/21/23].

static constexpr MathSize	wfcA ()
	Woody Fuel Consumption parameter a [ST-X-3 eq 20/22/24].

static constexpr MathSize	wfcB ()
	Woody Fuel Consumption parameter b [ST-X-3 eq 20/22/24].

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.

Protected Member Functions inherited from fs::fuel::FuelConifer< A, B, C, Bui0, 0, 0, BulkDensity, 15, 74 >
constexpr	FuelConifer (const FuelCodeSize &code, const char name, const LogValue log_q, const Duff duff_ffmc, const Duff *duff_dmc)
	A conifer FBP fuel type.

constexpr	FuelConifer (const FuelCodeSize &code, const char name, const LogValue log_q, const Duff duff)
	A conifer FBP fuel type.

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

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 FfcA, int FfcB, int WfcA, int WfcB, int BulkDensity>
class fs::fuel::FuelSlash< A, B, C, Bui0, FfcA, FfcB, WfcA, WfcB, BulkDensity >

A slash fuel type.

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]
FfcA	Forest Floor Consumption parameter a [ST-X-3 eq 19/21/23]
FfcB	Forest Floor Consumption parameter b * 10000 [ST-X-3 eq 19/21/23]
WfcA	Woody Fuel Consumption parameter a [ST-X-3 eq 20/22/24]
WfcB	Woody Fuel Consumption parameter b * 10000 [ST-X-3 eq 20/22/24]
BulkDensity	Duff Bulk Density (kg/m^3) [Anderson table 1] * 1000

Constructor & Destructor Documentation

◆ FuelSlash()

template<int A, int B, int C, int Bui0, int FfcA, int FfcB, int WfcA, int WfcB, int BulkDensity>

fs::fuel::FuelSlash< A, B, C, Bui0, FfcA, FfcB, WfcA, WfcB, BulkDensity >::FuelSlash	(	const FuelCodeSize &	code,
		const char *	name,
		const LogValue	log_q,
		const Duff *	duff_ffmc,
		const Duff *	duff_dmc )

inlineconstexpr

A slash fuel type.

Parameters

code	Code to identify fuel with
name	Name of the fuel
log_q	Log value of q [ST-X-3 table 7]
duff_ffmc	Type of duff near the surface
duff_dmc	Type of duff deeper underground

Member Function Documentation

◆ ffcA()

template<int A, int B, int C, int Bui0, int FfcA, int FfcB, int WfcA, int WfcB, int BulkDensity>

static constexpr MathSize fs::fuel::FuelSlash< A, B, C, Bui0, FfcA, FfcB, WfcA, WfcB, BulkDensity >::ffcA ( )

inlinestaticnodiscardconstexprprivate

Forest Floor Consumption parameter a [ST-X-3 eq 19/21/23].

Returns: Forest Floor Consumption parameter a [ST-X-3 eq 19/21/23]

Here is the caller graph for this function:

◆ ffcB()

template<int A, int B, int C, int Bui0, int FfcA, int FfcB, int WfcA, int WfcB, int BulkDensity>

static constexpr MathSize fs::fuel::FuelSlash< A, B, C, Bui0, FfcA, FfcB, WfcA, WfcB, BulkDensity >::ffcB ( )

inlinestaticnodiscardconstexprprivate

Forest Floor Consumption parameter b [ST-X-3 eq 19/21/23].

Returns: Forest Floor Consumption parameter b [ST-X-3 eq 19/21/23]

Here is the caller graph for this function:

◆ surfaceFuelConsumption()

template<int A, int B, int C, int Bui0, int FfcA, int FfcB, int WfcA, int WfcB, int BulkDensity>

MathSize fs::fuel::FuelSlash< A, B, C, Bui0, FfcA, FfcB, WfcA, WfcB, BulkDensity >::surfaceFuelConsumption ( const SpreadInfo & spread ) const

inlinenodiscardoverridevirtualnoexcept

Surface Fuel Consumption (SFC) (kg/m^2) [ST-X-3 eq 25].

Parameters

spread SpreadInfo to use

Returns: Surface Fuel Consumption (SFC) (kg/m^2) [ST-X-3 eq 25]

Implements fs::fuel::FuelType.

Here is the call graph for this function:

◆ wfcA()

template<int A, int B, int C, int Bui0, int FfcA, int FfcB, int WfcA, int WfcB, int BulkDensity>

static constexpr MathSize fs::fuel::FuelSlash< A, B, C, Bui0, FfcA, FfcB, WfcA, WfcB, BulkDensity >::wfcA ( )

inlinestaticnodiscardconstexprprivate

Woody Fuel Consumption parameter a [ST-X-3 eq 20/22/24].

Returns: Woody Fuel Consumption parameter a [ST-X-3 eq 20/22/24]

Here is the caller graph for this function:

◆ wfcB()

template<int A, int B, int C, int Bui0, int FfcA, int FfcB, int WfcA, int WfcB, int BulkDensity>

static constexpr MathSize fs::fuel::FuelSlash< A, B, C, Bui0, FfcA, FfcB, WfcA, WfcB, BulkDensity >::wfcB ( )

inlinestaticnodiscardconstexprprivate

Woody Fuel Consumption parameter b [ST-X-3 eq 20/22/24].

Returns: Woody Fuel Consumption parameter b [ST-X-3 eq 20/22/24]

Here is the caller graph for this function:

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

firestarr/src/cpp/FBP45.h

Public Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FuelSlash()

Member Function Documentation

◆ ffcA()

◆ ffcB()

◆ surfaceFuelConsumption()

◆ wfcA()

◆ wfcB()