Changeset 588

Show
Ignore:
Timestamp:
08/21/2007 12:13:51 PM (17 months ago)
Author:
AHaumer
Message:

improved documentation

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • Modelica/trunk/Modelica/Thermal/FluidHeatFlow.mo

    r585 r588  
    44  extends Modelica.Icons.Library2; 
    55  annotation ( 
    6     version="1.6.2", versionDate="2007-08-20", 
     6    version="1.6.3", versionDate="2007-08-21", 
    77    preferedView="info",Documentation(info="<HTML> 
    8 <p> 
    98This package contains very simple-to-use components to model coolant flows as needed to simulate cooling e.g. of electric machines: 
    109<ul> 
    … …  
    1716<li>Sources: various flow sources</li> 
    1817</ul> 
    19 </p> 
    20 <p> 
    2118<b>Variables used in connectors:</b> 
    2219<ul> 
    … …  
    2623<li>flow EnthalpyFlowRate H_flow</li> 
    2724</ul> 
    28 EnthalpyFlowRate means the Enthalpy = cp<sub>constant</sub> * m * T that is carried by the medium's flow. 
    29 </p> 
    30 <p> 
     25EnthalpyFlowRate means the Enthalpy = cp<sub>constant</sub> * m * T that is carried by the medium's flow.<br><br> 
    3126<b>Limitations and assumptions:</b> 
    3227<ul> 
    … …  
    4338Outlet temperature is defined by variable T of the corresponding component.</li> 
    4439</ul> 
    45 </p> 
    46 <p> 
    4740<b>Further development:</b> 
    4841<ul> 
    4942<li>Additional components like tanks (if needed)</li> 
    5043</ul> 
    51 </p> 
    52 <p> 
    5344<dl> 
    5445  <dt><b>Main Authors:</b></dt> 
    … …  
    6859  </p> 
    6960  </dd> 
    70 </dl> 
    71 </p> 
    7261</dl> 
    7362<p> 
    … …  
    115104  <li> v1.6.2 2007/08/20 Anton Haumer<br> 
    116105       improved documentation</li> 
     106  <li> v1.6.3 2007/08/21 Anton Haumer<br> 
     107       improved documentation</li> 
    117108  </ul> 
    118109</HTML> 
    … …  
    142133    extends Modelica.Icons.Library2; 
    143134  annotation (Documentation(info="<HTML> 
    144 <p> 
    145135This package contains test examples: 
    146136<ul> 
    … …  
    154144<li>8.TwoMass: cooling of two masses (thermal capacities) by two parallel coolant flows</li> 
    155145</ul> 
    156 </p> 
    157  
    158 </HTML>", revisions="<HTML> 
    159 <p> 
    160146<dl> 
    161147  <dt><b>Main Authors:</b></dt> 
    … …  
    176162  </dd> 
    177163</dl> 
    178 </p> 
    179 </dl> 
    180164<p> 
    181165Copyright &copy; 1998-2007, Modelica Association, Anton Haumer and arsenal research. 
    … …  
    187171<a href=\"Modelica://Modelica.UsersGuide.ModelicaLicense\">here</a>.</i> 
    188172</p> 
    189  
     173</HTML>", revisions="<HTML> 
    190174  <ul> 
    191175  <li> v1.00 2005/02/01 Anton Haumer<br> 
    … …  
    2162001st test example: SimpleCooling 
    217201</p> 
    218 <p> 
    219202A prescribed heat source dissipates its heat through a thermal conductor to a coolant flow. The coolant flow is taken from an ambient and driven by a pump with prescribed mass flow.<br> 
    220203<b>Results</b>:<br> 
    … …  
    245228</tr> 
    246229</table> 
    247 </p> 
    248230</HTML>"), Diagram, 
    249231        experiment(StopTime=1.0), 
    … …  
    3193012nd test example: ParallelCooling 
    320302</p> 
    321 <p> 
    322303Two prescribed heat sources dissipate their heat through thermal conductors to coolant flows. The coolant flow is taken from an ambient and driven by a pump with prescribed mass flow, then splitted into two coolant flows connected to the two heat sources, and afterwards merged. Splitting of coolant flows is determined by pressure drop characteristic of the two pipes.<br> 
    323304<b>Results</b>:<br> 
    … …  
    372353</tr> 
    373354</table> 
    374 </p> 
    375355</HTML>"), Diagram, 
    376356        experiment(StopTime=1.0), 
    … …  
    4894693rd test example: IndirectCooling 
    490470</p> 
    491 <p> 
    492471A prescribed heat sources dissipates its heat through a thermal conductor to the inner coolant cycle. It is necessary to define the pressure level of the inner coolant cycle. The inner coolant cycle is coupled to the outer coolant flow through a thermal conductor.<br> 
    493472Inner coolant's temperature rise near the source is the same as temperature drop near the cooler.<br> 
    … …  
    531510</tr> 
    532511</table> 
    533 </p> 
    534512</HTML>"), Diagram, 
    535513        experiment(StopTime=1.5), 
    … …  
    6596374th test example: PumpAndValve 
    660638</p> 
    661 <p> 
    662639The pump is running with half speed for 0.4 s,  
    663640afterwards with full speed (using a ramp of 0.1 s).<br>  
    664 The valve is half open for 0.9 s, afterwards full open (using a ramp of 0.1 s). 
    665 </p> 
    666 <p> 
    667 You may try to<br> 
     641The valve is half open for 0.9 s, afterwards full open (using a ramp of 0.1 s).<br> 
     642You may try to: 
    668643<ul> 
    669644<li>drive the pump with variable speed and let the valve full open  
    … …  
    672647    to regulate the volume flow rate of coolant</li> 
    673648</ul> 
    674 </p> 
    675649</HTML>"), Diagram, 
    676650        experiment(StopTime=2), 
    … …  
    7697435th test example: PumpDropOut 
    770744</p> 
    771 <p> 
    772745Same as 1st test example, but with a drop out of the pump:<br> 
    773746The pump is running for 0.2 s, then shut down (using a ramp of 0.2 s) for 0.2 s,  
    774747then started again (using a ramp of 0.2 s). 
    775 </p> 
    776748</HTML>"), Diagram, 
    777749        experiment(StopTime=2), 
    … …  
    8518236th test example: ParallelPumpDropOut 
    852824</p> 
    853 <p> 
    854825Same as 2nd test example, but with a drop out of the pump:<br> 
    855826The pump is running for 0.2 s, then shut down (using a ramp of 0.2 s) for 0.2 s,  
    856827then started again (using a ramp of 0.2 s). 
    857 </p> 
    858828</HTML>"), Diagram, 
    859829        experiment(StopTime=2, Algorithm="Lsodar"), 
    … …  
    9729427th test example: OneMass 
    973943</p> 
    974 <p> 
    975944A thermal capacity is coupled with a coolant flow.  
    976945Different inital temperatures of thermal capacity and pipe's coolant get ambient's temperature,  
    977946the time behaviour depending on coolant flow. 
    978 </p> 
    979947</HTML>"), Diagram, 
    980948        experiment(StopTime=1.0), 
    … …  
    104010088th test example: TwoMass 
    10411009</p> 
    1042 <p> 
    10431010Two thermal capacities are coupled with two parallel coolant flow.  
    10441011Different inital temperatures of thermal capacities and pipe's coolants get ambient's temperature,  
    10451012the time behaviour depending on coolant flow. 
    1046 </p> 
    10471013</HTML>"), Diagram, 
    10481014        experiment(StopTime=1.0), 
    … …  
    11431109      extends Modelica.Icons.Library; 
    11441110      annotation (Documentation(info="<html> 
    1145 <p> 
    1146 This package contains utility components used for the test examples. 
    1147 <p> 
    1148  
    1149 </html>", revisions="<HTML> 
     1111This package contains utility components used for the test examples.<br> 
    11501112<dl> 
    11511113  <dt><b>Main Authors:</b></dt> 
    … …  
    11661128  </dd> 
    11671129</dl> 
    1168 </p> 
    1169 </dl> 
    11701130<p> 
    11711131Copyright &copy; 1998-2007, Modelica Association, Anton Haumer and arsenal research. 
    … …  
    11771137<a href=\"Modelica://Modelica.UsersGuide.ModelicaLicense\">here</a>.</i> 
    11781138</p> 
    1179  
     1139</HTML>", revisions="<HTML> 
    11801140  <ul> 
    11811141  <li> v1.41 Beta 2005/06/17 Anton Haumer<br> 
    … …  
    12021162        annotation ( 
    12031163          Documentation(info="<HTML> 
    1204 <p> 
    12051164Block generating the sum of two ramps. 
    1206 </p> 
    12071165</HTML>"),Diagram, 
    12081166          Icon( 
    … …  
    12481206    extends Modelica.Icons.Library2; 
    12491207  annotation (Documentation(info="<HTML> 
    1250 <p> 
    12511208This package contains components: 
    1252 </p> 
    1253  
    12541209<ul> 
    12551210<li>pipe without heat exchange</li> 
    … …  
    12571212<li>valve (simple controlled valve)</li> 
    12581213</ul> 
    1259  
    1260 <p> 
    12611214Pressure drop is taken from partial model SimpleFriction.<br> 
    1262 Thermodynamic equations are defined in partial models (package Partials). 
    1263 </p> 
    1264  
    1265 </HTML>", revisions="<HTML> 
     1215Thermodynamic equations are defined in partial models (package Partials).<br> 
    12661216<dl> 
    12671217  <dt><b>Main Authors:</b></dt> 
    … …  
    12821232  </dd> 
    12831233</dl> 
    1284 </p> 
    1285 </dl> 
    12861234<p> 
    12871235Copyright &copy; 1998-2007, Modelica Association, Anton Haumer and arsenal research. 
    … …  
    12931241<a href=\"Modelica://Modelica.UsersGuide.ModelicaLicense\">here</a>.</i> 
    12941242</p> 
    1295  
     1243</HTML>", revisions="<HTML> 
    12961244  <ul> 
    12971245  <li> v1.00 2005/02/01 Anton Haumer<br> 
    … …  
    13271275       
    13281276    annotation (Documentation(info="<HTML> 
    1329 <p> 
    13301277Pipe without heat exchange.<br> 
    1331 Thermodynamic equations are defined by Partials.TwoPortMass(Q_flow = 0). 
    1332 </p> 
    1333 <p> 
     1278Thermodynamic equations are defined by Partials.TwoPortMass(Q_flow = 0).<br> 
    13341279<b>Note:</b> Setting parameter m (mass of medium within pipe) to zero 
    13351280leads to neglection of temperature transient cv*m*der(T). 
    1336 </p> 
    13371281</HTML>"), 
    13381282      Icon(Rectangle(extent=[-90, 20; 90, -20], style( 
    … …  
    13571301       
    13581302    annotation (Documentation(info="<HTML> 
    1359 <p> 
    13601303Pipe with heat exchange.<br> 
    13611304Thermodynamic equations are defined by Partials.TwoPort.<br> 
    1362 Q_flow is defined by heatPort.Q_flow. 
    1363 </p> 
    1364 <p> 
     1305Q_flow is defined by heatPort.Q_flow.<br> 
    13651306<b>Note:</b> Setting parameter m (mass of medium within pipe) to zero 
    1366 leads to neglection of temperature transient cv*m*der(T). 
    1367 </p> 
    1368 <p> 
     1307leads to neglection of temperature transient cv*m*der(T).<br> 
    13691308<b>Note:</b> Injecting heat into a pipe with zero massflow causes  
    13701309temperature rise defined by storing heat in medium's mass. 
    1371 </p> 
    13721310</HTML>"), 
    13731311      Icon(Rectangle(extent=[-90, 20; 90, -20], style( 
    … …  
    14031341       
    14041342    annotation (Documentation(info="<HTML> 
    1405 <p> 
    14061343Simple controlled valve.<br> 
    14071344Standard characteristic Kv=<i>f </i>(y) is given at standard conditions (dp0, rho0),<br>  
    … …  
    14201357Flow resistance under real conditions is calculated by<br> 
    14211358<tt>V_flow**2 * rho / dp = Kv(y)**2 * rho0 / dp0</tt> 
    1422 </p> 
    14231359</HTML>"), 
    14241360      Icon(   Text(extent=[-150,-60; 150,-120], string="%name"), 
    … …  
    14791415    extends Modelica.Icons.Library2; 
    14801416  annotation (Documentation(info="<HTML> 
    1481 <p> 
    14821417This package contains connectors and partial models: 
    14831418<ul> 
    … …  
    14861421<li>package Partials (defining basic thermodynamic equations)</li> 
    14871422</ul> 
    1488 </p> 
    1489 <p> 
    1490  
    1491 </HTML>", revisions="<HTML> 
    14921423<dl> 
    14931424  <dt><b>Main Authors:</b></dt> 
    … …  
    15081439  </dd> 
    15091440</dl> 
    1510 </p> 
    1511 </dl> 
    15121441<p> 
    15131442Copyright &copy; 1998-2007, Modelica Association, Anton Haumer and arsenal research. 
    … …  
    15191448<a href=\"Modelica://Modelica.UsersGuide.ModelicaLicense\">here</a>.</i> 
    15201449</p> 
    1521  
     1450</HTML>", revisions="<HTML> 
    15221451  <ul> 
    15231452  <li> v1.00 2005/02/01 Anton Haumer<br> 
    … …  
    15481477       
    15491478    annotation (Documentation(info="<HTML> 
    1550 <p> 
    1551 Basic definition of the connector. 
    1552 </p> 
    1553 <p> 
     1479Basic definition of the connector.<br> 
    15541480<b>Variables:</b> 
    15551481<ul> 
    … …  
    15591485<li>flow EnthaplyFlowRate H_flow</li> 
    15601486</ul> 
    1561 </p> 
    1562 <p> 
    1563 <p> 
    15641487If ports with different media are connected, the simulation is asserted due to the check of parameter. 
    1565 </p> 
    15661488</HTML>")); 
    15671489      parameter FluidHeatFlow.Media.Medium medium "Medium in the connector"; 
    … …  
    15751497       
    15761498    annotation (Documentation(info="<HTML> 
    1577 <p> 
    15781499Same as FlowPort, but icon allows to differentiate direction of flow. 
    1579 </p> 
    15801500</HTML>"), 
    15811501      Icon(Rectangle(extent=[-100, 100; 100, -100], style( 
    … …  
    16091529       
    16101530    annotation (Documentation(info="<HTML> 
    1611 <p> 
    16121531Same as FlowPort, but icon allows to differentiate direction of flow. 
    1613 </p> 
    16141532</HTML>"), 
    16151533      Icon(Rectangle(extent=[-100,100; 100,-100],   style( 
    … …  
    16361554      extends Modelica.Icons.Library; 
    16371555    annotation (Documentation(info="<HTML> 
    1638 <p> 
    1639 This package contains partial models, defining in a very compact way the basic thermodynamic equations used by the different components. 
    1640 </p> 
    1641 <p> 
     1556This package contains partial models, defining in a very compact way the basic thermodynamic equations used by the different components.<br> 
    16421557<dl> 
    16431558  <dt><b>Main Authors:</b></dt> 
    … …  
    16581573  </dd> 
    16591574</dl> 
    1660 </p> 
    1661 </dl> 
    16621575<p> 
    16631576Copyright &copy; 1998-2007, Modelica Association, Anton Haumer and arsenal research. 
    … …  
    16691582<a href=\"Modelica://Modelica.UsersGuide.ModelicaLicense\">here</a>.</i> 
    16701583</p> 
    1671 </HTML>",     revisions="<HTML> 
     1584</HTML>",revisions="<HTML> 
    16721585  <ul> 
    16731586  <li> v1.00 2005/02/01 Anton Haumer<br> 
    … …  
    16971610         
    16981611      annotation (Documentation(info="<HTML> 
    1699 <p> 
    1700 Definition of relationship between pressure drop and volume flow rate: 
    1701 </p> 
    1702 <p> 
     1612Definition of relationship between pressure drop and volume flow rate:<br> 
    17031613-V_flowLaminar &lt; VolumeFlow &lt; +V_flowLaminar: laminar i.e. linear dependency of pressure drop on volume flow.<br> 
    17041614-V_flowLaminar &gt; VolumeFlow or VolumeFlow &lt; +V_flowLaminar: turbulent i.e. quadratic dependency of pressure drop on volume flow.<br> 
    … …  
    17061616Quadratic dependency is defined by nominal volume flow and pressure drop (V_flowNominal / dpNominal).<br> 
    17071617See also sketch at diagram layer. 
    1708 </p> 
    17091618</HTML>"), 
    17101619        Diagram( 
    … …  
    17841693         
    17851694      annotation (Documentation(info="<HTML> 
    1786 <p> 
    17871695Partial model with two flowPorts.<br> 
    17881696Possible heat exchange with the ambient is defined by Q_flow; setting this = 0 means no energy exchange.<br> 
    … …  
    17911699Mixing rule is applied.<br> 
    17921700Parameter 0 &lt; tapT &lt; 1 defines temperature of heatPort between medium's inlet and outlet temperature. 
    1793 </p> 
    17941701</HTML>")); 
    17951702        parameter FluidHeatFlow.Media.Medium medium=FluidHeatFlow.Media.Medium()  
    … …  
    18761783         
    18771784      annotation (Documentation(info="<HTML> 
    1878 <p> 
    18791785Partial model for an absolute sensor (pressure/temperature).<br> 
    18801786Pressure, mass flow, temperature and enthalpy flow of medium are not affected. 
    1881 </p> 
    18821787</HTML>")); 
    18831788        parameter FluidHeatFlow.Media.Medium medium=FluidHeatFlow.Media.Medium()  
    … …  
    19211826         
    19221827      annotation (Documentation(info="<HTML> 
    1923 <p> 
    19241828Partial model for a relative sensor (pressure drop/temperature difference).<br> 
    19251829Pressure, mass flow, temperature and enthalpy flow of medium are not affected. 
    1926 </p> 
    19271830</HTML>")); 
    19281831        parameter FluidHeatFlow.Media.Medium medium=FluidHeatFlow.Media.Medium()  
    … …  
    19711874         
    19721875      annotation (Documentation(info="<HTML> 
    1973 <p> 
    19741876Partial model for a flow sensor (mass flow/heat flow).<br> 
    19751877Pressure, mass flow, temperature and enthalpy flow of medium are not affected, but mixing rule is applied. 
    1976 </p> 
    19771878</HTML>")); 
    19781879        extends TwoPort(final m=0, final T0=0, final tapT=1); 
    … …  
    20151916    extends Modelica.Icons.Library2; 
    20161917  annotation (Documentation(info="<HTML> 
    2017 <p> 
    2018 This package contains definitions of medium properties. 
    2019 </p> 
    2020  
    2021 </HTML>", revisions="<HTML> 
     1918This package contains definitions of medium properties.<br> 
    20221919<dl> 
    20231920  <dt><b>Main Authors:</b></dt> 
    … …  
    20381935  </dd> 
    20391936</dl> 
    2040 </p> 
    2041 </dl> 
    20421937<p> 
    20431938Copyright &copy; 1998-2007, Modelica Association, Anton Haumer and arsenal research. 
    … …  
    20491944<a href=\"Modelica://Modelica.UsersGuide.ModelicaLicense\">here</a>.</i> 
    20501945</p> 
    2051  
     1946</HTML>", revisions="<HTML> 
    20521947  <ul> 
    20531948  <li> v1.00 2005/02/01 Anton Haumer<br> 
    … …  
    21322027    extends Modelica.Icons.Library2; 
    21332028  annotation (Documentation(info="<HTML> 
    2134 <p> 
    21352029This package contains sensors: 
    21362030<ul> 
    … …  
    21432037<li>H_flowSensor: measures enthalpy flow rate</li> 
    21442038</ul> 
    2145 </p> 
    2146 <p> 
    21472039Some of the sensors do not need access to medium properties for measuring,  
    21482040but it is necessary to define the medium in the connector (check of connections).<br> 
    21492041Thermodynamic equations are defined in partial models (package Interfaces.Partials).<br> 
    2150 All sensors are considered massless, they do not change mass flow or enthalpy flow. 
    2151 </p> 
    2152 <p> 
    2153  
    2154 </HTML>", revisions="<HTML> 
     2042All sensors are considered massless, they do not change mass flow or enthalpy flow.<br> 
    21552043<dl> 
    21562044  <dt><b>Main Authors:</b></dt> 
    … …  
    21712059  </dd> 
    21722060</dl> 
    2173 </p> 
    2174 </dl> 
    21752061<p> 
    21762062Copyright &copy; 1998-2007, Modelica Association, Anton Haumer and arsenal research. 
    … …  
    21822068<a href=\"Modelica://Modelica.UsersGuide.ModelicaLicense\">here</a>.</i> 
    21832069</p> 
    2184  
     2070</HTML>", revisions="<HTML> 
    21852071  <ul> 
    21862072  <li> v1.00 2005/02/01 Anton Haumer<br> 
    … …  
    22322118       
    22332119    annotation (Documentation(info="<HTML> 
    2234 <p> 
    22352120pSensor measures the absolute pressure.<br> 
    22362121Thermodynamic equations are defined by Partials.AbsoluteSensor. 
    2237 </p> 
    22382122</HTML>"), Diagram); 
    22392123      extends Interfaces.Partials.AbsoluteSensor(y(redeclare type SignalType =  
    … …  
    22502134       
    22512135    annotation (Documentation(info="<HTML> 
    2252 <p> 
    22532136TSensor measures the absolute temperature (Kelvin).<br> 
    22542137Thermodynamic equations are defined by Partials.AbsoluteSensor. 
    2255 </p> 
    22562138</HTML>"), Diagram); 
    22572139      extends Interfaces.Partials.AbsoluteSensor(y(redeclare type SignalType =  
    … …  
    22682150       
    22692151    annotation (Documentation(info="<HTML> 
    2270 <p> 
    22712152dpSensor measures the pressure drop between flowPort_a and flowPort_b.<br> 
    22722153Thermodynamic equations are defined by Partials.RelativeSensor. 
    2273 </p> 
    22742154</HTML>"), Diagram); 
    22752155      extends Interfaces.Partials.RelativeSensor(y(redeclare type SignalType =  
    … …  
    22862166       
    22872167    annotation (Documentation(info="<HTML> 
    2288 <p> 
    22892168dTSensor measures the temperature difference between flowPort_a and flowPort_b.<br> 
    2290 Thermodynamic equations are defined by Partials.RelativeSensor. 
    2291 </p> 
    2292 <ul> 
    2293 <li><b>Note:</b> Connected flowPorts have the same temperature (mixing temperature)!<br> 
     2169Thermodynamic equations are defined by Partials.RelativeSensor.<br> 
     2170<b>Note:</b> Connected flowPorts have the same temperature (mixing temperature)!<br> 
    22942171Since mixing my occur, the outlet temperature of a component may be different from the connector's temperature.<br>  
    2295 Outlet temperature is defined by variable T of the corresponding component.</li> 
    2296 </ul> 
     2172Outlet temperature is defined by variable T of the corresponding component. 
    22972173</HTML>"), Diagram); 
    22982174      extends Interfaces.Partials.RelativeSensor(y(redeclare type SignalType =  
    … …  
    23092185       
    23102186    annotation (Documentation(info="<HTML> 
    2311 <p> 
    23122187m_flowSensor measures the mass flow rate.<br> 
    23132188Thermodynamic equations are defined by Partials.FlowSensor. 
    2314 </p> 
    23152189</HTML>"), Diagram); 
    23162190      extends Interfaces.Partials.FlowSensor(y(redeclare type SignalType =  
    … …  
    23272201       
    23282202    annotation (Documentation(info="<HTML> 
    2329 <p> 
    23302203V_flowSensor measures the volume flow rate.<br> 
    23312204Thermodynamic equations are defined by Partials.FlowSensor. 
    2332 </p> 
    23332205</HTML>"), Diagram); 
    23342206      extends Interfaces.Partials.FlowSensor(y(redeclare type SignalType =  
    … …  
    23452217       
    23462218    annotation (Documentation(info="<HTML> 
    2347 <p> 
    23482219H_flowSensor measures the enthalpy flow rate.<br> 
    23492220Thermodynamic equations are defined by Partials.FlowSensor. 
    2350 </p> 
    23512221</HTML>"),     Diagram); 
    23522222      extends Interfaces.Partials.FlowSensor(y(redeclare type SignalType =  
    … …  
    23642234    extends Modelica.Icons.Library2; 
    23652235  annotation (Documentation(info="<HTML> 
    2366