:py:mod:`eelib.data.dataclass.options`
======================================

.. py:module:: eelib.data.dataclass.options

.. autoapi-nested-parse::

   Dataclasses for options used in eELib.

   | 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.data.dataclass.options.OptimOptions




.. py:class:: OptimOptions


   Bases: :py:obj:`eelib.data.dataclass.BaseData`

   Dataclass for Options of an Energy Management System Optimization.

   .. attribute:: consider_thermal

      whether to consider the thermal balance for the optimization

      :type: bool

   .. attribute:: thermal_energy_start

      thermal energy demand before first schedule step

      :type: float

   .. attribute:: thermal_energy_restriction

      restrict the thermal energy within a range in kWh_th

      :type: float

   .. attribute:: th_e_penalty

      penalty for th. energy demand surpassing the restricting limits

      :type: float

   .. attribute:: ev_direct_cha

      incent. dir. charging with max. power with min. desc. obj. func. value

      :type: bool

   .. attribute:: bss_direct_cha

      incent. dir. charging using a min. descending obj. function value

      :type: bool

   .. attribute:: dir_cha_desc_factor

      descending obj. func. factor for charging power (bss, ev)

      :type: float

   .. attribute:: ev_end_energy_penalty

      penalty factor if ev not entirely filled at the last step

      :type: float

   .. attribute:: bss_end_energy_incentive

      incentivize stored bss energy at last step (avoid
      discharging into grid)

      :type: bool

   .. attribute:: round_int

      number of integers to round the optimization results to

      :type: int