Extract hydraulic input data from model

Usage

prepare_hydraulic_input(
  model,
  exposition,
  initial_water_depth_interior =
    getOption("floodam_building_hydraulic_initial_water_depth_interior"),
  discharge_coefficient = getOption("floodam_building_hydraulic_discharge_coefficient"),
  close_opening_margin = getOption("floodam_building_hydraulic_close_opening_clearance"),
  permeability = c("bottom", "side", "both"),
  verbose = getOption("floodam_building_verbose")
)

Arguments

model: an object of class model
exposition: list, contains list of facade exposed to the flood event. Each facade is a list of named vectors of the walls exposed in the same way. Vectors are named after the external they belong to in the model.
initial_water_depth_interior: numeric, initial water depth in each room in meters, default to getOption("floodam_building_hydraulic_initial_water_depth_interior")
discharge_coefficient: numeric, discharge coefficient for each opening, default to getOption("floodam_building_hydraulic_discharge_coefficient")
close_opening_margin: numeric, measurement of the opening gap clearance, default to getOption("floodam_building_hydraulic_close_opening_clearance")
permeability,: character, optional; if water goes through the side of the opening or bottom or both. Default to bottom, can be side or both
verbose: boolean, will floodam tells what it is doing, default to getOption("floodam_building_verbose")

Value

component hydraulic of the model

Details

This function creates data.frames with data on the openings for the hydraulic module. It creates one for each scenario open close combine