La structure du fichier d'entrée

Fichiers d’entrée

floodam.building utilise deux types de fichiers d’entrée :

Un fichier xml/yaml, nommé fichier building ;
Un fichier csv, nommé fichier furniture.

Le fichier building contient des informations sur la géométrie du bâtiment, ainsi que les composants élémentaires et leurs positions respectives (coordonnées xyx). Le fichier furniture contient les informations sur les stocks et le mobilier présents dans le bâtiment, ainsi que leurs emplacement internes (coordonnées xyz).

Le fichier building

Indépendamment du format choisi, qu’il s’agisse d’un –xml ou yaml–, le fichier bâtiment est toujours divisé en trois blocs distincts :

Le bloc général ;
Le bloc élément ;
Le bloc construction.

Chaque bloc fournit des informations différentes. Il est maintenant question de les examiner en détails.

Le bloc general

Ce bloc fournit des informations générales sur le bâtiment. Il comporte cinq caractéristiques obligatoires :

type : type de bâtiment (habitation ou activité) ;
H : hauteur du rez-de-chaussée ;
height : hauteur du bâtiment ;
dilapidation : facteur de vétusté par défaut à utiliser pour les composants élémentaires ;
version : version du fichier xml/yaml utilisé.

Il convient de noter qu’aucune caractéristique supplémentaire ne peut être incluse dans ce bloc.

Le bloc element

Ce bloc contient des informations sur les composants élémentaires présents dans le bâtiment. Il est structuré en sous-blocs pour différencier chaque composant, et chacun d’eux dispose de ses propres caractéristiques à définir. Certains composants sont obligatoires tandis que d’autres sont optionnels :

ceiling : composant élémentaire obligatoire ; liste des types de plafonds présents dans le bâtiment. Chaque type doit être défini à l’aide des caractéristiques suivantes
- material : caractéristique obligatoire ; matériau utilisé pour le plafond
- H : caractéristique obligatoire ; hauteur à laquelle se trouve le plafond (par rapport au sol de la pièce dans laquelle se trouve le plafond)
- insulating : caractéristique facultative ; matériau utilisé pour isoler ce type de plafond
- coating : caractéristique facultative ; matériau utilisé pour le revêtement de ce type de plafond
wall: composante élémentaire obligatoire ; liste des types de murs présents dans le bâtiment. Chaque type doit être défini à l’aide des caractéristiques suivantes :
- wall_type: caractéristique obligatoire ; type de mur
  - Il doit être choisi parmi load_bearing_wall, lining, partition ou empty
- material: caractéristique obligatoire ; matériau utilisé pour le mur
- insulating: caractéristique facultative ; matériau utilisé pour isoler ce type de mur
- render: caractéristique facultative ; matériau utilisé pour le rendu de ce type de mur
baseboard: composant élémentaire facultatif ; liste des types de plinthes présents dans le bâtiment. Chaque type doit être défini à l’aide des caractéristiques suivantes :
- material: caractéristique obligatoire ; matériau utilisé pour la plinthe
- width: caractéristique obligatoire ; largeur de la plinthe
coating: composant élémentaire facultatif ; liste des types de revêtements muraux présents dans le bâtiment. Chaque type doit être défini à l’aide des caractéristiques suivantes :
- material: caractéristique obligatoire ; matériau utilisé pour le revêtement.
coverstrip: composant élémentaire facultatif ; liste des types de couvre-joints présents dans le bâtiment. Chaque type doit être défini à l’aide des caractéristiques suivantes :
- material: caractéristique obligatoire ; matériau utilisé pour la bande de recouvrement.
floor: composant élémentaire facultatif ; liste des types d’étages présents dans le bâtiment. Chaque type doit être défini à l’aide des caractéristiques suivantes :
- material: caractéristique obligatoire ; matériau utilisé pour le sol
- insulating: caractéristique facultative ; matériau utilisé pour isoler ce type de sol
- coating: caractéristique facultative ; matériau utilisé pour le revêtement de ce type de sol
opening: composante élémentaire facultative ; liste des types d’ouvertures présentes dans le bâtiment. Chaque type doit être défini à l’aide des caractéristiques suivantes :
- opening_type: caractéristique obligatoire ; type d’ouverture
  - Il doit être choisi parmi door, french.window, window or empty
