Changeset 1153 for branches/maintenance

Show
Ignore:
Timestamp:
07/24/08 10:05:06 (4 months ago)
Author:
dietmarw
Message:

Release notes updated: #93 fixed: arctan replaced by atan

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • branches/maintenance/2.2.2/Modelica/package.mo

    r1128 r1153  
    3434<a href=\"http://www.Modelica.org\">http://www.Modelica.org</a>. 
    3535It is also called <b>Modelica Standard Library</b>. 
    36 It provides model components in many domains that are based on  
     36It provides model components in many domains that are based on 
    3737standardized interface definitions. Some typical examples are shown 
    3838in the next figure: 
    3939</p> 
    40   
     40 
    4141<p> 
    4242<img src=\"../Images/UsersGuide/ModelicaLibraries.png\"> 
    4343</p> 
    44   
     44 
    4545<p> 
    4646For an introduction, have especially a look at: 
    … …  
    7777<i>This Modelica package is <b>free</b> software; it can be redistributed and/or modified 
    7878under the terms of the <b>Modelica license</b>, see the license conditions 
    79 and the accompanying <b>disclaimer</b>  
     79and the accompanying <b>disclaimer</b> 
    8080<a href=\"Modelica://Modelica.UsersGuide.ModelicaLicense\">here</a>.</i> 
    8181</p> 
    … …  
    8484 
    8585 
    86 package UsersGuide "User's Guide of Modelica library"  
    87    
     86package UsersGuide "User's Guide of Modelica library" 
     87 
    8888  annotation (DocumentationClass=true, Documentation(info="<html> 
    8989<p> 
    … …  
    9797</p> 
    9898<p> 
    99 This is a short <b>User's Guide</b> for  
     99This is a short <b>User's Guide</b> for 
    100100the overall library. Some of the main sublibraries have their own 
    101101User's Guides that can be accessed by the following links: 
    … …  
    105105<tr><td valign=\"top\"><a href=\"Modelica://Modelica.Electrical.Digital.UsersGuide\">Digital</a> 
    106106    </td> 
    107       <td valign=\"top\">Library for digital electrical components based on the VHDL standard  
     107      <td valign=\"top\">Library for digital electrical components based on the VHDL standard 
    108108         (2-,3-,4-,9-valued logic)</td> 
    109109  </tr> 
    … …  
    139139 
    140140</html>")); 
    141    
    142   class Overview "Overview of Modelica Library"  
    143      
     141 
     142  class Overview "Overview of Modelica Library" 
     143 
    144144    annotation (Documentation(info="<html> 
    145145<p> 
    … …  
    151151<tr><th>Library Components</th> <th>Description</th></tr> 
    152152 
    153 <tr><td valign=\"top\">  
     153<tr><td valign=\"top\"> 
    154154    <img src=\"../Images/UsersGuide/Lib-Electrical.png\"> 
    155155    </td> 
    156156    <td valign=\"top\"> 
    157157    <a href=\"Modelica://Modelica.Electrical.Analog\">Analog</a><br> 
    158     Analog electric and electronic components, such as <br>  
     158    Analog electric and electronic components, such as <br> 
    159159    resistor, capacitor, transformers, diodes, transistors,<br> 
    160160    transmission lines, switches, sources, sensors. 
    … …  
    162162</tr> 
    163163 
    164 <tr><td valign=\"top\">  
     164<tr><td valign=\"top\"> 
    165165    <img src=\"../Images/UsersGuide/Lib-Digital.png\"> 
    166166    </td> 
    … …  
    173173</tr> 
    174174 
    175 <tr><td valign=\"top\">  
     175<tr><td valign=\"top\"> 
    176176    <img src=\"../Images/UsersGuide/Lib-Machines.png\"> 
    177177    </td> 
    … …  
    183183</tr> 
    184184 
    185 <tr><td valign=\"top\">  
     185<tr><td valign=\"top\"> 
    186186    <img src=\"../Images/UsersGuide/Lib-Translational.png\"> 
    187187    </td> 
    … …  
    193193</tr> 
    194194 
    195 <tr><td valign=\"top\">  
     195<tr><td valign=\"top\"> 
    196196    <img src=\"../Images/UsersGuide/Lib-Rotational.png\"> 
    197197    </td> 
    … …  
    204204</tr> 
    205205 
    206 <tr><td valign=\"top\">  
     206<tr><td valign=\"top\"> 
    207207    <img src=\"../Images/UsersGuide/Lib-MultiBody1.png\"><br> 
    208208    <img src=\"../Images/UsersGuide/Lib-MultiBody2.png\"> 
    … …  
    218218</tr> 
    219219 
    220 <tr><td valign=\"top\">  
     220<tr><td valign=\"top\"> 
    221221    <img src=\"../Images/UsersGuide/Lib-Media.png\"> 
    222222    </td> 
    … …  
    236236</tr> 
    237237 
    238 <tr><td valign=\"top\">  
     238<tr><td valign=\"top\"> 
    239239    <img src=\"../Images/UsersGuide/Lib-Thermal.png\"> 
    240240    </td> 
    241241    <td valign=\"top\"> 
    242     <a href=\"Modelica://Modelica.Thermal.FluidHeatFlow\">FluidHeatFlow</a>,  
     242    <a href=\"Modelica://Modelica.Thermal.FluidHeatFlow\">FluidHeatFlow</a>, 
    243243    <a href=\"Modelica://Modelica.Thermal.HeatTransfer\">HeatTransfer</a><br> 
    244244    Simple thermo-fluid pipe flow, especially to model cooling of machines <br> 
    … …  
    249249</tr> 
    250250 
    251 <tr><td valign=\"top\">  
     251<tr><td valign=\"top\"> 
    252252    <img src=\"../Images/UsersGuide/Lib-Blocks1.png\"><br> 
    253253    <img src=\"../Images/UsersGuide/Lib-Blocks2.png\"> 
    … …  
    262262</tr> 
    263263 
    264 <tr><td valign=\"top\">  
     264<tr><td valign=\"top\"> 
    265265    <img src=\"../Images/UsersGuide/Lib-StateGraph.png\"> 
    266266    </td> 
    … …  
    274274 
    275275 
    276 <tr><td valign=\"top\">  
     276<tr><td valign=\"top\"> 
    277277    <pre> 
    278     A = [1,2,3;  
     278    A = [1,2,3; 
    279279         3,4,5; 
    280280         2,1,4]; 
    281281    b = {10,22,12}; 
    282     x = Matrices.solve(A,b);  
    283     Matrices.eigenValues(A);  
     282    x = Matrices.solve(A,b); 
     283    Matrices.eigenValues(A); 
    284284    </pre> 
    285285    </td> 
    286286    <td valign=\"top\"> 
    287     <a href=\"Modelica://Modelica.Math\">Math</a>,  
     287    <a href=\"Modelica://Modelica.Math\">Math</a>, 
    288288    <a href=\"Modelica://Modelica.Utilities\">Utilities</a><br> 
    289289    Functions operating on vectors and matrices, such as for solving <br> 
    … …  
    299299")); 
    300300  end Overview; 
    301    
    302   class Connectors "Connectors"  
    303      
     301 
     302  class Connectors "Connectors" 
     303 
    304304    annotation (Documentation(info="<html> 
    305305 
    306306<p> 
    307 The Modelica standard library defines the most important  
    308 <b>elementary connectors</b> in various domains. If any possible,  
     307The Modelica standard library defines the most important 
     308<b>elementary connectors</b> in various domains. If any possible, 
    309309a user should utilize these connectors in order that components 
    310310from the Modelica Standard Library and from other libraries 
    … …  
    314314that have the flow attribute): 
    315315</p> 
    316   
     316 
    317317<table border=1 cellspacing=0 cellpadding=1> 
    318318  <tr><td valign=\"top\"><b>domain</b></td> 
    … …  
    321321      <td valign=\"top\"><b>connector definition</b></td> 
    322322      <td valign=\"top\"><b>icons</b></td></tr> 
    323   
     323 
    324324  <tr><td valign=\"top\"><b>electrical<br>analog</b></td> 
    325325      <td valign=\"top\">electrical potential</td> 
    … …  
    334334           <br>Plug, PositivePlug, NegativePlug</td> 
    335335      <td valign=\"top\"><img src=\"../Images/UsersGuide/ElectricalPlugs.png\"></td></tr> 
    336    
     336 
    337337  <tr><td valign=\"top\"><b>electrical <br>sphace phasor</b></td> 
    338338      <td valign=\"top\">2 electrical potentials</td> 
    … …  
    341341           <br>SpacePhasor</td> 
    342342      <td valign=\"top\"><img src=\"../Images/UsersGuide/SpacePhasor.png\"></td></tr> 
    343    
     343 
    344344  <tr><td valign=\"top\"><b>electrical <br>digital</b></td> 
    345345      <td valign=\"top\">Integer (1..9)</td> 
    … …  
    348348           <br>DigitalSignal, DigitalInput, DigitalOutput</td> 
    349349      <td valign=\"top\"><img src=\"../Images/UsersGuide/Digital.png\"></td></tr> 
    350    
     350 
    351351  <tr><td valign=\"top\"><b>translational</b></td> 
    352352      <td valign=\"top\">distance</td> 
    … …  
    355355           <br>Flange_a, Flange_b</td> 
    356356      <td valign=\"top\"><img src=\"../Images/UsersGuide/TranslationalFlanges.png\"></td></tr> 
    357   
     357 
    358358  <tr><td valign=\"top\"><b>rotational</b></td> 
    359359      <td valign=\"top\">angle</td> 
    … …  
    387387           <br>HeatPort, HeatPort_a, HeatPort_b</td> 
    388388      <td valign=\"top\"><img src=\"../Images/UsersGuide/ThermalHeatPorts.png\"></td></tr> 
    389   
     389 
    390390  <tr><td valign=\"top\"><b>block<br>diagram</b></td> 
    391391      <td valign=\"top\">Real variable<br> 
    … …  
    408408      <td valign=\"top\"><img src=\"../Images/UsersGuide/StateGraphPorts.png\"></td></tr> 
    409409 
    410   <tr><td colspan=\"5\">&nbsp;<br><b>Connectors from libraries that will be included in one of  
     410  <tr><td colspan=\"5\">&nbsp;<br><b>Connectors from libraries that will be included in one of 
    411411                                   the next releases of package Modelica</b></td></tr> 
    412412 
    … …  
    455455 
    456456<p> 
    457 Modelica supports also hierarchical connectors, in a similar way as hierarchical models.  
    458 As a result, it is, e.g., possible, to collect elementary connectors together.  
     457Modelica supports also hierarchical connectors, in a similar way as hierarchical models. 
     458As a result, it is, e.g., possible, to collect elementary connectors together. 
    459459For example, an electrical plug consisting of two electrical pins can be defined as: 
    460460</p> 
    … …  
    468468 
    469469<p> 
    470 With one connect(..) equation, either two plugs can be connected  
    471 (and therefore implicitly also the phase and ground pins) or a  
    472 Pin connector can be directly connected to the phase or ground of  
     470With one connect(..) equation, either two plugs can be connected 
     471(and therefore implicitly also the phase and ground pins) or a 
     472Pin connector can be directly connected to the phase or ground of 
    473473a Plug connector, such as \"connect(resistor.p, plug.phase)\". 
    474474</p> 
    … …  
    478478")); 
    479479  end Connectors; 
    480    
    481   class Conventions "Conventions"  
    482      
     480 
     481  class Conventions "Conventions" 
     482 
    483483    annotation (Documentation(info="<html> 
    484484 
    485485<p> 
    486 Note, in the html documentation of any Modelica library,  
     486Note, in the html documentation of any Modelica library, 
    487487the headings \"h1, h2, h3\" should not be used, 
    488488because they are utilized from the automatically generated documentation/headings. 
    … …  
    502502 
    503503<li> <b>Instance names</b>, i.e., names of component instances and 
    504      of variables (with the exception of constants),  
     504     of variables (with the exception of constants), 
    505505     start usually with a lower case letter with only 
    506      a few exceptions if this is common sense  
     506     a few exceptions if this is common sense 
    507507     (such as \"T\" for a temperature variable).<br>&nbsp;</li> 
    508508 
    509509<li> <b>Constant names</b>, i.e., names of variables declared with the 
    510      \"constant\" prefix, follow the usual naming conventions  
    511      (= upper and lower case letters) and start usually with an  
     510     \"constant\" prefix, follow the usual naming conventions 
     511     (= upper and lower case letters) and start usually with an 
    512512     upper case letter, e.g. UniformGravity, SteadyState.<br>&nbsp;<li> 
    513513 
    … …  
    526526     <ul> 
    527527     <li><b>UsersGuide</b> containing an overall description of the library 
    528          and how to use it.</li>   
     528         and how to use it.</li> 
    529529     <li><b>Examples</b> containing models demonstrating the 
    530          usage of the library.</li>   
     530         usage of the library.</li> 
    531531     <li><b>Interfaces</b> containing connectors and partial 
    532          models.</li>   
     532         models.</li> 
    533533     <li><b>Types</b> containing type, enumeration and choice 
    534534         definitions.</li> 
    … …  
    555555</p> 
    556556 
    557 <pre>   <b>package</b>  Init \"Enumeration emulation\"  
     557<pre>   <b>package</b>  Init \"Enumeration emulation\" 
    558558      <b>extends</b>  Modelica.Icons.Enumeration; 
    559    
     559 
    560560      <b>constant</b>  Integer NoInit=1; 
    561561      <b>constant</b>  Integer InitializeStates=2; 
    562562      <b>constant</b>  Integer SteadyState=3; 
    563    
    564       <b>type</b>  Temp   
     563 
     564      <b>type</b>  Temp 
    565565         <b>extends</b>  Modelica.Icons.TypeInteger; 
    566566         <b>annotation</b>  (choices( 
    … …  
    576576")); 
    577577  end Conventions; 
    578    
    579   package ReleaseNotes "Release notes"  
    580   class Version_2_2_2_BugFixes "Version 2.2.2 with bug fixes"  
    581        
     578 
     579  package ReleaseNotes "Release notes" 
     580  class Version_2_2_2_BugFixes "Version 2.2.2 with bug fixes" 
     581 
    582582      annotation (Documentation(info="<html> 
    583583<p> 
    … …  
    589589that can lead to wrong simulation results): 
    590590</p> 
    591   
     591 
    592592<table border=\"1\" cellspacing=0 cellpadding=2 style=\"border-collapse:collapse;\"> 
    593593  <tr><td colspan=\"2\"><b>Mechanics.MultiBody.Parts</b></td></tr> 
    594594  <tr><td valign=\"top\"> Rotor1D </td> 
    595       <td valign=\"top\"> The 3D reaction torque was not completely correct and gave in  
     595      <td valign=\"top\"> The 3D reaction torque was not completely correct and gave in 
    596596                        some situations a wrong result. This bug should not influence the 
    597597                        movement of a multi-body system, but only the constraint torques 
    598                         are sometimes not correct. </td>  
     598                        are sometimes not correct. </td> 
    599599  </tr> 
    600600 
    … …  
    607607      <td valign=\"top\"> Speed used in torque calculation was der(flange.phi) and not 
    608608                        the speed relative to the bearing<br> (= der(flange.phi) - der(bearing.phi)). 
    609                         This was corrected. This bug leads to wrong simulation results,<br>  
    610                         when the bearing is not fixed to ground </td>  
     609                        This was corrected. This bug leads to wrong simulation results,<br> 
     610                        when the bearing is not fixed to ground </td> 
    611611  </tr> 
    612612  <tr><td valign=\"top\"> Backlash </td> 
    613613      <td valign=\"top\"> If parameter phi_rel0 is not zero, the equations have been wrong. 
    614                         This bug has been fixed.  </td>  
     614                        This bug has been fixed.  </td> 
    615615  </tr> 
    616616 
    617617</table> 
    618   
    619   
     618 
     619 
    620620<p><br> 
    621621The following <b style=\"color:red\">uncritical errors</b> have been fixed (i.e. errors 
    622 that do <b style=\"color:red\">not</b> lead to wrong simulation results, but, e.g.,  
     622that do <b style=\"color:red\">not</b> lead to wrong simulation results, but, e.g., 
    623623units are wrong or errors in documentation): 
    624624</p> 
    625   
     625 
    626626<table border=\"1\" cellspacing=0 cellpadding=2 style=\"border-collapse:collapse;\"> 
    627627  <tr><td colspan=\"2\"><b>Blocks.Sources.</b></td></tr> 
    628628  <tr><td valign=\"top\"> CombiTimeTable</td> 
    629       <td valign=\"top\"> \"model\" changed to \"block\"</td>  
     629      <td valign=\"top\"> \"model\" changed to \"block\"</td> 
    630630  </tr> 
    631631 
    632632  <tr><td colspan=\"2\"><b>Blocks.Tables.</b></td></tr> 
    633633  <tr><td valign=\"top\"> CombiTable2D</td> 
    634       <td valign=\"top\"> Documentation improved and \"model\" changed to \"block\"</td>  
    635   </tr> 
    636  
     634      <td valign=\"top\"> Documentation improved and \"model\" changed to \"block\"</td> 
     635  </tr> 
     636 <tr><td colspan=\"2\"><b>Electrical.Analog.Basic.</b></td></tr> 
     637  <tr><td valign=\"top\"> SaturatingInductor</td> 
     638      <td valign=\"top\"> Replaced non-standard \"arctan\" by \"atan\" function.</td> 
     639  </tr> 
    637640  <tr><td colspan=\"2\"><b>Math.Matrices.</b></td></tr> 
    638641  <tr><td valign=\"top\"> eigenvalues<br> 
    … …  
    640643                        singularValues</td> 
    641644      <td valign=\"top\"> Matrices with zero dimensions lead to a crash. 
    642                         This has been fixed. </td>  
     645                        This has been fixed. </td> 
    643646  </tr> 
    644647 
    645648  <tr><td colspan=\"2\"><b>Mechanics.MultiBody</b></td></tr> 
    646649  <tr><td valign=\"top\"> * </td> 
    647       <td valign=\"top\"> Added (each final unit=\"1\") as unit for all unit vectors,  
     650      <td valign=\"top\"> Added (each final unit=\"1\") as unit for all unit vectors, 
    648651                        since in Dymola 7 unit propagation sometimes leads otherwise 
    649                         to warnings.</td>  
     652                        to warnings.</td> 
    650653  </tr> 
    651654 
    652655  <tr><td colspan=\"2\"><b>Media.Interfaces.PartialSimpleMedium</b></td></tr> 
    653   <tr><td valign=\"top\"> pressure<br>  
     656  <tr><td valign=\"top\"> pressure<br> 
    654657                        temperature<br> 
    655658                        density<br> 
    656659                        specificEnthalpy </td> 
    657       <td valign=\"top\"> Missing functions added.</td>  
     660      <td valign=\"top\"> Missing functions added.</td> 
    658661  </tr> 
    659662</table> 
    660                                 
     663 
    661664</html>")); 
    662665  end Version_2_2_2_BugFixes; 
    663      
     666 
    664667    annotation (Documentation(info="<html> 
    665668 
    … …  
    734737 
    735738<ul> 
    736 <li> One person is fixing the bug and another person is checking whether the  
     739<li> One person is fixing the bug and another person is checking whether the 
    737740     fix is fine.</li> 
    738741<li> It is up to the library developer, whether he opens a new branch for 
    739742     testing and then merges it with the \"head\" maintenance branch or not.</li> 
    740 <li> Every change to the maintenance branch has to be done at the development  
     743<li> Every change to the maintenance branch has to be done at the development 
    741744     branch (see above) as well.</li> 
    742745<li> Every change to the maintenance branch requires introducing a 
    743746     description of the bug fix under 
    744747     Modelica.UsersGuide.ReleaseNotes.&lt;release-number&gt;_bugFixes.</li> 
    745 <li> Every change to the maintenance branch requires changing the date  
     748<li> Every change to the maintenance branch requires changing the date 
    746749     of the Modelica library in the version annotation.<br> 
    747750     When including the library in a distribution, 
    … …  
    749752     release in the version annotation. Example:<br> 
    750753     <pre>annotation(version=\"2.2.1\", versionBuild=\"436\", versionDate=\"2007-05-13\")</pre> 
    751      The goal is to include the version build and version date information  
     754     The goal is to include the version build and version date information 
    752755     automatically from the subversion server, but this is not yet the case.</li> 
    753756<li> If time does not permit, a vendor makes the bug fix in its local version 
    … …  
    770773     and loading it with an older build-version, an error would occur.</li> 
    771774<li> Introducing a new name in the protected section of a non-partial 
    772      class should only be done if absolutely necessary to fix a bug.  
     775     class should only be done if absolutely necessary to fix a bug. 
    773776     The problem is that this might be non-backward compatible, 
    774      because a user might already extend from this class and already using the same name.</li>  
     777     because a user might already extend from this class and already using the same name.</li> 
    775778</ul> 
    776779</html> 
    777780")); 
    778      
    779   class Version_2_2_2 "Version 2.2.2 (Aug. 31, 2007)"  
    780        
     781 
     782  class Version_2_2_2 "Version 2.2.2 (Aug. 31, 2007)" 
     783 
    781784      annotation (Documentation(info="<html> 
    782785<p> 
    783 Version 2.2.2 is backward compatible to version 2.2.1 and 2.2 with  
     786Version 2.2.2 is backward compatible to version 2.2.1 and 2.2 with 
    784787the following exceptions: 
    785788</p> 
    … …  
    790793     Modelica.Media.IdealGases.SingleGases that are not type compatible 
    791794     to Modelica.Media.Interfaces.PartialMedium, because a FluidConstants 
    792      record definition is missing,  
    793      for details, see  
     795     record definition is missing, 
     796     for details, see 
    794797      <a href=\"Modelica://Modelica.Media.IdealGases\">Modelica.Media.IdealGases</a> 
    795798     (this is seen as a bug fix). 
    … …  
    804807ModelManagement.compare function. 
    805808</p> 
    806   
     809 
    807810<p> 
    808811In this version, <b>no</b> new libraries have been added. The <b>documentation</b> 
    … …  
    811814<a href=\"../help/Documentation/ModelicaStandardLibrary.pdf\">one pdf file</a>. 
    812815</p> 
    813   
    814   
     816 
     817 
    815818<p><br> 
    816 The following <b style=\"color:blue\">new components</b> have been added  
     819The following <b style=\"color:blue\">new components</b> have been added 
    817820to <b style=\"color:blue\">existing</b> libraries: 
    818821</p> 
    819   
     822 
    820823<table border=\"1\" cellspacing=0 cellpadding=2 style=\"border-collapse:collapse;\"> 
    821824  <tr><td colspan=\"2\"><b>Blocks.Logical.</b></td></tr> 
    … …  
    823826      <td valign=\"top\"> Terminate a simulation by a given condition.</td> 
    824827  </tr> 
    825   
     828 
    826829  <tr><td colspan=\"2\"><b>Blocks.Routing.</b></td></tr> 
    827830  <tr><td valign=\"top\"> RealPassThrough<br> 
    … …  
    829832           BooleanPassThrough</td> 
    830833      <td valign=\"top\"> Pass a signal from input to output 
    831            (useful in combination with a bus due to restrictions  
     834           (useful in combination with a bus due to restrictions 
    832835           of expandable connectors).</td> 
    833836  </tr> 
    834   
     837 
    835838  <tr><td colspan=\"2\"><b>Blocks.Sources.</b></td></tr> 
    836839  <tr><td valign=\"top\"> KinematicPTP2 </td> 
    … …  
    838841      </td> 
    839842  </tr> 
    840   
     843 
    841844  <tr><td colspan=\"2\"><b>Electrical.Machines.Examples.</b></td></tr> 
    842845  <tr><td valign=\"top\"> TransformerTestbench </td> 
    … …  
    852855  </tr> 
    853856  <tr><td valign=\"top\"> AIMC_Steinmetz </td> 
    854       <td valign=\"top\"> Asynchronous induction machine squirrel cage with Steinmetz connection  
    855       </td> 
    856   </tr> 
    857   
     857      <td valign=\"top\"> Asynchronous induction machine squirrel cage with Steinmetz connection 
     858      </td> 
     859  </tr> 
     860 
    858861  <tr><td colspan=\"2\"><b>Electrical.Machines.BasicMachines.Components.</b></td></tr> 
    859862  <tr><td valign=\"top\"> BasicAIM </td> 
    … …  
    882885      </td> 
    883886  </tr> 
    884   
     887 
    885888  <tr><td colspan=\"2\"><b>Electrical.Machines.BasicMachines.</b></td></tr> 
    886889  <tr><td valign=\"top\"> Transformers </td> 
    … …