Skip to contents

Dynamic Fire System Extension

DynamicFire.Rd

Dynamic Fire System Extension

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

Super class

landisutils::LandisExtension -> DynamicFire

Active bindings

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.

Methods

Public methods

Inherited methods

Method new()

Usage

DynamicFire$new(
  path,
  Timestep = 10,
  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.

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.

Method write()

Write extension inputs to disk

Usage

DynamicFire$write()

Method 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