tespy 0.2.1__tar.gz → 0.2.2__tar.gz

{TESPy-0.2.1 → TESPy-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: TESPy
-Version: 0.2.1
+Version: 0.2.2
 Summary: Thermal Engineering Systems in Python (TESPy)
 Home-page: http://github.com/oemof/tespy
 Author: Francesco Witte
@@ -71,9 +71,10 @@ Description: .. image:: https://coveralls.io/repos/github/oemof/tespy/badge.svg?
         
         For a short introduction on how TESPy works and how you can use it, we provide
         some
-        `examples and tutorials <http://tespy.readthedocs.io/en/latest/getting_started.html>`_,
-        go and check them out. You can download the python scripts of all example plants from
-        the `tespy_examples <https://github.com/oemof/oemof-examples/tree/master/oemof_examples/tespy>`_
+        `examples and tutorials <https://tespy.readthedocs.io/en/master/tutorials_examples.html>`_,
+        go and check them out. You can download the python scripts of all example plants
+        from the
+        `tespy_examples <https://github.com/oemof/oemof-examples/tree/master/oemof_examples/tespy>`_
         repository.
         
         License

{TESPy-0.2.1 → TESPy-0.2.2}/README.rst

@@ -63,9 +63,10 @@ Examples
 
 For a short introduction on how TESPy works and how you can use it, we provide
 some
-`examples and tutorials <http://tespy.readthedocs.io/en/latest/getting_started.html>`_,
-go and check them out. You can download the python scripts of all example plants from
-the `tespy_examples <https://github.com/oemof/oemof-examples/tree/master/oemof_examples/tespy>`_
+`examples and tutorials <https://tespy.readthedocs.io/en/master/tutorials_examples.html>`_,
+go and check them out. You can download the python scripts of all example plants
+from the
+`tespy_examples <https://github.com/oemof/oemof-examples/tree/master/oemof_examples/tespy>`_
 repository.
 
 License

{TESPy-0.2.1 → TESPy-0.2.2}/TESPy.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: TESPy
-Version: 0.2.1
+Version: 0.2.2
 Summary: Thermal Engineering Systems in Python (TESPy)
 Home-page: http://github.com/oemof/tespy
 Author: Francesco Witte
@@ -71,9 +71,10 @@ Description: .. image:: https://coveralls.io/repos/github/oemof/tespy/badge.svg?
         
         For a short introduction on how TESPy works and how you can use it, we provide
         some
-        `examples and tutorials <http://tespy.readthedocs.io/en/latest/getting_started.html>`_,
-        go and check them out. You can download the python scripts of all example plants from
-        the `tespy_examples <https://github.com/oemof/oemof-examples/tree/master/oemof_examples/tespy>`_
+        `examples and tutorials <https://tespy.readthedocs.io/en/master/tutorials_examples.html>`_,
+        go and check them out. You can download the python scripts of all example plants
+        from the
+        `tespy_examples <https://github.com/oemof/oemof-examples/tree/master/oemof_examples/tespy>`_
         repository.
         
         License

{TESPy-0.2.1 → TESPy-0.2.2}/TESPy.egg-info/SOURCES.txt

@@ -12,6 +12,7 @@ tespy/components/__init__.py
 tespy/components/basics.py
 tespy/components/combustion.py
 tespy/components/components.py
+tespy/components/customs.py
 tespy/components/heat_exchangers.py
 tespy/components/nodes.py
 tespy/components/piping.py

{TESPy-0.2.1 → TESPy-0.2.2}/setup.py

@@ -7,7 +7,7 @@ def read(fname):
 
 
 setup(name='TESPy',
-      version='0.2.1',
+      version='0.2.2',
       description='Thermal Engineering Systems in Python (TESPy)',
       url='http://github.com/oemof/tespy',
       author='Francesco Witte',

{TESPy-0.2.1 → TESPy-0.2.2}/tespy/__init__.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8
 
-__version__ = '0.2.1 - Fourier\'s Fable'
+__version__ = '0.2.2 - Rankine\'s Realm'
 
 # tespy networks imports
 from tespy.networks import (

{TESPy-0.2.1 → TESPy-0.2.2}/tespy/components/basics.py

@@ -356,7 +356,7 @@ class subsystem_interface(component):
     printout: boolean
         Include this component in the network's results printout.
 
-    num_inter : float/tespy.helpers.dc_simple
+    num_inter : float/tespy.tools.data_containers.dc_simple
         Number of interfaces for subsystem.
 
     Note
@@ -494,24 +494,6 @@ class subsystem_interface(component):
         ######################################################################
         # all derivatives are static
 
-    def fluid_deriv(self):
-        r"""
-        Calculate the partial derivatives for all fluid balance equations.
-
-        Returns
-        -------
-        deriv : list
-            Matrix with partial derivatives for the fluid equations.
-        """
-        deriv = np.zeros((self.num_nw_fluids * self.num_i,
-                          2 * self.num_i,
-                          self.num_nw_vars))
-        for i in range(self.num_i):
-            for j in range(self.num_nw_fluids):
-                deriv[i * self.num_nw_fluids + j, i, j + 3] = 1
-                deriv[i * self.num_nw_fluids + j, self.num_i + i, j + 3] = -1
-        return deriv.tolist()
-
     def inout_deriv(self, pos):
         r"""
         Calculate partial derivatives.
@@ -534,4 +516,4 @@ class subsystem_interface(component):
             deriv[i, i, pos] = 1
         for j in range(self.num_i):
             deriv[j, j + self.num_i, pos] = -1
-        return deriv.tolist()
+        return deriv

{TESPy-0.2.1 → TESPy-0.2.2}/tespy/components/combustion.py

@@ -105,10 +105,10 @@ class combustion_chamber(component):
     printout: boolean
         Include this component in the network's results printout.
 
-    lamb : float/tespy.helpers.dc_cp
+    lamb : float/tespy.tools.data_containers.dc_cp
         Actual oxygen to stoichiometric oxygen ratio, :math:`\lambda/1`.
 
-    ti : float/tespy.helpers.dc_cp
+    ti : float/tespy.tools.data_containers.dc_cp
         Thermal input, (:math:`{LHV \cdot \dot{m}_f}`),
         :math:`ti/\text{W}`.
 
@@ -759,7 +759,6 @@ class combustion_chamber(component):
                 try:
                     flow = [0, p, 0, {self.h2o: 1}]
                     h_steam = h_mix_pQ(flow, 1)
-                    # CP.PropsSI('H', 'P', p, 'Q', 1, self.h2o)
                 except ValueError:
                     flow = [0, 615, 0, {self.h2o: 1}]
                     h_steam = h_mix_pQ(flow, 1)
@@ -986,7 +985,7 @@ class combustion_chamber(component):
 
         m = 0
         for i in inl:
-            if i.init_csv is False:
+            if i.good_starting_values is False:
                 if i.m.val_SI < 0 and not i.m.val_set:
                     i.m.val_SI = 0.01
                 m += i.m.val_SI
@@ -994,7 +993,7 @@ class combustion_chamber(component):
         ######################################################################
         # check fluid composition
         for o in outl:
-            if o.init_csv is False:
+            if o.good_starting_values is False:
                 fluids = [f for f in o.fluid.val.keys()
                           if not o.fluid.val_set[f]]
                 for f in fluids:
@@ -1031,7 +1030,7 @@ class combustion_chamber(component):
         ######################################################################
         # flue gas propagation
         for o in outl:
-            if o.init_csv is False:
+            if o.good_starting_values is False:
                 if o.m.val_SI < 0 and not o.m.val_set:
                     o.m.val_SI = 10
                 nw.init_target(o, o.t)
@@ -1045,7 +1044,7 @@ class combustion_chamber(component):
             # search fuel and air inlet
             for i in inl:
                 fuel_found = False
-                if i.init_csv is False:
+                if i.good_starting_values is False:
                     fuel = 0
                     for f in self.fuel_list:
                         fuel += i.fluid.val[f]
@@ -1236,10 +1235,10 @@ class combustion_chamber_stoich(combustion_chamber):
     path : str
         Path to existing fluid property table.
 
-    lamb : float/tespy.helpers.dc_cp
+    lamb : float/tespy.tools.data_containers.dc_cp
         Air to stoichiometric air ratio, :math:`\lambda/1`.
 
-    ti : float/tespy.helpers.dc_cp
+    ti : float/tespy.tools.data_containers.dc_cp
         Thermal input, (:math:`{LHV \cdot \dot{m}_f}`),
         :math:`ti/\text{W}`.
 
@@ -2040,8 +2039,8 @@ class combustion_engine(combustion_chamber):
             0 = p_{1,in} \cdot pr1 - p_{1,out}\\
             0 = p_{2,in} \cdot pr2 - p_{2,out}
 
-        - :func:`tespy.components.components.component.zeta_func`
-        - :func:`tespy.components.components.component.zeta2_func`
+        - loop 1 :func:`tespy.components.components.component.zeta_func`
+        - loop 2 :func:`tespy.components.components.component.zeta_func`
 
     Available fuels
 
@@ -2090,49 +2089,49 @@ class combustion_engine(combustion_chamber):
     printout: boolean
         Include this component in the network's results printout.
 
-    lamb : float/tespy.helpers.dc_cp
+    lamb : float/tespy.tools.data_containers.dc_cp
         Air to stoichiometric air ratio, :math:`\lambda/1`.
 
-    ti : float/tespy.helpers.dc_cp
+    ti : float/tespy.tools.data_containers.dc_cp
         Thermal input, (:math:`{LHV \cdot \dot{m}_f}`),
         :math:`ti/\text{W}`.
 
-    P : str/float/tespy.helpers.dc_cp
+    P : str/float/tespy.tools.data_containers.dc_cp
         Power output, :math:`P/\text{W}`.
 
-    Q1 : str/float/tespy.helpers.dc_cp
+    Q1 : float/tespy.tools.data_containers.dc_cp
         Heat output 1, :math:`\dot Q/\text{W}`.
 
-    Q2 : str/float/tespy.helpers.dc_cp
+    Q2 : float/tespy.tools.data_containers.dc_cp
         Heat output 2, :math:`\dot Q/\text{W}`.
 
-    Qloss : str/float/tespy.helpers.dc_cp
+    Qloss : str/float/tespy.tools.data_containers.dc_cp
         Heat loss, :math:`\dot Q_{loss}/\text{W}`.
 
-    pr1 : str/float/tespy.helpers.dc_cp
+    pr1 : float/tespy.tools.data_containers.dc_cp
         Pressure ratio heat outlet 1, :math:`pr/1`.
 
-    pr2 : str/float/tespy.helpers.dc_cp
+    pr2 : float/tespy.tools.data_containers.dc_cp
         Pressure ratio heat outlet 2, :math:`pr/1`.
 
-    zeta1 : str/float/tespy.helpers.dc_cp
-        Pressure ratio heat outlet 2,
+    zeta1 : float/tespy.tools.data_containers.dc_cp
+        Geometry independent friction coefficient heating loop 1,
         :math:`\zeta/\frac{1}{\text{m}^4}`.
 
-    zeta2 : str/float/tespy.helpers.dc_cp
-        Pressure ratio heat outlet 2,
+    zeta2 : float/tespy.tools.data_containers.dc_cp
+        Geometry independent friction coefficient heating loop 2,
         :math:`\zeta/\frac{1}{\text{m}^4}`.
 
-    tiP_char : str/tespy.helpers.dc_cc
+    tiP_char : tespy.tools.charactersitics.char_line/tespy.tools.data_containers.dc_cc
         Characteristic line linking fuel input to power output.
 
-    Q1_char : str/tespy.helpers.dc_cc
+    Q1_char : tespy.tools.charactersitics.char_line/tespy.tools.data_containers.dc_cc
         Characteristic line linking heat output 1 to power output.
 
-    Q2_char : str/tespy.helpers.dc_cc
+    Q2_char : tespy.tools.charactersitics.char_line/tespy.tools.data_containers.dc_cc
         Characteristic line linking heat output 2 to power output.
 
-    Qloss_char : str/tespy.helpers.dc_cc
+    Qloss_char : tespy.tools.charactersitics.char_line/tespy.tools.data_containers.dc_cc
         Characteristic line linking heat loss to power output.
 
     Note
@@ -2391,12 +2390,14 @@ class combustion_engine(combustion_chamber):
         # equations for specified zeta values at cooling loops
         if self.zeta1.is_set:
             if np.absolute(self.vec_res[k]) > err ** 2 or self.it % 4 == 0:
-                self.vec_res[k] = self.zeta_func()
+                self.vec_res[k] = self.zeta_func(
+                    zeta='zeta1', inconn=0, outconn=0)
             k += 1
 
         if self.zeta2.is_set:
             if np.absolute(self.vec_res[k]) > err ** 2 or self.it % 4 == 0:
-                self.vec_res[k] = self.zeta2_func()
+                self.vec_res[k] = self.zeta_func(
+                    zeta='zeta2', inconn=1, outconn=1)
             k += 1
 
     def derivatives(self, vec_z):
@@ -2601,29 +2602,39 @@ class combustion_engine(combustion_chamber):
         if self.zeta1.is_set:
             f = self.zeta_func
             if not vec_z[0, 0]:
-                self.mat_deriv[k, 0, 0] = self.numeric_deriv(f, 'm', 0)
+                self.mat_deriv[k, 0, 0] = self.numeric_deriv(
+                    f, 'm', 0, zeta='zeta1', inconn=0, outconn=0)
             if not vec_z[0, 1]:
-                self.mat_deriv[k, 0, 1] = self.numeric_deriv(f, 'p', 0)
+                self.mat_deriv[k, 0, 1] = self.numeric_deriv(
+                    f, 'p', 0, zeta='zeta1', inconn=0, outconn=0)
             if not vec_z[0, 2]:
-                self.mat_deriv[k, 0, 2] = self.numeric_deriv(f, 'h', 0)
+                self.mat_deriv[k, 0, 2] = self.numeric_deriv(
+                    f, 'h', 0, zeta='zeta1', inconn=0, outconn=0)
             if not vec_z[4, 1]:
-                self.mat_deriv[k, 4, 1] = self.numeric_deriv(f, 'p', 4)
+                self.mat_deriv[k, 4, 1] = self.numeric_deriv(
+                    f, 'p', 4, zeta='zeta1', inconn=0, outconn=0)
             if not vec_z[4, 2]:
-                self.mat_deriv[k, 4, 2] = self.numeric_deriv(f, 'h', 4)
+                self.mat_deriv[k, 4, 2] = self.numeric_deriv(
+                    f, 'h', 4, zeta='zeta1', inconn=0, outconn=0)
             k += 1
 
         if self.zeta2.is_set:
-            f = self.zeta2_func
+            f = self.zeta_func
             if not vec_z[1, 0]:
-                self.mat_deriv[k, 1, 0] = self.numeric_deriv(f, 'm', 1)
+                self.mat_deriv[k, 1, 0] = self.numeric_deriv(
+                    f, 'm', 1, zeta='zeta2', inconn=1, outconn=1)
             if not vec_z[1, 1]:
-                self.mat_deriv[k, 1, 1] = self.numeric_deriv(f, 'p', 1)
+                self.mat_deriv[k, 1, 1] = self.numeric_deriv(
+                    f, 'p', 1, zeta='zeta2', inconn=1, outconn=1)
             if not vec_z[1, 2]:
-                self.mat_deriv[k, 1, 2] = self.numeric_deriv(f, 'h', 1)
+                self.mat_deriv[k, 1, 2] = self.numeric_deriv(
+                    f, 'h', 1, zeta='zeta2', inconn=1, outconn=1)
             if not vec_z[5, 1]:
-                self.mat_deriv[k, 5, 1] = self.numeric_deriv(f, 'p', 5)
+                self.mat_deriv[k, 5, 1] = self.numeric_deriv(
+                    f, 'p', 5, zeta='zeta2', inconn=1, outconn=1)
             if not vec_z[5, 2]:
-                self.mat_deriv[k, 5, 2] = self.numeric_deriv(f, 'h', 5)
+                self.mat_deriv[k, 5, 2] = self.numeric_deriv(
+                    f, 'h', 5, zeta='zeta2', inconn=1, outconn=1)
             k += 1
 
     def fluid_func(self):
@@ -2735,7 +2746,7 @@ class combustion_engine(combustion_chamber):
             .. math::
 
                 \begin{split}
-                0 = & \sum_i \dot{m}_{in,i} \cdot
+                res = & \sum_i \dot{m}_{in,i} \cdot
                 \left( h_{in,i} - h_{in,i,ref} \right)\\
                 & - \sum_j \dot{m}_{out,3} \cdot
                 \left( h_{out,3} - h_{out,3,ref} \right)\\

{TESPy-0.2.1 → TESPy-0.2.2}/tespy/components/components.py

@@ -492,13 +492,15 @@ class component:
             Vector of residual values for component's fluid balance.
 
             .. math::
-                0 = fluid_{i,in} - fluid_{i,out} \;
-                \forall i \in \mathrm{fluid}
+
+                0 = fluid_{i,in_{j}} - fluid_{i,out_{j}} \;
+                \forall i \in \mathrm{fluid}, \; \forall j \in inlets/outlets
         """
         vec_res = []
 
-        for fluid, x in self.inl[0].fluid.val.items():
-            vec_res += [x - self.outl[0].fluid.val[fluid]]
+        for i in range(self.num_i):
+            for fluid, x in self.inl[0].fluid.val.items():
+                vec_res += [x - self.outl[0].fluid.val[fluid]]
         return vec_res
 
     def fluid_deriv(self):
@@ -510,14 +512,13 @@ class component:
         deriv : list
             Matrix with partial derivatives for the fluid equations.
         """
-        deriv = np.zeros((self.num_nw_fluids,
-                          2 + self.num_vars,
+        deriv = np.zeros((self.num_nw_fluids * self.num_i,
+                          2 * self.num_i + self.num_vars,
                           self.num_nw_vars))
-        i = 0
-        for fluid in self.nw_fluids:
-            deriv[i, 0, i + 3] = 1
-            deriv[i, 1, i + 3] = -1
-            i += 1
+        for i in range(self.num_i):
+            for j in range(self.num_nw_fluids):
+                deriv[i * self.num_nw_fluids + j, i, j + 3] = 1
+                deriv[i * self.num_nw_fluids + j, self.num_i + i, j + 3] = -1
         return deriv
 
 # %%
@@ -651,10 +652,22 @@ class component:
 
 # %%
 
-    def zeta_func(self):
+    def zeta_func(self, zeta='', inconn=0, outconn=0):
         r"""
         Calculate residual value of :math:`\zeta`-function.
 
+        Parameters
+        ----------
+        zeta : str
+            Component parameter to evaluate the zeta_func on, e. g.
+            :code:`zeta1`.
+
+        inconn : int
+            Connection index of inlet.
+
+        outconn : int
+            Connection index of outlet.
+
         Returns
         -------
         val : float
@@ -681,59 +694,15 @@ class component:
             \frac{\zeta}{D^4} = \frac{\Delta p \cdot \pi^2}
             {8 \cdot \dot{m}^2 \cdot v}
         """
-        i = self.inl[0].to_flow()
-        o = self.outl[0].to_flow()
-        if hasattr(self, 'zeta'):
-            val = self.zeta.val
-        else:
-            val = self.zeta1.val
+        zeta = self.get_attr(zeta).val
+        i = self.inl[inconn].to_flow()
+        o = self.outl[outconn].to_flow()
 
         if abs(i[0]) < 1e-4:
             return i[1] - o[1]
 
         else:
-            v_i = v_mix_ph(i, T0=self.inl[0].T.val_SI)
-            v_o = v_mix_ph(o, T0=self.outl[0].T.val_SI)
-            return (val - (i[1] - o[1]) * np.pi ** 2 /
-                    (8 * abs(i[0]) * i[0] * (v_i + v_o) / 2))
-
-    def zeta2_func(self):
-        r"""
-        Calculate residual value of :math:`\zeta_2`-function.
-
-        Returns
-        -------
-        val : float
-            Residual value of function.
-
-            .. math::
-
-                val = \begin{cases}
-                p_{in} - p_{out} & |\dot{m}| < \epsilon \\
-                \frac{\zeta_2}{D^4} - \frac{(p_{2,in} - p_{2,out}) \cdot \pi^2}
-                {8 \cdot \dot{m}_{2,in} \cdot |\dot{m}_{2,in}| \cdot
-                \frac{v_{2,in} + v_{2,out}}{2}} &
-                |\dot{m}| > \epsilon
-                \end{cases}
-
-        Note
-        ----
-        The zeta value is caluclated on the basis of a given pressure loss at
-        a given flow rate in the design case. As the cross sectional area A
-        will not change, it is possible to handle the equation in this way:
-
-        .. math::
-
-            \frac{\zeta_2}{D^4} =  \frac{\Delta p_2 \cdot \pi^2}
-            {8 \cdot \dot{m}_2^2 \cdot v}
-        """
-        i = self.inl[1].to_flow()
-        o = self.outl[1].to_flow()
-
-        if abs(i[0]) < 1e-4:
-            return i[1] - o[1]
-        else:
-            v_i = v_mix_ph(i, T0=self.inl[1].T.val_SI)
-            v_o = v_mix_ph(o, T0=self.outl[1].T.val_SI)
-            return (self.zeta2.val - (i[1] - o[1]) * np.pi ** 2 /
+            v_i = v_mix_ph(i, T0=self.inl[inconn].T.val_SI)
+            v_o = v_mix_ph(o, T0=self.outl[outconn].T.val_SI)
+            return (zeta - (i[1] - o[1]) * np.pi ** 2 /
                     (8 * abs(i[0]) * i[0] * (v_i + v_o) / 2))