: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._base.BaseData`

   Dataclass for Options of an Energy Management System Optimization.

   consider_thermal (bool): whether to consider the thermal balance for the optimization
   thermal_energy_start (float): thermal energy demand before first schedule step
   thermal_energy_restriction (bool): restrict the thermal energy within this energy range [kWh_th]
   th_e_penalty (float): penalty for th. energy demand surpassing the restricting limits

   ev_direct_cha (bool): incent. dir. charging with max. power with min. desc. obj. func. value
   bss_direct_cha (bool): incent. dir. charging using a min. descending obj. function value
   dir_cha_desc_factor (float): descending obj. func. factor for charging power (bss, ev)

   ev_end_energy_penalty (float): penalty factor if ev not entirely filled at the last step
   bss_end_energy_incentive (bool): incent. stored bss energy at last step (avoid disch. into grid)

   round_int (int): number of integers to round the optimization results to

   .. py:attribute:: consider_thermal
      :type: bool

      

   .. py:attribute:: thermal_energy_start
      :type: float

      

   .. py:attribute:: thermal_energy_restriction
      :type: float

      

   .. py:attribute:: th_e_penalty
      :type: float

      

   .. py:attribute:: ev_direct_cha
      :type: bool

      

   .. py:attribute:: bss_direct_cha
      :type: bool

      

   .. py:attribute:: dir_cha_desc_factor
      :type: float

      

   .. py:attribute:: ev_end_energy_penalty
      :type: float

      

   .. py:attribute:: bss_end_energy_incentive
      :type: bool

      

   .. py:attribute:: round_int
      :type: int