From 10361de2d85bec06e09f37cc66f03f500807c049 Mon Sep 17 00:00:00 2001
From: David Andrs <andrsd@gmail.com>
Date: Fri, 19 May 2023 11:21:54 -0600
Subject: [PATCH] Adding helium fluid properties (doco)

---
 docs/CMakeLists.txt     | 26 ++++++++++++++++++++++++++
 docs/classes/helium.rst |  5 +++++
 docs/fluids/helium.rst  | 32 ++++++++++++++++++++++++++++++++
 docs/pyplots/he.yml     | 18 ++++++++++++++++++
 docs/references.bib     | 27 +++++++++++++++++++++++++++
 5 files changed, 108 insertions(+)
 create mode 100644 docs/classes/helium.rst
 create mode 100644 docs/fluids/helium.rst
 create mode 100644 docs/pyplots/he.yml

diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
index ecbf917..481b72f 100644
--- a/docs/CMakeLists.txt
+++ b/docs/CMakeLists.txt
@@ -34,6 +34,18 @@ if(DOXYGEN_FOUND)
         air_err_u.png
         air_err_w.png
     )
+    file(GLOB_RECURSE RST_FILES ${PROJECT_SOURCE_DIR}/docs/*.rst)
+    set(HE_ERR_IMGS
+        he_err_c_p.png
+        he_err_c_v.png
+        he_err_h.png
+        he_err_k.png
+        he_err_mu.png
+        he_err_rho.png
+        he_err_s.png
+        he_err_u.png
+        he_err_w.png
+    )
 
     add_custom_command(
         OUTPUT
@@ -46,6 +58,7 @@ if(DOXYGEN_FOUND)
             ${RST_FILES}
             ${N2_ERR_IMGS}
             ${AIR_ERR_IMGS}
+            ${HE_ERR_IMGS}
     )
 
     add_custom_command(
@@ -84,6 +97,19 @@ if(DOXYGEN_FOUND)
             ${PROJECT_SOURCE_DIR}/docs/pyplots/air.yml
     )
 
+    add_custom_command(
+        OUTPUT
+            ${HE_ERR_IMGS}
+        COMMAND
+            ${CMAKE_COMMAND} -E env "PYTHONPATH=${PROJECT_BINARY_DIR}/python/src:$ENV{PYTHONPATH}"
+            python3 plot_err.py he.yml
+        WORKING_DIRECTORY
+            ${PROJECT_SOURCE_DIR}/docs/pyplots
+        DEPENDS
+            ${PROJECT_SOURCE_DIR}/docs/pyplots/plot_err.py
+            ${PROJECT_SOURCE_DIR}/docs/pyplots/he.yml
+    )
+
     add_custom_command(
         TARGET doc
         POST_BUILD
diff --git a/docs/classes/helium.rst b/docs/classes/helium.rst
new file mode 100644
index 0000000..746d641
--- /dev/null
+++ b/docs/classes/helium.rst
@@ -0,0 +1,5 @@
+Helium
+======
+
+.. doxygenclass:: fprops::Helium
+   :members:
diff --git a/docs/fluids/helium.rst b/docs/fluids/helium.rst
new file mode 100644
index 0000000..05fcdaa
--- /dev/null
+++ b/docs/fluids/helium.rst
@@ -0,0 +1,32 @@
+Helium
+======
+
+Range of validity:
+
+- Temperature: `0.8 - 1500 K`
+- Pressure: to `2000 MPa`
+
+Computation of thermodynamic properties is based on :cite:t:`oritzvega2019`.
+Viscosity is based on :cite:t:`arp1989thermophysical`,
+thermal conductivity is based on :cite:t:`HANDS1981697`.
+
+Verification against CoolProp package
+-------------------------------------
+
+.. image:: ../pyplots/he_err_rho.png
+
+.. image:: ../pyplots/he_err_u.png
+
+.. image:: ../pyplots/he_err_h.png
+
+.. image:: ../pyplots/he_err_s.png
+
+.. image:: ../pyplots/he_err_w.png
+
+.. image:: ../pyplots/he_err_c_p.png
+
+.. image:: ../pyplots/he_err_c_v.png
+
+.. image:: ../pyplots/he_err_mu.png
+
+.. image:: ../pyplots/he_err_k.png
diff --git a/docs/pyplots/he.yml b/docs/pyplots/he.yml
new file mode 100644
index 0000000..5606c04
--- /dev/null
+++ b/docs/pyplots/he.yml
@@ -0,0 +1,18 @@
+fprops:
+  name: he
+  coolprop: Helium
+  fprops: Helium
+  p: [
+    0.1, 0.2,
+    0.5, 1, 1.5, 2, 2.5, 3, 3.5, 4,
+    5, 6, 8,
+    10, 15, 20, 25,
+    50, 75, 100,
+    200, 400, 600, 800, 1000
+  ]
+  T: [
+    60, 65, 70, 75, 80, 85, 90, 95, 100, 105, 110, 115, 120, 125, 130, 135, 140, 145, 150,
+    160, 170, 180, 190, 200, 210, 220, 230, 240, 250, 260, 270, 280, 290, 300, 310, 320, 330, 340, 350,
+    400, 450, 500, 550,
+    600, 700, 800, 900, 1000
+  ]
diff --git a/docs/references.bib b/docs/references.bib
index f81b0c6..fc47895 100644
--- a/docs/references.bib
+++ b/docs/references.bib
@@ -30,3 +30,30 @@ @article{lemmon2004viscosity
   year={2004},
   publisher={Springer}
 }
+
+@unpublished{oritzvega2019,
+  author={D. O. Ortiz-Vega and K. R. Hall and J. C. Holste and V. D. Arp and A. H. Harvey and E. W. Lemmon},
+  title={Equation of state for Helium-4},
+  note={Coefficients from REPROP 10},
+  year={2019}
+}
+
+@article{HANDS1981697,
+    title = {A correlation of thermal conductivity data for helium},
+    journal = {Cryogenics},
+    volume = {21},
+    number = {12},
+    pages = {697-703},
+    year = {1981},
+    issn = {0011-2275},
+    doi = {https://doi.org/10.1016/0011-2275(81)90211-3},
+    author = {B.A. Hands and V.D. Arp},
+    abstract = {A correlation for the thermal conductivity of helium has been developed which covers the temperature range from temperatures just above the lambda line to 830 K, and densities up to about 160 kg m−3. The data used incorporate some recent experimental results which cover the temperature range from 4 K to 20 K including the critical region. The correlation gives an equation which generally fits the experimental data within ± 5%. However, at low temperature, the experimental data deviate up to about 10% from predictions based upon viscosity measurements or molecular dynamics calculations.}
+}
+
+@techreport{arp1989thermophysical,
+  title={Thermophysical Properties of Helium-4 from 0.8 to 1500 K with Pressures to 2000 MPa},
+  author={Arp, Vincent D and McCarty, Robert D},
+  year={1989},
+  institution={}
+}