move secondary models to independent files, rename modules

Author: wagnerjpinto

bemol/bem.py

@@ -5,60 +5,11 @@
 import numpy as np
 
 from . import rotor
-from . import secondary
+from . import correction
 from . import tools
 
 
 
-
-class Corrections(object):
-    """Class for storing corrections.
-
-    Consider all the corrections available in the secondary
-    models module. If not given by the user considers the base (empty)
-    correction with the default parameters.
-
-    Parameters
-    ----------
-    corrections : optional
-        dictionary or list with the secondary corrections, either classes of
-        instances - in case of custom parameters. If dictionary is
-        given, the key must be the name of the correction as defined in
-        secondary.py with a lower first letter.
-    
-    """
-    def __init__(self,corrections:dict={}):
-        for name, obj in inspect.getmembers(secondary):
-            if inspect.isclass(obj):
-                _name = name[0].lower() + name[1:]
-                if type(corrections) is dict:
-                    if _name in corrections:
-                        # instantiation of correction with default values
-                        corr = corrections[_name]
-                        corr = corr() if isinstance(corr,type) else corr
-                        setattr(self,_name,corr)
-                    else:
-                        setattr(self,_name,obj.Dummy())
-                else:
-                    effect_name = obj.__qualname__
-                    setattr(self,_name,obj.Dummy())
-                    # loop for all effects to check if any of the input
-                    # corrections are inner of the available corrections
-                    for corr in corrections:
-                        # instantiation of correction with default values
-                        corr = corr() if isinstance(corr,type) else corr
-                        correction_name = type(corr).__qualname__
-                        if effect_name in correction_name:
-                            setattr(self,_name,corr)
-                            break
-
-
-    def __iter__(self):
-        """Iterate corrections."""
-        for value in self.__dict__.values():
-            yield value
-
-
 class BaseBEM:
     """Base BEM class.
 
@@ -89,7 +40,7 @@ def __init__(self,rotor:rotor.Rotor,rho:float=1.225,corrections:dict=None):
         self.n = len(rotor.sections)
 
         if corrections is None: corrections = {}
-        self.corrections = Corrections(corrections)
+        self.corrections = correction.Corrections(corrections)
 
 
 

bemol/correction.py

@@ -0,0 +1,55 @@
+
+import inspect
+from types import ModuleType
+
+from . import secondary
+
+
+class Corrections(object):
+    """Class for storing corrections.
+
+    Consider all the corrections available in the secondary
+    models module. If not given by the user considers the base (empty)
+    correction with the default parameters.
+
+    Parameters
+    ----------
+    corrections : optional
+        dictionary or list with the secondary corrections, either classes of
+        instances - in case of custom parameters. If dictionary is
+        given, the key must be the name of the correction as defined in
+        secondary.py with a lower first letter.
+    
+    """
+    def __init__(self,corrections:dict={}):
+
+        for name_mod, mod in inspect.getmembers(secondary):
+            if not isinstance(mod,ModuleType): continue
+            effect_name = name_mod[0].lower() + name_mod[1:]
+            for name_obj, obj in inspect.getmembers(mod):
+                if inspect.isclass(obj):
+                    if type(corrections) is dict:
+                        if effect_name in corrections:
+                            # instantiation of correction with default values
+                            corr = corrections[effect_name]
+                            corr = corr() if isinstance(corr,type) else corr
+                            setattr(self,effect_name,corr)
+                        else:
+                            setattr(self,effect_name,mod.Dummy())
+                    else:
+                        setattr(self,effect_name,mod.Dummy())
+                        # loop for all effects to check if any of the input
+                        # corrections are classes of the available corrections
+                        for corr in corrections:
+                            # instantiation of correction with default values
+                            # TODO: check name before instanciating!
+                            corr = corr() if isinstance(corr,type) else corr
+                            if effect_name in corr.__module__:
+                                setattr(self,effect_name,corr)
+                                break
+
+
+    def __iter__(self):
+        """Iterate corrections."""
+        for value in self.__dict__.values():
+            yield value

bemol/secondary.py

@@ -0,0 +1,7 @@
+
+
+from . import dynamicInflow
+from . import hubTipLoss
+from . import skewAngle
+from . import turbulentWakeState
+from . import yawModel

bemol/secondary/__init__.py

@@ -0,0 +1,36 @@
+
+
+
+class Dummy:
+    """Empty dynamic inflow model."""
+
+    def __init__(self) -> None:
+        return
+
+    def __call__(self,axialInduction,*args,**kwargs):
+        return axialInduction
+
+
+class Knudsen:
+    """Knudsen dynamic inflow model."""
+
+    def __init__(self,alphaDynamic=0.3,tauScale=3.0) -> None:
+        self._alpha0 = alphaDynamic
+        self.alphaDynamic = alphaDynamic
+        self.tauScale = tauScale
+
+    def __call__(self,axialInduction,Ux,radius,tStep):
+        if (tStep == 0.):
+            raise ValueError(
+                f'Using a dynamic inflow model with tStep = {tStep} does not make sense!'
+                )
+        # lower bound for wind velocity
+        kappa = 1. / (self.tauScale * radius / max(1.0,Ux) )
+        alphaDynamic = tStep*kappa*(axialInduction - self.alphaDynamic) + self.alphaDynamic
+        self.alphaDynamic = alphaDynamic
+
+        return alphaDynamic
+    
+    def restart(self):
+        """Restart alpha to the starting value."""
+        self.alphaDynamic = self._alpha0