UltradiscreteCA: Ultradiscretized Cellular Automata Model for Landslides

In JomaMinoza/LandslideR: LandslideR: Ultradiscrete Cellular Automata Model for Generalized Mass Failure

Ultradiscretized Cellular Automata Model for Landslides

Description

'UltradiscreteCA' class implements the Ultradiscretized Cellular Automata rules derived from two dimensional diffusion equation

Details

R6 Class representing a

Methods

Public methods

• UltradiscreteCA$new()

• UltradiscreteCA$get_iteration()

• UltradiscreteCA$simulate()

• UltradiscreteCA$get_simulation_particles()

• UltradiscreteCA$get_simulation_slip_values()

• UltradiscreteCA$get_simulation_displacements()

• UltradiscreteCA$get_simulation_sliding_volumes()

• UltradiscreteCA$save_plots()

• UltradiscreteCA$save_output()

• UltradiscreteCA$get_particles()

• UltradiscreteCA$get_slip_values()

• UltradiscreteCA$clone()

---

Method new()

Usage

UltradiscreteCA$new(
  domain,
  slip_area,
  rock_size = 0.5,
  scarp_depth = 1000,
  dynamic_particles = TRUE
)

---

Method get_iteration()

Usage

UltradiscreteCA$get_iteration(particle)

---

Method simulate()

Usage

UltradiscreteCA$simulate(iterations = 5, save = TRUE)

---

Method get_simulation_particles()

Usage

UltradiscreteCA$get_simulation_particles()

---

Method get_simulation_slip_values()

Usage

UltradiscreteCA$get_simulation_slip_values()

---

Method get_simulation_displacements()

Usage

UltradiscreteCA$get_simulation_displacements(every_n = 5)

---

Method get_simulation_sliding_volumes()

Usage

UltradiscreteCA$get_simulation_sliding_volumes(every_n = 5, km = F)

---

Method save_plots()

Usage

UltradiscreteCA$save_plots(
  type = "slide",
  every_n = 1,
  save_location = getwd(),
  ...
)

---

Method save_output()

Usage

UltradiscreteCA$save_output(
  every_n = 5,
  file_name_prefix = "slide",
  folder_location = getwd(),
  crs = "+proj=longlat +datum=WGS84 +ellps=WGS84 +towgs84=0,0,0",
  resolution = c(0.0041656, 0.0041656)
)

---

Method get_particles()

Usage

UltradiscreteCA$get_particles()

---

Method get_slip_values()

Usage

UltradiscreteCA$get_slip_values()

---

Method clone()

The objects of this class are cloneable with this method.

Usage

UltradiscreteCA$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

## Not run: 
data("nwbt.slide.area")
data("nwbt.slide.area.scarp")

# Model Initializiation
model <- UltradiscreteCA$new(
domain = nwbt.slide.area,          # ASCII/NetCDF Format
slip_area = nwbt.slide.area.scarp, # Assumed location of the landslide
rock_size = 0.5 # unit in meters
)

## End(Not run)

JomaMinoza/LandslideR documentation built on May 3, 2024, 9:48 a.m.