new version

aumpierre-unb · Sep 4, 2022 · 24ed541 · 24ed541
1 parent 0e3fbc5
commit 24ed541
Show file tree

Hide file tree

Showing 35 changed files with 213 additions and 104 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -4,7 +4,7 @@ Title: Internal Fluid Flow Toolbox for Scilab
 
 Summary: A toolbox for internal fluid flow
 
-Version: 0.1.1
+Version: 0.1.2
 
 Author: Alexandre Umpierre
 
@@ -22,6 +22,6 @@ ScilabVersion: >= 6.0
 
 Depends: 
 
-Date: 2022-08-27
+Date: 2022-09-04
 
 Description: This package provides a set of functions designed to solve problems of internal fluid flow on Scilab under GNU GPLv3. All functions are based on the Poiseuille condition for laminar flow, the Colebrooke-White equation for turbulent flow, and the Darcy-Weisbach equation for head loss. Basic functions allow to compute either the Reynolds number or the Darcy friction factor, given one of them is given along with the relative roughness. More advanced functions allow to compute both the Reynolds number and the Darcy friction factor given the head loss and other variables that describe the fluid flow. Enjoy!
diff --git a/NEWS b/NEWS
@@ -1,6 +1,9 @@
 TODO
 ====
-* Minor adjustments on plots (ongoing)
+
+inflowlib v0.1.0 (2022-09-04)
+=============================
+* Minor adjustments on plots
 
 inflowlib v0.1.1 (2022-08-27)
 =============================

