Documentation and description for FluidHeatFlow library improved (mod…

…elica#4141) * Improved doc strings and documentation * Improved documentation Updated * Update ParallelCooling * Lower case spelling of coolant * Corrected misspelling of coolant in documentation of IndirectCooling.mo Corrected misspelling of coolant in two instances of documentation --------- Co-authored-by: Christian Kral <dr.christian.kral@gmail.com> Co-authored-by: arunkumar-narasimhan <124154466+arunkumar-narasimhan@users.noreply.github.com>
henrikt-ma · Jun 15, 2023 · 4b0dbf6 · 4b0dbf6
1 parent 336acd6
commit 4b0dbf6
Show file tree

Hide file tree

Showing 8 changed files with 42 additions and 42 deletions.
diff --git a/Modelica/Thermal/FluidHeatFlow/Examples/IndirectCooling.mo b/Modelica/Thermal/FluidHeatFlow/Examples/IndirectCooling.mo
@@ -8,13 +8,13 @@ model IndirectCooling "Indirect cooling circuit"
   parameter SI.Temperature TAmb(displayUnit="degC")=293.15
     "Ambient temperature";
   output SI.TemperatureDifference dTSource=
-    prescribedHeatFlow.port.T-TAmb "Source over Ambient";
+    prescribedHeatFlow.port.T-TAmb "Temperature difference between heat source and ambient condition";
   output SI.TemperatureDifference dTtoPipe=prescribedHeatFlow.port.T-pipe1.T_q
-    "Source over inner Coolant";
+    "Temperature difference between heat source and coolant in pipe 1";
   output SI.TemperatureDifference dTinnerCoolant=pipe1.dT
     "Inner Coolant's temperature increase";
   output SI.TemperatureDifference dTCooler=innerPipe.T_q-outerPipe.T_q
-    "Cooler's temperature increase between inner and outer pipes";
+    "Coolant temperature difference between inner pipe and outer pipe";
   output SI.TemperatureDifference dTouterCoolant=outerPipe.dT
     "Outer coolant's temperature increase";
   FluidHeatFlow.Sources.Ambient ambient1(
@@ -173,31 +173,31 @@ Inner coolant's temperature rise near the source is the same as temperature drop
 </tr>
 <tr>
 <td>dTSource</td>
-<td>Source over Ambient</td>
+<td>Temperature difference between heat source and ambient condition</td>
 <td>dtouterCoolant + dtCooler + dTinnerCoolant + dtToPipe</td>
 <td>40 K</td>
 </tr>
 <tr>
 <td>dTtoPipe</td>
-<td>Source over inner Coolant</td>
+<td>Temperature difference between heat source and coolant in pipe 1</td>
 <td>Losses / ThermalConductor.G</td>
 <td>10 K</td>
 </tr>
 <tr>
-<td>dTinnerColant</td>
-<td>inner Coolant's temperature increase</td>
+<td>dTinnerCoolant</td>
+<td>Inner Coolant's temperature increase</td>
 <td>Losses * cp * innerMassFlow</td>
 <td>10 K</td>
 </tr>
 <tr>
 <td>dTCooler</td>
-<td>Cooler's temperature rise between inner and outer pipes</td>
+<td>Coolant temperature difference between inner pipe and outer pipe</td>
 <td>Losses * (innerGc + outerGc)</td>
 <td>10 K</td>
 </tr>
 <tr>
-<td>dTouterColant</td>
-<td>outer Coolant's temperature increase</td>
+<td>dTouterCoolant</td>
+<td>Outer coolant's temperature increase</td>
 <td>Losses * cp * outerMassFlow</td>
 <td>10 K</td>
 </tr>

diff --git a/Modelica/Thermal/FluidHeatFlow/Examples/OneMass.mo b/Modelica/Thermal/FluidHeatFlow/Examples/OneMass.mo
@@ -8,9 +8,9 @@ model OneMass "Cooling of one hot mass"
   parameter SI.Temperature TMass(displayUnit="degC")=313.15
     "Initial temperature of mass";
   output SI.TemperatureDifference dTMass=
-    heatCapacitor.port.T-TAmb "Mass over Ambient";
+    heatCapacitor.port.T-TAmb "Temperature difference between mass and ambient condition";
   output SI.TemperatureDifference dTtoPipe=heatCapacitor.port.T-pipe.T_q
-    "Mass over Coolant";
+    "Temperature difference between mass and coolant";
   output SI.TemperatureDifference dTCoolant=pipe.dT
     "Coolant's temperature increase";
   FluidHeatFlow.Sources.Ambient ambient1(

diff --git a/Modelica/Thermal/FluidHeatFlow/Examples/ParallelCooling.mo b/Modelica/Thermal/FluidHeatFlow/Examples/ParallelCooling.mo
@@ -7,17 +7,17 @@ model ParallelCooling "Cooling circuit with parallel branches"
   parameter SI.Temperature TAmb(displayUnit="degC")=293.15
     "Ambient temperature";
   output SI.TemperatureDifference dTSource1=
-    prescribedHeatFlow1.port.T-TAmb "Source1 over Ambient";
+    prescribedHeatFlow1.port.T-TAmb "Temperature difference between heat source 1 and ambient condition";
   output SI.TemperatureDifference dTtoPipe1=prescribedHeatFlow1.port.T-pipe1.T_q
-    "Source1 over Coolant1";
+    "Temperature difference between heat source 1 and coolant in pipe 1";                      
   output SI.TemperatureDifference dTCoolant1=pipe1.dT
-    "Coolant1's temperature increase";
+    "Coolant1's temperature increase in pipe 1";
   output SI.TemperatureDifference dTSource2=
-    prescribedHeatFlow2.port.T-TAmb "Source2 over Ambient";
+    prescribedHeatFlow2.port.T-TAmb "Temperature difference between Heat source 2 and ambient condition";
   output SI.TemperatureDifference dTtoPipe2=prescribedHeatFlow2.port.T-pipe2.T_q
-    "Source2 over Coolant2";
+    "Temperature difference between heat source 2 and coolant in pipe 2";
   output SI.TemperatureDifference dTCoolant2=pipe2.dT
-    "Coolant2's temperature increase";
+    "Coolant2's temperature increase in pipe 2";
   output SI.TemperatureDifference dTmixedCoolant=ambient2.T_port-ambient1.T_port
     "Mixed Coolant's temperature increase";
   FluidHeatFlow.Sources.Ambient ambient1(
@@ -169,43 +169,43 @@ Two prescribed heat sources dissipate their heat through thermal conductors to c
 </tr>
 <tr>
 <td>dTSource1</td>
-<td>Source1 over Ambient</td>
+<td>Temperature difference between heat source 1 and ambient condition</td>
 <td>dTCoolant1 + dTtoPipe1</td>
 <td>15 K</td>
 </tr>
 <tr>
 <td>dTtoPipe1</td>
-<td>Source1 over Coolant1</td>
+<td>Temperature difference between heat source 1 and coolant in pipe 1</td>
 <td>Losses1 / ThermalConductor1.G</td>
 <td> 5 K</td>
 </tr>
 <tr>
 <td>dTCoolant1</td>
-<td>Coolant's temperature increase</td>
+<td>Coolant1's temperature increase in pipe 1</td>
 <td>Losses * cp * totalMassFlow/2</td>
 <td>10 K</td>
 </tr>
 <tr>
 <td>dTSource2</td>
-<td>Source2 over Ambient</td>
+<td>Temperature difference between heat source 2 and ambient condition</td>
 <td>dTCoolant2 + dTtoPipe2</td>
 <td>30 K</td>
 </tr>
 <tr>
 <td>dTtoPipe2</td>
-<td>Source2 over Coolant2</td>
+<td>Temperature difference between heat source 2 and coolant in pipe 2</td>
 <td>Losses2 / ThermalConductor2.G</td>
 <td>10 K</td>
 </tr>
 <tr>
 <td>dTCoolant2</td>
-<td>Coolant's temperature increase</td>
+<td>Coolant2's temperature increase in pipe 2</td>
 <td>Losses * cp * totalMassFlow/2</td>
 <td>20 K</td>
 </tr>
 <tr>
 <td>dTmixedCoolant</td>
-<td>mixed Coolant's temperature increase</td>
+<td>Mixed coolant's temperature increase</td>
 <td>(dTCoolant1+dTCoolant2)/2</td>
 <td>15 K</td>
 </tr>

diff --git a/Modelica/Thermal/FluidHeatFlow/Examples/ParallelPumpDropOut.mo b/Modelica/Thermal/FluidHeatFlow/Examples/ParallelPumpDropOut.mo
@@ -7,19 +7,19 @@ model ParallelPumpDropOut
   parameter SI.Temperature TAmb(displayUnit="degC")=293.15
     "Ambient temperature";
   output SI.TemperatureDifference dTSource1=
-    prescribedHeatFlow1.port.T-TAmb "Source1 over Ambient";
+    prescribedHeatFlow1.port.T-TAmb "Temperature difference between heat source 1 and ambient condition";
   output SI.TemperatureDifference dTtoPipe1=prescribedHeatFlow1.port.T-pipe1.T_q
-    "Source1 over Coolant1";
+    "Temperature difference between heat source 1 and coolant in pipe 1";
   output SI.TemperatureDifference dTCoolant1=pipe1.dT
     "Coolant1's temperature increase";
   output SI.TemperatureDifference dTSource2=
-    prescribedHeatFlow2.port.T-TAmb "Source2 over Ambient";
+    prescribedHeatFlow2.port.T-TAmb "Temperature difference between heat source 2 and ambient condition";
   output SI.TemperatureDifference dTtoPipe2=prescribedHeatFlow2.port.T-pipe2.T_q
-    "Source2 over Coolant2";
+    "Temperature difference between heat source 2 and coolant in pipe 2";
   output SI.TemperatureDifference dTCoolant2=pipe2.dT
     "Coolant2's temperature increase";
   output SI.TemperatureDifference dTmixedCoolant=ambient2.T_port-ambient1.T_port
-    "Mixed Coolant's temperature increase";
+    "Overall change in coolant temperature";
   FluidHeatFlow.Sources.Ambient ambient1(
     constantAmbientTemperature=TAmb,
     medium=medium,

diff --git a/Modelica/Thermal/FluidHeatFlow/Examples/PumpAndValve.mo b/Modelica/Thermal/FluidHeatFlow/Examples/PumpAndValve.mo
@@ -8,7 +8,7 @@ model PumpAndValve "Cooling circuit with pump and valve"
   output SI.TemperatureDifference dTSource=
     prescribedHeatFlow.port.T-TAmb "Source over Ambient";
   output SI.TemperatureDifference dTtoPipe=prescribedHeatFlow.port.T-pipe.T_q
-    "Source over Coolant";
+    "Temperature difference between heat source and ambient condition";
   output SI.TemperatureDifference dTCoolant=pipe.dT
     "Coolant's temperature increase";
   FluidHeatFlow.Sources.Ambient ambient1(

diff --git a/Modelica/Thermal/FluidHeatFlow/Examples/PumpDropOut.mo b/Modelica/Thermal/FluidHeatFlow/Examples/PumpDropOut.mo
@@ -6,9 +6,9 @@ model PumpDropOut "Cooling circuit with drop out of pump"
   parameter SI.Temperature TAmb(displayUnit="degC")=293.15
     "Ambient temperature";
   output SI.TemperatureDifference dTSource=
-    prescribedHeatFlow.port.T-TAmb "Source over Ambient";
+    prescribedHeatFlow.port.T-TAmb "Temperature difference between heat source and ambient condition";
   output SI.TemperatureDifference dTtoPipe=prescribedHeatFlow.port.T-pipe.T_q
-    "Source over Coolant";
+    "Temperature difference between heat source and coolant";
   output SI.TemperatureDifference dTCoolant=pipe.dT
     "Coolant's temperature increase";
   FluidHeatFlow.Sources.Ambient ambient1(

diff --git a/Modelica/Thermal/FluidHeatFlow/Examples/SimpleCooling.mo b/Modelica/Thermal/FluidHeatFlow/Examples/SimpleCooling.mo
@@ -7,9 +7,9 @@ model SimpleCooling "Simple cooling circuit"
   parameter SI.Temperature TAmb(displayUnit="degC")=293.15
     "Ambient temperature";
   output SI.TemperatureDifference dTSource=
-    prescribedHeatFlow.port.T-TAmb "Source over Ambient";
+    prescribedHeatFlow.port.T-TAmb "Temperature difference between heat source and ambient condition";
   output SI.TemperatureDifference dTtoPipe=prescribedHeatFlow.port.T-pipe.T_q
-    "Source over Coolant";
+    "Temperature difference between heat source and coolant";
   output SI.TemperatureDifference dTCoolant=pipe.dT
     "Coolant's temperature increase";
   FluidHeatFlow.Sources.Ambient ambient1(
@@ -95,13 +95,13 @@ A prescribed heat source dissipates its heat through a thermal conductor to a co
 </tr>
 <tr>
 <td>dTSource</td>
-<td>Source over Ambient</td>
+<td>Temperature difference between heat source and ambient condition</td>
 <td>dtCoolant + dtToPipe</td>
 <td>20 K</td>
 </tr>
 <tr>
 <td>dTtoPipe</td>
-<td>Source over Coolant</td>
+<td>Temperature difference between heat source and coolant</td>
 <td>Losses / ThermalConductor.G</td>
 <td>10 K</td>
 </tr>

diff --git a/Modelica/Thermal/FluidHeatFlow/Examples/TwoMass.mo b/Modelica/Thermal/FluidHeatFlow/Examples/TwoMass.mo
@@ -10,15 +10,15 @@ model TwoMass "Cooling of two hot masses"
   parameter SI.Temperature TMass2(displayUnit="degC")=333.15
     "Initial temperature of mass2";
   output SI.TemperatureDifference dTMass1=
-    heatCapacitor1.port.T-TAmb "Mass1 over Ambient";
+    heatCapacitor1.port.T-TAmb "Temperature difference between mass 1 and ambient condition";
   output SI.TemperatureDifference dTtoPipe1=heatCapacitor1.port.T-pipe1.T_q
-    "Mass1 over Coolant1";
+    "Temperature difference between mass 1 and coolant in pipe 1";
   output SI.TemperatureDifference dTCoolant1=pipe1.dT
-    "Coolant1's temperature increase";
+    "Change in coolant temperature in pipe 1";
   output SI.TemperatureDifference dTMass2=
-    heatCapacitor2.port.T-TAmb "Mass2 over Ambient";
+    heatCapacitor2.port.T-TAmb "Temperature difference between mass 2 and ambient condition";
   output SI.TemperatureDifference dTtoPipe2=heatCapacitor2.port.T-pipe2.T_q
-    "Mass2 over Coolant2";
+    "Temperature difference between mass 2 and coolant in pipe 2";
   output SI.TemperatureDifference dTCoolant2=pipe2.dT
     "Coolant2's temperature increase";
   output SI.TemperatureDifference dTmixedCoolant=ambient2.T_port-ambient1.T_port