Source code for viiapackage.results.results_a5

### ===================================================================================================================
###   A5 MRS analysis result handling
### ===================================================================================================================
# Copyright ©VIIA 2024

### ===================================================================================================================
###   1. Import modules
### ===================================================================================================================

# General imports
from __future__ import annotations
from typing import TYPE_CHECKING, Optional
from pathlib import Path

# References for functions and classes in the viiaPackage
if TYPE_CHECKING:
    from viiapackage.viiaStatus import ViiaProject


### ===================================================================================================================
###   2. Function to handle results for A5 analysis
### ===================================================================================================================

[docs]def viia_results_a5(project: ViiaProject, out_file: Path, runtime: Optional[float] = None): """ Combination of functions to be performed on output of A5 linear time history analysis on flexible base. Includes: - Base shear graph. Input: - project (obj): Project object containing collections and of fem objects and project variables. - analysis_nr (str): Number of the VIIA analysis. For example 'A1'. - out_file (path): The DIANA out-file location and filename of the analysis requested as path. Alternative (str): The DIANA out-file location and filename of the analysis requested as string. - runtime (float): The time that the analysis ran, in [s]. This value is optional and only used to log and stored in database. Default value is None. Output: - Result items of A5 calculation. """ raise NotImplementedError( "ERROR: Currently not available, please request VIIA automating team that you require this function.")
### =================================================================================================================== ### 3. End of script ### ===================================================================================================================