carbatpy.models.components.flowmachine_comp
===========================================

.. py:module:: carbatpy.models.components.flowmachine_comp


Classes
-------

.. autoapisummary::

   carbatpy.models.components.flowmachine_comp.FlowMachine


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

.. py:class:: FlowMachine(name, config, **kwargs)

   Bases: :py:obj:`carbatpy.models.components.comp.FlowDevice`


   FlowMachine means Compressor, Expander, and Pump.

   Set the basic configuration of a component.

   :param name: name of the component to be configured, must be the same
                as in the config dictionary or file.
   :type name: string
   :param config: if it is a string it must be the filename with a yaml or
                  json file with the dictionary information. All needed basic
                  parameters or default parameters and calculation type are
                  set here. Check the io_utils.py file for typical values.
   :type config: string or dictionary
   :param \*\*kwargs: any further parameters which may be needed.
   :type \*\*kwargs: dictionary

   :rtype: None.


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


   .. py:method:: calculate(in_states, out_states, run_param=None, **kwargs)

      Calculates a Flowmachine. Available models:
          - const_eta: compressor (Pump) / expander
          - turbo * RadialCompressor: from spp machines
          - turbo * RadialTurbine: from spp machines
          - scroll * Expander: from Liège

      For more information on the models see documentation.

      Results written in self.output

      :param in_states: keys: fluidnmae (str)
                        index: state entering, as defined in THERMO_STRING T,p,h,v,s.
      :type in_states: dictionary
      :param out_states: keys: fluidnmae (str)
                         index: output state only the pressure is used out_state[1].
      :type out_states: dictionary
      :param run_params: if further parameters must be passed for the calculation.
                         - power : power given, mass flow rate calculated
      :type run_params: dict, optional
      :param \*\*kwargs: DESCRIPTION.
      :type \*\*kwargs: TYPE

      :raises Exception: DESCRIPTION.

      :rtype: None.