Merge branch 'features/diabatic_combustion_chamber' into dev

oemof · Mar 6, 2022 · faf5a8c · faf5a8c
2 parents 51ff17f + d908842
commit faf5a8c
Show file tree

Hide file tree

Showing 37 changed files with 603 additions and 157 deletions.
diff --git a/docs/api/tespy.components.rst b/docs/api/tespy.components.rst
@@ -54,26 +54,34 @@ tespy.components.basics.subsystem_interface module
     :undoc-members:
     :show-inheritance:
 
-tespy.components.combustion.combustion_chamber module
------------------------------------------------------
+tespy.components.combustion.base module
+---------------------------------------
 
-.. automodule:: tespy.components.combustion.combustion_chamber
+.. automodule:: tespy.components.combustion.base
     :members:
     :undoc-members:
     :show-inheritance:
 
-tespy.components.combustion.combustion_chamber_stoich module
-------------------------------------------------------------
+tespy.components.combustion.diabatic module
+-------------------------------------------
 
-.. automodule:: tespy.components.combustion.combustion_chamber_stoich
+.. automodule:: tespy.components.combustion.diabatic
     :members:
     :undoc-members:
     :show-inheritance:
 
-tespy.components.combustion.combustion_engine module
------------------------------------------------------
+tespy.components.combustion.stoichiometric module
+-------------------------------------------------
 
-.. automodule:: tespy.components.combustion.combustion_engine
+.. automodule:: tespy.components.combustion.stoichiometric
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+tespy.components.combustion.engine module
+-----------------------------------------
+
+.. automodule:: tespy.components.combustion.engine
     :members:
     :undoc-members:
     :show-inheritance:
@@ -102,18 +110,18 @@ tespy.components.heat_exchangers.desuperheater module
     :undoc-members:
     :show-inheritance:
 
-tespy.components.heat_exchangers.heat_exchanger module
-------------------------------------------------------
+tespy.components.heat_exchangers.base module
+--------------------------------------------
 
-.. automodule:: tespy.components.heat_exchangers.heat_exchanger
+.. automodule:: tespy.components.heat_exchangers.base
     :members:
     :undoc-members:
     :show-inheritance:
 
-tespy.components.heat_exchangers.heat_exchanger_simple module
--------------------------------------------------------------
+tespy.components.heat_exchangers.simple module
+----------------------------------------------
 
-.. automodule:: tespy.components.heat_exchangers.heat_exchanger_simple
+.. automodule:: tespy.components.heat_exchangers.simple
     :members:
     :undoc-members:
     :show-inheritance:
@@ -135,7 +143,7 @@ tespy.components.heat_exchangers.solar_collector module
     :show-inheritance:
 
 tespy.components.nodes.base module
---------------------------------------
+----------------------------------
 
 .. automodule:: tespy.components.nodes.base
     :members:
@@ -232,10 +240,10 @@ tespy.components.turbomachinery.turbine module
     :undoc-members:
     :show-inheritance:
 
-tespy.components.turbomachinery.turbomachine module
----------------------------------------------------
+tespy.components.turbomachinery.base module
+-------------------------------------------
 
-.. automodule:: tespy.components.turbomachinery.turbomachine
+.. automodule:: tespy.components.turbomachinery.base
     :members:
     :undoc-members:
     :show-inheritance:
diff --git a/docs/first_steps.rst b/docs/first_steps.rst
@@ -56,7 +56,7 @@ a heat exchanger. The definition of the parameters available can be found here:
 
 - :py:class:`tespy.components.piping.pipe.Pipe`
 - :py:class:`tespy.components.piping.valve.Valve`
-- :py:class:`tespy.components.heat_exchangers.heat_exchanger_simple.HeatExchangerSimple`
+- :py:class:`tespy.components.heat_exchangers.simple.HeatExchangerSimple`
 
 .. note::
 

diff --git a/docs/references.bib b/docs/references.bib
@@ -246,3 +246,23 @@ @article{Chen2015
  journal = {Entropy},
  doi = {10.3390/e17042328}
 }
