lineProps yaml specification, marine growth description conformity, unload/fairleads bug fix

-- yaml specification option for lineProps, where the yaml name will be read in and applied when developing mooring properties (when calling moorpy.helpers.loadLineProps)
	- property saved as lineProps
-- marine growth description altered to conform to general table format (now a list of dicts, -{'thickness':x,'lowerRange':y,'upperRange':z,'density':w})
-- marine growth on buoys moved to its own project property, marine_growth_buoys, same setup as before (list of thicknesses corresponding to different buoyancy sections irrespective of depth)
-- bug fix in unload for fairleads stuff
-- bug fix helpers.compareDicts to fix issue with recursion
-- bug fix in platform.setPosition to reset mooring end point attached to fairleads even if set_moorings is False

Author: lsirkis

famodel/cables/dynamic_cable.py

@@ -616,28 +616,29 @@ def createSubsystem(self, case=0,pristine=True,dd=None):
             self.ss_mod = ss
             return(self.ss_mod)
 
-    def addMarineGrowth(self, mgDict,updateDepths=False,tol=2):
+    def addMarineGrowth(self, mgDict, buoy_mg, updateDepths=False,tol=2):
         '''Creates a new design dictionary (does not overwrite old one) to account for marine 
         growth on the subystem, then calls createSubsystem() to recreate the cable
 
         Parameters
         ----------
-        mgDict : dictionary
+        mgDict : list, optional
             Provides marine growth thicknesses and the associated depth ranges
-            {
-                th : list with 3 values in each entry - thickness, range lower z-cutoff, range higher z-cutoff [m]
-                    *In order from sea floor to surface*
-                    example, if depth is 200 m: - [0.00,-200,-100]
-                                                - [0.05,-100,-80]
-                                                - [0.10,-80,-40]
-                                                - [0.20,-40,0]
-                buoy_th : list of thicknesses associated with buoyancy sections. This is used to simplify the marine growth modeling on buoys.
-                        * In order of sections from end A to end B (also the order of sections listed in buoyancy_sections list in the dd)
-                        example, if 3 buoyancy sections: - 0.1
-                                                         - 0.05
-                                                         - 0.1
-                rho : list of densities for each thickness, or one density for all thicknesses, [kg/m^3] (optional - default is 1325 kg/m^3)
-                }
+            Default is None, which triggers the use of the marine growth dictionary saved in the project class
+            'density' entry is optional. If no 'density' entry is created in the dictionary, addMarineGrowth defaults to 1325 kg/m^3
+            *In order from sea floor to surface*
+            example, if depth is 200 m: - {'thickness':0.00,'lowerRange':-200,'upperRange':-100, 'density':1320}
+                                        - {'thickness':0.05,'lowerRange':-100,'upperRange':-80, 'density':1325}
+                                        - {'thickness':0.1,'lowerRange':-80,'upperRange':0, 'density':1325}
+
+        buoy_mg: list, optional
+            Provides marine growth thicknesses for buoyancy sections of cables, irrespective of depth.
+                This is used to simplify the marine growth modeling on buoys.
+                * In order of sections from end A to end B (also the order of sections listed in buoyancy_sections list in the dd)
+                example, if 3 buoyancy sections: - 0.1
+                                                 - 0.05
+                                                 - 0.1
+
         Returns
         -------
         changePoints : list
@@ -646,7 +647,7 @@ def addMarineGrowth(self, mgDict,updateDepths=False,tol=2):
             List of cutoff depths the changePoints should be located at
 
         '''
-        def getMG(mgDict):
+        def getMG(mgDict, buoy_mg):
             # create a reference subsystem if it doesn't already exist
             if not self.ss:
                 self.createSubsystem(pristine=1)
@@ -699,31 +700,31 @@ def getMG(mgDict):
                         high = ssLine.rB
                         flip = 0
 
-                    th = mgDict['th'] # set location for ease of coding
+                    th = mgDict # set location for ease of coding
                     # look up what thickness this line section starts at (if lowest point is not on the sea floor, first segment will have a thickness other than the sea floor thickness)
                     rAth = 0 # exit while loop when we find thickness at low
                     count1 = 0 # counter
                     while rAth==0: # and count1 < len(th):
                         if flip:
