Improve Inheritance of Models

Author: FBumann

flixopt/features.py

@@ -12,13 +12,13 @@
 from .config import CONFIG
 from .core import NonTemporalData, Scalar, TemporalData, FlowSystemDimensions
 from .interface import InvestParameters, OnOffParameters, Piecewise, PiecewiseEffects
-from .structure import Submodel, FlowSystemModel, BaseFeatureModel
+from .structure import Submodel, FlowSystemModel
 from .modeling import ModelingUtilities, ModelingPrimitives, BoundingPatterns
 
 logger = logging.getLogger('flixopt')
 
 
-class InvestmentModel(BaseFeatureModel):
+class InvestmentModel(Submodel):
     """Investment model using factory patterns but keeping old interface"""
 
     def __init__(
@@ -40,7 +40,8 @@ def __init__(
 
         """
         self.piecewise_effects: Optional[PiecewiseEffectsModel] = None
-        super().__init__(model, label_of_element=label_of_element, parameters=parameters, label_of_model=label_of_model)
+        self.parameters = parameters
+        super().__init__(model, label_of_element=label_of_element, label_of_model=label_of_model)
 
     def _do_modeling(self):
         super()._do_modeling()
@@ -123,7 +124,7 @@ def is_invested(self) -> Optional[linopy.Variable]:
         return self._variables['is_invested']
 
 
-class OnOffModel(BaseFeatureModel):
+class OnOffModel(Submodel):
     """OnOff model using factory patterns"""
 
     def __init__(
@@ -149,7 +150,8 @@ def __init__(
         """
         self.on = on_variable
         self._previous_states = previous_states
-        super().__init__(model, label_of_element, parameters=parameters, label_of_model=label_of_model)
+        self.parameters = parameters
+        super().__init__(model, label_of_element, label_of_model=label_of_model)
 
     def _do_modeling(self):
         super()._do_modeling()

flixopt/modeling.py

@@ -7,7 +7,7 @@
 
 from .config import CONFIG
 from .core import NonTemporalData, Scalar, TemporalData, FlowSystemDimensions
-from .structure import Submodel, FlowSystemModel, BaseFeatureModel
+from .structure import Submodel, FlowSystemModel
 
 logger = logging.getLogger('flixopt')
 

flixopt/structure.py

@@ -912,26 +912,9 @@ def hours_per_step(self):
         return self._model.hours_per_step
 
     def _do_modeling(self):
-        """Template method"""
+        """Called at the end of initialization. Override in subclasses to create variables and constraints."""
         pass
 
-
-class BaseFeatureModel(Submodel):
-    """Minimal base class for feature models that use factory patterns"""
-
-    def __init__(self, model: FlowSystemModel, label_of_element: str, parameters, label_of_model: Optional[str] = None):
-        """Initialize the BaseFeatureModel.
-        Args:
-            model: The FlowSystemModel that is used to create the model.
-            label_of_element: The label of the parent (Element). Used to create shares.
-            label_of_model: The label of the model. Used as a prefix in all variables and constraints.
-                Defaults to {label_of_element}|{self.__class__.__name__}
-            parameters: The parameters of the feature model.
-            """
-        self.parameters = parameters
-        super().__init__(model, label_of_element, label_of_model or f'{label_of_element}|{self.__class__.__name__}')
-
-
 class ElementModel(Submodel):
     """Stores the mathematical Variables and Constraints for Elements"""