- height: caractéristique obligatoire ; hauteur de l’ouverture
- width: caractéristique obligatoire ; largeur de l’ouverture
- material: caractéristique facultative ; matériau utilisé pour l’ouverture
- shutter: caractéristique facultative ; matériau utilisé pour le volet avec ce type d’ouverture

Le bloc building

Ce bloc fournit des informations sur la géométrie du bâtiment et sur l’emplacement des composants structurels élémentaires déclarés dans le bloc précédent.

Les informations contenues dans ce bloc doivent être décrites par étages. En d’autres termes, la géométrie et l’emplacement des composants élémentaires doivent être déterminés étage par étage. Pour chaque étage, les caractéristiques suivantes doivent être fournies :

H: caractéristique obligatoire ; hauteur à laquelle l’étage est situé (par rapport au sol)
height: caractéristique facultative ; hauteur de l’étage. Cette valeur est utilisée comme hauteur par défaut des murs si cette information est manquante
name: élément facultatif ; nom de l’étage

Les informations relatives à chaque étage sont organisées en deux sous-blocs :

Le sous-bloc dit external: partie externe de l’étage, à savoir le mur extérieur. Ce bloc est censé contenir autant de sous-blocs wall que de murs extérieurs définissant le périmètre du bâtiment.
Le sous-bloc dit room: partie intérieure de l’étage ou, en d’autres termes, la distribution intérieure de l’étage. Ce bloc est destiné à être répété autant de fois qu’il y a de pièces dans l’étage.

Les deux sous-blocs partagent le même ensemble de caractéristiques :

wall: caractéristique obligatoire ; chaque pièce est constituée d’une liste de murs. Chaque mur possède les caractéristiques suivantes :
- coordinates: caractéristique obligatoire ; coordonnées du point de départ du mur
- type: caractéristique obligatoire ; type de mur
- H: caractéristique facultative ; hauteur à laquelle le mur est situé (par rapport au sol de la pièce)
- height: caractéristique facultative ; hauteur du mur
- side: caractéristique facultative ; côté du bâtiment où se trouve le mur.
- name: caractéristique facultative ; nom du mur.
De plus, chaque paroi peut présenter les deux caractéristiques suivantes :
- coating: caractéristique facultative ; s’il est fourni, chaque revêtement présente les caractéristiques suivantes :
  - type: caractéristique obligatoire ; type de revêtement
  - H: caractéristique facultative ; hauteur à laquelle le revêtement commence (par rapport à la base du mur sur lequel le revêtement est situé). La hauteur à laquelle le revêtement se termine est donnée soit par la hauteur à laquelle commence le revêtement suivant, soit par la hauteur du mur sur lequel se trouve le revêtement.
- opening: caractéristique facultative ; si elle est prévue, chaque ouverture présente les caractéristiques suivantes :
  - type: caractéristique obligatoire ; type d’ouverture
  - H: caractéristique obligatoire ; hauteur à laquelle l’ouverture est située (par rapport à la base du mur sur lequel l’ouverture est située)
  - coordinates: caractéristique facultative ; coordonnées du centre de l’ouverture
  - name: caractéristique facultative ; nom de l’ouverture
  - coverstrip: caractéristique facultative ; type de couvre-joint utilisé
name: élément facultatif ; nom de la pièce
baseboard: caractéristique facultative ; type de plinthe utilisé dans la pièce
ceiling: caractéristique facultative ; type de plafond utilisé dans la pièce
floor: caractéristique facultative ; type de sol utilisé dans la pièce
H: caractéristique facultative ; hauteur à laquelle la pièce est située (par rapport à la base de l’étage dans lequel la pièce est située)

Le fichier furniture

Le fichier furniture fournit des informations sur le stock et/ou le mobilier du bâtiment. Les champs suivants doivent être remplis :

component_elementary: nom du type de composant élémentaire ;
room_name: nom de la pièce où se trouve le composant élémentaire ;
wall_name: nom du mur où se trouve le composant élémentaire ;
relative_height: hauteur en cm à laquelle se trouve le composant élémentaire, par rapport au sol de la pièce où se trouve le composant ;
dilapidation: facteur de vétusté propre à utiliser pour le composant élémentaire (remplace celui défini au niveau du bâtiment) ;
quantity: quantité dans laquelle le composant élémentaire est présent ;
v_min: valeur minimale de remplacement (remplace celle définie par défaut pour le type de composant élémentaire) ;
v_max: valeur maximale de remplacement (remplace celle définie par défaut pour le type de composant élémentaire).

Voir l’exemple ci-dessous :