ENUM refactor

app.py

@@ -50,10 +50,10 @@ def __init__(self, args):
                 motor = self.fileManager.getCurrentMotor()
                 simulationResult = motor.runSimulation()
                 for alert in simulationResult.alerts:
-                    print('{} ({}, {}): {}'.format(motorlib.simResult.alertLevelNames[alert.level],
-                        motorlib.simResult.alertTypeNames[alert.type],
-                        alert.location,
-                        alert.description))
+                    print('{} ({}, {}): {}'.format(alert.level,
+                                                   alert.type,
+                                                   alert.location,
+                                                   alert.description))
                 print()
                 if '-o' in args:
                     with open(args[args.index('-o') + 1], 'w') as outputFile:

motorlib/enums/inhibitedEnds.py

@@ -0,0 +1,10 @@
+from enum import Enum
+
+
+# Python 3.11 supports `StrEnum` that would make this a bit more concise to write
+# https://docs.python.org/3/library/enum.html#enum.StrEnum
+class InhibitedEnds(str, Enum):
+    NEITHER = 'Neither'
+    TOP = 'Top'
+    BOTTOM = 'Bottom'
+    BOTH = 'Both'

motorlib/enums/multiValueChannels.py

@@ -0,0 +1,11 @@
+from enum import Enum
+
+
+# Python 3.11 supports `StrEnum` that would make this a bit more concise to write
+# https://docs.python.org/3/library/enum.html#enum.StrEnum
+class MultiValueChannels(str, Enum):
+    MASS = 'mass'
+    MASS_FLOW = 'massFlow'
+    MASS_FLUX = 'massFlux'
+    REGRESSION = 'regression'
+    WEB = 'web'

motorlib/enums/simAlertLevel.py

@@ -0,0 +1,10 @@
+from enum import Enum
+
+
+# Python 3.11 supports `StrEnum` that would make this a bit more concise to write
+# https://docs.python.org/3/library/enum.html#enum.StrEnum
+class SimAlertLevel(str, Enum):
+    """Levels of severity for sim alerts"""
+    ERROR = 'Error'
+    WARNING = 'Warning'
+    MESSAGE = 'Message'

motorlib/enums/simAlertType.py

@@ -0,0 +1,9 @@
+from enum import Enum
+
+# Python 3.11 supports `StrEnum` that would make this a bit more concise to write
+# https://docs.python.org/3/library/enum.html#enum.StrEnum
+class SimAlertType(str, Enum):
+    """Types of sim alerts"""
+    GEOMETRY = 'Geometry'
+    CONSTRAINT = 'Constraint'
+    VALUE = 'Value'

motorlib/enums/singleValueChannels.py

@@ -0,0 +1,13 @@
+from enum import Enum
+
+
+# Python 3.11 supports `StrEnum` that would make this a bit more concise to write
+# https://docs.python.org/3/library/enum.html#enum.StrEnum
+class SingleValueChannels(str, Enum):
+    TIME = 'time'
+    KN = 'kn'
+    PRESSURE = 'pressure'
+    FORCE = 'force'
+    VOLUME_LOADING = 'volumeLoading'
+    EXIT_PRESSURE = 'exitPressure'
+    D_THROAT = 'dThroat'

motorlib/enums/unit.py

