wolfhece 2.0.4__py3-none-any.whl → 2.0.6__py3-none-any.whl

wolfhece/mesh2d/bc_manager.py

@@ -61,9 +61,9 @@ class BcManager(wx.Frame):
 
         # bordersX and bordersY will contain
         #
-        # 'bc'         : dict where keys are 'i-j' and containing all BC value and type
+        # 'bc'         : dict where keys are 'i-j' (1-based) and containing all BC value and type
         # 'selected'   : numpy array of boolean
-        # 'indices'    : border's refernce in indices - Numpy array - shape (2,nbx),dtype=np.integer
+        # 'indices'    : border's reference in indices - Numpy array - shape (2,nbx),dtype=np.integer
         # 'indicesstr' : list with string 'ii-jj'
         # 'coords'     : border's extremities - Numpy array - shape (2,2,nbx/nby),dtype=float
         # 'coordscg'   : border's gravity center - Numpy array - shape (2,nbx/nby),dtype=float
@@ -100,22 +100,28 @@ class BcManager(wx.Frame):
         #Premiers boutons
         self.sizerbut1 = wx.BoxSizer(wx.HORIZONTAL)
 
-        self.butLoad = wx.Button(self,wx.ID_FILE,"Load from file...")
+        self.butLoad = wx.Button(self,wx.ID_ANY,"Load from file...")
         self.butLoad.Bind(wx.EVT_BUTTON,self.OnLoad)
 
-        self.butSave = wx.Button(self,wx.ID_SAVEAS,"Write to file...")
+        self.butSave = wx.Button(self,wx.ID_ANY,"Write to file...")
         self.butSave.Bind(wx.EVT_BUTTON,self.OnSave)
 
         self.sizerbut1.Add(self.butLoad,1,wx.EXPAND)
         self.sizerbut1.Add(self.butSave,1,wx.EXPAND)
 
         self.sizerbut2 = wx.BoxSizer(wx.HORIZONTAL)
-        self.butSet = wx.Button(self,wx.ID_APPLY,"Set BC")
+        self.butSet = wx.Button(self,wx.ID_ANY,"Set BC")
         self.butSet.Bind(wx.EVT_BUTTON,self.OnApplyBC)
-        self.butGet = wx.Button(self,wx.ID_FIND,"Get BC")
+        self.butSet.SetToolTip(_('Impose BC for the selected borders'))
+
+        self.butGet = wx.Button(self,wx.ID_ANY,"Get BC")
         self.butGet.Bind(wx.EVT_BUTTON,self.OnGetBC)
-        self.butReset = wx.Button(self,wx.ID_FIND,"Reset BC")
+        self.butGet.SetToolTip(_('Retrieve BC for the selected borders'))
+
+        self.butReset = wx.Button(self,wx.ID_ANY,"Reset BC")
         self.butReset.Bind(wx.EVT_BUTTON,self.OnResetBC)
+        self.butReset.SetToolTip(_('Reset all BC values'))
+
         self.sizerbut2.Add(self.butSet,1,wx.EXPAND)
         self.sizerbut2.Add(self.butGet,1,wx.EXPAND)
         self.sizerbut2.Add(self.butReset,1,wx.EXPAND)
@@ -217,11 +223,22 @@ class BcManager(wx.Frame):
         win.SetSizer(self.sizerselect)
 
         self.sizerfile = wx.BoxSizer(wx.HORIZONTAL)
+        self.sizerButtonSAction = wx.BoxSizer(wx.VERTICAL)
         self.File = wx.TextCtrl(self,size=(500,250),style=wx.TE_MULTILINE|wx.TE_PROCESS_TAB)
-        self.FileCmd=wx.Button(self,label='Apply\n<<<')
+
+        self.FileCmd=wx.Button(self,label='Apply to memory')
         self.FileCmd.Bind(wx.EVT_BUTTON,self.OnFileCmd)
-        self.sizerfile.Add(self.File,0,wx.EXPAND)
-        self.sizerfile.Add(self.FileCmd,1)
+        self.FileCmd.SetToolTip(_('Apply modifications from the textbox to memory'))
+
+        self.to_clipboard=wx.Button(self,label='Copy script to clipboard')
+        self.to_clipboard.Bind(wx.EVT_BUTTON,self.OnCopyToClipboard)
+        self.to_clipboard.SetToolTip(_('Copy script lines to clipboard'))
+
+        self.sizerfile.Add(self.File,3,wx.EXPAND)
+        self.sizerfile.Add(self.sizerButtonSAction,1,wx.EXPAND)
+
+        self.sizerButtonSAction.Add(self.FileCmd,1,wx.EXPAND)
+        self.sizerButtonSAction.Add(self.to_clipboard,1,wx.EXPAND)
 
         self.sizer.Add(self.sizerbut1,0,wx.EXPAND)
         self.sizer.Add(self.sizerbut2,0,wx.EXPAND)
