Module viiaTools

This module contains tools that are available for the user in the VIIA workflows.

viiapackage.viiaTools.viia_wind_comparison(project: ViiaProject, height: float, width: float, depth: float, year: Optional[int] = None, roof_type: Literal['flat', 'duopitch'] = 'flat', roof_angle: Optional[float] = None, orientation_angle: float = 0) → Optional[Path][source]

This function is used to execute the seismic assessment of the structure based on the wind comparison procedure. Currently, the wind part of this comparison is available in an automated workflow. User should still copy the relevant data to the NCG template and include the lateral force part for the seismic part of the comparison. Future developments will further assist the user in this workflow.

Note

Function is only available in Python version 3.11 and higher.

Input:

  • project (obj): VIIA project object containing collections of fem objects and project variables.

  • height (float): The height of the (simplified) building structure, in [m].

  • width (float): The width of the (simplified) building structure, in [m]. This is the dimension perpendicular to the wind at 0 degrees. The specification of the front facade aligns with EN1991-1-4 for different roof-types.

  • depth (float): The depth of the (simplified) building structure, in [m]. This is the dimension in the direction of the wind at 0 degrees. The specification of the front facade aligns with EN1991-1-4 for different roof-types.

  • year (int): Optional input for the original construction year (or relevant year of extension). Default value is None, in which case the original construction year is retrieved from MYVIIA (preferred workflow). If year is incorrect, inform the projectleader. The year is used to determine the wind velocity that has occurred on the load resisting structure (note, check for changes in the load bearing structure). User can overrule the original construction year by providing any other year (before 2026).

  • roof_type (str): Select the type of roof for the building structure. Select from ‘flat’ or ‘duopitch’. Default value is ‘flat’.

  • roof_angle (float): For duopitch roofs, the angle of the roof should be provided, in [degrees]. The input is ignored for roof-type ‘flat’. Default value is None.

  • orientation_angle (float): Rotation of the building, in [deg]. Default value is 0. Input is used for the sections of the terrain roughness calculation. 0 degrees is a front facade facing South.

Output:

  • Returns the file-path of the generated report with the wind part of the comparison.

Wind Comparison Tool functionality

viiapackage.wind_comparison.viia_wind_comparison.viia_create_wind_comparison_report(project: ViiaProject, height: float, width: float, depth: float, year: int, roof_type: Literal['flat', 'duopitch'] = 'flat', roof_angle: Optional[float] = None, orientation_angle: float = 0) → Path[source]

This function is used to execute the seismic assessment of the structure based on the wind comparison procedure. Currently, the wind part of this comparison is available in an automated workflow. User should still copy the relevant data to the NCG template and include the lateral force part for the seismic part of the comparison. Future developments will further assist the user in this workflow.

Input:

  • project (obj): VIIA project object containing collections of fem objects and project variables.

  • height (float): The height of the (simplified) building structure, in [m].

  • width (float): The width of the (simplified) building structure, in [m]. This is the dimension perpendicular to the wind at 0 degrees. The specification of the front facade aligns with EN1991-1-4 for different roof-types.

  • depth (float): The depth of the (simplified) building structure, in [m]. This is the dimension in the direction of the wind at 0 degrees. The specification of the front facade aligns with EN1991-1-4 for different roof-types.

  • year (int): Input for the year used to determine the wind load over the lifetime of the current load-bearing structure (before 2026).

  • roof_type (str): Select the type of roof for the building structure. Select from ‘flat’ or ‘duopitch’. Default value is ‘flat’.

  • roof_angle (float): For duopitch roofs, the angle of the roof should be provided, in [degrees]. The input is ignored for roof-type ‘flat’. Default value is None.

  • orientation_angle (float): Rotation of the building, in [deg]. Default value is 0. Input is used for the sections of the terrain roughness calculation. 0 degrees is a front facade facing South.

Output:

  • Returns the file-path of the generated report with the wind part of the comparison.

viiapackage.wind_comparison.viia_wind_comparison.viia_maximum_wind_lifetime(project: ViiaProject, year: int, wind_key: WindKey = 'FHX') → float[source]

Function to compute the maximum highest hourly average wind speed over the lifetime of the structure. The wind metric is retrieved from the Royal Netherlands Meteorological Institute KNMI for weather station of Eelde.

Input:

  • project (obj): VIIA project object containing collections of fem objects and project variables.

  • year (int): Inclusive lower bound for the year filter (e.g., 1970 means filter date.year >= 1970).

  • wind_key (str): The wind metric column in the database to maximize. Default value for the VIIA project is the highest hourly average wind speed.

Output:

  • Returns the maximum value of the highest hourly average wind speed, in [m/s], according measurements at weather station Eelde, over the lifetime of the structure.