Skip to contents

Dynamic Fire System Extension

DynamicFire.Rd

Dynamic Fire System Extension

References

LANDIS-II Dynamic Fire System Extension v4 User Guide https://github.com/LANDIS-II-Foundation/Extension-Dynamic-Fire-System/blob/master/docs/LANDIS-II%20Dynamic%20Fire%20System%20v4%20User%20Guide.pdf

See also

Helpers that prepare inputs for this extension: prepFireSizesTable(), prepDynamicEcoregionTable(), prepTopographyFile(), prepGroundSlopeFile(), prepUphillAzimuthMap(), prepInitialWeatherDatabase(), prepDynamicWeatherTable().

Other Dynamic Fire helpers: apply_calibrated_hi_prop(), apply_calibrated_ignprob(), defaultFuelTypeTable(), insertBuildUpIndex(), insertFireSizesTable(), insertFuelTypeTable(), insertGroundSlopeFile(), insertSeasonTable(), insertUphillSlopeAzimuthMap(), prepDynamicEcoregionTable(), prepDynamicWeatherTable(), prepFireSizesTable(), prepInitialWeatherDatabase(), prepTopographyFile()

Super class

LandisExtension -> DynamicFire

Active bindings

Species_CSV_File

Character. Relative file path.

EventSizeType

Character. One of "size_based" or "duration_based".

BuildUpIndex

Logical, or character indicating "yes" or "no".

WeatherRandomizer

(Optional) Integer [0,4] controlling the strength of the linkage between fire size/duration distribution and weather distribution.

FireSizesTable

data.frame.

InitialFireEcoregionsMap

Character. Relative file path.

DynamicEcoregionTable

data.frame.

GroundSlopeFile

Character. Relative file path.

UphillSlopeAzimuthMap

Character. Relative file path.

SeasonTable

data.frame.

InitialWeatherDatabase

Character. Relative file path.

DynamicWeatherTable

data.frame.

FuelTypeTable

data.frame.

SeverityCalibrationFactor

Numeric.

FireDamageTable

data.frame.

MapNames

Character. File pattern for writing outputs to disk.

LogFile

Character. Relative file path.

SummaryLogFile

Character. Relative file path.

output_files

Character vector of output files (relative paths from the scenario directory) that this extension is expected to produce at run time. Subclasses override this to return their extension-specific log files, event CSVs, etc. These paths are collected by scenario() and written to output_manifest.txt so tar_landis() can track them explicitly without relying on list.files() discovery.

Map files whose names depend on the timestep (e.g. BiomassC-10.tif) are NOT included here; they are discovered by tar_landis()'s output_dir scan instead.

Methods

Public methods

Inherited methods

DynamicFire$new()

Usage

DynamicFire$new(
  path,
  Timestep = 10,
  Species_CSV_File = NULL,
  EventSizeType = NULL,
  BuildUpIndex = NULL,
  WeatherRandomizer = NULL,
  FireSizesTable = NULL,
  InitialFireEcoregionsMap = NULL,
  DynamicEcoregionTable = NULL,
  GroundSlopeFile = NULL,
  UphillSlopeAzimuthMap = NULL,
  SeasonTable = NULL,
  InitialWeatherDatabase = NULL,
  DynamicWeatherTable = NULL,
  FuelTypeTable = NULL,
  SeverityCalibrationFactor = NULL,
  FireDamageTable = NULL,
  MapNames = NULL,
  LogFile = "fire/log.csv",
  SummaryLogFile = "fire/summary-log.csv"
)

Arguments

path

Character. Directory path.

Timestep

Integer.

Species_CSV_File

Character. Relative file path to the per-species fire-coefficient CSV (must precede EventSizeType in the emitted config).

EventSizeType

Character. One of "size_based" or "duration_based".

BuildUpIndex

Logical, or character indicating "yes" or "no".

WeatherRandomizer

Integer [0, 4].

FireSizesTable

data.frame.

InitialFireEcoregionsMap

Character. Relative file path.

DynamicEcoregionTable

data.frame.

GroundSlopeFile

Character. Relative file path.

UphillSlopeAzimuthMap

Character. Relative file path.

SeasonTable

data.frame.

InitialWeatherDatabase

Character. Relative file path.

DynamicWeatherTable

data.frame.

FuelTypeTable

data.frame.

SeverityCalibrationFactor

data.frame.

FireDamageTable

data.frame.

MapNames

Character. File pattern for writing outputs to disk.

LogFile

Character. Relative file path.

SummaryLogFile

Character. Relative file path.

DynamicFire$write()

Write extension inputs to disk

Usage

DynamicFire$write()

DynamicFire$clone()

The objects of this class are cloneable with this method.

Usage

DynamicFire$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## see vignette for usage examples