thermofluids 2.0.2__tar.gz → 2.0.4__tar.gz

thermofluids-2.0.4/.gitlab-ci.yml

@@ -0,0 +1,11 @@
+pages:
+  stage: deploy
+  script:
+  - mkdir .public
+  - cp -r docs/build/html/* .public
+  - mv .public public
+  artifacts:
+    paths:
+    - public
+  only:
+  - main

thermofluids-2.0.4/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.5
+Name: thermofluids
+Version: 2.0.4
+Summary: Physically-consistent thermal and fluids modeling tools
+Project-URL: Documentation, https://thermofluids-24bc0b.gitlab.io/
+Project-URL: Repository, https://gitlab.com/ericksonla/thermofluids
+Author: Luke Erickson, Russell Goldfarbmuren
+Author-email: russell@rebound-tech.com
+License-Expression: MIT
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >3.11
+Requires-Dist: coolprop
+Requires-Dist: pint
+Requires-Dist: scipy
+Description-Content-Type: text/markdown
+
+# Thermofluids
+
+Thermofluids makes modeling thermofluid systems easier. The essential element is the `statepoint`. `statepoint` objects work like physical statepoints: they have two independent variables, many dependent variables, and sometimes extensive variables. You can use them like this:
+````python
+sp = Statepoint(fluid='water',  # define a fluid
+                t=25.0,         # define one independent variable
+                p=1.0,          # define a second independent variable
+                m=0.1)          # define extensive varible
+
+sp.rho, sp.h, sp.visc
+# (<Quantity(997.047039, 'kilogram / meter ** 3')>, <Quantity(104.918893, 'kilojoule / kilogram')>, <Quantity(0.000890022674, 'kilogram / meter / second')>)
+````
+
+Representing statepoints this way makes it easy to model thermodynamic cycles. The module includes some common
+thermodynamic unit processes to manipulate statepoints in physically meaningful ways. For example, we can model a 
+refrigeration cycle:
+
+````python
+from thermofluids import Statepoint, Quantity
+from thermofluids.ProcessEquipment import Compressor
+
+
+# Select a refrigerant
+REFR = 'R134A'
+
+# Find the saturation pressures of the refrigerant
+ssp = Statepoint(fluid=REFR, t=-10, x=1.).p
+scp = Statepoint(fluid=REFR, t=25., x=1.).p
+
+# Define a statepoint representing the state between the evaporator and compressor
+evap_to_comp = Statepoint(fluid=REFR, t=-5., p=ssp, m=0.1)
+
+# Use the built in compressor object to calculate the statepoint at the compressor outlet
+comp = Compressor(inlet=evap_to_comp,
+                  eta=0.7,
+                  Pout=scp)
+comp_to_cond = comp.get_outlet()
+print(f'Compressor work: {comp.work.to("kW")}')
+
+# Derive the statepoint representing the condensed state between the condenser and expansion valve
+cond_to_exp = Statepoint(fluid=REFR, t=20., p=scp, m=evap_to_comp.m)
+q_cond = cond_to_exp.m * (comp_to_cond.h - cond_to_exp.h)
+print(f'Condenser heat: {q_cond.to("kW")}')
+
+# Derive the statepoint representing the isenthalpically expanded refrigerant
+exp_to_evap = Statepoint(fluid=REFR, p=ssp, h=cond_to_exp.h, m=cond_to_exp.m)
+q_evap = evap_to_comp.m * (evap_to_comp.h - exp_to_evap.h)
+print(f'Evaporator heat: {q_evap.to("kW")}')
+cop = q_evap / comp.work
+print(f'Coefficient of performance: {cop.to("")}')
+````
+
+```
+>>> Compressor work: 3.637 kW
+>>> Condenser heat: 20.58 kW
+>>> Evaporator heat: 16.95 kW
+>>> Coefficient of performance: 4.659
+```
+
+# Documentation
+Read the full documentation at https://thermofluids-24bc0b.gitlab.io/

thermofluids-2.0.4/README.md

@@ -0,0 +1,61 @@
+# Thermofluids
+
+Thermofluids makes modeling thermofluid systems easier. The essential element is the `statepoint`. `statepoint` objects work like physical statepoints: they have two independent variables, many dependent variables, and sometimes extensive variables. You can use them like this:
+````python
+sp = Statepoint(fluid='water',  # define a fluid
+                t=25.0,         # define one independent variable
+                p=1.0,          # define a second independent variable
+                m=0.1)          # define extensive varible
+
+sp.rho, sp.h, sp.visc
+# (<Quantity(997.047039, 'kilogram / meter ** 3')>, <Quantity(104.918893, 'kilojoule / kilogram')>, <Quantity(0.000890022674, 'kilogram / meter / second')>)
+````
+
+Representing statepoints this way makes it easy to model thermodynamic cycles. The module includes some common
+thermodynamic unit processes to manipulate statepoints in physically meaningful ways. For example, we can model a 
+refrigeration cycle:
+
+````python
+from thermofluids import Statepoint, Quantity
+from thermofluids.ProcessEquipment import Compressor
+
+
+# Select a refrigerant
+REFR = 'R134A'
+
+# Find the saturation pressures of the refrigerant
+ssp = Statepoint(fluid=REFR, t=-10, x=1.).p
+scp = Statepoint(fluid=REFR, t=25., x=1.).p
+
+# Define a statepoint representing the state between the evaporator and compressor
+evap_to_comp = Statepoint(fluid=REFR, t=-5., p=ssp, m=0.1)
+
+# Use the built in compressor object to calculate the statepoint at the compressor outlet
+comp = Compressor(inlet=evap_to_comp,
+                  eta=0.7,
+                  Pout=scp)
+comp_to_cond = comp.get_outlet()
+print(f'Compressor work: {comp.work.to("kW")}')
+
+# Derive the statepoint representing the condensed state between the condenser and expansion valve
+cond_to_exp = Statepoint(fluid=REFR, t=20., p=scp, m=evap_to_comp.m)
+q_cond = cond_to_exp.m * (comp_to_cond.h - cond_to_exp.h)
+print(f'Condenser heat: {q_cond.to("kW")}')
+
+# Derive the statepoint representing the isenthalpically expanded refrigerant
+exp_to_evap = Statepoint(fluid=REFR, p=ssp, h=cond_to_exp.h, m=cond_to_exp.m)
+q_evap = evap_to_comp.m * (evap_to_comp.h - exp_to_evap.h)
+print(f'Evaporator heat: {q_evap.to("kW")}')
+cop = q_evap / comp.work
+print(f'Coefficient of performance: {cop.to("")}')
+````
+
+```
+>>> Compressor work: 3.637 kW
+>>> Condenser heat: 20.58 kW
+>>> Evaporator heat: 16.95 kW
+>>> Coefficient of performance: 4.659
+```
+
+# Documentation
+Read the full documentation at https://thermofluids-24bc0b.gitlab.io/

thermofluids-2.0.4/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

thermofluids-2.0.4/docs/build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 7dab40b6708a2b61d02c742b45ba849e
+tags: 645f666f9bcd5a90fca523b33c5a78b7

thermofluids-2.0.4/docs/build/html/_sources/index.rst.txt

@@ -0,0 +1,120 @@
+.. Thermofluids documentation master file, created by
+   sphinx-quickstart on Thu Oct  8 13:47:07 2026.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Thermofluids
+============
+Thermofluids makes modeling thermofluid systems easier. The essential element is the `statepoint`. `statepoint` objects work like physical statepoints: they have two independent variables, many dependent variables, and sometimes extensive variables. You can use them like this::
+
+   sp = Statepoint(fluid='water',  # define a fluid
+                   t=25.0,         # define one independent variable
+                   p=1.0,          # define a second independent variable
+                   m=0.1)          # define extensive varible
+
+   sp.rho, sp.h, sp.visc
+
+   >>> (<Quantity(997.047039, 'kilogram / meter ** 3')>, <Quantity(104.918893, 'kilojoule / kilogram')>, <Quantity(0.000890022674, 'kilogram / meter / second')>)
+
+Representing statepoints this way makes it easy to model thermodynamic cycles. The module includes some common
+thermodynamic unit processes to manipulate statepoints in physically meaningful ways. For example, we can model a
+refrigeration cycle::
+
+   from thermofluids import Statepoint, Quantity
+   from thermofluids.ProcessEquipment import Compressor
+
+
+   # Select a refrigerant
+   REFR = 'R134A'
+
+   # Find the saturation pressures of the refrigerant
+   ssp = Statepoint(fluid=REFR, t=-10, x=1.).p
+   scp = Statepoint(fluid=REFR, t=25., x=1.).p
+
+   # Define a statepoint representing the state between the evaporator and compressor
+   evap_to_comp = Statepoint(fluid=REFR, t=-5., p=ssp, m=0.1)
+
+   # Use the built in compressor object to calculate the statepoint at the compressor outlet
+   comp = Compressor(inlet=evap_to_comp,
+                     eta=0.7,
+                     Pout=scp)
+   comp_to_cond = comp.get_outlet()
+   print(f'Compressor work: {comp.work.to("kW")}')
+
+   # Derive the statepoint representing the condensed state between the condenser and expansion valve
+   cond_to_exp = Statepoint(fluid=REFR, t=20., p=scp, m=evap_to_comp.m)
+   q_cond = cond_to_exp.m * (comp_to_cond.h - cond_to_exp.h)
+   print(f'Condenser heat: {q_cond.to("kW")}')
+
+   # Derive the statepoint representing the isenthalpically expanded refrigerant
+   exp_to_evap = Statepoint(fluid=REFR, p=ssp, h=cond_to_exp.h, m=cond_to_exp.m)
+   q_evap = evap_to_comp.m * (evap_to_comp.h - exp_to_evap.h)
+   print(f'Evaporator heat: {q_evap.to("kW")}')
+   cop = q_evap / comp.work
+   print(f'Coefficient of performance: {cop.to("")}')
+
+
+   >>> Compressor work: 3.637 kW
+   >>> Condenser heat: 20.58 kW
+   >>> Evaporator heat: 16.95 kW
+   >>> Coefficient of performance: 4.659
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+Essential Functionality
+_______________________
+.. autoclass:: thermofluids.Base.Statepoint.Statepoint
+   :members: __add__, __div__
+.. autoclass:: ...src.Base.Quantity
+
+Fluids
+______
+.. automodule:: thermofluids.Fluids.Drag
+   :members: f_drag, settling_vel
+.. automodule:: thermofluids.Fluids.Moody
+   :members: frictionfactor
+.. automodule:: thermofluids.Fluids.Re
+   :members: Re, Re_ext
+.. automodule:: thermofluids.Fluids.PressureDrop
+   :members: pressure_drop, pressure_drop_fitting, pressure_drop_packed_bed, pressure_drop_corrugated_plates, flow_at_dp
+
+Heat Transfer
+_____________
+.. automodule:: thermofluids.HeatTransfer.lmtd
+   :members: lmtd
+.. automodule:: thermofluids.HeatTransfer.Nusselt
+   :members: Nu, Nu_natural
+.. automodule:: thermofluids.HeatTransfer.Ra
+   :members: Ra
+.. automodule:: thermofluids.HeatTransfer.Gr
+   :members: Gr
+.. automodule:: thermofluids.HeatTransfer.NTU
+   :members: NTU
+.. automodule:: thermofluids.HeatTransfer.TwoPhase
+   :members: Co, Bo, Fr_le, crit_heat_flux, heat_flux_nucleate_boiling, htc_conv_boil
+
+Special Properties
+__________________
+.. automodule:: thermofluids.Properties
+.. automodule:: thermofluids.Properties.BrineProps
+   :members: get_c_freeze, get_T_liq_sat, get_T_vap_sat, get_P_liq_sat, get_P_vap_sat, get_h_mix, get_C_vap_sat, get_C_liq_sat
+
+Process Equipment
+_________________
+.. automodule:: thermofluids.ProcessEquipment
+.. automodule:: thermofluids.ProcessEquipment.Column
+   :members: Column
+.. automodule:: thermofluids.ProcessEquipment.Compressor
+   :members: Compressor
+.. automodule:: thermofluids.ProcessEquipment.HeatExchanger
+   :members: HX_Energy
+.. automodule:: thermofluids.ProcessEquipment.IsoCompressor
+   :members: IsoCompressor
+.. automodule:: thermofluids.ProcessEquipment.Pump
+   :members: Pump
+.. automodule:: thermofluids.ProcessEquipment.Turbine
+   :members: Turbine
+.. automodule:: thermofluids.ProcessEquipment.Valve
+   :members: get_valve_flow_rate, get_valve_dP, get_valve_C_v

thermofluids-2.0.4/docs/build/html/_static/_sphinx_javascript_frameworks_compat.js

@@ -0,0 +1,123 @@
+/* Compatability shim for jQuery and underscores.js.
+ *
+ * Copyright Sphinx contributors
+ * Released under the two clause BSD licence
+ */
+
+/**
+ * small helper function to urldecode strings
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
+ */
+jQuery.urldecode = function(x) {
+    if (!x) {
+        return x
+    }
+    return decodeURIComponent(x.replace(/\+/g, ' '));
+};
+
+/**
+ * small helper function to urlencode strings
+ */
+jQuery.urlencode = encodeURIComponent;
+
+/**
+ * This function returns the parsed url parameters of the
+ * current request. Multiple values per key are supported,
+ * it will always return arrays of strings for the value parts.
+ */
+jQuery.getQueryParameters = function(s) {
+    if (typeof s === 'undefined')
+        s = document.location.search;
+    var parts = s.substr(s.indexOf('?') + 1).split('&');
+    var result = {};
+    for (var i = 0; i < parts.length; i++) {
+        var tmp = parts[i].split('=', 2);
+        var key = jQuery.urldecode(tmp[0]);
+        var value = jQuery.urldecode(tmp[1]);
+        if (key in result)
+            result[key].push(value);
+        else
+            result[key] = [value];
+    }
+    return result;
+};
+
+/**
+ * highlight a given string on a jquery object by wrapping it in
+ * span elements with the given class name.
+ */
+jQuery.fn.highlightText = function(text, className) {
+    function highlight(node, addItems) {
+        if (node.nodeType === 3) {
+            var val = node.nodeValue;
+            var pos = val.toLowerCase().indexOf(text);
+            if (pos >= 0 &&
+                !jQuery(node.parentNode).hasClass(className) &&
+                !jQuery(node.parentNode).hasClass("nohighlight")) {
+                var span;
+                var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
+                if (isInSVG) {
+                    span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+                } else {
+                    span = document.createElement("span");
+                    span.className = className;
+                }
+                span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+                node.parentNode.insertBefore(span, node.parentNode.insertBefore(
+                    document.createTextNode(val.substr(pos + text.length)),
+                    node.nextSibling));
+                node.nodeValue = val.substr(0, pos);
+                if (isInSVG) {
+                    var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
+                    var bbox = node.parentElement.getBBox();
+                    rect.x.baseVal.value = bbox.x;
+                    rect.y.baseVal.value = bbox.y;
+                    rect.width.baseVal.value = bbox.width;
+                    rect.height.baseVal.value = bbox.height;
+                    rect.setAttribute('class', className);
+                    addItems.push({
+                        "parent": node.parentNode,
+                        "target": rect});
+                }
+            }
+        }
+        else if (!jQuery(node).is("button, select, textarea")) {
+            jQuery.each(node.childNodes, function() {
+                highlight(this, addItems);
+            });
+        }
+    }
+    var addItems = [];
+    var result = this.each(function() {
+        highlight(this, addItems);
+    });
+    for (var i = 0; i < addItems.length; ++i) {
+        jQuery(addItems[i].parent).before(addItems[i].target);
+    }
+    return result;
+};
+
+/*
+ * backward compatibility for jQuery.browser
+ * This will be supported until firefox bug is fixed.
+ */
+if (!jQuery.browser) {
+    jQuery.uaMatch = function(ua) {
+        ua = ua.toLowerCase();
+
+        var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
+            /(webkit)[ \/]([\w.]+)/.exec(ua) ||
+            /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
+            /(msie) ([\w.]+)/.exec(ua) ||
+            ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
+            [];
+
+        return {
+            browser: match[ 1 ] || "",
+            version: match[ 2 ] || "0"
+        };
+    };
+    jQuery.browser = {};
+    jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
+}