Skip to contents

Original Fire Extension

OriginalFire.Rd

Original Fire Extension

References

LANDIS-II Original Fire v5.0 Extension User Guide https://github.com/LANDIS-II-Foundation/Extension-Base-Fire/blob/master/docs/LANDIS-II%20Original%20Fire%20v5.0%20User%20Guide.pdf

See also

Helpers that prepare inputs for this extension: prepFireRegionParametersTable(), prepInitialFireRegionsMap().

Other Original Fire helpers: defaultFuelCurveTable(), insertFireRegionParametersTable(), insertFuelCurveTable(), insertWindCurveTable(), prepFireRegionParametersTable(), prepInitialFireRegionsMap()

Super class

LandisExtension -> OriginalFire

Active bindings

Species_CSV_File

Character. Relative file path.

FireRegionParametersTable

data.frame.

InitialFireRegionsMap

Character. Relative file path.

DynamicFireRegionTable

data.frame.

FuelCurveTable

data.frame.

WindCurveTable

data.frame.

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

OriginalFire$new()

Usage

OriginalFire$new(
  path,
  Timestep = NULL,
  Species_CSV_File = NULL,
  FireRegionParametersTable = NULL,
  InitialFireRegionsMap = NULL,
  DynamicFireRegionTable = NULL,
  FuelCurveTable = NULL,
  WindCurveTable = 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.

FireRegionParametersTable

data.frame.

InitialFireRegionsMap

SpatRaster.

DynamicFireRegionTable

data.frame.

FuelCurveTable

data.frame.

WindCurveTable

data.frame.

FireDamageTable

data.frame.

MapNames

Character. File pattern for writing outputs to disk.

LogFile

Character. Relative file path.

SummaryLogFile

Character. Relative file path.

OriginalFire$write()

Write extension inputs to disk

Usage

OriginalFire$write()

OriginalFire$clone()

The objects of this class are cloneable with this method.

Usage

OriginalFire$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.