-                            if high[2] <= th[count1][2]:
-                                LThick.append(th[count1][0])
+                            if high[2] <= th[count1]['upperRange']:
+                                LThick.append(th[count1]['thickness'])
                                 rAth = 1 # exit while loop
                         else:
-                            if low[2] <= th[count1][2]:
-                                LThick.append(th[count1][0])
+                            if low[2] <= th[count1]['upperRange']:
+                                LThick.append(th[count1]['thickness'])
                                 rAth = 1 # exit while loop
                         count1 = count1 + 1 # iterate counter
 
                     # determine if this line section will be split
                     for j in range(0,len(th)): # go through all changeDepths
                         if flip:
-                            rs = 2
+                            rs = 'upperRange'
                         else:
-                            rs = 1
+                            rs = 'lowerRange'
                         if th[j][rs]>low[2] and th[j][rs]<high[2]:
                             # line section will be split - add line type, mg thickness, and material to list
                             LTypes.append(ssLine.type['name'])
-                            slthick.append(th[j][0])
+                            slthick.append(th[j]['thickness'])
                             # Mats.append(ssLine.type['material'])
                             # add an empty connector object to list for split location
                             sCount += 1
@@ -771,12 +772,12 @@ def getMG(mgDict):
 
                 else:
                     # this is a buoy section, add the prescribed buoy marine growth thickness
-                    if isinstance(mgDict['buoy_th'],list):
+                    if isinstance(buoy_mg,list):
                         # add the buoy thickness for this specific buoyancy section
-                        LThick.append(mgDict['buoy_th'][buoyCount])
+                        LThick.append(buoy_mg[buoyCount])
                     else:
                         # add the single buoy thickness
-                        LThick.append(mgDict['buoy_th'])
+                        LThick.append(buoy_mg)
 
                 if slthick: # add the length of the top line (from last split to upper end of section) if there was a split in the line
                     slength.append(float(ssLine.L-ln_raw[-1]))
@@ -811,17 +812,13 @@ def getMG(mgDict):
             mu_mg = np.zeros((len(LTypes)))
             rho_mg = np.ones((len(LTypes)))*1325
             # adjust rho value if alternative provided
-            if 'rho' in mgDict:
-                if not type(mgDict['rho']) is list:
-                    # just one density given for all marine growth on the line
-                    rho_mg = rho_mg*mgDict['rho']/1325
-                else: # density given for each thickness of marine growth
-                    for i in range(0,len(rho_mg)):
-                        # look up what thickness number this rho is related to
-                        for j in range(0,len(LThick)):
-                            thind = np.where(th[:][0]==LThick[j])
-                            # assign rho_mg based on the rho_mg of the thickness
-                            rho_mg[i] = mgDict['rho'][thind]             
+            if 'density' in mgDict[0]:
+                for i in range(0,len(mgDict)):
+                    # look up what thickness number this rho is related to
+                    for j in range(0,len(LThick)):
+                        thind = np.where([th[ii]['thickness']==LThick[j] for ii in range(len(th))])
+                        # assign rho_mg based on the rho_mg of the thickness
+                        rho_mg[i] = mgDict[thind[0][0]]['density']             
 
 
             nd = [] # list of dictionaries for new design dictionary sections part
@@ -955,29 +952,29 @@ def getMG(mgDict):
             cEq = tol + 1 
             ct = 0
             while(cEq>tol):
-                changeDepths,changePoints = getMG(mgDict1)
+                changeDepths,changePoints = getMG(mgDict1, buoy_mg)
                 D = []
                 for d in range(0,len(changeDepths)):
-                    diff = mgDict['th'][changeDepths[d][0]][changeDepths[d][1]] - self.ss_mod.pointList[changePoints[d]].r[2]
+                    diff = mgDict[changeDepths[d][0]][changeDepths[d][1]] - self.ss_mod.pointList[changePoints[d]].r[2]
                     D.append(diff)
                 cEq = np.mean(D)
                 # adjust depth to change based on difference between actual and desired change depth
                 if cEq>tol:
-                    mgDict1['th'][0][2] = mgDict1['th'][0][2] + cEq
-                    for j in range(1,len(mgDict['th'])):
-                        for k in range(1,3):
+                    mgDict1[0]['upperRange'] = mgDict1[0]['upperRange'] + cEq
+                    for j in range(1,len(mgDict)):
+                        for k in ['lowerRange','upperRange']:
                             if ct < 4 and abs(cEq)<12:
