annular.optimization_model_manager
==================================

.. py:module:: annular.optimization_model_manager

.. autoapi-nested-parse::

   A class to manage optimization models.



Classes
-------

.. autoapisummary::

   annular.optimization_model_manager.OptimizationModelManager


Module Contents
---------------

.. py:class:: OptimizationModelManager(solver: str | pyomo.opt.base.OptSolver, model: pyomo.environ.AbstractModel | None = None)

   Class to manage Pyomo optimization models.

   :param solver: Pyomo OptSolver, or a string that instantiates a Pyomo OptSolver
                  with this argument.
   :param model: Pyomo abstract model, optional.


   .. py:attribute:: solver


   .. py:attribute:: model
      :value: None



   .. py:attribute:: model_instance
      :type:  pyomo.environ.ConcreteModel | None
      :value: None



   .. py:attribute:: is_solved
      :type:  bool
      :value: False



   .. py:method:: set_model(model: pyomo.environ.AbstractModel) -> None

      Set a new model.

      :param model: Pyomo abstract model to set.



   .. py:method:: instantiate(data: dict) -> None

      Create concrete model with instantiation data.

      :param data: Dictionary with keys of model attributes and values
                   of data to be set. The data needs to correspond to the abstract
                   model in terms of attributes needed and their lengths, otherwise
                   instantiation will fail.



   .. py:method:: solve() -> None

      Solve the model.