+
+@article{CODATA1989,
+  doi = {10.1002/bbpc.19900940121},
+  year = {1990},
+  month = jan,
+  publisher = {Wiley},
+  volume = {94},
+  number = {1},
+  pages = {93--93},
+  author = {J. D. Cox,  D. D. Wagman,  V. A. Medvedev},
+  title = {{CODATA} - Key Values for Thermodynamics},
+  journal = {Berichte der Bunsengesellschaft f\"{u}r physikalische Chemie}
+}
+
+@book{CRCHandbook2021,
+  title={CRC Handbook of Chemistry and Physics},
+  author={John R. Rumble},
+  year={2021},
+  publisher = {CRC Press}
+}
diff --git a/docs/tespy_modules/components.rst b/docs/tespy_modules/components.rst
@@ -20,16 +20,19 @@ well as the equations.
 
 - Combustion
 
-    * :py:class:`Combustion chamber <tespy.components.combustion.combustion_chamber.CombustionChamber>`
-    * :py:class:`Stoichiometric Combustion chamber <tespy.components.combustion.combustion_chamber_stoich.CombustionChamberStoich>`
-    * :py:class:`Combustion engine <tespy.components.combustion.combustion_engine.CombustionEngine>`
+    * :py:class:`Combustion chamber <tespy.components.combustion.base.CombustionChamber>`
+    * :py:class:`Diabatic combustion chamber <tespy.components.combustion.diabatic.DiabaticCombustionChamber>`
+      (Advanced version of combustion chamber, featuring heat losses and
+      pressure drop)
+    * :py:class:`Stoichiometric Combustion chamber <tespy.components.combustion.stoichiometric.CombustionChamberStoich>`
+    * :py:class:`Combustion engine <tespy.components.combustion.engine.CombustionEngine>`
 
 - Heat exchangers
 
-    * :py:class:`Simplified heat exchanger <tespy.components.heat_exchangers.heat_exchanger_simple.HeatExchangerSimple>`
+    * :py:class:`Simplified heat exchanger <tespy.components.heat_exchangers.simple.HeatExchangerSimple>`
     * :py:class:`Solar collector <tespy.components.heat_exchangers.solar_collector.SolarCollector>`
     * :py:class:`Parabolic trough <tespy.components.heat_exchangers.parabolic_trough.ParabolicTrough>`
-    * :py:class:`Heat exchanger <tespy.components.heat_exchangers.heat_exchanger.HeatExchanger>`
+    * :py:class:`Heat exchanger <tespy.components.heat_exchangers.base.HeatExchanger>`
     * :py:class:`Condenser <tespy.components.heat_exchangers.condenser.Condenser>`
     * :py:class:`Desuperheater <tespy.components.heat_exchangers.desuperheater.Desuperheater>`
 
@@ -335,10 +338,10 @@ Characteristics are available for the following components and parameters:
 
 - combustion engine
 
-    * :py:meth:`tiP_char <tespy.components.combustion.combustion_engine.CombustionEngine.tiP_char_func>`: thermal input vs. power ratio.
-    * :py:meth:`Q1_char <tespy.components.combustion.combustion_engine.CombustionEngine.Q1_char_func>`: heat output 1 vs. power ratio.
-    * :py:meth:`Q2_char <tespy.components.combustion.combustion_engine.CombustionEngine.Q2_char_func>`: heat output 2 vs. power ratio.
-    * :py:meth:`Qloss_char <tespy.components.combustion.combustion_engine.CombustionEngine.Qloss_char_func>`: heat loss vs. power ratio.
+    * :py:meth:`tiP_char <tespy.components.combustion.engine.CombustionEngine.tiP_char_func>`: thermal input vs. power ratio.
+    * :py:meth:`Q1_char <tespy.components.combustion.engine.CombustionEngine.Q1_char_func>`: heat output 1 vs. power ratio.
+    * :py:meth:`Q2_char <tespy.components.combustion.engine.CombustionEngine.Q2_char_func>`: heat output 2 vs. power ratio.
+    * :py:meth:`Qloss_char <tespy.components.combustion.engine.CombustionEngine.Qloss_char_func>`: heat loss vs. power ratio.
 
 - compressor
 
@@ -348,7 +351,7 @@ Characteristics are available for the following components and parameters:
 
 - heat exchangers:
 
-    * :py:meth:`kA1_char, kA2_char <tespy.components.heat_exchangers.heat_exchanger.HeatExchanger.kA_char_func>`: heat transfer coefficient.
+    * :py:meth:`kA1_char, kA2_char <tespy.components.heat_exchangers.base.HeatExchanger.kA_char_func>`: heat transfer coefficient.
 
 - pump
 
@@ -357,7 +360,7 @@ Characteristics are available for the following components and parameters:
 
 - simple heat exchangers
 
-    * :py:meth:`kA_char <tespy.components.heat_exchangers.heat_exchanger_simple.HeatExchangerSimple.kA_char_group_func>`: heat transfer coefficient.
+    * :py:meth:`kA_char <tespy.components.heat_exchangers.simple.HeatExchangerSimple.kA_char_group_func>`: heat transfer coefficient.
 
 - turbine
 
@@ -395,7 +398,7 @@ parameters, add these parameters as :code:`ComponentProperties` or
 :code:`ComponentCharacteristics` respectively and add a
 :code:`GroupedComponentProperties` type DataContainer holding the information,
 e.g. like the :code:`hydro_group` parameter of the
-:py:class:`tespy.components.heat_exchangers.heat_exchanger_simple.HeatExchangerSimple`
+:py:class:`tespy.components.heat_exchangers.simple.HeatExchangerSimple`
 class shown below.
 
 .. code:: python

diff --git a/docs/tutorials_examples/solar_collector.rst b/docs/tutorials_examples/solar_collector.rst
@@ -15,7 +15,7 @@ The solarthermal collector is used to transfer heat from the solar radiation to
 the collector fluid. The TESPy component
 :py:class:`tespy.components.heat_exchangers.solar_collector.SolarCollector`
 inherits from the
-:py:class:`tespy.components.heat_exchangers.heat_exchanger_simple.HeatExchangerSimple`
+:py:class:`tespy.components.heat_exchangers.simple.HeatExchangerSimple`
 component. An energy balance is applied according to the
 :py:meth:`tespy.components.heat_exchangers.solar_collector.SolarCollector.energy_group_func`
 method, which takes the collector's

diff --git a/docs/tutorials_examples/tutorial_heat_pump.rst b/docs/tutorials_examples/tutorial_heat_pump.rst
@@ -58,7 +58,7 @@ Components
 We will start with the consumer as the plant will be designed to deliver a
 specific heat flow. From figure 1 you can determine the components of the
 consumer system: condenser, pump and the consumer (
-:py:class:`tespy.components.heat_exchangers.heat_exchanger_simple.HeatExchangerSimple`
+:py:class:`tespy.components.heat_exchangers.simple.HeatExchangerSimple`
 ). Additionally we need a source and a sink for the consumer and the heat pump
 circuit respectively. We will import all necessary components already in the
 first step, so the imports will not need further adjustment.

diff --git a/docs/whats_new.rst b/docs/whats_new.rst
@@ -8,6 +8,7 @@ Discover noteable new features and improvements in each release
     :local:
     :backlinks: top
 
+.. include::  whats_new/v0-6-0.rst
 .. include::  whats_new/v0-5-1.rst
 .. include::  whats_new/v0-5-0.rst
 .. include::  whats_new/v0-4-4.rst

diff --git a/docs/whats_new/v0-1-2.rst b/docs/whats_new/v0-1-2.rst
@@ -4,7 +4,7 @@ v0.1.2 (August, 6, 2019)
 New Features
 ############
 - The water electrolyzer is available as new component of TESPy (`PR #73 <https://github.com/oemof/tespy/pull/73>`_).
-- The components :py:class:`combustion chamber <tespy.components.components.combustion_chamber>` and :py:class:`cogeneration unit <tespy.components.components.cogeneration_unit>`
+- The components :py:class:`combustion chamber <tespy.components.components.base>` and :py:class:`cogeneration unit <tespy.components.components.cogeneration_unit>`
   now work with fuel mixtures, too. Specification of the component's fuel is not required anymore, the software automatically detects,
   which fuels are connected to the component's inlets. Available fuels are: methane, ethane, propane, butane and hydrogen (`PR #79 <https://github.com/oemof/tespy/pull/79>`_).
 - Add busses to the :py:meth:`network's result printout <tespy.networks.network.print_results>`.

diff --git a/docs/whats_new/v0-2-0.rst b/docs/whats_new/v0-2-0.rst
@@ -62,7 +62,7 @@ Bug fixes
 - Parameters :code:`local_design` and :code:`local_offdesign` are now also available for network exports and imports (`PR #109 <https://github.com/oemof/tespy/pull/109>`_).
 - Busses and characteristics are not exported, if none are used in the network. The network_reader can now
   handle missing bus.csv, char_line.csv and char_map.csv (`PR #127 <https://github.com/oemof/tespy/pull/127>`_).
-- Some parameters of class :py:class:`combustion_engine <tespy.components.combustion.combustion_engine>` have been
+- Some parameters of class :py:class:`combustion_engine <tespy.components.combustion.engine>` have been
   printed out twice in the value range check (`PR #135 <https://github.com/oemof/tespy/pull/135>`_).
 
 Other changes

diff --git a/docs/whats_new/v0-2-1.rst b/docs/whats_new/v0-2-1.rst
@@ -30,8 +30,8 @@ Bug fixes
   updated to prevent future bugs resulting from possible API changes
   (`PR #146 <https://github.com/oemof/tespy/pull/146>`_).
 - There was a bug in the heat exchanger kA-functions (
-  :py:meth:`tespy.components.heat_exchangers.heat_exchanger_simple.kA_func`,
-  :py:meth:`tespy.components.heat_exchangers.heat_exchanger.kA_func` and
+  :py:meth:`tespy.components.heat_exchangers.simple.kA_func`,
+  :py:meth:`tespy.components.heat_exchangers.base.kA_func` and
   :py:meth:`tespy.components.heat_exchangers.condenser.kA_func`). The factors
   for the heat transfer coefficient should not simultaneously amplify the
   value but instead with their inverse.

diff --git a/docs/whats_new/v0-3-0.rst b/docs/whats_new/v0-3-0.rst
@@ -212,7 +212,7 @@ which has been used until version 0.2.x in TESPy.
     }
 
 Due to the addition of the CoolProp back end selection the
