Changeset 582

Show
Ignore:
Timestamp:
08/20/2007 12:50:41 PM (17 months ago)
Author:
AHaumer
Message:

improved documentation

Files:
1 modified

Legend:

Unmodified
Added
Removed

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

    r572 r582  
    11within Modelica.Thermal; 
    22package FluidHeatFlow  
    3   "Library of simple components for 1-dimensional incompressible thermo-fluid flow models"  
     3  "Simple components for 1-dimensional incompressible thermo-fluid flow models"  
    44  extends Modelica.Icons.Library2; 
    55  annotation ( 
    6     version="1.6.1", versionDate="2007-08-12", 
     6    version="1.6.2", versionDate="2007-08-20", 
    77    preferedView="info",Documentation(info="<HTML> 
    88<p> 
    99This package contains very simple-to-use components to model coolant flows as needed to simulate cooling e.g. of electric machines: 
    10 </p> 
    11  
    1210<ul> 
    1311<li>Components: components like different types of pipe models</li> 
    … …  
    1917<li>Sources: various flow sources</li> 
    2018</ul> 
    21  
     19</p> 
    2220<p> 
    2321<b>Variables used in connectors:</b> 
    24 </p> 
    25  
    2622<ul> 
    2723<li>Pressure p</li> 
    … …  
    3026<li>flow EnthalpyFlowRate H_flow</li> 
    3127</ul> 
    32  
    33 <p> 
    3428EnthalpyFlowRate means the Enthalpy = cp<sub>constant</sub> * m * T that is carried by the medium's flow. 
    3529</p> 
    36  
    3730<p> 
    3831<b>Limitations and assumptions:</b> 
    39 </p> 
    40  
    4132<ul> 
    4233<li>Splitting and mixing of coolant flows (media with the same cp) is possible.</li> 
    … …  
    5243Outlet temperature is defined by variable T of the corresponding component.</li> 
    5344</ul> 
    54  
    55  
     45</p> 
    5646<p> 
    5747<b>Further development:</b> 
    58 </p> 
    59  
    6048<ul> 
    6149<li>Additional components like tanks (if needed)</li> 
    6250</ul> 
    63  
    64  
     51</p> 
     52<p> 
    6553<dl> 
    6654  <dt><b>Main Authors:</b></dt> 
    … …  
    8169  </dd> 
    8270</dl> 
    83  
     71</p> 
     72</dl> 
    8473<p> 
    8574Copyright &copy; 1998-2007, Modelica Association, Anton Haumer and arsenal research. 
    8675</p> 
    8776<p> 
    88 <i>This Modelica package is <b>free</b> software; it can be redistributed and/or modified 
     77<i>The Modelica package is <b>free</b> software; it can be redistributed and/or modified 
    8978under the terms of the <b>Modelica license</b>, see the license conditions 
    9079and the accompanying <b>disclaimer</b>  
    … …  
    124113       improved documentation<br> 
    125114       removed type TemperatureDifference since this is defined in Modelica.SIunits</li> 
     115  <li> v1.6.2 2007/08/20 Anton Haumer<br> 
     116       improved documentation</li> 
    126117  </ul> 
    127118</HTML> 
    … …  
    153144<p> 
    154145This package contains test examples: 
    155 </p> 
    156  
    157146<ul> 
    158147<li>1.SimpleCooling: heat is dissipated through a media flow</li> 
    … …  
    165154<li>8.TwoMass: cooling of two masses (thermal capacities) by two parallel coolant flows</li> 
    166155</ul> 
    167  
     156</p> 
    168157 
    169158</HTML>", revisions="<HTML> 
    … …  
    10371026      connect(Pipe1.flowPort_b, Ambient2.flowPort)  
    10381027        annotation (points=[20,0; 40,0],   style(color=1, rgbcolor={255,0,0})); 
    1039       connect(ThermalConductor1.port_a, HeatCapacitor1.port) annotation (points=[10,-40; 
     1028      connect(ThermalConductor1.port_a, HeatCapacitor1.port) annotation (points=[10,-40;  
    10401029            10,-40; 10,-50; 10,-50],        style(color=42, rgbcolor={191,0,0})); 
    10411030      connect(Pipe1.heatPort, ThermalConductor1.port_b)  
    … …  
    11381127      connect(Pipe3.flowPort_b, Ambient2.flowPort)  
    11391128        annotation (points=[60,0; 80,0], style(color=1, rgbcolor={255,0,0})); 
    1140       connect(HeatCapacitor2.port, ThermalConductor2.port_a) annotation (points=[10,60; 
     1129      connect(HeatCapacitor2.port, ThermalConductor2.port_a) annotation (points=[10,60;  
    11411130            10,55.5; 10,50; 10,50],   style(color=42, rgbcolor={191,0,0})); 
    11421131      connect(ThermalConductor2.port_b, Pipe2.heatPort)  
    … …  
    11441133      connect(Pipe1.heatPort, ThermalConductor1.port_b) annotation (points=[10,-20; 
    11451134            10,-30],         style(color=42, rgbcolor={191,0,0})); 
    1146       connect(ThermalConductor1.port_a, HeatCapacitor1.port) annotation (points=[10,-50; 
     1135      connect(ThermalConductor1.port_a, HeatCapacitor1.port) annotation (points=[10,-50;  
    11471136            10,-50; 10,-60; 10,-60], 
    11481137                                  style(color=42, rgbcolor={191,0,0})); 
    … …  
    12011190        parameter Modelica.SIunits.Time interval=0.2  
    12021191          "Interval between end of 1st and beginning of 2nd ramp"; 
    1203         parameter Real height_1=-1 "|Ramp 1|Height of ramp"; 
     1192        parameter Real height_1=-1 "Height of ramp" 
     1193          annotation(Dialog(group="Ramp 1")); 
    12041194        parameter Modelica.SIunits.Time duration_1(min=Modelica.Constants.small) = 0.2  
    1205           "|Ramp 1|Duration of ramp"; 
    1206         parameter Real height_2=1 "|Ramp 2|Height of ramp"; 
     1195          "Duration of ramp" 
     1196          annotation(Dialog(group="Ramp 1")); 
     1197        parameter Real height_2=1 "Height of ramp" 
     1198          annotation(Dialog(group="Ramp 2")); 
    12071199        parameter Modelica.SIunits.Time duration_2(min=Modelica.Constants.small) = 0.2  
    1208           "|Ramp 2|Duration of ramp"; 
     1200          "Duration of ramp" 
     1201          annotation(Dialog(group="Ramp 2")); 
    12091202        annotation ( 
    12101203          Documentation(info="<HTML> 
    … …  
    12571250<p> 
    12581251This package contains components: 
    1259 </p> 
    1260  
    12611252<ul> 
    12621253<li>pipe without heat exchange</li> 
    12631254<li>pipe with heat exchange</li> 
    12641255<li>valve (simple controlled valve)</li> 
    1265 </ul> 
    1266  
     1256<ul> 
     1257</p> 
    12671258<p> 
    12681259Pressure drop is taken from partial model SimpleFriction.<br> 
    12691260Thermodynamic equations are defined in partial models (package Partials). 
    12701261</p> 
    1271  
     1262<p> 
    12721263 
    12731264</HTML>", revisions="<HTML> 
    … …  
    14451436      extends Interfaces.Partials.TwoPort(m=0, final tapT=1); 
    14461437      parameter Boolean LinearCharacteristic=true  
    1447         "|Standard characteristic|Type of characteristic"  
    1448         annotation(choices(choice=true "Linear", choice=false "Exponential")); 
     1438        "Type of characteristic"  
     1439        annotation(Dialog(group="Standard characteristic"), choices(choice=true "Linear", choice=false "Exponential")); 
    14491440      parameter Real y1(min=small)=1  
    1450         "|Standard characteristic|Max. valve opening"; 
     1441        "Max. valve opening" 
     1442        annotation(Dialog(group="Standard characteristic")); 
    14511443      parameter Modelica.SIunits.VolumeFlowRate Kv1(min=small)=1  
    1452         "|Standard characteristic|Max. flow @ y = y1"; 
     1444        "Max. flow @ y = y1" 
     1445        annotation(Dialog(group="Standard characteristic")); 
    14531446      parameter Real kv0(min=small,max=1-small)=0.01  
    1454         "|Standard characteristic|Leakage flow / max.flow @ y = 0"; 
     1447        "Leakage flow / max.flow @ y = 0" 
     1448        annotation(Dialog(group="Standard characteristic")); 
    14551449      parameter Modelica.SIunits.Pressure dp0=1  
    1456         "|Standard characteristic|Standard pressure drop"; 
     1450        "Standard pressure drop" 
     1451        annotation(Dialog(group="Standard characteristic")); 
    14571452      parameter Modelica.SIunits.Density rho0 = 10  
    1458         "|Standard characteristic|Standard medium's density"; 
     1453        "Standard medium's density" 
     1454        annotation(Dialog(group="Standard characteristic")); 
    14591455      parameter Real frictionLoss(min=0, max=1) = 0  
    14601456        "Part of friction losses fed to medium"; 
    … …  
    17511747              string="dp ~ V_flow²"))); 
    17521748        parameter Modelica.SIunits.VolumeFlowRate V_flowLaminar(min=Modelica.Constants.small)=0.1  
    1753           "|SimpleFriction|Laminar volume flow"; 
     1749          "Laminar volume flow" 
     1750          annotation(Dialog(group="Simple Friction")); 
    17541751        parameter Modelica.SIunits.Pressure dpLaminar=0.1  
    1755           "|SimpleFriction|Laminar pressure drop"; 
     1752          "Laminar pressure drop" 
     1753          annotation(Dialog(group="Simple Friction")); 
    17561754        parameter Modelica.SIunits.VolumeFlowRate V_flowNominal=1  
    1757           "|SimpleFriction|Nominal volume flow"; 
     1755          "Nominal volume flow" 
     1756          annotation(Dialog(group="Simple Friction")); 
    17581757        parameter Modelica.SIunits.Pressure dpNominal=1  
    1759           "|SimpleFriction|Nominal pressure drop"; 
     1758          "Nominal pressure drop" 
     1759          annotation(Dialog(group="Simple Friction")); 
    17601760        parameter Real frictionLoss(min=0, max=1) = 0  
    1761           "|SimpleFriction|Part of friction losses fed to medium"; 
     1761          "Part of friction losses fed to medium" 
     1762          annotation(Dialog(group="Simple Friction")); 
    17621763        Modelica.SIunits.Pressure pressureDrop; 
    17631764        Modelica.SIunits.VolumeFlowRate VolumeFlow; 
    … …  
    23682369<p> 
    23692370This package contains different types of sources: 
    2370 </p> 
    2371  
    23722371<ul> 
    23732372<li>Ambient with constant pressure and temperature</li> 
    … …  
    23772376<li>Constant and prescribed pressure increase</li> 
    23782377<li>Simple pump with mechanical flange</li> 
    2379 </ul> 
    2380  
     2378<ul> 
     2379</p> 
    23812380<p> 
    23822381Thermodynamic equations are defined in partial models (package Interfaces.Partials).<br> 
    23832382All fans / pumps are considered without losses, they do not change enthalpy flow. 
    23842383</p> 
     2384<p> 
    23852385 
    23862386</HTML>", revisions="<HTML> 
    … …  
    24032403  </dd> 
    24042404</dl> 
    2405  
     2405</p> 
     2406</dl> 
    24062407<p> 
    24072408Copyright &copy; 1998-2007, Modelica Association, Anton Haumer and arsenal research. 
    … …  
    26972698      extends Interfaces.Partials.TwoPort(final tapT=1); 
    26982699      parameter Modelica.SIunits.AngularVelocity w_Nominal=1  
    2699         "|Pump characteristic|Nominal speed"; 
     2700        "Nominal speed" 
     2701          annotation(Dialog(group="Pump characteristic")); 
    27002702      parameter Modelica.SIunits.Pressure dp0=2  
    2701         "|Pump characteristic|Max. pressure increase @ V_flow=0"; 
     2703        "Max. pressure increase @ V_flow=0" 
     2704          annotation(Dialog(group="Pump characteristic")); 
    27022705      parameter Modelica.SIunits.VolumeFlowRate V_flow0=2  
    2703         "|Pump characteristic|Max. volume flow rate @ dp=0"; 
     2706        "Max. volume flow rate @ dp=0" 
     2707          annotation(Dialog(group="Pump characteristic")); 
    27042708      Modelica.SIunits.AngularVelocity w=der(flange_a.phi) "Speed"; 
    27052709    protected