carbatpy.models.coupled.cycles
==============================

.. py:module:: carbatpy.models.coupled.cycles

.. autoapi-nested-parse::

   cycle calculation one input for each cyle
   Created on Wed Jul 31 17:01:59 2024

   @author: atakan



Attributes
----------

.. autoapisummary::

   carbatpy.models.coupled.cycles.file_n


Classes
-------

.. autoapisummary::

   carbatpy.models.coupled.cycles.Cycle
   carbatpy.models.coupled.cycles.HeatPump
   carbatpy.models.coupled.cycles.ORC


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

.. py:class:: Cycle(components=None, fixed_points=None, **kwargs)

   .. py:attribute:: components


   .. py:attribute:: fixed_points
      :value: None



   .. py:attribute:: all_states
      :value: []



   .. py:attribute:: m_dots
      :value: []



   .. py:attribute:: evaluation


   .. py:attribute:: warning
      :value: []



   .. py:attribute:: kwargs


   .. py:attribute:: fluids_all


   .. py:attribute:: fluids
      :value: []



   .. py:method:: calculate_hex(params, plot_info={}, verbose_=True)

      General method for calculating a heat exchanger.

      params: dict containing the following keys:
          - fluid_numbers: List[int]
          - h_dot_min: float
          - h_out_w: float
          - h_limit_s: float (optional)
          - d_temp_separation_min: float (optional)
          - calc_type: str (optional)
          - pinch: str (optional)
          - name: str (optional)



   .. py:method:: calc_cycle()
      :abstractmethod:



   .. py:method:: plot()
      :abstractmethod:



.. py:class:: HeatPump(components=None, fixed_points=None, **kwargs)

   Bases: :py:obj:`Cycle`


   .. py:method:: set_fl_state(**kwargs)


   .. py:method:: calc_cycle(plot_info={}, variations=['', ''], verbose=False)

      Calculates a simple compression heat pump cycle.



   .. py:method:: plot(f_name=None, **kwargs)

      plots the heat pump cycle and stores it to the given file (name)

      :rtype: None.



.. py:class:: ORC(components=None, fixed_points=None, fluids=None)

   Bases: :py:obj:`Cycle`


   .. py:method:: calc_cycle(verbose=False)

      Calculates a simple Organic Rankine Cycle (ORC).



.. py:data:: file_n
   :value: '\\test_input3.json'