@@ -414,7 +431,11 @@ class BcManager(wx.Frame):
         self.resetBC()
 
     def GetBC(self):
+        """
+        Get BC for selected borders
+        """
 
+        # create dictionary for all BC values
         values={}
         for curbc in self.bc_type:
             valbc, tbc = curbc.value
@@ -423,6 +444,7 @@ class BcManager(wx.Frame):
             values[tbc]['same']=True
             values[tbc]['nb']=0
 
+        # iterate along X == 0 and Y == 1
         for xy in range(2):
             if xy==0:
                 sel=self.BCx.Value.splitlines()
@@ -431,11 +453,13 @@ class BcManager(wx.Frame):
                 sel=self.BCy.Value.splitlines()
                 curbord=self.bordersY
 
+            # iterate on borders
             for cursel in sel:
                 i,j=cursel.split('\t')
                 txt=str(i)+'-'+str(j)
 
                 try:
+                    # count number of BC of each type and determine if all BC are the same
                     mybc= curbord['bc'][txt]
 
                     for ibc,tbc in enumerate(mybc):
@@ -452,6 +476,7 @@ class BcManager(wx.Frame):
                 except:
                     pass
 
+        # update widgets
         for curbc in self.bc_type:
             valbc, tbc = curbc.value
             if values[tbc]['nb']>0:
@@ -612,16 +637,46 @@ class BcManager(wx.Frame):
         self._filecontent += text+'\n'
         self._filecontent += 'version {}'.format(self._version)
 
+        self._filecontent += '\n\n'
+
+        self._filecontent += self._script_bc()
+
         if self.wx_exists:
             self.File.Clear()
             self.File.Value=self._filecontent
 
+    def _script_bc(self):
+        """ Return script to apply BC """
+
+        text = ""
+        for orient in range(1,3):
+            if orient==1:
+                curlist=self.bordersX['bc']
+                direction='LEFT'
+            else:
+                curlist=self.bordersY['bc']
+                direction='BOTTOM'
+            curlist:dict
+            ij:str
+            allbc:dict
+            for ij, allbc in curlist.items():
+                for tbc, val in allbc.items():
+                    i,j=ij.split('-')
+                    namebc=self._find_EnumName_TypeBC(tbc)
+
+                    if(str(val)!='99999.0'):
+                        text+= "simul.add_boundary_condition(i={}, j={},bc_type=BoundaryConditionsTypes.{}, bc_value={}, border=Direction.{}\n".format(i,j,namebc,val,direction)
+        return text
+
     def FillFromString(self, text:str):
 
         self._filecontent = text
 
         text=text.splitlines()
 
+        if len(text) == 0:
+            return
+
         nb=int(float(text[0]))
 
         try:
@@ -629,7 +684,7 @@ class BcManager(wx.Frame):
                 i,j,orient,type,value=text[i].split('\t')
 
         except:
-             logging.info(_('Bad text values -- Correct and Retry !!'))
+             logging.info(_('Bad text values -- Check and Retry !!'))
              return
 
         self.bordersX['bc']={}
@@ -683,8 +738,16 @@ class BcManager(wx.Frame):
     def OnFileCmd(self,event:wx.Event):
         """ Apply <<< button"""
         self.FillFromString(self.File.Value)
-        self.File.Clear()
-        self._Populate_FileContent()
+
+    def OnCopyToClipboard(self,event:wx.Event):
+        """ Copy to clipboard"""
+        if self.wx_exists:
+            if wx.TheClipboard.Open():
+                wx.TheClipboard.Clear()
+                wx.TheClipboard.SetData(wx.TextDataObject(self._script_bc()))
+                wx.TheClipboard.Close()
+            else:
+                logging.warning(_('Cannot open the clipboard'))
 
     def FindBorders(self,array : np.ma.array = None):
         """Find all borders where we can impose BC"""
@@ -837,7 +900,12 @@ class BcManager(wx.Frame):
         self.bordersY['selected']=selectedY
 
     def _count_nbbc(self, bc:str, axis:Literal['x', 'y']):
+        """
+        Count number of BC type for border 'bc' along axis 'axis'
 
+        :param bc: str 'ii-jj' of the border
+        :param axis: axis of BC -- 'x' or 'y'
+        """
         nb=0
 
         if axis.lower()=='x':
