fs::sim::Settings Class Reference

Reads and provides access to settings for the simulation. More...

#include <Settings.h>

Static Public Member Functions
static void	setRoot (const char *dirname) noexcept
	Set root directory and read settings from file.
static void	setRasterRoot (const char *dirname) noexcept
	Set raster root directory.
static const char *	rasterRoot () noexcept
	Root directory that raster inputs are stored in.
static void	setFuelLookupTable (const char *filename) noexcept
	Set fuel lookup table file.
static const fuel::FuelLookup &	fuelLookup () noexcept
	Fuel lookup table.
static bool	saveProbability () noexcept
	Whether or not to save probability grids.
static void	setSaveProbability (bool value) noexcept
	Set whether or not to save probability grids.
static MathSize	minimumRos () noexcept
	Minimum rate of spread before fire is considered to be spreading (m/min)
static void	setMinimumRos (MathSize value) noexcept
static MathSize	maximumSpreadDistance () noexcept
	Maximum distance that the fire is allowed to spread in one step (# of cells)
static MathSize	minimumFfmc () noexcept
	Minimum Fine Fuel Moisture Code required for spread during the day.
static MathSize	minimumFfmcAtNight () noexcept
	Minimum Fine Fuel Moisture Code required for spread during the night.
static DurationSize	offsetSunrise () noexcept
	Offset from sunrise at which the day is considered to start (hours)
static DurationSize	offsetSunset () noexcept
	Offset from sunrise at which the day is considered to end (hours)
static int	defaultPercentConifer () noexcept
	Default Percent Conifer to use for M1/M2 fuels where none is specified (%)
static int	defaultPercentDeadFir () noexcept
	Default Percent Dead Fir to use for M3/M4 fuels where none is specified (%)
static ThresholdSize	confidenceLevel () noexcept
	Confidence required before simulation stops (% / 100)
static void	setConfidenceLevel (const ThresholdSize value) noexcept
	Set confidence required before simulation stops (% / 100)
static size_t	maximumTimeSeconds () noexcept
	Maximum time simulation can run before it is ended and whatever results it has are used (s)
static void	setMaximumTimeSeconds (const size_t value) noexcept
	Set maximum time simulation can run before it is ended and whatever results it has are used (s)
static size_t	interimOutputIntervalSeconds () noexcept
	Time between generating interim outputs (s)
static void	setInterimOutputIntervalSeconds (const size_t value) noexcept
	Set time between generating interim outputs (s)
static size_t	maximumCountSimulations () noexcept
	Maximum number of simulations that can run before it is ended and whatever results it has are used.
static ThresholdSize	thresholdScenarioWeight () noexcept
	Weight to give to Scenario part of thresholds.
static ThresholdSize	thresholdDailyWeight () noexcept
	Weight to give to daily part of thresholds.
static ThresholdSize	thresholdHourlyWeight () noexcept
	Weight to give to hourly part of thresholds.
static vector< int >	outputDateOffsets ()
	Days to output probability contours for (1 is start date, 2 is day after, etc.)
static void	setOutputDateOffsets (const char *value)
	Set days to output probability contours for (1 is start date, 2 is day after, etc.)
static int	maxDateOffset () noexcept
	Whatever the maximum value in the date offsets is.

Detailed Description

Reads and provides access to settings for the simulation.

Member Function Documentation

confidenceLevel()

ThresholdSize fs::sim::Settings::confidenceLevel ( )

staticnodiscardnoexcept

Confidence required before simulation stops (% / 100)

Returns

Confidence required before simulation stops (% / 100)

Here is the call graph for this function:

defaultPercentConifer()

int fs::sim::Settings::defaultPercentConifer ( )

staticnodiscardnoexcept

Default Percent Conifer to use for M1/M2 fuels where none is specified (%)

Returns

Percent of the stand that is composed of conifer (%)

Here is the call graph for this function:

defaultPercentDeadFir()

int fs::sim::Settings::defaultPercentDeadFir ( )

staticnodiscardnoexcept

Default Percent Dead Fir to use for M3/M4 fuels where none is specified (%)

Returns

Percent of the stand that is composed of dead fir (NOT percent of the fir that is dead) (%)

Here is the call graph for this function:

fuelLookup()

const fuel::FuelLookup & fs::sim::Settings::fuelLookup ( )

staticnodiscardnoexcept

Fuel lookup table.

Returns

Fuel lookup table

Here is the call graph for this function:

Here is the caller graph for this function:

interimOutputIntervalSeconds()

size_t fs::sim::Settings::interimOutputIntervalSeconds ( )

staticnodiscardnoexcept

Time between generating interim outputs (s)

Returns

Time between generating interim outputs (s)

Here is the call graph for this function:

maxDateOffset()

int fs::sim::Settings::maxDateOffset ( )

staticnodiscardnoexcept

Whatever the maximum value in the date offsets is.

Returns

Whatever the maximum value in the date offsets is

Here is the call graph for this function:

Here is the caller graph for this function:

maximumCountSimulations()

size_t fs::sim::Settings::maximumCountSimulations ( )

staticnodiscardnoexcept

Maximum number of simulations that can run before it is ended and whatever results it has are used.

Returns

Maximum number of simulations that can run before it is ended and whatever results it has are used

Here is the call graph for this function:

Here is the caller graph for this function:

maximumSpreadDistance()

MathSize fs::sim::Settings::maximumSpreadDistance ( )

staticnodiscardnoexcept

Maximum distance that the fire is allowed to spread in one step (# of cells)

Returns

Maximum distance that the fire is allowed to spread in one step (# of cells)

Here is the call graph for this function:

Here is the caller graph for this function:

maximumTimeSeconds()

size_t fs::sim::Settings::maximumTimeSeconds ( )

staticnodiscardnoexcept

Maximum time simulation can run before it is ended and whatever results it has are used (s)

Returns

Maximum time simulation can run before it is ended and whatever results it has are used (s)

Here is the call graph for this function:

Here is the caller graph for this function:

minimumFfmc()

MathSize fs::sim::Settings::minimumFfmc ( )

staticnodiscardnoexcept

Minimum Fine Fuel Moisture Code required for spread during the day.

Returns

Minimum Fine Fuel Moisture Code required for spread during the day

Here is the call graph for this function:

Here is the caller graph for this function:

minimumFfmcAtNight()

MathSize fs::sim::Settings::minimumFfmcAtNight ( )

staticnodiscardnoexcept

Minimum Fine Fuel Moisture Code required for spread during the night.

Returns

Minimum Fine Fuel Moisture Code required for spread during the night

Here is the call graph for this function:

Here is the caller graph for this function:

minimumRos()

MathSize fs::sim::Settings::minimumRos ( )

staticnodiscardnoexcept

Minimum rate of spread before fire is considered to be spreading (m/min)

Returns

Minimum rate of spread before fire is considered to be spreading (m/min)

Here is the call graph for this function:

Here is the caller graph for this function:

offsetSunrise()

DurationSize fs::sim::Settings::offsetSunrise ( )

staticnodiscardnoexcept

Offset from sunrise at which the day is considered to start (hours)

Returns

Offset from sunrise at which the day is considered to start (hours)

Here is the call graph for this function:

offsetSunset()

DurationSize fs::sim::Settings::offsetSunset ( )

staticnodiscardnoexcept

Offset from sunrise at which the day is considered to end (hours)

Returns

Offset from sunrise at which the day is considered to end (hours)

Here is the call graph for this function:

outputDateOffsets()

vector< int > fs::sim::Settings::outputDateOffsets ( )

staticnodiscard

Days to output probability contours for (1 is start date, 2 is day after, etc.)

Returns

Days to output probability contours for (1 is start date, 2 is day after, etc.)

Here is the call graph for this function:

Here is the caller graph for this function:

rasterRoot()

const char * fs::sim::Settings::rasterRoot ( )

staticnodiscardnoexcept

Root directory that raster inputs are stored in.

Returns

Root directory that raster inputs are stored in

Here is the call graph for this function:

saveProbability()

bool fs::sim::Settings::saveProbability ( )

staticnodiscardnoexcept

Whether or not to save probability grids.

Returns

Whether or not to save probability grids

Here is the call graph for this function:

Here is the caller graph for this function:

setConfidenceLevel()

void fs::sim::Settings::setConfidenceLevel ( const ThresholdSize value )

staticnoexcept

Set confidence required before simulation stops (% / 100)

Returns

Set confidence required before simulation stops (% / 100)

Here is the call graph for this function:

setFuelLookupTable()

void fs::sim::Settings::setFuelLookupTable ( const char * filename )

staticnoexcept

Set fuel lookup table file.

Parameters

dirname

Directory to use for rasters

Here is the call graph for this function:

setInterimOutputIntervalSeconds()

void fs::sim::Settings::setInterimOutputIntervalSeconds ( const size_t value )

staticnoexcept

Set time between generating interim outputs (s)

Returns

Set time between generating interim outputs (s)

Here is the call graph for this function:

setMaximumTimeSeconds()

void fs::sim::Settings::setMaximumTimeSeconds ( const size_t value )

staticnoexcept

Set maximum time simulation can run before it is ended and whatever results it has are used (s)

Returns

Set maximum time simulation can run before it is ended and whatever results it has are used (s)

Here is the call graph for this function:

setOutputDateOffsets()

void fs::sim::Settings::setOutputDateOffsets ( const char * value )

static

Set days to output probability contours for (1 is start date, 2 is day after, etc.)

Returns

None

Here is the call graph for this function:

setRasterRoot()

void fs::sim::Settings::setRasterRoot ( const char * dirname )

staticnoexcept

Set raster root directory.

Parameters

dirname

Directory to use for rasters

Here is the call graph for this function:

setRoot()

void fs::sim::Settings::setRoot ( const char * dirname )

staticnoexcept

Set root directory and read settings from file.

Parameters

dirname

Directory to use for settings and relative paths

Here is the call graph for this function:

setSaveProbability()

void fs::sim::Settings::setSaveProbability ( bool value )

staticnoexcept

Set whether or not to save probability grids.

Parameters

value

Whether or not to save probability grids

Returns

None

Here is the call graph for this function:

thresholdDailyWeight()

ThresholdSize fs::sim::Settings::thresholdDailyWeight ( )

staticnodiscardnoexcept

Weight to give to daily part of thresholds.

Returns

Weight to give to daily part of thresholds

Here is the call graph for this function:

thresholdHourlyWeight()

ThresholdSize fs::sim::Settings::thresholdHourlyWeight ( )

staticnodiscardnoexcept

Weight to give to hourly part of thresholds.

Returns

Weight to give to hourly part of thresholds

Here is the call graph for this function:

thresholdScenarioWeight()

ThresholdSize fs::sim::Settings::thresholdScenarioWeight ( )

staticnodiscardnoexcept

Weight to give to Scenario part of thresholds.

Returns

Weight to give to Scenario part of thresholds

Here is the call graph for this function:

---

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

• firestarr/src/cpp/Settings.h
• firestarr/src/cpp/Settings.cpp