cronian.local_balance
=====================

.. py:module:: cronian.local_balance

.. autoapi-nested-parse::

   Add prosumer's end_use demand carrier local supply-consumption balance constraint to the model.



Functions
---------

.. autoapisummary::

   cronian.local_balance.add_prosumer_local_balance_constraint
   cronian.local_balance.calculate_end_use_demand_carrier_supply
   cronian.local_balance.calculate_end_use_demand_carrier_consumption


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

.. py:function:: add_prosumer_local_balance_constraint(model: pyomo.environ.AbstractModel, prosumer: dict, end_use_demand: str) -> None

   Add prosumer's local carrier supply-consumption balance constraint.

   NOTE: A local a balance constraint is established for each end_use_demand
   whose carrier is not `electricity`. For end_use_demands with `electricity`
   as carrier, the balance is handled by the system electric power balance
   constraint at the market bus.

   Args:
       model: Pyomo Abstract model.
       prosumer: Dictionary containing prosumer details.
       end_use_demand: Name of the end_use_demand, e.g., space_heating.


.. py:function:: calculate_end_use_demand_carrier_supply(model: pyomo.environ.AbstractModel, prosumer: dict, end_use_demand_carrier: str, t: int) -> pyomo.environ.Var

   Calculate total supply for the given end_use_demand's carrier.

   Args:
       model: Pyomo Abstract model.
       prosumer: Dictionary containing prosumer details.
       end_use_demand_carrier: Carrier of the end_use_demand, e.g., heat.
       t: Time index in the Pyomo model.

   Returns:
       pyo.Var: Total supply of an end_use_demand's carrier.


.. py:function:: calculate_end_use_demand_carrier_consumption(model: pyomo.environ.AbstractModel, prosumer: dict, end_use_demand_carrier: str, t: int) -> pyomo.environ.Var

   Calculate total consumption for the given end_use_demand's carrier.

   Args:
       model: Pyomo Abstract model.
       prosumer: Dictionary containing prosumer details.
       end_use_demand_carrier: Carrier of the end_use_demand, e.g., heat.
       t: Time index in the Pyomo model.

   Returns:
       pyo.Var: Total consumption of an end_use_demand's carrier.