-                                mgDict1['th'][j][k] = mgDict1['th'][j][k] + cEq
+                                mgDict1[j][k] = mgDict1[j][k] + cEq
                             elif (ct >= 4 and ct < 9) or abs(cEq)>=12:
                                 # could be ping-ponging between two different things, try adding half
-                                mgDict1['th'][j][k] = mgDict1['th'][j][k] + 0.5*cEq
+                                mgDict1[j][k] = mgDict1[j][k] + 0.5*cEq
                 print('average difference between expected and actual change depth is: ',cEq)
                 if ct > 10:
                     print('Could not meet tolerance in 10 attempts. Exiting loop')
                     break
                 ct += 1
         else:
-            changeDepths,changePoints = getMG(mgDict)
+            changeDepths,changePoints = getMG(mgDict, buoy_mg)
             return(changeDepths,changePoints)
 
 

famodel/helpers.py

@@ -767,7 +767,7 @@ def CableProps(cabType, cable_types, rho_water, g, checkType=1, A=None):
 
     return(deepcopy(dd))
 
-def MooringProps(mCon, lineTypes, rho_water, g, checkType=1):
+def MooringProps(mCon, lineTypes, rho_water, g, lineProps, checkType=1):
     '''
     Parameters
     ----------
@@ -805,8 +805,8 @@ def MooringProps(mCon, lineTypes, rho_water, g, checkType=1):
         from moorpy.helpers import loadLineProps, getLineProps
         if not 'd_nom' in mCon:
             raise Exception('To use MoorProps yaml, you must specify a nominal diameter in mm for the mooring line family')
-        lineprops = loadLineProps(None)
-        mProps = getLineProps(mCon['d_nom']*1000,mCon['mooringFamily'],lineProps=lineprops)
+
+        mProps = getLineProps(mCon['d_nom']*1000,mCon['mooringFamily'],lineProps=lineProps)
         dd = mProps
         dd['name'] = mCon['mooringFamily']
         dd['d_nom'] = mCon['d_nom']
@@ -816,7 +816,7 @@ def MooringProps(mCon, lineTypes, rho_water, g, checkType=1):
 
     return(deepcopy(dd))
 
-def getMoorings(lcID, lineConfigs, connectorTypes, pfID, proj):
+def getMoorings(lcID, lineConfigs, connectorTypes, pfID, proj, lineProps):
     '''
 
     Parameters
@@ -858,7 +858,8 @@ def getMoorings(lcID, lineConfigs, connectorTypes, pfID, proj):
                 config.append({})
                 c_config.append({})                        
             # set line information
-            lt = MooringProps(lc, proj.lineTypes, proj.rho_water, proj.g)                                             
+            lt = MooringProps(lc, proj.lineTypes, proj.rho_water, proj.g, 
+                              lineProps)                                             
             # lt = self.lineTypes[lc['type']] # set location for code clarity and brevity later
             # set up sub-dictionaries that will contain info on the line type
             config.append({'type':lt})# {'name':str(ct)+'_'+lc['type'],'d_nom':lt['d_nom'],'material':lt['material'],'d_vol':lt['d_vol'],'m':lt['m'],'EA':float(lt['EA'])}})
@@ -929,7 +930,7 @@ def getMoorings(lcID, lineConfigs, connectorTypes, pfID, proj):
                         if sublineLast[ii]:
                             # add empty connector
                             config[-1][-1].append({})
-                        lt = MooringProps(subsub,proj.lineTypes, proj.rho_water, proj.g)
+                        lt = MooringProps(subsub,proj.lineTypes, proj.rho_water, proj.g, lineProps)
                         config[-1][-1].append({'type':lt,
                                                'L': subsub['length']})
                         # make EA a float not a string
@@ -1415,13 +1416,17 @@ def compareDicts(d1, d2):
     for key in d1:
         if key in d2:
             if type(d1[key]) is dict:
-                compareDicts(d1[key],d2[key])
+                x = compareDicts(d1[key],d2[key])
+                if x==False:
+                    return(False)
             elif isinstance(d1[key],(list, np.ndarray)):
                 if len(d1[key])!=len(d2[key]):
                     return(False)
                 for i,ix in enumerate(d1[key]):
                     if type(d1[key][i]) is dict:
