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	saveIndividual () noexcept
	Whether or not to save individual grids.

static void	setSaveIndividual (bool value) noexcept
	Set whether or not to save individual grids.

static bool	runAsync () noexcept
	Whether or not to run things asynchronously where possible.

static void	setRunAsync (bool value) noexcept
	Set whether or not to run things asynchronously where possible.

static bool	deterministic () noexcept
	Whether or not to run deterministically (100% chance of spread & survival)

static void	setDeterministic (bool value) noexcept
	Set whether or not to run deterministically (100% chance of spread & survival)

static bool	surface () noexcept
	Whether or not to run all Cell(s) that can burn in entire Environment.

static void	setSurface (bool value) noexcept
	Set whether or not to run all Cell(s) that can burn in entire Environment.

static bool	saveAsAscii () noexcept
	Whether or not to save grids as .asc.

static void	setSaveAsAscii (bool value) noexcept
	Set whether or not to save grids as .asc.

static bool	savePoints () noexcept
	Whether or not to save points used for spread.

static void	setSavePoints (bool value) noexcept
	Set whether or not to save points used for spread.

static bool	saveIntensity () noexcept
	Whether or not to save intensity grids.

static void	setSaveIntensity (bool value) noexcept
	Set whether or not to save intensity grids.

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 bool	saveOccurrence () noexcept
	Whether or not to save occurrence grids.

static void	setSaveOccurrence (bool value) noexcept
	Set whether or not to save occurrence grids.

static bool	saveSimulationArea () noexcept
	Whether or not to save simulation area grids.

static void	setSaveSimulationArea (bool value) noexcept
	Set whether or not to save simulation area grids.

static bool	forceGreenup () noexcept
	Whether or not to force greenup for all fires.

static void	setForceGreenup (bool value) noexcept
	Whether or not to force greenup for all fires.

static bool	forceNoGreenup () noexcept
	Whether or not to force no greenup for all fires.

static void	setForceNoGreenup (bool value) noexcept
	Whether or not to force no greenup for all fires.

static bool	forceStaticCuring () noexcept
	Whether or not to force static grass curing value for all fires.

static int	staticCuring () noexcept
	Static curing value.

static void	setStaticCuring (const int value) noexcept
	Set static curing value.

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 int	intensityMaxLow () noexcept
	The maximum fire intensity for the 'low' range of intensity (kW/m)

static int	intensityMaxModerate () noexcept
	The maximum fire intensity for the 'moderate' range of intensity (kW/m)

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	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:

◆ deterministic()

bool fs::sim::Settings::deterministic ( )

staticnodiscardnoexcept

Whether or not to run deterministically (100% chance of spread & survival)

Returns: Whether or not to run deterministically (100% chance of spread & survival)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ forceGreenup()

bool fs::sim::Settings::forceGreenup ( )

staticnodiscardnoexcept

Whether or not to force greenup for all fires.

Returns: None

Here is the call graph for this function:

◆ forceNoGreenup()

bool fs::sim::Settings::forceNoGreenup ( )

staticnodiscardnoexcept

Whether or not to force no greenup for all fires.

Returns: None

Here is the call graph for this function:

◆ forceStaticCuring()

bool fs::sim::Settings::forceStaticCuring ( )

staticnodiscardnoexcept

Whether or not to force static grass curing value for all fires.

Returns: Whether or not to force static grass curing value for all fires

Here is the call graph for this function:

Here is the caller 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:

◆ intensityMaxLow()

int fs::sim::Settings::intensityMaxLow ( )

staticnodiscardnoexcept

The maximum fire intensity for the 'low' range of intensity (kW/m)

Returns: The maximum fire intensity for the 'low' range of intensity (kW/m)

Here is the call graph for this function:

Here is the caller graph for this function:

◆ intensityMaxModerate()

int fs::sim::Settings::intensityMaxModerate ( )

staticnodiscardnoexcept

The maximum fire intensity for the 'moderate' range of intensity (kW/m)

Returns: The maximum fire intensity for the 'moderate' range of intensity (kW/m)

Here is the call graph for this function:

Here is the caller 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:

◆ runAsync()

bool fs::sim::Settings::runAsync ( )

staticnodiscardnoexcept

Whether or not to run things asynchronously where possible.

Returns: Whether or not to run things asynchronously where possible

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveAsAscii()

bool fs::sim::Settings::saveAsAscii ( )

staticnodiscardnoexcept

Whether or not to save grids as .asc.

Returns: Whether or not to save grids as .asc

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveIndividual()

bool fs::sim::Settings::saveIndividual ( )

staticnodiscardnoexcept

Whether or not to save individual grids.

Returns: Whether or not to save individual grids

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveIntensity()

bool fs::sim::Settings::saveIntensity ( )

staticnodiscardnoexcept

Whether or not to save intensity grids.

Returns: Whether or not to save intensity grids

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveOccurrence()

bool fs::sim::Settings::saveOccurrence ( )

staticnodiscardnoexcept

Whether or not to save occurrence grids.

Returns: Whether or not to save occurrence grids

Here is the call graph for this function:

◆ savePoints()

bool fs::sim::Settings::savePoints ( )

staticnodiscardnoexcept

Whether or not to save points used for spread.

Returns: Whether or not to save points used for spread

Here is the call graph for this function:

Here is the caller 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:

◆ saveSimulationArea()

bool fs::sim::Settings::saveSimulationArea ( )

staticnodiscardnoexcept

Whether or not to save simulation area grids.

Returns: Whether or not to save simulation area 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:

◆ setDeterministic()

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

staticnoexcept

Set whether or not to run deterministically (100% chance of spread & survival)

Parameters

value Whether or not to run deterministically (100% chance of spread & survival)

Returns: None

Here is the call graph for this function:

◆ setForceGreenup()

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

staticnoexcept

Whether or not to force greenup for all fires.

Returns: Whether or not to force greenup for all fires

Here is the call graph for this function:

◆ setForceNoGreenup()

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

staticnoexcept

Whether or not to force no greenup for all fires.

Returns: Whether or not to force no greenup for all fires

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:

◆ 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:

◆ setRunAsync()

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

staticnoexcept

Set whether or not to run things asynchronously where possible.

Parameters

value Whether or not to run things asynchronously where possible

Returns: None

Here is the call graph for this function:

◆ setSaveAsAscii()

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

staticnoexcept

Set whether or not to save grids as .asc.

Parameters

value Whether or not to save grids as .asc

Returns: None

Here is the call graph for this function:

◆ setSaveIndividual()

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

staticnoexcept

Set whether or not to save individual grids.

Parameters

value Whether or not to save individual grids

Returns: None

Here is the call graph for this function:

◆ setSaveIntensity()

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

staticnoexcept

Set whether or not to save intensity grids.

Parameters

value Whether or not to save intensity grids

Returns: None

Here is the call graph for this function:

◆ setSaveOccurrence()

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

staticnoexcept

Set whether or not to save occurrence grids.

Parameters

value Whether or not to save occurrence grids

Returns: None

Here is the call graph for this function:

◆ setSavePoints()

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

staticnoexcept

Set whether or not to save points used for spread.

Parameters

value Whether or not to save points used for spread

Returns: None

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:

◆ setSaveSimulationArea()

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

staticnoexcept

Set whether or not to save simulation area grids.

Parameters

value Whether or not to save simulation area grids

Returns: None

Here is the call graph for this function:

◆ setStaticCuring()

void fs::sim::Settings::setStaticCuring ( const int value )

staticnoexcept

Set static curing value.

Returns: Set static curing value

Here is the call graph for this function:

◆ setSurface()

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

staticnoexcept

Set whether or not to run all Cell(s) that can burn in entire Environment.

Parameters

value Whether or not to run all Cell(s) that can burn in entire Environment

Returns: None

Here is the call graph for this function:

◆ staticCuring()

int fs::sim::Settings::staticCuring ( )

staticnodiscardnoexcept

Static curing value.

Returns: Static curing value

Here is the call graph for this function:

Here is the caller graph for this function:

◆ surface()

bool fs::sim::Settings::surface ( )

staticnodiscardnoexcept

Whether or not to run all Cell(s) that can burn in entire Environment.

Returns: Whether or not to run all Cell(s) that can burn in entire Environment

Here is the call graph for this function:

Here is the caller 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

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ confidenceLevel()

◆ defaultPercentConifer()

◆ defaultPercentDeadFir()

◆ deterministic()

◆ forceGreenup()

◆ forceNoGreenup()

◆ forceStaticCuring()

◆ fuelLookup()

◆ intensityMaxLow()

◆ intensityMaxModerate()

◆ maxDateOffset()

◆ maximumCountSimulations()

◆ maximumSpreadDistance()

◆ maximumTimeSeconds()

◆ minimumFfmc()

◆ minimumFfmcAtNight()

◆ minimumRos()

◆ offsetSunrise()

◆ offsetSunset()

◆ outputDateOffsets()

◆ rasterRoot()

◆ runAsync()

◆ saveAsAscii()

◆ saveIndividual()

◆ saveIntensity()

◆ saveOccurrence()

◆ savePoints()

◆ saveProbability()

◆ saveSimulationArea()

◆ setConfidenceLevel()

◆ setDeterministic()

◆ setForceGreenup()

◆ setForceNoGreenup()

◆ setFuelLookupTable()

◆ setMaximumTimeSeconds()

◆ setOutputDateOffsets()

◆ setRasterRoot()

◆ setRoot()

◆ setRunAsync()

◆ setSaveAsAscii()

◆ setSaveIndividual()

◆ setSaveIntensity()

◆ setSaveOccurrence()

◆ setSavePoints()

◆ setSaveProbability()

◆ setSaveSimulationArea()

◆ setStaticCuring()

◆ setSurface()

◆ staticCuring()

◆ surface()

◆ thresholdDailyWeight()

◆ thresholdHourlyWeight()

◆ thresholdScenarioWeight()