Merge branch 'master' of https://github.com/casella/ThermoPower

Author: Giovanni Mangola

ThermoPower/Gas.mo

@@ -1184,7 +1184,9 @@ package Gas "Models of components with ideal gases as working fluid"
         p = pstart;
       end if;
       Ttilde = Tstart[2:N];
-      Xtilde = ones(size(Xtilde, 1), size(Xtilde, 2))*diagonal(Xstart[1:nX]);
+      if (not Medium.fixedX) then
+        Xtilde = ones(size(Xtilde, 1), size(Xtilde, 2))*diagonal(Xstart[1:nX]);
+      end if;
     elseif initOpt == Choices.Init.Options.steadyState then
       if (not Medium.singleState) and not noInitialPressure then
         der(p) = 0;
@@ -1259,7 +1261,7 @@ package Gas "Models of components with ideal gases as working fluid"
     replaceable model HeatTransfer2 = Thermal.HeatTransferFV.IdealHeatTransfer
       constrainedby ThermoPower.Thermal.BaseClasses.DistributedHeatTransferFV
       annotation (choicesAllMatching=true);
-    HeatTransfer heatTransfer2(
+    HeatTransfer2 heatTransfer2(
       redeclare package Medium = Medium,
       final Nf=N,
       final Nw=Nw,
@@ -2741,6 +2743,85 @@ The packages Medium are redeclared and a mass balance determines the composition
 </html>"));
   end FanMech;
 
+  package Utility "Utility models"
+
+    model ClosedSystemInit
+      "Component for the steady-state initialization of closed systems"
+      replaceable package Medium = Modelica.Media.Interfaces.PartialMedium
+        "Medium model"
+        annotation(choicesAllMatching = true);
+      parameter Medium.AbsolutePressure pstart "Start value of pressure";
+      parameter Boolean initEquationFromInput = false
+        "Get initial condition residual from input connector"
+        annotation(Dialog(group="External inputs"), choices(checkBox=true));
+      parameter Boolean useHomotopy
+        "Use homotopy for residual-based initialization";
+      final parameter Medium.MassFlowRate w_b(fixed = false, start = 0)
+        "Initial balance flow rate eventually equal to zero";
+      outer ThermoPower.System system "System wide properties";
+
+      FlangeB flange(redeclare package Medium = Medium, m_flow(min = 0))
+         annotation (Placement(transformation(extent={{-20,-100},{20,-60}},
+                               rotation=0),
+                               iconTransformation(extent={{-20,-100},{20,-60}})));
+      Modelica.Blocks.Interfaces.RealInput initEquationResidual if initEquationFromInput
+        "Residual of initial equation" annotation (Placement(transformation(extent={
+                {-60,0},{-20,40}}), iconTransformation(extent={{-60,-10},{-40,10}})));
+    protected
+      Modelica.Blocks.Interfaces.RealInput initEquationResidual_int
+        "Hidden internal connector for conditional connection";
+    equation
+      0 = flange.m_flow + w_b "Mass balance";
+      flange.h_outflow = Medium.h_default
+        "Unused value as there is no flow out of the flange";
+      flange.Xi_outflow = Medium.X_default[1:Medium.nXi]
+        "Unused value as there is no flow out of the flange";
+
+      connect(initEquationResidual, initEquationResidual_int)
+        "Connects conditional input to hidden connector";
+
+      if not initEquationFromInput then
+        initEquationResidual_int = 0 "Not used";
+      end if;
+
+    initial equation
+      if initEquationFromInput then
+        if useHomotopy then
+          homotopy(initEquationResidual_int, (flange.p - pstart)/pstart) = 0
+            "Set initial value of residual to zero, simplified equation sets start value of pressure";
+        else
+          initEquationResidual_int = 0 "Set initial value of residual to zero";
+        end if;
+      else
+        flange.p = pstart "Set initial value of pressure";
+      end if;
+
+      annotation (Icon(coordinateSystem(preserveAspectRatio=false), graphics={
+            Line(
+              points={{0,0},{0,-60}},
+              color={159,159,223},
+              thickness=0.5),
+            Ellipse(
+              extent={{-40,40},{40,-40}},
+              lineColor={159,159,223},
+              fillColor={159,159,223},
+              fillPattern=FillPattern.Solid),
+            Text(
+              extent={{-32,24},{30,-24}},
+              lineColor={255,255,255},
+              lineThickness=0.5,
+              fillColor={0,0,255},
+              fillPattern=FillPattern.Solid,
+              textString="Init")}),                                  Diagram(
+            coordinateSystem(preserveAspectRatio=false)),
+        Documentation(info="<html>
+<p>This component can be used for the steady-state initialization of closed-system where all components have steady-state initial conditions. Without this component such systems would give rise to undetermined initial conditions, i.e., the amount of fluid and the initial pressures in the system would be unspecified.</p>
+<p>Connect the component to one point of the system. If <code>initEquationFromInput = false</code>, the system is initialized with pressure equal to <code>pstart</code> at the connection point.</p>
+<p>It is possible to use a generic initial equation instead of <code>p = pstart</code>, e.g., to set the initial charge of a refrigeration circuit, by setting <code>initEquationFromInput = true</code> and connecting to the input the output of a <a href=\"Modelica://Modelica.Blocks.Sources.RealExpression\">Modelica.Blocks.Sources.RealExpression</a> component, containing the residual of the initial equation. In this case, if <code>useHomotopy = true</code>, the simplified initial equation is <code>(p - pstart)/pstart = 0</code>. To ensure a smooth homotopy transformation, it is recommended to write the residual in normalized form, i.e., with values have the order of magnitude of one, as for the simplified equation.</p>
+</html>"));
+    end ClosedSystemInit;
+  end Utility;
+
   package BaseClasses
     extends Modelica.Icons.BasesPackage;
     partial model Flow1DBase

ThermoPower/Thermal.mo

@@ -783,7 +783,17 @@ package Thermal "Thermal models of heat transfer"
     end for;
     annotation (
       Icon(coordinateSystem(preserveAspectRatio=false, extent={{-100,-100},{100,100}}),
-           graphics));
+           graphics={Polygon(
+            points={{-72,0},{-72,-16},{-50,-8},{-72,0}},
+            lineColor={0,0,0},
+            lineThickness=0.5,
+            fillColor={0,0,0},
+            fillPattern=FillPattern.Solid), Polygon(
+            points={{72,0},{52,8},{72,16},{72,0}},
+            lineColor={0,0,0},
+            lineThickness=0.5,
+            fillColor={0,0,0},
+            fillPattern=FillPattern.Solid)}));
   end HeatExchangerTopologyFV;
 
   model CounterCurrentFV
@@ -880,7 +890,7 @@ The swapping is performed if the counterCurrent parameter is true (default value
     DHTVolumes side2(final N=Nv) annotation (Placement(transformation(extent={{-40,-42},{40,-20}},
             rotation=0)));
   equation
-    side1.Q = G*(side1.T - side2.T) "Convective heat transfer";
+    side1.Q = G*(side1.T - side2.T)/Nv "Convective heat transfer";
     side1.Q + side2.Q = zeros(Nv) "Static energy balance";
     annotation (Icon(graphics={Text(
             extent={{-100,-44},{100,-68}},

ThermoPower/Water.mo

@@ -1373,7 +1373,7 @@ outlet is ignored; use <t>Pump</t> models if this has to be taken into account c
     end if;
     annotation (
       Diagram(graphics),
-      Icon(graphics={Text(extent={{-100,-40},{100,-80}}, textString="%name")}),
+      Icon(graphics={Text(extent={{-100,-60},{100,-100}},textString="%name")}),
       Documentation(info="<HTML>
 <p>This model describes the flow of water or steam in a rigid tube. The basic modelling assumptions are:
 <ul><li>The fluid state is always one-phase (i.e. subcooled liquid or superheated steam).
@@ -1462,7 +1462,7 @@ outlet is ignored; use <t>Pump</t> models if this has to be taken into account c
     connect(wall2,heatTransfer2.wall);
     annotation (Diagram(coordinateSystem(preserveAspectRatio=false, extent={{-100,
               -100},{100,100}}), graphics), Icon(coordinateSystem(
-            preserveAspectRatio=false, extent={{-100,-100},{100,100}}), graphics));
+            preserveAspectRatio=false, extent={{-100,-100},{100,100}})));
   end Flow1DFV2w;
 
   model Flow1DFV2ph
@@ -1785,7 +1785,7 @@ outlet is ignored; use <t>Pump</t> models if this has to be taken into account c
 
     annotation (
       Diagram(graphics),
-      Icon(graphics={Text(extent={{-100,-40},{100,-80}}, textString="%name")}),
+      Icon(graphics={Text(extent={{-100,-60},{100,-100}},textString="%name")}),
       Documentation(info="<HTML>
 <p>This model describes the flow of water or steam in a rigid tube. The basic modelling assumptions are:
 <ul><li>The fluid state is either one-phase, or a two-phase mixture.
@@ -2288,7 +2288,7 @@ enthalpy between the nodes; this requires the availability of the time derivativ
     end if;
     annotation (
       Diagram(graphics),
-      Icon(graphics={Text(extent={{-100,-40},{100,-80}}, textString="%name")}),
+      Icon(graphics={Text(extent={{-100,-60},{100,-100}},textString="%name")}),
       Documentation(info="<HTML>
 <p>This model describes the flow of water or steam in a rigid tube. The basic modelling assumptions are:
 <ul><li>The fluid state is always one-phase (i.e. subcooled liquid or superheated steam).

ThermoPower/package.mo

@@ -2026,7 +2026,7 @@ annotation (
 <p><ul>
 <li>F. Casella, F. Schiavo, &QUOT;Modelling and Simulation of Heat Exchangers in Modelica with Finite Element Methods&QUOT;, <i>Proceedings of the 2003 Modelica Conference</i>, Link&ouml;ping, Sweden, 2003, pp. 343-352. (<a href=\"http://www.modelica.org/Conference2003/papers/h22_Schiavo.pdf\">Available online</a>) </li>
 <li>A. Cammi, M.E. Ricotti, F. Casella, F. Schiavo, &QUOT;New modelling strategy for IRIS dynamic response simulation&QUOT;, <i>Proc. 5th International Conference on Nuclear Option in Countries with Small and Medium Electricity Grids</i>, Dubrovnik, Croatia, May 2004.</li>
-<li>A. Cammi, F. Casella, M.E. Ricotti, F. Schiavo, &QUOT;Object-oriented Modelling for Integral Nuclear Reactors Dynamic Dimulation&QUOT;, <i>Proceedings of the International Conference on Integrated Modeling &AMP; Analysis in Applied Control &AMP; Automation</i>, Genova, Italy, October 2004. </li>
+<li>A. Cammi, F. Casella, M.E. Ricotti, F. Schiavo, &QUOT;Object-oriented Modelling for Integral Nuclear Reactors Dynamic Simulation&QUOT;, <i>Proceedings of the International Conference on Integrated Modeling &AMP; Analysis in Applied Control &AMP; Automation</i>, Genova, Italy, October 2004. </li>
 <li>Antonio Cammi, Francesco Casella, Marco Ricotti and Francesco Schiavo, &ldquo;Object-Oriented Modeling, Simulation and Control of the IRIS Nuclear Power Plant with Modelica&rdquo;. In <i>Proceedings 4th International Modelica Conference</i>, Hamburg, Germany,Mar. 7-8, 2005, pp. 423-432. <a href=\"http://www.modelica.org/events/Conference2005/online_proceedings/Session5/Session5b3.pdf\">Online</a>. </li>
 <li>A. Cammi, F. Casella, M. E. Ricotti, F. Schiavo, G. D. Storrick, &QUOT;Object-oriented Simulation for the Control of the IRIS Nuclear Power Plant&QUOT;, <i>Proceedings of the IFAC World Congress, </i>Prague, Czech Republic, July 2005 </li>
 <li>Francesco Casella and Francesco Pretolani, &ldquo;Fast Start-up of a Combined-Cycle Power Plant: a Simulation Study with Modelica&rdquo;. In <i>Proceedings 5th International Modelica Conference</i>, Vienna, Austria, Sep. 6-8, 2006, pp. 3-10. <a href=\"http://www.modelica.org/events/modelica2006/Proceedings/sessions/Session1a1.pdf\">Online</a>. </li>
@@ -2049,9 +2049,9 @@ annotation (
 This is a major new release, that has been in the making for 5 years. The new release is not compatible with 2.1. However, models built using the development version of the library after 2011 should compile with little or no adjustments. It has many new features:
 <ul>
   <li>Use of Modelica 3.2 revision 2 and Modelica Standard Library 3.2.1, ensuring full compatibility with all compliant Modelica tools</li>
-  <li>Tested with Dymola and OpenModelica./li>
+  <li>Tested with Dymola and OpenModelica.</li>
   <li>Use of stream connectors, compatible with the Modelica.Fluid library, allowing multiple-way connections (see <a href=\"http://dx.doi.org/10.3384/ecp09430078\">paper</a>).</li>
-  <li>Use of the homotopy operator for improved convegence of steady-state initialization problems(see <a href=\"https://www.modelica.org/events/modelica2011/Proceedings/pages/papers/04_2_ID_131_a_fv.pdf\">paper</a>).</li>
+  <li>Use of the homotopy operator for improved convergence of steady-state initialization problems(see <a href=\"https://www.modelica.org/events/modelica2011/Proceedings/pages/papers/04_2_ID_131_a_fv.pdf\">paper</a>).</li>
   <li>Improved Flow1D models with embedded replaceable heat transfer models, allowing a much easier customization of heat transfer correlations</li>
   <li>Many bug fixes</li>
 </ul></p>
@@ -2105,6 +2105,6 @@ This is a major new release, that has been in the making for 5 years. The new re
 <p>The ThermoPower package is licensed by Politecnico di Milano under the <b><a href=\"http://www.modelica.org/licenses/ModelicaLicense2\">Modelica License 2</a></b>. </p>
 <p><h4>Copyright &copy; 2002-2014, Politecnico di Milano.</h4></p>
 </html>"),
-  uses(Modelica(version="3.2.2")),
+  uses(Modelica(version="3.2.3")),
   version="3.1");
 end ThermoPower;

docs/index.html

@@ -93,7 +93,7 @@ <h2>References</h2>
 <p></p><ul>
 <li>F. Casella, F. Schiavo, "Modelling and Simulation of Heat Exchangers in Modelica with Finite Element Methods", <i>Proceedings of the 2003 Modelica Conference</i>, Linköping, Sweden, 2003, pp. 343-352. (<a href="http://www.modelica.org/Conference2003/papers/h22_Schiavo.pdf">Available online</a>) </li>
 <li>A. Cammi, M.E. Ricotti, F. Casella, F. Schiavo, "New modelling strategy for IRIS dynamic response simulation", <i>Proc. 5th International Conference on Nuclear Option in Countries with Small and Medium Electricity Grids</i>, Dubrovnik, Croatia, May 2004.</li>
-<li>A. Cammi, F. Casella, M.E. Ricotti, F. Schiavo, "Object-oriented Modelling for Integral Nuclear Reactors Dynamic Dimulation", <i>Proceedings of the International Conference on Integrated Modeling &amp; Analysis in Applied Control &amp; Automation</i>, Genova, Italy, October 2004. </li>
+<li>A. Cammi, F. Casella, M.E. Ricotti, F. Schiavo, "Object-oriented Modelling for Integral Nuclear Reactors Dynamic Simulation", <i>Proceedings of the International Conference on Integrated Modeling &amp; Analysis in Applied Control &amp; Automation</i>, Genova, Italy, October 2004. </li>
 <li>Antonio Cammi, Francesco Casella, Marco Ricotti and Francesco 
 Schiavo, “Object-Oriented Modeling, Simulation and Control of the IRIS 
 Nuclear Power Plant with Modelica”. In <i>Proceedings 4th International Modelica Conference</i>, Hamburg, Germany,Mar. 7-8, 2005, pp. 423-432. <a href="http://www.modelica.org/events/Conference2005/online_proceedings/Session5/Session5b3.pdf">Online</a>. </li>
@@ -138,11 +138,11 @@ <h2>Release notes:</h2>
 the development version of the library after 2011 should compile with 
 little or no adjustments. It has many new features:
 </p><ul>
-  <li>Use of Modelica 3.2.1 revision 2 and Modelica Standard Libary 
+  <li>Use of Modelica 3.2.1 revision 2 and Modelica Standard Library 
 3.2.1, ensuring full compatibility with all compliant Modelica tools</li>
-  <li>Tested with Dymola and OpenModelica./li&gt;
-  </li><li>Use of stream connectors, compatible with the Modelica.Fluid library, allowing multiple-way connections (see <a href="http://dx.doi.org/10.3384/ecp09430078">paper</a>).</li>
-  <li>Use of the homotopy operator for improved convegence of steady-state initialization problems(see <a href="https://www.modelica.org/events/modelica2011/Proceedings/pages/papers/04_2_ID_131_a_fv.pdf">paper</a>).</li>
+  <li>Tested with Dymola and OpenModelica.</li>
+  <li>Use of stream connectors, compatible with the Modelica.Fluid library, allowing multiple-way connections (see <a href="http://dx.doi.org/10.3384/ecp09430078">paper</a>).</li>
+  <li>Use of the homotopy operator for improved convergence of steady-state initialization problems(see <a href="https://www.modelica.org/events/modelica2011/Proceedings/pages/papers/04_2_ID_131_a_fv.pdf">paper</a>).</li>
   <li>Improved Flow1D models with embedded replaceable heat transfer 
 models, allowing a much easier customization of heat transfer 
 correlations</li>