model_inundation: Run bathtub inundation model

In acgold/floodr: Tools to model inundation of stormwater networks

Run bathtub inundation model

Description

Run bathtub inundation model

Usage

model_inundation(
  model,
  elev,
  elev_units,
  overlay = NULL,
  overlay_quantile = 0.95,
  from_elevation = -3,
  to_elevation = 3,
  step = 0.5,
  model_ponding = F,
  DEM_RMSE = 0.2,
  conv_RMSE = 0.1,
  pipe_RMSE = 0.1,
  DEM_confidence = F,
  minimum_area = 0.6,
  minimum_area_units = "km^2",
  min_elev_cutoff = -5,
  use_outlets = T,
  site_name,
  workspace,
  overwrite = T
)

Arguments

model	A bathtub model. Result of assemble_network_model
elev	RasterLayer DEM object for inundation modeling. Result of DEM_setup.
elev_units	Units of elev values
overlay	sf object or RasterLayer of flooding extent (Optional)
overlay_quantile	Quantile of elevation values flooded by overlay to use for modeling flooding (Optional)
from_elevation	Lower bound of elevation for modeling. Units same as model inverts
to_elevation	Upper bound of elevation for modeling. Units same as model inverts
step	Step of sequence between from_elevation and to_elevation. Units same as model inverts
model_ponding	Model overland ponding from structure surcharge? Default F
DEM_RMSE	RMSE of DEM in same units as 'elev_units'. Default is 0.2.
conv_RMSE	RMSE of conversion from NAVD88 to MHHW. Default is 0.1 m
pipe_RMSE	RMSE of elevation or depth measurements of pipes in same units as model$pipes. Default is 0.1
DEM_confidence	Calculate confidence rasters for DEMs? Default is F
minimum_area	Minimum area of flooded area to keep
minimum_area_units	Units of flooded area
min_elev_cutoff	Minimum cutoff for elevation values
use_outlets	Force outlets to be connected by receiving waters (i.e., contiguous flooded area > min_elev_cutoff)
site_name	Name of site
workspace	Path to bathtub folder

Value

A list of sf objects denoting impacted infrastructure from each step of the model. Objects include impacted Pipes, Nodes, and Structures (using propagation through network), Nodes and Structures impacted by overland flooding with no propagation through network (e.g., "np_nodes" & "np_structures"), overland flooding, overland ponding. Includes the overlay if used rather than a range of water levels.

Examples

# bft_model_output <- model_inundation(
# model = bft_model,
# elev = bft_elev,
# elev_units = "m",
# from_elevation = -3,
# to_elevation = 4,
# step = 3/12,
# model_ponding = T,
# site_name = "beaufort",
# minimum_area = 0.01,
# workspace = workspace
# )

acgold/floodr documentation built on Aug. 30, 2022, 11:17 a.m.