qin.py

Go to the documentation of this file.

# -*- coding: utf-8 -*-
"""
Created on Tue Apr 28 13:09:53 2020
 
@author: cd
"""
 
 
import abc
import numpy as np
import h5py
from efo.time import TimeBase
from efo.lookup import LkupTblAnn
 
class QinBase(metaclass=abc.ABCMeta):
    def __init__(self, name):
        # TODO: Some subclass properties could be super class properties
        self.namename = name
        super().__init__()    
    @abc.abstractmethod
    def get_qin(self):
        pass
    @classmethod
    def __subclasshook__(cls,C):
        if cls is QinBase:
            attrs = set(dir(C))
            if set(cls.__abstractmethods__) <= attrs:
                return True
        return NotImplemented
        
  
# TODO: This class should be modified to check dates to make sure that the begin 
# and end dates all match and if not then send an error (maybe this should just
# happen in the script for now)
class Qin(QinBase):
    def __init__(self, name, time, qIn):
        # Call super class constructor
        super().__init__(name)
        # Set class properties
        # TODO: Error handling to make sure these things can be assigned
        # TODO: Change this from qIn to just q
        self.qInqIn = qIn
        self.TT = time 
        # TODO: Add a time offset option that can add or subtract time to the current step
        
    def get_qin(self, tsOffset=0):
        return self.qInqIn[min(self.TT.end,self.TT.step + tsOffset)].item()
        
 
class QinRouted(QinBase):
    def __init__(self, name, time, reachUs):
        # Call super class constructor
        super().__init__(name)
        # Set class properties
        # TODO: Error handling
        self.reachUsreachUs = reachUs
         # TODO: Should use error handling instead
        if issubclass(type(time), TimeBase):
            self.TT = time
            
    def get_qin(self, tsOffset=0):
        # TODO: Need to apply and offset option
        return self.reachUsreachUs.calc_qout(tsOffset=tsOffset)
    
    
class QinLkup(QinBase):
    # TODO: Add a hydrologic conditions option for this
    def __init__(self, name, time, monthDayHr, qTblVals, *,
                 typ='interp', timeUnit=None):
        # Call super class constructor
        super().__init__(name)
        # Set class properties
        self.qLkupTblqLkupTbl = LkupTblAnn(name+'Tbl',  time, monthDayHr, qTblVals,
                                   typ=typ, timeUnit=timeUnit)
         # TODO: Should use error handling instead
        if issubclass(type(time), TimeBase):
            self.TT = time
            self.qInqIn = np.empty(time.nSteps)  
 
    def get_qin(self, tsOffset=0):
        # TODO: Need to apply and offset option
        qIn = self.qLkupTblqLkupTbl.get_val(self.TT.get_datetime_offset(tsOffset))
        self.qInqIn[min(self.TT.end, self.TT.step + tsOffset)] = qIn
        return qIn
        
     
class Qloss(QinBase):
    def __init__(self,name,qIn):
        # Call super class constructor
        super().__init__(name)
        # TODO: Should use error handling instead
        if issubclass(type(qIn), QinBase):
            self.qInqIn = qIn  
            
    def get_qin(self, tsOffset=0):
        return -self.qInqIn.get_qin(tsOffset)
    
    
class QinSpecified(Qin):
    def __init__(self, name, time):
        # Call super class constructor
        super().__init__(name, time, [])
        # Set class properties
        self.TTT = time
        self.qInqInqIn = np.full(self.TTT.nSteps, 0.)
        
    def set_qin(self, tsOffset=0, *, qSpecified=np.nan):
        self.qInqInqIn[min(self.TTT.end, self.TTT.step + tsOffset)] = qSpecified   
 
 
class QinFcst(QinBase):
    def __init__(self, name, timeFcst, qInFcst):
        # Call super class constructor
        super().__init__(name)
        # Set class properties
        # TODO: Error handling to make sure these things can be assigned
        self.qInFcstqInFcst = qInFcst
        self.tFcsttFcst = timeFcst
        self.tFcsttFcst.bind_to(self.update_current_qFcstupdate_current_qFcst)
        self.qInqIn = qInFcst[0, :].flatten() if qInFcst is not None else None
    
    def update_current_qFcst(self, rowFcst, dateTime):
        self.qInqIn = self.qInFcstqInFcst[rowFcst, :].flatten().copy()
        
    def get_qin(self, tsOffset=0):
        return self.qInqIn[min(self.tFcsttFcst.end, self.tFcsttFcst.step + tsOffset)]
        
        
class QinFcstHdf5(QinFcst):
    def __init__(self, name, timeFcst, h5FilePath, h5FileVar, fcstMbr=None):
        # Call super class constructor
        super().__init__(name, timeFcst, None)
        # Set class properties
        self.qInFcstFileqInFcstFile = h5py.File(h5FilePath, 'r')[h5FileVar]
        self.fcstMbrfcstMbr = fcstMbr
        self.nDimnDim = self.qInFcstFileqInFcstFile.ndim
        if self.nDimnDim == 2:
            self.qInqInqIn = self.qInFcstFileqInFcstFile[0, :].flatten()
        else:
            self.qInqInqIn = self.qInFcstFileqInFcstFile[0, :, self.fcstMbrfcstMbr].flatten()
        
    def update_current_qFcst(self, rowFcst, dateTime):
        if self.nDimnDim == 2:
            self.qInqInqIn = self.qInFcstFileqInFcstFile[rowFcst, :].flatten()
        else:
            self.qInqInqIn = self.qInFcstFileqInFcstFile[rowFcst, :, self.fcstMbrfcstMbr].flatten()