@@ -0,0 +1,83 @@
+from enum import Enum
+
+
+# Python 3.11 supports `StrEnum` that would make this a bit more concise to write
+# https://docs.python.org/3/library/enum.html#enum.StrEnum
+class Unit(str, Enum):
+    # Angle
+    DEGREES = 'deg'
+
+    # Burn Rate Coefficient
+    METER_PER_SECOND_PASCAL_TO_THE_POWER_OF_N = 'm/(s*Pa^n)'
+    INCH_PER_SECOND_POUND_PER_SQUARE_INCH_TO_THE_POWER_OF_N = 'in/(s*psi^n)'
+
+    # Density
+    KILOGRAM_PER_CUBIC_METER = 'kg/m^3'
+    POUND_PER_CUBIC_INCH = 'lb/in^3'
+    GRAM_PER_CUBIC_CENTIMETER = 'g/cm^3'
+
+    # Force
+    NEWTON = 'N'
+    POUND_FORCE = 'lbf'
+
+    # Impulse
+    NEWTON_SECOND = 'Ns'
+    POUND_FORCE_SECOND = 'lbfs'
+
+    # Length
+    METER = 'm'
+    CENTIMETER = 'cm'
+    MILLIMETER = 'mm'
+    INCH = 'in'
+    FOOT = 'ft'
+
+    # Mass Flow
+    KILOGRAM_PER_SECOND = 'kg/s'
+    POUND_PER_SECOND = 'lb/s'
+    GRAM_PER_SECOND = 'g/s'
+
+    # Mass Flux
+    KILOGRAM_PER_SQUARE_METER_PER_SECOND = 'kg/(m^2*s)'
+    POUND_PER_SQUARE_INCH_PER_SECOND = 'lb/(in^2*s)'
+
+    # Mass
+    KILOGRAM = 'kg'
+    GRAM = 'g'
+    POUND = 'lb'
+    OUNCE = 'oz'
+    GRAM_PER_MOLE = 'g/mol'
+
+    # Nozzle Erosion Coefficient
+    METER_PER_SECOND_PASCAL = 'm/(s*Pa)'
+    METER_PER_SECOND_MEGAPASCAL = 'm/(s*MPa)'
+    THOUSANDTH_INCH_PER_SECOND_POUND_PER_SQUARE_INCH = 'thou/(s*psi)'
+
+    # Nozzle Slag Coefficient
+    METER_PASCAL_PER_SECOND = '(m*Pa)/s'
+    METER_MEGAPASCAL_PER_SECOND = '(m*MPa)/s'
+    INCH_POUND_PER_SQUARE_INCH_PER_SECOND = '(in*psi)/s'
+
+    # Pressure
+    PASCAL = 'Pa'
+    MEGAPASCAL = 'MPa'
+    POUND_PER_SQUARE_INCH = 'psi'
+
+    # Temperature
+    KELVIN = 'K'
+
+    # Time
+    SECOND = 's'
+
+    # Velocity
+    METER_PER_SECOND = 'm/s'
+    CENTIMETER_PER_SECOND = 'cm/s'
+    MILLIMETER_PER_SECOND = 'mm/s'
+    FOOT_PER_SECOND = 'ft/s'
+    INCH_PER_SECOND = 'in/s'
+
+    # Volume
+    CUBIC_METER = 'm^3'
+    CUBIC_CENTIMETER = 'cm^3'
+    CUBIC_MILLIMETER = 'mm^3'
+    CUBIC_INCH = 'in^3'
+    CUBIC_FOOT = 'ft^3'

motorlib/grain.py

@@ -10,7 +10,11 @@
 from scipy import interpolate
 
 from . import geometry
-from .simResult import SimAlert, SimAlertLevel, SimAlertType
+from .enums.inhibitedEnds import InhibitedEnds
+from .enums.simAlertLevel import SimAlertLevel
+from .enums.simAlertType import SimAlertType
+from .enums.unit import Unit
+from .simResult import SimAlert
 from .properties import FloatProperty, EnumProperty, PropertyCollection
 
 class Grain(PropertyCollection):
@@ -19,8 +23,8 @@ class Grain(PropertyCollection):
     geomName = None
     def __init__(self):
         super().__init__()
