Changeset 580

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

improved documentation

Files:
1 modified

Legend:

Unmodified
Added
Removed
  • Modelica/trunk/Modelica/Electrical/Machines.mo

    r578 r580  
    1 within Modelica.Electrical; 
    21package Machines "Library for electric machines"  
    32  extends Modelica.Icons.Library2; 
    43  annotation ( 
    5   version="1.8.7", versionDate="2007-08-20", 
     4  version="1.8.8", versionDate="2007-08-20", 
    65  Settings(NewStateSelection=true, Evaluate=true), 
    76  preferedView="info", Documentation(info="<HTML> 
     
    122121  <li> v1.8.7 2007/08/20 Anton Haumer<br> 
    123122       corrected typo in documentation</li> 
     123  <li> v1.8.8 2007/08/20 Anton Haumer<br> 
     124       improved documentation</li> 
    124125  </ul> 
    125126</HTML>"), 
     
    18371838        extends Machines.BasicMachines.Components.BasicAIM(airGapS(final Lm=Lm)); 
    18381839        parameter Modelica.SIunits.Inductance Lm=3*sqrt(1 - 0.0667)/(2*pi*fNominal)  
    1839           "|Nominal resistances and inductances|main field inductance"; 
     1840          "main field inductance"  
     1841           annotation(Dialog(group="Nominal resistances and inductances")); 
    18401842        parameter Modelica.SIunits.Inductance Lrsigma=3*(1 - sqrt(1 - 0.0667))/(2*pi*fNominal)  
    1841           "|Nominal resistances and inductances|rotor stray inductance (equivalent three phase winding)"; 
     1843          "rotor stray inductance (equivalent three phase winding)"  
     1844           annotation(Dialog(group="Nominal resistances and inductances")); 
    18421845        parameter Modelica.SIunits.Resistance Rr=0.04  
    1843           "|Nominal resistances and inductances|warm rotor resistance (equivalent three phase winding)"; 
     1846          "warm rotor resistance (equivalent three phase winding)"  
     1847           annotation(Dialog(group="Nominal resistances and inductances")); 
    18441848        Machines.BasicMachines.Components.SquirrelCage squirrelCageR(final  
    18451849            Lrsigma =                                                              Lrsigma, final Rr=Rr)  
     
    19411945        extends Machines.BasicMachines.Components.BasicAIM(airGapS(final Lm=Lm)); 
    19421946        parameter Modelica.SIunits.Inductance Lm=3*sqrt(1 - 0.0667)/(2*pi*fNominal)  
    1943           "|Nominal resistances and inductances|main field inductance"; 
     1947          "main field inductance"  
     1948           annotation(Dialog(group="Nominal resistances and inductances")); 
    19441949        parameter Modelica.SIunits.Inductance Lrsigma=3*(1 - sqrt(1 - 0.0667))/(2*pi* 
    1945             fNominal)  
    1946           "|Nominal resistances and inductances|rotor stray inductance per phase"; 
     1950            fNominal) "rotor stray inductance per phase"  
     1951           annotation(Dialog(group="Nominal resistances and inductances")); 
    19471952        parameter Modelica.SIunits.Resistance Rr=0.04  
    1948           "|Nominal resistances and inductances|warm rotor resistance per phase"; 
     1953          "warm rotor resistance per phase"  
     1954           annotation(Dialog(group="Nominal resistances and inductances")); 
    19491955        parameter Boolean useTurnsRatio=true  
    19501956          "use TurnsRatio or calculate from locked-rotor voltage?"; 
     
    21912197              final Lmq=Lmq)); 
    21922198        parameter Modelica.SIunits.Voltage V0=112.3  
    2193           "|Excitation|no-load RMS voltage per phase @ fNominal"; 
     2199          "no-load RMS voltage per phase @ fNominal"  
     2200           annotation(Dialog(group="Excitation")); 
    21942201        parameter Modelica.SIunits.Inductance Lmd=0.3/(2*pi*fNominal)  
    2195           "|Nominal resistances and inductances|main field inductance in d-axis"; 
     2202          "main field inductance in d-axis"  
     2203           annotation(Dialog(group="Nominal resistances and inductances")); 
    21962204        parameter Modelica.SIunits.Inductance Lmq=0.3/(2*pi*fNominal)  
    2197           "|Nominal resistances and inductances|main field inductance in q-axis"; 
     2205          "main field inductance in q-axis"  
     2206           annotation(Dialog(group="Nominal resistances and inductances")); 
    21982207        parameter Boolean DamperCage = true "damper cage is present?"  
    21992208          annotation(Dialog(group = "DamperCage")); 
     
    23732382              final Lmq=Lmq)); 
    23742383        parameter Modelica.SIunits.Inductance Lmd=1.5/(2*pi*fNominal)  
    2375           "|Nominal resistances and inductances|main field inductance in d-axis"; 
     2384          "main field inductance in d-axis"  
     2385           annotation(Dialog(group="Nominal resistances and inductances")); 
    23762386        parameter Modelica.SIunits.Inductance Lmq=1.5/(2*pi*fNominal)  
    2377           "|Nominal resistances and inductances|main field inductance in q-axis"; 
     2387          "main field inductance in q-axis"  
     2388           annotation(Dialog(group="Nominal resistances and inductances")); 
    23782389        parameter Boolean DamperCage = true "damper cage is present?"  
    23792390          annotation(Dialog(group = "DamperCage")); 
     
    23912402          annotation(Dialog(group = "DamperCage", enable = DamperCage)); 
    23922403        parameter Modelica.SIunits.Voltage VNominal=100  
    2393           "|Excitation|nominal stator RMS voltage per phase"; 
    2394         parameter Modelica.SIunits.Frequency fNominal=50  
    2395           "|Excitation|nominal frequency"; 
     2404          "nominal stator RMS voltage per phase"  
     2405           annotation(Dialog(group="Excitation")); 
     2406        parameter Modelica.SIunits.Frequency fNominal=50 "nominal frequency"  
     2407           annotation(Dialog(group="Excitation")); 
    23962408        parameter Modelica.SIunits.Current Ie0=10  
    2397           "|Excitation|no-load excitation current @ nominal voltage and frequency"; 
     2409          "no-load excitation current @ nominal voltage and frequency"  
     2410           annotation(Dialog(group="Excitation")); 
    23982411        parameter Modelica.SIunits.Resistance Re=2.5  
    2399           "|Excitation|warm excitation resistance"; 
     2412          "warm excitation resistance"  
     2413           annotation(Dialog(group="Excitation")); 
    24002414        parameter Real sigmae(min=0, max=1)=0.025  
    2401           "|Excitation|stray fraction of total excitation inductance"; 
     2415          "stray fraction of total excitation inductance"  
     2416           annotation(Dialog(group="Excitation")); 
    24022417        output Modelica.SIunits.Current idq_dr[2](each stateSelect=StateSelect.prefer)= 
    24032418          damperCage.spacePhasor_r.i_ if DamperCage  
     
    25992614              final Lmq=Lmq)); 
    26002615        parameter Modelica.SIunits.Inductance Lmd=2.9/(2*pi*fNominal)  
    2601           "|Nominal resistances and inductances|main field inductance in d-axis"; 
     2616          "main field inductance in d-axis"  
     2617           annotation(Dialog(group="Nominal resistances and inductances")); 
    26022618        parameter Modelica.SIunits.Inductance Lmq=0.9/(2*pi*fNominal)  
    2603           "|Nominal resistances and inductances|main field inductance in q-axis"; 
     2619          "main field inductance in q-axis"  
     2620           annotation(Dialog(group="Nominal resistances and inductances")); 
    26042621        parameter Boolean DamperCage = true "damper cage is present?"  
    26052622          annotation(Dialog(group = "DamperCage")); 
     
    27972814      protected  
    27982815        final parameter Modelica.SIunits.Inductance Le=1  
    2799           "|Excitation|total field excitation inductance"; 
     2816          "total field excitation inductance"  
     2817           annotation(Dialog(group="Excitation")); 
    28002818        constant Modelica.SIunits.Current IeNominal=1  
    28012819          "equivalent excitation current"; 
     
    28842902            airGapDC(final Le=Le)); 
    28852903        parameter Modelica.SIunits.Current IeNominal=1  
    2886           "|Excitation|nominal excitation current"; 
     2904          "nominal excitation current"  
     2905           annotation(Dialog(group="Excitation")); 
    28872906        parameter Modelica.SIunits.Resistance Re=100  
    2888           "|Excitation|warm field excitation resistance"; 
     2907          "warm field excitation resistance"  
     2908           annotation(Dialog(group="Excitation")); 
    28892909        parameter Modelica.SIunits.Inductance Le=1  
    2890           "|Excitation|total field excitation inductance"; 
     2910          "total field excitation inductance"  
     2911           annotation(Dialog(group="Excitation")); 
    28912912        output Modelica.SIunits.Voltage ve = pin_ep.v-pin_en.v  
    28922913          "Field excitation voltage"; 
     
    30013022          airGapDC(final Le=Le)); 
    30023023        parameter Modelica.SIunits.Resistance Re=0.01  
    3003           "|Excitation|warm field excitation resistance"; 
     3024          "warm field excitation resistance"  
     3025           annotation(Dialog(group="Excitation")); 
    30043026        parameter Modelica.SIunits.Inductance Le=0.0005  
    3005           "|Excitation|total field excitation inductance"; 
     3027          "total field excitation inductance"  
     3028           annotation(Dialog(group="Excitation")); 
    30063029        output Modelica.SIunits.Voltage ve = pin_ep.v-pin_en.v  
    30073030          "Field excitation voltage"; 
     
    47004723        parameter Modelica.SIunits.Frequency fNominal=50 "nominal frequency"; 
    47014724        parameter Modelica.SIunits.Resistance Rs=0.03  
    4702           "|Nominal resistances and inductances|warm stator resistance per phase"; 
     4725          "warm stator resistance per phase"  
     4726           annotation(Dialog(group="Nominal resistances and inductances")); 
    47034727        parameter Modelica.SIunits.Inductance Lssigma=3*(1 - sqrt(1 - 0.0667))/(2*pi*fNominal)  
    4704           "|Nominal resistances and inductances|stator stray inductance per phase"; 
     4728          "stator stray inductance per phase"  
     4729           annotation(Dialog(group="Nominal resistances and inductances")); 
    47054730        output Modelica.SIunits.Voltage vs[m] = plug_sp.pin.v - plug_sn.pin.v  
    47064731          "stator instantaneous voltages"; 
     
    47844809        constant Integer m=3 "number of phases"; 
    47854810        parameter Integer p(min=1)=2 "number of pole pairs (Integer)"; 
    4786         parameter Modelica.SIunits.Frequency fNominal=50 "nominal frequency"; 
     4811        parameter Modelica.SIunits.Frequency fNominal=50 "nominal frequency"  
     4812          annotation(Dialog(group="Excitation")); 
    47874813        parameter Modelica.SIunits.Resistance Rs=0.03  
    4788           "|Nominal resistances and inductances|warm stator resistance per phase"; 
     4814          "warm stator resistance per phase"  
     4815           annotation(Dialog(group="Nominal resistances and inductances")); 
    47894816        parameter Modelica.SIunits.Inductance Lssigma=3*(1 - sqrt(1 - 0.0667))/(2*pi*fNominal)  
    4790           "|Nominal resistances and inductances|stator stray inductance per phase"; 
     4817          "stator stray inductance per phase"  
     4818           annotation(Dialog(group="Nominal resistances and inductances")); 
    47914819        output Modelica.SIunits.Voltage vs[m] = plug_sp.pin.v - plug_sn.pin.v  
    47924820          "stator instantaneous voltages"; 
     
    48394867            rgbfillColor={95,95,95}, 
    48404868            fillPattern=1)); 
    4841         connect(spacePhasorS.ground,spacePhasorS. zero) annotation (points=[-10,20; 
     4869        connect(spacePhasorS.ground,spacePhasorS. zero) annotation (points=[-10,20;  
    48424870              -10,14; -6.12303e-016,14; -6.12303e-016,20],     style( 
    48434871            color=3, 
     
    52155243        extends Interfaces.PartialBasicMachine(J_Rotor=0.15); 
    52165244        parameter Modelica.SIunits.Voltage VaNominal=100  
    5217           "|Nominal parameters|nominal armature voltage"; 
     5245          "nominal armature voltage"  
     5246           annotation(Dialog(group="Nominal parameters")); 
    52185247        parameter Modelica.SIunits.Current IaNominal=100  
    5219           "|Nominal parameters|nominal armature current"; 
     5248          "nominal armature current"  
     5249           annotation(Dialog(group="Nominal parameters")); 
    52205250        parameter Modelica.SIunits.Conversions.NonSIunits.AngularVelocity_rpm  
    5221           rpmNominal =  1425 "|Nominal parameters|nominal speed"; 
     5251          rpmNominal =  1425 "nominal speed"  
     5252           annotation(Dialog(group="Nominal parameters")); 
    52225253        parameter Modelica.SIunits.Resistance Ra=0.05  
    5223           "|Nominal resistances and inductances|warm armature resistance"; 
    5224         parameter Modelica.SIunits.Inductance La=0.0015  
    5225           "|Nominal resistances and inductances|armature inductance"; 
     5254          "warm armature resistance"  
     5255           annotation(Dialog(group="Nominal resistances and inductances")); 
     5256        parameter Modelica.SIunits.Inductance La=0.0015 "armature inductance"  
     5257           annotation(Dialog(group="Nominal resistances and inductances")); 
    52265258        parameter Real TurnsRatio  
    52275259          "Ratio of armature turns over number of turns of the excitation winding";