Skip to content
Snippets Groups Projects
Commit c554b9c8 authored by Uwe Bau's avatar Uwe Bau
Browse files

Merge branch '#1_Documentation' into 'develop'

#1 documentation

See merge request ltt_public/SorpLib!1
parents cfe1f7e2 d086a7f7
Branches
No related tags found
2 merge requests!2Develop,!1#1 documentation
Showing
with 50 additions and 51 deletions
......@@ -3,27 +3,27 @@
SorpLib - Adsorption Energy Systems Library
=====================================
**SorpLib - Adsorption Energy Systems Library** (short **SorpLib**) is a Modelica model library for simulating adsorption energy systems, such as adsorption chillers, adsorption heat pumps, adsorption thermal sorage systems, or desiccant systems. The library is being developed at RWTH Aachen University, Chair of Technical Thermodynamics, Sorption Systems Engineering group in Aachen, Germany.
**SorpLib - Adsorption Energy Systems Library** (short **SorpLib**) is a Modelica model library for simulating adsorption energy systems, such as adsorption chillers, adsorption heat pumps, adsorption thermal storage systems, or desiccant systems. The library is being developed at RWTH Aachen University, Institute of Technical Thermodynamics, Sorption Systems Engineering group in Aachen, Germany.
This repository is used to further develop the library and make it available under the BSD 3-Clause License.
We would like to build up an active **SorpLib** comunity. Therefore, we would appreciate a short notice to sorplib@ltt.rwth-aachen.de, when you download and use the **SorpLib**.
We would like to build up an active **SorpLib** community. Therefore, we would appreciate a short notice to sorplib@ltt.rwth-aachen.de, when you download and use the **SorpLib**.
### License
The model library **SorpLib** is released by RWTH Aachen University, Chair of Technical Thermodynamics under the [BSD 3-Clause License](https://git.rwth-aachen.de/ltt_group/LTT_SorptionEnergySystems_library/blob/develop/LICENSE.md).
The model library **SorpLib** is released by RWTH Aachen University, Institute of Technical Thermodynamics under the [BSD 3-Clause License](https://git.rwth-aachen.de/ltt_public/SorpLib/Sysblob/develop/LICENSE.md).
### Overview
The library provides basic models necessary to model adsorption energy systems. Based on these models, all types of adsorption energy systems can be modeled. In the applications package, a few examples demonstrate possible adsorption-based systems.
### Dependancies
### Dependencies
Regarding non-adsorption specific models, the library partly depends on the [TIL Suite](https://www.tlk-thermo.com/index.php/de/softwareprodukte/til-suite) and the [TIL Media Suite](https://www.tlk-thermo.com/index.php/de/softwareprodukte/tilmedia-suite):
*TIL Suite is suitable for the stationary and transient simulation of freely configurable thermodynamic systems. Thanks to the substance property library, TILMedia – a component of the TIL Suite – system simulations can be performed extremely quickly and accurately.*
TIL Suite and TILMedia Suite are commercial libraries provided by [TLK-Thermo GmbH](https://www.tlk-thermo.com/index.php/en/). At the moment, it is necessary to have these library to use the **SorpLib**. For the future, a light version of TIL and TIL-Media may be freely available.
TIL and TILMedia are commercial libraries provided by [TLK-Thermo GmbH](https://www.tlk-thermo.com/index.php/en/). At the moment, it is necessary to have these libraries to use the **SorpLib**. For the future, a light version of TIL and TIL-Media may be freely available.
### Version
......@@ -41,9 +41,9 @@ Please cite **SorpLib** as follows:
### How to contribute to the Development of SorpLib
You are invited to activly contribute to the development of **SorpLib**.
Issues can be reported using this site's [Issues section](https://git.rwth-aachen.de/ltt_group/LTT_SorptionEnergySystems_library/issues).
Furthermore, you are welcome to contribute via [Merge Requests](https://git.rwth-aachen.de/ltt_group/LTT_SorptionEnergySystems_library/merge_requests).
The workflow for changes is described in our [Wiki](https://git.rwth-aachen.de/ltt_group/LTT_SorptionEnergySystems_library/wikis/home).
Issues can be reported using this site's [Issues section](https://git.rwth-aachen.de/ltt_public/SorpLib/issues).
Furthermore, you are welcome to contribute via [Merge Requests](https://git.rwth-aachen.de/ltt_public/SorpLib/merge_requests).
The workflow for changes is described in our [Wiki](https://git.rwth-aachen.de/ltt_public/SorpLib/wikis/home).
### Contact
......
......@@ -24,7 +24,6 @@ model DesiccantSystem
Components.OpenAdsorber.HeatAndMassTransfer.TransportPhenomena.HeatTransfer.PackedBedGas_Kast1988,
redeclare model MassTransfer_diffusion_dp =
Components.OpenAdsorber.HeatAndMassTransfer.TransportPhenomena.MassTransfer.PackedBedGas_Kast1988,
generateEventsAtFlowReversal=false,
TInitialGas=303.15,
pInitial=100000,
......
within SorpLib.Components.Cells.Gas.PressureDropCorrelations;
within SorpLib.Components.Cells.Gas.PressureDropCorrelations;
model ConstantResistanceCoefficient
"Pressure drop correlation with constant resistance coefficient"
extends Partial.PartialPressureDrop(
......@@ -17,7 +17,7 @@ equation
pressureDrop=(cellGeometry.length/cellGeometry.hydraulicDiameter)/(2*properties.d*cellGeometry.flowCrossSection^2)*f*TIL.Utilities.Numerics.squareFunction(mdotHydraulic);
annotation (Documentation(info="<html>
<p>
This model calculates the pressure drop with a constant resistance coefficient according to the VDI Wrmeatlas (2013). The sign of the pressure drop is automatically determined by the sign of the hydraulic mass flow rate. The hydraulic mass flow rate is defined as outer variable and thus taken from the overlying model level. The fluid properties record is also defined as outer object and taken from the overlying model level.
This model calculates the pressure drop with a constant resistance coefficient according to the VDI Wärmeatlas (2013). The sign of the pressure drop is automatically determined by the sign of the hydraulic mass flow rate. The hydraulic mass flow rate is defined as outer variable and thus taken from the overlying model level. The fluid properties record is also defined as outer object and taken from the overlying model level.
</p>
<h4>Main equations</h4>
<p>
......@@ -27,7 +27,7 @@ equation
<h4>References</h4>
<ul>
<li>VDI e.V., VDI Wrmeatlas 11., bearbeitete und erweiterte Auflage, Chapter L1, Darmstadt: Springer Berlin Heidelberg, 2011. </li>
<li>VDI e.V., VDI Wärmeatlas 11., bearbeitete und erweiterte Auflage, Chapter L1, Darmstadt: Springer Berlin Heidelberg, 2011. </li>
</ul>
<h4>Author Information</h4>
......
within SorpLib.Components.Cells.VLEPhaseSeparator;
within SorpLib.Components.Cells.VLEPhaseSeparator;
model VLEPhaseSeparator
/*********************** SIM ***********************************/
......@@ -116,7 +116,7 @@ public
rotation=0)));
equation
//assert(T > 273.15, "Evaporator temperature must be above 0 C"); Assert operator may be added for simulations with water
//assert(T > 273.15, "Evaporator temperature must be above 0 °C"); Assert operator may be added for simulations with water
// simport setup
connect(sim.fluidPort[vleFluidType.ID], simPort.vleFluidPort);
......@@ -198,7 +198,7 @@ equation
<p>The partial derivative <i>du/d<code>&rho;</code></i> can be expressed as:</p>
<p align=\"center\"><i>du/d<code>&rho;</code></i> = 1/<i><code>&rho;</code></i><sup>2</sup> <i>( -p + T dpdT )</i> </p>
<p>where <i>dpdT</i> can be substituted with the equation of Clausius-Clayperon: <i>dpdT = (h<sup>v</sup> - h<sup>l</sup>) / (T (v<sup>v</sup> - v<sup>l</sup>)</i>. <br>
For more information see Grber (2011) and Tummescheit (2002). <br></p>
For more information see Gräber (2011) and Tummescheit (2002). <br></p>
The VLE phase seperator has two VLE ports, a liquid and a vapour VLE port. At the liquid VLE port, the specific enthalpy of the leaving fluid is slightly subccoled, at the vapour VLE port, the specific enthalpy of the leaving fluid is slightly superheated.
</p>
<h4>Assumptions and limitations</h4>
......@@ -221,7 +221,7 @@ equation
<p>
<ul>
<li>Tummescheit, H. Design and Implementation of Object-Oriented Model Libraries using Modelica. PhD Thesis. Lund, 2002.</li>
<li>Grber, M.; Kirches, C.; Bock, H.G.; Schlder, J.P.; Tegethoff, W.; Khler, J. Determining the optimum cyclic operation of adsorption chillers by a direct method for periodic optimal control. Int. J. Refrig., 2011, 34(4), 902-913.</li>
<li>Gräber, M.; Kirches, C.; Bock, H.G.; Schlöder, J.P.; Tegethoff, W.; Köhler, J. Determining the optimum cyclic operation of adsorption chillers by a direct method for periodic optimal control. Int. J. Refrig., 2011, 34(4), 902-913.</li>
</ul>
</p>
<h4>Author Information</h4>
......
......@@ -27,7 +27,6 @@ model TestAdsorber1
redeclare record TubeGeometry = Geometry.Adsorber_Finned_Tubes_Alu,
redeclare model HeatTransferModel_HX =
RecordsTransportCoefficients.HeatTransfer.HeatTransferSilicaGel_Lanzerath2015,
TInitial=303.15,
hx_TInitialCell1=293.15,
hx_TInitialCelln=293.15,
......
......@@ -29,7 +29,6 @@ model TestAdsorber2
HeatTransfer.HeatTransferPhenomena.ConstantAlphaA (constantAlphaA=50),
redeclare model HeatTransferModel_HX =
SorpLib.Components.ClosedAdsorber.RecordsTransportCoefficients.HeatTransfer.HeatTransferSilicaGel_Lanzerath2015,
TInitial=576.3,
hx_TInitialCell1=566.3,
hx_TInitialCelln=566.3,
......
within SorpLib.Components.EvpCond.Geometry;
within SorpLib.Components.EvpCond.Geometry;
record CondLanzerath2014
"Condenser used in dissertation of Lanzerath (2014 & 2015)"
extends TubeGeometry(
......@@ -18,7 +18,7 @@ record CondLanzerath2014
<h4>References</h4>
<p>
<ul>
<li>Lanzerath, F. Modellgesttzte Entwicklung von Adsorptionswrmepumpen (in German). Aachen: Mainz, 2014. Aachener Beitrge zur Technischen Thermodynamik. 3. ISBN 9783861304722.</li>
<li>Lanzerath, F. Modellgestützte Entwicklung von Adsorptionswärmepumpen (in German). Aachen: Mainz, 2014. Aachener Beiträge zur Technischen Thermodynamik. 3. ISBN 9783861304722.</li>
<li>Lanzerath, F.; Bau, U.; Seiler, J.; Bardow, A. Optimal design of adsorption chillers based on a validated dynamic object-oriented model. Science and Technology for the Built Environment, 2015, 21(3), 248-257.</li>
</ul>
</p>
......
within SorpLib.Components.EvpCond.Geometry;
within SorpLib.Components.EvpCond.Geometry;
record EvpLanzerath2014
"Evaporator used in dissertation of Lanzerath (2014 & 2015)"
extends TubeGeometry(
......@@ -18,7 +18,7 @@ record EvpLanzerath2014
<h4>References</h4>
<p>
<ul>
<li>Lanzerath, F. Modellgesttzte Entwicklung von Adsorptionswrmepumpen (in German). Aachen: Mainz, 2014. Aachener Beitrge zur Technischen Thermodynamik. 3. ISBN 9783861304722.</li>
<li>Lanzerath, F. Modellgestützte Entwicklung von Adsorptionswärmepumpen (in German). Aachen: Mainz, 2014. Aachener Beiträge zur Technischen Thermodynamik. 3. ISBN 9783861304722.</li>
<li>Lanzerath, F.; Bau, U.; Seiler, J.; Bardow, A. Optimal design of adsorption chillers based on a validated dynamic object-oriented model. Science and Technology for the Built Environment, 2015, 21(3), 248-257.</li>
</ul>
</p>
......
within SorpLib.Components.HeatExchanger.HXAirAirParallelflow.PressureDropCorrelations;
within SorpLib.Components.HeatExchanger.HXAirAirParallelflow.PressureDropCorrelations;
model VDIWaermeatlasN6
"Pressure drop correlation for plate heat exchangers (phi = 0) according to VDI Wrmeatlas (N6)"
"Pressure drop correlation for plate heat exchangers (phi = 0) according to VDI Wärmeatlas (N6)"
extends
SorpLib.Components.Cells.Gas.PressureDropCorrelations.Partial.PartialPressureDrop(
final computeTransportProperties=true);
......@@ -44,7 +44,7 @@ equation
pressureDrop=(cellGeometry.length/cellGeometry.hydraulicDiameter)/(2*properties.d*cellGeometry.flowCrossSection^2)*zeta*TIL.Utilities.Numerics.squareFunction(mdotHydraulic);
annotation (Documentation(info="<html>
<p>
This model calculates the pressure drop according to the VDI Wrmeatlas N6 (2011): pressure drop in plate heat exchangers. The model describes the special case for plates which have no angle (<code>&phi;</code>=0).<br>
This model calculates the pressure drop according to the VDI Wärmeatlas N6 (2011): pressure drop in plate heat exchangers. The model describes the special case for plates which have no angle (<code>&phi;</code>=0).<br>
The hydraulic mass flow rate, the fluid properties record, and the geometry are defined as outer objects and thus taken from the overlying model level.
</p>
<h4>Main equations</h4>
......@@ -60,7 +60,7 @@ for Reynolds numbers Re <code>&gt;</code> 2300.
</p>
<h4>References</h4>
<ul>
<li>VDI e.V., VDI Wrmeatlas 11., bearbeitete und erweiterte Auflage, Chapter N6, Darmstadt: Springer Berlin Heidelberg, 2011. </li>
<li>VDI e.V., VDI Wärmeatlas 11., bearbeitete und erweiterte Auflage, Chapter N6, Darmstadt: Springer Berlin Heidelberg, 2011. </li>
</ul>
<h4>Author Information</h4>
<p>
......
within SorpLib.Components.MassTransfer;
within SorpLib.Components.MassTransfer;
model MassTransferDiffusion
extends Partial.PartialMassTransfer(final computeTransportProperties=massTransfer_diffusion_dp.computeTransportProperties or massTransfer_diffusion_dx.computeTransportProperties);
......@@ -53,10 +53,10 @@ model MassTransferDiffusion
choice(redeclare model MassTransfer_diffusion_dx =
SorpLib.Components.MassTransfer.MassTransferPhenomena.ConstantSpecificCoefficient_dx),
choice(redeclare model MassTransfer_diffusion_dx =
SorpLib.Components.MassTransfer.MassTransferPhenomena.Glueckauf_dx "Glckauf-approach dx"),
SorpLib.Components.MassTransfer.MassTransferPhenomena.Glueckauf_dx "Glückauf-approach dx"),
choice(redeclare model MassTransfer_diffusion_dx =
SorpLib.Components.MassTransfer.MassTransferPhenomena.GlueckaufArrhenius_dx
"Glckauf-approach with temperature dependance dx"),
"Glückauf-approach with temperature dependance dx"),
choice(redeclare model MassTransfer_diffusion_dx =
SorpLib.Components.MassTransfer.Record.DiffusionCoefficients.Lanzerath2015_Zeolite13X_des
"Diffusion coefficient and particle diameter for Zeolith 13X desorption (Lanzerath 2015)"),
......
within SorpLib.Components.MassTransfer;
within SorpLib.Components.MassTransfer;
model MassTransferDiffusionFlow
extends Partial.PartialMassTransfer(final computeTransportProperties=
massTransfer_diffusion_dp.computeTransportProperties or
......@@ -87,10 +87,10 @@ model MassTransferDiffusionFlow
SorpLib.Components.MassTransfer.MassTransferPhenomena.ConstantSpecificCoefficient_dx),
choice(redeclare model MassTransfer_diffusion_dx =
SorpLib.Components.MassTransfer.MassTransferPhenomena.Glueckauf_dx
"Glckauf-approach dx"),
"Glückauf-approach dx"),
choice(redeclare model MassTransfer_diffusion_dx =
SorpLib.Components.MassTransfer.MassTransferPhenomena.GlueckaufArrhenius_dx
"Glckauf-approach with temperature dependance dx"),
"Glückauf-approach with temperature dependance dx"),
choice(redeclare model MassTransfer_diffusion_dx =
SorpLib.Components.MassTransfer.Record.DiffusionCoefficients.Lanzerath2015_Zeolite13X_des
"Diffusion coefficient and particle diameter for Zeolith 13X desorption (Lanzerath 2015)"),
......
within SorpLib.Components.MassTransfer.MassTransferPhenomena;
model GlueckaufArrhenius_dx "Glückauf-approach with temperature dependance dx"
within SorpLib.Components.MassTransfer.MassTransferPhenomena;
model GlueckaufArrhenius_dx "Glückauf-approach with temperature dependance dx"
extends
SorpLib.Components.MassTransfer.MassTransferPhenomena.Partial.PartialMassTransfer_dx(
final computeTransportProperties=false);
......
within SorpLib.Components.MassTransfer.MassTransferPhenomena;
model Glueckauf_dx "Glückauf-approach dx"
within SorpLib.Components.MassTransfer.MassTransferPhenomena;
model Glueckauf_dx "Glückauf-approach dx"
extends
SorpLib.Components.MassTransfer.MassTransferPhenomena.Partial.PartialMassTransfer_dx(
final computeTransportProperties=false);
......
within SorpLib.Components.MassTransfer.MassTransferPhenomena;
within SorpLib.Components.MassTransfer.MassTransferPhenomena;
model Laminar_dp
extends
SorpLib.Components.MassTransfer.MassTransferPhenomena.Partial.PartialMassTransfer_dp(
......@@ -18,7 +18,7 @@ equation
*1/zeta_lam;
annotation (Documentation(info="<html>
<p>
This laminar transfer model calculates the mass flow based on the pressure differnce according to the VDI Wärmeatlas (2013).
This laminar transfer model calculates the mass flow based on the pressure differnce according to the VDI Wärmeatlas (2013).
</p>
<h4>Main equations</h4>
<p>
......@@ -34,7 +34,7 @@ equation
</p>
<h4>References</h4>
<ul>
<li>VDI e.V., VDI Wärmeatlas 11., bearbeitete und erweiterte Auflage, Chapter L1, Darmstadt: Springer Berlin Heidelberg, 2011. </li>
<li>VDI e.V., VDI Wärmeatlas 11., bearbeitete und erweiterte Auflage, Chapter L1, Darmstadt: Springer Berlin Heidelberg, 2011. </li>
<li>Lanzerath, F.; Bau, U.; Seiler, J.; Bardow, A. Optimal design of adsorption chillers based on a validated dynamic object-oriented model. Science and Technology for the Built Environment, 2015, 21(3), 248-257. </li>
</ul>
<h4>Author Information</h4>
......
within SorpLib.Internals.AdditionalTransferPhenomena.HeatTransfer_insideTube;
within SorpLib.Internals.AdditionalTransferPhenomena.HeatTransfer_insideTube;
model Schmidt "Schmidt-Korrelation"
extends
TIL.LiquidComponents.Tubes.TransportPhenomena.HeatTransfer.PartialHeatTransfer(
......@@ -38,7 +38,7 @@ equation
</p>
<h4>References</h4>
<ul>
<li>Schmidt E. F. Wrmebergang und Druckverlust in Rohrschlangen. Chemie Ingenieur Technik, 1967.</li>
<li>Schmidt E. F. Wärmeübergang und Druckverlust in Rohrschlangen. Chemie Ingenieur Technik, 1967.</li>
</ul>
<h4>Author Information</h4>
<p>
......
within SorpLib.Media.Functions;
within SorpLib.Media.Functions;
function CharCurve2Polynomial
input Modelica.SIunits.SpecificEnergy A "Adsorption Potential";
input Real c_u[:] "Coefficients for nominator (see Info)";
......@@ -43,7 +43,7 @@ algorithm
<h4>References</h4>
<p>This type of characteristic curve is used in the following publications: </p>
<ul>
<li>Núñez, T. Charakterisierung und Bewertung von Adsorbentien für Wärmetransformationsanwendungen. PhD Thesis. Freiburg, 2001. </li>
<li>Núñez, T. Charakterisierung und Bewertung von Adsorbentien für Wärmetransformationsanwendungen. PhD Thesis. Freiburg, 2001. </li>
</ul>
<h4>Author Information</h4>
<ul>
......
within SorpLib.Media.Functions;
within SorpLib.Media.Functions;
function CharCurve2Polynomial_dWdA
input Modelica.SIunits.SpecificEnergy A "Adsorption Potential";
input Real c_u[:] "Coefficients for nominator (see Info)";
......@@ -61,7 +61,7 @@ algorithm
<h4>References</h4>
<p>This type of characteristic curve is used in the following publications: </p>
<ul>
<li>Núñez, T. Charakterisierung und Bewertung von Adsorbentien für Wärmetransformationsanwendungen. PhD Thesis. Freiburg, 2001. </li>
<li>Núñez, T. Charakterisierung und Bewertung von Adsorbentien für Wärmetransformationsanwendungen. PhD Thesis. Freiburg, 2001. </li>
</ul>
<h4>Author Information</h4>
<ul>
......
......@@ -4,16 +4,18 @@ extends Modelica.Icons.Information;
annotation (DocumentationClass=true, Documentation(info="<html>
<p>
<b>SorpLib - Adsorption Energy Systems Library</b> (short <b>SorpLib</b>) is a Modelica model library for simulating adsorption energy systems, such as adsorption chillers, adsorption heat pumps, adsorption thermal sorage systems, or desiccant systems. The library is being developed at RWTH Aachen University, Chair of Technical Thermodynamics, Sorption Systems Engineering group in Aachen, Germany.
<b>SorpLib - Adsorption Energy Systems Library</b> (short <b>SorpLib</b>) is a Modelica model library for simulating adsorption energy systems, such as adsorption chillers, adsorption heat pumps, adsorption thermal sorage systems, or desiccant systems. The library is being developed at RWTH Aachen University, Institute of Technical Thermodynamics, Sorption Systems Engineering group in Aachen, Germany.
</p>
<h3>Dependencies</h3>
Regarding non-adsorption specific models, the library partly depends on the libraries TIL and TILMedia:
<ul>
<li>TIL: Model library for thermal components and systems</li>
<li>TILMedia: Model library providing thermophysical properties</li>
<li>TIL: Component library for thermal systems</li>
<li>TILMedia: Thermophysical media properties</li>
</ul>
<p>TIL and TILMedia are commercial libraries provided by TLK-Thermo GmbH.
To use all functions of SorpLib, either the commercial versions of TIL and TILMedia or free versions of both libraries (TIL Excerpt S and Clara) can be used.</p>
<p> TIL and TILMedia are commercial libraries provided by <a href='https://www.tlk-thermo.com/index.php/en/'> TLK-Thermo GmbH</a>.
At the moment, it is necessary to have these libraries to use the **SorpLib**. For the future, a light version of TIL and TIL-Media may be freely available.
</p>
</html>"));
end UsersGuide;
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment