Placeholder fuel that throws exceptions if it ever gets used.
More...
#include <SimpleFuelType.h>
|
| 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 |
| |
| bool | isValid () const override |
| | Is fuel a valid fuel type.
|
| |
| MathSize | grass_curing (const int nd, const 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 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 FwiWeather &) const noexcept override |
| | Throw a runtime_error.
|
| |
| 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.
|
| |
|
| 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.
|
| |
Placeholder fuel that throws exceptions if it ever gets used.
◆ InvalidFuel()
| fs::simplefbp::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 |
◆ buiEffect()
| MathSize fs::simplefbp::InvalidFuel::buiEffect |
( |
MathSize | | ) |
const |
|
nodiscardoverridevirtual |
Throw a runtime_error.
- Returns
- Throw a runtime_error
Implements fs::FuelType.
◆ calculateIsf()
| MathSize fs::simplefbp::InvalidFuel::calculateIsf |
( |
const SpreadInfo & | , |
|
|
MathSize | ) const |
|
nodiscardoverridevirtual |
Throw a runtime_error.
- Returns
- Throw a runtime_error
Implements fs::FuelType.
◆ calculateRos()
| MathSize fs::simplefbp::InvalidFuel::calculateRos |
( |
int | , |
|
|
const FwiWeather & | , |
|
|
MathSize | ) const |
|
nodiscardoverridevirtual |
Throw a runtime_error.
- Returns
- Throw a runtime_error
Implements fs::FuelType.
◆ cbh()
| MathSize fs::simplefbp::InvalidFuel::cbh |
( |
| ) |
const |
|
nodiscardoverridevirtual |
Throw a runtime_error.
- Returns
- Throw a runtime_error
Implements fs::FuelType.
◆ cfl()
| MathSize fs::simplefbp::InvalidFuel::cfl |
( |
| ) |
const |
|
nodiscardoverridevirtual |
Throw a runtime_error.
- Returns
- Throw a runtime_error
Implements fs::FuelType.
◆ criticalSurfaceIntensity()
| MathSize fs::simplefbp::InvalidFuel::criticalSurfaceIntensity |
( |
const SpreadInfo & | | ) |
const |
|
nodiscardoverridevirtual |
Throw a runtime_error.
- Returns
- Throw a runtime_error
Implements fs::FuelType.
◆ crownConsumption()
| MathSize fs::simplefbp::InvalidFuel::crownConsumption |
( |
MathSize | | ) |
const |
|
nodiscardoverridevirtual |
Throw a runtime_error.
- Returns
- Throw a runtime_error
Implements fs::FuelType.
◆ crownFractionBurned()
| MathSize fs::simplefbp::InvalidFuel::crownFractionBurned |
( |
MathSize | , |
|
|
MathSize | ) const |
|
nodiscardoverridevirtualnoexcept |
Throw a runtime_error.
- Returns
- Throw a runtime_error
Implements fs::FuelType.
◆ finalRos()
| MathSize fs::simplefbp::InvalidFuel::finalRos |
( |
const SpreadInfo & | , |
|
|
MathSize | , |
|
|
MathSize | , |
|
|
MathSize | ) const |
|
nodiscardoverridevirtual |
Throw a runtime_error.
- Returns
- Throw a runtime_error
Implements fs::FuelType.
◆ grass_curing()
| MathSize fs::simplefbp::InvalidFuel::grass_curing |
( |
const int | nd, |
|
|
const FwiWeather & | wx ) const |
|
nodiscardoverridevirtual |
Throw a runtime_error.
- Returns
- Throw a runtime_error
Reimplemented from fs::FuelType.
◆ isValid()
| bool fs::simplefbp::InvalidFuel::isValid |
( |
| ) |
const |
|
inlinenodiscardoverridevirtual |
◆ lengthToBreadth()
| MathSize fs::simplefbp::InvalidFuel::lengthToBreadth |
( |
MathSize | | ) |
const |
|
nodiscardoverridevirtual |
Throw a runtime_error.
- Returns
- Throw a runtime_error
Implements fs::FuelType.
◆ probabilityPeat()
| ThresholdSize fs::simplefbp::InvalidFuel::probabilityPeat |
( |
MathSize | | ) |
const |
|
nodiscardoverridevirtualnoexcept |
Throw a runtime_error.
- Returns
- Throw a runtime_error
Implements fs::FuelType.
◆ surfaceFuelConsumption()
| MathSize fs::simplefbp::InvalidFuel::surfaceFuelConsumption |
( |
const SpreadInfo & | | ) |
const |
|
nodiscardoverridevirtual |
Throw a runtime_error.
- Returns
- Throw a runtime_error
Implements fs::FuelType.
◆ survivalProbability()
| ThresholdSize fs::simplefbp::InvalidFuel::survivalProbability |
( |
const FwiWeather & | | ) |
const |
|
nodiscardoverridevirtualnoexcept |
Throw a runtime_error.
- Returns
- Throw a runtime_error
Implements fs::FuelType.
The documentation for this class was generated from the following file: