FireSTARR
Loading...
Searching...
No Matches
fs::settings::Settings Class Reference

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

#include <Settings.h>

Collaboration diagram for fs::settings::Settings:

Public Member Functions

const string getRoot () const noexcept
 
const string getBinaryDirectory () const noexcept
 
 Settings (const string dir_binary, const string dir_root) noexcept
 
string create (const pushd &dir) const
 
void saveTo (const string &output_directory) const noexcept
 
bool found (const string &key) const noexcept
 
string log_directory () const
 
constexpr bool is_test () const
 
constexpr bool is_surface () const
 
FwiWeather get_weather () const
 

Static Public Member Functions

static void setRoot (const string dir_binary, const string dir_root) noexcept
 

Public Attributes

Mode mode {Mode::Simulation}
 
string output_directory {}
 
LazyPath wx_file_name {}
 
string log_file_name {"firestarr.log"}
 
string log_file {}
 
LazyPath perimeter {}
 
bool save_individual {false}
 
bool run_async {true}
 
bool deterministic {false}
 
bool save_as_ascii {false}
 
bool save_as_tiff {true}
 
bool save_points {false}
 
bool save_intensity {true}
 
bool save_probability {true}
 
bool save_occurrence {false}
 
bool save_simulation_area {false}
 
bool force_greenup {false}
 
bool force_no_greenup {false}
 
bool no_search {false}
 
StaticCuring static_curing {}
 
MathSize minimum_ros {0.0}
 
MathSize maximum_spread_distance {0.0}
 
MathSize minimum_ffmc {0.0}
 
MathSize minimum_ffmc_at_night {0.0}
 
std::optional< DurationSize > utc_offset {}
 
DurationSize offset_sunrise {0.0}
 
DurationSize offset_sunset {0.0}
 
int default_percent_conifer {0}
 
int default_percent_dead_fir {0}
 
int intensity_max_low {0}
 
int intensity_max_moderate {0}
 
ThresholdSize confidence_level {0.0}
 
size_t salt {0}
 
size_t maximum_time_seconds {0}
 
size_t interim_output_interval_seconds {0}
 
size_t minimum_simulation_count {0}
 
size_t minimum_active_simulation_count {0}
 
size_t maximum_simulation_count {0}
 
ThresholdSize threshold_scenario_weight {0.0}
 
ThresholdSize threshold_daily_weight {0.0}
 
ThresholdSize threshold_hourly_weight {0.0}
 
LazyPath raster_root {}
 
LazyFuelLookup fuel_lookup {}
 
OutputDateOffsets output_date_offsets {}
 
Precipitation apcp_prev {Precipitation::Zero()}
 
std::optional< size_t > initial_size {}
 
std::optional< tm > start_date {}
 
std::optional< MathSize > latitude {}
 
std::optional< MathSize > longitude {}
 
std::optional< string > fuel_name {}
 
std::optional< bool > test_all {}
 
std::optional< MathSize > hours {}
 
std::optional< Ffmc > ffmc {}
 
std::optional< Dmc > dmc {}
 
std::optional< Dc > dc {}
 
std::optional< MathSize > wind_direction {}
 
std::optional< MathSize > wind_speed {}
 
std::optional< SlopeSize > slope {}
 
std::optional< AspectSize > aspect {}
 

Private Attributes

string dir_binary_
 
string dir_root_
 
std::pair< string_map< string >, string_map< string > > settings_
 

Detailed Description

Reads and provides access to settings for the simulation.


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