-:py:class:`tespy.components.combustion.combustion_chamber_stoich` API changed
+:py:class:`tespy.components.combustion.stoichiometric` API changed
 as well. Please refer to the
 :ref:`combustion chamber tutorial<combustion_chamber_tutorial_label>` for the
 new implementation.

diff --git a/docs/whats_new/v0-3-1.rst b/docs/whats_new/v0-3-1.rst
@@ -4,7 +4,7 @@ v0.3.1 - Fix for Mayer's Merit (May, 29, 2020)
 Bug fixes
 #########
 - Remove a debugging printout in the kA_func of the
-  :py:class:`tespy.components.heat_exchangers.heat_exchanger_simple` class.
+  :py:class:`tespy.components.heat_exchangers.simple` class.
 
 Contributors
 ############

diff --git a/docs/whats_new/v0-4-0.rst b/docs/whats_new/v0-4-0.rst
@@ -27,7 +27,7 @@ API Changes
   repository have been adjusted accordingly
   (`PR #237 <https://github.com/oemof/tespy/pull/237>`_).
 - The definition of power and heat transfer of the components
-  :py:class:`tespy.components.combustion.combustion_engine.CombustionEngine`
+  :py:class:`tespy.components.combustion.engine.CombustionEngine`
   and :py:class:`tespy.components.customs.orc_evaporator.ORCEvaporator` as well
   as the heat loss values of the components
   :py:class:`tespy.components.heat_exchangers.solar_collector.SolarCollector`
