: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




Attributes
~~~~~~~~~~

.. autoapisummary::

   eelib.core.devices.heatpump.heatpump_model._logger


.. py:data:: _logger

   

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


   Models a heatpump.

   .. py:attribute:: _VALID_PARAMETERS

      

   .. py:attribute:: eid

      

   .. py:attribute:: p_rated_th
      :value: '10000'

      

   .. py:attribute:: p_modulation_rel
      :value: '0.5'

      

   .. py:attribute:: time_min
      :value: '2100'

      

   .. py:attribute:: time_on
      :value: '2100'

      

   .. py:attribute:: time_off
      :value: '2100'

      

   .. py:attribute:: cop
      :value: '3.60584'

      

   .. py:attribute:: modulation
      :value: 'True'

      

   .. py:attribute:: voltage_control

      

   .. py:attribute:: step_size
      :value: '900'

      

   .. py:attribute:: p_th
      :value: '0'

      

   .. py:attribute:: p_th_set

      

   .. py:attribute:: p_th_max
      :value: '0'

      

   .. py:attribute:: p_th_mod_start
      :value: '-5000.0'

      

   .. py:attribute:: p_th_min
      :value: '-10000'

      

   .. py:attribute:: state
      :value: "'off'"

      

   .. py:attribute:: p
      :value: '0'

      

   .. py:attribute:: p_min
      :value: '0'

      

   .. py:attribute:: p_mod_start
      :value: '0'

      

   .. py:attribute:: p_max
      :value: '0'

      

   .. py:attribute:: q
      :value: '0'

      

   .. py:attribute:: timestep
      :value: 'None'

      

   .. py:method:: get_valid_parameters() -> dict
      :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: int)

      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