Skip to content

Commit 93f02e6

Browse files
nayakpriyamnayakpriyam
committed
Added documentation for Chemsep Database
1 parent a8957fa commit 93f02e6

File tree

2 files changed

+67
-11
lines changed

2 files changed

+67
-11
lines changed

‎Simulator/Files/ChemsepDatabase/GeneralProperties.mo‎

Lines changed: 57 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
within Simulator.Files.ChemsepDatabase;
22

3-
model GeneralProperties "Model to declare the variables for thermophysical properties of the compounds in the database"
3+
model GeneralProperties "Model to declare the variables for thermophysical properties"
44
extends Modelica.Icons.Record;
55
parameter Integer SN "Serial Number";
66
parameter String name "Compound Name";
@@ -26,17 +26,64 @@ model GeneralProperties "Model to declare the variables for thermophysical prope
2626
parameter Real HOC (unit="J/kmol") "Heat of Combustion";
2727
parameter Real UniquacR (unit="-") "UNIQUAC r";
2828
parameter Real UniquacQ (unit="-") "UNIQUAC q";
29-
parameter Real LiqDen[6] (unit="kmol/m3") "Liquid Density Coefficients";
30-
parameter Real VP[6] (unit="Pa") "Vapor Pressure Coefficients";
31-
parameter Real LiqCp[6] (unit="J/kmol/K") "Liquid Heat Capacity Coefficients";
32-
parameter Real HOV[6] (unit="J/kmol") "Heat of Vaporization Coefficients";
33-
parameter Real VapCp[6] (unit="J/kmol/K") "Ideal Gas Heat Capacity Coefficients";
34-
parameter Real LiqVis[6] (unit="Pa s") "Liquid Viscosity Coefficients";
35-
parameter Real VapVis[6] (unit="Pa s") "Vapor Viscosity Coefficients";
36-
parameter Real LiqK[6] (unit="W/m/K") "Liquid Thermal Conductivity Coefficients";
37-
parameter Real VapK[6] (unit="W/m/K") "Vapor Thermal Conductivity Coefficients";
29+
parameter Real LiqDen[6] (each unit="kmol/m3") "Liquid Density Coefficients";
30+
parameter Real VP[6] (each unit="Pa") "Vapor Pressure Coefficients";
31+
parameter Real LiqCp[6] (each unit="J/kmol/K") "Liquid Heat Capacity Coefficients";
32+
parameter Real HOV[6] (each unit="J/kmol") "Heat of Vaporization Coefficients";
33+
parameter Real VapCp[6] (each unit="J/kmol/K") "Ideal Gas Heat Capacity Coefficients";
34+
parameter Real LiqVis[6] (each unit="Pa s") "Liquid Viscosity Coefficients";
35+
parameter Real VapVis[6] (each unit="Pa s") "Vapor Viscosity Coefficients";
36+
parameter Real LiqK[6] (each unit="W/m/K") "Liquid Thermal Conductivity Coefficients";
37+
parameter Real VapK[6] (each unit="W/m/K") "Vapor Thermal Conductivity Coefficients";
3838
parameter Real Racketparam (unit="-") "Racket Parameter";
3939
parameter Real ChaoSeadAF (unit="-") "Chao-Seader Accentric Factor";
4040
parameter Real ChaoSeadSP (unit="J0.5/m1.5") "Shao-Seader Solubility Parameter";
4141
parameter Real ChaoSeadLV (unit="m3/kmol") "Chao-Seader Liquid Volume";
42+
annotation(
43+
Documentation(info = "<html><head></head><body><div>This model is to define/declare the variables for all the thermopysical properties that are available for the components in Chemsep Database.</div><div><br></div>In this model, variables for the following properties are defined:<div><br><table border=\"1\" cellspacing=\"0\" cellpadding=\"2\"><caption align=\"bottom\"><br></caption><caption align=\"bottom\"><br></caption><tbody><tr><th>Variables</th><th>Description</th><th>Units</th></tr><tr><td>SN</td><td>Serial Number</td><td>Not Applicable</td></tr><tr><td>name</td><td>Name of the Compound</td><td>Not Applicable</td></tr><tr><td>CAS</td><td>CAS ID</td><td>Not Applicable</td></tr><tr><td>Tc</td><td>Critical Temperature</td><td>K </td></tr><tr><td>Pc</td><td>Critical Pressure</td><td>Pa</td></tr><tr><td>Vc</td><td>Critical Volume</td><td>m3/kmol</td></tr><tr><td>Cc</td><td>Critial Compressibility Factor</td><td>No Units</td></tr><tr><td>Tb</td><td>Boiling Point Temperature</td><td>K </td></tr><tr><td>Tm</td><td>Melting Point Temperature</td><td>K </td></tr><tr><td>TT</td><td>Triple Point Temperature</td><td>K </td></tr><tr><td>TP</td><td>Triple Point Pressure</td><td>Pa</td></tr><tr><td>MW</td><td>Molecular Weight</td><td>kg/kmol</td></tr><tr><td>LVB</td><td>Liquid Molar Volume at Normal Boiling Point</td><td>m3/kmol</td></tr><tr><td>AF</td><td>Accentric Factor</td><td>No Units</td></tr><tr><td>SP</td><td>Solubility Parameter</td><td>J0.5/m1.5</td></tr><tr><td>DM</td><td>Dipole Moment</td><td>Coulumb.m</td></tr><tr><td>SH</td><td>Absolute Enthalpy</td><td>J/kmol</td></tr><tr><td>IGHF</td><td>Standard Heat of Formation</td><td>J/kmol</td></tr><tr><td>GEF</td><td>Gibbs Energy of Formation</td><td>J/kmol</td></tr><tr><td>AS</td><td>Absolute Entropy</td><td>J/[kmol.K]</td></tr><tr><td>HFMP</td><td>Heat of Fusion at Melting Point</td><td>J/kmol</td></tr><tr><td>HOC</td><td>Heat of Combustion</td><td>J/kmol</td></tr><tr><td>UniquacR</td><td>UNIQUAC R</td><td>No Units</td></tr><tr><td>UniquacQ</td><td>UNIQUAC Q</td><td>No Units</td></tr><tr><td>Racketparam</td><td>Racket parameter</td><td>No Units</td></tr><tr><td>ChaoSeadAF</td><td>Chao-Seader Accentric Factor</td><td>No Units</td></tr><tr><td>ChaoSeadSP</td><td>Chao-Seader Solubility Parameter</td><td>J0.5/m1.5</td></tr><tr><td>ChaoSeadLV</td><td>Chao-Seader Liquid Volume</td><td>m3/kmol</td></tr></tbody></table>Aditionally, array variables for the following temperature dependent properties are also defined.</div><div><br><table border=\"1\" cellspacing=\"0\" cellpadding=\"2\">
44+
<tbody>
45+
<tr><th>Variables</th><th>Description</th><th>Units</th></tr>
46+
<tr><td>LiqDen[6]<span class=\"Apple-tab-span\" style=\"white-space:pre\"> </span>&nbsp;</td>
47+
<td>Liquid Density Coefficients &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp;&nbsp;</td>
48+
<td>kmol/m3 &nbsp; &nbsp; &nbsp; &nbsp;</td>
49+
</tr>
50+
<tr>
51+
<td>VP[6]</td>
52+
<td>Vapor Pressure Coefficients</td>
53+
<td>Pa</td>
54+
</tr>
55+
<tr>
56+
<td>LiqCp[6]</td>
57+
<td>Liquid Heat Capacity Coefficients</td>
58+
<td>J/[kmol.K]</td>
59+
</tr> <tr>
60+
<td>HOV[6]</td>
61+
<td>Heat of Vaporization Coefficients</td>
62+
<td>J/kmol</td>
63+
</tr>
64+
<tr>
65+
<td>VapCp[6]</td>
66+
<td>Ideal Gas Heat Capacity Coefficients</td>
67+
<td>J/[kmol.K]</td>
68+
</tr> <tr>
69+
<td>LiqVis[6]</td>
70+
<td>Liquid Viscosity Coefficients</td>
71+
<td>Pa s</td>
72+
</tr>
73+
<tr>
74+
<td>VapVis[6]</td>
75+
<td>Vapor Viscosity Coefficients</td>
76+
<td>Pa s</td>
77+
</tr>
78+
<tr>
79+
<td>LiqK[6]</td>
80+
<td>Liquid Thermal Conductivity Coefficients</td>
81+
<td>W/[m.K]</td>
82+
</tr>
83+
<tr>
84+
<td>VapK[6]</td>
85+
<td>Vapor Thermal Conductivity Coefficients</td>
86+
<td>W/[m.K]</td></tr></tbody></table><br></div><div>
87+
88+
The first indice of the array refers to the equation number from the Chemsep Database which will be used to calculate the property value as function of temperature. Remaining indices are the actual coefficients that are used in the equation to calculate the property.</div></body></html>"));
4289
end GeneralProperties;

‎Simulator/Files/ChemsepDatabase/package.mo‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
within Simulator.Files;
22

3-
package ChemsepDatabase
3+
package ChemsepDatabase "Library of components from Chemsep Database"
44
extends Modelica.Icons.RecordsPackage;
5+
6+
7+
annotation(
8+
Documentation(info = "<html><head></head><body><p style=\"font-size: 12px;\">This library hosts all the components of Chemsep Database along with their thermophysical properties to be used directly in Modelica language. Following thermophysical properties are available for the components listed under this database:</p><p></p><ul><li>Serial Number</li><li>Compound Name</li><li>CAS Number</li><li>Critical Temperature</li><li>Critical Pressure</li><li>Critical Volume</li><li>Critical Compressibility Factor</li><li>Boiling Point Temperature</li><li>Melting Point Temperature</li><li>Triple Point Temperature</li><li>Triple Point Pressure</li><li>Molecular Weight</li><li>Liquid Molar Volume at Normal Boiling Point</li><li>Acentric Factor</li><li>Solubility Parameter</li><li>Dipole Moment</li><li>Absolute Enthalpy</li><li>Standard Heat of Formation</li><li>Gibbs Energy of Formation</li><li>Absolute Entropy</li><li>Heat of Fusion at Melting Point</li><li>Heat of Combustion</li><li>UNIQUAC r</li><li>UNIQUAC q</li><li>Coefficients to calculate Liquid Density</li><li>Coefficients to calculate Vapor Pressure</li><li>Coefficients to calculate Liquid Heat Capacity</li><li>Coefficients to calculate Heat of Vaporization</li><li>Coefficients to calculate Ideal Gas Heat Capacity</li><li>Coefficients to calculate Liquid Viscosity</li><li>Coefficients to calculate Vapor Viscosity Coefficients</li><li>Coefficients to calculate Liquid Thermal Conductivity</li><li>Coefficient to calculate Vapor Thermal Conductivity</li><li>Racket Parameter</li><li>Chao-Seader Accentric Factor</li><li>Chao-Seader Solubility Parameter</li><li>Chao-Seader Liquid Volume</li></ul><div><br></div><div>All the above properties are defined/declared as parameters in the <a href=\"modelica://Simulator.Files.ChemsepDatabase.GeneralProperties\">GeneralProperties</a> model.&nbsp;</div><div>Every component is a separate model where the <a href=\"modelica://Simulator.Files.ChemsepDatabase.GeneralProperties\">GeneralProperties</a> model is then extended and then the values are passed for the declared parameter variables.</div><div><br></div><div>For example, the model
9+
<pre><strong>model</strong> Air
10+
...
11+
<strong>extends</strong> GeneralProperties(SN = 1, name = \"Air\", CAS = \"132259-10-0\", Tc = 132.45,...\");
12+
<strong>end</strong> Air;
13+
</pre></div><div><br></div></body></html>"));
514

615
end ChemsepDatabase;

0 commit comments

Comments
 (0)