@@ -234,8 +234,8 @@ Other Changes
   (`#7adff43a <https://github.com/oemof/tespy/commit/7adff43>`_).
 
 - For improved convergence stability of the methods
-  :py:meth:`tespy.components.heat_exchangers.heat_exchanger_simple.HeatExchangerSimple.kA_group_func` and
-  :py:meth:`tespy.components.heat_exchangers.heat_exchanger_simple.HeatExchangerSimple.kA_char_group_func`,
+  :py:meth:`tespy.components.heat_exchangers.simple.HeatExchangerSimple.kA_group_func` and
+  :py:meth:`tespy.components.heat_exchangers.simple.HeatExchangerSimple.kA_char_group_func`,
   the logarithmic temperature difference is calculated based on the mean
   temperature difference between ambient and inlet and outlet temperature, if
   the terminal temperature differences do not have the same sign

diff --git a/docs/whats_new/v0-6-0.rst b/docs/whats_new/v0-6-0.rst
@@ -0,0 +1,25 @@
+v0.6.0 - Colored Chemicals (March, 06, 2022)
+++++++++++++++++++++++++++++++++++++++++++++
+
+New Features
+############
+- A new component is introduced, the DiabaticCombustionChamber:
+  :py:class:`tespy.components.combustion.diabatic.DiabaticCombustionChamber`.
+  In contrast to the adiabatic combustion chamber, the new component implements
+  pressure and heat losses. An example usage can be found in the API reference
+  of the class linked above
+  (`PR #301 <https://github.com/oemof/tespy/pull/301>`_).
+
+Documentation
+#############
+
+Bug Fixes
+#########
+
+Other Changes
+#############
+
+Contributors
+############
+- Francesco Witte (`@fwitte <https://github.com/fwitte>`_)
+- `@tub-hofmann <https://github.com/tub-hofmann>`_)
diff --git a/setup.py b/setup.py
@@ -25,7 +25,7 @@ def read(*names, **kwargs):
 
 setup(
     name='TESPy',
-    version='0.5.1',
+    version='0.6.0',
     license='MIT',
     description='Thermal Engineering Systems in Python (TESPy)',
     long_description='%s' % (

diff --git a/src/tespy/__init__.py b/src/tespy/__init__.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8
 
-__version__ = '0.5.1 - Exciting Exergy'
+__version__ = '0.6.0 - Colored Chemicals'
 
 # tespy data and connections import
 from . import connections  # noqa: F401

diff --git a/src/tespy/components/__init__.py b/src/tespy/components/__init__.py
@@ -4,14 +4,15 @@
 from .basics.sink import Sink  # noqa: F401
 from .basics.source import Source  # noqa: F401
 from .basics.subsystem_interface import SubsystemInterface  # noqa: F401
-from .combustion.combustion_chamber import CombustionChamber  # noqa: F401
-from .combustion.combustion_chamber_stoich import CombustionChamberStoich  # noqa: F401
-from .combustion.combustion_engine import CombustionEngine  # noqa: F401
+from .combustion.base import CombustionChamber  # noqa: F401
+from .combustion.diabatic import DiabaticCombustionChamber  # noqa: F401
+from .combustion.engine import CombustionEngine  # noqa: F401
+from .combustion.stoichiometric import CombustionChamberStoich  # noqa: F401
 from .customs.orc_evaporator import ORCEvaporator  # noqa: F401
 from .heat_exchangers.condenser import Condenser  # noqa: F401
 from .heat_exchangers.desuperheater import Desuperheater  # noqa: F401
-from .heat_exchangers.heat_exchanger import HeatExchanger  # noqa: F401
-from .heat_exchangers.heat_exchanger_simple import HeatExchangerSimple  # noqa: F401
+from .heat_exchangers.base import HeatExchanger  # noqa: F401
+from .heat_exchangers.simple import HeatExchangerSimple  # noqa: F401
 from .heat_exchangers.parabolic_trough import ParabolicTrough  # noqa: F401
 from .heat_exchangers.solar_collector import SolarCollector  # noqa: F401
 from .nodes.droplet_separator import DropletSeparator  # noqa: F401