-        self.props['diameter'] = FloatProperty('Diameter', 'm', 0, 1)
-        self.props['length'] = FloatProperty('Length', 'm', 0, 3)
+        self.props['diameter'] = FloatProperty('Diameter', Unit.METER, 0, 1)
+        self.props['length'] = FloatProperty('Length', Unit.METER, 0, 3)
 
     def getVolumeSlice(self, regDist, dRegDist):
         """Returns the amount of propellant volume consumed as the grain regresses from a distance of 'regDist' to
@@ -67,9 +71,9 @@ def getRegressedLength(self, regDist):
         endPos = self.getEndPositions(regDist)
         return endPos[1] - endPos[0]
 
-    def getDetailsString(self, lengthUnit='m'):
+    def getDetailsString(self, Unit=Unit.METER):
         """Returns a short string describing the grain, formatted using the units that is passed in"""
-        return 'Length: {}'.format(self.props['length'].dispFormat(lengthUnit))
+        return 'Length: {}'.format(self.props['length'].dispFormat(Unit))
 
     @abstractmethod
     def simulationSetup(self, config):
@@ -103,17 +107,20 @@ class PerforatedGrain(Grain):
     geomName = 'perfGrain'
     def __init__(self):
         super().__init__()
-        self.props['inhibitedEnds'] = EnumProperty('Inhibited ends', ['Neither', 'Top', 'Bottom', 'Both'])
+        self.props['inhibitedEnds'] = EnumProperty('Inhibited ends', [InhibitedEnds.NEITHER,
+                                                                      InhibitedEnds.TOP,
+                                                                      InhibitedEnds.BOTTOM,
+                                                                      InhibitedEnds.BOTH])
         self.wallWeb = 0 # Max distance from the core to the wall
 
     def getEndPositions(self, regDist):
-        if self.props['inhibitedEnds'].getValue() == 'Neither': # Neither
+        if self.props['inhibitedEnds'].getValue() == InhibitedEnds.NEITHER:
             return (regDist, self.props['length'].getValue() - regDist)
-        if self.props['inhibitedEnds'].getValue() == 'Top': # Top
+        if self.props['inhibitedEnds'].getValue() == InhibitedEnds.TOP:
             return (0, self.props['length'].getValue() - regDist)
-        if self.props['inhibitedEnds'].getValue() == 'Bottom': # Bottom
+        if self.props['inhibitedEnds'].getValue() == InhibitedEnds.BOTTOM:
             return (regDist, self.props['length'].getValue())
-        if self.props['inhibitedEnds'].getValue() == 'Both':
+        if self.props['inhibitedEnds'].getValue() == InhibitedEnds.BOTH:
             return (0, self.props['length'].getValue())
         # The enum should prevent this from even being raised, but to cover the case where it somehow gets set wrong
         raise ValueError('Invalid number of faces inhibited')
@@ -135,7 +142,7 @@ def getCoreSurfaceArea(self, regDist):
 
     def getWebLeft(self, regDist):
         wallLeft = self.wallWeb - regDist
-        if self.props['inhibitedEnds'].getValue() == 'Both':
+        if self.props['inhibitedEnds'].getValue() == InhibitedEnds.BOTH:
             return wallLeft
         lengthLeft = self.getRegressedLength(regDist)
         return min(lengthLeft, wallLeft)
@@ -145,9 +152,9 @@ def getSurfaceAreaAtRegression(self, regDist):
         coreArea = self.getCoreSurfaceArea(regDist)
 
         exposedFaces = 2
-        if self.props['inhibitedEnds'].getValue() == 'Top' or self.props['inhibitedEnds'].getValue() == 'Bottom':
+        if self.props['inhibitedEnds'].getValue() == InhibitedEnds.TOP or self.props['inhibitedEnds'].getValue() == InhibitedEnds.BOTTOM:
             exposedFaces = 1
-        if self.props['inhibitedEnds'].getValue() == 'Both':
+        if self.props['inhibitedEnds'].getValue() == InhibitedEnds.BOTH:
             exposedFaces = 0
 
         return coreArea + (exposedFaces * faceArea)
@@ -172,7 +179,7 @@ def getMassFlux(self, massIn, dTime, regDist, dRegDist, position, density):
         # If a position in the grain is queried, the mass flow is the input mass, from the top face,
         # and from the tube up to the point. The diameter is the core.
         if position <= endPos[1]:
-            if self.props['inhibitedEnds'].getValue() in ('Top', 'Both'):
+            if self.props['inhibitedEnds'].getValue() in (InhibitedEnds.TOP, InhibitedEnds.BOTH):
                 top = 0
                 countedCoreLength = position
             else:

motorlib/grains/bates.py

@@ -4,9 +4,12 @@
 import skfmm
 from skimage import measure
 
+from ..enums.simAlertLevel import SimAlertLevel
+from ..enums.simAlertType import SimAlertType
+from ..enums.unit import Unit
 from ..grain import PerforatedGrain
 from .. import geometry
-from ..simResult import SimAlert, SimAlertLevel, SimAlertType
+from ..simResult import SimAlert
 from ..properties import FloatProperty
 
 class BatesGrain(PerforatedGrain):
@@ -15,7 +18,7 @@ class BatesGrain(PerforatedGrain):
     geomName = "BATES"
     def __init__(self):
         super().__init__()
-        self.props['coreDiameter'] = FloatProperty('Core Diameter', 'm', 0, 1)
+        self.props['coreDiameter'] = FloatProperty('Core Diameter', Unit.METER, 0, 1)
 
     def simulationSetup(self, config):
         self.wallWeb = (self.props['diameter'].getValue() - self.props['coreDiameter'].getValue()) / 2
@@ -28,9 +31,9 @@ def getFaceArea(self, regDist):
         inner = geometry.circleArea(self.props['coreDiameter'].getValue() + (2 * regDist))
         return outer - inner
 
-    def getDetailsString(self, lengthUnit='m'):
-        return 'Length: {}, Core: {}'.format(self.props['length'].dispFormat(lengthUnit),
-                                             self.props['coreDiameter'].dispFormat(lengthUnit))
+    def getDetailsString(self, Unit=Unit.METER):
+        return 'Length: {}, Core: {}'.format(self.props['length'].dispFormat(Unit),
+                                             self.props['coreDiameter'].dispFormat(Unit))
 
     def getGeometryErrors(self):
         errors = super().getGeometryErrors()

motorlib/grains/cGrain.py

@@ -2,9 +2,12 @@
 
 import numpy as np
 
+from ..enums.simAlertLevel import SimAlertLevel
+from ..enums.simAlertType import SimAlertType
+from ..enums.unit import Unit
 from ..grain import FmmGrain
 from ..properties import FloatProperty
-from ..simResult import SimAlert, SimAlertLevel, SimAlertType
+from ..simResult import SimAlert
 
 class CGrain(FmmGrain):
     """Defines a C grain, which is a cylindrical grain with a single slot taken out. The slot is a rectangular section
@@ -13,8 +16,8 @@ class CGrain(FmmGrain):
     geomName = 'C Grain'
     def __init__(self):
         super().__init__()
-        self.props['slotWidth'] = FloatProperty('Slot width', 'm', 0, 1)
-        self.props['slotOffset'] = FloatProperty('Slot offset', 'm', -1, 1)
+        self.props['slotWidth'] = FloatProperty('Slot width', Unit.METER, 0, 1)
+        self.props['slotOffset'] = FloatProperty('Slot offset', Unit.METER, -1, 1)
 
         self.props['slotOffset'].setValue(0)
 
@@ -24,8 +27,8 @@ def generateCoreMap(self):
 
         self.coreMap[np.logical_and(np.abs(self.mapY) < slotWidth / 2, self.mapX > slotOffset)] = 0
 
-    def getDetailsString(self, lengthUnit='m'):
-        return 'Length: {}'.format(self.props['length'].dispFormat(lengthUnit))
+    def getDetailsString(self, Unit=Unit.METER):
+        return 'Length: {}'.format(self.props['length'].dispFormat(Unit))
 
     def getGeometryErrors(self):
         errors = super().getGeometryErrors()