build limnigraph for interior hydraulic simulation

Usage

generate_limnigraph(
  model,
  time,
  depth,
  exposed_openings,
  verbose = getOption("floodam_building_verbose")
)

Arguments

model: either a character, name given to the model or an object of class model
time: numeric, vector of time steps (in seconds) at which a specific floodwater depth is reached
depth: numeric, vector of floodwater depth (in meters) for each time step
exposed_openings: character, vector of names of openings to the outside exposed to floods in model
verbose: boolean, will floodam tells what it is doing, default to getOption("floodam_building_verbose")

Value

matrix containing the limnigraph

Examples


# using already loaded library model 'dwelling'
model = dwelling

# analyzing model using the steps *extract* and *hydraulic* 
model = analyse_model(model = dwelling, stage = c("extract", "hydraulic"))
#> Extracting building information for 'adu_t'...
#> 	- extracted:
#>  		- parameter
#>  		- storey
#>  		- room
#>  		- wall
#>  		- opening
#>  		- coating
#>  		- furniture
#> 	- missing (not found):
#>  	... Informations successfully extracted for 'adu_t'
#> Computing some values for 'adu_t'...
#> 	... Informations successfully extracted for 'adu_t'
#> Extracting input data for hydraulic model for 'adu_t'...
#> 	... converting hydraulic input data in 'adu_t' to meters
#> 	... hydraulic input data in 'adu_t' succesfully converted to meters
#> 	... hydraulic input data successfully extracted for 'adu_t'
#> End of analysis for 'adu_t'. Total elapsed time 0.23 secs
#> More information availabe at /tmp/RtmpBUioc4/model/adu/adu_t/adu_t.log
#> 

# generating the limnigraph for the N openings of the modeled dwelling 
flood = generate_limnigraph(
     model = model,
     time = c(0, 5400, 10800),
     depth = c(0,3,0),
     exposed_openings = c("door1", "window1", "window2")
 )
#> generating limnigraph for model 'adu_t'...
#> limnigraph for model 'adu_t' successfully generated