Hydraulic input

This document describes the inputs required to run the hydraulic and damage analyses provided by the package. It outlines the main objects (model, limnigraph), and the recommended workflow: prepare or load a model with analyse_model() (for example, adu_t), build a limnigraph with generate_limnigraph(), then run analyse_hydraulic() with stage = c("hydraulic", ...). Use detail = TRUE during development to inspect full matrices, and detail = FALSE for summary outputs.

General parameters

Stage

Stages define what the program will do. It is mandatory to include "hydraulic" to your stages as all the other stages depends on this one.

Argument	Description	Default
stage	Defines which parts of the analysis are executed. Can include "hydraulic", "damaging", "dangerosity", "graph", "save", "display".	""

Model

The model object contains the geometric and hydraulic description of the building.
It defines rooms, walls, openings, and their connections, as well as elevation data and damage functions.
This structured object is produced by the analyse_model() function and is the foundation for hydraulic, damage, and danger analysis.

Limnigraph

A limnigraph defines the external flood boundary conditions applied to the model.
It provides time series of water levels at each exposed façade and specifies which walls are affected by the flooding.
This input controls how floodwater enters the hydraulic system over time and is created using the generate_limnigraph() function.

Hydraulic Parameters

Several arguments control how the hydraulic system is configured and simulated.

Argument	Description	Default
opening_scenario	Defines which openings are open or closed. Options: "open", "close", "combine"	"close"
Cd	Discharge coefficient applied to all openings	0.42
clearance	Distance between opening and its frame, controlling tightness. It is a named vector with under and/or side entries.	c(under = 0.5, side = 0.5) cm
height_break	Differential head required to break an opening	1.0 m
dt_max	Maximum simulation time step (used for adaptive stepping)	0.5 s

The figure below represents the clearances when doors are closed. In the code it stands as 2 openings, one vertical and one horizontal. There is a small overlap at the intersection of both the openings but it is considered negligible.

Other Parameters

Argument	Description	Default
sim_id	Optional string identifier for the simulation	NULL
detail	If TRUE, returns full simulation matrices; otherwise, only summary results (hmax, damage)	TRUE
verbose	If TRUE, prints progress messages during execution	from global option
what	Elements to save when "save" is included in stage	c("hmax", "damage")