diff --git a/README.md b/README.md
@@ -3,11 +3,25 @@
 [![DOI](https://zenodo.org/badge/509430202.svg)](https://zenodo.org/badge/latestdoi/509430202)
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 
+### Install and load Internal Fluid Flow Toolbox for Scilab:
+
+1. Download ``v0.1.2.zip`` file from the current release page.
+
+2. Set Scilab current directory to the download folder.
+
+3. To install the toolbox, type:
+
+``--> atomsInstall('v0.1.2.zip')``
+
+4. To load the toolbox, type:
+
+``--> atomsLoad('inflowlib')``
+
 This is a very short introduction to the steady internal flow of an incompressible and inviscid fluid and to the Internal Fluid Flow Toolbox for Scilab.
 
 Our focus here is a small set of equations that described the phenomenon and are required to solve problems on internal fluid flow. Internal flow is a pretty extensive topic in fluid mechanics and there are a lot of important and interesting observations related to it that are not taken into account in this text, because they have no direct impact the computation performed by the functions in this toolbox.
 
-This text is divided in two main sections: The Theory and The Internal Fluid Flow Toolbox.
+This text is divided in two main sections: The Theory and The Internal Fluid Flow Toolbox for Scilab.
 
 ## The Theory
 

diff --git a/help/epsRe2fD.xml b/help/epsRe2fD.xml
@@ -24,7 +24,7 @@
 <refsynopsisdiv>
    <title>Syntax</title>
    <synopsis>
-   [fD]=epsRe2fD(Re[,eps[,s]])
+   [fD]=epsRe2fD(Re[,eps[,fig]])
 
    </synopsis>
 </refsynopsisdiv>
@@ -41,8 +41,8 @@
             <listitem><para> optional, relative roughness (default is eps=2e-3)</para></listitem>
         </varlistentry>
         <varlistentry>
-            <term>s:</term>
-            <listitem><para> optional, boolean for display plot (default is s=%f)</para></listitem>
+            <term>fig:</term>
+            <listitem><para> optional, boolean for display plot (default is fig=%f)</para></listitem>
         </varlistentry>
         <varlistentry>
             <term>fD:</term>

diff --git a/help/epsfD2Re.xml b/help/epsfD2Re.xml
@@ -24,7 +24,7 @@
 <refsynopsisdiv>
    <title>Syntax</title>
    <synopsis>
-   [Re]=epsfD2Re(fD[,eps[,s]])
+   [Re]=epsfD2Re(fD[,eps[,fig]])
 
    </synopsis>
 </refsynopsisdiv>
@@ -41,8 +41,8 @@
             <listitem><para> optional, relative roughness (default is eps=2e-3)</para></listitem>
         </varlistentry>
         <varlistentry>
-            <term>s:</term>
-            <listitem><para> optional, boolean for display plot (default is s=%f)</para></listitem>
+            <term>fig:</term>
+            <listitem><para> optional, boolean for display plot (default is fig=%f)</para></listitem>
         </varlistentry>
         <varlistentry>
             <term>Re:</term>

diff --git a/help/hDeps2fDRe.xml b/help/hDeps2fDRe.xml
@@ -24,7 +24,7 @@
 <refsynopsisdiv>
    <title>Syntax</title>
    <synopsis>
-   [Re,fD]=hDeps2fDRe(h,g,mu,rho,D,L,eps[,s])
+   [Re,fD]=hDeps2fDRe(h,g,mu,rho,D,L,eps[,fig])
 
    </synopsis>
 </refsynopsisdiv>
@@ -61,8 +61,8 @@
             <listitem><para> pipe's relative roughness</para></listitem>
         </varlistentry>
         <varlistentry>
-            <term>s:</term>
-            <listitem><para> optional, boolean for display plot (default is s=%f)</para></listitem>
+            <term>fig:</term>
+            <listitem><para> optional, boolean for display plot (default is fig=%f)</para></listitem>
         </varlistentry>
         <varlistentry>
             <term>Re:</term>

diff --git a/help/hQeps2fDRe.xml b/help/hQeps2fDRe.xml
@@ -24,7 +24,7 @@
 <refsynopsisdiv>
    <title>Syntax</title>
    <synopsis>
-   [Re,fD]=hQeps2fDRe(h,g,mu,rho,Q,L,eps[,s])
+   [Re,fD]=hQeps2fDRe(h,g,mu,rho,Q,L,eps[,fig])
 
    </synopsis>
 </refsynopsisdiv>
@@ -61,8 +61,8 @@
             <listitem><para> pipe's relative roughness</para></listitem>
         </varlistentry>
         <varlistentry>
-            <term>s:</term>
-            <listitem><para> optional, boolean for display plot (default is s=%f)</para></listitem>
+            <term>fig:</term>
+            <listitem><para> optional, boolean for display plot (default is fig=%f)</para></listitem>
         </varlistentry>
         <varlistentry>
             <term>Re:</term>

diff --git a/help/hQthk2fDRe.xml b/help/hQthk2fDRe.xml
@@ -24,7 +24,7 @@
 <refsynopsisdiv>
    <title>Syntax</title>
    <synopsis>
-   [Re,fD]=hQthk2fDRe(h,g,mu,rho,Q,L,thk[,s])
+   [Re,fD]=hQthk2fDRe(h,g,mu,rho,Q,L,thk[,fig])
 
    </synopsis>
 </refsynopsisdiv>
@@ -61,8 +61,8 @@
             <listitem><para> pipe's roughness</para></listitem>
         </varlistentry>
         <varlistentry>
-            <term>s:</term>
-            <listitem><para> optional, boolean for display plot (default is s=%f)</para></listitem>
+            <term>fig:</term>
+            <listitem><para> optional, boolean for display plot (default is fig=%f)</para></listitem>
         </varlistentry>
         <varlistentry>
             <term>Re:</term>

diff --git a/help/hveps2fDRe.xml b/help/hveps2fDRe.xml
@@ -24,7 +24,7 @@
 <refsynopsisdiv>
    <title>Syntax</title>
    <synopsis>
-   [Re,fD]=hveps2fDRe(h,g,mu,rho,v,L,eps,[,s])
+   [Re,fD]=hveps2fDRe(h,g,mu,rho,v,L,eps,[,fig])
 
    </synopsis>
 </refsynopsisdiv>
@@ -61,8 +61,8 @@
             <listitem><para> pipe's relative roughness</para></listitem>
         </varlistentry>
         <varlistentry>
-            <term>s:</term>
-            <listitem><para> optional, boolean for display plot (default is s=%f)</para></listitem>
+            <term>fig:</term>
+            <listitem><para> optional, boolean for display plot (default is fig=%f)</para></listitem>
         </varlistentry>
         <varlistentry>
             <term>Re:</term>

diff --git a/help/hvthk2fDRe.xml b/help/hvthk2fDRe.xml
@@ -24,7 +24,7 @@
 <refsynopsisdiv>
    <title>Syntax</title>
    <synopsis>
-   [Re,fD]=hvthk2fDRe(h,g,mu,rho,v,L,thk[,s])
+   [Re,fD]=hvthk2fDRe(h,g,mu,rho,v,L,thk[,fig])
 
    </synopsis>
 </refsynopsisdiv>
@@ -61,8 +61,8 @@
             <listitem><para> pipe's roughness</para></listitem>
         </varlistentry>
         <varlistentry>
-            <term>s:</term>
-            <listitem><para> optional, boolean for display plot (default is s=%f)</para></listitem>
+            <term>fig:</term>
+            <listitem><para> optional, boolean for display plot (default is fig=%f)</para></listitem>
         </varlistentry>
         <varlistentry>
             <term>Re:</term>

diff --git a/help/master_help.xml b/help/master_help.xml
@@ -1,13 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE book [
 <!--Begin Entities-->
-<!ENTITY ac80445ec5b0046ded6debaa6def49c7f SYSTEM "file:///E:/programacao-sync/scilab/inflowlib/help/epsRe2fD.xml">
-<!ENTITY aff2c59b6b826fdfff7d68dcb19d367af SYSTEM "file:///E:/programacao-sync/scilab/inflowlib/help/epsfD2Re.xml">
-<!ENTITY a2a10d2219f38208a78507c55b38f332c SYSTEM "file:///E:/programacao-sync/scilab/inflowlib/help/hDeps2fDRe.xml">
-<!ENTITY a1585424d93fa7c89dc6559e3890ae944 SYSTEM "file:///E:/programacao-sync/scilab/inflowlib/help/hQeps2fDRe.xml">
-<!ENTITY ab875e5c8d4ba682d4aa10f4ae437a28a SYSTEM "file:///E:/programacao-sync/scilab/inflowlib/help/hQthk2fDRe.xml">
-<!ENTITY a58254fa7da28ca5ab8a9e109c86a062d SYSTEM "file:///E:/programacao-sync/scilab/inflowlib/help/hveps2fDRe.xml">
-<!ENTITY ae2f53c030efd7b14fe373834062138e6 SYSTEM "file:///E:/programacao-sync/scilab/inflowlib/help/hvthk2fDRe.xml">
+<!ENTITY aec82fdb30033a5817f8089b64e11b088 SYSTEM "file:///D:/UnB/programacao/scilab/inflowlib/help/epsRe2fD.xml">
+<!ENTITY a860be86d2e2c221340eeacc7e797fbe1 SYSTEM "file:///D:/UnB/programacao/scilab/inflowlib/help/epsfD2Re.xml">
+<!ENTITY a33b56b1ed421efc8c8aa15efade4152f SYSTEM "file:///D:/UnB/programacao/scilab/inflowlib/help/hDeps2fDRe.xml">
+<!ENTITY ad7ea9bd1d1c9fc774adc28f752e26b6c SYSTEM "file:///D:/UnB/programacao/scilab/inflowlib/help/hQeps2fDRe.xml">
+<!ENTITY a38f04710b149a80965e670e6b6fc6575 SYSTEM "file:///D:/UnB/programacao/scilab/inflowlib/help/hQthk2fDRe.xml">
+<!ENTITY a6cb3b8bc2465c4a46490b10241b40b98 SYSTEM "file:///D:/UnB/programacao/scilab/inflowlib/help/hveps2fDRe.xml">
+<!ENTITY a33d406922dbe6facc91bf56936813a6c SYSTEM "file:///D:/UnB/programacao/scilab/inflowlib/help/hvthk2fDRe.xml">
 <!--End Entities-->
 ]>
 <book version="5.0-subset Scilab" xml:lang="en_US"
@@ -22,14 +22,14 @@
     <title>Internal Fluid Flow</title>
   </info>
 
-<part xml:id='section_8bfecf9836e3fd00fd91909d3b01db8f'>
+<part xml:id='section_1a5d32a5774a02b036ca9077794f67ce'>
 <title>Internal Fluid Flow</title>
-&ac80445ec5b0046ded6debaa6def49c7f;
-&aff2c59b6b826fdfff7d68dcb19d367af;
-&a2a10d2219f38208a78507c55b38f332c;
-&a1585424d93fa7c89dc6559e3890ae944;
-&ab875e5c8d4ba682d4aa10f4ae437a28a;
-&a58254fa7da28ca5ab8a9e109c86a062d;
-&ae2f53c030efd7b14fe373834062138e6;
+&aec82fdb30033a5817f8089b64e11b088;
+&a860be86d2e2c221340eeacc7e797fbe1;
+&a33b56b1ed421efc8c8aa15efade4152f;
+&ad7ea9bd1d1c9fc774adc28f752e26b6c;
+&a38f04710b149a80965e670e6b6fc6575;
+&a6cb3b8bc2465c4a46490b10241b40b98;
+&a33d406922dbe6facc91bf56936813a6c;
 </part>
 </book>
diff --git a/help/scilab_en_US_help/JavaHelpSearch/DOCS b/help/scilab_en_US_help/JavaHelpSearch/DOCS
diff --git a/help/scilab_en_US_help/JavaHelpSearch/DOCS.TAB b/help/scilab_en_US_help/JavaHelpSearch/DOCS.TAB
@@ -1 +1,2 @@
-ť�ퟎ⟿ｽ睟퀁㊪ꪪꪪ⣊ꪪꪪꪪꪪꪪꪊ㊪訲ꪊ貪ꪪꢻ뿿￺ꫪꪪﮘ
+ťｽ翿﷗﷕ퟷ吁㊪ꪪꪢ첪⨲ꨪꌊ꣈ꪪ㈪ꌪꪨꣂꨰꌪꨪꪌꪪꪪ⣊訲ꪪꪪ⣊⯯뾫�
+�Ȫ�2*�*���ª0�*�*������(ʊ2����(�+￫�
diff --git a/help/scilab_en_US_help/JavaHelpSearch/OFFSETS b/help/scilab_en_US_help/JavaHelpSearch/OFFSETS
@@ -1 +1 @@
-��j��Cߤ���I�Q���`:��1�񆊅̀
+��o�R��P��C�����zdƵ�
diff --git a/help/scilab_en_US_help/JavaHelpSearch/POSITIONS b/help/scilab_en_US_help/JavaHelpSearch/POSITIONS
diff --git a/help/scilab_en_US_help/JavaHelpSearch/SCHEMA b/help/scilab_en_US_help/JavaHelpSearch/SCHEMA
@@ -1,2 +1,2 @@
 JavaSearch 1.0
-TMAP bs=2048 rt=0 fl=-1 id1=172 id2=1
+TMAP bs=2048 rt=0 fl=-1 id1=173 id2=1
diff --git a/help/scilab_en_US_help/JavaHelpSearch/TMAP b/help/scilab_en_US_help/JavaHelpSearch/TMAP
diff --git a/help/scilab_en_US_help/epsRe2fD.html b/help/scilab_en_US_help/epsRe2fD.html
@@ -12,11 +12,11 @@
     <div class="manualnavbar">
     <table width="100%"><tr>
       <td width="30%">
-    	<span class="previous"><a href="section_8bfecf9836e3fd00fd91909d3b01db8f.html">&lt;&lt; Internal Fluid Flow</a></span>
+    	<span class="previous"><a href="section_1a5d32a5774a02b036ca9077794f67ce.html">&lt;&lt; Internal Fluid Flow</a></span>
 
       </td>
       <td width="40%" class="center">
-      	<span class="top"><a href="section_8bfecf9836e3fd00fd91909d3b01db8f.html">Internal Fluid Flow</a></span>
+      	<span class="top"><a href="section_1a5d32a5774a02b036ca9077794f67ce.html">Internal Fluid Flow</a></span>
 
       </td>
       <td width="30%" class="next">
@@ -29,23 +29,23 @@
 
 
 
-    <span class="path" dir="ltr"><a href="index.html">Internal Fluid Flow</a> &gt;&gt; <a href="section_8bfecf9836e3fd00fd91909d3b01db8f.html">Internal Fluid Flow</a> &gt; epsRe2fD</span>
+    <span class="path" dir="ltr"><a href="index.html">Internal Fluid Flow</a> &gt;&gt; <a href="section_1a5d32a5774a02b036ca9077794f67ce.html">Internal Fluid Flow</a> &gt; epsRe2fD</span>
 
     <br /><br />
     <div class="refnamediv"><h1 class="refname">epsRe2fD</h1>
     <p class="refpurpose">Computes the Darcy friction factor given the Reynolds number and the relative roughness</p></div>
 
 
 <div class="refsynopsisdiv"><h3 class="title">Syntax</h3>
-   <div class="synopsis"><pre><span class="default">[</span><span class="default">fD</span><span class="default">]=</span><span class="functionid">epsRe2fD</span><span class="default">(</span><span class="default">Re</span><span class="default">[,</span><span class="default">eps</span><span class="default">[,</span><span class="default">s</span><span class="default">]])</span></pre></div></div>
+   <div class="synopsis"><pre><span class="default">[</span><span class="default">fD</span><span class="default">]=</span><span class="functionid">epsRe2fD</span><span class="default">(</span><span class="default">Re</span><span class="default">[,</span><span class="default">eps</span><span class="default">[,</span><span class="default">fig</span><span class="default">]])</span></pre></div></div>
 
 <div class="refsection"><h3 class="title">Parameters</h3>
    <dl><dt><span class="term">Re:</span>
             <dd><p class="para">Reynolds number</p></dd></dt>
         <dt><span class="term">eps:</span>
             <dd><p class="para">optional, relative roughness (default is eps=2e-3)</p></dd></dt>
-        <dt><span class="term">s:</span>
-            <dd><p class="para">optional, boolean for display plot (default is s=%f)</p></dd></dt>
+        <dt><span class="term">fig:</span>
+            <dd><p class="para">optional, boolean for display plot (default is fig=%f)</p></dd></dt>
         <dt><span class="term">fD:</span>
             <dd><p class="para">Darcy friction factor</p></dd></dt></dl></div>
 
@@ -104,11 +104,11 @@
     <tr><td colspan="3" class="next"><a href="http://bugzilla.scilab.org/enter_bug.cgi?product=Scilab%20software&component=Documentation%20pages" class="ulink">Report an issue</a></td></tr>
 <tr>
       <td width="30%">
-    	<span class="previous"><a href="section_8bfecf9836e3fd00fd91909d3b01db8f.html">&lt;&lt; Internal Fluid Flow</a></span>
+    	<span class="previous"><a href="section_1a5d32a5774a02b036ca9077794f67ce.html">&lt;&lt; Internal Fluid Flow</a></span>
 
       </td>
       <td width="40%" class="center">
-      	<span class="top"><a href="section_8bfecf9836e3fd00fd91909d3b01db8f.html">Internal Fluid Flow</a></span>
+      	<span class="top"><a href="section_1a5d32a5774a02b036ca9077794f67ce.html">Internal Fluid Flow</a></span>
 
       </td>
       <td width="30%" class="next">

diff --git a/help/scilab_en_US_help/epsfD2Re.html b/help/scilab_en_US_help/epsfD2Re.html
@@ -16,7 +16,7 @@
 
       </td>
       <td width="40%" class="center">
-      	<span class="top"><a href="section_8bfecf9836e3fd00fd91909d3b01db8f.html">Internal Fluid Flow</a></span>
+      	<span class="top"><a href="section_1a5d32a5774a02b036ca9077794f67ce.html">Internal Fluid Flow</a></span>
 
       </td>
       <td width="30%" class="next">
@@ -29,23 +29,23 @@
 
 
 
-    <span class="path" dir="ltr"><a href="index.html">Internal Fluid Flow</a> &gt;&gt; <a href="section_8bfecf9836e3fd00fd91909d3b01db8f.html">Internal Fluid Flow</a> &gt; epsfD2Re</span>
+    <span class="path" dir="ltr"><a href="index.html">Internal Fluid Flow</a> &gt;&gt; <a href="section_1a5d32a5774a02b036ca9077794f67ce.html">Internal Fluid Flow</a> &gt; epsfD2Re</span>
 
     <br /><br />
     <div class="refnamediv"><h1 class="refname">epsfD2Re</h1>
     <p class="refpurpose">Computes the Reynolds number given the Darcy friction factor and the relative roughness</p></div>
 
 
 <div class="refsynopsisdiv"><h3 class="title">Syntax</h3>
-   <div class="synopsis"><pre><span class="default">[</span><span class="default">Re</span><span class="default">]=</span><span class="functionid">epsfD2Re</span><span class="default">(</span><span class="default">fD</span><span class="default">[,</span><span class="default">eps</span><span class="default">[,</span><span class="default">s</span><span class="default">]])</span></pre></div></div>
+   <div class="synopsis"><pre><span class="default">[</span><span class="default">Re</span><span class="default">]=</span><span class="functionid">epsfD2Re</span><span class="default">(</span><span class="default">fD</span><span class="default">[,</span><span class="default">eps</span><span class="default">[,</span><span class="default">fig</span><span class="default">]])</span></pre></div></div>
 
 <div class="refsection"><h3 class="title">Parameters</h3>
    <dl><dt><span class="term">fD:</span>
             <dd><p class="para">Darcy friction factor</p></dd></dt>
         <dt><span class="term">eps:</span>
             <dd><p class="para">optional, relative roughness (default is eps=2e-3)</p></dd></dt>
-        <dt><span class="term">s:</span>
-            <dd><p class="para">optional, boolean for display plot (default is s=%f)</p></dd></dt>
+        <dt><span class="term">fig:</span>
+            <dd><p class="para">optional, boolean for display plot (default is fig=%f)</p></dd></dt>
         <dt><span class="term">Re:</span>
             <dd><p class="para">Reynolds number</p></dd></dt></dl></div>
 
@@ -129,7 +129,7 @@
 
       </td>
       <td width="40%" class="center">
-      	<span class="top"><a href="section_8bfecf9836e3fd00fd91909d3b01db8f.html">Internal Fluid Flow</a></span>
+      	<span class="top"><a href="section_1a5d32a5774a02b036ca9077794f67ce.html">Internal Fluid Flow</a></span>
 
       </td>
       <td width="30%" class="next">
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		��j��Cߤ��I�Q��`:��1�񆊅̀
		��o�R��P��C��zdƵ