A Weather value with calculated FWI indices. More...

#include <FWI.h>

Inheritance diagram for fs::wx::FwiWeather:

Collaboration diagram for fs::wx::FwiWeather:

[legend]

Public Member Functions
	FwiWeather () noexcept
	Construct with 0 for all values.

	FwiWeather (istringstream iss, string str)
	Construct by reading from istringstream.

	FwiWeather (const FwiWeather &yesterday, const int month, const MathSize latitude, const Temperature &temp, const RelativeHumidity &rh, const Wind &wind, const Precipitation &prec)
	construct by applying noon weather to yesterday's indices

	FwiWeather (const Temperature &temp, const RelativeHumidity &rh, const Wind &wind, const Precipitation &prec, const Ffmc &ffmc, const Dmc &dmc, const Dc &dc, const Isi &isi, const Bui &bui, const Fwi &fwi) noexcept
	Constructor.

	FwiWeather (const Temperature &temp, const RelativeHumidity &rh, const Wind &wind, const Precipitation &prec, const Ffmc &ffmc, const Dmc &dmc, const Dc &dc, const Isi &isi, const Bui &bui) noexcept
	Construct by calculating FWI.

	FwiWeather (const Temperature &temp, const RelativeHumidity &rh, const Wind &wind, const Precipitation &prec, const Ffmc &ffmc, const Dmc &dmc, const Dc &dc) noexcept
	Construct by calculating ISI, BUI, & FWI.

	FwiWeather (const FwiWeather &wx, const Speed &ws, const Ffmc &ffmc) noexcept
	Construct by recalculating with different wind Speed and Ffmc.

	~FwiWeather () override=default
	Destructor.

constexpr	FwiWeather (FwiWeather &&rhs) noexcept=default
	Move constructor.

constexpr	FwiWeather (const FwiWeather &rhs) noexcept=default
	Copy constructor.

FwiWeather &	operator= (FwiWeather &&rhs) noexcept=default
	Move assignment.

FwiWeather &	operator= (const FwiWeather &rhs)=default
	Copy assignment.

constexpr const Ffmc &	ffmc () const
	Fine Fuel Moisture Code.

constexpr const Dmc &	dmc () const
	Duff Moisture Code.

constexpr const Dc &	dc () const
	Drought Code.

constexpr const Isi &	isi () const
	Initial Spread Index.

constexpr const Bui &	bui () const
	Build-up Index.

constexpr const Fwi &	fwi () const
	Fire Weather Index.

constexpr MathSize	mcFfmcPct () const
	Moisture content (%) based on Ffmc.

constexpr MathSize	mcDmcPct () const
	Moisture content (%) based on Dmc.

constexpr MathSize	mcFfmc () const
	Moisture content (ratio) based on Ffmc.

constexpr MathSize	mcDmc () const
	Moisture content (ratio) based on Dmc.

constexpr MathSize	ffmcEffect () const
	Ffmc effect used for spread.

Public Member Functions inherited from fs::wx::Weather
virtual	~Weather ()=default
	Destructor.

constexpr	Weather () noexcept=default
	Constructor with no initialization.

constexpr	Weather (const Temperature &temp, const RelativeHumidity &rh, const Wind &wind, const Precipitation &prec) noexcept
	Construct with given indices.

constexpr	Weather (Weather &&rhs) noexcept=default
	Move constructor.

constexpr	Weather (const Weather &rhs) noexcept=default
	Copy constructor.

Weather &	operator= (Weather &&rhs) noexcept=default
	Move assignment.

Weather &	operator= (const Weather &rhs)=default
	Move assignment.

constexpr const Temperature &	temp () const noexcept
	Temperature (Celsius)

constexpr const RelativeHumidity &	rh () const noexcept
	Relative Humidity (%)

constexpr const Wind &	wind () const noexcept
	Wind (km/h)

constexpr const Precipitation &	prec () const noexcept
	Precipitation (1hr accumulation) (mm)

Static Public Attributes
static const FwiWeather	Zero
	FwiWeather with 0 for all Indices.

static const FwiWeather	Invalid

Private Member Functions
	FwiWeather (const FwiWeather &wx, const Wind &wind, const Ffmc &ffmc, const Isi &isi) noexcept
	Calculate based on indices plus new Wind, Ffmc, and Isi.

	FwiWeather (const FwiWeather &wx, const Wind &wind, const Ffmc &ffmc) noexcept
	Calculate based on indices plus new Wind and Ffmc.

Private Attributes
Ffmc	ffmc_
	Fine Fuel Moisture Code.

Dmc	dmc_
	Duff Moisture Code.

Dc	dc_
	Drought Code.

Isi	isi_
	Initial Spread Index.

Bui	bui_
	Build-up Index.

Fwi	fwi_
	Fire Weather Index.

MathSize	mc_ffmc_pct_
	Moisture content (ratio) based on Ffmc.

MathSize	mc_dmc_pct_
	Moisture content (ratio) based on Dmc.