@@ -856,6 +924,7 @@ class BcManager(wx.Frame):
         return nb
 
     def plot(self):
+        """ Plot borders -- OpenGL """
 
         nbx = self.bordersX['nb']
         nby = self.bordersY['nb']
@@ -1013,6 +1082,13 @@ class BcManager(wx.Frame):
             if name_bc==name:
                 return val_bc
 
+    def _find_EnumName_TypeBC(self,name:str):
+        """Convert nameBC to intBC"""
+        for curbc in self.bc_type:
+            val_bc, name_bc = curbc.value
+            if name_bc==name:
+                return curbc.name
+
     def get_lists_for_GPU(self) -> tuple[list[boundary_condition_2D], list[boundary_condition_2D]]:
         """
         Return list of BC for GPU computing

wolfhece/mesh2d/cst_2D_boundary_conditions.py

@@ -14,6 +14,16 @@ class Direction(Enum):
     BOTTOM= 2
     X     = 1
     Y     = 2
+
+class BCType_2D_GPU(Enum):
+    # The numbers match the numbers in Wolf's simulations parameters.
+    # H    = (1,_('Water level [m]'))
+    QX   = (2,_('Flow rate along X [m²/s]'))
+    QY   = (3,_('Flow rate along Y [m²/s]'))
+    NONE = (4,_('None'))
+    HMOD = (7,_('Water level [m] / impervious if entry point'))
+    FROUDE_NORMAL = (8,_('Froude normal to the border [-]'))
+
 class BCType_2D(Enum):
     # The numbers match the numbers in Wolf's 2D simulations parameters.
     H    = (1,_('Water level [m]'))
@@ -52,6 +62,8 @@ def choose_bc_type(version:Union[int,str] = 1):
         return BCType_2D
     elif version==2 or version =='oo':
         return BCType_2D_OO
+    elif version==3 or version =='gpu':
+        return BCType_2D_GPU
 
 # Color associated to a number of BC per border
 ColorsNb = {1 : (0.,0.,1.),

wolfhece/mesh2d/wolf2dprev.py

@@ -6,7 +6,7 @@ try:
 except:
     msg=_('Error importing OpenGL library')
     msg+=_('   Python version : ' + sys.version)
-    msg+=_('   Please check your version of opengl32.dll -- conflict may exist between different fils present on your desktop')
+    msg+=_('   Please check your version of opengl32.dll -- conflict may exist between different files present on your desktop')
     raise Exception(msg)
 
 import numpy as np
@@ -2285,7 +2285,6 @@ class prev_parameters_simul:
         assert i >= 1 and i <= self.nxfin, f"1 <= i:{i} <= {self.nxfin+1}"
         assert j >= 1 and j <= self.nyfin, f"1 <= j:{j} <= {self.nyfin+1}"
         self.weak_bc_y.add(i,j,ntype,value,orient='y')
-        self.impfbygen += 1
 
     def to_yaml(self):
         global_params =  f"""\

wolfhece/pydike.py

@@ -47,7 +47,7 @@ class Dike(Triangulation,Zones):
             for curv in curpar.myvertices:
                 curv.z=zmin
 
-        # on dispose de 5 vecteurs dans la zone orienté de l'aval vers l'amont
+        # on dispose de 5 vecteurs dans la zone, orientés de l'aval vers l'amont
 
         self.trace.update_lengths()
         nb = int(self.trace.length3D/ds)

wolfhece/pyshields.py

