source: inundation/damage/inundation_damage.py @ 3315

"""Classes for implementing damage curves and economic damage

   Duncan Gray, Ole Nielsen, Jane Sexton, Nick Bartzis
   Geoscience Australia, 2006
"""

from math import sqrt

from pyvolution.data_manager import Exposure_csv
from pyvolution.util import file_function
from geospatial_data.geospatial_data import ensure_absolute
from utilities.numerical_tools import INF
try:  
    import kinds  
except ImportError:  
    # Hand-built mockup of the things we need from the kinds package,
    #since it  
    # was recently removed from the standard Numeric distro.  Some users may  
    # not have it by default.  
    class _bunch:  
        pass  
         
    class _kinds(_bunch):  
        default_float_kind = _bunch()  
        default_float_kind.MIN = 2.2250738585072014e-308  #smallest +ve number
        default_float_kind.MAX = 1.7976931348623157e+308  
     
    kinds = _kinds()

def inundation_damage(sww_file, exposure_file_in,
                      exposure_file_out=None,
                      overwrite=False, verbose=True,
                                 use_cache = True):
    """
    """

    csv = Exposure_csv(exposure_file_in)
    geospatial = csv.get_location()
    max_depth, max_momentum = calc_max_depth_and_momentum(sww_file,
                                                          geospatial,
                                                          verbose=verbose,
                                                          use_cache=use_cache)
    csv.set_column("MAX INUNDATION DEPTH (m)",max_depth)
    csv.set_column("MOMENTUM (m^2/s) ",max_momentum)
    csv.save(exposure_file_out)

    
def add_depth_and_momentum2csv(sww_file, exposure_file_in,
                      exposure_file_out=None,
                      overwrite=False, verbose=True,
                                 use_cache = True):
    """
    """

    csv = Exposure_csv(exposure_file_in)
    geospatial = csv.get_location()
    max_depth, max_momentum = calc_max_depth_and_momentum(sww_file,
                                                          geospatial,
                                                          verbose=verbose,
                                                          use_cache=use_cache)
    csv.set_column("MAX INUNDATION DEPTH (m)",max_depth, overwrite=overwrite)
    csv.set_column("MOMENTUM (m^2/s) ",max_momentum, overwrite=overwrite)
    csv.save(exposure_file_out)
    
def calc_max_depth_and_momentum(sww_file, points,
                                ground_floor_height=0.0,
                                verbose=True,
                                 use_cache = True):
    """
    Calculate the maximum depth above ground height
    """
    quantities =  ['stage', 'elevation', 'xmomentum', 'ymomentum']
    points = ensure_absolute(points)
    point_count = len(points)
    callable_sww = file_function(sww_file,
                                 quantities=quantities,
                                 interpolation_points=points,
                                 verbose=verbose,
                                 use_cache=use_cache)
    # initialise the max lists
    max_depth = [kinds.default_float_kind.MIN]*point_count
    max_momentum = [kinds.default_float_kind.MIN]*point_count
    for point_i, point in enumerate(points):
        for time in callable_sww.get_time():
            quantities = callable_sww(time,point_i)
            #print "quantities", quantities
            
            w = quantities[0]
            z = quantities[1]
            uh = quantities[2]
            vh = quantities[3]
            depth = w - z - ground_floor_height
              
            if depth > max_depth[point_i]:
                max_depth[point_i] = depth
            if w == INF or z == INF or uh == INF or vh == INF:
                continue
            momentum = sqrt(uh*uh + vh*vh)
            if momentum > max_momentum[point_i]:
                max_momentum[point_i] = momentum
    return max_depth, max_momentum