Show
Ignore:
Timestamp:
08/20/07 12:46:05 (12 months ago)
Author:
AHaumer
Message:

improved documentation

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • branches/maintenance/2.2.1/Modelica/Thermal/FluidHeatFlow.mo

    r530 r581  
    33  extends Modelica.Icons.Library2; 
    44  annotation ( 
    5     version="1.6.1", versionDate="2007-08-12", 
     5    version="1.6.2", versionDate="2007-08-20", 
    66    preferedView="info",Documentation(info="<HTML> 
    77<p> 
    … …  
    112112       improved documentation<br> 
    113113       removed type TemperatureDifference since this is defined in Modelica.SIunits</li> 
     114  <li> v1.6.2 2007/08/20 Anton Haumer<br> 
     115       improved documentation</li> 
    114116  </ul> 
    115117</HTML> 
    … …  
    11871189        parameter Modelica.SIunits.Time interval=0.2  
    11881190          "Interval between end of 1st and beginning of 2nd ramp"; 
    1189         parameter Real height_1=-1 "|Ramp 1|Height of ramp"; 
     1191        parameter Real height_1=-1 "Height of ramp" 
     1192          annotation(Dialog(group="Ramp 1")); 
    11901193        parameter Modelica.SIunits.Time duration_1(min=Modelica.Constants.small) = 0.2  
    1191           "|Ramp 1|Duration of ramp"; 
    1192         parameter Real height_2=1 "|Ramp 2|Height of ramp"; 
     1194          "Duration of ramp" 
     1195          annotation(Dialog(group="Ramp 1")); 
     1196        parameter Real height_2=1 "Height of ramp" 
     1197          annotation(Dialog(group="Ramp 2")); 
    11931198        parameter Modelica.SIunits.Time duration_2(min=Modelica.Constants.small) = 0.2  
    1194           "|Ramp 2|Duration of ramp"; 
     1199          "Duration of ramp" 
     1200          annotation(Dialog(group="Ramp 2")); 
    11951201        annotation ( 
    11961202          Documentation(info="<HTML> 
    … …  
    14291435      extends Interfaces.Partials.TwoPort(m=0, final tapT=1); 
    14301436      parameter Boolean LinearCharacteristic=true  
    1431         "|Standard characteristic|Type of characteristic"  
    1432         annotation(choices(choice=true "Linear", choice=false "Exponential")); 
     1437        "Type of characteristic"  
     1438        annotation(Dialog(group="Standard characteristic"), choices(choice=true "Linear", choice=false "Exponential")); 
    14331439      parameter Real y1(min=small)=1  
    1434         "|Standard characteristic|Max. valve opening"; 
     1440        "Max. valve opening" 
     1441        annotation(Dialog(group="Standard characteristic")); 
    14351442      parameter Modelica.SIunits.VolumeFlowRate Kv1(min=small)=1  
    1436         "|Standard characteristic|Max. flow @ y = y1"; 
     1443        "Max. flow @ y = y1" 
     1444        annotation(Dialog(group="Standard characteristic")); 
    14371445      parameter Real kv0(min=small,max=1-small)=0.01  
    1438         "|Standard characteristic|Leakage flow / max.flow @ y = 0"; 
     1446        "Leakage flow / max.flow @ y = 0" 
     1447        annotation(Dialog(group="Standard characteristic")); 
    14391448      parameter Modelica.SIunits.Pressure dp0=1  
    1440         "|Standard characteristic|Standard pressure drop"; 
     1449        "Standard pressure drop" 
     1450        annotation(Dialog(group="Standard characteristic")); 
    14411451      parameter Modelica.SIunits.Density rho0 = 10  
    1442         "|Standard characteristic|Standard medium's density"; 
     1452        "Standard medium's density" 
     1453        annotation(Dialog(group="Standard characteristic")); 
    14431454      parameter Real frictionLoss(min=0, max=1) = 0  
    14441455        "Part of friction losses fed to medium"; 
    … …  
    17351746              string="dp ~ V_flow²"))); 
    17361747        parameter Modelica.SIunits.VolumeFlowRate V_flowLaminar(min=Modelica.Constants.small)=0.1  
    1737           "|SimpleFriction|Laminar volume flow"; 
     1748          "Laminar volume flow" 
     1749          annotation(Dialog(group="Simple Friction")); 
    17381750        parameter Modelica.SIunits.Pressure dpLaminar=0.1  
    1739           "|SimpleFriction|Laminar pressure drop"; 
     1751          "Laminar pressure drop" 
     1752          annotation(Dialog(group="Simple Friction")); 
    17401753        parameter Modelica.SIunits.VolumeFlowRate V_flowNominal=1  
    1741           "|SimpleFriction|Nominal volume flow"; 
     1754          "Nominal volume flow" 
     1755          annotation(Dialog(group="Simple Friction")); 
    17421756        parameter Modelica.SIunits.Pressure dpNominal=1  
    1743           "|SimpleFriction|Nominal pressure drop"; 
     1757          "Nominal pressure drop" 
     1758          annotation(Dialog(group="Simple Friction")); 
    17441759        parameter Real frictionLoss(min=0, max=1) = 0  
    1745           "|SimpleFriction|Part of friction losses fed to medium"; 
     1760          "Part of friction losses fed to medium" 
     1761          annotation(Dialog(group="Simple Friction")); 
    17461762        Modelica.SIunits.Pressure pressureDrop; 
    17471763        Modelica.SIunits.VolumeFlowRate VolumeFlow; 
    … …  
    26812697      extends Interfaces.Partials.TwoPort(final tapT=1); 
    26822698      parameter Modelica.SIunits.AngularVelocity w_Nominal=1  
    2683         "|Pump characteristic|Nominal speed"; 
     2699        "Nominal speed" 
     2700          annotation(Dialog(group="Pump characteristic")); 
    26842701      parameter Modelica.SIunits.Pressure dp0=2  
    2685         "|Pump characteristic|Max. pressure increase @ V_flow=0"; 
     2702        "Max. pressure increase @ V_flow=0" 
     2703          annotation(Dialog(group="Pump characteristic")); 
    26862704      parameter Modelica.SIunits.VolumeFlowRate V_flow0=2  
    2687         "|Pump characteristic|Max. volume flow rate @ dp=0"; 
     2705        "Max. volume flow rate @ dp=0" 
     2706          annotation(Dialog(group="Pump characteristic")); 
    26882707      Modelica.SIunits.AngularVelocity w=der(flange_a.phi) "Speed"; 
    26892708    protected