@@ -219,13 +219,13 @@ def get_d_cr(q:float, h:float, K:float, rhom:float=2650., rho:float=RHO_PUREWATE
             - Shields
             - Izbach
 
-      @param q : discharge [m3/s]
-      @param h : water depth [m]
-      @param K : Strickler friction coefficient [m1/3/s]
-      @param rhom : sediment density [kg/m3]
-      @param rho : water density [kg/m3]
-      @param method : method to solve the equation (default 'brenth')
-      @param which : which formula to use (default 2)  -- see funcs = [(get_sadim,get_psi_cr),(get_dstar,get_psi_cr2),(get_dstar,get_psi_cr3)]
+      :param q : discharge [m3/s]
+      :param h : water depth [m]
+      :param K : Strickler friction coefficient [m1/3/s]
+      :param rhom : sediment density [kg/m3]
+      :param rho : water density [kg/m3]
+      :param method : method to solve the equation (default 'brenth')
+      :param which : which formula to use (default 2)  -- see funcs = [(get_sadim,get_psi_cr),(get_dstar,get_psi_cr2),(get_dstar,get_psi_cr3)]
       """
       if q==0.:
             return 0.,0.
@@ -247,9 +247,9 @@ def get_settling_vel(d:float, rhom:float=2650., rho:float=RHO_PUREWATER) -> floa
       """
       Vitesse de chute
 
-      @param d : grain diameter [m]
-      @param rhom : sediment density [kg/m3]
-      @param rho : water density [kg/m3]
+      :param d : grain diameter [m]
+      :param rhom : sediment density [kg/m3]
+      :param rho : water density [kg/m3]
       """
       dstar = get_dstar(d,rhom,rho)
       ws = KIN_VISCOSITY/d*(math.sqrt(25+1.2*dstar**2.)-5)**(3./2.)
@@ -259,12 +259,12 @@ def get_Rouse(d:float, q:float, h:float, K:float, rhom:float=2650., rho:float=RH
       """
       Vitesse de chute
 
-      @param d : grain diameter [m]
-      @param q : discharge [m3/s]
-      @param h : water depth [m]
-      @param K : Strickler friction coefficient [m1/3/s]
-      @param rhom : sediment density [kg/m3]
-      @param rho : water density [kg/m3]
+      :param d : grain diameter [m]
+      :param q : discharge [m3/s]
+      :param h : water depth [m]
+      :param K : Strickler friction coefficient [m1/3/s]
+      :param rhom : sediment density [kg/m3]
+      :param rho : water density [kg/m3]
       """
       # tau_cr = (q/K)**2 / h**(7/3) * rho  * GRAVITY
       # shear_vel = math.sqrt(tau_cr/rho)
@@ -279,12 +279,12 @@ def _get_Rouse(d:float, q:float, h:float, K:float, rhom:float=2650., rho:float=R
       """
       Settling velocity function -- used in root_scalar
 
-      @param d : grain diameter [m]
-      @param q : discharge [m3/s]
-      @param h : water depth [m]
-      @param K : Strickler friction coefficient [m1/3/s]
-      @param rhom : sediment density [kg/m3]
-      @param rho : water density [kg/m3]
+      :param d : grain diameter [m]
+      :param q : discharge [m3/s]
+      :param h : water depth [m]
+      :param K : Strickler friction coefficient [m1/3/s]
+      :param rhom : sediment density [kg/m3]
+      :param rho : water density [kg/m3]
       """
       # tau_cr = (q/K)**2 / h**(7/3) * rho  * GRAVITY
       # shear_vel = math.sqrt(tau_cr/rho)
@@ -309,12 +309,12 @@ def get_transport_mode(d:float, q:float, h:float, K:float, rhom:float=2650., rho
 
       return in [BED_LOAD, SUSPENDED_LOAD_50, SUSPENDED_LOAD_100, WASH_LOAD]
 
-      @param d : grain diameter [m]
-      @param q : discharge [m3/s]
-      @param h : water depth [m]
-      @param K : Strickler friction coefficient [m1/3/s]
-      @param rhom : sediment density [kg/m3]
-      @param rho : water density [kg/m3]
+      :param d : grain diameter [m]
+      :param q : discharge [m3/s]
+      :param h : water depth [m]
+      :param K : Strickler friction coefficient [m1/3/s]
+      :param rhom : sediment density [kg/m3]
+      :param rho : water density [kg/m3]
 
       """
 
@@ -332,11 +332,11 @@ def get_d_cr_susp(q:float, h:float, K:float, rhom:float=2650., rho:float=RHO_PUR
       """
       Diamètre critique d'emportement par suspension à 50% --> cf Rouse 1.2
 
-      @param q : discharge [m3/s]
-      @param h : water depth [m]
-      @param K : Strickler friction coefficient [m1/3/s]
-      @param rhom : sediment density [kg/m3]
-      @param rho : water density [kg/m3]
+      :param q : discharge [m3/s]
+      :param h : water depth [m]
+      :param K : Strickler friction coefficient [m1/3/s]
+      :param rhom : sediment density [kg/m3]
+      :param rho : water density [kg/m3]
 
       """
       if q==0.:
@@ -507,11 +507,11 @@ def get_Shields_2D_Manning(s:float, d:float, q:float, h:float, K:float) -> float
       """
       Compute Shields dimensionless parameter for 2D flow with Manning friction law
 
-      @param s : sediment density / water density [-]
-      @param d : sediment diameter [m]
-      @param q : discharge [m3/s]
-      @param h : water depth [m]
-      @param K : Strickler friction coefficient [m1/3/s]
+      :param s : sediment density / water density [-]
+      :param d : sediment diameter [m]
+      :param q : discharge [m3/s]
+      :param h : water depth [m]
+      :param K : Strickler friction coefficient [m1/3/s]
       """
       # calcul de terme de pente de frottement
 
@@ -535,11 +535,11 @@ def izbach_d_cr(q:float, h:float, rhom:float=2650, rho:float=RHO_PUREWATER, meth
 
       --> d = (0.85 * q/h)**2 / (s * g) / 1.7**2
 
-      @param q : discharge [m3/s]
-      @param h : water depth [m]
-      @param rhom : sediment density [kg/m3]
-      @param rho : water density [kg/m3]
-      @param method : method to solve the equation (default 'ridder')
+      :param q : discharge [m3/s]
+      :param h : water depth [m]
+      :param rhom : sediment density [kg/m3]
+      :param rho : water density [kg/m3]
+      :param method : method to solve the equation (default 'ridder')
       """
       s = rhom/rho
       #      (0.85 * q/h)**2. / ((s-1.) * GRAVITY) / 1.7**2.

wolfhece/pywalous.py

@@ -24,8 +24,8 @@ class Walous_data():
         """
         Read the file
 
-        @param force : force to read even read was done before
-        @param bounds : [xmin, ymin, xmax, ymax] or [[xmin, xmax], [ymin, ymax]]
+        :param force : force to read even read was done before
+        :param bounds : [xmin, ymin, xmax, ymax] or [[xmin, xmax], [ymin, ymax]]
         """
 
         if self._gdf is None or force:

wolfhece/scenario/config_manager.py

@@ -622,6 +622,8 @@ class Config_Manager_2D_GPU:
                 logging.info(_('infiltration_zones.tif created and set to -1 ! -- Please edit it !'))
             else:
                 logging.error(_("infiltration_zones.tif not created ! --  Does 'bathymetry.tif' or any '.tif' file exist in the root directory ?"))
+        else:
+            logging.error(_("No 'bathymetry.tif' file found in the root directory !"))
 
     def create_simulation(self, dir:Path, idx_hydros:list[int] = [-1], delete_existing:bool = False) -> list[Path]:
         """ Create a simulation from different hydrographs """
@@ -981,7 +983,7 @@ class UI_Manager_2D_GPU():
     def oncreate_void_infil(self, e:wx.MouseEvent):
         """ Création d'un fichier d'infiltration vide """
         self._parent.create_void_infil()
-        self._parent._load_data()
+        self._parent.load_data()
 
     def oncreate_void_scripts(self,e:wx.MouseEvent):
         """ Création d'un script vide """

wolfhece/ui/wolf_multiselection_collapsiblepane.py

@@ -6,8 +6,8 @@ class Wolf_TwoLists_Transfer(wx.Panel):
 
     def __init__(self, parent, **kwargs):
         """
-        @param parent : wx.Window
-        @param kwargs : dict - other arguments for wx.Panel (example : max_selected_items=3, delete_if_transfer=True)
+        :param parent : wx.Window
+        :param kwargs : dict - other arguments for wx.Panel (example : max_selected_items=3, delete_if_transfer=True)
         """
 
         super().__init__(parent)
@@ -174,14 +174,14 @@ class Wolf_MultipleSelection(wx.Dialog):
                  destroyOK = False,
                  **kwargs):
         """
-        @param parent : wx.Window
-        @param title : str - title of the frame
-        @param values_dict : dict - {'label1':[item1, item2, ...], 'label2':[item1, item2, ...], ...}
-        @param callback : function - callback function when OK or Apply button is pressed
-        @param info : str - information to display upper the collapsiblepanes
-        @param cmdApply : bool - if True, Apply button is displayed
-        @param styles : wx.ListBox styles - wx constant or list of wx constants
-        @param kwargs : dict - other arguments for wx.Frame (example : max_selected_items=[1, 2, 3], delete_if_transfer=[True, False, True])
+        :param parent : wx.Window
+        :param title : str - title of the frame
+        :param values_dict : dict - {'label1':[item1, item2, ...], 'label2':[item1, item2, ...], ...}
+        :param callback : function - callback function when OK or Apply button is pressed
+        :param info : str - information to display upper the collapsiblepanes
+        :param cmdApply : bool - if True, Apply button is displayed
+        :param styles : wx.ListBox styles - wx constant or list of wx constants
+        :param kwargs : dict - other arguments for wx.Frame (example : max_selected_items=[1, 2, 3], delete_if_transfer=[True, False, True])
         """
         if isinstance(styles, list):
             assert len(styles) == len(values_dict), "styles must be a list of len(values_dict)"