Changeset 533

Show
Ignore:
Timestamp:
08/13/2007 07:44:10 PM (17 months ago)
Author:
AHaumer
Message:

improved documentation

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • Modelica/trunk/Modelica/Electrical/Machines.mo

    r514 r533  
    22  extends Modelica.Icons.Library2; 
    33  annotation ( 
    4   version="1.8.5", versionDate="2007-06-26", 
     4  version="1.8.6", versionDate="2007-08-12", 
    55  Settings(NewStateSelection=true, Evaluate=true), 
    66  preferedView="info", Documentation(info="<HTML> 
    … …  
    117117  <li> v1.8.5 2007/06/26 Anton Haumer<br> 
    118118       consistent parameters of DCSE</li> 
     119  <li> v1.8.6 2007/08/12 Anton Haumer<br> 
     120       improved documentation</li> 
    119121  </ul> 
    120122</HTML>"), 
    … …  
    11631165    model TransformerTestbench "Transformer Testbench"  
    11641166      extends Modelica.Icons.Example; 
    1165       parameter Modelica.SIunits.Resistance RL[3]=fill(1/3,3); 
     1167      parameter Modelica.SIunits.Resistance RL[3]=fill(1/3,3) "Load resistance"; 
    11661168      annotation (Documentation(info="<HTML> 
    11671169Transformer testbench:<br> 
    … …  
    12611263      constant Integer m=3 "Number of phases"; 
    12621264      parameter Modelica.SIunits.Voltage V=100*sqrt(2/3)  
    1263         "amplitude of star-voltage"; 
    1264       parameter Modelica.SIunits.Frequency f=50 "frequency"; 
    1265       parameter Modelica.SIunits.Resistance RL=0.4 "load resistance"; 
    1266       parameter Modelica.SIunits.Capacitance C=0.005 "total DC-capacitance"; 
    1267       parameter Modelica.SIunits.Voltage VC0=sqrt(3)*V; 
     1265        "Amplitude of star-voltage"; 
     1266      parameter Modelica.SIunits.Frequency f=50 "Frequency"; 
     1267      parameter Modelica.SIunits.Resistance RL=0.4 "Load resistance"; 
     1268      parameter Modelica.SIunits.Capacitance C=0.005 "Total DC-capacitance"; 
     1269      parameter Modelica.SIunits.Voltage VC0=sqrt(3)*V  
     1270        "Initial voltage of capacitance"; 
    12681271      annotation (Documentation(info="<HTML> 
    12691272Test example with multiphase components:<br> 
    … …  
    16351638      model TerminalBox "terminal box Y/D-connection"  
    16361639        constant Integer m=3 "number of phases"; 
    1637         parameter String StarDelta="Y"  
     1640        parameter String StarDelta="Y" "Choose Y=star/D=delta"  
    16381641          annotation(choices(choice="Y" "Star connection",choice="D"  
    16391642              "Delta connection")); 
    … …  
    31773180          Ellipse(extent=[-40,30; 80,-90], style(color=3, rgbcolor={0,0,255})))); 
    31783181       
    3179       model Transformer "transformer: choose connection/vector group"  
    3180         parameter Modelica.SIunits.Frequency f=50 "nominal frequency"; 
     3182      model Transformer "Transformer: choose connection/vector group"  
     3183        parameter Modelica.SIunits.Frequency f=50 "Nominal frequency"; 
    31813184        parameter Modelica.SIunits.Voltage V1=100  
    3182           "primary nominal line-to-line voltage (RMS)"; 
     3185          "Primary nominal line-to-line voltage (RMS)"; 
    31833186        parameter Modelica.SIunits.Voltage V2=100  
    3184           "secondary open circuit line-to-line voltage (RMS) @ primary nominal voltage"; 
     3187          "Secondary open circuit line-to-line voltage (RMS) @ primary nominal voltage"; 
    31853188        parameter Modelica.SIunits.ApparentPower SNominal=30E3  
    3186           "nominal apparent power"; 
     3189          "Nominal apparent power"; 
    31873190        parameter Real v_sc(final min=0, final max=1)=0.05  
    3188           "impedance voltage drop pu"; 
     3191          "Impedance voltage drop pu"; 
    31893192        parameter Modelica.SIunits.Power P_sc=300  
    3190           "short-circuit (copper) losses"; 
     3193          "Short-circuit (copper) losses"; 
    31913194        extends transformer(final n=V1/V2, 
    31923195          final R1=R1ph, final L1sigma=L1ph, 
    … …  
    31953198            Machines.BasicMachines.Transformers.Yy.Yy00 extends  
    31963199          Machines.BasicMachines.Components.BasicTransformer  
    3197           annotation (choicesFromPackage=true, choicesAllMatching=true); 
     3200          "Replaceable transformer model"  
     3201          annotation (choicesFromPackage=true, choicesAllMatching=true,  
     3202          Documentation(info="<html> 
     3203Replaceable transformer model for user's convenience 
     3204</html>")); 
    31983205      protected  
    31993206        parameter Modelica.SIunits.Voltage V1ph = V1/(if C1=="D" then 1 else sqrt(3)); 
    … …  
    32073214        parameter Modelica.SIunits.Resistance R2ph= 0.5*P_sc/(3*I2ph^2); 
    32083215        parameter Modelica.SIunits.Inductance L2ph= sqrt(Z2ph^2-R2ph^2)/(2*Modelica.Constants.pi*f); 
    3209         annotation (Diagram); 
     3216        annotation (Diagram, Documentation(info="<html> 
     3217\"Supertransformer\": lets the user choose connection/vector group 
     3218</html>")); 
    32103219      end Transformer; 
    32113220       
    3212       package Yy "transformers: primary Y / secondary y"  
     3221      package Yy "Transformers: primary Y / secondary y"  
    32133222        extends Modelica.Icons.Library2; 
    32143223        annotation (Documentation(info="<HTML> 
    … …  
    32393248              string="Yy"))); 
    32403249         
    3241         model Yy00  
    3242           annotation (defaultComponentName="transformer"); 
     3250        model Yy00 "Transformer Yy0"  
     3251           
     3252          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     3253Transformer Yy0 
     3254</html>")); 
    32433255          extends Machines.BasicMachines.Components.BasicTransformer(final  
    32443256              VectorGroup =                                                            "Yy00"); 
    … …  
    32693281        end Yy00; 
    32703282         
    3271         model Yy02  
    3272           annotation (defaultComponentName="transformer"); 
     3283        model Yy02 "Transformer Yy2"  
     3284           
     3285          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     3286Transformer Yy2 
     3287</html>")); 
    32733288          extends Machines.BasicMachines.Components.BasicTransformer(final  
    32743289              VectorGroup =                                                            "Yy02"); 
    … …  
    33033318        end Yy02; 
    33043319         
    3305         model Yy04  
    3306           annotation (defaultComponentName="transformer"); 
     3320        model Yy04 "Transformer Yy4"  
     3321           
     3322          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     3323Transformer Yy4 
     3324</html>")); 
    33073325          extends Machines.BasicMachines.Components.BasicTransformer(final  
    33083326              VectorGroup =                                                            "Yy04"); 
    … …  
    33373355        end Yy04; 
    33383356         
    3339         model Yy06  
    3340           annotation (defaultComponentName="transformer"); 
     3357        model Yy06 "Transformer Yy6"  
     3358           
     3359          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     3360Transformer Yy6 
     3361</html>")); 
    33413362          extends Machines.BasicMachines.Components.BasicTransformer(final  
    33423363              VectorGroup =                                                            "Yy06"); 
    … …  
    33673388        end Yy06; 
    33683389         
    3369         model Yy08  
    3370           annotation (defaultComponentName="transformer"); 
     3390        model Yy08 "Transformer Yy8"  
     3391           
     3392          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     3393Transformer Yy8 
     3394</html>")); 
    33713395          extends Machines.BasicMachines.Components.BasicTransformer(final  
    33723396              VectorGroup =                                                            "Yy08"); 
    … …  
    34013425        end Yy08; 
    34023426         
    3403         model Yy10  
    3404           annotation (defaultComponentName="transformer"); 
     3427        model Yy10 "Transformer Yy10"  
     3428           
     3429          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     3430Transformer Yy10 
     3431</html>")); 
    34053432          extends Machines.BasicMachines.Components.BasicTransformer(final  
    34063433              VectorGroup =                                                            "Yy10"); 
    … …  
    34363463      end Yy; 
    34373464       
    3438       package Yd "transformers: primary Y / secondary d"  
     3465      package Yd "Transformers: primary Y / secondary d"  
    34393466        extends Modelica.Icons.Library2; 
    34403467        annotation (Documentation(info="<HTML> 
    … …  
    34653492              string="Yd"))); 
    34663493         
    3467         model Yd01  
    3468           annotation (defaultComponentName="transformer"); 
     3494        model Yd01 "Transformer Yd1"  
     3495           
     3496          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     3497Transformer Yd1 
     3498</html>")); 
    34693499          extends Machines.BasicMachines.Components.BasicTransformer(final  
    34703500              VectorGroup =                                                            "Yd01"); 
    … …  
    34933523        end Yd01; 
    34943524         
    3495         model Yd03  
    3496           annotation (defaultComponentName="transformer"); 
     3525        model Yd03 "Transformer Yd3"  
     3526           
     3527          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     3528Transformer Yd3 
     3529</html>")); 
    34973530          extends Machines.BasicMachines.Components.BasicTransformer(final  
    34983531              VectorGroup =                                                            "Yd03"); 
    … …  
    35253558        end Yd03; 
    35263559         
    3527         model Yd05  
    3528           annotation (defaultComponentName="transformer"); 
     3560        model Yd05 "Transformer Yd5"  
     3561           
     3562          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     3563Transformer Yd5 
     3564</html>")); 
    35293565          extends Machines.BasicMachines.Components.BasicTransformer(final  
    35303566              VectorGroup =                                                            "Yd05"); 
    … …  
    35533589        end Yd05; 
    35543590         
    3555         model Yd07  
    3556           annotation (defaultComponentName="transformer"); 
     3591        model Yd07 "Transformer Yd7"  
     3592           
     3593          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     3594Transformer Yd7 
     3595</html>")); 
    35573596          extends Machines.BasicMachines.Components.BasicTransformer(final  
    35583597              VectorGroup =                                                            "Yd07"); 
    … …  
    35813620        end Yd07; 
    35823621         
    3583         model Yd09  
    3584           annotation (defaultComponentName="transformer"); 
     3622        model Yd09 "Transformer Yd9"  
     3623           
     3624          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     3625Transformer Yd9 
     3626</html>")); 
    35853627          extends Machines.BasicMachines.Components.BasicTransformer(final  
    35863628              VectorGroup =                                                            "Yd09"); 
    … …  
    36133655        end Yd09; 
    36143656         
    3615         model Yd11  
    3616           annotation (defaultComponentName="transformer"); 
     3657        model Yd11 "Transformer Yd11"  
     3658           
     3659          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     3660Transformer Yd11 
     3661</html>")); 
    36173662          extends Machines.BasicMachines.Components.BasicTransformer(final  
    36183663              VectorGroup =                                                            "Yd11"); 
    … …  
    36423687      end Yd; 
    36433688       
    3644       package Yz "transformers: primary Y / secondary zig-zag"  
     3689      package Yz "Transformers: primary Y / secondary zig-zag"  
    36453690        extends Modelica.Icons.Library2; 
    36463691        annotation (Documentation(info="<HTML> 
    … …  
    36713716              string="Yz"))); 
    36723717         
    3673         model Yz01  
    3674           annotation (defaultComponentName="transformer"); 
     3718        model Yz01 "Transformer Yz1"  
     3719           
     3720          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     3721Transformer Yz1 
     3722</html>")); 
    36753723          extends Machines.BasicMachines.Components.BasicTransformer(final  
    36763724              VectorGroup =                                                            "Yz01"); 
    … …  
    37083756        end Yz01; 
    37093757         
    3710         model Yz03  
    3711           annotation (defaultComponentName="transformer"); 
     3758        model Yz03 "Transformer Yz3"  
     3759           
     3760          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     3761Transformer Yz3 
     3762</html>")); 
    37123763          extends Machines.BasicMachines.Components.BasicTransformer(final  
    37133764              VectorGroup =                                                            "Yz03"); 
    … …  
    37463797        end Yz03; 
    37473798         
    3748         model Yz05  
    3749           annotation (defaultComponentName="transformer"); 
     3799        model Yz05 "Transformer Yz5"  
     3800           
     3801          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     3802Transformer Yz5 
     3803</html>")); 
    37503804          extends Machines.BasicMachines.Components.BasicTransformer(final  
    37513805              VectorGroup =                                                            "Yz05"); 
    … …  
    37803834        end Yz05; 
    37813835         
    3782         model Yz07  
    3783           annotation (defaultComponentName="transformer"); 
     3836        model Yz07 "Transformer Yz7"  
     3837           
     3838          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     3839Transformer Yz7 
     3840</html>")); 
    37843841          extends Machines.BasicMachines.Components.BasicTransformer(final  
    37853842              VectorGroup =                                                            "Yz07"); 
    … …  
    38143871        end Yz07; 
    38153872         
    3816         model Yz09  
    3817           annotation (defaultComponentName="transformer"); 
     3873        model Yz09 "Transformer Yz9"  
     3874           
     3875          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     3876Transformer Yz9 
     3877</html>")); 
    38183878          extends Machines.BasicMachines.Components.BasicTransformer(final  
    38193879              VectorGroup =                                                            "Yz09"); 
    … …  
    38523912        end Yz09; 
    38533913         
    3854         model Yz11  
    3855           annotation (defaultComponentName="transformer"); 
     3914        model Yz11 "Transformer Yz11"  
     3915           
     3916          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     3917Transformer Yz11 
     3918</html>")); 
    38563919          extends Machines.BasicMachines.Components.BasicTransformer(final  
    38573920              VectorGroup =                                                            "Yz11"); 
    … …  
    38913954      end Yz; 
    38923955       
    3893       package Dy "transformers: primary D / secondary y"  
     3956      package Dy "Transformers: primary D / secondary y"  
    38943957        extends Modelica.Icons.Library2; 
    38953958        annotation (Documentation(info="<HTML> 
    … …  
    39203983              string="Dy"))); 
    39213984         
    3922         model Dy01  
    3923           annotation (defaultComponentName="transformer"); 
     3985        model Dy01 "Transformer Dy1"  
     3986           
     3987          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     3988Transformer Dy1 
     3989</html>")); 
    39243990          extends Machines.BasicMachines.Components.BasicTransformer(final  
    39253991              VectorGroup =                                                            "Dy01"); 
    … …  
    39524018        end Dy01; 
    39534019         
    3954         model Dy03  
    3955           annotation (defaultComponentName="transformer"); 
     4020        model Dy03 "Transformer Dy3"  
     4021           
     4022          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     4023Transformer Dy3 
     4024</html>")); 
    39564025          extends Machines.BasicMachines.Components.BasicTransformer(final  
    39574026              VectorGroup =                                                            "Dy03"); 
    … …  
    39844053        end Dy03; 
    39854054         
    3986         model Dy05  
    3987           annotation (defaultComponentName="transformer"); 
     4055        model Dy05 "Transformer Dy5"  
     4056           
     4057          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     4058Transformer Dy5 
     4059</html>")); 
    39884060          extends Machines.BasicMachines.Components.BasicTransformer(final  
    39894061              VectorGroup =                                                            "Dy05"); 
    … …  
    40124084        end Dy05; 
    40134085         
    4014         model Dy07  
    4015           annotation (defaultComponentName="transformer"); 
     4086        model Dy07 "Transformer Dy7"  
     4087           
     4088          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     4089Transformer Dy7 
     4090</html>")); 
    40164091          extends Machines.BasicMachines.Components.BasicTransformer(final  
    40174092              VectorGroup =                                                            "Dy07"); 
    … …  
    40444119        end Dy07; 
    40454120         
    4046         model Dy09  
    4047           annotation (defaultComponentName="transformer"); 
     4121        model Dy09 "Transformer Dy9"  
     4122           
     4123          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     4124Transformer Dy9 
     4125</html>")); 
    40484126          extends Machines.BasicMachines.Components.BasicTransformer(final  
    40494127              VectorGroup =                                                            "Dy09"); 
    … …  
    40764154        end Dy09; 
    40774155         
    4078         model Dy11  
    4079           annotation (defaultComponentName="transformer"); 
     4156        model Dy11 "Transformer Dy11"  
     4157           
     4158          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     4159Transformer Dy11 
     4160</html>")); 
    40804161          extends Machines.BasicMachines.Components.BasicTransformer(final  
    40814162              VectorGroup =                                                            "Dy11"); 
    … …  
    41054186      end Dy; 
    41064187       
    4107       package Dd "transformers: primary D / secondary d"  
     4188      package Dd "Transformers: primary D / secondary d"  
    41084189        extends Modelica.Icons.Library2; 
    41094190        annotation (Documentation(info="<HTML> 
    … …  
    41344215              string="Dd"))); 
    41354216         
    4136         model Dd00  
    4137           annotation (defaultComponentName="transformer"); 
     4217        model Dd00 "Transformer Dd0"  
     4218           
     4219          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     4220Transformer Dd0 
     4221</html>")); 
    41384222          extends Machines.BasicMachines.Components.BasicTransformer(final  
    41394223              VectorGroup =                                                            "Dd00"); 
    … …  
    41604244        end Dd00; 
    41614245         
    4162         model Dd02  
    4163           annotation (defaultComponentName="transformer"); 
     4246        model Dd02 "Transformer Dd2"  
     4247           
     4248          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     4249Transformer Dd2 
     4250</html>")); 
    41644251          extends Machines.BasicMachines.Components.BasicTransformer(final  
    41654252              VectorGroup =                                                            "Dd02"); 
    … …  
    41904277        end Dd02; 
    41914278         
    4192         model Dd04  
    4193           annotation (defaultComponentName="transformer"); 
     4279        model Dd04 "Transformer Dd4"  
     4280           
     4281          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     4282Transformer Dd4 
     4283</html>")); 
    41944284          extends Machines.BasicMachines.Components.BasicTransformer(final  
    41954285              VectorGroup =                                                            "Dd04"); 
    … …  
    42164306        end Dd04; 
    42174307         
    4218         model Dd06  
    4219           annotation (defaultComponentName="transformer"); 
     4308        model Dd06 "Transformer Dd6"  
     4309           
     4310          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     4311Transformer Dd6 
     4312</html>")); 
    42204313          extends Machines.BasicMachines.Components.BasicTransformer(final  
    42214314              VectorGroup =                                                            "Dd06"); 
    … …  
    42424335        end Dd06; 
    42434336         
    4244         model Dd08  
    4245           annotation (defaultComponentName="transformer"); 
     4337        model Dd08 "Transformer Dd8"  
     4338           
     4339          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     4340Transformer Dd8 
     4341</html>")); 
    42464342          extends Machines.BasicMachines.Components.BasicTransformer(final  
    42474343              VectorGroup =                                                            "Dd08"); 
    … …  
    42724368        end Dd08; 
    42734369         
    4274         model Dd10  
    4275           annotation (defaultComponentName="transformer"); 
     4370        model Dd10 "Transformer Dd10"  
     4371           
     4372          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     4373Transformer Dd10 
     4374</html>")); 
    42764375          extends Machines.BasicMachines.Components.BasicTransformer(final  
    42774376              VectorGroup =                                                            "Dd10"); 
    … …  
    42994398      end Dd; 
    43004399       
    4301       package Dz "transformers: primary D / secondary ziag-zag"  
     4400      package Dz "Transformers: primary D / secondary ziag-zag"  
    43024401        extends Modelica.Icons.Library2; 
    43034402        annotation (Documentation(info="<HTML> 
    … …  
    43284427              string="Dz"))); 
    43294428         
    4330         model Dz00  
    4331           annotation (defaultComponentName="transformer"); 
     4429        model Dz00 "Transformer Dz0"  
     4430           
     4431          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     4432Transformer Dz0 
     4433</html>")); 
    43324434          extends Machines.BasicMachines.Components.BasicTransformer(final  
    43334435              VectorGroup =                                                            "Dz00"); 
    … …  
    43644466        end Dz00; 
    43654467         
    4366         model Dz02  
    4367           annotation (defaultComponentName="transformer"); 
     4468        model Dz02 "Transformer Dz2"  
     4469           
     4470          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     4471Transformer Dz2 
     4472</html>")); 
    43684473          extends Machines.BasicMachines.Components.BasicTransformer(final  
    43694474              VectorGroup =                                                            "Dz02"); 
    … …  
    44004505        end Dz02; 
    44014506         
    4402         model Dz04  
    4403           annotation (defaultComponentName="transformer"); 
     4507        model Dz04 "Transformer Dz4"  
     4508           
     4509          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     4510Transformer Dz4 
     4511</html>")); 
    44044512          extends Machines.BasicMachines.Components.BasicTransformer(final  
    44054513              VectorGroup =                                                            "Dz04"); 
    … …  
    44324540        end Dz04; 
    44334541         
    4434         model Dz06  
    4435           annotation (defaultComponentName="transformer"); 
     4542        model Dz06 "Transformer Dz6"  
     4543           
     4544          annotation (defaultComponentName="transformer", Documentation(info="<html> 
     4545Transformer Dz6 
     4546</html>")); 
    44364547          extends Machines.BasicMachines.Components.BasicTransformer(final  
    44374548              VectorGroup =                                                            "Dz06"); 
    â€