Lin: using FASTLinearizationFile reader, adding options for state selection and TXT selection

Author: ebranlard

pyFAST/input_output/fast_linearization_file.py

@@ -10,16 +10,49 @@ def test_001_read_all(self, DEBUG=True):
         reading_test('FASTLin*.*', FASTLinearizationFile)
 
     def test_FASTLin(self):
+
+        # --- Test basic read
         F=FASTLinearizationFile(os.path.join(MyDir,'FASTLin.lin'))
         self.assertAlmostEqual(F['A'][3,1], 3.91159454E-04 )
         self.assertAlmostEqual(F['u'][7]   ,4.00176055E+04)
 
+        # Test properties
+        np.testing.assert_almost_equal(F.nx  , 4)
+        np.testing.assert_almost_equal(F.nu  , 9)
+        np.testing.assert_almost_equal(F.ny  , 16)
+        np.testing.assert_almost_equal(F.nz  , 0 )
+
+        # Test keys
+        np.testing.assert_almost_equal(F['Azimuth']  ,  5.8684 , 4)
+        np.testing.assert_almost_equal(F['RotSpeed'] ,  1.2367 , 4)
+        self.assertEqual(F['WindSpeed'],  None  ) # NOTE: might become NaN in the future
+
+        # --- Test methods
+        dfs = F.toDataFrame() # Make sure this runs
+
+        # Test EVA
+        fd, zeta, Q, f0 = F.eva()
+        np.testing.assert_almost_equal(f0  , [0.394858], 4)
+        np.testing.assert_almost_equal(zeta, [0.06078], 4)
+
+        # Test state removal
+        F.removeStates(pattern='generator')
+        fd, zeta, Q, f0 = F.eva()
+        dfs = F.toDataFrame() # Make sure this runs
+        np.testing.assert_almost_equal(F.nx  , 2)
+        np.testing.assert_almost_equal(f0  , [0.394258], 4)
+        np.testing.assert_almost_equal(zeta, [0.0603 ], 4)
+
+
+        # --- Test lin file with M (only for EB's special branch...)
         F=FASTLinearizationFile(os.path.join(MyDir,'FASTLin_EDM.lin'))
         dfs=F.toDataFrame()
         M=dfs['M']
         self.assertAlmostEqual(M['7_TwFADOF1']['7_TwFADOF1'],0.436753E+06)
         self.assertAlmostEqual(M['13_GeAz']['13_GeAz']     , 0.437026E+08)
 
+
+
 if __name__ == '__main__':
 #     Test().test_000_debug()
     unittest.main()

pyFAST/input_output/tests/test_fast_linearization.py

@@ -28,10 +28,11 @@
 from pyFAST.linearization.campbell_data import IdentifyModes
 
 
