Changeset 579

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

improved documentation

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • Modelica/branches/maintenance/2.2.1/Modelica/Electrical/Machines.mo

    r577 r579  
    22  extends Modelica.Icons.Library2; 
    33  annotation ( 
    4   version="1.7.8", versionDate="2007-08-20", 
     4  version="1.7.9", versionDate="2007-08-20", 
    55  Settings(NewStateSelection=true, Evaluate=true), 
    66  preferedView="info", Documentation(info="<HTML> 
     
    115115  <li> v1.7.8 2007/08/20 Anton Haumer<br> 
    116116       corrected typo in documentation</li> 
     117  <li> v1.7.9 2007/08/20 Anton Haumer<br> 
     118       improved documentation</li> 
    117119  </ul> 
    118120</HTML>"), 
     
    14901492        constant Modelica.SIunits.Frequency fNominal=50 "nominal frequency"; 
    14911493        parameter Modelica.SIunits.Resistance Rs=0.03  
    1492           "|Nominal resistances and inductances|warm stator resistance per phase"; 
     1494          "warm stator resistance per phase"  
     1495          annotation(Dialog(group="Nominal resistances and inductances")); 
    14931496        parameter Modelica.SIunits.Inductance Lssigma=3*(1 - sqrt(1 - 0.0667))/(2*pi* 
    1494             fNominal)  
    1495           "|Nominal resistances and inductances|stator stray inductance per phase"; 
     1497            fNominal) "stator stray inductance per phase"  
     1498          annotation(Dialog(group="Nominal resistances and inductances")); 
    14961499        parameter Modelica.SIunits.Inductance Lm=3*sqrt(1 - 0.0667)/(2*pi*fNominal)  
    1497           "|Nominal resistances and inductances|main field inductance"; 
     1500          "main field inductance"  
     1501          annotation(Dialog(group="Nominal resistances and inductances")); 
    14981502        parameter Modelica.SIunits.Inductance Lrsigma=3*(1 - sqrt(1 - 0.0667))/(2*pi* 
    1499             fNominal)  
    1500           "|Nominal resistances and inductances|rotor stray inductance"; 
    1501         parameter Modelica.SIunits.Resistance Rr=0.04  
    1502           "|Nominal resistances and inductances|warm rotor resistance"; 
     1503            fNominal) "rotor stray inductance"  
     1504          annotation(Dialog(group="Nominal resistances and inductances")); 
     1505        parameter Modelica.SIunits.Resistance Rr=0.04 "warm rotor resistance"  
     1506          annotation(Dialog(group="Nominal resistances and inductances")); 
    15031507        output Modelica.SIunits.Current i_0_s( stateSelect=StateSelect.prefer) = spacePhasorS.zero.i  
    15041508          "stator zero-sequence current"; 
     
    16611665        constant Modelica.SIunits.Frequency fNominal=50 "nominal frequency"; 
    16621666        parameter Modelica.SIunits.Resistance Rs=0.03  
    1663           "|Nominal resistances and inductances|warm stator resistance per phase"; 
     1667          "warm stator resistance per phase"  
     1668          annotation(Dialog(group="Nominal resistances and inductances")); 
    16641669        parameter Modelica.SIunits.Inductance Lssigma=3*(1 - sqrt(1 - 0.0667))/(2*pi* 
    1665             fNominal)  
    1666           "|Nominal resistances and inductances|stator stray inductance per phase"; 
     1670            fNominal) "stator stray inductance per phase"  
     1671          annotation(Dialog(group="Nominal resistances and inductances")); 
    16671672        parameter Modelica.SIunits.Inductance Lm=3*sqrt(1 - 0.0667)/(2*pi*fNominal)  
    1668           "|Nominal resistances and inductances|main field inductance"; 
     1673          "main field inductance"  
     1674          annotation(Dialog(group="Nominal resistances and inductances")); 
    16691675        parameter Modelica.SIunits.Inductance Lrsigma=3*(1 - sqrt(1 - 0.0667))/(2*pi* 
    1670             fNominal)  
    1671           "|Nominal resistances and inductances|rotor stray inductance per phase"; 
     1676            fNominal) "rotor stray inductance per phase"  
     1677          annotation(Dialog(group="Nominal resistances and inductances")); 
    16721678        parameter Modelica.SIunits.Resistance Rr=0.04  
    1673           "|Nominal resistances and inductances|warm rotor resistance per phase"; 
     1679          "warm rotor resistance per phase"  
     1680          annotation(Dialog(group="Nominal resistances and inductances")); 
    16741681        parameter Boolean useTurnsRatio=true  
    16751682          "use TurnsRatio or calculate from locked-rotor voltage?"; 
     
    19591966        "Permanent magnet synchronous induction machine"  
    19601967        extends Interfaces.PartialBasicInductionMachine; 
    1961         parameter Modelica.SIunits.Frequency fNominal=50  
    1962           "|Excitation|nominal frequency"; 
     1968        parameter Modelica.SIunits.Frequency fNominal=50 "nominal frequency"  
     1969          annotation(Dialog(group="Excitation")); 
    19631970        parameter Modelica.SIunits.Voltage V0=112.3  
    1964           "|Excitation|no-load RMS voltage per phase @ fNominal"; 
     1971          "no-load RMS voltage per phase @ fNominal"  
     1972          annotation(Dialog(group="Excitation")); 
    19651973        parameter Modelica.SIunits.Resistance Rs=0.03  
    1966           "|Nominal resistances and inductances|warm stator resistance per phase"; 
     1974          "warm stator resistance per phase"  
     1975          annotation(Dialog(group="Nominal resistances and inductances")); 
    19671976        parameter Modelica.SIunits.Inductance Lssigma=0.1/(2*pi*fNominal)  
    1968           "|Nominal resistances and inductances|stator stray inductance per phase"; 
     1977          "stator stray inductance per phase"  
     1978          annotation(Dialog(group="Nominal resistances and inductances")); 
    19691979        parameter Modelica.SIunits.Inductance Lmd=0.3/(2*pi*fNominal)  
    1970           "|Nominal resistances and inductances|main field inductance in d-axis"; 
     1980          "main field inductance in d-axis"  
     1981          annotation(Dialog(group="Nominal resistances and inductances")); 
    19711982        parameter Modelica.SIunits.Inductance Lmq=0.3/(2*pi*fNominal)  
    1972           "|Nominal resistances and inductances|main field inductance in q-axis"; 
     1983          "main field inductance in q-axis"  
     1984          annotation(Dialog(group="Nominal resistances and inductances")); 
    19731985        parameter Boolean DamperCage = true "damper cage is present?"  
    19741986          annotation(Dialog(group = "DamperCage")); 
     
    21572169        connect(spacePhasorS.plug_n, plug_sn) annotation (points=[-10,40; -10, 
    21582170              60; -60,60; -60,100],     style(color=3, rgbcolor={0,0,255})); 
    2159         connect(spacePhasorS.ground, spacePhasorS.zero) annotation (points=[-10,20; 
     2171        connect(spacePhasorS.ground, spacePhasorS.zero) annotation (points=[-10,20;  
    21602172              -10,14; -6.12303e-016,14; -6.12303e-016,20], style( 
    21612173            color=3, 
     
    21872199        extends Interfaces.PartialBasicInductionMachine; 
    21882200        parameter Modelica.SIunits.Resistance Rs=0.03  
    2189           "|Nominal resistances and inductances|warm stator resistance per phase"; 
     2201          "warm stator resistance per phase"  
     2202          annotation(Dialog(group="Nominal resistances and inductances")); 
    21902203        parameter Modelica.SIunits.Inductance Lssigma=0.1/(2*pi*fNominal)  
    2191           "|Nominal resistances and inductances|stator stray inductance per phase"; 
     2204          "stator stray inductance per phase"  
     2205          annotation(Dialog(group="Nominal resistances and inductances")); 
    21922206        parameter Modelica.SIunits.Inductance Lmd=1.5/(2*pi*fNominal)  
    2193           "|Nominal resistances and inductances|main field inductance in d-axis"; 
     2207          "main field inductance in d-axis"  
     2208          annotation(Dialog(group="Nominal resistances and inductances")); 
    21942209        parameter Modelica.SIunits.Inductance Lmq=1.5/(2*pi*fNominal)  
    2195           "|Nominal resistances and inductances|main field inductance in q-axis"; 
     2210          "main field inductance in q-axis"  
     2211          annotation(Dialog(group="Nominal resistances and inductances")); 
    21962212        parameter Boolean DamperCage = true "damper cage is present?"  
    21972213          annotation(Dialog(group = "DamperCage")); 
     
    22092225          annotation(Dialog(group = "DamperCage", enable = DamperCage)); 
    22102226        parameter Modelica.SIunits.Voltage VNominal=100  
    2211           "|Excitation|nominal stator RMS voltage per phase"; 
    2212         parameter Modelica.SIunits.Frequency fNominal=50  
    2213           "|Excitation|nominal frequency"; 
     2227          "nominal stator RMS voltage per phase"  
     2228          annotation(Dialog(group="Excitation")); 
     2229        parameter Modelica.SIunits.Frequency fNominal=50 "nominal frequency"  
     2230          annotation(Dialog(group="Excitation")); 
    22142231        parameter Modelica.SIunits.Current Ie0=10  
    2215           "|Excitation|no-load excitation current @ nominal voltage and frequency"; 
     2232          "no-load excitation current @ nominal voltage and frequency"  
     2233          annotation(Dialog(group="Excitation")); 
    22162234        parameter Modelica.SIunits.Resistance Re=2.5  
    2217           "|Excitation|warm excitation resistance"; 
     2235          "warm excitation resistance"  
     2236          annotation(Dialog(group="Excitation")); 
    22182237        parameter Real sigmae(min=0, max=1)=0.025  
    2219           "|Excitation|stray fraction of total excitation inductance"; 
     2238          "stray fraction of total excitation inductance"  
     2239          annotation(Dialog(group="Excitation")); 
    22202240        output Modelica.SIunits.Current i_0_s( stateSelect=StateSelect.prefer) = spacePhasorS.zero.i  
    22212241          "stator zero-sequence current"; 
     
    24572477        constant Modelica.SIunits.Frequency fNominal=50 "nominal frequency"; 
    24582478        parameter Modelica.SIunits.Resistance Rs=0.03  
    2459           "|Nominal resistances and inductances|warm stator resistance per phase"; 
     2479          "warm stator resistance per phase"  
     2480          annotation(Dialog(group="Nominal resistances and inductances")); 
    24602481        parameter Modelica.SIunits.Inductance Lssigma=0.1/(2*pi*fNominal)  
    2461           "|Nominal resistances and inductances|stator stray inductance per phase"; 
     2482          "stator stray inductance per phase"  
     2483          annotation(Dialog(group="Nominal resistances and inductances")); 
    24622484        parameter Modelica.SIunits.Inductance Lmd=2.9/(2*pi*fNominal)  
    2463           "|Nominal resistances and inductances|main field inductance in d-axis"; 
     2485          "main field inductance in d-axis"  
     2486          annotation(Dialog(group="Nominal resistances and inductances")); 
    24642487        parameter Modelica.SIunits.Inductance Lmq=0.9/(2*pi*fNominal)  
    2465           "|Nominal resistances and inductances|main field inductance in q-axis"; 
     2488          "main field inductance in q-axis"  
     2489          annotation(Dialog(group="Nominal resistances and inductances")); 
    24662490        parameter Boolean DamperCage = true "damper cage is present?"  
    24672491          annotation(Dialog(group = "DamperCage")); 
     
    27052729        extends Interfaces.PartialBasicDCMachine; 
    27062730        parameter Modelica.SIunits.Voltage VaNominal=100  
    2707           "|Nominal parameters|nominal armature voltage"; 
     2731          "nominal armature voltage"  
     2732          annotation(Dialog(group="Nominal parameters")); 
    27082733        parameter Modelica.SIunits.Current IaNominal=100  
    2709           "|Nominal parameters|nominal armature current"; 
     2734          "nominal armature current"  
     2735          annotation(Dialog(group="Nominal parameters")); 
    27102736        parameter Modelica.SIunits.Conversions.NonSIunits.AngularVelocity_rpm  
    2711           rpmNominal =  1425 "|Nominal parameters|nominal speed"; 
     2737          rpmNominal =  1425 "nominal speed"  
     2738          annotation(Dialog(group="Nominal parameters")); 
    27122739        parameter Modelica.SIunits.Resistance Ra=0.05  
    2713           "|Nominal resistances and inductances|warm armature resistance"; 
    2714         parameter Modelica.SIunits.Inductance La=0.0015  
    2715           "|Nominal resistances and inductances|armature inductance"; 
     2740          "warm armature resistance"  
     2741          annotation(Dialog(group="Nominal resistances and inductances")); 
     2742        parameter Modelica.SIunits.Inductance La=0.0015 "armature inductance"  
     2743          annotation(Dialog(group="Nominal resistances and inductances")); 
    27162744      protected  
    27172745        constant Modelica.SIunits.Current IeNominal=1  
     
    28252853        extends Machines.Interfaces.PartialBasicDCMachine; 
    28262854        parameter Modelica.SIunits.Voltage VaNominal=100  
    2827           "|Nominal parameters|nominal armature voltage"; 
     2855          "nominal armature voltage"  
     2856          annotation(Dialog(group="Nominal parameters")); 
    28282857        parameter Modelica.SIunits.Current IaNominal=100  
    2829           "|Nominal parameters|nominal armature current"; 
     2858          "nominal armature current"  
     2859          annotation(Dialog(group="Nominal parameters")); 
    28302860        parameter Modelica.SIunits.Conversions.NonSIunits.AngularVelocity_rpm  
    2831           rpmNominal =  1425 "|Nominal parameters|nominal speed"; 
     2861          rpmNominal =  1425 "nominal speed"  
     2862          annotation(Dialog(group="Nominal parameters")); 
    28322863        parameter Modelica.SIunits.Resistance Ra=0.05  
    2833           "|Nominal resistances and inductances|warm armature resistance"; 
    2834         parameter Modelica.SIunits.Inductance La=0.0015  
    2835           "|Nominal resistances and inductances|armature inductance"; 
     2864          "warm armature resistance"  
     2865          annotation(Dialog(group="Nominal resistances and inductances")); 
     2866        parameter Modelica.SIunits.Inductance La=0.0015 "armature inductance"  
     2867          annotation(Dialog(group="Nominal resistances and inductances")); 
    28362868        parameter Modelica.SIunits.Current IeNominal=1  
    2837           "|Excitation|nominal excitation current"; 
     2869          "nominal excitation current"  
     2870          annotation(Dialog(group="Excitation")); 
    28382871        parameter Modelica.SIunits.Resistance Re=100  
    2839           "|Excitation|warm field excitation resistance"; 
     2872          "warm field excitation resistance"  
     2873          annotation(Dialog(group="Excitation")); 
    28402874        parameter Modelica.SIunits.Inductance Le=1  
    2841           "|Excitation|total field excitation inductance"; 
     2875          "total field excitation inductance"  
     2876          annotation(Dialog(group="Excitation")); 
    28422877        output Modelica.SIunits.Voltage ve = pin_ep.v-pin_en.v  
    28432878          "Field excitation voltage"; 
     
    29753010        extends Machines.Interfaces.PartialBasicDCMachine; 
    29763011        parameter Modelica.SIunits.Voltage VaNominal=100  
    2977           "|Nominal parameters|nominal armature voltage"; 
     3012          "nominal armature voltage"  
     3013          annotation(Dialog(group="Nominal parameters")); 
    29783014        parameter Modelica.SIunits.Current IaNominal=100  
    2979           "|Nominal parameters|nominal armature current"; 
     3015          "nominal armature current"  
     3016          annotation(Dialog(group="Nominal parameters")); 
    29803017        parameter Modelica.SIunits.Conversions.NonSIunits.AngularVelocity_rpm  
    2981           rpmNominal =  1410 "|Nominal parameters|nominal speed"; 
     3018          rpmNominal =  1410 "nominal speed"  
     3019          annotation(Dialog(group="Nominal parameters")); 
    29823020        parameter Modelica.SIunits.Resistance Ra=0.05  
    2983           "|Nominal resistances and inductances|warm armature resistance"; 
    2984         parameter Modelica.SIunits.Inductance La=0.0015  
    2985           "|Nominal resistances and inductances|armature inductance"; 
     3021          "warm armature resistance"  
     3022          annotation(Dialog(group="Nominal resistances and inductances")); 
     3023        parameter Modelica.SIunits.Inductance La=0.0015 "armature inductance"  
     3024          annotation(Dialog(group="Nominal resistances and inductances")); 
    29863025        parameter Modelica.SIunits.Resistance Re=0.01  
    2987           "|Excitation|warm field excitation resistance"; 
     3026          "warm field excitation resistance"  
     3027          annotation(Dialog(group="Excitation")); 
    29883028        parameter Modelica.SIunits.Inductance Le=0.0005  
    2989           "|Excitation|total field excitation inductance"; 
     3029          "total field excitation inductance"  
     3030          annotation(Dialog(group="Excitation")); 
    29903031        output Modelica.SIunits.Voltage ve = pin_ep.v-pin_en.v  
    29913032          "Field excitation voltage";