fs::fuel::InvalidFuel Class Reference

Placeholder fuel that throws exceptions if it ever gets used. More...

#include <FuelType.h>

Inheritance diagram for fs::fuel::InvalidFuel:

Collaboration diagram for fs::fuel::InvalidFuel:

Public Member Functions
constexpr	InvalidFuel (const FuelCodeSize &code, const char *name) noexcept
	Placeholder fuel that throws exceptions if it ever gets used.
	InvalidFuel (const InvalidFuel &rhs) noexcept=delete
	InvalidFuel (InvalidFuel &&rhs) noexcept=delete
InvalidFuel &	operator= (const InvalidFuel &rhs) noexcept=delete
InvalidFuel &	operator= (InvalidFuel &&rhs) noexcept=delete
MathSize	grass_curing (const int nd, const wx::FwiWeather &wx) const override
	Throw a runtime_error.
MathSize	cbh () const override
	Throw a runtime_error.
MathSize	cfl () const override
	Throw a runtime_error.
MathSize	buiEffect (MathSize) const override
	Throw a runtime_error.
MathSize	crownConsumption (MathSize) const override
	Throw a runtime_error.
MathSize	calculateRos (int, const wx::FwiWeather &, MathSize) const override
	Throw a runtime_error.
MathSize	calculateIsf (const SpreadInfo &, MathSize) const override
	Throw a runtime_error.
MathSize	surfaceFuelConsumption (const SpreadInfo &) const override
	Throw a runtime_error.
MathSize	lengthToBreadth (MathSize) const override
	Throw a runtime_error.
MathSize	finalRos (const SpreadInfo &, MathSize, MathSize, MathSize) const override
	Throw a runtime_error.
MathSize	criticalSurfaceIntensity (const SpreadInfo &) const override
	Throw a runtime_error.
MathSize	crownFractionBurned (MathSize, MathSize) const noexcept override
	Throw a runtime_error.
ThresholdSize	probabilityPeat (MathSize) const noexcept override
	Throw a runtime_error.
ThresholdSize	survivalProbability (const wx::FwiWeather &) const noexcept override
	Throw a runtime_error.
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

Placeholder fuel that throws exceptions if it ever gets used.

Constructor & Destructor Documentation

InvalidFuel()

fs::fuel::InvalidFuel::InvalidFuel ( const FuelCodeSize & code, const char * name )

inlineconstexprnoexcept

Placeholder fuel that throws exceptions if it ever gets used.

Parameters

code	Code to identify fuel with
name	Name of the fuel

Member Function Documentation

buiEffect()

MathSize fs::fuel::InvalidFuel::buiEffect ( MathSize ) const

nodiscardoverridevirtual

Throw a runtime_error.

Returns

Throw a runtime_error

Implements fs::fuel::FuelType.

calculateIsf()

MathSize fs::fuel::InvalidFuel::calculateIsf ( const SpreadInfo & , MathSize  ) const

nodiscardoverridevirtual

Throw a runtime_error.

Returns

Throw a runtime_error

Implements fs::fuel::FuelType.

calculateRos()

MathSize fs::fuel::InvalidFuel::calculateRos ( int , const wx::FwiWeather & , MathSize  ) const

nodiscardoverridevirtual

Throw a runtime_error.

Returns

Throw a runtime_error

Implements fs::fuel::FuelType.

cbh()

MathSize fs::fuel::InvalidFuel::cbh ( ) const

nodiscardoverridevirtual

Throw a runtime_error.

Returns

Throw a runtime_error

Implements fs::fuel::FuelType.

cfl()

MathSize fs::fuel::InvalidFuel::cfl ( ) const

nodiscardoverridevirtual

Throw a runtime_error.

Returns

Throw a runtime_error

Implements fs::fuel::FuelType.

criticalSurfaceIntensity()

MathSize fs::fuel::InvalidFuel::criticalSurfaceIntensity ( const SpreadInfo & ) const

nodiscardoverridevirtual

Throw a runtime_error.

Returns

Throw a runtime_error

Implements fs::fuel::FuelType.

crownConsumption()

MathSize fs::fuel::InvalidFuel::crownConsumption ( MathSize ) const

nodiscardoverridevirtual

Throw a runtime_error.

Returns

Throw a runtime_error

Implements fs::fuel::FuelType.

crownFractionBurned()

MathSize fs::fuel::InvalidFuel::crownFractionBurned ( MathSize , MathSize  ) const

nodiscardoverridevirtualnoexcept

Throw a runtime_error.

Returns

Throw a runtime_error

Implements fs::fuel::FuelType.

finalRos()

MathSize fs::fuel::InvalidFuel::finalRos ( const SpreadInfo & , MathSize , MathSize , MathSize  ) const

nodiscardoverridevirtual

Throw a runtime_error.

Returns

Throw a runtime_error

Implements fs::fuel::FuelType.

grass_curing()

MathSize fs::fuel::InvalidFuel::grass_curing ( const int nd, const wx::FwiWeather & wx ) const

nodiscardoverridevirtual

Throw a runtime_error.

Returns

Throw a runtime_error

Reimplemented from fs::fuel::FuelType.

lengthToBreadth()

MathSize fs::fuel::InvalidFuel::lengthToBreadth ( MathSize ) const

nodiscardoverridevirtual

Throw a runtime_error.

Returns

Throw a runtime_error

Implements fs::fuel::FuelType.

probabilityPeat()

MathSize fs::fuel::InvalidFuel::probabilityPeat ( MathSize ) const

nodiscardoverridevirtualnoexcept

Throw a runtime_error.

Returns

Throw a runtime_error

Implements fs::fuel::FuelType.

surfaceFuelConsumption()

MathSize fs::fuel::InvalidFuel::surfaceFuelConsumption ( const SpreadInfo & ) const

nodiscardoverridevirtual

Throw a runtime_error.

Returns

Throw a runtime_error

Implements fs::fuel::FuelType.

survivalProbability()

MathSize fs::fuel::InvalidFuel::survivalProbability ( const wx::FwiWeather & ) const

nodiscardoverridevirtualnoexcept

Throw a runtime_error.

Returns

Throw a runtime_error

Implements fs::fuel::FuelType.

---

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

• firestarr/src/cpp/FuelType.h
• firestarr/src/cpp/FuelType.cpp