A grass fuel type. More...

#include <FBP45.h>

Inheritance diagram for fs::fuel::FuelGrass< A, B, C >:

[legend]

Collaboration diagram for fs::fuel::FuelGrass< A, B, C >:

[legend]

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

	FuelGrass (FuelGrass &&rhs) noexcept=delete

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

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

constexpr	FuelGrass (const FuelCodeSize &code, const char *name, const LogValue log_q)
	A grass fuel type.

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

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

MathSize	baseMultiplier (const int nd, const wx::FwiWeather &wx) const noexcept
	Calculate base rate of spread multiplier.

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

MathSize	calculateRos (const int nd, const wx::FwiWeather &wx, const MathSize isi) const noexcept override
	Calculate rate of spread (m/min)

Public Member Functions inherited from fs::fuel::StandardFuel< A, B, C, 1, 0, 0, 0, 0, static_cast< int >(DUFF_FFMC_DEPTH *10.0)>
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.

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

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

Protected Member Functions
MathSize	lengthToBreadth (const MathSize ws) const noexcept override
	Length to Breadth ratio [ST-X-3 eq 80/81].

Protected Member Functions inherited from fs::fuel::StandardFuel< A, B, C, 1, 0, 0, 0, 0, static_cast< int >(DUFF_FFMC_DEPTH *10.0)>
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].

Private Member Functions
MathSize	calculateRos (const MathSize multiplier, const MathSize isi) const noexcept
	Calculate rate of spread (m/min)

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, 1, 0, 0, 0, 0, static_cast< int >(DUFF_FFMC_DEPTH *10.0)>
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>
class fs::fuel::FuelGrass< A, B, C >

A grass 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]

Constructor & Destructor Documentation

◆ FuelGrass()

template<int A, int B, int C>

fs::fuel::FuelGrass< A, B, C >::FuelGrass	(	const FuelCodeSize &	code,
		const char *	name,
		const LogValue	log_q )

inlineconstexpr

A grass 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]

Member Function Documentation

◆ baseMultiplier()

template<int A, int B, int C>

MathSize fs::fuel::FuelGrass< A, B, C >::baseMultiplier	(	const int	nd,
		const wx::FwiWeather &	wx ) const

inlinenodiscardnoexcept

Calculate base rate of spread multiplier.

Parameters

nd	Difference between date and the date of minimum foliar moisture content
wx	FwiWeather to use for calculation

Returns: Base rate of spread multiplier

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateIsf()

template<int A, int B, int C>

MathSize fs::fuel::FuelGrass< A, B, C >::calculateIsf	(	const SpreadInfo &	spread,
		const MathSize	isi ) const

inlinenodiscardoverridevirtualnoexcept

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

Parameters

spread	SpreadInfo to use
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() [1/2]

template<int A, int B, int C>

MathSize fs::fuel::FuelGrass< A, B, C >::calculateRos	(	const int	nd,
		const wx::FwiWeather &	wx,
		const MathSize	isi ) const

inlinenodiscardoverridevirtualnoexcept

Calculate rate of spread (m/min)

Parameters

nd	Difference between date and the date of minimum foliar moisture content
wx	FwiWeather to use for calculation
isi	Initial Spread Index (may differ from wx because of slope)

Returns: Rate of spread (m/min)

Implements fs::fuel::FuelType.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateRos() [2/2]

template<int A, int B, int C>

MathSize fs::fuel::FuelGrass< A, B, C >::calculateRos	(	const MathSize	multiplier,
		const MathSize	isi ) const

inlinenodiscardprivatenoexcept

Calculate rate of spread (m/min)

Parameters

multiplier	Rate of spread multiplier
isi	Initial Spread Index (may differ from wx because of slope)

Returns: Rate of spread (m/min)

Here is the call graph for this function:

◆ grass_curing()

template<int A, int B, int C>

MathSize fs::fuel::FuelGrass< A, B, C >::grass_curing	(	const int	nd,
		const wx::FwiWeather &	wx ) const

inlinenodiscardoverridevirtual

Grass curing.

Returns: Grass curing (or -1 if invalid for this fuel type)

Reimplemented from fs::fuel::FuelType.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lengthToBreadth()

template<int A, int B, int C>

MathSize fs::fuel::FuelGrass< A, B, C >::lengthToBreadth ( const MathSize ws ) const

inlinenodiscardoverrideprotectedvirtualnoexcept

Length to Breadth ratio [ST-X-3 eq 80/81].

Parameters

ws	Wind Speed (km/h)

Returns: Length to Breadth ratio [ST-X-3 eq 80/81]

Implements fs::fuel::FuelType.

◆ surfaceFuelConsumption()

template<int A, int B, int C>

MathSize fs::fuel::FuelGrass< A, B, C >::surfaceFuelConsumption ( const SpreadInfo & ) const

inlinenodiscardoverridevirtualnoexcept

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

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

Implements fs::fuel::FuelType.

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

firestarr/src/cpp/FBP45.h

Public Member Functions

Protected Member Functions

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FuelGrass()

Member Function Documentation

◆ baseMultiplier()

◆ calculateIsf()

◆ calculateRos() [1/2]

◆ calculateRos() [2/2]

◆ grass_curing()

◆ lengthToBreadth()

◆ surfaceFuelConsumption()