edisgo.flex_opt.q_control
=========================

.. py:module:: edisgo.flex_opt.q_control


Functions
---------

.. autoapisummary::

   edisgo.flex_opt.q_control.get_q_sign_generator
   edisgo.flex_opt.q_control.get_q_sign_load
   edisgo.flex_opt.q_control.fixed_cosphi


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

.. py:function:: get_q_sign_generator(reactive_power_mode)

   Get the sign of reactive power in generator sign convention.

   In the generator sign convention the reactive power is negative in
   inductive operation (`reactive_power_mode` is 'inductive') and positive
   in capacitive operation (`reactive_power_mode` is 'capacitive').

   :param reactive_power_mode: Possible options are 'inductive' and 'capacitive'.
   :type reactive_power_mode: str

   :returns: Sign of reactive power in generator sign convention.
   :rtype: int


.. py:function:: get_q_sign_load(reactive_power_mode)

   Get the sign of reactive power in load sign convention.

   In the load sign convention the reactive power is positive in
   inductive operation (`reactive_power_mode` is 'inductive') and negative
   in capacitive operation (`reactive_power_mode` is 'capacitive').

   :param reactive_power_mode: Possible options are 'inductive' and 'capacitive'.
   :type reactive_power_mode: str

   :returns: Sign of reactive power in load sign convention.
   :rtype: int


.. py:function:: fixed_cosphi(active_power, q_sign, power_factor)

   Calculates reactive power for a fixed cosphi operation.

   :param active_power: Dataframe with active power time series. Columns of the dataframe are
                        names of the components and index of the dataframe are the time steps
                        reactive power is calculated for.
   :type active_power: :pandas:`pandas.DataFrame<DataFrame>`
   :param q_sign: `q_sign` defines whether the reactive power is positive or
                  negative and must either be -1 or +1. In case `q_sign` is given as a
                  series, the index must contain the same component names as given in
                  columns of parameter `active_power`.
   :type q_sign: :pandas:`pandas.Series<Series>` or int
   :param power_factor: Ratio of real to apparent power.
                        In case `power_factor` is given as a series, the index must contain the
                        same component names as given in columns of parameter `active_power`.
   :type power_factor: :pandas:`pandas.Series<Series>` or float

   :returns: Dataframe with the same format as the `active_power` dataframe,
             containing the reactive power.
   :rtype: :pandas:`pandas.DataFrame<DataFrame>`