Function reference • floodam.building

All functions

ACTIVITY: Information on activity.

BUILDING: Expected structure of building files

COMPONENT_ELEMENTARY: Elementary component

DAM: Elementary damage functions.

LEGEND: Default value for plotting

add_log(): Add a given msg to a log file

add_wall_width(): add width to data.frame of walls

adjust_coating_03(): Adjust model information in the table coating

adjust_elementary_damaging(): Adjust elementary damaging function to local characteristics

adjust_furniture_02(): Adjust model information in the table furniture

adjust_furniture_03(): Adjust model information in the table furniture

adjust_opening_03(): Adjust model information in the table opening

adjust_room_03(): Adjust model information in the table room

adjust_storey_03(): Adjust model information in the table storey

adjust_wall_03(): Adjust model information in the table wall

analyse_esane(): Plot some analysis of esane data

analyse_hydraulics(): Analyse the hydraulics of the maquette

analyse_model(): Analyse a model.

apply_measure(): Apply vulnerability reduction measures on the model

calculate_surface_height(): Calculate the function giving surface depending on height

calculate_weight_building(): Calculate weight of building damage compared to some other damage

check_damaging(): Chcek if all elementary components in a model has damaging functions.

check_floodam(): Check some integrity of floodam

coating_adaptation_cost(): Add the detail and costs of the changes of coating or the addition of a coating on a changed wall

complete_substitution(): For a selection by room, complete the substitution of the second part of the openings

compose_elementary_damaging(): Compose elementary damaging function

compute_adaptation_costs(): Calculate the total costs of the selected adaptation measures

compute_damage(): Compute damage for a given model

create_combination(): Creates declination of model according to the declination file

create_combination_old(): Creates declination of model according to the declination file

create_component(): Create elementary components from damaging and test internal integrity

create_default_damaging(): Create default damaging functions

create_new_building(): Creates declination of model according to the declination file

create_new_model(): creates a new model template

create_opening_coordinates(): creat opening coordinates when missing.

damaging_as_matrix(): Transform a data.frame of damaging functions in a list of matrix of damaging functions

declinaison_building(): Creates declination of model according to the declination file

distrib_by_room(): group elementary damages by room.

elementary_adaptation_cost(): Add the detail and costs of each new material measure

extract_building_03(): Extract information at building level

extract_building_information(): Extract information of a model from building and furniture components

extract_coating_03(): Extract information at coating level

extract_hydraulic_input(): Extract hydraulic input data from model

extract_opening_03(): Extract information at opening level

extract_parameter_02(): Extract information of type parameter

extract_protection_03(): Extract information at storey level

extract_room_03(): Extract information at room level

extract_something_from_building(): Extract information from a building

extract_something_from_room(): Extract information from a room

extract_something_from_storey(): Extract information from a storey

extract_something_from_wall(): Extract information from a wall

extract_storey_03(): Extract information at storey level

extract_value(): Extract some values information of a model

extract_wall_03(): Extract information at wall level

format_model(): format a model.

generate_limnigraph(): build limnigraph for interior hydraulic simulation

in_range(): Extract from a vector values that are in a certain range

init_create_path(): Define some useful path to use floodam

init_file_name(): Create a list of useful (and expected) file names

inspect_building(): Inspect building part of model.

interpolate_damaging(): Interpolate parameter to make a damaging function

keep_df_order(): Keep rows order in data.frame when a function is applied to it.

list2xml(): Transform a list in xml

load_furniture(): Load furniture for a given model.

load_model(): Load a model from basic files.

make_selection(): Change the selection into a boolean vector depending on component

make_substitution_building(): Changes the origin by the final elements in the building

manage_python(): install python dependencies for the floodam.building hydraulic model

modify_material(): Apply the measures on the building values and create the new tables

order_wall(): Create a trace of order chosen for walls

plot(<analysis_damaging>): Plot analysis of damaging function

plot(<damaging>): Plot damaging function

plot(<efficiency>): Plot efficiency function

plot(<elementary_damaging>): Plot elementary damaging function

plot(<model>): plot a model.

plot(<relative_damaging>): Plot relative damaging function

plot_building_front_03(): plot a front perspective of a building

plot_building_top_03(): plot a top perspective of a building

prepare_substitution(): Prepare the material modification by creating a list of the new elements and a table of correspondence for the changes in the building

print_list(): Print a readable version of list

print_model(): plot a model.

produce_elementary_damaging(): Produce an elementary function damage, save it make a graph if asked.

py_simulate_hydraulics(): Analyse the hydraulics of the maquette

replace_component(): Replace a component in the building tables by another

replace_in_building(): Replace elements in some building part of a model

save_model(): Save a model

show_log(): Show useful information of model.

split_special(): split a data.frame with some preliminary operations

summarize_category_damaging(): Summarize category damaging function

summarize_elementary_damaging(): Summarize elementary damaging function

summarize_model_damaging(): Summarize model damaging function

sumup_damaging(): Summarize detailed list of elementary damaging functions.

update_analysis(): Update analysis of results from floodam. Subject to many changes...

update_ape(): Update damaging functions for activities at ape_05 level

update_ape_damaging(): Update damaging function for a given APE code

update_category(): Update category damaging functions of a given type.

update_category_damaging(): Update damaging function for a given category

update_elementary_damaging(): Update elementary function damages.

update_esane(): Update value used for extrapolation based on esane data base

update_esane_from_csv(): Read INSEE data as generated by update_esane_from_tar

update_esane_from_tar(): Read INSEE data compressed in tar files

update_esane_mean(): Update mean data from INSEE data

update_file_name(): Define some useful file names to use floodam

update_floodam(): Make an update of some useful data when you start with floodam

update_legend(): Check whether the global variable LEGEND is up to date and update it if necessary

update_path(): Define some useful path to use floodam

update_type(): Update models of a given type.