-def postproCampbell(fstFiles, BladeLen=None, TowerLen=None, verbose=True, nFreqOut=15, 
-        WS_legacy=None, removeTwrAzimuth=False,
-        writeModes=None,
-        **kwargs
+def postproCampbell(fstFiles, BladeLen=None, TowerLen=None, verbose=True, 
+        WS_legacy=None, 
+        nFreqOut=500, freqRange=None, posDampRange=None,  # Options for TXT output
+        removeTwrAzimuth=False, starSub=None, removeStatesPattern=None, # Options for A matrix selection
+        writeModes=None, **kwargs  # Options for .viz files
         ):
     """ 
     Postprocess linearization files to extract Campbell diagram (linearization at different Operating points)
@@ -42,6 +43,23 @@ def postproCampbell(fstFiles, BladeLen=None, TowerLen=None, verbose=True, nFreqO
 
     INPUTS:
      - fstFiles: list of fst files
+
+    INPUTS (related to A matrices):
+     - removeTwrAzimuth: if False do nothing
+                 otherwise discard lin files where azimuth in [60, 180, 300]+/-4deg (close to tower). 
+     - starSub: if None, raise an error if `****` are present
+                 otherwise replace *** with `starSub` (e.g. 0)
+                 see FASTLinearizationFile. 
+     - removeStatesPattern: remove states matching a giving description pattern.
+                e.g:  'tower|Drivetrain'  or '^AD'
+                see FASTLinearizationFile. 
+
+    INPUTS (related to Campbell_Summary.txt output):
+     - nFreqOut: maximum number of frequencies to write to Campbell_Summary.txt file
+     - freqRange:    range in which frequencies are "accepted",  if None: [-np.inf, np.inf]
+     - posDampRange: range in which damping are "accepted'    ,  if None: [1e-5, 0.96]
+
+    INPUTS (related to .viz files):
      - writeModes: if True, a binary file and a .viz file is written to disk for OpenFAST VTK visualization.
                    if None, the binary file is written only if a checkpoint file is present.
                           For instance, if the main file is     : 'main.fst', 
@@ -50,6 +68,13 @@ def postproCampbell(fstFiles, BladeLen=None, TowerLen=None, verbose=True, nFreqO
                           the checkpoint file is expected to be : 'main.ModeShapeVTK.chkp'
      - **kwargs: list of key/values to be passed to writeVizFile (see function below)
            VTKLinModes=15, VTKLinScale=10, VTKLinTim=1, VTKLinTimes1=True, VTKLinPhase=0, VTKModes=None
+
+    OUTPUTS:
+     - OP: dataframe of operating points
+     - Freq: dataframe of frequencies for each OP and identified mode
+     - Damp: dataframe of dampings    for each OP and identified mode
+     - UnMapped: 
+     - ModeData: all mode data all mode data 
     """ 
     if len(fstFiles)==0:
         raise Exception('postproCampbell requires a list of at least one .fst')
@@ -60,7 +85,8 @@ def postproCampbell(fstFiles, BladeLen=None, TowerLen=None, verbose=True, nFreqO
         CD = pickle.load(open(fstFiles[0],'rb'))
     else:
         # --- Attemps to extract Blade Length and TowerLen from first file...
-        CD, MBC = getCampbellDataOPs(fstFiles, writeModes=writeModes, BladeLen=BladeLen, TowerLen=TowerLen, removeTwrAzimuth=removeTwrAzimuth, verbose=verbose, **kwargs)
+        CD, MBC = getCampbellDataOPs(fstFiles, writeModes=writeModes, BladeLen=BladeLen, TowerLen=TowerLen, 
+                removeTwrAzimuth=removeTwrAzimuth, starSub=starSub, removeStatesPattern=removeStatesPattern, verbose=verbose, **kwargs)
 
     # --- Identify modes
     modeID_table,modesDesc=IdentifyModes(CD)
@@ -71,7 +97,7 @@ def postproCampbell(fstFiles, BladeLen=None, TowerLen=None, verbose=True, nFreqO
     modeID_file = campbellData2CSV(baseName, CD, modeID_table, modesDesc)
     # Write summary txt file to help manual identification step..
     txtFileName = baseName+'_Summary.txt'
-    campbellData2TXT(CD, nFreqOut=nFreqOut, txtFileName=txtFileName)
+    campbellData2TXT(CD, txtFileName=txtFileName, nFreqOut=nFreqOut, freqRange=freqRange, posDampRange=posDampRange)
 
     # --- Return nice dataframes (assuming the identification is correct)
     # TODO, for now we reread the files...

pyFAST/linearization/campbell.py

@@ -201,49 +201,68 @@ def printCampbellDataOP(CDDOP, nModesMax=15, nCharMaxDesc=50) :
 # --- Manipulation of multiple operating points
 # --------------------------------------------------------------------------------{
 
-def campbellData2TXT(CD, nFreqOut=15, txtFileName=None, skipHighDamp=True, skipNonEDBD=True):
+def campbellData2TXT(CD, txtFileName=None, nFreqOut=500, freqRange=None, posDampRange=None, skipNonEDBD=True):
     """ Write frequencies, damping, and mode contents for each operating points to a string
     Write to file if filename provided
+    INPUTS:
+     - nFreqOut: maximum number of frequencies to write to Campbell_Summary.txt file
+     - freqRange:    range in which frequencies are "accepted",  if None: [-np.inf, np.inf]
+     - posDampRange: range in which damping are "accepted'    ,  if None: [1e-5, 0.96]
     """
     if not isinstance(CD, list):
         CD=[CD]
+    if freqRange is None:
+        freqRange =[-np.inf, np.inf] 
+    if posDampRange is None:
+        posDampRange =[1e-5, 0.96] 
+
+    def mode2txtline(cd, im):
+        m    = cd['Modes'][im]
+        Desc = cd['ShortModeDescr'][im]
+        zeta = m['DampingRatio']
+        return '{:03d} ; {:8.3f} ; {:7.4f} ; {:s}\n'.format(im+1,m['NaturalFreq_Hz'],m['DampingRatio'],Desc)
+
     txt=''
     for iOP,cd in enumerate(CD):
         WS  = cd['WindSpeed']
         RPM = cd['RotSpeed_rpm']
         nFreqOut_loc = np.min([len(cd['Modes']),nFreqOut])
-        txt+='------------------------------------------------------------------------\n'
-        txt+='--- OP {:d} - WS {:.1f} - RPM {:.2f} \n'.format(iOP+1, WS, RPM)
-        txt+='------------------------------------------------------------------------\n'
+        txt+='# -----------------------------------------------------------------------\n'
+        txt+='# --- OP {:d} - WS {:.1f} - RPM {:.2f} \n'.format(iOP+1, WS, RPM)
+        txt+='# -----------------------------------------------------------------------\n'
+        txt+='# --- "Selected" modes\n'
+        txt+='# ID; Freq [Hz]; Zeta [-]; Mode content\n'
         skippedDamp=[]
+        skippedFreq=[]
         skippedEDBD=[]
         for im in np.arange(nFreqOut_loc):
             m    = cd['Modes'][im]
             Desc = cd['ShortModeDescr'][im]
             zeta = m['DampingRatio']
+            freq = m['NaturalFreq_Hz']
             hasED = Desc.find('ED')>=0
             hasBD = Desc.find('BD')>=0
             hasAD = Desc.find('AD')>=0
-            if skipHighDamp and (zeta>0.96 or abs(zeta)<1e-5):
+            if (freq>freqRange[1] or freq<freqRange[0]):
+                skippedFreq.append(im)
+            elif (zeta>posDampRange[1] or abs(zeta)<posDampRange[0]):
                 skippedDamp.append(im)
             elif skipNonEDBD and (not (hasBD or hasED)):
                 skippedEDBD.append(im)
             else:
-                txt+='{:02d} ; {:8.3f} ; {:7.4f} ; {:s}\n'.format(im+1,m['NaturalFreq_Hz'],m['DampingRatio'],Desc)
+                txt+=mode2txtline(cd, im)
         if len(skippedEDBD)>0:
-            txt+='---- Skipped (No ED/BD)\n'
+            txt+='# --- Skipped (No ED/BD)\n'
             for im in skippedEDBD:
-                m    = cd['Modes'][im]
-                Desc = cd['ShortModeDescr'][im]
-                zeta = m['DampingRatio']
-                txt+='{:02d} ; {:8.3f} ; {:7.4f} ; {:s}\n'.format(im+1,m['NaturalFreq_Hz'],m['DampingRatio'],Desc)
+                txt+=mode2txtline(cd, im)
+        if len(skippedFreq)>0:
+            txt+='# --- Skipped (Frequency outside of `freqRange`={})\n'.format(freqRange)
+            for im in skippedFreq:
+                txt+=mode2txtline(cd, im)
         if len(skippedDamp)>0:
-            txt+='---- Skipped (High Damping)\n'
+            txt+='# --- Skipped (Damping outside of `posDampRange`={})\n'.format(posDampRange)
             for im in skippedDamp:
-                m    = cd['Modes'][im]
-                Desc = cd['ShortModeDescr'][im]
-                zeta = m['DampingRatio']
-                txt+='{:02d} ; {:8.3f} ; {:7.4f} ; {:s}\n'.format(im+1,m['NaturalFreq_Hz'],m['DampingRatio'],Desc)
+                txt+=mode2txtline(cd, im)
     if txtFileName is not None:
         with open(txtFileName, 'w') as f:
             f.write(txt)

pyFAST/linearization/campbell_data.py

@@ -17,7 +17,8 @@
 print('Keys available:',lin.keys())
 
 # --- Perform eigenvalue analysis
-fd, zeta, Q, f0 = eigA(lin['A'])
+#fd, zeta, Q, f0 = eigA(lin['A'])
+fd, zeta, Q, f0 = lin.eva()
 print('Nat. freq. [Hz], Damping ratio [%]')
 print(np.column_stack((np.around(f0,4),np.around(zeta*100,4))))
 

pyFAST/linearization/examples/ex1a_OneLinFile_SimpleEigenAnalysis.py

@@ -43,7 +43,9 @@ def campbell(templateFstFile, operatingPointsFile, workDir, toolboxDir, fastExe,
              nPerPeriod=36, baseDict=None, tStart=5400, trim=True, viz=False,
              trimGainPitch = 0.001, trimGainGenTorque = 300,
              maxTrq= None, 
-             generateInputs=True, runFast=True, runMBC=True, prefix='',sortedSuffix=None, ylim=None, removeTwrAzimuth=False):
+             generateInputs=True, runFast=True, runMBC=True, prefix='',sortedSuffix=None, ylim=None, 
+             removeTwrAzimuth=False, starSub=None, removeStatesPattern=None # Options for A matrices
+             ):
     """ 
     Wrapper function to perform a Campbell diagram study
        see: writeLinearizationFiles, postproLinearization and postproMBC for more description of inputs.
@@ -60,6 +62,14 @@ def campbell(templateFstFile, operatingPointsFile, workDir, toolboxDir, fastExe,
       - prefix:     strings such that the output files will looked like: [folder prefix ]
       - sortedSuffix use a separate file where IDs have been sorted
       - runFast      Logical to specify whether to run the simulations or not
+      - removeTwrAzimuth: if False do nothing
+                 otherwise discard lin files where azimuth in [60, 180, 300]+/-4deg (close to tower). 
+      - starSub: if None, raise an error if `****` are present
+                 otherwise replace *** with `starSub` (e.g. 0)
+                 see FASTLinearizationFile. 
+      - removeStatesPattern: remove states matching a giving description pattern.
+                e.g:  'tower|Drivetrain'  or '^AD'
+                see FASTLinearizationFile. 
     """
     Cases=pd.read_csv(caseFile); Cases.rename(columns=lambda x: x.strip(), inplace=True)
 
@@ -80,7 +90,7 @@ def campbell(templateFstFile, operatingPointsFile, workDir, toolboxDir, fastExe,
 
     # --- Postprocess linearization outputs (MBC + modes ID)
     if runMBC:
-        OP, Freq, Damp, _, _, modeID_file = postproCampbell(FSTfilenames, removeTwrAzimuth=removeTwrAzimuth, suffix=suffix)
+        OP, Freq, Damp, _, _, modeID_file = postproCampbell(FSTfilenames, removeTwrAzimuth=removeTwrAzimuth, starSub=starSub, removeStatesPattern=removeStatesPattern, suffix=suffix)
 
     # ---  Plot Campbell
     fig, axes = plotCampbell(OP, Freq, Damp, sx='WS_[m/s]', UnMapped=UnMapped, ylim=ylim)