MathSize	ffmc_effect_
	Ffmc effect used for spread.

Detailed Description

A Weather value with calculated FWI indices.

Constructor & Destructor Documentation

◆ FwiWeather() [1/10]

fs::wx::FwiWeather::FwiWeather	(	istringstream *	iss,
		string *	str )

Construct by reading from istringstream.

Parameters

iss	Stream to parse
str	string to read into

◆ FwiWeather() [2/10]

fs::wx::FwiWeather::FwiWeather	(	const FwiWeather &	yesterday,
		const int	month,
		const MathSize	latitude,
		const Temperature &	temp,
		const RelativeHumidity &	rh,
		const Wind &	wind,
		const Precipitation &	prec )

construct by applying noon weather to yesterday's indices

Parameters

yesterday	FwiWeather yesterday used for startup indices
month	Month to calculate for
latitude	Latitude to calculate for
temp	Temperature (Celsius)
rh	Relative Humidity (%)
wind	Wind (km/h)
prec	Precipitation (24hr accumulated, noon-to-noon) (mm)

◆ FwiWeather() [3/10]

fs::wx::FwiWeather::FwiWeather	(	const Temperature &	temp,
		const RelativeHumidity &	rh,
		const Wind &	wind,
		const Precipitation &	prec,
		const Ffmc &	ffmc,
		const Dmc &	dmc,
		const Dc &	dc,
		const Isi &	isi,
		const Bui &	bui,
		const Fwi &	fwi )

noexcept

Constructor.

Parameters

temp	Temperature (Celsius)
rh	Relative Humidity (%)
wind	Wind (km/h)
prec	Precipitation (1hr accumulation) (mm)
ffmc	Fine Fuel Moisture Code
dmc	Duff Moisture Code
dc	Drought Code
isi	Initial Spread Index
bui	Build-up Index
fwi	Fire Weather Index

◆ FwiWeather() [4/10]

fs::wx::FwiWeather::FwiWeather	(	const Temperature &	temp,
		const RelativeHumidity &	rh,
		const Wind &	wind,
		const Precipitation &	prec,
		const Ffmc &	ffmc,
		const Dmc &	dmc,
		const Dc &	dc,
		const Isi &	isi,
		const Bui &	bui )

noexcept

Construct by calculating FWI.

Parameters

temp	Temperature (Celsius)
rh	Relative Humidity (%)
wind	Wind (km/h)
prec	Precipitation (1hr accumulation) (mm)
ffmc	Fine Fuel Moisture Code
dmc	Duff Moisture Code
dc	Drought Code
isi	Initial Spread Index
bui	Build-up Index

◆ FwiWeather() [5/10]

fs::wx::FwiWeather::FwiWeather	(	const Temperature &	temp,
		const RelativeHumidity &	rh,
		const Wind &	wind,
		const Precipitation &	prec,
		const Ffmc &	ffmc,
		const Dmc &	dmc,
		const Dc &	dc )

noexcept

Construct by calculating ISI, BUI, & FWI.

Parameters

temp	Temperature (Celsius)
rh	Relative Humidity (%)
wind	Wind (km/h)
prec	Precipitation (1hr accumulation) (mm)
ffmc	Fine Fuel Moisture Code
dmc	Duff Moisture Code
dc	Drought Code

◆ FwiWeather() [6/10]

fs::wx::FwiWeather::FwiWeather	(	const FwiWeather &	wx,
		const Speed &	ws,
		const Ffmc &	ffmc )

noexcept

Construct by recalculating with different wind Speed and Ffmc.

Parameters

wx	Original weather values
ws	Wind Speed to use
ffmc	Fine Fuel Moisture Code to use

◆ FwiWeather() [7/10]

fs::wx::FwiWeather::FwiWeather ( FwiWeather && rhs )

constexprdefaultnoexcept

Move constructor.

Parameters

rhs	FwiWeather to move from

◆ FwiWeather() [8/10]

fs::wx::FwiWeather::FwiWeather ( const FwiWeather & rhs )

constexprdefaultnoexcept

Copy constructor.

Parameters

rhs	FwiWeather to copy from

◆ FwiWeather() [9/10]

fs::wx::FwiWeather::FwiWeather	(	const FwiWeather &	wx,
		const Wind &	wind,
		const Ffmc &	ffmc,
		const Isi &	isi )

privatenoexcept

Calculate based on indices plus new Wind, Ffmc, and Isi.

Parameters

wx	FwiWeather to use most indices from
wind	Wind to override with
ffmc	Ffmc to override with
isi	Isi calculated from given Wind and Ffmc to override with

◆ FwiWeather() [10/10]

fs::wx::FwiWeather::FwiWeather	(	const FwiWeather &	wx,
		const Wind &	wind,
		const Ffmc &	ffmc )

privatenoexcept

Calculate based on indices plus new Wind and Ffmc.

Parameters

