:py:mod:`eelib.core.devices.heatpump.heatpump_model`
====================================================

.. py:module:: eelib.core.devices.heatpump.heatpump_model

.. autoapi-nested-parse::

   eElib heat pump model for calculation of the thermal generation and electrical load of a heat pump.
   The model approximates the thermal calculations with power values and their impact on temperatures.

   | Author: elenia@TUBS
   | Copyright 2024 elenia
   | This file is part of eELib, which is free software under the terms of the GNU GPL Version 3.



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

Classes
~~~~~~~

.. autoapisummary::

   eelib.core.devices.heatpump.heatpump_model.Heatpump




.. py:class:: Heatpump(eid: str, p_rated_th=10000, modulation=1, p_min_th_rel=0.5, time_min=2100, cop=3.60584, cos_phi: float = 1.0, step_size=60 * 15)


   Models a heatpump.

   .. py:attribute:: _VALID_PARAMETERS

      

   .. py:method:: get_valid_parameters()
      :classmethod:

      Returns dictionary containing valid parameter types and values.

      :returns: valid parameters for this model
      :rtype: dict


   .. py:method:: _set_state()

      Set the state of the heatpump with regard to the current power on on/off time.


   .. py:method:: _calc_thermal_limits()

      Calculate the thermal maximum and minimum power of the heatpump.


   .. py:method:: step(timestep)

      Calculating of current thermal and active power values, as well as the minimum and
      maximal values while differentiating between modulation or on/off heatpump.

      :param timestep: Current simulation time
      :type timestep: int