Extract hydraulic input data from model

Extract hydraulic input data from model

extract_hydraulic_input(
  model,
  initial_water_depth_interior =
    getOption("floodam_building_hydraulic_initial_water_depth_interior"),
  discharge_coefficient = getOption("floodam_building_hydraulic_discharge_coefficient"),
  closed_opening_margin =
    getOption("floodam_building_hydraulic_closed_opening_clearance"),
  verbose = getOption("floodam_building_verbose")
)

Arguments

model

either a character, name given to the model or an object of class 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")

closed_opening_margin

numeric, measurement of the opening gap clearance, default to getOption("floodam_building_hydraulic_closed_opening_clearance")

verbose

boolean, will floodam tells what it is doing, default to getOption("floodam_building_verbose")

Value

component hydraulic of the model