wx	FwiWeather to use most indices from
wind	Wind to override with
ffmc	Ffmc to override with

Member Function Documentation

◆ bui()

const Bui & fs::wx::FwiWeather::bui ( ) const

inlinenodiscardconstexpr

Build-up Index.

Returns: Build-up Index

Here is the caller graph for this function:

◆ dc()

const Dc & fs::wx::FwiWeather::dc ( ) const

inlinenodiscardconstexpr

Drought Code.

Returns: Drought Code

Here is the caller graph for this function:

◆ dmc()

const Dmc & fs::wx::FwiWeather::dmc ( ) const

inlinenodiscardconstexpr

Duff Moisture Code.

Returns: Duff Moisture Code

Here is the caller graph for this function:

◆ ffmc()

const Ffmc & fs::wx::FwiWeather::ffmc ( ) const

inlinenodiscardconstexpr

Fine Fuel Moisture Code.

Returns: Fine Fuel Moisture Code

Here is the caller graph for this function:

◆ ffmcEffect()

MathSize fs::wx::FwiWeather::ffmcEffect ( ) const

inlinenodiscardconstexpr

Ffmc effect used for spread.

Returns: Ffmc effect used for spread

Here is the caller graph for this function:

◆ fwi()

const Fwi & fs::wx::FwiWeather::fwi ( ) const

inlinenodiscardconstexpr

Fire Weather Index.

Returns: Fire Weather Index

Here is the caller graph for this function:

◆ isi()

const Isi & fs::wx::FwiWeather::isi ( ) const

inlinenodiscardconstexpr

Initial Spread Index.

Returns: Initial Spread Index

Here is the caller graph for this function:

◆ mcDmc()

MathSize fs::wx::FwiWeather::mcDmc ( ) const

inlinenodiscardconstexpr

Moisture content (ratio) based on Dmc.

Returns: Moisture content (ratio) based on Dmc

Here is the call graph for this function:

◆ mcDmcPct()

MathSize fs::wx::FwiWeather::mcDmcPct ( ) const

inlinenodiscardconstexpr

Moisture content (%) based on Dmc.

Returns: Moisture content (%) based on Dmc

Here is the caller graph for this function:

◆ mcFfmc()

MathSize fs::wx::FwiWeather::mcFfmc ( ) const

inlinenodiscardconstexpr

Moisture content (ratio) based on Ffmc.

Returns: Moisture content (ratio) based on Ffmc

Here is the call graph for this function:

◆ mcFfmcPct()

MathSize fs::wx::FwiWeather::mcFfmcPct ( ) const

inlinenodiscardconstexpr

Moisture content (%) based on Ffmc.

Returns: Moisture content (%) based on Ffmc

Here is the caller graph for this function:

◆ operator=() [1/2]

FwiWeather & fs::wx::FwiWeather::operator= ( const FwiWeather & rhs )

default

Copy assignment.

Parameters

rhs	FwiWeather to copy from

Returns: This, after assignment

◆ operator=() [2/2]

FwiWeather & fs::wx::FwiWeather::operator= ( FwiWeather && rhs )

defaultnoexcept

Move assignment.

Parameters

rhs	FwiWeather to move from

Returns: This, after assignment

Member Data Documentation

◆ Invalid

const FwiWeather fs::wx::FwiWeather::Invalid

static

Initial value:

{
  Temperature::Invalid,
  RelativeHumidity::Invalid,
  Wind::Invalid,
  Precipitation::Invalid,
  Ffmc::Invalid,
  Dmc::Invalid,
  Dc::Invalid,
  Isi::Invalid,
  Bui::Invalid,
  Fwi::Invalid}

◆ Zero

const FwiWeather fs::wx::FwiWeather::Zero

static

Initial value:

{
  Temperature::Zero,
  RelativeHumidity::Zero,
  Wind::Zero,
  Precipitation::Zero,
  Ffmc::Zero,
  Dmc::Zero,
  Dc::Zero,
  Isi::Zero,
  Bui::Zero,
  Fwi::Zero}

FwiWeather with 0 for all Indices.

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

firestarr/src/cpp/FWI.h
firestarr/src/cpp/FWI.cpp

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FwiWeather() [1/10]

◆ FwiWeather() [2/10]

◆ FwiWeather() [3/10]

◆ FwiWeather() [4/10]

◆ FwiWeather() [5/10]

◆ FwiWeather() [6/10]

◆ FwiWeather() [7/10]

◆ FwiWeather() [8/10]

◆ FwiWeather() [9/10]

◆ FwiWeather() [10/10]

Member Function Documentation

◆ bui()

◆ dc()

◆ dmc()

◆ ffmc()

◆ ffmcEffect()

◆ fwi()

◆ isi()

◆ mcDmc()

◆ mcDmcPct()

◆ mcFfmc()

◆ mcFfmcPct()

◆ operator=() [1/2]

◆ operator=() [2/2]

Member Data Documentation

◆ Invalid

◆ Zero