-                        compareDicts(ix,d2[key][i])
+                        x = compareDicts(ix,d2[key][i])
+                        if x==False:
+                            return(False)
                     elif isinstance(ix,(list, np.ndarray)):
                         for j,jx in ix:
                             if jx != d2[key][i][j]:

famodel/mooring/mooring.py

@@ -904,15 +904,10 @@ def addMarineGrowth(self, mgDict):
         ----------
         mgDict : dictionary
             Provides marine growth thicknesses and the associated depth ranges
-            {
-                th : list with 3 values in each entry - thickness, range lower z-cutoff, range higher z-cutoff [m]
-                    *In order from sea floor to surface*
-                    example, if depth is 200 m: - [0.00,-200,-100]
-                                                - [0.05,-100,-80]
-                                                - [0.10,-80,-40]
-                                                - [0.20,-40,0]
-                rho : list of densities for each thickness, or one density for all thicknesses, [kg/m^3] (optional - default is 1325 kg/m^3)
-                }
+            *In order from sea floor to surface*
+            example, if depth is 200 m: - {'thickness':0.00,'lowerRange':-200,'upperRange':-100, 'density':1320}
+                                        - {'thickness':0.05,'lowerRange':-100,'upperRange':-80, 'density':1325}
+                                        - {'thickness':0.1,'lowerRange':-80,'upperRange':0, 'density':1325}
 
         Returns
         -------
@@ -967,31 +962,31 @@ def addMarineGrowth(self, mgDict):
                 high = ssLine.rB
                 flip = 0
 
-            th = mgDict['th'] # set location for ease of coding
+            th = mgDict # set location for ease of coding
             # look up what thickness this line section starts at (if lowest point is not on the sea floor, first segment will have a thickness other than the sea floor thickness)
             rAth = 0 # exit while loop when we find thickness at low
             count1 = 0 # counter
             while rAth==0 and count1 <= len(th):
                 if flip:
-                    if high[2] <= th[count1][2]:
-                        LThick.append(th[count1][0])
+                    if high[2] <= th[count1]['upperRange']:
+                        LThick.append(th[count1]['thickness'])
                         rAth = 1 # exit while loop
                 else:
-                    if low[2] <= th[count1][2]:
-                        LThick.append(th[count1][0])
+                    if low[2] <= th[count1]['upperRange']:
+                        LThick.append(th[count1]['thickness'])
                         rAth = 1 # exit while loop
                 count1 = count1 + 1 # iterate counter
 
             # determine if this line section will be split
             for j in range(0,len(th)): # go through all changeDepths
                 if flip:
-                    rs = 2
+                    rs = 'upperRange'
                 else:
-                    rs = 1
+                    rs = 'lowerRange'
                 if th[j][rs]>low[2] and th[j][rs]<high[2]:
                     # line section will be split - add line type, mg thickness, and material to list
                     LTypes.append(ssLine.type['name'])
-                    slthick.append(th[j][0])
+                    slthick.append(th[j]['thickness'])
                     Mats.append(ssLine.type['material'])
                     # add an empty connector object to list for split location
                     connList.append(Connector(str(len(connList))+'_empty'))
@@ -1075,7 +1070,7 @@ def addMarineGrowth(self, mgDict):
                     # look up what thickness number this rho is related to
                     for j in range(0,len(th)):
                         # compare thickness to th list
-                        if LThick == th[j][0]:
+                        if LThick == th[j]['thickness']:
                             # assign rho_mg based on the rho_mg of the thickness
                             rho_mg[i] = mgDict['rho'][j]                   
 

famodel/platform/platform.py

@@ -97,7 +97,6 @@ def setPosition(self, r, heading=None, degrees=False,project=None, update_moorin
         if update_moorings:
             for i, att in enumerate(self.attachments):
                 if isinstance(self.attachments[att]['obj'], Mooring): 
-                    self.updateMooringPoints()
                     # Heading of the mooring line
                     heading_i = self.mooring_headings[count] + self.phi
                     # Reposition the whole Mooring if it is an anchored line
@@ -116,7 +115,8 @@ def setPosition(self, r, heading=None, degrees=False,project=None, update_moorin
 
                     # reposition the cable
                     cab.reposition(project=project)
-    
+            
+        self.updateMooringPoints()
 
     def mooringSystem(self,rotateBool=0,mList=None,bodyInfo=None, project=None):
         '''