Rename nonstructural building damage

CHANGELOG.md

@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Update Non-structural Building Damage to support flood [#562](https://github.com/IN-CORE/pyincore/issues/562)
 - Update flood input to non-structural building damage for combined wind-wave-surge building [#566](https://github.com/IN-CORE/pyincore/issues/566)
 - Rename transportation recovery analysis to traffic flow recovery analysis [#558](https://github.com/IN-CORE/pyincore/issues/558)
+- Rename nonstructural building damage [#537](https://github.com/IN-CORE/pyincore/issues/537)
 
 ### Added
 - Gas Facility Damage Analysis [#568](https://github.com/IN-CORE/pyincore/issues/568)

docs/source/modules.rst

@@ -25,6 +25,13 @@ analyses/buildingfunctionality
 ..  autoclass:: buildingfunctionality.buildingfunctionality.BuildingFunctionality
     :members:
 
+analyses/buildingnonstructdamage
+================================
+..  autoclass:: buildingnonstructdamage.buildingnonstructdamage.BuildingNonStructDamage
+    :members:
+..  autoclass:: buildingnonstructdamage.buildingnonstructutil.BuildingNonStructUtil
+    :members:
+
 analyses/buildingportfolio
 ==========================
 
@@ -231,6 +238,8 @@ analyses/nonstructbuildingdamage
     :members:
 ..  autoclass:: nonstructbuildingdamage.nonstructbuildingutil.NonStructBuildingUtil
     :members:
+..  deprecated:: 1.19.0
+    This class will be deprecated soon. Use :class:`buildingnonstructdamage.BuildingNonStructDamage` instead.
 
 analyses/pipelinedamage
 =======================

pyincore/analyses/buildingnonstructuraldamage/__init__.py

@@ -0,0 +1,9 @@
+# Copyright (c) 2019 University of Illinois and others. All rights reserved.
+#
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License v2.0 which accompanies this distribution,
+# and is available at https://www.mozilla.org/en-US/MPL/2.0/
+
+
+from pyincore.analyses.buildingnonstructuraldamage.buildingnonstructuraldamage import BuildingNonStructDamage
+from pyincore.analyses.buildingnonstructuraldamage.buildingnonstructuralutil import BuildingNonStructUtil

pyincore/analyses/buildingnonstructuraldamage/buildingnonstructuralutil.py

@@ -0,0 +1,62 @@
+# Copyright (c) 2019 University of Illinois and others. All rights reserved.
+#
+# This program and the accompanying materials are made available under the
+# terms of the Mozilla Public License v2.0 which accompanies this distribution,
+# and is available at https://www.mozilla.org/en-US/MPL/2.0/
+
+import collections
+
+
+class BuildingNonStructUtil:
+    """Utility methods for the non-structural building damage analysis."""
+    BUILDING_FRAGILITY_KEYSBUILDING_FRAGILITY_KEYS = {
+        "drift-sensitive fragility id code": ["Drift Sensitive", "DS"],
+        "parametric non-retrofit fragility id code": ["Parametric Non-Retrofit", "PNR"],
+        "acceleration-sensitive fragility id code": ["Acceleration Sensitive", "AS"],
+        "non-retrofit fragility id code": ["as built", "none"]
+    }
+
+    DEFAULT_FRAGILITY_KEY_DS = "Drift-Sensitive Fragility ID Code"
+    DEFAULT_FRAGILITY_KEY_AS = "Acceleration-Sensitive Fragility ID Code"
+
+    @staticmethod
+    def adjust_damage_for_liquefaction(limit_state_probabilities, ground_failure_probabilities):
+        """Adjusts building damage probability based on liquefaction ground failure probability
+        with the liq_dmg, we know that it is 3 values, the first two are the same.
+        The 3rd might be different.
+        We always want to apply the first two to all damage states except the highest.
+
+        Args:
+            limit_state_probabilities (obj): Limit state probabilities.
+            ground_failure_probabilities (list): Ground failure probabilities.
+
+        Returns:
+            OrderedDict: Adjusted limit state probability.
+
+        """
+        keys = list(limit_state_probabilities.keys())
+        adjusted_limit_state_probabilities = collections.OrderedDict()
+
+        for i in range(len(keys)):
+            # check and see...if we are trying to use the last ground failure
+            # number for something other than the
+            # last limit-state-probability, then we should use the
+            # second-to-last probability of ground failure instead.
+
+            if i > len(ground_failure_probabilities) - 1:
+                prob_ground_failure = ground_failure_probabilities[len(ground_failure_probabilities) - 2]
+            else:
+                prob_ground_failure = ground_failure_probabilities[i]
+
+            adjusted_limit_state_probabilities[keys[i]] = \
+                limit_state_probabilities[keys[i]] + prob_ground_failure \
+                - limit_state_probabilities[keys[i]] * prob_ground_failure
+
+        # the final one is the last of limitStates should match with the last of ground failures
+        j = len(limit_state_probabilities) - 1
+        prob_ground_failure = ground_failure_probabilities[-1]
+        adjusted_limit_state_probabilities[keys[j]] = \
+            limit_state_probabilities[keys[j]] \
+            + prob_ground_failure - limit_state_probabilities[keys[j]] * prob_ground_failure
+
+        return adjusted_limit_state_probabilities