diff --git a/Modelica/UsersGuide/Connectors.mo b/Modelica/UsersGuide/Connectors.mo new file mode 100644 index 0000000000..5ee53a5ed0 --- /dev/null +++ b/Modelica/UsersGuide/Connectors.mo @@ -0,0 +1,279 @@ +within Modelica.UsersGuide; +class Connectors "Connectors" + extends Modelica.Icons.Information; + + annotation (Documentation(info=" + +

+The Modelica standard library defines the most important +elementary connectors in various domains. If any possible, +a user should utilize these connectors in order that components +from the Modelica Standard Library and from other libraries +can be combined without problems. +The following elementary connectors are defined +(the meaning of potential, flow, and stream +variables is explained in section \"Connector Equations\" below): +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
domainpotential
variables		flow
variables		stream
variables		connector definitionicons
electrical
analog		electrical potentialelectrical currentModelica.Electrical.Analog.Interfaces +
Pin, PositivePin, NegativePin
electrical
polyphase		vector of electrical pinsModelica.Electrical.Polyphase.Interfaces +
Plug, PositivePlug, NegativePlug
electrical
space phasor		2 electrical potentials2 electrical currentsModelica.Electrical.Machines.Interfaces +
SpacePhasor
quasi-static
single-phase		complex electrical potentialcomplex electrical current + Modelica.Electrical.QuasiStatic.SinglePhase.Interfaces +
Pin, PositivePin, NegativePin
quasi-static
polyphase		vector of quasi-static single-phase pinsModelica.Electrical.QuasiStatic.Polyphase.Interfaces +
Plug, PositivePlug, NegativePlug
electrical
digital		Integer (1..9)Modelica.Electrical.Digital.Interfaces +
DigitalSignal, DigitalInput, DigitalOutput
magnetic
flux tubes		magnetic potentialmagnetic flux +Modelica.Magnetic.FluxTubes.Interfaces +
MagneticPort, PositiveMagneticPort,
NegativeMagneticPort
magnetic
fundamental
wave		complex magnetic potentialcomplex magnetic flux +Modelica.Magnetic.FundamentalWave.Interfaces +
MagneticPort, PositiveMagneticPort,
NegativeMagneticPort
translationaldistancecut-forceModelica.Mechanics.Translational.Interfaces +
Flange_a, Flange_b
rotationalanglecut-torqueModelica.Mechanics.Rotational.Interfaces +
Flange_a, Flange_b
3-dim.
mechanics		position vector
+ orientation object		cut-force vector
+ cut-torque vector		Modelica.Mechanics.MultiBody.Interfaces +
Frame, Frame_a, Frame_b, Frame_resolve
simple
fluid flow		pressure
+ specific enthalpy		mass flow rate
+ enthalpy flow rate		Modelica.Thermal.FluidHeatFlow.Interfaces +
FlowPort, FlowPort_a, FlowPort_b
thermo
fluid flow		pressuremass flow ratespecific enthalpy
mass fractions		 +Modelica.Fluid.Interfaces +
FluidPort, FluidPort_a, FluidPort_b
heat
transfer		temperatureheat flow rateModelica.Thermal.HeatTransfer.Interfaces +
HeatPort, HeatPort_a, HeatPort_b
blocks + Real variable
+ Integer variable
+ Boolean variable		Modelica.Blocks.Interfaces +
+ RealSignal, RealInput, RealOutput
+ IntegerSignal, IntegerInput, IntegerOutput
+ BooleanSignal, BooleanInput, BooleanOutput
complex
blocks		 + Complex variableModelica.ComplexBlocks.Interfaces +
ComplexSignal, ComplexInput, ComplexOutput
state
machine		Boolean variables
+ (occupied, set,
+ available, reset)		Modelica.StateGraph.Interfaces +
Step_in, Step_out, Transition_in, Transition_out
+ +

+In all domains, usually 2 connectors are defined. The variable declarations +are identical, only the icons are different in order that it is easy +to distinguish connectors of the same domain that are attached at the same +component. +

+ +

Hierarchical Connectors

+

+Modelica supports also hierarchical connectors, in a similar way as hierarchical models. +As a result, it is, e.g., possible, to collect elementary connectors together. +For example, an electrical plug consisting of two electrical pins can be defined as: +

+ +
+connector Plug
+   import Modelica.Electrical.Analog.Interfaces;
+   Interfaces.PositivePin phase;
+   Interfaces.NegativePin ground;
+end Plug;
+
+ +

+With one connect(..) equation, either two plugs can be connected +(and therefore implicitly also the phase and ground pins) or a +Pin connector can be directly connected to the phase or ground of +a Plug connector, such as \"connect(resistor.p, plug.phase)\". +

+ +

Connector Equations

+ +

+The connector variables listed above have been basically determined +with the following strategy: +

+ +
    +
  1. State the relevant balance equations and boundary + conditions of a volume for the particular physical domain.
    2. +
  2. Simplify the balance equations and boundary conditions + of (1) by taking the + limit of an infinitesimal small volume + (e.g., thermal domain: + temperatures are identical and heat flow rates + sum up to zero). +
    3. +
  3. Use the variables needed for the balance equations + and boundary conditions of (2) + in the connector and select appropriate Modelica + prefixes, so that these equations + are generated by the Modelica connection semantics. +
    4. +
+ +

+The Modelica connection semantics is sketched at hand +of an example: Three connectors c1, c2, c3 with the definition +

+ +
+connector Demo
+  Real        p;  // potential variable
+  flow   Real f;  // flow variable
+  stream Real s;  // stream variable
+end Demo;
+
+ +

+are connected together with +

+ +
+connect(c1,c2);
+connect(c1,c3);
+
+ +

+then this leads to the following equations: +

+ +
+// Potential variables are identical
+c1.p = c2.p;
+c1.p = c3.p;
+
+// The sum of the flow variables is zero
+0 = c1.f + c2.f + c3.f;
+
+/* The sum of the product of flow variables and upstream stream variables is zero
+   (this implicit set of equations is explicitly solved when generating code;
+   the \"<undefined>\" parts are defined in such a way that
+   inStream(..) is continuous).
+*/
+0 = c1.f*(if c1.f > 0 then s_mix else c1.s) +
+    c2.f*(if c2.f > 0 then s_mix else c2.s) +
+    c3.f*(if c3.f > 0 then s_mix else c3.s);
+
+inStream(c1.s) = if c1.f > 0 then s_mix else <undefined>;
+inStream(c2.s) = if c2.f > 0 then s_mix else <undefined>;
+inStream(c3.s) = if c3.f > 0 then s_mix else <undefined>;
+
+ +")); +end Connectors; diff --git a/Modelica/UsersGuide/Contact.mo b/Modelica/UsersGuide/Contact.mo new file mode 100644 index 0000000000..bdf530c49a --- /dev/null +++ b/Modelica/UsersGuide/Contact.mo @@ -0,0 +1,451 @@ +within Modelica.UsersGuide; +class Contact "Contact" + extends Modelica.Icons.Contact; + + annotation (Documentation(info=" +
The Modelica Standard Library (this Modelica package) is developed by contributors from different organizations (see list below). It is licensed under the BSD 3-Clause License by:
+

+
Modelica Association
+
(Ideella Föreningar 822003-8858 in Linköping)
+
c/o PELAB, IDA, Linköpings Universitet
+
S-58183 Linköping
+
Sweden
+
email: Board@Modelica.org
+
web: https://www.Modelica.org
+

+ +
The development of this Modelica package, starting with version 3.2.3, is organized by:
+
Thomas Beutlich and Dietmar Winkler
+

+ +
The development of this Modelica package of version 3.2.2 was organized by:
+
Anton Haumer
+
Technical Consulting & Electrical Engineering
+
D-93049 Regensburg
+
Germany
+
email: A.Haumer@Haumer.at
+

+ +
The development of this Modelica package up to and including version 3.2.1 was organized by:
+
Martin Otter
+
Deutsches Zentrum für Luft- und Raumfahrt (DLR)
+
Institut für Systemdynamik und Regelungstechnik (SR)
+
Münchener Straße 20
+
D-82234 Weßling
+
Germany
+
email: Martin.Otter@dlr.de
+
+

Since end of 2007, the development of the sublibraries of package Modelica is organized by personal and/or organizational library officers assigned by the Modelica Association. They are responsible for the maintenance and for the further organization of the development. Other persons may also contribute, but the final decision for library improvements and/or changes is performed by the responsible library officer(s). In order that a new sublibrary or a new version of a sublibrary is ready to be released, the responsible library officers report the changes to the members of the Modelica Association and the library is made available for beta testing to interested parties before a final decision. A new release of a sublibrary is formally decided by voting of the Modelica Association members.

+

As of March 7th, 2020, the following library officers are assigned:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Sublibraries Library officers
UsersGuideChristian Kral, Jakub Tobolar
BlocksMartin Otter, Anton Haumer
ClockedChristoff Bürger, Bernhard Thiele
ComplexBlocksAnton Haumer, Christian Kral
Blocks.TablesThomas Beutlich, Martin Otter, Anton Haumer
StateGraphHans Olsson, Martin Otter
Electrical.AnalogChristoph Clauss, Anton Haumer, Christian Kral, Kristin Majetta
Electrical.BatteriesAnton Haumer, Christian Kral
Electrical.DigitalChristoph Clauss, Kristin Majetta
Electrical.MachinesAnton Haumer, Christian Kral
Electrical.PolyphaseAnton Haumer, Christian Kral
Electrical.PowerConvertersChristian Kral, Anton Haumer
Electrical.QuasiStaticAnton Haumer, Christian Kral
Electrical.Spice3Christoph Clauss, Kristin Majetta, Joe Riel
Magnetic.FluxTubesThomas Bödrich, Anton Haumer, Christian Kral, Johannes Ziske
Magnetic.FundamentalWaveAnton Haumer, Christian Kral
Magnetic.QuasiStaticAnton Haumer, Christian Kral
Mechanics.MultiBodyMartin Otter, Jakub Tobolar
Mechanics.RotationalAnton Haumer, Christian Kral, Martin Otter, Jakub Tobolar
Mechanics.TranslationalAnton Haumer, Christian Kral, Martin Otter, Jakub Tobolar
FluidFrancesco Casella, Rüdiger Franke, Hubertus Tummescheit
Fluid.DissipationFrancesco Casella, Stefan Wischhusen
MediaFrancesco Casella, Rüdiger Franke, Hubertus Tummescheit
Thermal.FluidHeatFlowAnton Haumer, Christian Kral
Thermal.HeatTransferAnton Haumer, Christian Kral
MathHans Olsson, Martin Otter
ComplexMathAnton Haumer, Christian Kral, Martin Otter
UtilitiesDag Brück, Hans Olsson, Martin Otter
ConstantsHans Olsson, Martin Otter
IconsChristian Kral, Jakub Tobolar
UnitsChristian Kral, Martin Otter
C-SourcesThomas Beutlich, Hans Olsson, Martin Sjölund
ReferenceHans Olsson, Dietmar Winkler
ServicesHans Olsson, Martin Otter
ComplexAnton Haumer, Christian Kral
TestLeo Gall, Martin Otter
TestOverdeterminedLeo Gall, Martin Otter
TestConversion4Leo Gall, Martin Otter
ObsoleteModelica4Hans Olsson, Martin Otter
+ +

+The following people have directly contributed to the implementation +of the Modelica package (many more people have contributed to the design): +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Marcus Baurpreviously at:
Institute of System Dynamics and Control
+ DLR, German Aerospace Center,
+ Oberpfaffenhofen, Germany		Complex
+ Modelica.Math.Vectors
+ Modelica.Math.Matrices
Peter BeaterUniversity of Paderborn, GermanyModelica.Mechanics.Translational
Thomas Beutlichpreviously at:
ESI ITI GmbH, Germany		Modelica.Blocks.Sources.CombiTimeTable
+ Modelica.Blocks.Tables
Thomas BödrichDresden University of Technology, GermanyModelica.Magnetic.FluxTubes
Dag BrückDassault Systèmes AB, Lund, SwedenModelica.Utilities
Francesco CasellaPolitecnico di Milano, Milano, ItalyModelica.Fluid
+ Modelica.Media
Christoph Claussuntil 2016:
+ Fraunhofer Institute for Integrated Circuits,
+ Dresden, Germany		Modelica.Electrical.Analog
+ Modelica.Electrical.Digital
+ Modelica.Electrical.Spice3
Jonas EbornModelon AB, Lund, SwedenModelica.Media
Hilding ElmqvistMogram AB, Lund, Sweden
+ until 2015:
+ Dassault Systèmes AB, Lund, Sweden		Modelica.Mechanics.MultiBody
+ Modelica.Fluid
+ Modelica.Media
+ Modelica.StateGraph
+ Modelica.Utilities
+ Conversion from 1.6 to 2.0
Rüdiger FrankeABB Corporate Research,
Ladenburg, Germany		Modelica.Fluid
+ Modelica.Media
Manuel GräberInstitut für Thermodynamik,
+ Technische Universität Braunschweig, Germany		Modelica.Fluid
Anton HaumerConsultant, Regensburg,
Germany		Modelica.ComplexBlocks
+ Modelica.Electrical.Machines
+ Modelica.Electrical.Polyphase
+ Modelica.Electrical.QuasiStatic
+ Modelica.Magnetics.FundamentalWave
+ Modelica.Mechanics.Rotational
+ Modelica.Mechanics.Translational
+ Modelica.Thermal.FluidHeatFlow
+ Modelica.Thermal.HeatTransfer
+ Modelica.ComplexMath
+ Conversion from 1.6 to 2.0
+ Conversion from 2.2 to 3.0
Hans-Dieter Joospreviously at:
Institute of System Dynamics and Control
+ DLR, German Aerospace Center,
+ Oberpfaffenhofen, Germany		Modelica.Math.Matrices
Christian KralModeling and Simulation of Electric Machines, Drives and Mechatronic Systems,
+ Vienna, Austria		Modelica.ComplexBlocks
+ Modelica.Electrical.Machines
+ Modelica.Electrical.Polyphase
+ Modelica.Electrical.QuasiStatic
+ Modelica.Magnetics.FundamentalWave
+ Modelica.Mechanics.Rotational
+ Modelica.Mechanics.Translational
+ Modelica.Thermal.FluidHeatFlow
+ Modelica.Thermal.HeatTransfer
+ Modelica.ComplexMath +
Sven Erik Mattssonuntil 2015:
+ Dassault Systèmes AB, Lund, Sweden		Modelica.Mechanics.MultiBody
Hans OlssonDassault Systèmes AB, Lund, SwedenModelica.Blocks
+ Modelica.Math.Matrices
+ Modelica.Utilities
+ Conversion from 1.6 to 2.0
+ Conversion from 2.2 to 3.0
Martin OtterInstitute of System Dynamics and Control
+ DLR, German Aerospace Center,
+ Oberpfaffenhofen, Germany		Complex
+ Modelica.Blocks
+ Modelica.Fluid
+ Modelica.Mechanics.MultiBody
+ Modelica.Mechanics.Rotational
+ Modelica.Mechanics.Translational
+ Modelica.Math
+ Modelica.ComplexMath
+ Modelica.Media
+ Modelica.SIunits
+ Modelica.StateGraph
+ Modelica.Thermal.HeatTransfer
+ Modelica.Utilities
+ ModelicaReference
+ Conversion from 1.6 to 2.0
+ Conversion from 2.2 to 3.0
Katrin Prölßpreviously at:
Modelon Deutschland GmbH, Hamburg, Germany
+ until 2008:
+ Department of Technical Thermodynamics,
+ Technical University Hamburg-Harburg,
Germany		Modelica.Fluid
+ Modelica.Media
Christoph C. Richteruntil 2009:
+ Institut für Thermodynamik,
+ Technische Universität Braunschweig,
+ Germany		Modelica.Fluid
+ Modelica.Media
André SchneiderFraunhofer Institute for Integrated Circuits,
Dresden, Germany		Modelica.Electrical.Analog
+ Modelica.Electrical.Digital
Christian Schweigeruntil 2006:
+ Institute of System Dynamics and Control,
+ DLR, German Aerospace Center,
+ Oberpfaffenhofen, Germany		Modelica.Mechanics.Rotational
+ ModelicaReference
+ Conversion from 1.6 to 2.0
Michael SielemannModelon Deutschland GmbH, Munich, Germany
+ previously at:
+ Institute of System Dynamics and Control
+ DLR, German Aerospace Center,
+ Oberpfaffenhofen, Germany		Modelica.Fluid
+ Modelica.Media
Michael TillerXogeny Inc., Canton, MI, U.S.A.
+ previously at:
+ Emmeskay, Inc., Dearborn, MI, U.S.A.
+ previously at:
+ Ford Motor Company, Dearborn, MI, U.S.A.		Modelica.Media
+ Modelica.Thermal.HeatTransfer
Hubertus TummescheitModelon, Inc., Hartford, CT, U.S.A.Modelica.Media
+ Modelica.Thermal.HeatTransfer
Thorsten Vahlenkampuntil 2010:
+ XRG Simulation GmbH, Hamburg, Germany		Modelica.Fluid.Dissipation
Nico WalterMaster thesis at HTWK Leipzig
+ (Prof. R. Müller) and
+ DLR Oberpfaffenhofen, Germany		Modelica.Math.Matrices
Michael WetterLawrence Berkeley National Laboratory, Berkeley, CA, U.S.A.Modelica.Fluid
Hans-Jürg WiesmannSwitzerlandModelica.ComplexMath
Stefan WischhusenXRG Simulation GmbH, Hamburg, GermanyModelica.Fluid.Dissipation
+ Modelica.Media
+ +")); + +end Contact; diff --git a/Modelica/UsersGuide/Conventions.mo b/Modelica/UsersGuide/Conventions.mo new file mode 100644 index 0000000000..5f13e8fa0d --- /dev/null +++ b/Modelica/UsersGuide/Conventions.mo @@ -0,0 +1,1865 @@ +within Modelica.UsersGuide; +package Conventions "Conventions" + extends Modelica.Icons.Information; + package Documentation "HTML documentation" + extends Modelica.Icons.Information; + + package Format "Format" + extends Modelica.Icons.Information; + + class Cases "Cases" + extends Modelica.Icons.Information; + annotation (Documentation(info=" + +

In the Modelica documentation sometimes different cases have to be distinguished. If the case distinction refers to Modelica parameters or variables (Boolean expressions) the comparisons should be written in the style of Modelica code within <code> and </code> +

+ +

Examples

+ +
Example 1
+

+<p>If <code>useCage == true</code>, a damper cage is considered in the model...</p> +

+ +

appears as

+ +

If useCage == true, a damper cage is considered in the model...

+ +

+For more complex case scenarios, an unordered list should be used. In this case only Modelica specific code segments and Boolean expressions. +

+ +
Example 2
+ +
+<ul>
+  <li> If <code>useCage == true</code>, a damper cage is considered in the model.
+       Cage parameters must be specified in this case.</li>
+  <li> If <code>useCage == false</code>, the damper cage is omitted.</li>
+</ul>
+
+ +

appears as

+ + + +

+In a more equation oriented case, additional equations or code segments can be added. +

+ +
Example 3
+ +
+<ul>
+  <li>if <code>usePolar == true</code>, assign magnitude and angle to output <br>
+  <!-- insert graphical representation of equations -->
+  y[i,1] = sqrt( a[i]^2 + b[i]^2 ) <br>
+  y[i,2] = atan2( b[i], a[i] )
+  </li>
+  <li>if <code>usePolar == false</code>, assign cosine and sine to output <br>
+  <!-- insert graphical representation of equations -->
+  y[i,1] = a[i] <br>
+  y[i,2] = b[i]
+  </li>
+</ul>
+
+ +

appears as

+ + + +")); + end Cases; + + class Code "Code" + extends Modelica.Icons.Information; + + annotation (Documentation(info=" +

+Modelica code conventions of class and instance names, +parameters and variables are specified separately. In this section it is summarized how to refer to +Modelica code in the HTML documentation. +

+ +
    +
  1. For constants, parameters and variables in code segments <code> + and </code> should to be used, e.g.,
    + parameter Modelica.Units.SI.Time tStart "Start time"
    2. +
  2. Write multi or single line code segments as quoted preformatted text, i.e., embedded within + <blockquote><pre> and </pre></blockquote> tags.
    3. +
  3. Multi line or single line code shall not be additionally indented.
    4. +
  4. Inline code segments may be typeset with <code> and </code>.
    5. +
  5. In code segments use bold to emphasize Modelica keywords.
    6. +
+ +

Examples

+ +
Example 1
+ +
+<blockquote><pre>
+<strong>connector</strong> Frame
+   ...
+   <strong>flow</strong> SI.Force f[3] <strong>annotation</strong>(unassignedMessage="...");
+<strong>end</strong> Frame;
+</pre></blockquote>
+
+ +

appears as

+ +
+connector Frame
+   ...
+   flow SI.Force f[3] annotation(unassignedMessage="...");
+end Frame;
+
+ +
Example 2
+ +
+<blockquote><pre>
+<strong>parameter</strong> Modelica.Units.SI.Conductance G=1 "Conductance";
+</pre></blockquote>
+
+ +

appears as

+ +
+parameter Modelica.Units.SI.Conductance G=1 "Conductance";
+
+")); + end Code; + + class Equations "Equations" + extends Modelica.Icons.Information; + + annotation (Documentation(info=" + +

+In the context of HTML documentation +equations should have a graphical representation in PNG format. For that purpose tool +specific math typing capabilities can be used. Alternatively the LaTeX to HTML translator +LaTeX2HTML, or the +Online Equation Editor +or codecogs can be used. +

+ +

+A typical equation, e.g., of a Fourier synthesis, could look like
+
+or
+\"y=a_1+a_2\"
+In an alt tag the original equation should be stored, e.g.,

+
+<img
+ src="modelica://Modelica/Resources/Images/UsersGuide/Conventions/Documentation/Format/Equations/sample.png"
+ alt="y=a_1+a_2">
+
+ +

+If one wants to refer to particular variables and parameters in the documentation text, either a +graphical representation (PNG file) or italic fonts for regular physical symbols and lower case +Greek letters +should be used. Full word variables and full word indices should be spelled within +<code> and </code>. +Vector and array indices should be typeset as subscripts using the +<sub> and </sub> tags. +

+ +

Examples for such variables and parameters are: +φ, φref, v2, useDamperCage. +

+ +

Numbered equations

+ +

For numbering equations a one row table with two columns should be used. The equation number should be placed in the right column:

+ +
+<table border="0" cellspacing="10" cellpadding="2">
+  <tr>
+    <td><img
+    src="modelica://Modelica/Resources/Images/UsersGuide/Conventions/Documentation/Format/Equations/sample.png"
+    alt="y=a_1+a_2"> </td>
+    <td>(1)</td>
+  </tr>
+</table>
+
+ +

appears as:

+ + + + + + +
\"y=a_1+a_2\"(1)
+ +")); + end Equations; + + class Figures "Figures" + extends Modelica.Icons.Information; + + annotation (Documentation(info=" +

+Figures should in particular be included to examples to discuss the problems and results of the respective model. The library developers are yet encouraged to add figures to the documentation of other components to support the understanding of the users of the library. +

+ +
    +
  1. Figures have to be placed outside of paragraphs to be HTML compliant.
    2. +
  2. Figures need to have at least a src and an alt attribute defined to be HTML compliant.
    3. +
  3. Technical figures should be placed within a table environment. Each technical figure should then also have a caption. The figure caption starts with a capital letter.
    4. +
  4. Illustration can be embedded without table environment.
    5. +
+ +

Location of files

+ +

+The PNG files should be placed in a folder which exactly represents the package structure. +

+ +

Examples

+ +
Example 1
+ +

This example shows how an illustration should be embedded in the Example +PID_Controller of the +Blocks package. +

+ +
+<img src="modelica://Modelica/Resources/Images/Blocks/PID_controller.png"
+     alt="PID_controller.png">
+
+ +
Example 2
+ +

This is a simple example of a technical figure with caption.

+ +
+<table border="0" cellspacing="0" cellpadding="2">
+  <caption>Caption starts with a capital letter</caption>
+  <tr>
+    <td>
+      <img src="modelica://Modelica/Resources/Images/Blocks/PID_controller.png"
+           alt="PID_controller.png">
+    </td>
+  </tr>
+</table>
+
+ +
Example 3
+ +

To refer to a certain figure, a figure number may be added. In such case the figure name (Fig.) including the figure enumeration (1,2,...) have to be displayed bold using <strong> and </strong>.

+

The figure name and enumeration should look like this: Fig. 1:

+

Figures have to be enumerated manually.

+ +
+<table border="0" cellspacing="0" cellpadding="2">
+  <caption><strong>Fig. 2:</strong> Caption starts with a capital letter</caption>
+  <tr>
+    <td>
+      <img src="modelica://Modelica/Resources/Images/Blocks/PID_controller.png"
+           alt="PID_controller.png">
+    </td>
+  </tr>
+</table>
+
+")); + end Figures; + + class Hyperlinks "Hyperlinks" + extends Modelica.Icons.Information; + + annotation (Documentation(info=" +
    +
  1. Hyperlinks should always be made when referring to a component or package.
    2. +
  2. The hyperlink text in between <a href="..."> and </a> should include the full main package name.
    3. +
  3. A link to an external component should include the full name of the package that it is referred to.
    4. +
  4. Modelica hyperlinks have to use the scheme "modelica://..."
    5. +
  5. For hyperlinks referring to a Modelica component, see Example 1 and 2.
    6. +
  6. No links to commercial web sites are allowed.
    7. +
+ +

Examples

+ +
Example 1
+ +
+<a href="modelica://Modelica.Mechanics.MultiBody.UsersGuide.Tutorial.LoopStructures.PlanarLoops">
+         Modelica.Mechanics.MultiBody.UsersGuide.Tutorial.LoopStructures.PlanarLoops</a>
+
+

appears as

+ + Modelica.Mechanics.MultiBody.UsersGuide.Tutorial.LoopStructures.PlanarLoops + +
Example 2
+ +
+<p>
+  The feeder cables are connected to an
+  <a href="modelica://Modelica.Electrical.Machines.BasicMachines.InductionMachines.IM_SquirrelCage">
+  induction machine</a>.
+</p>
+
+

appears as

+

+ The feeder cables are connected to an + + induction machine. +

+")); + end Hyperlinks; + + class Lists "Lists" + extends Modelica.Icons.Information; + + annotation (Documentation(info=" +
    +
  1. Lists have to be placed outside of paragraphs to be HTML compliant.
    2. +
  2. Items of a list shall start with +
      +
    1. a capital letter if each item is a full sentence
      2. +
    2. a small letter, if only text fragments are used or the list is fragment of a sentence
      3. +
    3. +
+ +

Examples

+ +
Example 1
+ +

This is a simple example of an enumerated (ordered) list

+ +
+<ol>
+  <li>item 1</li>
+  <li>item 2</li>
+</ol>
+
+

appears as

+
    +
  1. item 1
    2. +
  2. item 2
    3. +
+ +
Example 2
+ +

This is a simple example of an unnumbered list.

+ +
+<ul>
+  <li>item 1</li>
+  <li>item 2</li>
+</ul>
+
+

appears as

+ +")); + end Lists; + + class References "References" + extends Modelica.Icons.Information; + + annotation (Documentation(info=" +
    +
  1. Refer to references by [1], [Andronov1973], etc. by hyperlink and summarize literature in the references subsection of + Conventions.UsersGuide.References.
    2. +
  2. There has to be made at least one citation to each reference.
    3. +
+ +

Examples

+ +
Example 1
+ +
+<p>
+More details about electric machine modeling
+can be found in [<a href="modelica://Modelica.UsersGuide.Conventions.UsersGuide.References">Gao2008</a>]
+and
+[<a href="modelica://Modelica.UsersGuide.Conventions.UsersGuide.References">Kral2018</a>, p. 149].
+</p>
+
+

appears as

+

+More details about electric machine modeling +can be found in [Gao2008] +and +[Kral2018, p. 149]. +

+")); + end References; + + class Tables "Tables" + extends Modelica.Icons.Information; + + annotation (Documentation(info=" +
    +
  1. Tables should always be typeset with <table> and </table>, + not with <pre> and </pre>.
    2. +
  2. Tables have to be placed outside of paragraphs to be HTML compliant.
    3. +
  3. Each table must have a table caption.
    4. +
  4. Table headers and entries start with capital letters.
    5. +
+ +

Examples

+ +
Example 1
+ +

This is a simple example of a table.

+ +
+<table border="1" cellspacing="0" cellpadding="2">
+  <caption>Caption starts with a capital letter</caption>
+  <tr>
+    <th>Head 1</th>
+    <th>Head 2</th>
+  </tr>
+  <tr>
+    <td>Entry 1</td>
+    <td>Entry 2</td>
+  </tr>
+  <tr>
+    <td>Entry 3</td>
+    <td>Entry 4</td>
+  </tr>
+</table>
+
+

appears as

+ + + + + + + + + + + + + + +
Caption starts with a capital letter
Head 1Head 2
Entry 1Entry 2
Entry 3Entry 4
+ +
Example 2
+ +

In this case of table captions, the table name (Tab.) including the table enumeration (1,2,...) +has to be displayed bold using <strong> and </strong>. The table name +and enumeration should look like this: Tab. 1: Tables have to be enumerated manually.

+ +
+<table border="1" cellspacing="0" cellpadding="2">
+  <caption><strong>Tab 2:</strong> Caption starts with a capital letter</caption>
+  <tr>
+    <th>Head 1</th>
+    <th>Head 2</th>
+  </tr>
+  <tr>
+    <td>Entry 1</td>
+    <td>Entry 2</td>
+  </tr>
+  <tr>
+    <td>Entry 3</td>
+    <td>Entry 4</td>
+  </tr>
+</table>
+
+

appears as

+ + + + + + + + + + + + + + +
Tab. 2: Caption starts with a capital letter
Head 1Head 2
Entry 1Entry 2
Entry 3Entry 4
+")); + end Tables; + annotation (Documentation(info=" + +

+In this section the format UsersGuide of the HTML documentation are specified. +The structure of the documentation is specified separately. +

+ +

Paragraphs

+ +
    +
  1. In each section the paragraphs should start with <p> + and terminate with </p>.
    2. +
  2. Do not write plain text without putting it in a paragraph.
    3. +
  3. No artificial line breaks <br> should be added within text paragraphs if possible. + Use separate paragraphs instead.
    4. +
  4. After a colon (:) continue with capital letter if new sentence starts; + for text fragments continue with lower case letter
    5. +
+ +

Emphasis

+ +
    +
  1. For setting text in strong font (normally interpreted as boldface) the tags <strong> and </strong> have to be used.
    2. +
  2. For emphasizing text fragments <em> and </em> has to be used.
    3. +
  3. Modelica terms such as expandable bus, array, etc. should not be emphasized anyhow.
    4. +
+ +

Capitalization of Text

+ +
    +
  1. Table headers and entries should start with capital letters
    2. +
  2. Table entries should start with lower case letter if only text fragments are used.
    3. +
  3. Table and figure captions start with a capital letter
    4. +
+ +")); + end Format; + + class Structure "Structure" + extends Modelica.Icons.Information; + + annotation (Documentation(info=" +
    +
  1. In the HTML documentation of any Modelica library, the headings <h1>, + <h2> and <h3> should not be used, because they are utilized by + the automatically generated documentation.
    2. +
  2. The utilized heading format starts with <h4> and terminates with </h4>, e.g., + <h4>Description</h4>
    3. +
  3. The <h4> and <h5> headings must not be terminated by a colon (:).
    4. +
  4. For additional structuring <h5> and </h5> may be used as demonstrated below.
    5. +
+ +

Structure

+ +

+The following parts should be added to the documentation of each component: +

+ +
    +
  1. General information without additional subsection explains how the class works
    2. +
  2. Syntax (for functions only): shows syntax of function call with minimum and full input parameters
    3. +
  3. Implementation (optional): explains how the implementation is made
    4. +
  4. Limitations (optional): explains the limitations of the component
    5. +
  5. Notes (optional): if required/useful
    6. +
  6. Examples (optional): if required/useful
    7. +
  7. Acknowledgments (optional): if required
    8. +
  8. See also: shows hyperlinks to related models
    9. +
  9. Revision history (optional): if required/intended for a package/model, the revision history + should be placed in annotation(Documentation(revisions="..."));
    10. +
+ +

+These sections should appear in the listed order. The only exceptions are hierarchically structured notes and examples as explained in the following. +

+ +

Additional notes and examples

+ +

Some additional notes or examples may require additional <h5> headings. For either notes or examples the following cases may be applied:

+ +
Example 1
+

+This is an example of a single note. +

+ +
+<h5>Note</h5>
+<p>This is the note.</p>
+
+ +
Example 2
+

+This is an example of a very simple structure. +

+ +
+<h5>Notes</h5>
+<p>This is the first note.</p>
+<p>This is the second note.</p>
+
+ +
Example 3
+

+This example shows a more complex structure with enumeration. +

+ +
+<h5>Note 1</h5>
+...
+<h5>Note 2</h5>
+...
+
+ +

Automatically created documentation

+ +

+For parameters, connectors, as well as inputs and outputs of function automatic documentation is generated by the tool from the quoted comments. +

+")); + end Structure; + annotation (Documentation(info=" +HTML documentation of Modelica classes. +")); + end Documentation; + + package Terms "Terms and spelling" + extends Modelica.Icons.Information; + + class Electrical "Electrical terms" + extends Modelica.Icons.Information; + + annotation (Documentation(info=" + +

The terms listed in this package shall be in accordance with Electropedia.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
List of electrical term spellings
To be usedNot to be used
cut-off frequencycut off frequency, cutoff frequency, cut-off-frequency, cutoff-frequency
electromagneticelectro magnetic, electro-magnetic
electromechanicalelectro mechanical, electro-mechanical
no-loadnoload, no load
polyphasemulti phase, multi-phase, multiphase
quasi-staticquasistatic, quasi static
set-pointset point, setpoint
short-circuitshortcircuit, short circuit
single-phasesingle phase, singlephase, one phase, one-phase, onephase, 1 phase, 1-phase
star pointstar-point, starpoint
three-phasethree phase, threephase, 3 phase, 3-phase
+ +")); + end Electrical; + + class Magnetic "Magnetic terms" + extends Modelica.Icons.Information; + + annotation (Documentation(info=" + +

The terms listed in this package shall be in accordance with Electropedia.

+ + + + + + + + + + + + + + + + + + + +
List of magnetic term spellings
To be usedNot to be used
electromagneticelectro magnetic, electro-magnetic
magnetomotive forcemagneto motive force
quasi-staticquasistatic, quasi static
+ +")); + end Magnetic; + annotation (Documentation(info=" + +

This is the documentation of terms to be used in the Modelica Standard Library.

+ +")); + end Terms; + + package ModelicaCode "Modelica code" + extends Modelica.Icons.Information; + + class Format "Format" + extends Modelica.Icons.Information; + + annotation (Documentation(info=" + +

Comments and Annotations

+

+Comments and annotations should start with a capital letter, for example:
+parameter Real a = 1 "Arbitrary factor";.
+For Boolean parameters, the description string should start with "= true, …", for example:
+parameter Boolean useHeatPort = false "= true, if heatPort is enabled";. +

+ +

Tabs and Groups

+

+The annotations "tab" and "group" define the placement of +component or of variables in a dialog. +

+

+Using the group annotation, the following rules shall be followed: +

+
    +
  1. + Avoid excessively long group labels. +
    2. +
  2. + Use nouns rather than verbs, without ending punctuation. +
    3. +
  3. + Use sentence-style capitalization. +
    4. +
+

+Using the tab annotation, the following rules shall be followed: +

+
    +
  1. + Try to group components or variables in the default \"general\" tab first. + But feel free to define a new tab it they are so many. +
    2. +
  2. + Label tabs based on their pattern. The label shall clearly reflect + the content of the collected variables. +
    3. +
  3. + Avoid long tab labels. One or two words are mostly sufficient. +
    4. +
  4. + Use nouns rather than verbs, without ending punctuation. +
    5. +
  5. + Use sentence-style capitalization. +
    6. +
  6. + Visibility of parameters collected in one tab shall not be dependent + on parameters shown in another tab. +
    7. +
+ +
Example
+

+Imagine you define a controlled electric drive being composed of +a controller and an electrical machine. The latter +has parameters number of pole pairs p, nominal frequency +fnom, rotor's moment of inertia Jrotor +and others. +The controller itself is divided into several sub-controllers +– such as the one for speed control with parameters like gain k +or time constant T. +Then, the above parameters of your electrical drive model could be sorted using tabs +and groups as follows: p, fnom and +Jrotor grouped in the \"Electrical machine\" group in +the \"general\" tab; k and T in the group +\"Speed control\" under tab \"Controller\". +

+

+In the Modelica code, for example the parameter k will then +be defined like: +

+ +
+parameter Real k=1 \"Gain\"
+  annotation(
+    Dialog(
+      tab=\"Controller\",
+      group=\"Speed control\"));
+
+ +

Whitespace and Indentation

+

+Trailing white-space (i.e., white-space at the end of the lines) shall not be used. +The tab-character shall not be used, since the tab-stops are not standardized. +

+

+The code in a class shall be indented relative to the class in steps of two spaces; +except that the headings public, protected, equation, +algorithm, and end of class marker shall not be indented. +The keywords public and protected are headings for a group +of declarations. +

+

+Long modifier lists shall be split into several indented lines with at most one modifier per line. +

+

+Full class definitions shall be separated by an empty line. +

+ +
Example
+ +
+package MyPackage
+  partial model BaseModel
+    parameter Real p;
+    input Real u(unit=\"m/s\");
+  protected
+    Real y;
+    Real x(
+      start=1,
+      unit=\"m\",
+      nominal=10);
+  equation
+    der(x) = u;
+    y = 2*x;
+  end BaseModel;
+
+  model ModelP2
+    extends BaseModel(p=2);
+  end ModelP2;
+end MyPackage;
+
+")); + end Format; + + class Naming "Naming convention" + extends Modelica.Icons.Information; + + annotation (Documentation(info=" + +
    +
  1. Class and instance names are usually written in upper and lower case + letters, e.g., "ElectricCurrent". An underscore may be used in names. + However, it has to be taken into account that the last underscore in a + name might indicate that the following characters are rendered as a subscript. + Example: "pin_a" may be rendered as "pina".
    2. + +
  2. Class names start always with an upper case letter, + with the exception of functions, that start with a lower case letter.
    3. + +
  3. Instance names, i.e., names of component instances and + of variables (with the exception of constants), + start usually with a lower case letter with only + a few exceptions if this is common sense + (such as T for a temperature variable).
    4. + +
  4. Constant names, i.e., names of variables declared with the + "constant" prefix, follow the usual naming conventions + (= upper and lower case letters) and start usually with an + upper case letter, e.g., UniformGravity, SteadyState.
    5. + +
  5. The two connectors of a domain that have identical declarations + and different icons are usually distinguished by _a, _b + or _p, _n, e.g., Flange_a, Flange_b, + HeatPort_a, HeatPort_b.
    6. + +
  6. A connector class has the instance + name definition in the diagram layer and not in the + icon layer.
    7. +
+ +

Variable names

+

In the following table typical variable names are listed. This list should be completed.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Variables and names
VariableQuantity
aacceleration
Aarea
Ccapacitance
ddamping, density, diameter
dppressureDrop
especificEntropy
Eenergy, entropy
etaefficiency
fforce, frequency
Gconductance
hheight, specificEnthalpy
Henthalpy
HFlowenthalpyFlow
icurrent
Jinertia
llength
LInductance
mmass
MmutualInductance
mFlowmassFlow
ppressure
Ppower
Qheat
QflowheatFlow
rradius
Rradius, resistance
ttime
Ttemperature
tautorque
UinternalEnergy
velectricPotential, specificVolume, velocity, voltage
Vvolume
wangularVelocity
Xreactance
Zimpedance
+")); + end Naming; + + class ParameterDefaults "Parameter defaults" + extends Modelica.Icons.Information; + + annotation (Documentation(info=" + +

+In this section the convention is summarized how default parameters are +handled in the Modelica Standard Library (since version 3.0). +

+ +

+Many models in this library have parameter declarations to define +constants of a model that might be changed before simulation starts. +Example: +

+ +
+model SpringDamper
+parameter Real c(final unit=\"N.m/rad\") = 1e5    \"Spring constant\";
+parameter Real d(final unit=\"N.m.s/rad\") = 0    \"Damping constant\";
+parameter Modelica.Units.SI.Angle phi_rel0 = 0  \"Unstretched spring angle\";
+...
+end SpringDamper;
+
+ +

+In Modelica it is possible to define a default value of a parameter in +the parameter declaration. In the example above, this is performed for +all parameters. Providing default values for all parameters can lead to +errors that are difficult to detect, since a modeler may have forgotten +to provide a meaningful value (the model simulates but gives wrong +results due to wrong parameter values). In general the following basic +situations are present: +

+ +
    +
  1. The parameter value could be anything (e.g., a spring constant or + a resistance value) and therefore the user should provide a value in + all cases. A Modelica translator should warn, if no value is provided. +
    2. + +
  2. The parameter value is not changed in > 95 % of the cases + (e.g., initialization or visualization parameters, or parameter phi_rel0 + in the example above). In this case a default parameter value should be + provided, in order that the model or function can be conveniently + used by a modeler. +
    3. + +
  3. A modeler would like to quickly utilize a model, e.g., + + In all these cases, it would be not practical, if the modeler would + have to provide explicit values for all parameters first. +
    4. +
+ +

+To handle the conflicting goals of (1) and (3), the Modelica Standard Library +uses two approaches to define default parameters, as demonstrated with the +following example: +

+ +
+model SpringDamper
+parameter Real c(final unit=\"N.m/rad\"  , start = 1e5) \"Spring constant\";
+parameter Real d(final unit=\"N.m.s/rad\", start = 0)   \"Damping constant\";
+parameter Modelica.Units.SI.Angle phi_rel0 = 0        \"Unstretched spring angle\";
+...
+end SpringDamper;
+
+SpringDamper sp1;              // warning for \"c\" and \"d\"
+SpringDamper sp2(c=1e4, d=0);  // fine, no warning
+
+ +

+Both definition forms, using a \"start\" value (for \"c\" and \"d\") and providing +a declaration equation (for \"phi_rel0\"), are valid Modelica and define the value +of the parameter. By convention, it is expected that Modelica translators will +trigger a warning message for parameters that are not defined by a declaration +equation, by a modifier equation or in an initial equation/algorithm section. +A Modelica translator might have options to change this behavior, especially, +that no messages are printed in such cases and/or that an error is triggered +instead of a warning. +

+ +")); + end ParameterDefaults; + annotation (Documentation(info=" + +

In this section guidelines on creating Modelica code are provided.

+ +")); + end ModelicaCode; + + package UsersGuide "User's Guide" + extends Modelica.Icons.Information; + + class Implementation "Implementation notes" + extends Modelica.Icons.Information; + + annotation (Documentation(info=" +

+This class summarizes general information about the implementation which is not stated elsewhere. +

+
    +
  1. The <caption> tag is currently not supported in some tools.
    2. +
  2. The &sim; symbol (i.e., '∼' ) is currently not supported in some tools.
    3. +
  3. The &prop; symbol (i.e., '∝' ) is currently not supported in some tools.
    4. +
+")); + end Implementation; + + class References "References" + extends Modelica.Icons.References; + + annotation (Documentation(info=" + +
    +
  1. Citation formats should be unified according to IEEE Transactions style.
    2. +
  2. Reference should be formatted as tables with two columns.
    3. +
+ +

In the following the reference formats will be explained based on five examples:

+ + + +

The citation is also explained.

+ +

Example

+ +
+<table border=\"0\" cellspacing=\"0\" cellpadding=\"2\">
+  <tr>
+    <td>[Gao2008]</td>
+    <td>Z. Gao, T. G. Habetler, R. G. Harley, and R. S. Colby,
+        &quot;<a href="https://ieeexplore.ieee.org/document/4401132">A sensorless rotor temperature estimator for induction
+        machines based on a current harmonic spectral estimation scheme</a>&quot;,
+        <em>IEEE Transactions on Industrial Electronics</em>,
+        vol. 55, no. 1, pp. 407-416, Jan. 2008.
+    </td>
+  </tr>
+  <tr>
+    <td>[Kral2018]</td>
+    <td>C. Kral,
+        <em>Modelica - object oriented modeling of polyphase electric machines</em> (in German),
+        M&uuml;nchen: Hanser Verlag, 2018, <a href="https://doi.org/10.3139/9783446457331">DOI 10.3139/9783446457331</a>,
+        ISBN 978-3-446-45551-1.
+    </td>
+  </tr>
+  <tr>
+    <td>[Woehrnschimmel1998]</td>
+    <td>R. W&ouml;hrnschimmel,
+        &quot;Simulation, modeling and fault detection for vector
+        controlled induction machines&quot;,
+        Master&apos;s thesis, Vienna University of Technology,
+        Vienna, Austria, 1998.
+    </td>
+  </tr>
+  <tr>
+    <td>[Farnleitner1999]</td>
+    <td>E. Farnleitner,
+      &quot;Computational Fluid dynamics analysis for rotating
+      electrical machinery&quot;,
+      Ph.D. dissertation, University of Leoben,
+      Department of Applied Mathematics, Leoben, Austria, 1999.
+    </td>
+  </tr>
+  <tr>
+    <td>[Marlino2005]</td>
+    <td>L. D. Marlino,
+      &quot;Oak ridge national laboratory annual progress report for the
+      power electronics and electric machinery program&quot;,
+      Oak Ridge National Laboratory, prepared for the U.S. Department of Energy,
+      Tennessee, USA, Tech. Rep. FY2004 Progress Report, January 2005,
+      <a href="https://doi.org/10.2172/974618">DOI 10.2172/974618</a>.
+    </td>
+  </tr>
+</table>
+
+ +

appears as

+ + + + + + + + + + + + + + + + + + + + + + +
[Gao2008]Z. Gao, T. G. Habetler, R. G. Harley, and R. S. Colby, + "A sensorless rotor temperature estimator for induction + machines based on a current harmonic spectral estimation scheme", + IEEE Transactions on Industrial Electronics, + vol. 55, no. 1, pp. 407-416, Jan. 2008. +
[Kral2018]C. Kral, + Modelica - object oriented modeling of polyphase electric machines (in German), + München: Hanser Verlag, 2018, DOI 10.3139/9783446457331, + ISBN 978-3-446-45551-1. +
[Woehrnschimmel1998]R. Wöhrnschimmel, + "Simulation, modeling and fault detection for vector + controlled induction machines", + Master's thesis, Vienna University of Technology, + Vienna, Austria, 1998. +
[Farnleitner1999]E. Farnleitner, + "Computational Fluid dynamics analysis for rotating + electrical machinery", + Ph.D. dissertation, University of Leoben, + Department of Applied Mathematics, Leoben, Austria, 1999. +
[Marlino2005]L. D. Marlino, + "Oak ridge national laboratory annual progress report for the + power electronics and electric machinery program", + Oak Ridge National Laboratory, prepared for the U.S. Department of Energy, + Tennessee, USA, Tech. Rep. FY2004 Progress Report, January 2005, + DOI 10.2172/974618. +
+ +")); + end References; + + class Contact "Contact" + extends Modelica.Icons.Contact; + + annotation (Documentation(info=" + +

+This class summarizes contact information of the contributing persons. +

+ +

Example

+ +
+<p>
+Library officers responsible for the maintenance and for the
+organization of the development of this library are listed in
+<a href=\"modelica://Modelica.UsersGuide.Contact\">Modelica.UsersGuide.Contact</a>.
+</p>
+
+<h4>Main authors</h4>
+
+<p>
+<strong>First author's name</strong><br>
+First author's address<br>
+next address line<br>
+email: <a href=\"mailto:author1@example.org\">author1@example.org</a><br>
+web: <a href="https://www.example.org">https://www.example.org</a>
+</p>
+
+<p>
+<strong>Second author's name</strong><br>
+Second author's address<br>
+next address line<br>
+email: <a href=\"mailto:author2@example.org\">author2@example.org</a>
+</p>
+
+<h4>Contributors to this library</h4>
+
+<ul>
+  <li>Person one</li>
+  <li>...</li>
+</ul>
+
+<h4>Acknowledgements</h4>
+
+<p>
+The authors would like to thank following persons for their support ...
+</p>
+
+OR
+
+<p>
+We are thankful to our colleagues [names] who provided expertise to develop this library...
+</p>
+
+OR
+
+<p>
+The [partial] financial support for the development of this library by [organization]
+is highly appreciated.
+</p>
+
+OR whatever
+
+

appears as

+

+Library officers responsible for the maintenance and for the +organization of the development of this library are listed in +Modelica.UsersGuide.Contact. +

+ +

Main authors

+ +

+First author's name
+First author's address
+next address line
+email: author1@example.org
+web: https://www.example.org +

+ +

+Second author's name
+Second author's address
+next address line
+email: author2@example.org
+

+ +

Contributors to this library

+ + + +

Acknowledgements

+ +

+The authors would like to thank following persons for their support ... +

+")); + end Contact; + + class RevisionHistory "Revision History" + extends Modelica.Icons.ReleaseNotes; + + annotation (Documentation(info=" + +
    +
  1. The revision history needs to answer the question: + What has changed and what are the improvements over the previous versions and revision.
    2. +
  2. The revision history includes the documentation of the development history of each class and/or package.
    3. +
  3. Version number, date, author and comments shall be included. + In case the version number is not known at the time of implementation, + a dummy version number shall be used, e.g., 3.x.x. The version date shall be the date of the + latest change.
    4. +
+ +
Example
+ +
+<table border=\"1\" cellspacing=\"0\" cellpadding=\"2\">
+    <tr>
+      <th>Version</th>
+      <th>Date</th>
+      <th>Author</th>
+      <th>Comment</th>
+    </tr>
+    ...
+    <tr>
+      <td>1.0.1</td>
+      <td>2008-05-26</td>
+      <td>A. Haumer<br>C. Kral</td>
+      <td>Fixed bug in documentation</td>
+    </tr>
+    <tr>
+      <td>1.0.0</td>
+      <td>2008-05-21</td>
+      <td>A. Haumer</td>
+      <td>Initial version</td>
+    </tr>
+</table>
+
+ +

This code appears then as in the \"Revisions\" section below.

+ +", + revisions=" + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
VersionDateAuthorComment
3.2.32017-07-04C. KralAdded comment on version number and date, see + #2219
1.1.02010-04-22C. KralMigrated Conventions to UsersGuide of MSL
1.0.52010-03-11D. WinklerUpdated image links guide to new 'modelica://' URIs, added contact details
1.0.42009-09-28C. KralApplied new rules for equations as discussed on the 63rd Modelica Design Meeting
1.0.32008-05-26D. WinklerLayout fixes and enhancements
1.0.12008-05-26A. Haumer
C. Kral		Fixed bug in documentation
1.0.02008-05-21A. HaumerInitial version
+")); + end RevisionHistory; + + annotation (Documentation(info=" +

The UsersGuide of each package should consist of the following classes

+
    +
  1. Contact information of + the library officer and the co-authors
    2. +
  2. Optional Implementation Notes to give general information about the implementation
    3. +
  3. References for summarizing the literature of the package
    4. +
  4. Revision history to summarize the most important changes and improvements of the package
    5. +
+")); + end UsersGuide; + + class Icons "Icon design" + extends Modelica.Icons.Information; + annotation (Documentation(info=" + +

The icon of a Modelica class shall consider the following guidelines:

+ +

Color and Shapes

+ +

The main icon color of a component shall be the same for all components of one library. White fill areas of an icon shall not be used to hide parts of an icon, see +#2031. +In the Modelica Standard Library the following color schemes apply:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Color schemes applied to particular libraries
PackageColor RGB codeColor sample
Modelica.Blocks{0,0,127}
Modelica.ComplexBlocks{85,170,255}
Modelica.Clocked{95,95,95}
Modelica.StateGraph{0,0,0}
Modelica.Electrical.Analog{0,0,255}
Modelica.Electrical.Digital{128,0,128}
Modelica.Electrical.Machines{0,0,255}
Modelica.Electrical.Polyphase{0,0,255}
Modelica.Electrical.QuasiStatic{85,170,255}
Modelica.Electrical.Spice3 {170,85,255}
Modelica.Magnetic.FluxTubes{255,127,0}
Modelica.Magnetic.FundamentalWave{255,127,0}
Modelica.Magnetic.QuasiStatic{255,170,85}
Modelica.Mechanics.MultiBody{192,192,192}
Modelica.Mechanics.Rotational{95,95,95}
Modelica.Mechanics.Translational{0,127,0}
Modelica.Fluid{0,127,255}
Modelica.Medianone
Modelica.Thermal.FluidHeatFlow{0,0,255}
Modelica.Thermal.HeatTransfer{191,0,0}
Modelica.Mathnone
Modelica.ComplexMathnone
Modelica.Utilitiesnone
Modelica.Constantsnone
Modelica.Iconsnone
Modelica.Unitsnone
+ +

Icon size

+ +

The icon of a Modelica class shall not be significantly greater or smaller than the default Diagram limits of 200 units x 200 units. These default diagram limits are

+ +

If possible, the icon shall be designed such way, that the icon name %name +and the most significant parameter can be displayed within the vertical Diagram range of the icon.

+ + + + + + + +
Fig. 1: (a) Typical icon, (b) including dimensions
(a) + \"Typical + (b) + \"Typical +
+ +

Component Name

+ +

The component name %name shall be in RGB (0,0,255) blue color.

+ +

The text shall be located above the actual icon. If there is enough space, the upper text limit of the component name +shall be 10 units below the upper icon boundary, see Fig. 1.

+ +

If the icon is as big as the entire icon range of 200 units x 200 units, e.g. in blocks, +the component name shall be placed above the icon with vertical 10 units of space between icon and lower text box, see Fig. 2.

+ + + + + + +
Fig. 2: Block component name
+ \"Placement +
+ +

If there is a connector located at the top icon boundary and it is obvious that this connector influences the model +behavior compared to a similar model without such connector, then a line from the connector to the actual icon +shall be avoided to keep the design straight, see Fig. 4. If it is required to use a line indicating the connector dependency, then +the line shall be interrupted such that this line does not interfere with component name.

+ + + + + + +
Fig. 3: Component name between actual icon and connector
+ \"Component +
+ +

In some cases, if there is not alternative, the component name has to be placed below the actual icon, see. Fig. 4.

+ + + + + + +
Fig. 4: Component name below actual icon
+ \"Icon +
+ +

Parameter Name

+ +

One significant parameter shall be placed below the icon, see Fig. 1 and Fig. 2. The parameter name shall be RGB (0,0,0) black color.

+ +

The parameter text box shall be placed 10 units below the actual icon. +

+ +

Connector location

+ +

Physical connectors shall always be located on the icon boundary. Input and output connector shall be placed outside the icon, see Fig. 2 and Fig. 3. +Preferred connector locations are:

+ + + + + + + +
Fig. 5: Connectors located at the four corners of the icon diagram
+ \"Icon +
+ +

Sensors

+ +

+Based on #2628 the following guidelines for the +design of sensors apply: +

+ + + + + + + + + +
Fig. 6: Round sensor with (a) short and (b) longer SI unit
(a) + \"Icon + (b) + \"Icon +
+ + + + + + +
Fig. 7: Rectangular sensor
+ \"Icon +
+ + + + + + +
Fig. 8: Sensor with multiple signal outputs and SI units located next to the output connectors
+ \"Icon +
+ +

Diagram layer

+ +

The diagram layer is intended to contain the graphical components, and if there are no graphical components it shall be left empty. +In particular do not make the diagram layer a copy of the icon layer. +Graphical illustrations shall not be added in the diagram layer, but can be added in the HTML documentation.

+")); + end Icons; + annotation (DocumentationClass=true,Documentation(info=" +

A Modelica main package should be compliant with the UsersGuide stated in this documentation:

+
    +
  1. Conventions of the Modelica code
    2. +
  2. Consistent HTML documentation
    3. +
  3. Structure to be provided by a main package +
    4. +
  4. These packages should appear in the listed order.
    5. +
+")); +end Conventions; diff --git a/Modelica/UsersGuide/Overview.mo b/Modelica/UsersGuide/Overview.mo new file mode 100644 index 0000000000..d7194771a8 --- /dev/null +++ b/Modelica/UsersGuide/Overview.mo @@ -0,0 +1,192 @@ +within Modelica.UsersGuide; +class Overview "Overview of Modelica Library" + extends Modelica.Icons.Information; + + annotation (Documentation(info=" +

+The Modelica Standard Library consists of the following +main sub-libraries: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Library Components Description
+ + + Analog
+ Analog electric and electronic components, such as + resistor, capacitor, transformers, diodes, transistors, + transmission lines, switches, sources, sensors. +
+ + + Digital
+ Digital electrical components based on the VHDL standard, + like basic logic blocks with 9-value logic, delays, gates, + sources, converters between 2-, 3-, 4-, and 9-valued logic. +
+ + + Machines
+ Electrical asynchronous-, synchronous-, and DC-machines + (motors and generators) as well as three-phase transformers. +
+ + + FluxTubes
+Based on magnetic flux tubes concepts. Especially to model electromagnetic actuators. Nonlinear shape, force, leakage, and material models. Material data for steel, electric sheet, pure iron, Cobalt iron, Nickel iron, NdFeB, Sm2Co17, and more. +
+ + + Translational
+ 1-dim. mechanical, translational systems, e.g., + sliding mass, mass with stops, spring, damper. +
+ + + Rotational
+ 1-dim. mechanical, rotational systems, e.g., inertias, gears, + planetary gears, convenient definition of speed/torque dependent friction + (clutches, brakes, bearings, ..) +
+
+ + 		+ MultiBody + 3-dim. mechanical systems consisting of joints, bodies, force and + sensor elements. Joints can be driven by drive trains defined by + 1-dim. mechanical system library (Rotational). + Every component has a default animation. + Components can be arbitrarily connected together. +
+ + + Fluid
+ 1-dim. thermo-fluid flow in networks of vessels, pipes, + fluid machines, valves and fittings. All media from the + Modelica.Media library can be used (so incompressible or compressible, + single or multiple substance, one or two phase medium). +
+ + + Media
+ Large media library providing models and functions + to compute media properties, such as h = h(p,T), d = d(p,T), + for the following media: +
    +
  • 1240 gases and mixtures between these gases.
    • +
  • incompressible, table based liquids (h = h(T), etc.).
    • +
  • compressible liquids
    • +
  • dry and moist air
    • +
  • high precision model for water (IF97).
    • +
+
+ + + FluidHeatFlow, + HeatTransfer + Simple thermo-fluid pipe flow, especially to model cooling of machines + with air or water (pipes, pumps, valves, ambient, sensors, sources) and + lumped heat transfer with heat capacitors, thermal conductors, convection, + body radiation, sources and sensors. +
+
+ + 		+ Blocks
+ Input/output blocks to model block diagrams and logical networks, e.g., + integrator, PI, PID, transfer function, linear state space system, + sampler, unit delay, discrete transfer function, and/or blocks, + timer, hysteresis, nonlinear and routing blocks, sources, tables. +
+ + + Clocked
+ Blocks to precisely define and synchronize sampled data systems with different + sampling rates. Continuous-time equations can be automatically discretized and + utilized in a sampled data system. The library is based on the clocked + synchronous language elements introduced in Modelica 3.3. +
+ + + StateGraph
+ Hierarchical state machines with a similar modeling power as Statecharts. + Modelica is used as synchronous action language, i.e., deterministic + behavior is guaranteed +
+ 
+A = [1,2,3;
+     3,4,5;
+     2,1,4];
+b = {10,22,12};
+x = Matrices.solve(A,b);
+Matrices.eigenValues(A);
+
+ 		+ Math, + Utilities
+ Functions operating on vectors and matrices, such as for solving + linear systems, eigen and singular values etc., and + functions operating on strings, streams, files, e.g., + to copy and remove a file or sort a vector of strings. +
+ +")); +end Overview; diff --git a/Modelica/UsersGuide/ReleaseNotes.mo b/Modelica/UsersGuide/ReleaseNotes.mo new file mode 100644 index 0000000000..0334f6b32e --- /dev/null +++ b/Modelica/UsersGuide/ReleaseNotes.mo @@ -0,0 +1,6216 @@ +within Modelica.UsersGuide; +package ReleaseNotes "Release notes" + extends Modelica.Icons.ReleaseNotes; + +class VersionManagement "Version Management" + extends Modelica.Icons.ReleaseNotes; + + annotation (Documentation(info=" +

Development branches

+

+Further development and maintenance of the Modelica Standard Library is performed with +two branches on the public GitHub repository of the Modelica Association. +

+

+Since version 4.0.0 the Modelica Standard Library uses semantic versioning following the +convention: +

+
MAJOR.MINOR.BUGFIX
+

+This provides a mechanism for maintaining releases and bug-fixes in a well defined way and is inspired +by (but not identical to) https://semver.org. +

+ +
Main development branch
+

+Name: \"master\" +

+ +

+This branch contains the actual development version, i.e., all bug-fixes +and new features. +New features must have been tested before including them. +However, the exhaustive tests for a new version are (usually) not performed. +This version is usually only be used by the developers of the +Modelica Standard Library and is not utilized by Modelica users. +

+ +
Maintenance branch
+

+Name: \"maint/4.1.x\" +

+ +

+This branch contains the released Modelica Standard Library version (e.g., v4.1.0) +where all bug-fixes since this release date are included +(also consecutive BUGFIX versions 4.1.1, 4.1.2, etc., +up to when a new MINOR or MAJOR release becomes available; +i.e., there will not be any further BUGFIX versions (i.e., 4.1.x) of a previous release). +These bug-fixes might not yet be tested with all test cases or with +other Modelica libraries. The goal is that a vendor may take this version at +any time for a new release of its software, in order to incorporate the latest +bug fixes. +

+ +

Contribution workflow

+

+The general contribution workflow is usually as follows: +

+ +
    +
  1. Fork the repository to your account by + using the Fork button of the GitHub repository site.
    2. +
  2. Clone the forked repository to your computer. Make sure to checkout the maintenance branch if the bug fix is going to get merged to the maintenance branch.
    3. +
  3. Create a new topic branch and give it a meaningful name, like, e.g., \"issue2161-fix-formula\".
    4. +
  4. Do your code changes and commit them, one change per commit.
    + Single commits can be copied to other branches.
    + Multiple commits can be squashed into one, but splitting is difficult.
    5. +
  5. Once you are done, push your topic branch to your forked repository.
    6. +
  6. Go to the upstream https://github.com/modelica/ModelicaStandardLibrary.git repository and submit a Pull Request (PR). +
    7. +
  7. Update your branch with the requested changes. If necessary, merge the latest + \"master\" branch into your topic branch and solve all merge conflicts in your topic branch.
    8. +
+ +

+There are some special guidelines for changes to the maintenance branch. +

+ + + +

+As a recommendation, a valid bug-fix to the maintenance branch may contain one or +more of the following changes. +

+ + +")); +end VersionManagement; + +class Version_4_1_0 "Version 4.1.0 (Month D, 20YY)" + extends Modelica.Icons.ReleaseNotes; + + annotation (Documentation(info=" +

+Version 4.1.0 is backward compatible to version 4.0.0, that is models developed with +versions 4.0.0 will work without any changes also with version 4.1.0. +Short Overview: +

+ +

+The following Modelica packages have been tested that they work together with this release of package Modelica (alphabetical list). +

+ + +
+ +


+The following new libraries have been added: +

+ + +
+ +


+The following new components have been added to existing libraries: +

+ + +
+ +


+The following existing components have been improved in a backward compatible way: +

+ + + + + + + + + + + + + + + + + + + + + +
Modelica.Blocks.Sources
CombiTimeTableAdded support of reading CSV files.
Modelica.Blocks.Tables
CombiTable1Ds
CombiTable1Dv
CombiTable2Ds
CombiTable2Dv		Added support of reading CSV files.
Electrical.PowerConverters.DCDC
HBridgeAn enhanced distribution of the fire signals avoids a short circuit on the source, and enables an enhanced pwm algorithm.
Control.SignalPWMThe reference signal can be chosen between sawtooth and triangle, and + the comparison between dutyCycle and reference signal is either applied common or separated for both fire ports.
Mechanics.Rotational.Components
BearingFrictionThe table interpolation in tau_pos utilizes the interpolation based on ExternalCombiTable1D.
LossyGearThe table interpolation in lossTable utilizes the interpolation based on ExternalCombiTable1D.
Mechanics.Translational.Components
SupportFrictionThe table interpolation in f_pos utilizes the interpolation based on ExternalCombiTable1D.
+ +


+The following existing components have been changed in a non-backward compatible way: +

+ + + + + + + + + + + +
Mechanics.MultiBody
WorldThe protected parameters ndim, ndim2 and + ndim_pointGravity have been removed.
Mechanics.Rotational.Components
Brake
Clutch
OneWayClutch		The table interpolation in mu_pos utilizes the interpolation based on ExternalCombiTable1D.
The public variable mu0 was changed to a protected final parameter.
Mechanics.Translational.Components
BrakeThe table interpolation in mu_pos utilizes the interpolation based on ExternalCombiTable1D.
The public variable mu0 was changed to a protected final parameter.
+ +


+The following critical errors have been fixed (i.e., errors +that can lead to wrong simulation results): +

+ + + + + +
Modelica.Blocks.Tables
CombiTable2Ds
CombiTable2Dv		The derivatives for one-sided extrapolation by constant continuation (i.e., extrapolation=Modelica.Blocks.Types.Extrapolation.HoldLastPoint) returned a constant zero value. This has been corrected.
+")); +end Version_4_1_0; + +class Version_4_0_0 "Version 4.0.0 (June 4, 2020)" + extends Modelica.Icons.ReleaseNotes; + + annotation (Documentation(info=" +

+Version 4.0.0 is not backward compatible to previous versions. +A tested conversion script is provided to transform models and libraries of previous versions 3.x.y to the new version. +Short Overview: +

+ + +

+The exact difference between package Modelica version 4.0.0 and version 3.2.3 is +summarized in a comparison table. +

+ +

+The following Modelica packages have been tested that they work together with this release of package Modelica +(alphabetical list). +Hereby simulation results of the listed packages have been produced with package Modelica version 3.2.3 and +compared with the simulation results produced with version 4.0.0 Beta.1. The tests have been performed with Dymola 2020/2020x/2021: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
LibraryVersionLibrary provider
Buildings > 6.0.0LBNL
BrushlessDCDrives1.1.1Dassault Systèmes
Clara1.5.0XRG Simulation GmbH and TLK-Thermo GmbH
ClaraPlus1.3.0XRG Simulation GmbH and TLK-Thermo GmbH
DriveControl4.0.0Anton Haumer
DymolaModels1.1Dassault Systèmes
EDrives1.0.1Anton Haumer and Christian Kral
ElectricalMachines0.9.1Anton Haumer
ElectricPowerSystems1.3.1Dassault Systèmes
ElectrifiedPowertrains1.3.2Dassault Systèmes
ElectroMechanicalDrives2.2.0Christian Kral
EMOTH1.4.1Anton Haumer
HanserModelica1.1.0Christian Kral
IBPSA > 3.0.0IBPSA Project 1
KeywordIO0.9.0Christian Kral
Modelica_DeviceDrivers1.8.1DLR, ESI ITI, and Linköping University (PELAB)
Optimization2.2.4DLR
PhotoVoltaics1.6.0Christian Kral
PlanarMechanics1.4.1Dirk Zimmer
Testing1.3Dassault Systèmes
ThermalSystems1.6.0TLK-Thermo GmbH
TIL3.9.0TLK-Thermo GmbH
TILMedia3.9.0TLK-Thermo GmbH
TSMedia1.6.0TLK-Thermo GmbH
VehicleInterfaces1.2.5Modelica Association
WindPowerPlants1.2.0Christian Kral
+ +


+The following new libraries have been added: +

+ + + + + + +
Modelica.ClockedThis library can be used to precisely define and synchronize sampled data systems with different sampling rates.
The library previously was + available as separate package Modelica_Synchronous. + (This library was developed by DLR in close cooperation with Dassault Systèmes Lund.) +
Modelica.Electrical.BatteriesThis library offers simple battery models.
+ (This library was developed by Anton Haumer and Christian Kral.) +
+ +


+The following new components have been added to existing libraries: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Modelica.Blocks.Sources
SineVariableFrequencyAndAmplitude
CosineVariableFrequencyAndAmplitude		Added signal sources with variable amplitude and frequency; sine and cosine waveforms are provided.
SincAdded signal source of amplitude*sin(2*π*f*t)/(2*π*f*t).
Modelica.Electrical.Analog.Sources
SineVoltageVariableFrequencyAndAmplitude
CosineVoltageVariableFrequencyAndAmplitude
SineCurrentVariableFrequencyAndAmplitude
CosineCurrentVariableFrequencyAndAmplitude		Added voltage and current sources with variable amplitude and frequency; sine and cosine waveforms are provided.
Modelica.Electrical.Machines.Sensors
SinCosResolverAdded resolver with two sine and two cosine tracks to be used in drive control applications.
Modelica.Electrical.Machines.Utilities
SwitchYDwithArcAdded wye delta switch with arc model and time delay between the two switching events.
Modelica.Electrical.PowerConverters
ACACAdded single-phase and polyphase triac models (AC/AC converters).
Modelica.Magnetic.FluxTubes.Shapes.FixedShape
HollowCylinderCircumferentialFlux
Toroid		Added circumferential flux models of hollow cylinder and toroid with circular cross section.
Magnetic.QuasiStatic.FluxTubes.Shapes.FixedShape
HollowCylinderCircumferentialFlux
Toroid		Added circumferential flux models of hollow cylinder and toroid with circular cross section.
Modelica.Mechanics.MultiBody.Visualizers.Advanced
VectorAdded 3-dimensional animation for visualization of vector quantities (force, torque, etc.)
Modelica.Mechanics.Translational.Components
RollingResistanceAdded resistance of a rolling wheel incorporating the inclination and rolling resistance coefficient.
VehicleAdded simple vehicle model considering mass and inertia, drag and rolling resistance, inclination resistance.
Modelica.Math
BooleanVectors.andTrueSimilar to allTrue, but return true on empty input vector.
Matrices.LAPACK.dgeqp3Compute the QR factorization with column pivoting of square or rectangular matrix.
Random.Utilities.automaticLocalSeedCreate an automatic local seed from the instance name.
+ +


+The following existing components have been improved in a backward compatible way: +

+ + + + + + + + + + + + + + + + + + + +
Modelica.Blocks.Sources
CombiTimeTableAdded second derivative and modified Akima interpolation.
Modelica.Blocks.Tables
CombiTable1Ds
CombiTable1Dv		Added second derivatives and modified Akima interpolation.
CombiTable2Ds
CombiTable2Dv		Added second derivatives.
Modelica.Electrical.Analog.Basic
GyratorServes as generalized gyrator model as IdealGyrator was removed.
Modelica.Electrical.Analog.Ideal
IdealizedOpAmpLimitedAdded homotopy to operational amplifier.
Modelica.Electrical.Semiconductors
NPN
PNP		Added optional substrate connector.
+ +


+The following existing components have been changed in a non-backward compatible way: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Modelica.Blocks
Nonlinear.Limiter
Nonlinear.VariableLimiter		The superfluous parameter limitsAtInit has been removed.
Continuous.PIDThe initialization option initType = InitPID.DoNotUse_InitialIntegratorState to only initialize the integrator state has been removed. This option has been converted to both initialize the integrator state and the derivative state, i.e., initType = Init.InitialState.
Continuous.LimPIDThe superfluous parameter limitsAtInit has been removed.
The initialization option initType = InitPID.DoNotUse_InitialIntegratorState to only initialize the integrator state has been removed. This option has been converted to both initialize the integrator state and the derivative state, i.e., initType = Init.InitialState.
Nonlinear.DeadZoneThe superfluous parameter deadZoneAtInit has been removed.
Interfaces.PartialNoise
Noise.UniformNoise
Noise.NormalNoise
Noise.TruncatedNormalNoise
Noise.BandLimitedWhiteNoise		As a side-effect of the updated computation in Modelica.Math.Random.Utilities.automaticLocalSeed the localSeed parameter is computed differently if useAutomaticLocalSeed is set to true.
Types.InitPIDThe enumeration type has been converted to Types.Init with exception of the alternative InitPID.DoNotUse_InitialIntegratorState, that was converted to Init.InitialState leading to a different initialization behaviour.
Modelica.Electrical.Machines.Utilities
SwitchYDThe IdealCommutingSwitch is replaced by an IdealOpeningSwitch and an IdealClosingSwitch to allow a time delay between the two switching actions.
Modelica.Electrical.Spice3
Internal.MOS2
Semiconductors.M_NMOS2
Semiconductors.M_PMOS2		The final parameter vp has been removed.
The obsolete variables cc_obsolete, icqmGB, icqmGS, icqmGD, MOScapgd, MOScapgs, MOScapgb, qm and vDS have been removed.
Modelica.Magnetic.QuasiStatic.FundamentalWave.Utilities
SwitchYDThe IdealCommutingSwitch is replaced by an IdealOpeningSwitch and an IdealClosingSwitch to allow a time delay between the two switching actions.
Modelica.Mechanics.MultiBody.Forces
WorldForceThe parameters diameter and N_to_m have been removed.
WorldTorqueThe parameters diameter and Nm_to_m have been removed.
WorldForceAndTorqueThe parameters forceDiameter, torqueDiameter, N_to_m, and Nm_to_m have been removed.
ForceThe parameter N_to_m has been removed.
TorqueThe parameter Nm_to_m has been removed.
ForceAndTorqueThe parameters N_to_m and Nm_to_m have been removed.
Modelica.Mechanics.MultiBody.Joints
PrismaticThe superfluous constant s_offset has been removed.
RevoluteThe superfluous constant phi_offset has been removed.
FreeMotion
FreeMotionScalarInit		The parameter arrowDiameter has been removed.
Modelica.Mechanics.MultiBody.Parts
BodyThe superfluous parameter z_a_start has been removed.
Modelica.Mechanics.MultiBody.Sensors
AbsoluteSensor
RelativeSensor
Distance		The parameter arrowDiameter has been removed.
CutForceThe parameters forceDiameter and N_to_m have been removed.
CutForceThe parameters torqueDiameter and Nm_to_m have been removed.
CutForceAndTorqueThe parameters forceDiameter, torqueDiameter, N_to_m, and Nm_to_m have been removed.
Modelica.Mechanics.MultiBody.Visualizers
Advanced.Arrow
Advanced.DoubleArrow
FixedArrow
SignalArrow		The parameter diameter has been removed.
Modelica.Fluid.Machines
PartialPumpThe superfluous parameter show_NPSHa has been removed.
Modelica.Thermal.HeatTransfer
Fahrenheit.FromKelvin
Rankine.FromKelvin
Rankine.ToKelvin		The superfluous parameter n has been removed.
+ +


+The following critical errors have been fixed (i.e., errors +that can lead to wrong simulation results): +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Modelica.Blocks.Math
PythagorasThe case with negative y2 was not correctly considered if u1IsHypotenuse is true. This has been corrected.
Modelica.Electrical.Semiconductors
DiodeFixed unit error in current equations.
Modelica.Electrical.Spice3.Additionals
polyThe case with one coefficient and one variable was not correctly considered. This has been corrected.
Modelica.Fluid.Dissipation.PressureLoss.General
dp_volumeFlowRate_DP
dp_volumeFlowRate_MFLOW		The mass flow rate was not correctly computed if the pressure drop is a linear function of the volume flow rate. This has been corrected.
Modelica.Media.Air.MoistAir
density_derX
s_pTX
s_pTX_der		The calculation was wrong. This has been corrected.
Modelica.Media.Air.ReferenceAir.Air_Base
BasePropertiesThe unit of the specific gas constant R_s was not correctly considered. This has been corrected.
Modelica.Media.IdealGases.Common.Functions
s0_Tlow_derThe calculation was wrong. This has been corrected.
Modelica.Media.IdealGases.Common.MixtureGasNasa
T_hXThe function inputs exclEnthForm, refChoice and h_off were not considered. This has been corrected.
Modelica.Media.Incompressible.TableBased
T_phThe pressure negligence was not considered. This has been corrected.
Modelica.Media.R134a.R134a_ph
setState_pTXOnly applicable in one-phase regime: The Newton iteration for the calculation of the density may possibly converge to the wrong root. This has been improved.
setState_dTX
setState_psX		The calculation was wrong in two-phase regime. This has been corrected.
Modelica.Utilities.System
getTimeThe month and year was only correctly returned if the implementing source file (ModelicaInternal.c) was compiled for Windows OS. This has been corrected.
+")); +end Version_4_0_0; + +class Version_3_2_3 "Version 3.2.3 (January 23, 2019)" + extends Modelica.Icons.ReleaseNotes; + + annotation (Documentation(info=" +

+Version 3.2.3 is backward compatible to version 3.2.2, that is models developed with +versions 3.0, 3.0.1, 3.1, 3.2, 3.2.1 or 3.2.2 will work without any changes also with version 3.2.3. +This version is a \"clean-up\" with major emphasis on quality improvement and +tool compatibility. The goal is that all +Modelica tools will support this package +and will interpret it in the same way. Short Overview: +

+ + + +

+The exact difference between package Modelica version 3.2.3 and version 3.2.2 is +summarized in a comparison table. +

+ +


+The following new libraries have been added: +

+ + + + + + +
Modelica.Magnetic.QuasiStatic.FluxTubes + This library provides models for the investigation of quasi-static electromagnetic devices with lumped magnetic networks + in a comparable way as Modelica.Magnetic.FluxTubes.
+ (This library was developed by Christian Kral.) +
Modelica.Electrical.Machines.Examples.ControlledDCDrives + This library demonstrates the control of a permanent magnet dc machine: current control, speed control and position control + along with the necessary components in sublibrary Utilities.
+ (This library was developed by Anton Haumer.) +
+ +


+The following new components have been added +to existing libraries: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Modelica.Blocks.Interfaces.Adaptors
FlowToPotentialAdaptor
PotentialToFlowAdaptor		 Partial adaptors for generation of FMUs, optionally taking first and second derivative into account, + for consistent components in various domains.
Modelica.Blocks.Math
PowerComputes the power of the input signal.
WrapAngle Wraps the angle signal at the input to the interval ]-π, π] or [0, 2π[.
Pythagoras This block determines the hypotenuse from the legs or one leg from the hypotenuse and the other leg.
TotalHarmonicDistortion This block calculates THD of the signal at the input.
RealFFT This block samples the input and calculates the FFT, writing the result to a mat file when the simulation terminates.
Modelica.Blocks.Routing
MultiplexMultiplexer block for arbitrary number of input signals
DeMultiplexDemultiplexer block for arbitrary number of output signals
Modelica.Blocks.Tables
CombiTable2DvVariant of CombiTable2D (table look-up in two dimensions) with vector inputs and vector output
Modelica.ComplexBlocks.Routing
Replicator
ExtractSignal
Extractor
ComplexPassThrough		 Complex implementations analogous to the real implementations.
Modelica.ComplexBlocks.ComplexMath
Bode Determine variables of a Bode diagram.
Modelica.ComplexBlocks.Sources
RampPhasor A source of a phasor with constant angle and ramped amplitude.
Modelica.Electrical.Analog.Basic
GeneralCurrentToVoltageAdaptor
GeneralVoltageToCurrentAdaptor		 Adaptors for the generation of FMUs, optionally taking first and second derivative into account.
Modelica.Electrical.Analog.Sensors
MultiSensor Measures voltage, current and power simultaneously.
Modelica.Electrical.Polyphase.Sensors
MultiSensor Measures voltage, current and active power for each phase as well as total power simultaneously.
AronSensor Measures active power for a three-phase system by two single-phase power sensors in an Aron circuit.
ReactivePowerSensor Measures reactive power for a three-phase system.
Modelica.Electrical.Machines.Examples
SMEE_DOL Electrically excited synchronous machine, starting direct on line via the damper cage, + synchronised by increasing excitation voltage.
SMR_DOL Synchronous reluctance machine, starting direct on line via the damper cage, + synchronised when reaching synchronous speed.
Modelica.Electrical.Machines.Sensors
HallSensor Simple model of a hall sensor, measuring the angle aligned with the orientation of phase 1.
Modelica.Electrical.PowerConverters.DCAC.Control
PWM
SVPWM
IntersectivePWM		 Standard three-phase pwm algorithms: space vector and intersective.
Modelica.Electrical.PowerConverters.DCDC
ChopperStepUp Step up chopper (boost converter) model.
Modelica.Electrical.QuasiStatic.SinglePhase.Sensors
MultiSensor Measures voltage, current and apparent power simultaneously.
Modelica.Electrical.QuasiStatic.Polyphase.Sensors
MultiSensor Measures voltage, current and apparent power for m phases as well as total apparent power simultaneously.
AronSensor Measures active power for a three-phase system by two single-phase power sensors in an Aron circuit.
ReactivePowerSensor Measures reactive power for a three-phase system.
Modelica.Electrical.QuasiStatic.{SinglePhase, Polyphase}.Sources
FrequencySweepVoltageSource
FrequencySweepCurrentSource		 Voltage source and current source with integrated frequency sweep.
Modelica.Mechanics.MultiBody
Visualizers.RectangleA planar rectangular surface.
Modelica.Mechanics.Rotational.Components
GeneralAngleToTorqueAdaptor
GeneralTorqueToAngleAdaptor		 Adaptors for the generation of FMUs, optionally taking first and second derivative into account.
+ Note: These adaptors give the same results as:
+ AngleToTorqueAdaptor
TorqueToAngleAdaptor
+ but extend from Modelica.Blocks.Interfaces.Adaptors + like adaptors in other domains.
Modelica.Mechanics.Rotational.Sources
EddyCurrentTorque Rotational eddy current brake.
Modelica.Mechanics.Translational.Components
GeneralForceToPositionAdaptor
GeneralPositionToForceAdaptor		 Adaptors for the generation of FMUs, optionally taking first and second derivative into account.
Modelica.Mechanics.Translational.Sources
EddyCurrentForce Translational eddy current brake.
Modelica.Magnetic.FundamentalWave.Examples
A lot of new test examples for fundamental wave machines.
Modelica.Magnetic.QuasiStatic.FundamentalWave.Sensors
RotorDisplacementAngle Measures the rotor displacement angle of a quasi-static machine.
Modelica.Thermal.HeatTransfer.Components
GeneralHeatFlowToTemperatureAdaptor
GeneralTemperatureToHeatFlowAdaptor		 Adaptors for the generation of FMUs, optionally taking first derivative into account.
Modelica.Thermal.FluidHeatFlow.Examples
WaterPump
TestOpenTank
TwoTanks
TestCylinder		 New examples testing and demonstrating the new resp. enhanced components.
Modelica.Thermal.FluidHeatFlow.Components
Pipe A pipe model with optional heatPort which replaces the isolatedPipe and the heatedPipe.
OpenTank A simple model of an open tank.
Cylinder A simple model of a piston/cylinder with translational flange.
OneWayValve A simple one way valve model (comparable to an electrical ideal diode)
Modelica.Thermal.FluidHeatFlow.Media
Water_10degC
Water_90degC
Glycol20_20degC
Glycol50_20degC
MineralOil		 Several new records defining media properties.
Modelica.Thermal.FluidHeatFlow.Interfaces
SinglePortLeft Replaces the (now obsolete) partial model Ambient and is also used for Sources.AbsolutePressure.
SinglePortBottom Same as SinglePortLeft but with the flowPort at the bottom; used for the new Components.OpenTank model.
Modelica.Constants
q The elementary charge of an electron.
Modelica.Icons
FunctionsPackage This icon indicates a package that contains functions.
RecordPackage This icon indicates a package that contains records.
+ +


+The following existing components +have been marked as obsolete and will be +removed in a future release: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Modelica.Blocks.Interfaces.Adaptors
SendReal
SendBoolean
SendInteger
ReceiveReal
ReceiveBoolean
ReceiveInteger		Use expandable connectors instead.
Modelica.StateGraph.Temporary
SetRealParameterUse parameter Real instead.
anyTrueUse Modelica.Math.BooleanVectors.anyTrue instead.
allTrueUse Modelica.Math.BooleanVectors.allTrue instead instead.
RadioButtonUse future model from Modelica.Blocks.Interaction instead.
NumericValueUse Modelica.Blocks.Interaction.Show.RealValue instead.
IndicatorLampUse Modelica.Blocks.Interaction.Show.BooleanValue instead.
Modelica.Electrical.Digital.Converters
LogicToXO1
LogicToXO1Z		Use LogicToX01 or LogicToX01Z instead.
Modelica.Electrical.Machines
BasicMachines.Components.BasicTransformerUse Interfaces.PartialBasicTransformer instead.
Modelica.Electrical.Spice3.Internal
BJTUse BJT2 instead.
Bjt3.*Use revised classes instead.
Modelica.Mechanics.MultiBody
Examples.Loops.Utilities.GasForceUse Examples.Loops.Utilities.GasForce2 instead.
Sensors.TansformAbsoluteVector
Sensors.TansformRelativeVector		Use Sensors.TransformAbsoluteVector or Sensors.TransformRelativeVector instead.
Visualizers.GroundUse ground plane visualization of World or Visualizers.Rectangle instead.
Modelica.Fluid.Icons
VariantLibrary
BaseClassLibrary		Use icons from Modelica.Icons instead.
Modelica.Media.Examples
Tests.Components.*Use classes from Utilities instead.
TestOnly.*
Tests.MediaTestModels.*		Use test models from ModelicaTest.Media instead.
Modelica.Thermal.FluidHeatFlow
Components.IsolatedPipe
Components.HeatedPipe		Extend from the new pipe model with optional heatPort.
Interfaces.AmbientExtends from SinglePortLeft.
Modelica.Math
baseIcon1
baseIcon2		Use icons from Modelica.Math.Icons instead.
Modelica.Icons
Library
Library2
GearIcon
MotorIcon
Info		Use (substitute) icons from Modelica.Icons, Modelica.Mechanics.Rotational.Icons or Modelica.Electrical.Machines.Icons instead.
Modelica.SIunits.Conversions.NonSIunits
FirstOrderTemperaturCoefficient
SecondOrderTemperaturCoefficient		Use Modelica.SIunits.LinearTemperatureCoefficientResistance or Modelica.SIunits.QuadraticTemperatureCoefficientResistance instead.
+ +


+The following existing components +have been improved in a +backward compatible way: +

+ + + + + + + + + + + + + + + +
Modelica.Blocks.Continuous
Integrator
LimIntegrator		Added optional reset and set value inputs.
LimPIDAdded an optional feed-forward input.
Modelica.Blocks.Sources
CombiTimeTableThe time events were not considered at the interval boundaries in case of linear interpolation and non-replicated sample points. This has been generalized by introduction of the new parameter timeEvents with the default option to always generate time events at the interval boundaries, which might lead to slower, but more accurate simulations.
BooleanTable
IntegerTable		Added options to set start time, shift time and extrapolation kind, especially to set periodic extrapolation.
Modelica.Blocks.Tables
CombiTable1D
CombiTable1Ds
CombiTable2D		Added option to set the extrapolation kind and to optionally print a warning in case of extrapolated table input.
+ +


+The following existing components have been changed in a non-backward compatible way: +

+ + + + + + + + + + + +
Modelica.Blocks
Interfaces.PartialNoise
Noise.UniformNoise
Noise.NormalNoise
Noise.TruncatedNormalNoise
Noise.BandLimitedWhiteNoise		As a side-effect of the corrected computation in Modelica.Math.Random.Utilities.impureRandomInteger the localSeed parameter is computed differently if useAutomaticLocalSeed is set to true.
Modelica.Mechanics.MultiBody
WorldAdded new parameter animateGround for optional ground plane visualization.
+ Users that have copied the World model (of MSL 3.0, 3.0.1, 3.1, 3.2, 3.2.1, or 3.2.2) as an own World model and used it as inner world component, might have broken their models. + Generally, for MSL models with sub-typing (due to inner/outer), it is strongly suggested to extend from this MSL model, instead of copying it.
Modelica.Media.Interfaces
PartialMediumAdded new constant C_default as default value for the trace substances of medium.
+ Users that have created an own medium by inheritance from the PartialMedium package and already added the C_default constant, might have broken their models.
+ Users that have copied the PartialMedium package (of MSL 3.0, 3.0.1, 3.1, 3.2, 3.2.1, or 3.2.2) as an own Medium package, might have broken their models. + Generally, for MSL classes with sub-typing (due to a replaceable declaration), it is strongly suggested to extend from this MSL class, instead of copying it.
+ +


+The following critical errors have been fixed (i.e., errors +that can lead to wrong simulation results): +

+ + + + + + + + + + + + + + + + + + + + + + + +
Modelica.Blocks.Sources
TimeTableThe derivative of the TimeTable output could no longer be determined. This has been corrected.
Modelica.Media.Air
MoistAir.molarMass
ReferenceMoistAir.molarMass		The computation of the function output MM was wrong. This has been corrected.
Modelica.Media.IdealGases.Common.Functions
thermalConductivityEstimateThe computation of the function output lambda was wrong for the modified Eucken correlation, i.e., if method is set to 2. This has been corrected.
Modelica.Media.IdealGases.Common.SingleGasesData
CH2
CH3
CH3OOH
C2CL2
C2CL4
C2CL6
C2HCL
C2HCL3
CH2CO_ketene
O_CH_2O
HO_CO_2OH
CH2BrminusCOOH
C2H3CL
CH2CLminusCOOH
HO2
HO2minus
OD
ODminus		The coefficients for blow, ahigh and bhigh were wrong. This has been corrected.
Modelica.Media.IdealGases.Common.MixtureGasNasa
mixtureViscosityChungThe computation of the function output etaMixture was wrong. This has been corrected.
Modelica.Media.Incompressible.TableBased
BasePropertiesThe unit of the gas constant R for table based media was not correctly considered. This has been corrected.
Modelica.Math.Random.Utilities
impureRandomIntegerThe function output y was not computed to yield a discrete uniform distribution for a minimum value imin of 1. This has been corrected.
+ +")); +end Version_3_2_3; + +class Version_3_2_2 "Version 3.2.2 (April 3, 2016)" + extends Modelica.Icons.ReleaseNotes; + + annotation (Documentation(info=" +

+Version 3.2.2 is backward compatible to version 3.2.1, that is models developed with +versions 3.0, 3.0.1, 3.1, 3.2, or 3.2.1 will work without any changes also with version 3.2.2 +(with exception of the, usually uncritical, non-backwards compatible changes listed below with regards to +external object libraries, and one bug fix introduced in 3.2.1 Build.3 for non-circular pipes +that can be non-backwards compatible if a user constructed a new pipe model based on +Modelica.Fluid.Pipes.BaseClasses.WallFriction.PartialWallFriction, see details below). +

+ + + +

+The exact difference between package Modelica version 3.2.2 and version 3.2.1 is +summarized in the following two comparison tables: +

+ + +

+This release of package Modelica, and the accompanying ModelicaTest, has been tested with the +following tools (the tools are listed alphabetically. At the time of the test, some of the +tools might not yet supported the complete Modelica package. For more details of the tests +see #1867): +

+ + + +

+The following Modelica packages have been tested that they work together with this release of package Modelica +(alphabetical list): +

+ + + +


+The following new libraries have been added: +

+ + + + + + + + + + + + + + + + + + + +
Modelica.Electrical.PowerConverters + This library offers models for rectifiers, inverters and DC/DC-converters.
+ (This library was developed by Christian Kral and Anton Haumer.) +
Modelica.Magnetic.QuasiStatic.FundamentalWave + This library provides quasi-static models of polyphase machines (induction machines, synchronous machines) in parallel (with the same parameters but different electric connectors) + to the transient models in Modelica.Magnetic.FundamentalWave.
+ Quasistatic means that electric transients are neglected, voltages and currents are supposed to be sinusoidal. Mechanical and thermal transients are taken into account.
+ This library is especially useful in combination with the Modelica.Electrical.QuasiStatic + library in order to build up very fast simulations of electrical circuits with sinusoidal currents and voltages.
+ (This library was developed by Christian Kral and Anton Haumer.) +
Sublibraries of Modelica.Magnetic.FluxTubes + New elements for modeling ferromagnetic (static) and eddy current (dynamic) hysteresis effects and permanent magnets have been added. + The FluxTubes.Material package is also extended to provide hysteresis data for several magnetic materials. These data is partly based on own measurements. + For modeling of ferromagnetic hysteresis, two different hysteresis models have been implemented: The simple Tellinen model and the considerably + more detailed Preisach hysteresis model. The following packages have been added: + + (These extensions have been developed by Johannes Ziske and Thomas Bödrich as part of the Clean Sky JTI project; + project number: 296369; Theme: + JTI-CS-2011-1-SGO-02-026; + MOMOLIB - Modelica Model Library Development for Media, Magnetic Systems and Wavelets. + The partial financial support by the European Union for this development is highly appreciated.). +
Sublibraries for noise modeling + Several new sublibraries have been added allowing the modeling of reproducible noise. + The most important new sublibraries are (for more details see below): + + (These extensions have been developed by Andreas Klöckner, Frans van der Linden, Dirk Zimmer, and Martin Otter from + DLR Institute of System Dynamics and Control). +
Modelica.Utilities functions for matrix read/write + New functions are provided in the Modelica.Utilities.Streams + sublibrary to write matrices in MATLAB MAT format on file and read matrices in this format from file. + The MATLAB MAT formats v4, v6, v7 and v7.3 (in case the tool supports HDF5) are supported by these functions. + Additionally, example models are provided under + Modelica.Utilities.Examples + to demonstrate the usage of these functions in models. For more details see below.
+ (These extensions have been developed by Thomas Beutlich from ITI GmbH). +
Modelica.Math sublibrary for FFT + The new sublibrary FastFourierTransform + provides utility and convenience functions to compute the Fast Fourier Transform (FFT). + Additionally two examples are present to demonstrate how to compute an FFT during continuous-time + simulation and store the result on file. For more details see below.
+ (These extensions have been developed by Martin Kuhn and Martin Otter from + DLR Institute of System Dynamics and Control). +
+ +


+The following new components have been added +to existing libraries: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Modelica.Blocks.Examples
NoiseExamples Several examples to demonstrate the usage of the blocks in the + new sublibrary Blocks.Noise.
Modelica.Blocks.Interfaces
PartialNoise Partial noise generator (base class of the noise generators in Blocks.Noise)
Modelica.Blocks.Math
ContinuousMean Calculates the empirical expectation (mean) value of its input signal
Variance Calculates the empirical variance of its input signal
StandardDeviation Calculates the empirical standard deviation of its input signal
Modelica.Blocks.Noise
GlobalSeed Defines global settings for the blocks of sublibrary Noise, + especially a global seed value is defined
UniformNoise Noise generator with uniform distribution
NormalNoise Noise generator with normal distribution
TruncatedNormalNoise Noise generator with truncated normal distribution
BandLimitedWhiteNoise Noise generator to produce band-limited white noise with normal distribution
Modelica.ComplexBlocks.Examples
ShowTransferFunction Example to demonstrate the usage of the block TransferFunction.
Modelica.ComplexBlocks.ComplexMath
TransferFunction This block allows to define a complex transfer function (depending on frequency input w) to obtain the complex output y.
Modelica.ComplexBlocks.Sources
LogFrequencySweep The logarithm of w performs a linear ramp from log10(wMin) to log10(wMax), the output is the decimal power of this logarithmic ramp.
Modelica.Electrical.Machines.Examples
ControlledDCDrivesCurrent, speed and position controlled DC PM drive
Modelica.Mechanics.Rotational.Examples.Utilities.
SpringDamperNoRelativeStatesIntroduced to fix ticket 1375
Modelica.Mechanics.Rotational.Components.
ElastoBacklash2Alternative model of backlash. The difference to the existing ElastoBacklash + component is that an event is generated when contact occurs and that the contact torque + changes discontinuously in this case. For some user models, this variant of a backlash model + leads to significantly faster simulations.
Modelica.Fluid.Examples.
NonCircularPipesIntroduced to check the fix of ticket 1681
Modelica.Media.Examples.
PsychrometricDataIntroduced to fix ticket 1679
Modelica.Math.Matrices.
balanceABC Return a balanced form of a system [A,B;C,0] + to improve its condition by a state transformation
Modelica.Math.Random.Generators.
Xorshift64star Random number generator xorshift64*
Xorshift128plus Random number generator xorshift128+
Xorshift1024star Random number generator xorshift1024*
Modelica.Math.Random.Utilities.
initialStateWithXorshift64star Return an initial state vector for a random number generator (based on xorshift64star algorithm)
automaticGlobalSeed Creates an automatic integer seed from the current time and process id (= impure function)
initializeImpureRandom Initializes the internal state of the impure random number generator
impureRandom Impure random number generator (with hidden state vector)
impureRandomInteger Impure random number generator for integer values (with hidden state vector)
Modelica.Math.Distributions.
Uniform Library of uniform distribution functions (functions: density, cumulative, quantile)
Normal Library of normal distribution functions (functions: density, cumulative, quantile)
TruncatedNormal Library of truncated normal distribution functions (functions: density, cumulative, quantile)
Weibull Library of Weibull distribution functions (functions: density, cumulative, quantile)
TruncatedWeibull Library of truncated Weibull distribution functions (functions: density, cumulative, quantile)
Modelica.Math.Special.
erfError function erf(u) = 2/sqrt(pi)*Integral_0_u exp(-t^2)*d
erfcComplementary error function erfc(u) = 1 - erf(u)
erfInvInverse error function: u = erf(erfInv(u))
erfcInv Inverse complementary error function: u = erfc(erfcInv(u))
sinc Unnormalized sinc function: sinc(u) = sin(u)/u
Modelica.Math.FastFourierTransform.
realFFTinfo Print information about real FFT for given f_max and f_resolution
realFFTsamplePoints Return number of sample points for a real FFT
realFFTReturn amplitude and phase vectors for a real FFT
Modelica.Utilities.Streams.
readMatrixSizeRead dimensions of a Real matrix from a MATLAB MAT file
readRealMatrixRead Real matrix from MATLAB MAT file
writeRealMatrixWrite Real matrix to a MATLAB MAT file
Modelica.Utilities.Strings.
hashStringCreates a hash value of a String
Modelica.Utilities.System.
getTimeRetrieves the local time (in the local time zone)
getPidRetrieves the current process id
+ +


+The following existing components have been changed in a non-backward compatible way: +

+ + + + + + + +
Electrical.Analog.Semiconductors.
HeatingDiode Removed protected variable k \"Boltzmann's constant\".
+ Calculate protected constant q \"Electron charge\" from already known constants instead of defining a protected variable q.
HeatingNPN
+ HeatingPNP 		Removed parameter K \"Boltzmann's constant\" and q \"Elementary electronic charge\".
+ Calculate instead protected constant q \"Electron charge\" from already known constants.
+ Users that have used these parameters might have broken their models; + the (although formal non-backwards compatible) change offers the users a safer use.
+ +")); +end Version_3_2_2; + +class Version_3_2_1 "Version 3.2.1 (August 14, 2013)" + extends Modelica.Icons.ReleaseNotes; + + annotation (Documentation(info=" +

+Version 3.2.1 is backward compatible to version 3.2, that is models developed with +versions 3.0, 3.0.1, 3.1, or 3.2 will work without any changes also with version 3.2.1. +This version is a \"clean-up\" with major emphasis on quality improvement and +tool compatibility. The goal is that all +Modelica tools will support this package +and will interpret it in the same way. Short Overview: +

+ + + +

+This release of package Modelica, and the accompanying ModelicaTest, has been tested with the +following tools (the tools are listed alphabetically. At the time of the test, some of the +tools might not yet supported the complete Modelica package): +

+ + + +

+The following Modelica packages have been tested that they work together with this release of package Modelica +(alphabetical list): +

+ + + +

+The new open source tables have been tested by T. Beutlich (ITI): +

+ + + +

+The exact difference between package Modelica version 3.2 and version 3.2.1 is +summarized in a +comparison table. +

+ +

+About 400 trac tickets have been fixed for this release. An overview is given +here. +Clicking on a ticket gives all information about it. +

+ +


+The following new components have been added +to existing libraries: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Modelica.Blocks.Logical.
RSFlipFlop Basic RS flip flop
Modelica.Blocks.Math.
MinMaxOutput the minimum and the maximum element of the input vector
LinearDependency Output a linear combination of the two inputs
Modelica.Blocks.Nonlinear.
SlewRateLimiter Limit the slew rate of a signal
Modelica.Electrical.Digital.Memories
DLATRAM Level sensitive Random Access Memory
DLATROM Level sensitive Read Only Memory
Modelica.Electrical.Digital.Multiplexers
MUX2x1 A two inputs MULTIPLEXER for multiple value logic (2 data inputs, 1 select input, 1 output)
Modelica.Electrical.Machines.Examples.InductionMachines.
IMC_Initialize Steady-State Initialization example of InductionMachineSquirrelCage
Modelica.Electrical.Machines.Examples.SynchronousMachines.
SMPM_VoltageSource PermanentMagnetSynchronousMachine example fed by FOC
Modelica.Electrical.Polyphase.Examples.
TestSensors Example for polyphase quasiRMS sensors: A sinusoidal source feeds a load consisting of resistor and inductor
Modelica.Electrical.Polyphase.Sensors.
VoltageQuasiRMSSensor Continuous quasi voltage RMS sensor for polyphase system
CurrentQuasiRMSSensor Continuous quasi current RMS sensor for polyphase system
Modelica.Electrical.Polyphase.Blocks.
QuasiRMS Determine quasi RMS value of a polyphase system
Modelica.Electrical.Polyphase.Functions.
quasiRMS Calculate continuous quasi RMS value of input
activePower Calculate active power of voltage and current input
symmetricOrientation Orientations of the resulting fundamental wave field phasors
Modelica.Electrical.Spice3.Examples.
CoupledInductors
+ CascodeCircuit
+ Spice3BenchmarkDifferentialPair
+ Spice3BenchmarkMosfetCharacterization
+ Spice3BenchmarkRtlInverter
+ Spice3BenchmarkFourBitBinaryAdder		 Spice3 examples and benchmarks from the SPICE3 Version e3 User's Manual
Modelica.Electrical.Spice3.Basic.
K_CoupledInductors Inductive coupling via coupling factor K
Modelica.Electrical.Spice3.Semiconductors.
M_NMOS2
+ M_PMOS2
+ ModelcardMOS2		 N/P channel MOSFET transistor with fixed level 2
J_NJFJFE
+ J_PJFJFE
+ ModelcardJFET		 N/P-channel junction field-effect transistor
C_Capacitor
+ ModelcardCAPACITOR		 Semiconductor capacitor model
Modelica.Magnetic.FundamentalWave.Examples.BasicMachines.
IMC_DOL_Polyphase
+ IMS_Start_Polyphase
+ SMPM_Inverter_Polyphase
+ SMEE_Generator_Polyphase
+ SMR_Inverter_Polyphase		 Polyphase machine examples
Modelica.Fluid.Sensors.
MassFractions
+ MassFractionsTwoPort		 Ideal mass fraction sensors
Modelica.Media.
R134a R134a (Tetrafluoroethane) medium model in the range (0.0039 bar .. 700 bar, + 169.85 K .. 455 K)
Modelica.Media.Air.
ReferenceAir Detailed dry air model with a large operating range (130 ... 2000 K, 0 ... 2000 MPa) + based on Helmholtz equations of state
ReferenceMoistAir Detailed moist air model (143.15 ... 2000 K)
MoistAir Temperature range of functions of MoistAir medium enlarged from + 240 - 400 K to 190 - 647 K.
Modelica.Media.Air.MoistAir.
velocityOfSound
+ isobaricExpansionCoefficient
+ isothermalCompressibility
+ density_derp_h
+ density_derh_p
+ density_derp_T
+ density_derT_p
+ density_derX
+ molarMass
+ T_psX
+ setState_psX
+ s_pTX
+ s_pTX_der
+ isentropicEnthalpy		 Functions returning additional properties of the moist air medium model
Modelica.Thermal.HeatTransfer.Components.
ThermalResistor Lumped thermal element transporting heat without storing it (dT = R*Q_flow)
ConvectiveResistor Lumped thermal element for heat convection (dT = Rc*Q_flow)
Modelica.MultiBody.Examples.Constraints.
PrismaticConstraint
+ RevoluteConstraint
+ SphericalConstraint
+ UniversalConstraint		 Demonstrates the use of the new Joints.Constraints joints by comparing + them with the standard joints.
Modelica.MultiBody.Joints.Constraints.
Prismatic
+ Revolute
+ Spherical
+ Universal		 Joint elements formulated as kinematic constraints. These elements are + designed to break kinematic loops and result usually in numerically more + efficient and reliable loop handling as the (standard) automatic handling.
Modelica.Mechanics.Rotational.
MultiSensor Ideal sensor to measure the torque and power between two flanges and the absolute angular velocity
Modelica.Mechanics.Translational.
MultiSensor Ideal sensor to measure the absolute velocity, force and power between two flanges
Modelica.Math.
isPowerOf2 Determine if the integer input is a power of 2
Modelica.Math.Vectors.
normalizedWithAssert Return normalized vector such that length = 1 (trigger an assert for zero vector)
Modelica.Math.BooleanVectors.
countTrue Returns the number of true entries in a Boolean vector
enumerate Enumerates the true entries in a Boolean vector (0 for false entries)
index Returns the indices of the true entries of a Boolean vector
Modelica.Utilities.Files.
loadResource Return the absolute path name of a URI or local file name
Modelica.SIunits.
PressureDifference
+ MolarDensity
+ MolarEnergy
+ MolarEnthalpy
+ TimeAging
+ ChargeAging
+ PerUnit
+ DerPressureByDensity
+ DerPressureByTemperature		 New SI unit types
+")); +end Version_3_2_1; + +class Version_3_2 "Version 3.2 (Oct. 25, 2010)" + extends Modelica.Icons.ReleaseNotes; + + annotation (Documentation(info=" + +

+Version 3.2 is backward compatible to version 3.1, i.e., models developed with +versions 3.0, 3.0.1, or 3.1 will work without any changes also with version 3.2. +This version is a major improvement: +

+ + + +

+Version 3.2 is slightly based on the Modelica Specification 3.2. It uses +the following new language elements (compared to Modelica Specification 3.1): +

+ + + +

+A large part of the new classes has been developed with +partial financial support by +BMBF (BMBF Förderkennzeichen: 01IS07022F) +within the ITEA EUROSYSLIB research project. +We highly appreciate this funding. +

+ +

+The following new libraries have been added: +

+ + + + + + + + + + + + + + + + + + + + + + +
Complex + This is a top-level record outside of the Modelica Standard Library. + It is used for complex numbers and contains overloaded operators. + From a users point of view, Complex is used in a similar way as the + built-in type Real. Example:
+   Real a = 2;
+   Complex j = Modelica.ComplexMath.j;
+   Complex b = 2 + 3*j;
+   Complex c = (2*b + a)/b;
+   Complex d = Modelica.ComplexMath.sin(c);
+   Complex v[3] = {b/2, c, 2*d};
+ (This library was developed by Marcus Baur, DLR.) +
Modelica.ComplexBlocks + Library of basic input/output control blocks with Complex signals.
+ This library is especially useful in combination with the new + Modelica.Electrical.QuasiStatic + library in order to build up very fast simulations of electrical circuits with periodic + currents and voltages.
+ (This library was developed by Anton Haumer.) +
Modelica.Electrical.QuasiStatic + Library for quasi-static electrical single-phase and polyphase AC simulation.
+ This library allows very fast simulations of electrical circuits with sinusoidal + currents and voltages by only taking into account the quasi-static, periodic part + and neglecting non-periodic transients.
+ (This library was developed by Anton Haumer and Christian Kral.) +
Modelica.Electrical.Spice3 + Library with components of the Berkeley + SPICE3 + simulator:
+ R, C, L, controlled and independent sources, semiconductor device models + (MOSFET Level 1, Bipolar junction transistor, Diode, Semiconductor resistor). + The components have been intensively tested with more than 1000 test models + and compared with results from the SPICE3 simulator. All test models give identical + results in Dymola 7.4 with respect to the Berkeley SPICE3 simulator up to the relative + tolerance of the integrators.
+ This library allows detailed simulations of electronic circuits. + Work on Level 2 SPICE3 models, i.e., even more detailed models, is under way. + Furthermore, a pre-processor is under development to transform automatically + a SPICE netlist into a Modelica model, in order that the many available + SPICE3 models can be directly used in a Modelica model.
+ (This library was developed by Fraunhofer Gesellschaft, Dresden.) +
Modelica.Magnetic.FundamentalWave + Library for magnetic fundamental wave effects in electric machines for the + application in three phase electric machines. + The library is an alternative approach to the Modelica.Electrical.Machines library. + A great advantage of this library is the strict object orientation of the + electrical and magnetic components that the electric machines models are composed of. + This allows an easier incorporation of more detailed physical effects of + electrical machines. + From a didactic point of view this library is very beneficial for students in the field + of electrical engineering.
+ (This library was developed by Christian Kral and Anton Haumer, using + ideas and source code of a library from Michael Beuschel from 2000.) +
Modelica.Fluid.Dissipation + Library with functions to compute convective heat transfer and pressure loss characteristics.
+ (This library was developed by Thorben Vahlenkamp and Stefan Wischhusen from + XRG Simulation GmbH.) +
Modelica.ComplexMath + Library of complex mathematical functions (e.g., sin, cos) and of functions operating + on complex vectors.
+ (This library was developed by Marcus Baur from DLR-RM, Anton Haumer, and + HansJürg Wiesmann.) +
+ +


+The following new components have been added +to existing libraries: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Modelica.UsersGuide
Conventions + Considerably improved 'Conventions' for the Modelica Standard Library.
Modelica.Blocks.Examples
Filter
+ FilterWithDifferentation
+ FilterWithRiseTime
+ RealNetwork1
+ IntegerNetwork1
+ BooleanNetwork1
+ Interaction1 + 		Examples for the newly introduced block components.
Modelica.Blocks.Continuous
Filter Continuous low pass, high pass, band pass and band stop + IIR-filter of type CriticalDamping, Bessel, Butterworth and Chebyshev I.
Modelica.Blocks.Interaction.Show
RealValue
+ IntegerValue
+ BooleanValue		 Blocks to show the values of variables in a diagram animation.
Modelica.Blocks.Interfaces
RealVectorInput
+ IntegerVectorInput
+ BooleanVectorInput
+ PartialRealMISO
+ PartialIntegerSISO
+ PartialIntegerMISO
+ PartialBooleanSISO_small
+ PartialBooleanMISO + 		Interfaces and partial blocks for the new block components.
Modelica.Blocks.Math
MultiSum
+ MultiProduct
+ MultiSwitch 		Sum, product and switch blocks with 1,2,...,N inputs + (based on connectorSizing annotation to handle vectors of + connectors in a convenient way).
Modelica.Blocks.MathInteger
MultiSwitch
+ Sum
+ Product
+ TriggeredAdd		 Mathematical blocks for Integer signals.
Modelica.Blocks.Boolean
MultiSwitch
+ And
+ Or
+ Xor
+ Nand
+ Nor
+ Not
+ RisingEdge
+ FallingEdge
+ ChangingEdge
+ OnDelay		 Mathematical blocks for Boolean signals. + Some of these blocks are available also in library + Logical. + The new design is based on the connectorSizing annotation that allows + the convenient handling of an arbitrary number of input signals + (e.g., the \"And\" block has 1,2,...,N inputs, instead of only 2 inputs + in the Logical library). + Additionally, the icons are smaller so that the diagram area is + better utilized
Modelica.Blocks.Sources
RadioButtonSource Boolean signal source that mimics a radio button.
IntegerTable Generate an Integer output signal based on a table matrix + with [time, yi] values.
Modelica.Electrical.Analog.Examples
SimpleTriacCircuit,
+ IdealTriacCircuit,
+ AD_DA_conversion 		Examples for the newly introduced Analog components.
Modelica.Electrical.Analog.Ideal
IdealTriac,
+ AD_Converter,
+ DA_Converter 		AD and DA converter, ideal triac (based on ideal thyristor).
Modelica.Electrical.Analog.Semiconductors
SimpleTriac Simple triac based on semiconductor thyristor model.
Modelica.Electrical.Digital.Examples
Delay_example,
+ DFFREG_example,
+ DFFREGL_example,
+ DFFREGSRH_example,
+ DFFREGSRL_example,
+ DLATREG_example,
+ DLATREGL_example,
+ DLATREGSRH_example,
+ DLATREGSRL_example,
+ NXFER_example,
+ NRXFER_example,
+ BUF3S_example,
+ INV3S_example,
+ WiredX_example 		Examples for the newly introduced Digital components.
Modelica.Electrical.Digital.Interfaces
UX01,
+ Strength,
+ MIMO 		Interfaces for the newly introduced Digital components.
Modelica.Electrical.Digital.Tables
ResolutionTable,
+ StrengthMap,
+ NXferTable,
+ NRXferTable,
+ PXferTable,
+ PRXferTable,
+ Buf3sTable,
+ Buf3slTable 		New Digital table components.
Modelica.Electrical.Digital.Delay
InertialDelaySensitiveVector New Digital delay component.
Modelica.Electrical.Digital.Registers
DFFR,
+ DFFREG,
+ DFFREGL,
+ DFFSR,
+ DFFREGSRH,
+ DFFREGSRL,
+ DLATR,
+ DLATREG,
+ DLATREGL,
+ DLATSR,
+ DLATREGSRH,
+ DLATREGSRL 		Various register components (collection of flipflops and latches) + according to the VHDL standard.
Modelica.Electrical.Digital.Tristates
NXFERGATE,
+ NRXFERGATE,
+ PXFERGATE,
+ PRXFERGATE,
+ BUF3S,
+ BUF3SL,
+ INV3S,
+ INV3SL,
+ WiredX 		Transfer gates, buffers, inverters and wired node.
Modelica.Electrical.Polyphase.Basic
MutualInductor Polyphase inductor providing a mutual inductance matrix model.
ZeroInductor Polyphase zero sequence inductor.
Modelica.Electrical.Machines
Examples Structured according to machine types:
+ InductionMachines
+ SynchronousMachines
+ DCMachines
+ Transformers
Losses.* Parameter records and models for losses in electrical machines and transformers (where applicable):
+ Friction losses
+ Brush losses
+ Stray Load losses
+ Core losses (only eddy current losses but no hysteresis losses; not for transformers)
Thermal.* Simple thermal ambience, to be connected to the thermal ports of machines,
+ as well as material constants and utility functions.
Icons.* Icons for transient and quasi-static electrical machines and transformers.
Modelica.Electrical.Machines.Examples.InductionMachines.
AIMC_withLosses Induction machine with squirrel cage with losses
AIMC_Transformer Induction machine with squirrel cage - transformer starting
AIMC_withLosses Test example of an induction machine with squirrel cage with losses
Modelica.Electrical.Machines.Examples.SynchronousMachines.
SMPM_CurrentSource Permanent magnet synchronous machine fed by a current source
SMEE_LoadDump Electrical excited synchronous machine with voltage controller
Modelica.Electrical.Machines.Examples.DCMachines.
DCSE_SinglePhase Series excited DC machine, fed by sinusoidal voltage
DCPM_Temperature Permanent magnet DC machine, demonstration of varying temperature
DCPM_Cooling Permanent magnet DC machine, coupled with a simple thermal model
DCPM_QuasiStatic Permanent magnet DC machine, comparison between transient and quasi-static model
DCPM_Losses Permanent magnet DC machine, comparison between model with and without losses
Modelica.Electrical.Machines.BasicMachines.QuasiStaticDCMachines.
DC_PermanentMagnet
+ DC_ElectricalExcited
+ DC_SeriesExcited 		QuasiStatic DC machines, i.e., neglecting electrical transients
Modelica.Electrical.Machines.BasicMachines.Components.
InductorDC Inductor model which neglects der(i) if Boolean parameter quasiStatic = true
Modelica.Electrical.Machines.Interfaces.
ThermalPortTransformer
+ PowerBalanceTransformer 		Thermal ports and power balances for electrical machines and transformers.
Modelica.Electrical.Machines.Utilities
SwitchedRheostat Switched rheostat, used for starting induction motors with slipring rotor.
RampedRheostat Ramped rheostat, used for starting induction motors with slipring rotor.
SynchronousMachineData The parameters of the synchronous machine model with electrical excitation (and damper) are calculated + from parameters normally given in a technical description, + according to the standard EN 60034-4:2008 Appendix C.
Modelica.Mechanics.MultiBody.Examples.Elementary.
HeatLosses Demonstrate the modeling of heat losses.
UserDefinedGravityField Demonstrate the modeling of a user-defined gravity field.
Surfaces Demonstrate the visualization of a sine surface,
+ as well as a torus and a wheel constructed from a surface.
Modelica.Mechanics.MultiBody.Joints.
FreeMotionScalarInit Free motion joint that allows initialization and state selection
+ of single elements of the relevant vectors
+ (e.g., initialize r_rel_a[2] but not the other elements of r_rel_a;
+ this new component fixes ticket + #274)
Modelica.Mechanics.MultiBody.Visualizers.
Torus Visualizing a torus.
VoluminousWheel Visualizing a voluminous wheel.
PipeWithScalarField Visualizing a pipe with scalar field quantities along the pipe axis.
Modelica.Mechanics.MultiBody.Visualizers.ColorMaps.
jet
+ hot
+ gray
+ spring
+ summer
+ autumn
+ winter 		Functions returning different color maps.
Modelica.Mechanics.MultiBody.Visualizers.Colors.
colorMapToSvg Save a color map on file in svg (scalable vector graphics) format.
scalarToColor Map a scalar to a color using a color map.
Modelica.Mechanics.MultiBody.Visualizers.Advanced.
Surface Visualizing a moveable, parameterized surface;
+ the surface characteristic is provided by a function
+ (this new component fixes ticket + #181)
PipeWithScalarField Visualizing a pipe with a scalar field.
Modelica.Mechanics.MultiBody.Visualizers.Advanced.SurfaceCharacteristics.
torus Function defining the surface characteristic of a torus.
pipeWithScalarField Function defining the surface characteristic of a pipe
+ where a scalar field value is displayed with color along the pipe axis.
Modelica.Mechanics.Rotational.Examples.
HeatLosses Demonstrate the modeling of heat losses.
Modelica.Mechanics.Translational.Examples.
HeatLosses Demonstrate the modeling of heat losses.
Modelica.Fluid.Fittings.Bends
CurvedBend
+ EdgedBend		 New fitting (pressure loss) components.
Modelica.Fluid.Fittings.Orifices.
ThickEdgedOrifice New fitting (pressure loss) component.
Modelica.Fluid.Fittings.GenericResistances.
VolumeFlowRate New fitting (pressure loss) component.
Modelica.Math
isEqual Determine if two Real scalars are numerically identical.
Modelica.Math.Vectors
find Find element in vector.
toString Convert a real vector to a string.
interpolate Interpolate in a vector.
relNodePositions Return vector of relative node positions (0..1).
Modelica.Math.Vectors.Utilities
householderVector
+ householderReflection
+ roots 		Utility functions for vectors that are used by the newly introduced functions, + but are only of interest for a specialist.
Modelica.Math.Matrices
continuousRiccati
+ discreteRiccati 		Return solution of continuous-time and discrete-time + algebraic Riccati equation respectively.
continuousSylvester
+ discreteSylvester 		Return solution of continuous-time and discrete-time + Sylvester equation respectively.
continuousLyapunov
+ discreteLyapunov 		Return solution of continuous-time and discrete-time + Lyapunov equation respectively.
trace Return the trace of a matrix.
conditionNumber Compute the condition number of a matrix.
rcond Estimate the reciprocal condition number of a matrix.
nullSpace Return a orthonormal basis for the null space of a matrix.
toString Convert a matrix into its string representation.
flipLeftRight Flip the columns of a matrix in left/right direction.
flipUpDown Flip the rows of a matrix in up/down direction.
cholesky Perform Cholesky factorization of a real symmetric positive definite matrix.
hessenberg Transform a matrix to upper Hessenberg form.
realSchur Computes the real Schur form of a matrix.
frobeniusNorm Return the Frobenius norm of a matrix.
Modelica.Math.Matrices.LAPACK.
dtrevc
+ dpotrf
+ dtrsm
+ dgees
+ dtrsen
+ dgesvx
+ dhseqr
+ dlange
+ dgecon
+ dgehrd
+ dgeqrf
+ dggevx
+ dgesdd
+ dggev
+ dggevx
+ dhgeqz
+ dormhr
+ dormqr
+ dorghr		 New interface functions for LAPACK + (should usually not directly be used but only indirectly via + Modelica.Math.Matrices).
Modelica.Math.Matrices.Utilities.
reorderRSF
+ continuousRiccatiIterative
+ discreteRiccatiIterative
+ eigenvaluesHessenberg
+ toUpperHessenberg
+ householderReflection
+ householderSimilarityTransformation
+ findLokal_tk		 Utility functions for matrices that are used by the newly introduced functions, + but are only of interest for a specialist.
Modelica.Math.Nonlinear
quadratureLobatto Return the integral of an integrand function using an adaptive Lobatto rule.
solveOneNonlinearEquation Solve f(u) = 0 in a very reliable and efficient way + (f(u_min) and f(u_max) must have different signs).
Modelica.Math.Nonlinear.Examples.
quadratureLobatto1
+ quadratureLobatto2
+ solveNonlinearEquations1
+ solveNonlinearEquations2 		Examples that demonstrate the usage of the Modelica.Math.Nonlinear functions + to integrate over functions and to solve scalar nonlinear equations.
Modelica.Math.BooleanVectors.
allTrue Returns true, if all elements of the Boolean input vector are true.
anyTrue Returns true, if at least on element of the Boolean input vector is true.
oneTrue Returns true, if exactly one element of the Boolean input vector is true.
firstTrueIndex Returns the index of the first element of the Boolean vector that + is true and returns 0, if no element is true
Modelica.Icons.
Information
+ Contact
+ ReleaseNotes
+ References
+ ExamplesPackage
+ Example
+ Package
+ BasesPackage
+ VariantsPackage
+ InterfacesPackage
+ SourcesPackage
+ SensorsPackage
+ MaterialPropertiesPackage
+ MaterialProperty 		New icons to get a unified view on different categories + of packages.
Modelica.SIunits.
ComplexCurrent
+ ComplexCurrentSlope
+ ComplexCurrentDensity
+ ComplexElectricPotential
+ ComplexPotentialDifference
+ ComplexVoltage
+ ComplexVoltageSlope
+ ComplexElectricFieldStrength
+ ComplexElectricFluxDensity
+ ComplexElectricFlux
+ ComplexMagneticFieldStrength
+ ComplexMagneticPotential
+ ComplexMagneticPotentialDifference
+ ComplexMagnetomotiveForce
+ ComplexMagneticFluxDensity
+ ComplexMagneticFlux
+ ComplexReluctance
+ ComplexImpedance
+ ComplexAdmittance
+ ComplexPower		 SIunits to be used in physical models using complex variables, e.g.,
+ Modelica.Electrical.QuasiStatic, + Modelica.Magnetic.FundamentalWave
ImpulseFlowRate
+ AngularImpulseFlowRate		 New SIunits for mechanics.
+ +


+The following existing components +have been improved in a +backward compatible way: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Modelica.Blocks.Sources.
Pulse
+ SawTooth 		New parameter \"nperiod\" introduced to define the number of periods + for the signal type. Default is \"infinite number of periods + (nperiods=-1).
Modelica.Electrical.
Polyphase.* All dissipative components have now an optional heatPort connector + to which the dissipated losses are transported in form of heat. +
Machines.* To all electric machines (asynchronous and synchronous induction machines, DC machines) + and transformers loss models have been added (where applicable):
+ Temperature dependent resistances (ohmic losses)
+ Friction losses
+ Brush losses
+ Stray Load losses
+ Core losses (only eddy current losses but no hysteresis losses; not for transformers)
+ As default, temperature dependency and losses are set to zero.

+ To all electric machines (asynchronous and synchronous induction machines, DC machines) + and transformers conditional thermal ports have been added, + to which the dissipated losses are flowing, if activated. + The thermal port contains a HeatPort + for each loss source of the specific machine type.

+ To all electric machines (asynchronous and synchronous induction machines, DC machines) + a \"powerBalance\" result record has been added, summarizing converted power and losses. +
Modelica.Mechanics.
MultiBody.*
+ Rotational.*
+ Translational.*		 All dissipative components in Modelica.Mechanics have now an + optional heatPort connector to which the dissipated energy is + transported in form of heat.
+ All icons in Modelica.Mechanics are unified according to the + Modelica.Blocks library:
+ \"%name\": width: -150 .. 150, height: 40, color: blue
+ other text: height: 30, color: black +
Modelica.Mechanics.MultiBody.
World Function gravityAcceleration is made replaceable, so that redeclaration + yields user-defined gravity fields. +
Modelica.Fluid.Valves.
ValveIncompressible
+ ValveVaporizing
+ ValveCompressible		 (a) Optional filtering of opening signal introduced to model + the delay time of the opening/closing drive. In this case, an optional + leakageOpening can be defined to model leakage flow and/or to + improve the numerics in certain situations. + (b) Improved regularization of the valve characteristics in some cases + so that it is twice differentiable (smooth=2), + instead of continuous (smooth=0).
Modelica.Fluid.Sources.
FixedBoundary
+ Boundary_pT
+ Boundary_ph		 Changed the implementation so that no non-linear algebraic + equation system occurs, if the given variables (e.g. p,T,X) do + not correspond to the medium states (e.g. p,h,X). This is + achieved by using appropriate \"setState_xxx\" calls to compute the + medium state from the given variables. If a nonlinear equation + system occurs, it is solved by a specialized handler inside the + setState_xxx(..) function, but in the model this equation system is + not visible.
Modelica.Media.Interfaces.
PartialMedium The min/max values of types SpecificEnthalpy, SpecificEntropy, + SpecificHeatCapacity increased, due to reported user problems.
+ New constant C_nominal introduced to provide nominal values for + trace substances (utilized in Modelica.Fluid to avoid numerical problems; + this fixes ticket + #393).
Modelica.Thermal.
HeatTransfer.* All icons are unified according to the + Modelica.Blocks library:
+ \"%name\": width: -150 .. 150, height: 40, color: blue
+ other text: height: 30, color: black +
Modelica.Math.Matrices
QR A Boolean input \"pivoting\" has been added (now QR(A, pivoting)) to provide QR-decomposition without pivoting (QR(A, false)). Default is pivoting=true.
+ +


+The following critical errors have been fixed (i.e., errors +that can lead to wrong simulation results): +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Modelica.Electrical.Digital.Delay.
InertialDelaySensitive In order to decide whether the rising delay (tLH) or + the falling delay (tHL) is used, the \"previous\" value of the + output y has to be used and not the \"previous\" value of the + input x (delayType = delayTable[y_old, x] and not + delayType = delayTable[x_old, x]). This has been corrected.
Modelica.Mechanics.MultiBody.Parts.
BodyBox
+ BodyCylinder 		Fixes ticket + #373: + The \"Center of Mass\" was calculated as normalize(r)*length/2. This is + only correct if the box/cylinder is attached between frame_a and frame_b. + If this is not the case, the calculation is wrong. + The has been fixed by using the correct formula:
+ r_shape + normalize(lengthDirection)*length/2
BodyShape
+ BodyBox
+ BodyCylinder 		Fixes ticket + #300: + If parameter enforceStates=true, an error occurred. + This has been fixed.
Modelica.Mechanics.Rotational.Components.
LossyGear In cases where the driving flange is not obvious, the component could + lead to a non-convergent event iteration. This has been fixed + (a detailed description is provided in ticket + #108 + and in the + attachment + of this ticket).
Gearbox If useSupport=false, the support flange of the internal LossyGear + model was connected to the (disabled) support connector. As a result, the + LossyGear was \"free floating\". This has been corrected.
Modelica.Fluid.Pipes.
DynamicPipe Bug fix for dynamic mass, energy and momentum balances + for pipes with nParallel>1.
Modelica.Fluid.Pipes.BaseClasses.HeatTransfer.
PartialPipeFlowHeatTransfer Calculation of Reynolds numbers for the heat transfer through + walls corrected, if nParallel>1. + This partial model is used by LocalPipeFlowHeatTransfer + for laminar and turbulent forced convection in pipes.
Modelica.Media.Interfaces.PartialLinearFluid
setState_psX Sign error fixed.
Modelica.Media.CompressibleLiquids.
LinearColdWater Fixed wrong values for thermal conductivity and viscosity.
+ +


+The following uncritical errors have been fixed (i.e., errors +that do not lead to wrong simulation results, but, e.g., +units are wrong or errors in documentation): +

+ + + + +
Modelica.Math.Matrices.LAPACK
dgesv_vec
+ dgesv
+ dgetrs
+ dgetrf
+ dgetrs_vec
+ dgetri
+ dgeqpf
+ dorgqr
+ dgesvx
+ dtrsyl		 Integer inputs to specify leading dimensions of matrices have got a lower bound 1 (e.g., lda=max(1,n)) + to avoid incorrect values (e.g., lda=0) in the case of empty matrices.
+ The Integer variable \"info\" to indicate the successful call of a LAPACK routine has been converted to an output where it had been a protected variable.
+ +


+The following trac tickets have been fixed: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Modelica
+ #155Wrong usage of \"fillColor\" and \"fillPattern\" annotations for lines
+ #211Undefined function realString used in MSL
+ #216Make MSL version 3.2 more Modelica 3.1 conform
+ #218Replace `Modelica://`-URIs by `modelica://`-URIs
+ #271Documentation URI errors in MSL 3.1
+ #292Remove empty \"\" annotations\"
+ #294Typo 'w.r.t' --> 'w.r.t.'
+ #296Unify disclaimer message and improve bad style \"here\" links
+ #333Fix real number formats of the form `.[0-9]+`
+ #347invalid URI in MSL 3.2
+ #355Non-standard annotations

Modelica.Blocks
+ #227Enhance unit deduction functionality by adding 'unit=\"1\"' to some blocks\"
+ #349Incorrect annotation in Blocks/Continuous.mo
+ #374Parameter with no value at all in Modelica.Blocks.Continuous.TransferFunction

Modelica.Constants
+ #356Add Euler-Mascheroni constant to Modelica.Constants

Modelica.Electrical.Analog
+ #346Multiple text in Modelica.Electrical.Analog.Basic.Conductor
+ #363Mixture of Real and Integer in index expressions in Modelica.Electrical.Analog.Lines
+ #384Incomplete annotations in some examples
+ #396Bug in Modelica.Electrical.Analog.Ideal.ControlledIdealIntermediateSwitch

Modelica.Machines
+ #276Improve/fix documentation of Modelica.Electrical.Machines
+ #288Describe thermal concept of machines
+ #301Documentation of Electrical.Machines.Examples needs update
+ #306Merge content of `Modelica.Electrical.Machines.Icons` into `Modelica.Icons`
+ #362Incomplete example model for DC machines
+ #375Strangeness with final parameters with no value but a start value

Modelica.Electrical.Polyphase
+ #173m-phase mutual inductor
+ #200adjust Polyphase to Analog
+ #277Improve/fix documentation of Modelica.Electrical.Polyphase
+ #352Odd annotation in Modelica.Electrical.Polyphase.Sources.SignalVoltage

Modelica.Fluid
+ #215Bug in Modelica.Fluid.Pipes.DynamicPipe
+ #219Fluid.Examples.HeatExchanger: Heat transfer is switched off and cannot be enabled

Modelica.Math
+ #348Small error in documentation
+ #371Modelica.Math functions declared as \"C\" not \"builtin\"\"

Modelica.Mechanics.MultiBody
+ #50Error in LineForce handling of potential root
+ #71Make MultiBody.World replaceable
+ #1813d surface visualisation
+ #210Description of internal gear wheel missing
+ #242Missing each qualifier for modifiers in MultiBody.
+ #251Using enforceStates=true for BodyShape causes errors
+ #255Error in Revolute's handling of non-normalized axis of rotations
+ #268Non-standard annotation in MultiBody,Examples.Systems.RobotR3
+ #269What is the purpose of MultiBody.Examples.Systems.RobotR3.Components.InternalConnectors?
+ #272Function World.gravityAcceleration should not be protected
+ #274Convenient and mighty initialization of frame kinematics
+ #286Typo in Multibody/Frames.mo
+ #300enforceStates parameter managed incorrectly in BodyShape, BodyBox, BodyCylinder
+ #320Replace non-standard annotation by `showStartAttribute`
+ #373Error in Modelica Mechanics
+ #389Shape.rxvisobj wrongly referenced in Arrow/DoubleArrow

Modelica.Mechanics.Rotational
+ #108Problem with model \"Lossy Gear\" and approach to a solution
+ #278Improve/fix documentation of Modelica.Mechanics.Rotational
+ #381Bug in Modelica.Mechanics.Rotational.Gearbox

Modelica.Mechanics.Translational
+ #279Improve/fix documentation of Modelica.Mechanics.Translational
+ #310Erroneous image links in `Modelica.Mechanics.Translational`

Modelica.Media
+ #72PartialMedium functions not provided for all media in Modelica.Media
+ #217Missing image file Air.png
+ #224dpT calculation in waterBaseProp_dT
+ #393Provide C_nominal in Modelica.Media to allow propagating + value and avoid wrong numerical results

Modelica.StateGraph
+ #206Syntax error in StateGraph.mo
+ #261Modelica.StateGraph should mention the availability of Modelica_StateGraph2
+ #354Bad annotation in Modelica.StateGraph.Temporary.NumericValue

Modelica.Thermal.FluidHeatFlow
+ #280Improve/fix documentation of Modelica.Thermal.FluidHeatFlow

Modelica.Thermal.HeatTransfer
+ #281Improve/fix documentation of Modelica.Thermal.HeatTransfer

Modelica.UsersGuide
+ #198Name of components in MSL not according to naming conventions
+ #204Minor correction to User's Guide's section on version management
+ #244Update the contacts section of the User's Guide
+ #267MSL-Documentation: Shouldn't equations be numbered on the right hand side?
+ #299SVN keyword expansion messed up the User's guide section on version management

Modelica.Utilities
+ #249Documentation error in ModelicaUtilities.h

ModelicaServices
+ #248No uses statement on ModelicaServices in MSL 3.1
+ +

+Note: +

+ +")); +end Version_3_2; + +class Version_3_1 "Version 3.1 (August 14, 2009)" + extends Modelica.Icons.ReleaseNotes; + + annotation (Documentation(info=" + +

+Version 3.1 is backward compatible to version 3.0 and 3.0.1, +i.e., models developed with version 3.0 or 3.0.1 will work without any +changes also with version 3.1. +

+ +

+Version 3.1 is slightly based on the Modelica Specification 3.1. It uses +the following new language elements (compared to Modelica Specification 3.0): +

+ + + +

+The following new libraries have been added: +

+ + + + + + + + + +
Modelica.Fluid + Components to model 1-dim. thermo-fluid flow in networks of vessels, pipes, + fluid machines, valves and fittings. All media from the + Modelica.Media library can be used (so incompressible or compressible, + single or multiple substance, one or two phase medium). + The library is using the stream-concept from Modelica Specification 3.1. +
Modelica.Magnetic.FluxTubes + Components to model magnetic devices based on the magnetic flux tubes concepts. + Especially to model + electromagnetic actuators. Nonlinear shape, force, leakage, and + Material models. Material data for steel, electric sheet, pure iron, + Cobalt iron, Nickel iron, NdFeB, Sm2Co17, and more. +
ModelicaServices + New top level package that shall contain functions and models to be used in the + Modelica Standard Library that requires a tool specific implementation. + ModelicaServices is then used in the Modelica package. + In this first version, the 3-dim. animation with model Modelica.Mechanics.MultiBody.Visualizers.Advanced.Shape + was moved to ModelicaServices. Tool vendors can now provide their own implementation + of the animation. +
+ +


+The following new components have been added +to existing libraries: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Modelica.
versionBuild
versionDate
dateModified
revisionId 		New annotations from Modelica 3.1 for version handling added.
Modelica.UsersGuide.ReleaseNotes.
VersionManagement Copied from info layer of previous ReleaseNotes (to make it more + visible) and adapted it to the new possibilities in + Modelica Specification 3.1.
Modelica.Blocks.Math.
RectangularToPolar
+ PolarToRectangular 		New blocks to convert between rectangular and polar form + of space phasors.
Modelica.Blocks.Routing.
Replicator New block to replicate an input signal to many output signals.
Modelica.Electrical.Analog.Examples.
AmplifierWithOpAmpDetailed
+ HeatingResistor
+ CompareTransformers
+ OvervoltageProtection
+ ControlledSwitchWithArc
+ SwitchWithArc
+ ThyristorBehaviourTest		 New examples to demonstrate the usage of new components.
Modelica.Electrical.Analog.Basic.
OpAmpDetailed
+ TranslationalEMF
+ M_Transformer		 New detailed model of an operational amplifier.
+ New electromotoric force from electrical energy into mechanical translational energy.
+ Generic transformer with choosable number of inductors
Modelica.Electrical.Analog.Ideal.
OpenerWithArc
+ CloserWithArc
+ ControlledOpenerWithArc
+ ControlledCloserWithArc		 New switches with simple arc model.
Modelica.Electrical.Analog.Interfaces.
ConditionalHeatPort New partial model to add a conditional HeatPort to + an electrical component.
Modelica.Electrical.Analog.Lines.
M_Oline New multiple line model, both the number of lines and the number of segments choosable.
Modelica.Electrical.Analog.Semiconductors.
ZDiode
Thyristor		 Zener Diode with 3 working areas and simple thyristor model.
Modelica.Electrical.Polyphase.Ideal.
OpenerWithArc
CloserWithArc		 New switches with simple arc model (as in Modelica.Electrical.Analog.Ideal.
Modelica.Mechanics.MultiBody.Examples.Elementary.
RollingWheel
+ RollingWheelSetDriving
+ RollingWheelSetPulling		 New examples to demonstrate the usage of new components.
Modelica.Mechanics.MultiBody.Joints.
RollingWheel
+ RollingWheelSet		 New joints (no mass, no inertia) that describe an + ideal rolling wheel and a ideal rolling wheel set consisting + of two wheels rolling on the plane z=0.
Modelica.Mechanics.MultiBody.Parts.
RollingWheel
+ RollingWheelSet		 New ideal rolling wheel and ideal rolling wheel set consisting + of two wheels rolling on the plane z=0.
Modelica.Mechanics.MultiBody.Visualizers.
Ground New model to visualize the ground (box at z=0).
Modelica.Mechanics.Rotational.Interfaces.
PartialElementaryOneFlangeAndSupport2
+ PartialElementaryTwoFlangesAndSupport2		 New partial model with one and two flanges and the support flange + with a much simpler implementation as previously.
Modelica.Mechanics.Translational.Interfaces.
PartialElementaryOneFlangeAndSupport2
+ PartialElementaryTwoFlangesAndSupport2		 New partial model with one and two flanges and the support flange + with a much simpler implementation as previously.
Modelica.Media.IdealGases.Common.MixtureGasNasa.
setSmoothState Return thermodynamic state so that it smoothly approximates: + if x > 0 then state_a else state_b.
Modelica.Utilities.Internal.
PartialModelicaServices New package containing the interface description of + models and functions that require a tool dependent + implementation (currently only \"Shape\" for 3-dim. animation, + but will be extended in the future)
Modelica.Thermal.HeatTransfer.Components.
ThermalCollector New auxiliary model to collect the heat flows + from m heatports to a single heatport; + useful for polyphase resistors (with heatports) + as a junction of the m heatports.
Modelica.Icons.
VariantLibrary
+ BaseClassLibrary
+ ObsoleteModel		 New icons (VariantLibrary and BaseClassLibrary have been moved + from Modelica_Fluid.Icons to this place).
Modelica.SIunits.
ElectricalForceConstant New type added (#190).
Modelica.SIunits.Conversions.
from_Hz
+ to_Hz		 New functions to convert between frequency [Hz] and + angular velocity [1/s]. (#156)
+ +


+The following existing components +have been improved in a +backward compatible way: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Modelica.
Blocks
Mechanics
StateGraph 		Provided missing parameter values for examples + (these parameters had only start values)
Modelica.Electrical.Analog.Basic
Resistor, Conductor, VariableResistor, VariableConductor Conditional heatport added for coupling to thermal network.
Modelica.Electrical.Analog.Ideal
Thyristors, Switches, IdealDiode Conditional heatport added for coupling to thermal network.
Modelica.Electrical.Analog.Semiconductors
Diode, ZDiode, PMOS, NMOS, NPN, PNP Conditional heatport added for coupling to thermal network.
Modelica.Electrical.Polyphase.Basic
Resistor, Conductor, VariableResistor, VariableConductor Conditional heatport added for coupling to thermal network (as in Modelica.Electrical.Analog).
Modelica.Electrical.Polyphase.Ideal
Thyristors, Switches, IdealDiode Conditional heatport added for coupling to thermal network (as in Modelica.Electrical.Analog).
Modelica.Mechanics.MultiBody.Visualizers.Advanced.
Shape New implementation by inheriting from ModelicaServices. This allows a + tool vendor to provide its own implementation of Shape.
Modelica.StateGraph.
Examples Introduced \"StateGraphRoot\" on the top level of all example models.
Modelica.StateGraph.Interfaces.
StateGraphRoot
PartialCompositeStep
CompositeStepState 		Replaced the wrong Modelica code \"flow output Real xxx\" + by \"Real dummy; flow Real xxx;\". + As a side effect, several \"blocks\" had to be changed to \"models\".
PartialStep Changed model by packing the protected outer connector in to a model. + Otherwise, there might be differences in the sign of the flow variable + in Modelica 3.0 and 3.1.
Modelica.Utilities.Examples.
expression Changed local variable \"operator\" to \"opString\" since \"operator\" + is a reserved keyword in Modelica 3.1
+ +


+The following uncritical errors have been fixed (i.e., errors +that do not lead to wrong simulation results, but, e.g., +units are wrong or errors in documentation): +

+ + + + + + + + + + + + + + + +
Modelica.
Many models Removed wrong usages of annotations fillColor and fillPattern + in text annotations (#155, #185).
Modelica.Electrical.Machines
All machine models The conditional heatports of the instantiated resistors + (which are new in Modelica.Electrical.Analog and Modelica.Electrical.Polyphase) + are finally switched off until a thermal connector design for machines is implemented.
Modelica.Media.Air.MoistAir
saturationPressureLiquid
+ sublimationPressureIce
+ saturationPressure		 For these three functions, an error in the derivative annotation was corrected. However, the effect of + this bug was minor, as a Modelica tool was allowed to compute derivatives automatically via + the smoothOrder annotation.
Modelica.Math.Matrices.
eigenValues Wrong documentation corrected (#162)
+ +")); +end Version_3_1; + +class Version_3_0_1 "Version 3.0.1 (Jan. 27, 2009)" + extends Modelica.Icons.ReleaseNotes; + + annotation (Documentation(info=" + +

+This Modelica package is provided under the Modelica License 2 +and no longer under Modelica License 1.1. There are the following reasons +why the Modelica Association changes from Modelica License 1.1 to this +new license text (note, the text below is not a legal interpretation of the +Modelica License 2. In case of a conflict, the language of the license shall prevail): +

+ +
    +
  1. The rights of licensor and licensee are much more clearly defined. For example: + + We hope that this compromise between open source contributors, commercial + Modelica environments and Modelica users will motivate even more people to + provide their Modelica packages freely under the Modelica License 2.

    2. +
  2. There are several new provisions that shall make law suites against licensors and licensees more unlikely (so the small risk is further reduced).
    3. +
+ +


+The following new components have been added +to existing libraries: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Electrical.Analog.Basic.
M_Transformer Transformer, with the possibility to + choose the number of inductors. The inductances and the coupled inductances + can be chosen arbitrarily.
Electrical.Analog.Lines.
M_OLine Segmented line model that enables the use of + multiple lines, that means, the number of segments and the number of + single lines can be chosen by the user. The model allows to investigate + phenomena at multiple lines like mutual magnetic or capacitive influence.
Mechanics.Translational.Components.Examples.
Brake Demonstrates the usage of the translational brake component.
Media.Interfaces.PartialMedium.
ThermoStates Enumeration type for independent variables to identify the independent + variables of the medium (pT, ph, phX, pTX, dTX).
+ An implementation of this enumeration is provided for every medium. + (This is useful for fluid libraries that do not use the + PartialMedium.BaseProperties model).
setSmoothState Function that returns the thermodynamic state which smoothly approximates: + if x > 0 then state_a else state_b.
+ (This is useful for pressure drop components in fluid libraries + where the upstream density and/or viscosity has to be computed + and these properties should be smooth a zero mass flow rate)
+ An implementation of this function is provided for every medium.
Media.Common.
smoothStep Approximation of a general step, such that the characteristic + is continuous and differentiable.
Media.UsersGuide.
Future Short description of goals and changes of upcoming release of Modelica.Media.
Media.Media.Air.MoistAir.
isentropicExponent Implemented Missing Function from interface.
isentropicEnthalpyApproximation Implemented function that approximates the isentropic enthalpy change. +This is only correct as long as there is no liquid in the stream.
+ +


+The following existing components +have been changed (in a +backward compatible way): +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Mechanics.Rotational.Interfaces.
PartialFriction Improvement of friction model so that in certain situations + the number of iterations is much smaller.
Mechanics.Translational.Components.Examples.
Friction Added a third variant, where friction is modelled with + the SupportFriction component.
Mechanics.Translational.Components.
MassWithStopAndFriction Improvement of friction model so that in certain situations + the number of iterations is much smaller.
Mechanics.Translational.Interfaces.
PartialFriction Improvement of friction model so that in certain situations + the number of iterations is much smaller.
Media.Examples.
SimpleLiquidWater
+ IdealGasH20
+ WaterIF97
+ MixtureGases
+ MoistAir 		Added equations to test the new setSmoothState(..) functions + including the analytic derivatives of these functions.
Media.Interfaces.PartialLinearFluid.
setState_pTX
+ setState_phX
+ setState_psX
+ setState_dTX 		Rewritten function in one statement so that it is usually inlined.
Media.Interfaces.PartialLinearFluid.
consistent use of reference_d instead of density(state Change was done to achieve consistency with analytic inverse functions.
Media.Air.MoistAir.
T_phX Interval of nonlinear solver to compute T from p,h,X changed + from 200..6000 to 240 ..400 K.
+ +


+The following critical errors have been fixed (i.e., errors +that can lead to wrong simulation results): +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Mechanics.MultiBody.Forces
WorldTorque Parameter \"ResolveInFrame\" was not propagated and therefore + always the default (resolved in world frame) was used, independently + of the setting of this parameter.
WorldForceAndTorque Parameter \"ResolveInFrame\" was not propagated and therefore + always the default (resolved in world frame) was used, independently + of the setting of this parameter.
+ Furthermore, internally WorldTorque was used instead of + Internal.BasicWorldTorque and therefore the visualization of + worldTorque was performed twice.
Mechanics.MultiBody.Sensors
AbsoluteSensor Velocity, acceleration and angular acceleration were computed + by differentiating in the resolveInFrame frame. This has been corrected, by + first transforming the vectors in to the world frame, differentiating here + and then transforming into resolveInFrame. The parameter in the Advanced menu + resolveInFrameAfterDifferentiation is then superfluous and was removed .
AbsoluteVelocity The velocity was computed + by differentiating in the resolveInFrame frame. This has been corrected, by + first transforming the velocity in to the world frame, differentiating here + and then transforming into resolveInFrame
RelativeSensor If resolveInFrame <> frame_resolve and + resolveInFrameAfterDifferentiation = frame_resolve, a translation + error occurred, since frame_resolve was not enabled in this situation. + This has been corrected.
RelativeVelocity The velocity has have been computed + by differentiating in the resolveInFrame frame. This has been corrected, by + first transforming the relative position in to frame_a, differentiating here + and then transforming into resolveInFrame
TransformRelativeVector The transformation was wrong, since the parameters frame_r_in and frame_r_out + have not been propagated to the submodel that performs the transformation. + This has been corrected.
Mechanics.Translational.Components.
SupportFriction
+ Brake 		The sign of the friction force was wrong and therefore friction accelerated + instead of decelerated. This was fixed.
SupportFriction The component was only correct for fixed support. + This was corrected.
Media.Interfaces.
PartialSimpleMedium
+ PartialSimpleIdealGasMedium 		BaseProperties.p was not defined as preferred state and BaseProperties.T was + always defined as preferred state. This has been fixed by + Defining p,T as preferred state if parameter preferredMediumState = true. + This error had the effect that mass m is selected as state instead of p + and if default initialization is used then m=0 could give not the expected + behavior. This means, simulation is not wrong but the numerics is not as good + and if a model relies on default initial values, the result could be not + as expected.
+ +


+The following uncritical errors have been fixed (i.e., errors +that do not lead to wrong simulation results, but, e.g., +units are wrong or errors in documentation): +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Blocks.Math.
InverseBlockConstraint Changed annotation preserveAspectRatio from true to false.
Blocks.Sources.
RealExpression
+ IntegerExpression
+ BooleanExpression 		Changed annotation preserveAspectRatio from true to false.
Electrical.Analog.Basic.
SaturatingInductor Replaced non-standard \"arctan\" by \"atan\" function.
Modelica.Electrical.Digital.
UsersGuide Removed empty documentation placeholders and added the missing + release comment for version 1.0.7
Modelica.Mechanics.Translational.Components.
MassWithStopAndFriction Changed usage of reinit(..), in order that it appears + only once for one variable according to the language specification + (if a tool could simulate the model, there is no difference).
Media.Interfaces.PartialSimpleMedium
pressure
+ temperature
+ density
+ specificEnthalpy 		Missing functions added.
+ +")); +end Version_3_0_1; + +class Version_3_0 "Version 3.0 (March 1, 2008)" + extends Modelica.Icons.ReleaseNotes; + + annotation (Documentation(info=" +

+Version 3.0 is not backward compatible to previous versions. +A conversion script is provided to transform models and libraries +of previous versions to the new version. Therefore, conversion +should be automatic. +

+ +

+The following changes are present for the whole library: +

+ + + +


+The following new components have been added +to existing libraries (note, the names in parentheses +are the new sublibrary names that are introduced in version 3.0): +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Blocks.Examples.
InverseModel Demonstrates the construction of an inverse model.
Blocks.Math.
InverseBlockConstraints Construct inverse model by requiring that two inputs + and two outputs are identical (replaces the previously, + unbalanced, TwoInputs and TwoOutputs blocks).
Electrical.Machines.Utilities
TransformerData A record that calculates required impedances (parameters) from nominal data of transformers.
Mechanics.MultiBody.Examples.Rotational3DEffects
GyroscopicEffects
+ ActuatedDrive
+ MovingActuatedDrive
+ GearConstraint 		New examples to demonstrate the usage of the Rotational library + in combination with multi-body components.
Mechanics.MultiBody.Sensors
AbsolutePosition
+ AbsoluteVelocity
+ AbsoluteAngles
+ AbsoluteAngularVelocity
+ RelativePosition
+ RelativeVelocity
+ RelativeAngles
+ RelativeAngularVelocity		 New sensors to measure one vector.
TransformAbsoluteVector
+ TransformRelativeVector		 Transform absolute and/or relative vector into another frame.
Mechanics.Rotational.(Components)
Disc Right flange is rotated by a fixed angle with respect to left flange
IdealRollingWheel Simple 1-dim. model of an ideal rolling wheel without inertia
Mechanics.Translational.Sensors
RelPositionSensor
RelSpeedSensor
RelAccSensor
PowerSensor		 Relative position sensor, i.e., distance between two flanges
+ Relative speed sensor
+ Relative acceleration sensor
+ Ideal power sensor
Mechanics.Translational(.Components)
SupportFriction
Brake
InitializeFlange		 Model of friction due to support
+ Model of a brake, base on Coulomb friction
+ Initializes a flange with pre-defined position, speed and acceleration .
Mechanics.Translational(.Sources)
Force2
LinearSpeedDependentForce
QuadraticSpeedDependentForce
+ ConstantForce
ConstantSpeed
ForceStep		 Force acting on 2 flanges
+ Force linearly dependent on flange speed
+ Force quadratic dependent on flange speed
+ Constant force source
+ Constant speed source
+ Force step
+ +


+The following existing components +have been changed in a +non-backward compatible way +(the conversion script transforms models and libraries +of previous versions to the new version. Therefore, conversion +should be automatic): +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Blocks.Continuous.
CriticalDamping New parameter \"normalized\" to define whether filter is provided + in normalized or non-normalized form. Default is \"normalized = true\". + The previous implementation was a non-normalized filter. + The conversion script automatically introduces the modifier + \"normalized=false\" for existing models.
Blocks.Interfaces.
RealInput
+ RealOutput		 Removed \"SignalType\", since extending from a replaceable class + and this is not allowed in Modelica 3.
The conversion script + removes modifiers to SignalType.
RealSignal
+ IntegerSignal
+ BooleanSignal		 Moved to library ObsoleteModelica3, since these connectors + are no longer allowed in Modelica 3
+ (prefixes input and/or output are required).
Blocks.Interfaces.Adaptors.
AdaptorReal
+ AdaptorBoolean
+ AdaptorInteger		 Moved to library ObsoleteModelica3, since the models are not \"balanced\". + These are completely obsolete adaptors
between the Real, Boolean, Integer + signal connectors of version 1.6 and version ≥ 2.1 of the Modelica + Standard Library.
Blocks.Math.
ConvertAllUnits Moved to library ObsoleteModelica3, since extending from a replaceable class + and this is not allowed in Modelica 3.
It would be possible to rewrite this + model to use a replaceable component. However, the information about the + conversion
cannot be visualized in the icon in this case.
Blocks.Math.UnitConversions.
TwoInputs
+ TwoOutputs		 Moved to library ObsoleteModelica3, since the models are not \"balanced\". + A new component
\"InverseBlockConstraints\" + is provided instead that has the same feature, but is \"balanced\".
Electrical.Analog.Basic.
HeatingResistor The heatPort has to be connected; otherwise the component Resistor (without heatPort) has to be used.
+ cardinality() is only used to check whether the heatPort is connected.
Electrical.Polyphase.Examples.
Changed the instance names of components used in the examples to more up-to-date style.
Electrical.Machines.
Moved package Machines.Examples.Utilities to Machines.Utilities
Removed all nonSIunits; especially in DCMachines
+ parameter NonSIunits.AngularVelocity_rpm rpmNominal was replaced by
+ parameter SIunits.AngularVelocity wNominal
Changed the following component variable and parameter names to be more concise:
+ Removed suffix \"DamperCage\" from all synchronous machines + since the user can choose whether the damper cage is present or not.
+ RotorAngle ... RotorDisplacementAngle
+ J_Rotor ... Jr
+ Rr ........ Rrd (damper of synchronous machines)
+ Lrsigma ... Lrsigmad (damper of synchronous machines)
+ phi_mechanical ... phiMechanical
+ w_mechanical ..... wMechanical
+ rpm_mechanical ... rpmMechanical
+ tau_electrical ... tauElectrical
+ tau_shaft ........ tauShaft
+ TurnsRatio ....... turnsRatio (AIMS)
+ VsNom ............ VsNominal (AIMS)
+ Vr_Lr ............ VrLockedRotor (AIMS)
+ DamperCage ....... useDamperCage (synchronous machines)
+ V0 ............... VsOpenCicuit (SMPM)
+ Ie0 .............. IeOpenCicuit (SMEE) +
Interfaces. Moved as much code as possible from specific machine models to partials to reduce redundant code.
Interfaces.Adapter Removed to avoid cardinality; instead, the following solution has been implemented:
Sensors.RotorDisplacementAngle
Interfaces.PartialBasicMachine		 Introduced parameter Boolean useSupport=false \"enable / disable (=fixed stator) support\"
+ The rotational support connector is only present with useSupport = true;
+ otherwise the stator is fixed internally.
Electrical.Machines.Examples.
Changed the names of the examples to more meaningful names.
+ Changed the instance names of components used in the examples to more up-to-date style.
SMEE_Generator Initialization of smee.phiMechanical with fixed=true
Mechanics.MultiBody.
World Changed default value of parameter driveTrainMechanics3D from false to true.
+ 3-dim. effects in Rotor1D, Mounting1D and BevelGear1D are therefore taken
+ into account by default (previously this was only the case, if + world.driveTrainMechanics3D was explicitly set).
Mechanics.MultiBody.Forces.
FrameForce
+ FrameTorque
+ FrameForceAndTorque		 Models removed, since functionality now available via Force, Torque, ForceAndTorque
WorldForce
+ WorldTorque
+ WorldForceAndTorque
+ Force
+ Torque
+ ForceAndTorque		 Connector frame_resolve is optionally enabled via parameter resolveInFrame
. + Forces and torques and be resolved in all meaningful frames defined + by enumeration resolveInFrame.
Mechanics.MultiBody.Frames.
length
+ normalize		 Removed functions, since available also in Modelica.Math.Vectors +
The conversion script changes the references correspondingly.
Mechanics.MultiBody.Joints.
Prismatic
+ ActuatedPrismatic
+ Revolute
+ ActuatedRevolute
+ Cylindrical
+ Universal
+ Planar
+ Spherical
+ FreeMotion		 Changed initialization, by replacing initial value parameters with + start/fixed attributes.
+ When start/fixed attributes are properly supported + in the parameter menu by a Modelica tool,
+ the initialization is considerably simplified for the + user and the implementation is much simpler.
+ Replaced parameter \"enforceStates\" by the more general + built-in enumeration stateSelect=StateSelection.xxx.
+ The conversion script automatically + transforms from the \"old\" to the \"new\" forms.
Revolute
+ ActuatedRevolute		 Parameter \"planarCutJoint\" in the \"Advanced\" menu of \"Revolute\" and of + \"ActuatedRevolute\" removed.
+ A new joint \"RevolutePlanarLoopConstraint\" introduced that defines the constraints + of a revolute joint
as cut-joint in a planar loop. + This change was needed in order that the revolute joint can be + properly used
in advanced model checking.
+ ActuatedRevolute joint removed. Flange connectors of Revolute joint
+ can be enabled with parameter useAxisFlange.
Prismatic
+ ActuatedPrismatic		 ActuatedPrismatic joint removed. Flange connectors of Prismatic joint
+ can be enabled with parameter useAxisFlange.
Assemblies Assembly joint implementation slightly changed, so that + annotation \"structurallyIncomplete\"
could be removed + (all Assembly joint models are now \"balanced\").
Mechanics.MultiBody.Joints.Internal
RevoluteWithLengthConstraint
+ PrismaticWithLengthConstraint		 These joints should not be used by a user of the MultiBody library. + They are only provided to built-up the + MultiBody.Joints.Assemblies.JointXYZ joints. + These two joints have been changed in a slightly not backward compatible + way, in order that the usage in the Assemblies.JointXYZ joints results in + balanced models (no conversion is provided for this change since the + user should not have used these joints and the conversion would be too + complicated): + In releases before version 3.0 of the Modelica Standard Library, + it was possible to activate the torque/force projection equation + (= cut-torque/-force projected to the rotation/translation + axis must be identical to + the drive torque/force of flange axis) via parameter axisTorqueBalance. + This is no longer possible, since otherwise this model would not be + \"balanced\" (= same number of unknowns as equations). Instead, when + using this model in version 3.0 and later versions, the torque/force + projection equation must be provided in the Advanced menu of joints + Joints.SphericalSpherical and Joints.UniversalSpherical + via the new parameter \"constraintResidue\".
Mechanics.MultiBody.Parts.
BodyBox
+ BodyCylinder		 Changed unit of parameter density from g/cm3 to the SI unit kg/m3 + in order to allow stricter unit checking.
The conversion script multiplies + previous density values with 1000.
Body
+ BodyShape
+ BodyBox
+ BodyCylinder
+ PointMass + Rotor1D		 Changed initialization, by replacing initial value parameters with + start/fixed attributes.
+ When start/fixed attributes are properly supported + in the parameter menu by a Modelica tool,
+ the initialization is considerably simplified for the + user and the implementation is much simpler.
The conversion script automatically + transforms from the \"old\" to the \"new\" form of initialization.
Mechanics.MultiBody.Sensors.
AbsoluteSensor
+ RelativeSensor
+ CutForceAndTorque		 New design of sensor components: Via Boolean parameters
+ signal connectors for the respective vectors are enabled/disabled.
+ It is not possible to automatically convert models to this new design.
+ Instead, references in existing models are changed to ObsoleteModelice3.
+ This means that these models must be manually adapted.
CutForce
+ CutTorque		 Slightly new design. The force and/or torque component can be + resolved in world, frame_a, or frame_resolved.
+ Existing models are automatically converted.
Mechanics.Rotational.
Moved components to structured sub-packages (Sources, Components)
Inertia
+ SpringDamper
+ RelativeStates		 Changed initialization, by replacing initial value parameters with + start/fixed attributes.
+ When start/fixed attributes are properly supported + in the parameter menu by a Modelica tool,
+ the initialization is considerably simplified for the + user and the implementation is much simpler.
+ Parameter \"stateSelection\" in \"Inertia\" and \"SpringDamper\" replaced + by the built-in enumeration
stateSelect=StateSelection.xxx. + Introduced the \"stateSelect\" enumeration in \"RelativeStates\".
+ The conversion script automatically + transforms from the \"old\" to the \"new\" forms.
LossyGear
+ GearBox		 Renamed gear ratio parameter \"i\" to \"ratio\", in order to have a + consistent naming convention.
+ Existing models are automatically converted.
SpringDamper
+ ElastoBacklash
+ Clutch
+ OneWayClutch		 Relative quantities (phi_rel, w_rel) are used as states, if possible + (due to StateSelect.prefer).
+ In most cases, relative states in drive trains are better suited as + absolute states.
This change might give changes in the selected states + of existing models.
+ This might give rise to problems if, e.g., the initialization was not + completely defined in a user model,
since the default + initialization heuristic may give different initial values.
Mechanics.Translational.
Moved components to structured sub-packages (Sources, Components)
Adaptions corresponding to Rotational
Stop Renamed to Components.MassWithStopAndFriction to be more concise.
+ MassWithStopAndFriction is not available with a support connector,
+ since the reaction force can't be modeled in a meaningful way due to reinit of velocity v.
+ Until a sound implementation of a hard stop is available, the old model may be used.
Media.
constant nX
+ constant nXi
+ constant reference_X
+ BaseProperties		 The package constant nX = nS, now always, even for single species media. This also allows to define mixtures with only 1 element. The package constant nXi=if fixedX then 0 else if reducedX or nS==1 then nS - 1 else nS. This required that all BaseProperties for single species media get an additional equation to define the composition X as {1.0} (or reference_X, which is {1.0} for single species). This will also mean that all user defined single species media need to be updated by that equation.
SIunits.
CelsiusTemperature Removed, since no SI unit. The conversion script changes references to + SIunits.Conversions.NonSIunits.Temperature_degC
ThermodynamicTemperature
+ TemperatureDifference		 Added annotation \"absoluteValue=true/false\" + in order that unit checking is possible
+ (the unit checker needs to know for a unit that has an offset, + whether it is used as absolute or as a relative number)
SIunits.Conversions.NonSIunits.
Temperature_degC
+ Temperature_degF
+ Temperature_degRk 		Added annotation \"absoluteValue=true\" + in order that unit checking is possible
+ (the unit checker needs to know for a unit that has an offset, + whether it is used as absolute or as a relative number)
StateGraph.Examples.
ControlledTanks The connectors of the ControlledTanks did not fulfill the new + restrictions of Modelica 3. This has been fixed.
Utilities Replacing inflow, outflow by connectors inflow1, inflow2, + outflow1, outflow2 with appropriate input/output prefixes in + order to fulfill the restrictions of Modelica 3 to arrive + at balanced models. No conversion is provided, since + too difficult and since the non-backward compatible change is in + an example.
Thermal.FluidHeatFlow.Sensors.

+ pSensor
TSensor
dpSensor
dTSensor
m_flowSensor
V_flowSensor
H_flowSensor		 renamed to:
+ PressureSensor
TemperatureSensor
RelPressureSensor
RelTemperatureSensor
MassFlowSensor
VolumeFlowSensor
EnthalpyFlowSensor +
Thermal.FluidHeatFlow.Sources.
Ambient
PrescribedAmbient		 available as one combined component Ambient
+ Boolean parameters usePressureInput and useTemperatureInput decide + whether pressure and/or temperature are constant or prescribed
ConstantVolumeFlow
PrescribedVolumeFlow		 available as one combined component VolumeFlow
+ Boolean parameter useVolumeFlowInput decides + whether volume flow is constant or prescribed
ConstantPressureIncrease
PrescribedPressureIncrease		 available as one combined component PressureIncrease
+ Boolean parameter usePressureIncreaseInput decides + whether pressure increase is constant or prescribed
Thermal.FluidHeatFlow.Examples.
Changed the instance names of components used in the examples to more up-to-date style.
Thermal.HeatTransfer.(Components)
HeatCapacitor Initialization changed: SteadyStateStart removed. Instead + start/fixed values for T and der_T
(initial temperature and its derivative).


HeatCapacitor
ThermalConductor
ThermalConvection
BodyRadiation

+ TemperatureSensor
RelTemperatureSensor
HeatFlowSensor

+ FixedTemperature
PrescribedTemperature
FixedHeatFlow
PrescribedHeatFlow		 Moved components to sub-packages:

+ Components.HeatCapacitor
Components.ThermalConductor
Components.ThermalConvection
Components.BodyRadiation

+ Sensors.TemperatureSensor
Sensors.RelTemperatureSensor
Sensors.HeatFlowSensor

+ Sources.FixedTemperature
Sources.PrescribedTemperature
Sources.FixedHeatFlow
Sources.PrescribedHeatFlow +
Thermal.FluidHeatFlow.Examples.
Changed the instance names of components used in the examples to more up-to-date style.
+ +


+The following existing components +have been improved in a +backward compatible way: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Modelica.* Parameter declarations, input and output function arguments without description + strings improved
by providing meaningful description texts. +
Modelica.Blocks.Continuous.
TransferFunction Internal scaling of the controller canonical states introduced + in order to enlarge the range of transfer functions where the default + relative tolerance of the simulator is sufficient.
Butterworth
CriticalDamping 		Documentation improved and plots of the filter characteristics added.
Electrical.Analog.Basic.
EMF New parameter \"useSupport\" to optionally enable a support connector.
Icons.
RectangularSensor
+ RoundSensor		 Removed drawing from the diagram layer (kept drawing only in + icon layer),
in order that this icon can be used in situations + where components are dragged in the diagram layer.
Math.Vectors.
normalize Implementation changed, so that the result is always continuous
+ (previously, this was not the case for small vectors: normalize(eps,eps)). +
Mechanics.MultiBody.
Renamed non-standard keywords defineBranch, defineRoot, definePotentialRoot, + isRooted to the standard names:
+ Connections.branch/.root/.potentialRoot/.isRooted.
Frames Added annotation \"Inline=true\" to all one-line functions + (which should be all inlined).
Mechanics.MultiBody.Parts.
Mounting1D
+ Rotor1D
+ BevelGear1D		 Changed implementation so that no longer modifiers for connector + variables are used,
because this violates the restrictions on + \"balanced models\" of Modelica 3.
Mechanics.Rotational.
InitializeFlange Changed implementation so that counting unknowns and + equations is possible without actual values of parameters.
Thermal.FluidHeatFlow.Interfaces.
TwoPort Introduced parameter Real tapT(final min=0, final max=1)=1
that defines the temperature of the heatPort + between inlet and outlet.
StateGraph.
InitialStep
+ InitialStepWithSignal
+ Step
+ StepWithSignal		 Changed implementation so that no longer modifiers for output + variables are used,
because this violates the restrictions on + \"balanced models\" of Modelica 3.
+ +


+The following critical errors have been fixed (i.e., errors +that can lead to wrong simulation results): +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Electrical.Analog.Examples.
CauerLowPassSC Wrong calculation of Capacitor1 both in Rn and Rp corrected + (C=clock/R instead of C=clock*R)
Mechanics.MultiBody.Parts.
Rotor1D The 3D reaction torque was not completely correct and gave in + some situations a wrong result. This bug should not influence the + movement of a multi-body system, but only the constraint torques + are sometimes not correct.
Mechanics.Rotational.
ElastoBacklash If the damping torque was too large, the reaction torque + could \"pull\" which is unphysical. The component was + newly written by limiting the damping torque in such a case + so that \"pulling\" torques can no longer occur. Furthermore, + during initialization the characteristics is made continuous + to reduce numerical errors. The relative angle and relative + angular velocities are used as states, if possible + (StateSelect.prefer), since relative quantities lead usually + to better behavior.
Position
Speed
Accelerate
Move		 The movement of the flange was wrongly defined as absolute; + this is corrected as relative to connector support.
+ For Accelerate, it was necessary to rename + RealInput a to a_ref, as well as the start values + phi_start to phi.start and w_start to w.start. + The conversion script performs the necessary conversion of + existing models automatically.
Media.Interfaces.
PartialSimpleIdealGasMedium Inconsistency in reference temperature corrected. This may give + different results for functions:
+ specificEnthalpy, specificInternalEnergy, specificGibbsEnergy, + specificHelmholtzEnergy.
Media.Air.
specificEntropy Small bug in entropy computation of ideal gas mixtures corrected.
Media.IdealGases.Common.MixtureGasNasa
specificEntropy Small bug in entropy computation of ideal gas mixtures corrected.
+ +


+The following uncritical errors have been fixed (i.e., errors +that do not lead to wrong simulation results, but, e.g., +units are wrong or errors in documentation): +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Blocks.Tables.
CombiTable2D Documentation improved.
Electrica.Digital.Gates
AndGate
+ NandGate
+ OrGate
+ NorGate
+ XorGate
+ XnorGate		 The number of inputs was not correctly propagated + to the included base model.
+ This gave a translation error, if the number + of inputs was changed (and not the default used).
Electrica.Digital.Sources
Pulse Model differently implemented, so that + warning message about \"cannot properly initialize\" is gone.
Mechanics.Rotational.
BearingFriction
+ Clutch
+ OneWayClutch
+ Brake
+ Gear 		Declaration of table parameter changed from + table[:,:] to table[:,2].
Modelica.Mechanics.MultiBody.Examples.Loops.Utilities.
GasForce Unit of variable \"press\" corrected (from Pa to bar)
StateGraph.Examples.
SimpleFriction The internal parameter k is defined and calculated with the appropriate unit.
Thermal.FluidHeatFlow.Interfaces.
SimpleFriction The internal parameter k is defined and calculated with the appropriate unit.
+ +")); +end Version_3_0; + +class Version_2_2_2 "Version 2.2.2 (Aug. 31, 2007)" + extends Modelica.Icons.ReleaseNotes; + + annotation (Documentation(info=" +

+Version 2.2.2 is backward compatible to version 2.2.1 and 2.2 with +the following exceptions: +

+ + +

+An overview of the differences between version 2.2.2 and the previous +version 2.2.1 is given below. The exact differences (but without +differences in the documentation) are available in +Differences-Modelica-221-222.html. +This comparison file was generated automatically with Dymola's +ModelManagement.compare function. +

+ +

+In this version, no new libraries have been added. The documentation +of the whole library was improved. +

+ +


+The following new components have been added +to existing libraries: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Blocks.Logical.
TerminateSimulation Terminate a simulation by a given condition.
Blocks.Routing.
RealPassThrough
+ IntegerPassThrough
+ BooleanPassThrough		 Pass a signal from input to output + (useful in combination with a bus due to restrictions + of expandable connectors).
Blocks.Sources.
KinematicPTP2 Directly gives q,qd,qdd as output (and not just qdd as KinematicPTP). +
Electrical.Machines.Examples.
TransformerTestbench Transformer Testbench +
Rectifier6pulse 6-pulse rectifier with 1 transformer +
Rectifier12pulse 12-pulse rectifier with 2 transformers +
AIMC_Steinmetz Induction machine squirrel cage with Steinmetz connection +
Electrical.Machines.BasicMachines.Components.
BasicAIM Partial model for induction machine +
BasicSM Partial model for synchronous machine +
PartialAirGap Partial air gap model +
BasicDCMachine Partial model for DC machine +
PartialAirGapDC Partial air gap model of a DC machine +
BasicTransformer Partial model of three-phase transformer +
PartialCore Partial model of transformer core with 3 windings +
IdealCore Ideal transformer with 3 windings +
Electrical.Machines.BasicMachines.
Transformers Sub-Library for technical 3phase transformers +
Electrical.Machines.Interfaces.
Adapter Adapter to model housing of electrical machine +
Math.
Vectors New library of functions operating on vectors +
atan3 Four quadrant inverse tangent (select solution that is closest to given angle y0) +
asinh Inverse of sinh (area hyperbolic sine) +
acosh Inverse of cosh (area hyperbolic cosine) +
Math.Vectors
isEqual Determine if two Real vectors are numerically identical +
norm Return the p-norm of a vector +
length Return length of a vector (better as norm(), if further symbolic processing is performed) +
normalize Return normalized vector such that length = 1 and prevent zero-division for zero vector +
reverse Reverse vector elements (e.g., v[1] becomes last element) +
sort Sort elements of vector in ascending or descending order +
Math.Matrices
solve2 Solve real system of linear equations A*X=B with a B matrix + (Gaussian elimination with partial pivoting) +
LU_solve2 Solve real system of linear equations P*L*U*X=B with a B matrix + and an LU decomposition (from LU(..)) +
Mechanics.Rotational.
InitializeFlange Initialize a flange according to given signals + (useful if initialization signals are provided by a signal bus). +
Media.Interfaces.PartialMedium.
density_pTX Return density from p, T, and X or Xi +
Media.Interfaces.PartialTwoPhaseMedium.
BaseProperties Base properties (p, d, T, h, u, R, MM, x) of a two phase medium +
molarMass Return the molar mass of the medium +
saturationPressure_sat Return saturation pressure +
saturationTemperature_sat Return saturation temperature +
saturationTemperature_derp_sat Return derivative of saturation temperature w.r.t. pressure +
setState_px Return thermodynamic state from pressure and vapour quality +
setState_Tx Return thermodynamic state from temperature and vapour quality +
vapourQuality Return vapour quality +
Media.Interfaces.
PartialLinearFluid Generic pure liquid model with constant cp, + compressibility and thermal expansion coefficients +
Media.Air.MoistAir.
massFraction_pTphi Return the steam mass fraction from relative humidity and T +
saturationTemperature Return saturation temperature from (partial) pressure + via numerical inversion of function saturationPressure +
enthalpyOfWater Return specific enthalpy of water (solid/liquid) near + atmospheric pressure from temperature +
enthalpyOfWater_der Return derivative of enthalpyOfWater()\" function +
PsychrometricData Model to generate plot data for psychrometric chart +
Media.CompressibleLiquids.
+ New sub-library for simple compressible liquid models
LinearColdWater Cold water model with linear compressibility +
LinearWater_pT_Ambient Liquid, linear compressibility water model at 1.01325 bar + and 25 degree Celsius +
SIunits.
TemperatureDifference Type for temperature difference +
+ +


+The following existing components +have been improved: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Blocks.Examples.
BusUsage Example changed from the \"old\" to the \"new\" bus concept with + expandable connectors.
Blocks.Discrete.
ZeroOrderHold Sample output ySample moved from \"protected\" to \"public\" + section with new attributes (start=0, fixed=true). +
TransferFunction Discrete state x with new attributes (each start=0, each fixed=0). +
Electrical.
Analog
Polyphase		 Improved some icons. +
Electrical.Digital.Interfaces.
MISO Removed \"algorithm\" from this partial block. +
Electrical.Digital.Delay.
DelayParams Removed \"algorithm\" from this partial block. +
Electrical.Digital.Delay.
DelayParams Removed \"algorithm\" from this partial block. +
TransportDelay If delay time is zero, an infinitely small delay is + introduced via pre(x) (previously \"x\" was used). +
Electrical.Digital.Sources.
Clock
Step		 Changed if-conditions from \"xxx < time\" to \"time >= xxx\" + (according to the Modelica specification, in the second case + a time event should be triggered, i.e., this change leads + potentially to a faster simulation). +
Electrical.Digital.Converters.
BooleanToLogic
+ LogicToBoolean
+ RealToLogic
+ LogicToReal		 Changed from \"algorithm\" to \"equation\" section + to allow better symbolic preprocessing +
Electrical.
Machines Slightly improved documentation, typos in + documentation corrected +
Electrical.Machines.Examples.
AIMS_start Changed QuadraticLoadTorque1(TorqueDirection=true) to + QuadraticLoadTorque1(TorqueDirection=false) since more realistic +
Electrical.Machines.Interfaces.
PartialBasicMachine Introduced support flange to model the + reaction torque to the housing +
Electrical.Machines.Sensors.
Rotorangle Introduced support flange to model the + reaction torque to the housing +
Mechanics.MultiBody.Examples.Elementary.
PointMassesWithGravity Added two point masses connected by a line force to demonstrate + additionally how this works. Connections of point masses + with 3D-elements are demonstrated in the new example + PointMassesWithGravity (there is the difficulty that the orientation + is not defined in a PointMass object and therefore some + special handling is needed in case of a connection with + 3D-elements, where the orientation of the point mass is not + determined by these elements.
Mechanics.MultiBody.Examples.Systems.
RobotR3 Changed from the \"old\" to the \"new\" bus concept with expandable connectors. + Replaced the non-standard Modelica function \"constrain()\" by + standard Modelica components. As a result, the non-standard function + constrain() is no longer used in the Modelica Standard Library.
Mechanics.MultiBody.Frames.Orientation.
equalityConstraint Use a better residual for the equalityConstraint function. + As a result, the non-linear equation system of a kinematic + loop is formulated in a better way (the range where the + desired result is a unique solution of the non-linear + system of equations becomes much larger).
Mechanics.MultiBody.
Visualizers. Removed (misleading) annotation \"structurallyIncomplete\" + in the models of this sub-library +
Mechanics.Rotational.
Examples For all models in this sub-library: +
    +
  • Included a housing object in all examples to compute + all support torques.
    • +
  • Replaced initialization by modifiers via the + initialization menu parameters of Inertia components.
    • +
  • Removed \"encapsulated\" and unnecessary \"import\".
    • +
  • Included \"StopTime\" in the annotations.
    • +
+
Mechanics.Rotational.Interfaces.
FrictionBase Introduced \"fixed=true\" for Boolean variables startForward, + startBackward, mode. +
Mechanics.Translational.Interfaces.
FrictionBase Introduced \"fixed=true\" for Boolean variables startForward, + startBackward, mode. +
Media.UsersGuide.MediumUsage.
TwoPhase Improved documentation and demonstrating the newly introduced functions +
Media.Examples.
WaterIF97 Provided (missing) units for variables V, dV, H_flow_ext, m, U. +
Media.Interfaces.
PartialMedium Final modifiers are removed from nX and nXi, to allow + customized medium models such as mixtures of refrigerants with oil, etc. +
PartialCondensingGases Included attributes \"min=1, max=2\" for input argument FixedPhase + for functions setDewState and setBubbleState (in order to guarantee + that input arguments are correct). +
Media.Interfaces.PartialMedium.
BaseProperties New Boolean parameter \"standardOrderComponents\". + If true, last element vector X is computed from 1-sum(Xi) (= default) + otherwise, no equation is provided for it in PartialMedium. +
IsentropicExponent \"max\" value changed from 1.7 to 500000 +
setState_pTX
+ setState_phX
+ setState_psX
+ setState_dTX
+ specificEnthalpy_pTX
+ temperature_phX
+ density_phX
+ temperature_psX
+ density_psX
+ specificEnthalpy_psX		 Introduced default value \"reference_X\" for input argument \"X\". +
Media.Interfaces.PartialSimpleMedium.
setState_pTX
+ setState_phX
+ setState_psX
+ setState_dTX		 Introduced default value \"reference_X\" for input argument \"X\". +
Media.Interfaces.PartialSimpleIdealGasMedium.
setState_pTX
+ setState_phX
+ setState_psX
+ setState_dTX		 Introduced default value \"reference_X\" for input argument \"X\". +
Media.Air.MoistAir.
setState_pTX
+ setState_phX
+ setState_dTX		 Introduced default value \"reference_X\" for input argument \"X\". +
Media.IdealGases.Common.SingleGasNasa.
setState_pTX
+ setState_phX
+ setState_psX
+ setState_dTX		 Introduced default value \"reference_X\" for input argument \"X\". +
Media.IdealGases.Common.MixtureGasNasa.
setState_pTX
+ setState_phX
+ setState_psX
+ setState_dTX
+ h_TX		 Introduced default value \"reference_X\" for input argument \"X\". +
Media.Common.
IF97PhaseBoundaryProperties
+ gibbsToBridgmansTables 		Introduced unit for variables vt, vp. +
SaturationProperties Introduced unit for variable dpT. +
BridgmansTables Introduced unit for dfs, dgs. +
Media.Common.ThermoFluidSpecial.
gibbsToProps_ph
+ gibbsToProps_ph
+ gibbsToBoundaryProps
+ gibbsToProps_dT
+ gibbsToProps_pT		 Introduced unit for variables vt, vp. +
TwoPhaseToProps_ph Introduced unit for variables dht, dhd, detph. +
Media.
MoistAir Documentation of moist air model significantly improved. +
Media.MoistAir.
enthalpyOfVaporization Replaced by linear correlation since simpler and more + accurate in the entire region. +
Media.Water.IF97_Utilities.BaseIF97.Regions.
drhovl_dp Introduced unit for variable dd_dp. +
Thermal.
FluidHeatFlow Introduced new parameter tapT (0..1) to define the + temperature of the HeatPort as linear combination of the + flowPort_a (tapT=0) and flowPort_b (tapT=1) temperatures. +
+ +


+The following critical errors have been fixed (i.e., errors +that can lead to wrong simulation results): +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Electrical.Machines.BasicMachines.Components.
ElectricalExcitation Excitation voltage ve is calculated as + \"spacePhasor_r.v_[1]*TurnsRatio*3/2\" instead of + \"spacePhasor_r.v_[1]*TurnsRatio +
Mechanics.MultiBody.Parts.
FixedRotation Bug corrected that the torque balance was wrong in the + following cases (since vector r was not transformed + from frame_a to frame_b; note this special case occurs very seldom in practice): +
  • frame_b is in the spanning tree closer to the root + (usually this is frame_a).
    • +
  • vector r from frame_a to frame_b is not zero.
    • +
+
PointMass If a PointMass model is connected so that no equations are present + to compute its orientation object, the orientation was arbitrarily + set to a unit rotation. In some cases this can lead to a wrong overall + model, depending on how the PointMass model is used. For this reason, + such cases lead now to an error (via an assert(..)) with an explanation + how to fix this. +
Media.Interfaces.PartialPureSubstance.
pressure_dT
+ specificEnthalpy_dT + 		Changed wrong call from \"setState_pTX\" to \"setState_dTX\" +
Media.Interfaces.PartialTwoPhaseMedium.
pressure_dT
+ specificEnthalpy_dT + 		Changed wrong call from \"setState_pTX\" to \"setState_dTX\" +
Media.Common.ThermoFluidSpecial.
gibbsToProps_dT
+ helmholtzToProps_ph
+ helmholtzToProps_pT
+ helmholtzToProps_dT		 Bugs in equations corrected
Media.Common.
helmholtzToBridgmansTables
+ helmholtzToExtraDerivs		 Bugs in equations corrected
Media.IdealGases.Common.SingleGasNasa.
density_derp_T Bug in equation of partial derivative corrected
Media.Water.IF97_Utilities.
BaseIF97.Inverses.dtofps3
+ isentropicExponent_props_ph
+ isentropicExponent_props_pT
+ isentropicExponent_props_dT		 Bugs in equations corrected
Media.Air.MoistAir.
h_pTX Bug in setState_phX due to wrong vector size in h_pTX corrected. + Furthermore, syntactical errors corrected: +
  • In function massFractionpTphi an equation + sign is used in an algorithm.
    • +
  • Two consecutive semicolons removed
    • +
+
Media.Water.
waterConstants Bug in equation of criticalMolarVolume corrected. +
Media.Water.IF97_Utilities.BaseIF97.Regions.
region_ph
+ region_ps		 Bug in region determination corrected. +
boilingcurve_p
+ dewcurve_p		 Bug in equation of plim corrected. +
+ +


+The following uncritical errors have been fixed (i.e., errors +that do not lead to wrong simulation results, but, e.g., +units are wrong or errors in documentation): +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Blocks.
Examples Corrected typos in description texts of bus example models. +
Blocks.Continuous.
LimIntegrator removed incorrect smooth(0,..) because expression might be discontinuous. +
Blocks.Math.UnitConversions.
block_To_kWh
block_From_kWh		 Corrected unit from \"kWh\" to (syntactically correct) \"kW.h\". +
Electrical.Analog.Examples.
HeatingNPN_OrGate Included start values, so that initialization is + successful
Electrical.Analog.Lines.
OLine Corrected unit from \"Siemens/m\" to \"S/m\". +
TLine2 Changed wrong type of parameter NL (normalized length) from + SIunits.Length to Real. +
Electrical.Digital.Delay.
TransportDelay Syntax error corrected + (\":=\" in equation section is converted by Dymola silently to \"=\"). +
Electrical.Digital
Converters Syntax error corrected + (\":=\" in equation section is converted by Dymola silently to \"=\"). +
Electrical.Polyphase.Basic.
Conductor Changed wrong type of parameter G from SIunits.Resistance to + SIunits.Conductance. +
Electrical.Polyphase.Interfaces.
Plug
 Made used \"pin\" connectors non-graphical (otherwise, + there are difficulties to connect to Plug). +
Electrical.Polyphase.Sources.
SineCurrent Changed wrong type of parameter offset from SIunits.Voltage to + SIunits.Current. +
Mechanics.MultiBody.Examples.Loops.
EngineV6 Corrected wrong crankAngleOffset of some cylinders + and improved the example. +
Mechanics.MultiBody.Examples.Loops.Utilities.
GasForce Wrong units corrected: + \"SIunitsPosition x,y\" to \"Real x,y\"; + \"SIunits.Pressure press\" to \"SIunits.Conversions.NonSIunits.Pressure_bar\" +
GasForce2 Wrong unit corrected: \"SIunits.Position x\" to \"Real x\". +
EngineV6_analytic Corrected wrong crankAngleOffset of some cylinders. +
Mechanics.MultiBody.Interfaces.
PartialLineForce Corrected wrong unit: \"SIunits.Position eRod_a\" to \"Real eRod_a\"; +
FlangeWithBearingAdaptor If includeBearingConnector = false, connector \"fr\" + + \"ame\" was not + removed. As long as the connecting element to \"frame\" determines + the non-flow variables, this is fine. In the corrected version, \"frame\" + is conditionally removed in this case.
Mechanics.MultiBody.Forces.
ForceAndTorque Corrected wrong unit: \"SIunits.Force t_b_0\" to \"SIunits.Torque t_b_0\". +
LineForceWithTwoMasses Corrected wrong unit: \"SIunits.Position e_rel_0\" to \"Real e_rel_0\". +
Mechanics.MultiBody.Frames.
axisRotation Corrected wrong unit: \"SIunits.Angle der_angle\" to + \"SIunits.AngularVelocity der_angle\". +
Mechanics.MultiBody.Joints.Assemblies.
JointUSP
JointSSP		 Corrected wrong unit: \"SIunits.Position aux\" to \"Real\" +
Mechanics.MultiBody.Sensors.
AbsoluteSensor Corrected wrong units: \"SIunits.Acceleration angles\" to + \"SIunits.Angle angles\" and + \"SIunits.Velocity w_abs_0\" to \"SIunits.AngularVelocity w_abs_0\" +
RelativeSensor Corrected wrong units: \"SIunits.Acceleration angles\" to + \"SIunits.Angle angles\" +
Distance Corrected wrong units: \"SIunits.Length L2\" to \"SIunits.Area L2\" and + SIunits.Length s_small2\" to \"SIunits.Area s_small2\" +
Mechanics.MultiBody.Visualizers.Advanced.
Shape Changed \"MultiBody.Types.Color color\" to \"Real color[3]\", since + \"Types.Color\" is \"Integer color[3]\" and there have been backward + compatibility problems with models using \"color\" before it was changed + to \"Types.Color\". +
Mechanics.Rotational.Interfaces.
FrictionBase Rewrote equations with new variables \"unitAngularAcceleration\" and + \"unitTorque\" in order that the equations are correct with respect + to units (previously, variable \"s\" can be both a torque and an + angular acceleration and this lead to unit incompatibilities) +
Mechanics.Rotational.
OneWayClutch
LossyGear		 Rewrote equations with new variables \"unitAngularAcceleration\" and + \"unitTorque\" in order that the equations are correct with respect + to units (previously, variable \"s\" can be both a torque and an + angular acceleration and this lead to unit incompatibilities) +
Mechanics.Translational.Interfaces.
FrictionBase Rewrote equations with new variables \"unitAngularAcceleration\" and + \"unitTorque\" in order that the equations are correct with respect + to units (previously, variable \"s\" can be both a torque and an + angular acceleration and this lead to unit incompatibilities) +
Mechanics.Translational.
Speed Corrected unit of v_ref from SIunits.Position to SIunits.Velocity +
Media.Examples.Tests.Components.
PartialTestModel
PartialTestModel2		 Corrected unit of h_start from \"SIunits.Density\" to \"SIunits.SpecificEnthalpy\" +
Media.Examples.SolveOneNonlinearEquation.
Inverse_sh_T + InverseIncompressible_sh_T
+ Inverse_sh_TX		 Rewrote equations so that dimensional (unit) analysis is correct\" +
Media.Incompressible.Examples.
TestGlycol Rewrote equations so that dimensional (unit) analysis is correct\" +
Media.Interfaces.PartialTwoPhaseMedium.
dBubbleDensity_dPressure
dDewDensity_dPressure		 Changed wrong type of ddldp from \"DerDensityByEnthalpy\" + to \"DerDensityByPressure\". +
Media.Common.ThermoFluidSpecial.
ThermoProperties Changed wrong units: + \"SIunits.DerEnergyByPressure dupT\" to \"Real dupT\" and + \"SIunits.DerEnergyByDensity dudT\" to \"Real dudT\" +
ThermoProperties_ph Changed wrong unit from \"SIunits.DerEnergyByPressure duph\" to \"Real duph\" +
ThermoProperties_pT Changed wrong unit from \"SIunits.DerEnergyByPressure dupT\" to \"Real dupT\" +
ThermoProperties_dT Changed wrong unit from \"SIunits.DerEnergyByDensity dudT\" to \"Real dudT\" +
Media.IdealGases.Common.SingleGasNasa.
cp_Tlow_der Changed wrong unit from \"SIunits.Temperature dT\" to \"Real dT\". +
Media.Water.IF97_Utilities.BaseIF97.Basic.
p1_hs
+ h2ab_s
+ p2a_hs
+ p2b_hs
+ p2c_hs
+ h3ab_p
+ T3a_ph
+ T3b_ph
+ v3a_ph
+ v3b_ph
+ T3a_ps
+ T3b_ps
+ v3a_ps
+ v3b_ps		 Changed wrong unit of variables h/hstar, s, sstar from + \"SIunits.Enthalpy\" to \"SIunits.SpecificEnthalpy\", + \"SIunits.SpecificEntropy\", \"SIunits.SpecificEntropy +
Media.Water.IF97_Utilities.BaseIF97.Transport.
cond_dTp Changed wrong unit of TREL, rhoREL, lambdaREL from + \"SIunits.Temperature\", \"SIunit.Density\", \"SIunits.ThermalConductivity\" + to \"Real\". +
Media.Water.IF97_Utilities.BaseIF97.Inverses.
tofps5
tofpst5		 Changed wrong unit of pros from \"SIunits.SpecificEnthalpy\" to + \"SIunits.SpecificEntropy\". +
Media.Water.IF97_Utilities.
waterBaseProp_ph Improved calculation at the limits of the validity. +
Thermal.
FluidHeatFlow
HeatTransfer		 Corrected wrong unit \"SIunits.Temperature\" of difference temperature + variables with \"SIunits.TemperatureDifference\". +
+ +")); +end Version_2_2_2; + +class Version_2_2_1 "Version 2.2.1 (March 24, 2006)" + extends Modelica.Icons.ReleaseNotes; + + annotation (Documentation(info=" + +

+Version 2.2.1 is backward compatible to version 2.2. +

+ +

+In this version, no new libraries have been added. +The following major improvements have been made: +

+ + + +

+The following new components have been added to existing libraries: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Modelica.Blocks.Examples.
PID_Controller Example to demonstrate the usage of the + Blocks.Continuous.LimPID block.
Modelica.Blocks.Math.
UnitConversions.* New package that provides blocks for unit conversions. + UnitConversions.ConvertAllBlocks allows to select all + available conversions from a menu.
Modelica.Electrical.Machines.BasicMachines.SynchronousMachines.
SM_ElectricalExcitedDamperCage Electrical excited synchronous machine with damper cage
Modelica.Electrical.Machines.BasicMachines.Components.
ElectricalExcitation Electrical excitation for electrical excited synchronous + induction machines
DamperCage Unsymmetrical damper cage for electrical excited synchronous + induction machines. At least the user has to specify the dampers + resistance and stray inductance in d-axis; if he omits the + parameters of the q-axis, the same values as for the d.axis + are used, assuming a symmetrical damper.
Modelica.Electrical.Machines.Examples.
SMEE_Gen Test example 7: ElectricalExcitedSynchronousMachine + as Generator
Utilities.TerminalBox Terminal box for three-phase induction machines to choose + either star (wye) ? or delta ? connection
Modelica.Math.Matrices.
equalityLeastSquares Solve a linear equality constrained least squares problem:
+ min|A*x-a|^2 subject to B*x=b
Modelica.Mechanics.MultiBody.
Parts.PointMass Point mass, i.e., body where inertia tensor is neglected.
Interfaces.FlangeWithBearing Connector consisting of 1-dim. rotational flange and its + 3-dim. bearing frame.
Interfaces.FlangeWithBearingAdaptor Adaptor to allow direct connections to the sub-connectors + of FlangeWithBearing.
Types.SpecularCoefficient New type to define a specular coefficient.
Types.ShapeExtra New type to define the extra data for visual shape objects and to + have a central place for the documentation of this data.
Modelica.Mechanics.MultiBody.Examples.Elementary
PointGravityWithPointMasses Example of two point masses in a central gravity field.
Modelica.Mechanics.Rotational.
UsersGuide A User's Guide has been added by using the documentation previously + present in the package documentation of Rotational.
Sensors.PowerSensor New component to measure the energy flow between two connectors + of the Rotational library.
Modelica.Mechanics.Translational.
Speed New component to move a translational flange + according to a reference speed
Modelica.Media.Interfaces.PartialMedium.
specificEnthalpy_pTX New function to compute specific enthalpy from pressure, temperature + and mass fractions.
temperature_phX New function to compute temperature from pressure, specific enthalpy, + and mass fractions.
Modelica.Icons.
SignalBus Icon for signal bus
SignalSubBus Icon for signal sub-bus
Modelica.SIunits.
UsersGuide A User's Guide has been added that describes unit handling.
Resistance
+ Conductance		 Attribute 'min=0' removed from these types.
Modelica.Thermal.FluidHeatFlow.
Components.Valve Simple controlled valve with either linear or + exponential characteristic.
Sources. IdealPump Simple ideal pump (resp. fan) dependent on the shaft's speed; + pressure increase versus volume flow is defined as a linear + function. Torque * Speed = Pressure increase * Volume flow + (without losses).
Examples.PumpAndValve Test example for valves.
Examples.PumpDropOut Drop out of 1 pump to test behavior of semiLinear.
Examples.ParallelPumpDropOut Drop out of 2 parallel pumps to test behavior of semiLinear.
Examples.OneMass Cooling of 1 hot mass to test behavior of semiLinear.
Examples.TwoMass Cooling of 2 hot masses to test behavior of semiLinear.
+ +

+The following components have been improved: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Modelica.
UsersGuide User's Guide and package description of Modelica Standard Library improved.
Modelica.Blocks.Interfaces.
RealInput
+ BooleanInput
+ IntegerInput		 When dragging one of these connectors the width and height + is a factor of 2 larger as a standard icon. Previously, + these connectors have been dragged and then manually enlarged + by a factor of 2 in the Modelica standard library.
Modelica.Blocks.
Continuous.* Initialization options added to all blocks + (NoInit, SteadyState, InitialState, InitialOutput). + New parameter limitsAtInit to switch off the limits + of LimIntegrator or LimPID during initialization
Continuous.LimPID Option to select P, PI, PD, PID controller. + Documentation significantly improved.
Nonlinear.Limiter
+ Nonlinear.VariableLimiter
+ Nonlinear.Deadzone		 New parameter limitsAtInit/deadZoneAtInit to switch off the limits + or the dead zone during initialization
Modelica.Electrical.Analog.
Sources Icon improved (+/- added to voltage sources, arrow added to + current sources).
Modelica.Electrical.Analog.Semiconductors.
Diode smooth() operator included to improve numerics.
Modelica.Electrical.Machines.BasicMachines.SynchronousMachines.
SM_PermanentMagnetDamperCage
+ SM_ElectricalExcitedDamperCage
+ SM_ReluctanceRotorDamperCage		 The user can choose \"DamperCage = false\" (default: true) + to remove all equations for the damper cage from the model.
Modelica.Electrical.Machines.BasicMachines.InductionMachines.
IM_SlipRing Easier parameterization: if the user selects \"useTurnsRatio = false\" + (default: true, this is the same behavior as before), + parameter TurnsRatio is calculated internally from + Nominal stator voltage and Locked-rotor voltage.
Modelica.Math.Matrices.
leastSquaresThe A matrix in the least squares problem might be rank deficient. + Previously, it was required that A has full rank.
Modelica.Mechanics.MultiBody.
all models
    +
  • All components with animation information have a new variable + specularCoefficient to define the reflection of ambient light. + The default value is world.defaultSpecularCoefficient which has + a default of 0.7. By changing world.defaultSpecularCoefficient, the + specularCoefficient of all components is changed that are not + explicitly set differently. Since specularCoefficient is a variable + (and no parameter), it can be changed during simulation. Since + annotation(Dialog) is set, this variable still appears in the + parameter menus.
    + Previously, a constant specularCoefficient of 0.7 was used + for all components.
    • +
  • Variable color of all components is no longer a parameter + but an input variable. Also all parameters in package Visualizers, + with the exception of shapeType are no longer parameters but + defined as input variables with annotation(Dialog). As a result, + all these variables appear still in parameter menus, but they can + be changed during simulation (e.g., color might be used to + display the temperature of a part).
    • +
  • All menus have been changed to follow the Modelica 2.2 annotations + \"Dialog, group, tab, enable\" (previously, a non-standard Dymola + definition for menus was used). Also, the \"enable\" annotation + is used in all menus + to disable input fields if the input would be ignored.
    • +
  • All visual shapes are now defined with conditional declarations + (to remove them, if animation is switched off). Previously, + these (protected) objects have been defined by arrays with + dimension 0 or 1.
    • +
Frames.resolveRelative The derivative of this function added as function and defined via + an annotation. In certain situations, tools had previously + difficulties to differentiate the inlined function automatically.
Forces.* The scaling factors N_to_m and Nm_to_m have no longer a default + value of 1000 but a default value of world.defaultN_to_m (=1000) + and world.defaultNm_to_m (=1000). This allows to change the + scaling factors for all forces and torques in the world + object.
Interfaces.Frame.a
+ Interfaces.Frame.b
+ Interfaces.Frame_resolve		 The Frame connectors are now centered around the origin to ease + the usage. The shape was changed, such that the icon is a factor + of 1.6 larger as a standard icon (previously, the icon had a + standard size when dragged and then the icon was manually enlarged + by a factor of 1.5 in the y-direction in the MultiBody library; + the height of 16 allows easy positioning on the standard grid size of 2). + The double line width of the border in icon and diagram layer was changed + to a single line width and when making a connection the connection + line is dark grey and no longer black which looks better.
Joints.Assemblies.* When dragging an assembly joint, the icon is a factor of 2 + larger as a standard icon. Icon texts and connectors have a + standard size in this enlarged icon (and are not a factor of 2 + larger as previously).
Types.* All types have a corresponding icon now to visualize the content + in the package browser (previously, the types did not have an icon).
Modelica.Mechanics.Rotational.
Inertia Initialization and state selection added.
SpringDamper Initialization and state selection added.
Move New implementation based solely on Modelica 2.2 language + (previously, the Dymola specific constrain(..) function was used).
Modelica.Mechanics.Translational.
Move New implementation based solely on Modelica 2.2 language + (previously, the Dymola specific constrain(..) function was used).
Modelica.Thermal.FluidHeatFlow.Interfaces.
SimpleFriction Calculates friction losses from pressure drop and volume flow.
Modelica.Thermal.FluidHeatFlow.Components.
IsolatedPipe
+ HeatedPipe		 Added geodetic height as a source of pressure change; + feeds friction losses as calculated by simple friction to + the energy balance of the medium.
Modelica.Media.Interfaces.PartialMedium.FluidConstants.
HCRIT0Critical specific enthalpy of the fundamental + equation (base formulation of the fluid medium model).
SCRIT0Critical specific entropy of the fundamental + equation (base formulation of the fluid medium model).
deltahEnthalpy offset (default: 0) between the + specific enthalpy of the fluid model and the user-visible + specific enthalpy in the model: deltah = h_model - h_fundamentalEquation. +
deltasEntropy offset (default: 0) between the + specific entropy of the fluid model and the user-visible + specific entropy in the model: deltas = s_model - s_fundamentalEquation.
T_defaultDefault value for temperature of medium (for initialization)
h_defaultDefault value for specific enthalpy of medium (for initialization)
p_defaultDefault value for pressure of medium (for initialization)
X_defaultDefault value for mass fractions of medium (for initialization)
+

+The following errors have been fixed: +

+ + + + + + + + + + + + + + + + + + + + + +
Modelica.Blocks.Tables.
CombiTable1D
+ CombiTable1Ds
+ CombiTable2D		 Parameter \"tableOnFile\" determines now whether a table is read from + file or used from parameter \"table\". Previously, if \"fileName\" was not + \"NoName\", a table was always read from file \"fileName\", independently + of the setting of \"tableOnFile\". This has been corrected.
+ Furthermore, the initialization of a table is now performed in a + when-clause and no longer in a parameter declaration, because some + tools evaluate the parameter declaration in some situation more than + once and then the table is unnecessarily read several times + (and occupies also more memory).
Modelica.Blocks.Sources.
CombiTimeTable Same bug fix/improvement as for the tables from Modelica.Blocks.Tables + as outlined above.
Modelica.Electrical.Analog.Semiconductors.
PMOS
+ NMOS
+ HeatingPMOS
+ HeatingNMOS		 The Drain-Source-Resistance RDS had actually a resistance of + RDS/v, with v=Beta*(W+dW)/(L+dL). The correct formula is without + the division by \"v\". This has now been corrected.
+ This bug fix should not have an essential effect in most applications. + In the default case (Beta=1e-5), the Drain-Source-Resistance was + a factor of 1e5 too large and had in the default case the + wrong value 1e12, although it should have the value 1e7. The effect + was that this resistance had practically no effect.
Modelica.Media.IdealGases.Common.SingleGasNasa.
dynamicViscosityLowPressure Viscosity and thermal conductivity (which needs viscosity as input) + were computed wrong for polar gases and gas mixtures + (i.e., if dipole moment not 0.0). This has been fixed in version 2.2.1.
Modelica.Utilities.Streams.
readLine Depending on the C-implementation, the stream was not correctly closed. + This has been corrected by adding a \"Streams.close(..)\" + after reading the file content.
+")); +end Version_2_2_1; + +class Version_2_2 "Version 2.2 (April 6, 2005)" + extends Modelica.Icons.ReleaseNotes; + + annotation (Documentation(info=" + +

+Version 2.2 is backward compatible to version 2.1. +

+ +

+The following new libraries have been added: +

+ + + + + + +
Modelica.Media Property models of liquids and gases, especially +
    +
  • 1241 detailed gas models,
    • +
  • moist air,
    • +
  • high precision water model (according to IAPWS/IF97 standard),
    • +
  • incompressible media defined by tables (cp(T), rho(t), eta(T), etc. are defined by tables).
    • +
+ The user can conveniently define mixtures of gases between the + 1241 gas models. The models are + designed to work well in dynamic simulations. They + are based on a new standard interface for media with + single and multiple substances and one or multiple phases + with the following features: +
    +
  • The independent variables of a medium model do not influence the + definition of a fluid connector port or how the + balance equations have to be implemented.
    + Used independent variables: \"p,T\", \"p,T,X\", \"p,h\", \"d,T\".
    • +
  • Optional variables, e.g., dynamic viscosity, are only computed + if needed.
    • +
  • The medium models are implemented with regards to efficient + dynamic simulation.
    • +
+
Modelica.Thermal.FluidHeatFlow Simple components for 1-dim., incompressible thermo-fluid flow + to model coolant flows, e.g., of electrical machines. + Components can be connected arbitrarily together (= ideal mixing + at connection points) and fluid may reverse direction of flow. +
+

+The following changes have been performed in the +Modelica.Mechanics.MultiBody library: +

+ +")); +end Version_2_2; + +class Version_2_1 "Version 2.1 (Nov. 11, 2004)" + extends Modelica.Icons.ReleaseNotes; + + annotation (Documentation(info=" + +

This is a major change with respect to previous versions of the + Modelica Standard Library, because many new libraries and components + are included and because the input/output blocks (Modelica.Blocks) + have been considerably simplified: +

+ + +

+The discussed changes of Modelica.Blocks are not backward compatible. +A script to automatically convert models to this new version is +provided. There might be rare cases, where this script does not convert. +In this case models have to be manually converted. +In any case you should make a back-up copy of your model +before automatic conversion is performed. +

+

+The following new libraries have been added: +

+ + + + + + + + + + + + + + + + + +
Modelica.Electrical.DigitalDigital electrical components based on 2-,3-,4-, and 9-valued logic
+ according to the VHDL standard
Modelica.Electrical.MachinesAsynchronous, synchronous and DC motor and generator models
Modelica.Math.MatricesFunctions operating on matrices such as solve() (A*x=b), leastSquares(),
+ norm(), LU(), QR(), eigenValues(), singularValues(), exp(), ...
Modelica.StateGraph Modeling of discrete event and reactive systems in a convenient way using
+ hierarchical state machines and Modelica as action language.
+ It is based on JGrafchart and Grafcet and has a similar modeling power as
+ StateCharts. It avoids deficiencies of usually used action languages.
+ This library makes the ModelicaAdditions.PetriNets library obsolete.
Modelica.Utilities.FilesFunctions to operate on files and directories (copy, move, remove files etc.)
Modelica.Utilities.StreamsRead from files and write to files (print, readLine, readFile, error, ...)
Modelica.Utilities.StringsOperations on strings (substring, find, replace, sort, scanToken, ...)
Modelica.Utilities.SystemGet/set current directory, get/set environment variable, execute shell command, etc.
+

+The following existing libraries outside of the Modelica standard library +have been improved and added as new libraries +(models using the previous libraries are automatically converted +to the new sublibraries inside package Modelica): +

+ + + + + + + + + + + + + +
Modelica.Blocks.Discrete Discrete input/output blocks with fixed sample period
+ (from ModelicaAdditions.Blocks.Discrete)
Modelica.Blocks.Logical Logical components with Boolean input and output signals
+ (from ModelicaAdditions.Blocks.Logical)
Modelica.Blocks.Nonlinear Discontinuous or non-differentiable algebraic control blocks such as variable limiter,
+ fixed, variable and Pade delay etc. (from ModelicaAdditions.Blocks.Nonlinear)
Modelica.Blocks.Routing Blocks to combine and extract signals, such as multiplexer
+ (from ModelicaAdditions.Blocks.Multiplexer)
Modelica.Blocks.Tables One and two-dimensional interpolation in tables. CombiTimeTable is available
+ in Modelica.Blocks.Sources (from ModelicaAdditions.Tables)
Modelica.Mechanics.MultiBody Components to model the movement of 3-dimensional mechanical systems. Contains
+ body, joint, force and sensor components, analytic handling of kinematic loops,
+ force elements with mass, series/parallel connection of 3D force elements etc.
+ (from MultiBody 1.0 where the new signal connectors are used;
+ makes the ModelicaAdditions.MultiBody library obsolete)
+

+As a result, the ModelicaAdditions library is obsolete, because all components +are either included in the Modelica library or are replaced by much more +powerful libraries (MultiBody, StateGraph). +

+

+The following new components have been added to existing libraries. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Modelica.Blocks.Logical.
Prey = pre(u): Breaks algebraic loops by an infinitesimal small
+ time delay (event iteration continues until u = pre(u))
Edgey = edge(u): Output y is true, if the input u has a rising edge
FallingEdgey = edge(not u): Output y is true, if the input u has a falling edge
Changey = change(u): Output y is true, if the input u has a rising or falling edge
GreaterEqualOutput y is true, if input u1 is greater or equal than input u2
LessOutput y is true, if input u1 is less than input u2
LessEqualOutput y is true, if input u1 is less or equal than input u2
TimerTimer measuring the time from the time instant where the
+ Boolean input became true
Modelica.Blocks.Math.
BooleanToRealConvert Boolean to Real signal
BooleanToIntegerConvert Boolean to Integer signal
RealToBooleanConvert Real to Boolean signal
IntegerToBooleanConvert Integer to Boolean signal
Modelica.Blocks.Sources.
RealExpressionSet output signal to a time varying Real expression
IntegerExpressionSet output signal to a time varying Integer expression
BooleanExpressionSet output signal to a time varying Boolean expression
BooleanTableGenerate a Boolean output signal based on a vector of time instants
Modelica.Mechanics.MultiBody.
Frames.from_T2Return orientation object R from transformation matrix T and its derivative der(T)
Modelica.Mechanics.Rotational.
LinearSpeedDependentTorqueLinear dependency of torque versus speed (acts as load torque)
QuadraticSpeedDependentTorqueQuadratic dependency of torque versus speed (acts as load torque)
ConstantTorqueConstant torque, not dependent on speed (acts as load torque)
ConstantSpeedConstant speed, not dependent on torque (acts as load torque)
TorqueStepConstant torque, not dependent on speed (acts as load torque)
+

+The following bugs have been corrected: +

+ + + + + + + +
Modelica.Mechanics.MultiBody.Forces.
LineForceWithMass
+ Spring		If mass of the line force or spring component is not zero, the
+ mass was (implicitly) treated as \"mass*mass\" instead of as \"mass\"
Modelica.Mechanics.Rotational.
SpeedIf parameter exact=false, the filter was wrong
+ (position was filtered and not the speed input signal)
+

+Other changes: +

+ +")); +end Version_2_1; + +class Version_1_6 "Version 1.6 (June 21, 2004)" + extends Modelica.Icons.ReleaseNotes; + + annotation (Documentation(info=" + +

Added 1 new library (Electrical.Polyphase), 17 new components, + improved 3 existing components + in the Modelica.Electrical library and improved 3 types + in the Modelica.SIunits library. Furthermore, + this User's Guide has been started. The improvements + in more detail: +

+

+New components +

+ + + + + + + + + + + + + + + + + + + + + + + + +
Modelica.Electrical.Analog.Basic.
SaturatingInductorSimple model of an inductor with saturation
VariableResistorIdeal linear electrical resistor with variable resistance
VariableConductorIdeal linear electrical conductor with variable conductance
VariableCapacitorIdeal linear electrical capacitor with variable capacitance
VariableInductorIdeal linear electrical inductor with variable inductance
Modelica.Electrical.Analog.Semiconductors.
HeatingDiodeSimple diode with heating port
HeatingNMOSSimple MOS Transistor with heating port
HeatingPMOSSimple PMOS Transistor with heating port
HeatingNPNSimple NPN BJT according to Ebers-Moll with heating port
HeatingPNPSimple PNP BJT according to Ebers-Moll with heating port
Modelica.Electrical.Polyphase
+ A new library for polyphase electrical circuits
+

+New examples +

+

+The following new examples have been added to +Modelica.Electrical.Analog.Examples: +

+

+CharacteristicThyristors, +CharacteristicIdealDiodes, +HeatingNPN_OrGate, +HeatingMOSInverter, +HeatingRectifier, +Rectifier, +ShowSaturatingInductor +ShowVariableResistor +

+

+Improved existing components +

+

In the library Modelica.Electrical.Analog.Ideal, +a knee voltage has been introduced for the components +IdealThyristor, IdealGTOThyristor, IdealDiode in order +that the approximation of these ideal elements is improved +with not much computational effort.

+

In the Modelica.SIunits library, the following changes + have been made:

+ + + + + + + +
Inductancemin=0 removed
SelfInductancemin=0 added
ThermodynamicTemperaturemin=0 added
+")); +end Version_1_6; + +class Version_1_5 "Version 1.5 (Dec. 16, 2002)" + extends Modelica.Icons.ReleaseNotes; + + annotation (Documentation(info=" + +

Added 55 new components. In particular, added new package + Thermal.HeatTransfer for modeling of lumped + heat transfer, added model LossyGear in Mechanics.Rotational + to model gear efficiency and bearing friction according to a new + theory in a robust way, added 10 new models in Electrical.Analog and + added several other new models and improved existing models. +

+

+New components +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Modelica.Blocks.
Continuous.DerDerivative of input (= analytic differentiations)
ExamplesDemonstration examples of the components of this package
Nonlinear.VariableLimiterLimit the range of a signal with variable limits
Modelica.Blocks.Interfaces.
RealPortReal port (both input/output possible)
IntegerPortInteger port (both input/output possible)
BooleanPortBoolean port (both input/output possible)
SIMOSingle Input Multiple Output continuous control block
IntegerBlockIconBasic graphical layout of Integer block
IntegerMOMultiple Integer Output continuous control block
IntegerSignalSourceBase class for continuous Integer signal source
IntegerMIBooleanMOsMultiple Integer Input Multiple Boolean Output continuous control block with same number of inputs and outputs
BooleanMIMOsMultiple Input Multiple Output continuous control block with same number of inputs and outputs of Boolean type
BusAdaptorsComponents to send signals to the bus or receive signals from the bus
Modelica.Blocks.Math.
RealToIntegerConvert real to integer signals
IntegerToRealConvert integer to real signals
MaxPass through the largest signal
MinPass through the smallest signal
EdgeIndicates rising edge of Boolean signal
BooleanChangeIndicates Boolean signal changing
IntegerChangeIndicates integer signal changing
Modelica.Blocks.Sources.
IntegerConstantGenerate constant signals of type Integer
IntegerStepGenerate step signals of type Integer
Modelica.Electrical.Analog.Basic.
HeatingResistorTemperature dependent electrical resistor
OpAmpSimple nonideal model of an OpAmp with limitation
Modelica.Electrical.Analog.Ideal.
IdealCommutingSwitchIdeal commuting switch
IdealIntermediateSwitchIdeal intermediate switch
ControlledIdealCommutingSwitchControlled ideal commuting switch
ControlledIdealIntermediateSwitchControlled ideal intermediate switch
IdealOpAmpLimitedIdeal operational amplifier with limitation
IdealOpeningSwitchIdeal opener
IdealClosingSwitchIdeal closer
ControlledIdealOpeningSwitchControlled ideal opener
ControlledIdealClosingSwitchControlled ideal closer
Modelica.Electrical.Analog.Lines.
TLine1Lossless transmission line (Z0, TD)
TLine2Lossless transmission line (Z0, F, NL)
TLine2Lossless transmission line (Z0, F)
Modelica.Icons.
FunctionIcon for a function
RecordIcon for a record
EnumerationIcon for an enumeration
Modelica.Math.
tempInterpol2temporary routine for vectorized linear interpolation (will be removed)
Modelica.Mechanics.Rotational.
Examples.LossyGearDemo1Example to show that gear efficiency may lead to stuck motion
Examples.LossyGearDemo2Example to show combination of LossyGear and BearingFriction
LossyGearGear with mesh efficiency and bearing friction (stuck/rolling possible)
Gear2Realistic model of a gearbox (based on LossyGear)
Modelica.SIunits.
ConversionsConversion functions to/from non SI units and type definitions of non SI units
EnergyFlowRateSame definition as Power
EnthalpyFlowRateReal (final quantity=\"EnthalpyFlowRate\", final unit=\"W\")
Modelica.
Thermal.HeatTransfer1-dimensional heat transfer with lumped elements
ModelicaAdditions.Blocks.Discrete.
TriggeredSamplerTriggered sampling of continuous signals
TriggeredMaxCompute maximum, absolute value of continuous signal at trigger instants
ModelicaAdditions.Blocks.Logical.Interfaces.
BooleanMIRealMOsMultiple Boolean Input Multiple Real Output continuous control block with same number of inputs and outputs
RealMIBooleanMOsMultiple Real Input Multiple Boolean Output continuous control block with same number of inputs and outputs
ModelicaAdditions.Blocks.Logical.
TriggeredTrapezoidTriggered trapezoid generator
HysteresisTransform Real to Boolean with Hysteresis
OnOffControllerOn-off controller
CompareTrue, if signal of inPort1 is larger than signal of inPort2
ZeroCrossingTrigger zero crossing of input signal
ModelicaAdditions.
Blocks.Multiplexer.ExtractorExtract scalar signal out of signal vector dependent on IntegerRealInput index
Tables.CombiTable1DsTable look-up in one dimension (matrix/file) with only single input
+

+Package-specific Changes +

+ +

+Class-specific Changes +

+

+Modelica.SIunits +

+

Removed final from quantity attribute for Mass and MassFlowRate.

+

+Modelica.Blocks.Math.Sum +

+

Implemented avoiding algorithm section, which would lead to expensive function calls.

+

Modelica.Blocks.Sources.Step

+
+block Step \"Generate step signals of type Real\"
+        parameter Real height[:]={1} \"Heights of steps\";
+ // parameter Real offset[:]={0} \"Offsets of output signals\";
+// parameter SIunits.Time startTime[:]={0} \"Output = offset for time < startTime\";
+// extends Interfaces.MO          (final nout=max([size(height, 1); size(offset, 1); size(startTime, 1)]));
+        extends Interfaces.SignalSource(final nout=max([size(height, 1); size(offset, 1); size(startTime, 1)]));
+
+

Modelica.Blocks.Sources.Exponentials

+

Replaced usage of built-in function exp by Modelica.Math.exp.

+

Modelica.Blocks.Sources.TimeTable

+

Interface definition changed from

+
+parameter Real table[:, :]=[0, 0; 1, 1; 2, 4] \"Table matrix (time = first column)\";
+
+

to

+
+parameter Real table[:, 2]=[0, 0; 1, 1; 2, 4] \"Table matrix (time = first column)\";
+
+

Did the same for subfunction getInterpolationCoefficients.

+

Bug in getInterpolationCoefficients for startTime <> 0 fixed:

+
+...
+        end if;
+  end if;
+  // Take into account startTime \"a*(time - startTime) + b\"
+  b := b - a*startTime;
+end getInterpolationCoefficients;
+
+

Modelica.Blocks.Sources.BooleanStep

+
+block BooleanStep \"Generate step signals of type Boolean\"
+        parameter SIunits.Time startTime[:]={0} \"Time instants of steps\";
+        parameter Boolean startValue[size(startTime, 1)]=fill(false, size(startTime, 1)) \"Output before startTime\";
+        extends Interfaces.BooleanSignalSource(final nout=size(startTime, 1));
+equation
+        for i in 1:nout loop
+//   outPort.signal[i] = time >= startTime[i];
+          outPort.signal[i] = if time >= startTime[i] then not startValue[i] else startValue[i];
+        end for;
+end BooleanStep;
+
+

+Modelica.Electrical.Analog

+

Corrected table of values and default for Beta by dividing them by 1000 +(consistent with the values used in the NAND-example model): +

+ +

Corrected parameter defaults, unit and description for TrapezoidCurrent. +This makes the parameters consistent with their use in the model. +Models specifying parameter values are not changed. +Models not specifying parameter values did not generate trapezoids previously. +

+

Icon layer background changed from transparent to white:

+ +

Basic.Transformer: Replaced invalid escape characters '\\ ' and '\\[newline]' in documentation by '|'.

+

Modelica.Mechanics.Rotational

+

Removed arrows and names documentation from flanges in diagram layer

+

Modelica.Mechanics.Rotational.Interfaces.FrictionBase

+

Modelica.Mechanics.Rotational.Position

+

Replaced reinit by initial equation

+

Modelica.Mechanics.Rotational.RelativeStates

+

Bug corrected by using modifier stateSelect = StateSelect.prefer as implementation

+

Modelica.Mechanics.Translational.Interfaces.flange_b

+

Attribute fillColor=7 added to Rectangle on Icon layer, i.e., it is now +filled with white and not transparent any more.

+

Modelica.Mechanics.Translational.Position

+

Replaced reinit by initial equation

+

Modelica.Mechanics.Translational.RelativeStates

+

Bug corrected by using modifier stateSelect = StateSelect.prefer as implementation

+

Modelica.Mechanics.Translational.Stop

+

Use stateSelect = StateSelect.prefer.

+

Modelica.Mechanics.Translational.Examples.PreLoad

+

Improved documentation and coordinate system used for example.

+

ModelicaAdditions.Blocks.Nonlinear.PadeDelay

+

Replaced reinit by initial equation

+

ModelicaAdditions.HeatFlow1D.Interfaces

+

Definition of connectors Surface_a and Surface_b:
+flow SIunits.HeatFlux q; changed to flow SIunits.HeatFlowRate q;

+

MultiBody.Parts.InertialSystem

+

Icon corrected.

+")); +end Version_1_5; + +class Version_1_4 "Version 1.4 (June 28, 2001)" + extends Modelica.Icons.ReleaseNotes; + +annotation (Documentation(info=" + + +
+

Version 1.4.1beta1 (February 12, 2001)

+

Adapted to Modelica 1.4

+
+

Version 1.3.2beta2 (June 20, 2000)

+ +
+

Version 1.3.1 (Dec. 13, 1999)

+

+First official release of the library. +

+")); +end Version_1_4; + annotation (Documentation(info=" + +

+This section summarizes the changes that have been performed +on the Modelica standard library. Furthermore, it is explained in +Modelica.UsersGuide.ReleaseNotes.VersionManagement +how the versions are managed. +This is especially important for maintenance (bug fix) releases where the +main version number is not changed. +

+ + + + + + + + + + + + + + + + + + +
Version 4.1.0March 15, 2024
Version 4.0.0June 4, 2020
Version 3.2.3January 23, 2019
Version 3.2.2April 3, 2016
Version 3.2.1August 14, 2013
Version 3.2Oct. 25, 2010
Version 3.1August 14, 2009
Version 3.0.1Jan. 27, 2009
Version 3.0March 1, 2008
Version 2.2.2Aug. 31, 2007
Version 2.2.1March 24, 2006
Version 2.2April 6, 2005
Version 2.1Nov. 11, 2004
Version 1.6June 21, 2004
Version 1.5Dec. 16, 2002
Version 1.4June 28, 2001
+")); +end ReleaseNotes; diff --git a/Modelica/UsersGuide/package.mo b/Modelica/UsersGuide/package.mo new file mode 100644 index 0000000000..1c46093015 --- /dev/null +++ b/Modelica/UsersGuide/package.mo @@ -0,0 +1,123 @@ +within Modelica; +package UsersGuide "User's Guide" + extends Modelica.Icons.Information; + +annotation (DocumentationClass=true, Documentation(info=" +

+Package Modelica is a standardized and pre-defined package +that is developed together with the Modelica language from the +Modelica Association, see +https://www.Modelica.org. +It is also called Modelica Standard Library. +It provides constants, types, connectors, partial models and model +components in various disciplines. +

+

+This is a short User's Guide for +the overall library. Some of the main sublibraries have their own +User's Guides that can be accessed by the following links: +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ComplexBlocksLibrary of basic input/output control blocks with Complex signals
Digital + Library for digital electrical components based on the VHDL standard + (2-,3-,4-,9-valued logic)
DissipationLibrary of functions for convective heat transfer and pressure loss characteristics
FluidLibrary of 1-dim. thermo-fluid flow models using the Modelica.Media media description
FluidHeatFlowLibrary of simple components for 1-dimensional incompressible thermo-fluid flow models
FluxTubes + Library for modelling of electromagnetic devices with lumped magnetic networks
FundamentalWaveLibrary for magnetic fundamental wave effects in electric machines
FundamentalWaveLibrary for quasi-static fundamental wave electric machines
MachinesLibrary for electric machines
Media + Library of media property models
MultiBody + Library to model 3-dimensional mechanical systems
PolyphaseLibrary for electrical components of one or more phases
PowerConvertersLibrary for rectifiers, inverters and DC/DC converters
QuasiStaticLibrary for quasi-static electrical single-phase and polyphase AC simulation
Rotational + Library to model 1-dimensional, rotational mechanical systems
Spice3Library for components of the Berkeley SPICE3 simulator
StateGraph + Library to model discrete event and reactive systems by hierarchical state machines
Translational + Library to model 1-dimensional, translational mechanical systems
Units Library of type definitions
Utilities + Library of utility functions especially for scripting (Files, Streams, Strings, System)
+ +")); +end UsersGuide; diff --git a/Modelica/UsersGuide/package.order b/Modelica/UsersGuide/package.order new file mode 100644 index 0000000000..fdefe73d5b --- /dev/null +++ b/Modelica/UsersGuide/package.order @@ -0,0 +1,5 @@ +Overview +Connectors +Conventions +ReleaseNotes +Contact diff --git a/Modelica/package.mo b/Modelica/package.mo index f32576e7c3..8b0126cf38 100644 --- a/Modelica/package.mo +++ b/Modelica/package.mo @@ -2,9132 +2,6 @@ within ; package Modelica "Modelica Standard Library" extends Modelica.Icons.Package; -package UsersGuide "User's Guide" - extends Modelica.Icons.Information; - -class Overview "Overview of Modelica Library" - extends Modelica.Icons.Information; - - annotation (Documentation(info=" -

-The Modelica Standard Library consists of the following -main sub-libraries: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Library Components Description
- - - Analog
- Analog electric and electronic components, such as - resistor, capacitor, transformers, diodes, transistors, - transmission lines, switches, sources, sensors. -
- - - Digital
- Digital electrical components based on the VHDL standard, - like basic logic blocks with 9-value logic, delays, gates, - sources, converters between 2-, 3-, 4-, and 9-valued logic. -
- - - Machines
- Electrical asynchronous-, synchronous-, and DC-machines - (motors and generators) as well as three-phase transformers. -
- - - FluxTubes
-Based on magnetic flux tubes concepts. Especially to model electromagnetic actuators. Nonlinear shape, force, leakage, and material models. Material data for steel, electric sheet, pure iron, Cobalt iron, Nickel iron, NdFeB, Sm2Co17, and more. -
- - - Translational
- 1-dim. mechanical, translational systems, e.g., - sliding mass, mass with stops, spring, damper. -
- - - Rotational
- 1-dim. mechanical, rotational systems, e.g., inertias, gears, - planetary gears, convenient definition of speed/torque dependent friction - (clutches, brakes, bearings, ..) -
-
- - 		- MultiBody - 3-dim. mechanical systems consisting of joints, bodies, force and - sensor elements. Joints can be driven by drive trains defined by - 1-dim. mechanical system library (Rotational). - Every component has a default animation. - Components can be arbitrarily connected together. -
- - - Fluid
- 1-dim. thermo-fluid flow in networks of vessels, pipes, - fluid machines, valves and fittings. All media from the - Modelica.Media library can be used (so incompressible or compressible, - single or multiple substance, one or two phase medium). -
- - - Media
- Large media library providing models and functions - to compute media properties, such as h = h(p,T), d = d(p,T), - for the following media: -
    -
  • 1240 gases and mixtures between these gases.
    • -
  • incompressible, table based liquids (h = h(T), etc.).
    • -
  • compressible liquids
    • -
  • dry and moist air
    • -
  • high precision model for water (IF97).
    • -
-
- - - FluidHeatFlow, - HeatTransfer - Simple thermo-fluid pipe flow, especially to model cooling of machines - with air or water (pipes, pumps, valves, ambient, sensors, sources) and - lumped heat transfer with heat capacitors, thermal conductors, convection, - body radiation, sources and sensors. -
-
- - 		- Blocks
- Input/output blocks to model block diagrams and logical networks, e.g., - integrator, PI, PID, transfer function, linear state space system, - sampler, unit delay, discrete transfer function, and/or blocks, - timer, hysteresis, nonlinear and routing blocks, sources, tables. -
- - - Clocked
- Blocks to precisely define and synchronize sampled data systems with different - sampling rates. Continuous-time equations can be automatically discretized and - utilized in a sampled data system. The library is based on the clocked - synchronous language elements introduced in Modelica 3.3. -
- - - StateGraph
- Hierarchical state machines with a similar modeling power as Statecharts. - Modelica is used as synchronous action language, i.e., deterministic - behavior is guaranteed -
- 
-A = [1,2,3;
-     3,4,5;
-     2,1,4];
-b = {10,22,12};
-x = Matrices.solve(A,b);
-Matrices.eigenValues(A);
-
- 		- Math, - Utilities
- Functions operating on vectors and matrices, such as for solving - linear systems, eigen and singular values etc., and - functions operating on strings, streams, files, e.g., - to copy and remove a file or sort a vector of strings. -
- -")); -end Overview; - -class Connectors "Connectors" - extends Modelica.Icons.Information; - - annotation (Documentation(info=" - -

-The Modelica standard library defines the most important -elementary connectors in various domains. If any possible, -a user should utilize these connectors in order that components -from the Modelica Standard Library and from other libraries -can be combined without problems. -The following elementary connectors are defined -(the meaning of potential, flow, and stream -variables is explained in section \"Connector Equations\" below): -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
domainpotential
variables		flow
variables		stream
variables		connector definitionicons
electrical
analog		electrical potentialelectrical currentModelica.Electrical.Analog.Interfaces -
Pin, PositivePin, NegativePin
electrical
polyphase		vector of electrical pinsModelica.Electrical.Polyphase.Interfaces -
Plug, PositivePlug, NegativePlug
electrical
space phasor		2 electrical potentials2 electrical currentsModelica.Electrical.Machines.Interfaces -
SpacePhasor
quasi-static
single-phase		complex electrical potentialcomplex electrical current - Modelica.Electrical.QuasiStatic.SinglePhase.Interfaces -
Pin, PositivePin, NegativePin
quasi-static
polyphase		vector of quasi-static single-phase pinsModelica.Electrical.QuasiStatic.Polyphase.Interfaces -
Plug, PositivePlug, NegativePlug
electrical
digital		Integer (1..9)Modelica.Electrical.Digital.Interfaces -
DigitalSignal, DigitalInput, DigitalOutput
magnetic
flux tubes		magnetic potentialmagnetic flux -Modelica.Magnetic.FluxTubes.Interfaces -
MagneticPort, PositiveMagneticPort,
NegativeMagneticPort
magnetic
fundamental
wave		complex magnetic potentialcomplex magnetic flux -Modelica.Magnetic.FundamentalWave.Interfaces -
MagneticPort, PositiveMagneticPort,
NegativeMagneticPort
translationaldistancecut-forceModelica.Mechanics.Translational.Interfaces -
Flange_a, Flange_b
rotationalanglecut-torqueModelica.Mechanics.Rotational.Interfaces -
Flange_a, Flange_b
3-dim.
mechanics		position vector
- orientation object		cut-force vector
- cut-torque vector		Modelica.Mechanics.MultiBody.Interfaces -
Frame, Frame_a, Frame_b, Frame_resolve
simple
fluid flow		pressure
- specific enthalpy		mass flow rate
- enthalpy flow rate		Modelica.Thermal.FluidHeatFlow.Interfaces -
FlowPort, FlowPort_a, FlowPort_b
thermo
fluid flow		pressuremass flow ratespecific enthalpy
mass fractions		 -Modelica.Fluid.Interfaces -
FluidPort, FluidPort_a, FluidPort_b
heat
transfer		temperatureheat flow rateModelica.Thermal.HeatTransfer.Interfaces -
HeatPort, HeatPort_a, HeatPort_b
blocks - Real variable
- Integer variable
- Boolean variable		Modelica.Blocks.Interfaces -
- RealSignal, RealInput, RealOutput
- IntegerSignal, IntegerInput, IntegerOutput
- BooleanSignal, BooleanInput, BooleanOutput
complex
blocks		 - Complex variableModelica.ComplexBlocks.Interfaces -
ComplexSignal, ComplexInput, ComplexOutput
state
machine		Boolean variables
- (occupied, set,
- available, reset)		Modelica.StateGraph.Interfaces -
Step_in, Step_out, Transition_in, Transition_out
- -

-In all domains, usually 2 connectors are defined. The variable declarations -are identical, only the icons are different in order that it is easy -to distinguish connectors of the same domain that are attached at the same -component. -

- -

Hierarchical Connectors

-

-Modelica supports also hierarchical connectors, in a similar way as hierarchical models. -As a result, it is, e.g., possible, to collect elementary connectors together. -For example, an electrical plug consisting of two electrical pins can be defined as: -

- -
-connector Plug
-   import Modelica.Electrical.Analog.Interfaces;
-   Interfaces.PositivePin phase;
-   Interfaces.NegativePin ground;
-end Plug;
-
- -

-With one connect(..) equation, either two plugs can be connected -(and therefore implicitly also the phase and ground pins) or a -Pin connector can be directly connected to the phase or ground of -a Plug connector, such as \"connect(resistor.p, plug.phase)\". -

- -

Connector Equations

- -

-The connector variables listed above have been basically determined -with the following strategy: -

- -
    -
  1. State the relevant balance equations and boundary - conditions of a volume for the particular physical domain.
    2. -
  2. Simplify the balance equations and boundary conditions - of (1) by taking the - limit of an infinitesimal small volume - (e.g., thermal domain: - temperatures are identical and heat flow rates - sum up to zero). -
    3. -
  3. Use the variables needed for the balance equations - and boundary conditions of (2) - in the connector and select appropriate Modelica - prefixes, so that these equations - are generated by the Modelica connection semantics. -
    4. -
- -

-The Modelica connection semantics is sketched at hand -of an example: Three connectors c1, c2, c3 with the definition -

- -
-connector Demo
-  Real        p;  // potential variable
-  flow   Real f;  // flow variable
-  stream Real s;  // stream variable
-end Demo;
-
- -

-are connected together with -

- -
-connect(c1,c2);
-connect(c1,c3);
-
- -

-then this leads to the following equations: -

- -
-// Potential variables are identical
-c1.p = c2.p;
-c1.p = c3.p;
-
-// The sum of the flow variables is zero
-0 = c1.f + c2.f + c3.f;
-
-/* The sum of the product of flow variables and upstream stream variables is zero
-   (this implicit set of equations is explicitly solved when generating code;
-   the \"<undefined>\" parts are defined in such a way that
-   inStream(..) is continuous).
-*/
-0 = c1.f*(if c1.f > 0 then s_mix else c1.s) +
-    c2.f*(if c2.f > 0 then s_mix else c2.s) +
-    c3.f*(if c3.f > 0 then s_mix else c3.s);
-
-inStream(c1.s) = if c1.f > 0 then s_mix else <undefined>;
-inStream(c2.s) = if c2.f > 0 then s_mix else <undefined>;
-inStream(c3.s) = if c3.f > 0 then s_mix else <undefined>;
-
- -")); -end Connectors; - - package Conventions "Conventions" - extends Modelica.Icons.Information; - package Documentation "HTML documentation" - extends Modelica.Icons.Information; - - package Format "Format" - extends Modelica.Icons.Information; - - class Cases "Cases" - extends Modelica.Icons.Information; - annotation (Documentation(info=" - -

In the Modelica documentation sometimes different cases have to be distinguished. If the case distinction refers to Modelica parameters or variables (Boolean expressions) the comparisons should be written in the style of Modelica code within <code> and </code> -

- -

Examples

- -
Example 1
-

-<p>If <code>useCage == true</code>, a damper cage is considered in the model...</p> -

- -

appears as

- -

If useCage == true, a damper cage is considered in the model...

- -

-For more complex case scenarios, an unordered list should be used. In this case only Modelica specific code segments and Boolean expressions. -

- -
Example 2
- -
-<ul>
-  <li> If <code>useCage == true</code>, a damper cage is considered in the model.
-       Cage parameters must be specified in this case.</li>
-  <li> If <code>useCage == false</code>, the damper cage is omitted.</li>
-</ul>
-
- -

appears as

- - - -

-In a more equation oriented case, additional equations or code segments can be added. -

- -
Example 3
- -
-<ul>
-  <li>if <code>usePolar == true</code>, assign magnitude and angle to output <br>
-  <!-- insert graphical representation of equations -->
-  y[i,1] = sqrt( a[i]^2 + b[i]^2 ) <br>
-  y[i,2] = atan2( b[i], a[i] )
-  </li>
-  <li>if <code>usePolar == false</code>, assign cosine and sine to output <br>
-  <!-- insert graphical representation of equations -->
-  y[i,1] = a[i] <br>
-  y[i,2] = b[i]
-  </li>
-</ul>
-
- -

appears as

- - - -")); - end Cases; - - class Code "Code" - extends Modelica.Icons.Information; - - annotation (Documentation(info=" -

-Modelica code conventions of class and instance names, -parameters and variables are specified separately. In this section it is summarized how to refer to -Modelica code in the HTML documentation. -

- -
    -
  1. For constants, parameters and variables in code segments <code> - and </code> should to be used, e.g.,
    - parameter Modelica.Units.SI.Time tStart "Start time"
    2. -
  2. Write multi or single line code segments as quoted preformatted text, i.e., embedded within - <blockquote><pre> and </pre></blockquote> tags.
    3. -
  3. Multi line or single line code shall not be additionally indented.
    4. -
  4. Inline code segments may be typeset with <code> and </code>.
    5. -
  5. In code segments use bold to emphasize Modelica keywords.
    6. -
- -

Examples

- -
Example 1
- -
-<blockquote><pre>
-<strong>connector</strong> Frame
-   ...
-   <strong>flow</strong> SI.Force f[3] <strong>annotation</strong>(unassignedMessage="...");
-<strong>end</strong> Frame;
-</pre></blockquote>
-
- -

appears as

- -
-connector Frame
-   ...
-   flow SI.Force f[3] annotation(unassignedMessage="...");
-end Frame;
-
- -
Example 2
- -
-<blockquote><pre>
-<strong>parameter</strong> Modelica.Units.SI.Conductance G=1 "Conductance";
-</pre></blockquote>
-
- -

appears as

- -
-parameter Modelica.Units.SI.Conductance G=1 "Conductance";
-
-")); - end Code; - - class Equations "Equations" - extends Modelica.Icons.Information; - - annotation (Documentation(info=" - -

-In the context of HTML documentation -equations should have a graphical representation in PNG format. For that purpose tool -specific math typing capabilities can be used. Alternatively the LaTeX to HTML translator -LaTeX2HTML, or the -Online Equation Editor -or codecogs can be used. -

- -

-A typical equation, e.g., of a Fourier synthesis, could look like
-
-or
-\"y=a_1+a_2\"
-In an alt tag the original equation should be stored, e.g.,

-
-<img
- src="modelica://Modelica/Resources/Images/UsersGuide/Conventions/Documentation/Format/Equations/sample.png"
- alt="y=a_1+a_2">
-
- -

-If one wants to refer to particular variables and parameters in the documentation text, either a -graphical representation (PNG file) or italic fonts for regular physical symbols and lower case -Greek letters -should be used. Full word variables and full word indices should be spelled within -<code> and </code>. -Vector and array indices should be typeset as subscripts using the -<sub> and </sub> tags. -

- -

Examples for such variables and parameters are: -φ, φref, v2, useDamperCage. -

- -

Numbered equations

- -

For numbering equations a one row table with two columns should be used. The equation number should be placed in the right column:

- -
-<table border="0" cellspacing="10" cellpadding="2">
-  <tr>
-    <td><img
-    src="modelica://Modelica/Resources/Images/UsersGuide/Conventions/Documentation/Format/Equations/sample.png"
-    alt="y=a_1+a_2"> </td>
-    <td>(1)</td>
-  </tr>
-</table>
-
- -

appears as:

- - - - - - -
\"y=a_1+a_2\"(1)
- -")); - end Equations; - - class Figures "Figures" - extends Modelica.Icons.Information; - - annotation (Documentation(info=" -

-Figures should in particular be included to examples to discuss the problems and results of the respective model. The library developers are yet encouraged to add figures to the documentation of other components to support the understanding of the users of the library. -

- -
    -
  1. Figures have to be placed outside of paragraphs to be HTML compliant.
    2. -
  2. Figures need to have at least a src and an alt attribute defined to be HTML compliant.
    3. -
  3. Technical figures should be placed within a table environment. Each technical figure should then also have a caption. The figure caption starts with a capital letter.
    4. -
  4. Illustration can be embedded without table environment.
    5. -
- -

Location of files

- -

-The PNG files should be placed in a folder which exactly represents the package structure. -

- -

Examples

- -
Example 1
- -

This example shows how an illustration should be embedded in the Example -PID_Controller of the -Blocks package. -

- -
-<img src="modelica://Modelica/Resources/Images/Blocks/PID_controller.png"
-     alt="PID_controller.png">
-
- -
Example 2
- -

This is a simple example of a technical figure with caption.

- -
-<table border="0" cellspacing="0" cellpadding="2">
-  <caption>Caption starts with a capital letter</caption>
-  <tr>
-    <td>
-      <img src="modelica://Modelica/Resources/Images/Blocks/PID_controller.png"
-           alt="PID_controller.png">
-    </td>
-  </tr>
-</table>
-
- -
Example 3
- -

To refer to a certain figure, a figure number may be added. In such case the figure name (Fig.) including the figure enumeration (1,2,...) have to be displayed bold using <strong> and </strong>.

-

The figure name and enumeration should look like this: Fig. 1:

-

Figures have to be enumerated manually.

- -
-<table border="0" cellspacing="0" cellpadding="2">
-  <caption><strong>Fig. 2:</strong> Caption starts with a capital letter</caption>
-  <tr>
-    <td>
-      <img src="modelica://Modelica/Resources/Images/Blocks/PID_controller.png"
-           alt="PID_controller.png">
-    </td>
-  </tr>
-</table>
-
-")); - end Figures; - - class Hyperlinks "Hyperlinks" - extends Modelica.Icons.Information; - - annotation (Documentation(info=" -
    -
  1. Hyperlinks should always be made when referring to a component or package.
    2. -
  2. The hyperlink text in between <a href="..."> and </a> should include the full main package name.
    3. -
  3. A link to an external component should include the full name of the package that it is referred to.
    4. -
  4. Modelica hyperlinks have to use the scheme "modelica://..."
    5. -
  5. For hyperlinks referring to a Modelica component, see Example 1 and 2.
    6. -
  6. No links to commercial web sites are allowed.
    7. -
- -

Examples

- -
Example 1
- -
-<a href="modelica://Modelica.Mechanics.MultiBody.UsersGuide.Tutorial.LoopStructures.PlanarLoops">
-         Modelica.Mechanics.MultiBody.UsersGuide.Tutorial.LoopStructures.PlanarLoops</a>
-
-

appears as

- - Modelica.Mechanics.MultiBody.UsersGuide.Tutorial.LoopStructures.PlanarLoops - -
Example 2
- -
-<p>
-  The feeder cables are connected to an
-  <a href="modelica://Modelica.Electrical.Machines.BasicMachines.InductionMachines.IM_SquirrelCage">
-  induction machine</a>.
-</p>
-
-

appears as

-

- The feeder cables are connected to an - - induction machine. -

-")); - end Hyperlinks; - - class Lists "Lists" - extends Modelica.Icons.Information; - - annotation (Documentation(info=" -
    -
  1. Lists have to be placed outside of paragraphs to be HTML compliant.
    2. -
  2. Items of a list shall start with -
      -
    1. a capital letter if each item is a full sentence
      2. -
    2. a small letter, if only text fragments are used or the list is fragment of a sentence
      3. -
    3. -
- -

Examples

- -
Example 1
- -

This is a simple example of an enumerated (ordered) list

- -
-<ol>
-  <li>item 1</li>
-  <li>item 2</li>
-</ol>
-
-

appears as

-
    -
  1. item 1
    2. -
  2. item 2
    3. -
- -
Example 2
- -

This is a simple example of an unnumbered list.

- -
-<ul>
-  <li>item 1</li>
-  <li>item 2</li>
-</ul>
-
-

appears as

- -")); - end Lists; - - class References "References" - extends Modelica.Icons.Information; - - annotation (Documentation(info=" -
    -
  1. Refer to references by [1], [Andronov1973], etc. by hyperlink and summarize literature in the references subsection of - Conventions.UsersGuide.References.
    2. -
  2. There has to be made at least one citation to each reference.
    3. -
- -

Examples

- -
Example 1
- -
-<p>
-More details about electric machine modeling
-can be found in [<a href="modelica://Modelica.UsersGuide.Conventions.UsersGuide.References">Gao2008</a>]
-and
-[<a href="modelica://Modelica.UsersGuide.Conventions.UsersGuide.References">Kral2018</a>, p. 149].
-</p>
-
-

appears as

-

-More details about electric machine modeling -can be found in [Gao2008] -and -[Kral2018, p. 149]. -

-")); - end References; - - class Tables "Tables" - extends Modelica.Icons.Information; - - annotation (Documentation(info=" -
    -
  1. Tables should always be typeset with <table> and </table>, - not with <pre> and </pre>.
    2. -
  2. Tables have to be placed outside of paragraphs to be HTML compliant.
    3. -
  3. Each table must have a table caption.
    4. -
  4. Table headers and entries start with capital letters.
    5. -
- -

Examples

- -
Example 1
- -

This is a simple example of a table.

- -
-<table border="1" cellspacing="0" cellpadding="2">
-  <caption>Caption starts with a capital letter</caption>
-  <tr>
-    <th>Head 1</th>
-    <th>Head 2</th>
-  </tr>
-  <tr>
-    <td>Entry 1</td>
-    <td>Entry 2</td>
-  </tr>
-  <tr>
-    <td>Entry 3</td>
-    <td>Entry 4</td>
-  </tr>
-</table>
-
-

appears as

- - - - - - - - - - - - - - -
Caption starts with a capital letter
Head 1Head 2
Entry 1Entry 2
Entry 3Entry 4
- -
Example 2
- -

In this case of table captions, the table name (Tab.) including the table enumeration (1,2,...) -has to be displayed bold using <strong> and </strong>. The table name -and enumeration should look like this: Tab. 1: Tables have to be enumerated manually.

- -
-<table border="1" cellspacing="0" cellpadding="2">
-  <caption><strong>Tab 2:</strong> Caption starts with a capital letter</caption>
-  <tr>
-    <th>Head 1</th>
-    <th>Head 2</th>
-  </tr>
-  <tr>
-    <td>Entry 1</td>
-    <td>Entry 2</td>
-  </tr>
-  <tr>
-    <td>Entry 3</td>
-    <td>Entry 4</td>
-  </tr>
-</table>
-
-

appears as

- - - - - - - - - - - - - - -
Tab. 2: Caption starts with a capital letter
Head 1Head 2
Entry 1Entry 2
Entry 3Entry 4
-")); - end Tables; - annotation (Documentation(info=" - -

-In this section the format UsersGuide of the HTML documentation are specified. -The structure of the documentation is specified separately. -

- -

Paragraphs

- -
    -
  1. In each section the paragraphs should start with <p> - and terminate with </p>.
    2. -
  2. Do not write plain text without putting it in a paragraph.
    3. -
  3. No artificial line breaks <br> should be added within text paragraphs if possible. - Use separate paragraphs instead.
    4. -
  4. After a colon (:) continue with capital letter if new sentence starts; - for text fragments continue with lower case letter
    5. -
- -

Emphasis

- -
    -
  1. For setting text in strong font (normally interpreted as boldface) the tags <strong> and </strong> have to be used.
    2. -
  2. For emphasizing text fragments <em> and </em> has to be used.
    3. -
  3. Modelica terms such as expandable bus, array, etc. should not be emphasized anyhow.
    4. -
- -

Capitalization of Text

- -
    -
  1. Table headers and entries should start with capital letters
    2. -
  2. Table entries should start with lower case letter if only text fragments are used.
    3. -
  3. Table and figure captions start with a capital letter
    4. -
- -")); - end Format; - - class Structure "Structure" - extends Modelica.Icons.Information; - - annotation (Documentation(info=" -
    -
  1. In the HTML documentation of any Modelica library, the headings <h1>, - <h2> and <h3> should not be used, because they are utilized by - the automatically generated documentation.
    2. -
  2. The utilized heading format starts with <h4> and terminates with </h4>, e.g., - <h4>Description</h4>
    3. -
  3. The <h4> and <h5> headings must not be terminated by a colon (:).
    4. -
  4. For additional structuring <h5> and </h5> may be used as demonstrated below.
    5. -
- -

Structure

- -

-The following parts should be added to the documentation of each component: -

- -
    -
  1. General information without additional subsection explains how the class works
    2. -
  2. Syntax (for functions only): shows syntax of function call with minimum and full input parameters
    3. -
  3. Implementation (optional): explains how the implementation is made
    4. -
  4. Limitations (optional): explains the limitations of the component
    5. -
  5. Notes (optional): if required/useful
    6. -
  6. Examples (optional): if required/useful
    7. -
  7. Acknowledgments (optional): if required
    8. -
  8. See also: shows hyperlinks to related models
    9. -
  9. Revision history (optional): if required/intended for a package/model, the revision history - should be placed in annotation(Documentation(revisions="..."));
    10. -
- -

-These sections should appear in the listed order. The only exceptions are hierarchically structured notes and examples as explained in the following. -

- -

Additional notes and examples

- -

Some additional notes or examples may require additional <h5> headings. For either notes or examples the following cases may be applied:

- -
Example 1
-

-This is an example of a single note. -

- -
-<h5>Note</h5>
-<p>This is the note.</p>
-
- -
Example 2
-

-This is an example of a very simple structure. -

- -
-<h5>Notes</h5>
-<p>This is the first note.</p>
-<p>This is the second note.</p>
-
- -
Example 3
-

-This example shows a more complex structure with enumeration. -

- -
-<h5>Note 1</h5>
-...
-<h5>Note 2</h5>
-...
-
- -

Automatically created documentation

- -

-For parameters, connectors, as well as inputs and outputs of function automatic documentation is generated by the tool from the quoted comments. -

-")); - end Structure; - annotation (Documentation(info=" -HTML documentation of Modelica classes. -")); - end Documentation; - - package Terms "Terms and spelling" - extends Modelica.Icons.Information; - - class Electrical "Electrical terms" - extends Modelica.Icons.Information; - - annotation (Documentation(info=" - -

The terms listed in this package shall be in accordance with Electropedia.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
List of electrical term spellings
To be usedNot to be used
cut-off frequencycut off frequency, cutoff frequency, cut-off-frequency, cutoff-frequency
electromagneticelectro magnetic, electro-magnetic
electromechanicalelectro mechanical, electro-mechanical
no-loadnoload, no load
polyphasemulti phase, multi-phase, multiphase
quasi-staticquasistatic, quasi static
set-pointset point, setpoint
short-circuitshortcircuit, short circuit
single-phasesingle phase, singlephase, one phase, one-phase, onephase, 1 phase, 1-phase
star pointstar-point, starpoint
three-phasethree phase, threephase, 3 phase, 3-phase
- -")); - end Electrical; - - class Magnetic "Magnetic terms" - extends Modelica.Icons.Information; - - annotation (Documentation(info=" - -

The terms listed in this package shall be in accordance with Electropedia.

- - - - - - - - - - - - - - - - - - - -
List of magnetic term spellings
To be usedNot to be used
electromagneticelectro magnetic, electro-magnetic
magnetomotive forcemagneto motive force
quasi-staticquasistatic, quasi static
- -")); - end Magnetic; - annotation (Documentation(info=" - -

This is the documentation of terms to be used in the Modelica Standard Library.

- -")); - end Terms; - - package ModelicaCode "Modelica code" - extends Modelica.Icons.Information; - - class Format "Format" - extends Modelica.Icons.Information; - - annotation (Documentation(info=" - -

Comments and Annotations

-

-Comments and annotations should start with a capital letter, for example:
-parameter Real a = 1 "Arbitrary factor";.
-For Boolean parameters, the description string should start with "= true, …", for example:
-parameter Boolean useHeatPort = false "= true, if heatPort is enabled";. -

- -

Tabs and Groups

-

-The annotations "tab" and "group" define the placement of -component or of variables in a dialog. -

-

-Using the group annotation, the following rules shall be followed: -

-
    -
  1. - Avoid excessively long group labels. -
    2. -
  2. - Use nouns rather than verbs, without ending punctuation. -
    3. -
  3. - Use sentence-style capitalization. -
    4. -
-

-Using the tab annotation, the following rules shall be followed: -

-
    -
  1. - Try to group components or variables in the default \"general\" tab first. - But feel free to define a new tab it they are so many. -
    2. -
  2. - Label tabs based on their pattern. The label shall clearly reflect - the content of the collected variables. -
    3. -
  3. - Avoid long tab labels. One or two words are mostly sufficient. -
    4. -
  4. - Use nouns rather than verbs, without ending punctuation. -
    5. -
  5. - Use sentence-style capitalization. -
    6. -
  6. - Visibility of parameters collected in one tab shall not be dependent - on parameters shown in another tab. -
    7. -
- -
Example
-

-Imagine you define a controlled electric drive being composed of -a controller and an electrical machine. The latter -has parameters number of pole pairs p, nominal frequency -fnom, rotor's moment of inertia Jrotor -and others. -The controller itself is divided into several sub-controllers -– such as the one for speed control with parameters like gain k -or time constant T. -Then, the above parameters of your electrical drive model could be sorted using tabs -and groups as follows: p, fnom and -Jrotor grouped in the \"Electrical machine\" group in -the \"general\" tab; k and T in the group -\"Speed control\" under tab \"Controller\". -

-

-In the Modelica code, for example the parameter k will then -be defined like: -

- -
-parameter Real k=1 \"Gain\"
-  annotation(
-    Dialog(
-      tab=\"Controller\",
-      group=\"Speed control\"));
-
- -

Whitespace and Indentation

-

-Trailing white-space (i.e., white-space at the end of the lines) shall not be used. -The tab-character shall not be used, since the tab-stops are not standardized. -

-

-The code in a class shall be indented relative to the class in steps of two spaces; -except that the headings public, protected, equation, -algorithm, and end of class marker shall not be indented. -The keywords public and protected are headings for a group -of declarations. -

-

-Long modifier lists shall be split into several indented lines with at most one modifier per line. -

-

-Full class definitions shall be separated by an empty line. -

- -
Example
- -
-package MyPackage
-  partial model BaseModel
-    parameter Real p;
-    input Real u(unit=\"m/s\");
-  protected
-    Real y;
-    Real x(
-      start=1,
-      unit=\"m\",
-      nominal=10);
-  equation
-    der(x) = u;
-    y = 2*x;
-  end BaseModel;
-
-  model ModelP2
-    extends BaseModel(p=2);
-  end ModelP2;
-end MyPackage;
-
-")); - end Format; - - class Naming "Naming convention" - extends Modelica.Icons.Information; - - annotation (Documentation(info=" - -
    -
  1. Class and instance names are usually written in upper and lower case - letters, e.g., "ElectricCurrent". An underscore may be used in names. - However, it has to be taken into account that the last underscore in a - name might indicate that the following characters are rendered as a subscript. - Example: "pin_a" may be rendered as "pina".
    2. - -
  2. Class names start always with an upper case letter, - with the exception of functions, that start with a lower case letter.
    3. - -
  3. Instance names, i.e., names of component instances and - of variables (with the exception of constants), - start usually with a lower case letter with only - a few exceptions if this is common sense - (such as T for a temperature variable).
    4. - -
  4. Constant names, i.e., names of variables declared with the - "constant" prefix, follow the usual naming conventions - (= upper and lower case letters) and start usually with an - upper case letter, e.g., UniformGravity, SteadyState.
    5. - -
  5. The two connectors of a domain that have identical declarations - and different icons are usually distinguished by _a, _b - or _p, _n, e.g., Flange_a, Flange_b, - HeatPort_a, HeatPort_b.
    6. - -
  6. A connector class has the instance - name definition in the diagram layer and not in the - icon layer.
    7. -
- -

Variable names

-

In the following table typical variable names are listed. This list should be completed.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Variables and names
VariableQuantity
aacceleration
Aarea
Ccapacitance
ddamping, density, diameter
dppressureDrop
especificEntropy
Eenergy, entropy
etaefficiency
fforce, frequency
Gconductance
hheight, specificEnthalpy
Henthalpy
HFlowenthalpyFlow
icurrent
Jinertia
llength
LInductance
mmass
MmutualInductance
mFlowmassFlow
ppressure
Ppower
Qheat
QflowheatFlow
rradius
Rradius, resistance
ttime
Ttemperature
tautorque
UinternalEnergy
velectricPotential, specificVolume, velocity, voltage
Vvolume
wangularVelocity
Xreactance
Zimpedance
-")); - end Naming; - - class ParameterDefaults "Parameter defaults" - extends Modelica.Icons.Information; - - annotation (Documentation(info=" - -

-In this section the convention is summarized how default parameters are -handled in the Modelica Standard Library (since version 3.0). -

- -

-Many models in this library have parameter declarations to define -constants of a model that might be changed before simulation starts. -Example: -

- -
-model SpringDamper
-parameter Real c(final unit=\"N.m/rad\") = 1e5    \"Spring constant\";
-parameter Real d(final unit=\"N.m.s/rad\") = 0    \"Damping constant\";
-parameter Modelica.Units.SI.Angle phi_rel0 = 0  \"Unstretched spring angle\";
-...
-end SpringDamper;
-
- -

-In Modelica it is possible to define a default value of a parameter in -the parameter declaration. In the example above, this is performed for -all parameters. Providing default values for all parameters can lead to -errors that are difficult to detect, since a modeler may have forgotten -to provide a meaningful value (the model simulates but gives wrong -results due to wrong parameter values). In general the following basic -situations are present: -

- -
    -
  1. The parameter value could be anything (e.g., a spring constant or - a resistance value) and therefore the user should provide a value in - all cases. A Modelica translator should warn, if no value is provided. -
    2. - -
  2. The parameter value is not changed in > 95 % of the cases - (e.g., initialization or visualization parameters, or parameter phi_rel0 - in the example above). In this case a default parameter value should be - provided, in order that the model or function can be conveniently - used by a modeler. -
    3. - -
  3. A modeler would like to quickly utilize a model, e.g., - - In all these cases, it would be not practical, if the modeler would - have to provide explicit values for all parameters first. -
    4. -
- -

-To handle the conflicting goals of (1) and (3), the Modelica Standard Library -uses two approaches to define default parameters, as demonstrated with the -following example: -

- -
-model SpringDamper
-parameter Real c(final unit=\"N.m/rad\"  , start = 1e5) \"Spring constant\";
-parameter Real d(final unit=\"N.m.s/rad\", start = 0)   \"Damping constant\";
-parameter Modelica.Units.SI.Angle phi_rel0 = 0        \"Unstretched spring angle\";
-...
-end SpringDamper;
-
-SpringDamper sp1;              // warning for \"c\" and \"d\"
-SpringDamper sp2(c=1e4, d=0);  // fine, no warning
-
- -

-Both definition forms, using a \"start\" value (for \"c\" and \"d\") and providing -a declaration equation (for \"phi_rel0\"), are valid Modelica and define the value -of the parameter. By convention, it is expected that Modelica translators will -trigger a warning message for parameters that are not defined by a declaration -equation, by a modifier equation or in an initial equation/algorithm section. -A Modelica translator might have options to change this behavior, especially, -that no messages are printed in such cases and/or that an error is triggered -instead of a warning. -

- -")); - end ParameterDefaults; - annotation (Documentation(info=" - -

In this section guidelines on creating Modelica code are provided.

- -")); - end ModelicaCode; - - package UsersGuide "User's Guide" - extends Modelica.Icons.Information; - - class Implementation "Implementation notes" - extends Modelica.Icons.Information; - - annotation (Documentation(info=" -

-This class summarizes general information about the implementation which is not stated elsewhere. -

-
    -
  1. The <caption> tag is currently not supported in some tools.
    2. -
  2. The &sim; symbol (i.e., '∼' ) is currently not supported in some tools.
    3. -
  3. The &prop; symbol (i.e., '∝' ) is currently not supported in some tools.
    4. -
-")); - end Implementation; - - class References "References" - extends Modelica.Icons.References; - - annotation (Documentation(info=" - -
    -
  1. Citation formats should be unified according to IEEE Transactions style.
    2. -
  2. Reference should be formatted as tables with two columns.
    3. -
- -

In the following the reference formats will be explained based on five examples:

- - - -

The citation is also explained.

- -

Example

- -
-<table border=\"0\" cellspacing=\"0\" cellpadding=\"2\">
-  <tr>
-    <td>[Gao2008]</td>
-    <td>Z. Gao, T. G. Habetler, R. G. Harley, and R. S. Colby,
-        &quot;<a href="https://ieeexplore.ieee.org/document/4401132">A sensorless rotor temperature estimator for induction
-        machines based on a current harmonic spectral estimation scheme</a>&quot;,
-        <em>IEEE Transactions on Industrial Electronics</em>,
-        vol. 55, no. 1, pp. 407-416, Jan. 2008.
-    </td>
-  </tr>
-  <tr>
-    <td>[Kral2018]</td>
-    <td>C. Kral,
-        <em>Modelica - object oriented modeling of polyphase electric machines</em> (in German),
-        M&uuml;nchen: Hanser Verlag, 2018, <a href="https://doi.org/10.3139/9783446457331">DOI 10.3139/9783446457331</a>,
-        ISBN 978-3-446-45551-1.
-    </td>
-  </tr>
-  <tr>
-    <td>[Woehrnschimmel1998]</td>
-    <td>R. W&ouml;hrnschimmel,
-        &quot;Simulation, modeling and fault detection for vector
-        controlled induction machines&quot;,
-        Master&apos;s thesis, Vienna University of Technology,
-        Vienna, Austria, 1998.
-    </td>
-  </tr>
-  <tr>
-    <td>[Farnleitner1999]</td>
-    <td>E. Farnleitner,
-      &quot;Computational Fluid dynamics analysis for rotating
-      electrical machinery&quot;,
-      Ph.D. dissertation, University of Leoben,
-      Department of Applied Mathematics, Leoben, Austria, 1999.
-    </td>
-  </tr>
-  <tr>
-    <td>[Marlino2005]</td>
-    <td>L. D. Marlino,
-      &quot;Oak ridge national laboratory annual progress report for the
-      power electronics and electric machinery program&quot;,
-      Oak Ridge National Laboratory, prepared for the U.S. Department of Energy,
-      Tennessee, USA, Tech. Rep. FY2004 Progress Report, January 2005,
-      <a href="https://doi.org/10.2172/974618">DOI 10.2172/974618</a>.
-    </td>
-  </tr>
-</table>
-
- -

appears as

- - - - - - - - - - - - - - - - - - - - - - -
[Gao2008]Z. Gao, T. G. Habetler, R. G. Harley, and R. S. Colby, - "A sensorless rotor temperature estimator for induction - machines based on a current harmonic spectral estimation scheme", - IEEE Transactions on Industrial Electronics, - vol. 55, no. 1, pp. 407-416, Jan. 2008. -
[Kral2018]C. Kral, - Modelica - object oriented modeling of polyphase electric machines (in German), - München: Hanser Verlag, 2018, DOI 10.3139/9783446457331, - ISBN 978-3-446-45551-1. -
[Woehrnschimmel1998]R. Wöhrnschimmel, - "Simulation, modeling and fault detection for vector - controlled induction machines", - Master's thesis, Vienna University of Technology, - Vienna, Austria, 1998. -
[Farnleitner1999]E. Farnleitner, - "Computational Fluid dynamics analysis for rotating - electrical machinery", - Ph.D. dissertation, University of Leoben, - Department of Applied Mathematics, Leoben, Austria, 1999. -
[Marlino2005]L. D. Marlino, - "Oak ridge national laboratory annual progress report for the - power electronics and electric machinery program", - Oak Ridge National Laboratory, prepared for the U.S. Department of Energy, - Tennessee, USA, Tech. Rep. FY2004 Progress Report, January 2005, - DOI 10.2172/974618. -
- -")); - end References; - - class Contact "Contact" - extends Modelica.Icons.Contact; - - annotation (Documentation(info=" - -

-This class summarizes contact information of the contributing persons. -

- -

Example

- -
-<p>
-Library officers responsible for the maintenance and for the
-organization of the development of this library are listed in
-<a href=\"modelica://Modelica.UsersGuide.Contact\">Modelica.UsersGuide.Contact</a>.
-</p>
-
-<h4>Main authors</h4>
-
-<p>
-<strong>First author's name</strong><br>
-First author's address<br>
-next address line<br>
-email: <a href=\"mailto:author1@example.org\">author1@example.org</a><br>
-web: <a href="https://www.example.org">https://www.example.org</a>
-</p>
-
-<p>
-<strong>Second author's name</strong><br>
-Second author's address<br>
-next address line<br>
-email: <a href=\"mailto:author2@example.org\">author2@example.org</a>
-</p>
-
-<h4>Contributors to this library</h4>
-
-<ul>
-  <li>Person one</li>
-  <li>...</li>
-</ul>
-
-<h4>Acknowledgements</h4>
-
-<p>
-The authors would like to thank following persons for their support ...
-</p>
-
-OR
-
-<p>
-We are thankful to our colleagues [names] who provided expertise to develop this library...
-</p>
-
-OR
-
-<p>
-The [partial] financial support for the development of this library by [organization]
-is highly appreciated.
-</p>
-
-OR whatever
-
-

appears as

-

-Library officers responsible for the maintenance and for the -organization of the development of this library are listed in -Modelica.UsersGuide.Contact. -

- -

Main authors

- -

-First author's name
-First author's address
-next address line
-email: author1@example.org
-web: https://www.example.org -

- -

-Second author's name
-Second author's address
-next address line
-email: author2@example.org
-

- -

Contributors to this library

- - - -

Acknowledgements

- -

-The authors would like to thank following persons for their support ... -

-")); - end Contact; - - class RevisionHistory "Revision History" - extends Modelica.Icons.ReleaseNotes; - - annotation (Documentation(info=" - -
    -
  1. The revision history needs to answer the question: - What has changed and what are the improvements over the previous versions and revision.
    2. -
  2. The revision history includes the documentation of the development history of each class and/or package.
    3. -
  3. Version number, date, author and comments shall be included. - In case the version number is not known at the time of implementation, - a dummy version number shall be used, e.g., 3.x.x. The version date shall be the date of the - latest change.
    4. -
- -
Example
- -
-<table border=\"1\" cellspacing=\"0\" cellpadding=\"2\">
-    <tr>
-      <th>Version</th>
-      <th>Date</th>
-      <th>Author</th>
-      <th>Comment</th>
-    </tr>
-    ...
-    <tr>
-      <td>1.0.1</td>
-      <td>2008-05-26</td>
-      <td>A. Haumer<br>C. Kral</td>
-      <td>Fixed bug in documentation</td>
-    </tr>
-    <tr>
-      <td>1.0.0</td>
-      <td>2008-05-21</td>
-      <td>A. Haumer</td>
-      <td>Initial version</td>
-    </tr>
-</table>
-
- -

This code appears then as in the \"Revisions\" section below.

- -", - revisions=" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
VersionDateAuthorComment
3.2.32017-07-04C. KralAdded comment on version number and date, see - #2219
1.1.02010-04-22C. KralMigrated Conventions to UsersGuide of MSL
1.0.52010-03-11D. WinklerUpdated image links guide to new 'modelica://' URIs, added contact details
1.0.42009-09-28C. KralApplied new rules for equations as discussed on the 63rd Modelica Design Meeting
1.0.32008-05-26D. WinklerLayout fixes and enhancements
1.0.12008-05-26A. Haumer
C. Kral		Fixed bug in documentation
1.0.02008-05-21A. HaumerInitial version
-")); - end RevisionHistory; - - annotation (Documentation(info=" -

The UsersGuide of each package should consist of the following classes

-
    -
  1. Contact information of - the library officer and the co-authors
    2. -
  2. Optional Implementation Notes to give general information about the implementation
    3. -
  3. References for summarizing the literature of the package
    4. -
  4. Revision history to summarize the most important changes and improvements of the package
    5. -
-")); - end UsersGuide; - - class Icons "Icon design" - extends Modelica.Icons.Information; - annotation (Documentation(info=" - -

The icon of a Modelica class shall consider the following guidelines:

- -

Color and Shapes

- -

The main icon color of a component shall be the same for all components of one library. White fill areas of an icon shall not be used to hide parts of an icon, see -#2031. -In the Modelica Standard Library the following color schemes apply:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Color schemes applied to particular libraries
PackageColor RGB codeColor sample
Modelica.Blocks{0,0,127}
Modelica.ComplexBlocks{85,170,255}
Modelica.Clocked{95,95,95}
Modelica.StateGraph{0,0,0}
Modelica.Electrical.Analog{0,0,255}
Modelica.Electrical.Digital{128,0,128}
Modelica.Electrical.Machines{0,0,255}
Modelica.Electrical.Polyphase{0,0,255}
Modelica.Electrical.QuasiStatic{85,170,255}
Modelica.Electrical.Spice3 {170,85,255}
Modelica.Magnetic.FluxTubes{255,127,0}
Modelica.Magnetic.FundamentalWave{255,127,0}
Modelica.Magnetic.QuasiStatic{255,170,85}
Modelica.Mechanics.MultiBody{192,192,192}
Modelica.Mechanics.Rotational{95,95,95}
Modelica.Mechanics.Translational{0,127,0}
Modelica.Fluid{0,127,255}
Modelica.Medianone
Modelica.Thermal.FluidHeatFlow{0,0,255}
Modelica.Thermal.HeatTransfer{191,0,0}
Modelica.Mathnone
Modelica.ComplexMathnone
Modelica.Utilitiesnone
Modelica.Constantsnone
Modelica.Iconsnone
Modelica.Unitsnone
- -

Icon size

- -

The icon of a Modelica class shall not be significantly greater or smaller than the default Diagram limits of 200 units x 200 units. These default diagram limits are

- -

If possible, the icon shall be designed such way, that the icon name %name -and the most significant parameter can be displayed within the vertical Diagram range of the icon.

- - - - - - - -
Fig. 1: (a) Typical icon, (b) including dimensions
(a) - \"Typical - (b) - \"Typical -
- -

Component Name

- -

The component name %name shall be in RGB (0,0,255) blue color.

- -

The text shall be located above the actual icon. If there is enough space, the upper text limit of the component name -shall be 10 units below the upper icon boundary, see Fig. 1.

- -

If the icon is as big as the entire icon range of 200 units x 200 units, e.g. in blocks, -the component name shall be placed above the icon with vertical 10 units of space between icon and lower text box, see Fig. 2.

- - - - - - -
Fig. 2: Block component name
- \"Placement -
- -

If there is a connector located at the top icon boundary and it is obvious that this connector influences the model -behavior compared to a similar model without such connector, then a line from the connector to the actual icon -shall be avoided to keep the design straight, see Fig. 4. If it is required to use a line indicating the connector dependency, then -the line shall be interrupted such that this line does not interfere with component name.

- - - - - - -
Fig. 3: Component name between actual icon and connector
- \"Component -
- -

In some cases, if there is not alternative, the component name has to be placed below the actual icon, see. Fig. 4.

- - - - - - -
Fig. 4: Component name below actual icon
- \"Icon -
- -

Parameter Name

- -

One significant parameter shall be placed below the icon, see Fig. 1 and Fig. 2. The parameter name shall be RGB (0,0,0) black color.

- -

The parameter text box shall be placed 10 units below the actual icon. -

- -

Connector location

- -

Physical connectors shall always be located on the icon boundary. Input and output connector shall be placed outside the icon, see Fig. 2 and Fig. 3. -Preferred connector locations are:

- - - - - - - -
Fig. 5: Connectors located at the four corners of the icon diagram
- \"Icon -
- -

Sensors

- -

-Based on #2628 the following guidelines for the -design of sensors apply: -

- - - - - - - - - -
Fig. 6: Round sensor with (a) short and (b) longer SI unit
(a) - \"Icon - (b) - \"Icon -
- - - - - - -
Fig. 7: Rectangular sensor
- \"Icon -
- - - - - - -
Fig. 8: Sensor with multiple signal outputs and SI units located next to the output connectors
- \"Icon -
- -

Diagram layer

- -

The diagram layer is intended to contain the graphical components, and if there are no graphical components it shall be left empty. -In particular do not make the diagram layer a copy of the icon layer. -Graphical illustrations shall not be added in the diagram layer, but can be added in the HTML documentation.

-")); - end Icons; - annotation (DocumentationClass=true,Documentation(info=" -

A Modelica main package should be compliant with the UsersGuide stated in this documentation:

-
    -
  1. Conventions of the Modelica code
    2. -
  2. Consistent HTML documentation
    3. -
  3. Structure to be provided by a main package -
    4. -
  4. These packages should appear in the listed order.
    5. -
-")); - end Conventions; - -package ReleaseNotes "Release notes" - extends Modelica.Icons.ReleaseNotes; - -class VersionManagement "Version Management" - extends Modelica.Icons.ReleaseNotes; - - annotation (Documentation(info=" -

Development branches

-

-Further development and maintenance of the Modelica Standard Library is performed with -two branches on the public GitHub repository of the Modelica Association. -

-

-Since version 4.0.0 the Modelica Standard Library uses semantic versioning following the -convention: -

-
MAJOR.MINOR.BUGFIX
-

-This provides a mechanism for maintaining releases and bug-fixes in a well defined way and is inspired -by (but not identical to) https://semver.org. -

- -
Main development branch
-

-Name: \"master\" -

- -

-This branch contains the actual development version, i.e., all bug-fixes -and new features. -New features must have been tested before including them. -However, the exhaustive tests for a new version are (usually) not performed. -This version is usually only be used by the developers of the -Modelica Standard Library and is not utilized by Modelica users. -

- -
Maintenance branch
-

-Name: \"maint/4.1.x\" -

- -

-This branch contains the released Modelica Standard Library version (e.g., v4.1.0) -where all bug-fixes since this release date are included -(also consecutive BUGFIX versions 4.1.1, 4.1.2, etc., -up to when a new MINOR or MAJOR release becomes available; -i.e., there will not be any further BUGFIX versions (i.e., 4.1.x) of a previous release). -These bug-fixes might not yet be tested with all test cases or with -other Modelica libraries. The goal is that a vendor may take this version at -any time for a new release of its software, in order to incorporate the latest -bug fixes. -

- -

Contribution workflow

-

-The general contribution workflow is usually as follows: -

- -
    -
  1. Fork the repository to your account by - using the Fork button of the GitHub repository site.
    2. -
  2. Clone the forked repository to your computer. Make sure to checkout the maintenance branch if the bug fix is going to get merged to the maintenance branch.
    3. -
  3. Create a new topic branch and give it a meaningful name, like, e.g., \"issue2161-fix-formula\".
    4. -
  4. Do your code changes and commit them, one change per commit.
    - Single commits can be copied to other branches.
    - Multiple commits can be squashed into one, but splitting is difficult.
    5. -
  5. Once you are done, push your topic branch to your forked repository.
    6. -
  6. Go to the upstream https://github.com/modelica/ModelicaStandardLibrary.git repository and submit a Pull Request (PR). -
    7. -
  7. Update your branch with the requested changes. If necessary, merge the latest - \"master\" branch into your topic branch and solve all merge conflicts in your topic branch.
    8. -
- -

-There are some special guidelines for changes to the maintenance branch. -

- - - -

-As a recommendation, a valid bug-fix to the maintenance branch may contain one or -more of the following changes. -

- - -")); -end VersionManagement; - -class Version_4_1_0 "Version 4.1.0 (Month D, 20YY)" - extends Modelica.Icons.ReleaseNotes; - - annotation (Documentation(info=" -

-Version 4.1.0 is backward compatible to version 4.0.0, that is models developed with -versions 4.0.0 will work without any changes also with version 4.1.0. -Short Overview: -

- -

-The following Modelica packages have been tested that they work together with this release of package Modelica (alphabetical list). -

- - -
- -


-The following new libraries have been added: -

- - -
- -


-The following new components have been added to existing libraries: -

- - -
- -


-The following existing components have been improved in a backward compatible way: -

- - - - - - - - - - - - - - - - - - - - - -
Modelica.Blocks.Sources
CombiTimeTableAdded support of reading CSV files.
Modelica.Blocks.Tables
CombiTable1Ds
CombiTable1Dv
CombiTable2Ds
CombiTable2Dv		Added support of reading CSV files.
Electrical.PowerConverters.DCDC
HBridgeAn enhanced distribution of the fire signals avoids a short circuit on the source, and enables an enhanced pwm algorithm.
Control.SignalPWMThe reference signal can be chosen between sawtooth and triangle, and - the comparison between dutyCycle and reference signal is either applied common or separated for both fire ports.
Mechanics.Rotational.Components
BearingFrictionThe table interpolation in tau_pos utilizes the interpolation based on ExternalCombiTable1D.
LossyGearThe table interpolation in lossTable utilizes the interpolation based on ExternalCombiTable1D.
Mechanics.Translational.Components
SupportFrictionThe table interpolation in f_pos utilizes the interpolation based on ExternalCombiTable1D.
- -


-The following existing components have been changed in a non-backward compatible way: -

- - - - - - - - - - - -
Mechanics.MultiBody
WorldThe protected parameters ndim, ndim2 and - ndim_pointGravity have been removed.
Mechanics.Rotational.Components
Brake
Clutch
OneWayClutch		The table interpolation in mu_pos utilizes the interpolation based on ExternalCombiTable1D.
The public variable mu0 was changed to a protected final parameter.
Mechanics.Translational.Components
BrakeThe table interpolation in mu_pos utilizes the interpolation based on ExternalCombiTable1D.
The public variable mu0 was changed to a protected final parameter.
- -


-The following critical errors have been fixed (i.e., errors -that can lead to wrong simulation results): -

- - - - - -
Modelica.Blocks.Tables
CombiTable2Ds
CombiTable2Dv		The derivatives for one-sided extrapolation by constant continuation (i.e., extrapolation=Modelica.Blocks.Types.Extrapolation.HoldLastPoint) returned a constant zero value. This has been corrected.
-")); -end Version_4_1_0; - -class Version_4_0_0 "Version 4.0.0 (June 4, 2020)" - extends Modelica.Icons.ReleaseNotes; - - annotation (Documentation(info=" -

-Version 4.0.0 is not backward compatible to previous versions. -A tested conversion script is provided to transform models and libraries of previous versions 3.x.y to the new version. -Short Overview: -

- - -

-The exact difference between package Modelica version 4.0.0 and version 3.2.3 is -summarized in a comparison table. -

- -

-The following Modelica packages have been tested that they work together with this release of package Modelica -(alphabetical list). -Hereby simulation results of the listed packages have been produced with package Modelica version 3.2.3 and -compared with the simulation results produced with version 4.0.0 Beta.1. The tests have been performed with Dymola 2020/2020x/2021: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
LibraryVersionLibrary provider
Buildings > 6.0.0LBNL
BrushlessDCDrives1.1.1Dassault Systèmes
Clara1.5.0XRG Simulation GmbH and TLK-Thermo GmbH
ClaraPlus1.3.0XRG Simulation GmbH and TLK-Thermo GmbH
DriveControl4.0.0Anton Haumer
DymolaModels1.1Dassault Systèmes
EDrives1.0.1Anton Haumer and Christian Kral
ElectricalMachines0.9.1Anton Haumer
ElectricPowerSystems1.3.1Dassault Systèmes
ElectrifiedPowertrains1.3.2Dassault Systèmes
ElectroMechanicalDrives2.2.0Christian Kral
EMOTH1.4.1Anton Haumer
HanserModelica1.1.0Christian Kral
IBPSA > 3.0.0IBPSA Project 1
KeywordIO0.9.0Christian Kral
Modelica_DeviceDrivers1.8.1DLR, ESI ITI, and Linköping University (PELAB)
Optimization2.2.4DLR
PhotoVoltaics1.6.0Christian Kral
PlanarMechanics1.4.1Dirk Zimmer
Testing1.3Dassault Systèmes
ThermalSystems1.6.0TLK-Thermo GmbH
TIL3.9.0TLK-Thermo GmbH
TILMedia3.9.0TLK-Thermo GmbH
TSMedia1.6.0TLK-Thermo GmbH
VehicleInterfaces1.2.5Modelica Association
WindPowerPlants1.2.0Christian Kral
- -


-The following new libraries have been added: -

- - - - - - -
Modelica.ClockedThis library can be used to precisely define and synchronize sampled data systems with different sampling rates.
The library previously was - available as separate package Modelica_Synchronous. - (This library was developed by DLR in close cooperation with Dassault Systèmes Lund.) -
Modelica.Electrical.BatteriesThis library offers simple battery models.
- (This library was developed by Anton Haumer and Christian Kral.) -
- -


-The following new components have been added to existing libraries: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Modelica.Blocks.Sources
SineVariableFrequencyAndAmplitude
CosineVariableFrequencyAndAmplitude		Added signal sources with variable amplitude and frequency; sine and cosine waveforms are provided.
SincAdded signal source of amplitude*sin(2*π*f*t)/(2*π*f*t).
Modelica.Electrical.Analog.Sources
SineVoltageVariableFrequencyAndAmplitude
CosineVoltageVariableFrequencyAndAmplitude
SineCurrentVariableFrequencyAndAmplitude
CosineCurrentVariableFrequencyAndAmplitude		Added voltage and current sources with variable amplitude and frequency; sine and cosine waveforms are provided.
Modelica.Electrical.Machines.Sensors
SinCosResolverAdded resolver with two sine and two cosine tracks to be used in drive control applications.
Modelica.Electrical.Machines.Utilities
SwitchYDwithArcAdded wye delta switch with arc model and time delay between the two switching events.
Modelica.Electrical.PowerConverters
ACACAdded single-phase and polyphase triac models (AC/AC converters).
Modelica.Magnetic.FluxTubes.Shapes.FixedShape
HollowCylinderCircumferentialFlux
Toroid		Added circumferential flux models of hollow cylinder and toroid with circular cross section.
Magnetic.QuasiStatic.FluxTubes.Shapes.FixedShape
HollowCylinderCircumferentialFlux
Toroid		Added circumferential flux models of hollow cylinder and toroid with circular cross section.
Modelica.Mechanics.MultiBody.Visualizers.Advanced
VectorAdded 3-dimensional animation for visualization of vector quantities (force, torque, etc.)
Modelica.Mechanics.Translational.Components
RollingResistanceAdded resistance of a rolling wheel incorporating the inclination and rolling resistance coefficient.
VehicleAdded simple vehicle model considering mass and inertia, drag and rolling resistance, inclination resistance.
Modelica.Math
BooleanVectors.andTrueSimilar to allTrue, but return true on empty input vector.
Matrices.LAPACK.dgeqp3Compute the QR factorization with column pivoting of square or rectangular matrix.
Random.Utilities.automaticLocalSeedCreate an automatic local seed from the instance name.
- -


-The following existing components have been improved in a backward compatible way: -

- - - - - - - - - - - - - - - - - - - -
Modelica.Blocks.Sources
CombiTimeTableAdded second derivative and modified Akima interpolation.
Modelica.Blocks.Tables
CombiTable1Ds
CombiTable1Dv		Added second derivatives and modified Akima interpolation.
CombiTable2Ds
CombiTable2Dv		Added second derivatives.
Modelica.Electrical.Analog.Basic
GyratorServes as generalized gyrator model as IdealGyrator was removed.
Modelica.Electrical.Analog.Ideal
IdealizedOpAmpLimitedAdded homotopy to operational amplifier.
Modelica.Electrical.Semiconductors
NPN
PNP		Added optional substrate connector.
- -


-The following existing components have been changed in a non-backward compatible way: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Modelica.Blocks
Nonlinear.Limiter
Nonlinear.VariableLimiter		The superfluous parameter limitsAtInit has been removed.
Continuous.PIDThe initialization option initType = InitPID.DoNotUse_InitialIntegratorState to only initialize the integrator state has been removed. This option has been converted to both initialize the integrator state and the derivative state, i.e., initType = Init.InitialState.
Continuous.LimPIDThe superfluous parameter limitsAtInit has been removed.
The initialization option initType = InitPID.DoNotUse_InitialIntegratorState to only initialize the integrator state has been removed. This option has been converted to both initialize the integrator state and the derivative state, i.e., initType = Init.InitialState.
Nonlinear.DeadZoneThe superfluous parameter deadZoneAtInit has been removed.
Interfaces.PartialNoise
Noise.UniformNoise
Noise.NormalNoise
Noise.TruncatedNormalNoise
Noise.BandLimitedWhiteNoise		As a side-effect of the updated computation in Modelica.Math.Random.Utilities.automaticLocalSeed the localSeed parameter is computed differently if useAutomaticLocalSeed is set to true.
Types.InitPIDThe enumeration type has been converted to Types.Init with exception of the alternative InitPID.DoNotUse_InitialIntegratorState, that was converted to Init.InitialState leading to a different initialization behaviour.
Modelica.Electrical.Machines.Utilities
SwitchYDThe IdealCommutingSwitch is replaced by an IdealOpeningSwitch and an IdealClosingSwitch to allow a time delay between the two switching actions.
Modelica.Electrical.Spice3
Internal.MOS2
Semiconductors.M_NMOS2
Semiconductors.M_PMOS2		The final parameter vp has been removed.
The obsolete variables cc_obsolete, icqmGB, icqmGS, icqmGD, MOScapgd, MOScapgs, MOScapgb, qm and vDS have been removed.
Modelica.Magnetic.QuasiStatic.FundamentalWave.Utilities
SwitchYDThe IdealCommutingSwitch is replaced by an IdealOpeningSwitch and an IdealClosingSwitch to allow a time delay between the two switching actions.
Modelica.Mechanics.MultiBody.Forces
WorldForceThe parameters diameter and N_to_m have been removed.
WorldTorqueThe parameters diameter and Nm_to_m have been removed.
WorldForceAndTorqueThe parameters forceDiameter, torqueDiameter, N_to_m, and Nm_to_m have been removed.
ForceThe parameter N_to_m has been removed.
TorqueThe parameter Nm_to_m has been removed.
ForceAndTorqueThe parameters N_to_m and Nm_to_m have been removed.
Modelica.Mechanics.MultiBody.Joints
PrismaticThe superfluous constant s_offset has been removed.
RevoluteThe superfluous constant phi_offset has been removed.
FreeMotion
FreeMotionScalarInit		The parameter arrowDiameter has been removed.
Modelica.Mechanics.MultiBody.Parts
BodyThe superfluous parameter z_a_start has been removed.
Modelica.Mechanics.MultiBody.Sensors
AbsoluteSensor
RelativeSensor
Distance		The parameter arrowDiameter has been removed.
CutForceThe parameters forceDiameter and N_to_m have been removed.
CutForceThe parameters torqueDiameter and Nm_to_m have been removed.
CutForceAndTorqueThe parameters forceDiameter, torqueDiameter, N_to_m, and Nm_to_m have been removed.
Modelica.Mechanics.MultiBody.Visualizers
Advanced.Arrow
Advanced.DoubleArrow
FixedArrow
SignalArrow		The parameter diameter has been removed.
Modelica.Fluid.Machines
PartialPumpThe superfluous parameter show_NPSHa has been removed.
Modelica.Thermal.HeatTransfer
Fahrenheit.FromKelvin
Rankine.FromKelvin
Rankine.ToKelvin		The superfluous parameter n has been removed.
- -


-The following critical errors have been fixed (i.e., errors -that can lead to wrong simulation results): -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Modelica.Blocks.Math
PythagorasThe case with negative y2 was not correctly considered if u1IsHypotenuse is true. This has been corrected.
Modelica.Electrical.Semiconductors
DiodeFixed unit error in current equations.
Modelica.Electrical.Spice3.Additionals
polyThe case with one coefficient and one variable was not correctly considered. This has been corrected.
Modelica.Fluid.Dissipation.PressureLoss.General
dp_volumeFlowRate_DP
dp_volumeFlowRate_MFLOW		The mass flow rate was not correctly computed if the pressure drop is a linear function of the volume flow rate. This has been corrected.
Modelica.Media.Air.MoistAir
density_derX
s_pTX
s_pTX_der		The calculation was wrong. This has been corrected.
Modelica.Media.Air.ReferenceAir.Air_Base
BasePropertiesThe unit of the specific gas constant R_s was not correctly considered. This has been corrected.
Modelica.Media.IdealGases.Common.Functions
s0_Tlow_derThe calculation was wrong. This has been corrected.
Modelica.Media.IdealGases.Common.MixtureGasNasa
T_hXThe function inputs exclEnthForm, refChoice and h_off were not considered. This has been corrected.
Modelica.Media.Incompressible.TableBased
T_phThe pressure negligence was not considered. This has been corrected.
Modelica.Media.R134a.R134a_ph
setState_pTXOnly applicable in one-phase regime: The Newton iteration for the calculation of the density may possibly converge to the wrong root. This has been improved.
setState_dTX
setState_psX		The calculation was wrong in two-phase regime. This has been corrected.
Modelica.Utilities.System
getTimeThe month and year was only correctly returned if the implementing source file (ModelicaInternal.c) was compiled for Windows OS. This has been corrected.
-")); -end Version_4_0_0; - -class Version_3_2_3 "Version 3.2.3 (January 23, 2019)" - extends Modelica.Icons.ReleaseNotes; - - annotation (Documentation(info=" -

-Version 3.2.3 is backward compatible to version 3.2.2, that is models developed with -versions 3.0, 3.0.1, 3.1, 3.2, 3.2.1 or 3.2.2 will work without any changes also with version 3.2.3. -This version is a \"clean-up\" with major emphasis on quality improvement and -tool compatibility. The goal is that all -Modelica tools will support this package -and will interpret it in the same way. Short Overview: -

- - - -

-The exact difference between package Modelica version 3.2.3 and version 3.2.2 is -summarized in a comparison table. -

- -


-The following new libraries have been added: -

- - - - - - -
Modelica.Magnetic.QuasiStatic.FluxTubes - This library provides models for the investigation of quasi-static electromagnetic devices with lumped magnetic networks - in a comparable way as Modelica.Magnetic.FluxTubes.
- (This library was developed by Christian Kral.) -
Modelica.Electrical.Machines.Examples.ControlledDCDrives - This library demonstrates the control of a permanent magnet dc machine: current control, speed control and position control - along with the necessary components in sublibrary Utilities.
- (This library was developed by Anton Haumer.) -
- -


-The following new components have been added -to existing libraries: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Modelica.Blocks.Interfaces.Adaptors
FlowToPotentialAdaptor
PotentialToFlowAdaptor		 Partial adaptors for generation of FMUs, optionally taking first and second derivative into account, - for consistent components in various domains.
Modelica.Blocks.Math
PowerComputes the power of the input signal.
WrapAngle Wraps the angle signal at the input to the interval ]-π, π] or [0, 2π[.
Pythagoras This block determines the hypotenuse from the legs or one leg from the hypotenuse and the other leg.
TotalHarmonicDistortion This block calculates THD of the signal at the input.
RealFFT This block samples the input and calculates the FFT, writing the result to a mat file when the simulation terminates.
Modelica.Blocks.Routing
MultiplexMultiplexer block for arbitrary number of input signals
DeMultiplexDemultiplexer block for arbitrary number of output signals
Modelica.Blocks.Tables
CombiTable2DvVariant of CombiTable2D (table look-up in two dimensions) with vector inputs and vector output
Modelica.ComplexBlocks.Routing
Replicator
ExtractSignal
Extractor
ComplexPassThrough		 Complex implementations analogous to the real implementations.
Modelica.ComplexBlocks.ComplexMath
Bode Determine variables of a Bode diagram.
Modelica.ComplexBlocks.Sources
RampPhasor A source of a phasor with constant angle and ramped amplitude.
Modelica.Electrical.Analog.Basic
GeneralCurrentToVoltageAdaptor
GeneralVoltageToCurrentAdaptor		 Adaptors for the generation of FMUs, optionally taking first and second derivative into account.
Modelica.Electrical.Analog.Sensors
MultiSensor Measures voltage, current and power simultaneously.
Modelica.Electrical.Polyphase.Sensors
MultiSensor Measures voltage, current and active power for each phase as well as total power simultaneously.
AronSensor Measures active power for a three-phase system by two single-phase power sensors in an Aron circuit.
ReactivePowerSensor Measures reactive power for a three-phase system.
Modelica.Electrical.Machines.Examples
SMEE_DOL Electrically excited synchronous machine, starting direct on line via the damper cage, - synchronised by increasing excitation voltage.
SMR_DOL Synchronous reluctance machine, starting direct on line via the damper cage, - synchronised when reaching synchronous speed.
Modelica.Electrical.Machines.Sensors
HallSensor Simple model of a hall sensor, measuring the angle aligned with the orientation of phase 1.
Modelica.Electrical.PowerConverters.DCAC.Control
PWM
SVPWM
IntersectivePWM		 Standard three-phase pwm algorithms: space vector and intersective.
Modelica.Electrical.PowerConverters.DCDC
ChopperStepUp Step up chopper (boost converter) model.
Modelica.Electrical.QuasiStatic.SinglePhase.Sensors
MultiSensor Measures voltage, current and apparent power simultaneously.
Modelica.Electrical.QuasiStatic.Polyphase.Sensors
MultiSensor Measures voltage, current and apparent power for m phases as well as total apparent power simultaneously.
AronSensor Measures active power for a three-phase system by two single-phase power sensors in an Aron circuit.
ReactivePowerSensor Measures reactive power for a three-phase system.
Modelica.Electrical.QuasiStatic.{SinglePhase, Polyphase}.Sources
FrequencySweepVoltageSource
FrequencySweepCurrentSource		 Voltage source and current source with integrated frequency sweep.
Modelica.Mechanics.MultiBody
Visualizers.RectangleA planar rectangular surface.
Modelica.Mechanics.Rotational.Components
GeneralAngleToTorqueAdaptor
GeneralTorqueToAngleAdaptor		 Adaptors for the generation of FMUs, optionally taking first and second derivative into account.
- Note: These adaptors give the same results as:
- AngleToTorqueAdaptor
TorqueToAngleAdaptor
- but extend from Modelica.Blocks.Interfaces.Adaptors - like adaptors in other domains.
Modelica.Mechanics.Rotational.Sources
EddyCurrentTorque Rotational eddy current brake.
Modelica.Mechanics.Translational.Components
GeneralForceToPositionAdaptor
GeneralPositionToForceAdaptor		 Adaptors for the generation of FMUs, optionally taking first and second derivative into account.
Modelica.Mechanics.Translational.Sources
EddyCurrentForce Translational eddy current brake.
Modelica.Magnetic.FundamentalWave.Examples
A lot of new test examples for fundamental wave machines.
Modelica.Magnetic.QuasiStatic.FundamentalWave.Sensors
RotorDisplacementAngle Measures the rotor displacement angle of a quasi-static machine.
Modelica.Thermal.HeatTransfer.Components
GeneralHeatFlowToTemperatureAdaptor
GeneralTemperatureToHeatFlowAdaptor		 Adaptors for the generation of FMUs, optionally taking first derivative into account.
Modelica.Thermal.FluidHeatFlow.Examples
WaterPump
TestOpenTank
TwoTanks
TestCylinder		 New examples testing and demonstrating the new resp. enhanced components.
Modelica.Thermal.FluidHeatFlow.Components
Pipe A pipe model with optional heatPort which replaces the isolatedPipe and the heatedPipe.
OpenTank A simple model of an open tank.
Cylinder A simple model of a piston/cylinder with translational flange.
OneWayValve A simple one way valve model (comparable to an electrical ideal diode)
Modelica.Thermal.FluidHeatFlow.Media
Water_10degC
Water_90degC
Glycol20_20degC
Glycol50_20degC
MineralOil		 Several new records defining media properties.
Modelica.Thermal.FluidHeatFlow.Interfaces
SinglePortLeft Replaces the (now obsolete) partial model Ambient and is also used for Sources.AbsolutePressure.
SinglePortBottom Same as SinglePortLeft but with the flowPort at the bottom; used for the new Components.OpenTank model.
Modelica.Constants
q The elementary charge of an electron.
Modelica.Icons
FunctionsPackage This icon indicates a package that contains functions.
RecordPackage This icon indicates a package that contains records.
- -


-The following existing components -have been marked as obsolete and will be -removed in a future release: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Modelica.Blocks.Interfaces.Adaptors
SendReal
SendBoolean
SendInteger
ReceiveReal
ReceiveBoolean
ReceiveInteger		Use expandable connectors instead.
Modelica.StateGraph.Temporary
SetRealParameterUse parameter Real instead.
anyTrueUse Modelica.Math.BooleanVectors.anyTrue instead.
allTrueUse Modelica.Math.BooleanVectors.allTrue instead instead.
RadioButtonUse future model from Modelica.Blocks.Interaction instead.
NumericValueUse Modelica.Blocks.Interaction.Show.RealValue instead.
IndicatorLampUse Modelica.Blocks.Interaction.Show.BooleanValue instead.
Modelica.Electrical.Digital.Converters
LogicToXO1
LogicToXO1Z		Use LogicToX01 or LogicToX01Z instead.
Modelica.Electrical.Machines
BasicMachines.Components.BasicTransformerUse Interfaces.PartialBasicTransformer instead.
Modelica.Electrical.Spice3.Internal
BJTUse BJT2 instead.
Bjt3.*Use revised classes instead.
Modelica.Mechanics.MultiBody
Examples.Loops.Utilities.GasForceUse Examples.Loops.Utilities.GasForce2 instead.
Sensors.TansformAbsoluteVector
Sensors.TansformRelativeVector		Use Sensors.TransformAbsoluteVector or Sensors.TransformRelativeVector instead.
Visualizers.GroundUse ground plane visualization of World or Visualizers.Rectangle instead.
Modelica.Fluid.Icons
VariantLibrary
BaseClassLibrary		Use icons from Modelica.Icons instead.
Modelica.Media.Examples
Tests.Components.*Use classes from Utilities instead.
TestOnly.*
Tests.MediaTestModels.*		Use test models from ModelicaTest.Media instead.
Modelica.Thermal.FluidHeatFlow
Components.IsolatedPipe
Components.HeatedPipe		Extend from the new pipe model with optional heatPort.
Interfaces.AmbientExtends from SinglePortLeft.
Modelica.Math
baseIcon1
baseIcon2		Use icons from Modelica.Math.Icons instead.
Modelica.Icons
Library
Library2
GearIcon
MotorIcon
Info		Use (substitute) icons from Modelica.Icons, Modelica.Mechanics.Rotational.Icons or Modelica.Electrical.Machines.Icons instead.
Modelica.SIunits.Conversions.NonSIunits
FirstOrderTemperaturCoefficient
SecondOrderTemperaturCoefficient		Use Modelica.SIunits.LinearTemperatureCoefficientResistance or Modelica.SIunits.QuadraticTemperatureCoefficientResistance instead.
- -


-The following existing components -have been improved in a -backward compatible way: -

- - - - - - - - - - - - - - - -
Modelica.Blocks.Continuous
Integrator
LimIntegrator		Added optional reset and set value inputs.
LimPIDAdded an optional feed-forward input.
Modelica.Blocks.Sources
CombiTimeTableThe time events were not considered at the interval boundaries in case of linear interpolation and non-replicated sample points. This has been generalized by introduction of the new parameter timeEvents with the default option to always generate time events at the interval boundaries, which might lead to slower, but more accurate simulations.
BooleanTable
IntegerTable		Added options to set start time, shift time and extrapolation kind, especially to set periodic extrapolation.
Modelica.Blocks.Tables
CombiTable1D
CombiTable1Ds
CombiTable2D		Added option to set the extrapolation kind and to optionally print a warning in case of extrapolated table input.
- -


-The following existing components have been changed in a non-backward compatible way: -

- - - - - - - - - - - -
Modelica.Blocks
Interfaces.PartialNoise
Noise.UniformNoise
Noise.NormalNoise
Noise.TruncatedNormalNoise
Noise.BandLimitedWhiteNoise		As a side-effect of the corrected computation in Modelica.Math.Random.Utilities.impureRandomInteger the localSeed parameter is computed differently if useAutomaticLocalSeed is set to true.
Modelica.Mechanics.MultiBody
WorldAdded new parameter animateGround for optional ground plane visualization.
- Users that have copied the World model (of MSL 3.0, 3.0.1, 3.1, 3.2, 3.2.1, or 3.2.2) as an own World model and used it as inner world component, might have broken their models. - Generally, for MSL models with sub-typing (due to inner/outer), it is strongly suggested to extend from this MSL model, instead of copying it.
Modelica.Media.Interfaces
PartialMediumAdded new constant C_default as default value for the trace substances of medium.
- Users that have created an own medium by inheritance from the PartialMedium package and already added the C_default constant, might have broken their models.
- Users that have copied the PartialMedium package (of MSL 3.0, 3.0.1, 3.1, 3.2, 3.2.1, or 3.2.2) as an own Medium package, might have broken their models. - Generally, for MSL classes with sub-typing (due to a replaceable declaration), it is strongly suggested to extend from this MSL class, instead of copying it.
- -


-The following critical errors have been fixed (i.e., errors -that can lead to wrong simulation results): -

- - - - - - - - - - - - - - - - - - - - - - - -
Modelica.Blocks.Sources
TimeTableThe derivative of the TimeTable output could no longer be determined. This has been corrected.
Modelica.Media.Air
MoistAir.molarMass
ReferenceMoistAir.molarMass		The computation of the function output MM was wrong. This has been corrected.
Modelica.Media.IdealGases.Common.Functions
thermalConductivityEstimateThe computation of the function output lambda was wrong for the modified Eucken correlation, i.e., if method is set to 2. This has been corrected.
Modelica.Media.IdealGases.Common.SingleGasesData
CH2
CH3
CH3OOH
C2CL2
C2CL4
C2CL6
C2HCL
C2HCL3
CH2CO_ketene
O_CH_2O
HO_CO_2OH
CH2BrminusCOOH
C2H3CL
CH2CLminusCOOH
HO2
HO2minus
OD
ODminus		The coefficients for blow, ahigh and bhigh were wrong. This has been corrected.
Modelica.Media.IdealGases.Common.MixtureGasNasa
mixtureViscosityChungThe computation of the function output etaMixture was wrong. This has been corrected.
Modelica.Media.Incompressible.TableBased
BasePropertiesThe unit of the gas constant R for table based media was not correctly considered. This has been corrected.
Modelica.Math.Random.Utilities
impureRandomIntegerThe function output y was not computed to yield a discrete uniform distribution for a minimum value imin of 1. This has been corrected.
- -")); -end Version_3_2_3; - -class Version_3_2_2 "Version 3.2.2 (April 3, 2016)" - extends Modelica.Icons.ReleaseNotes; - - annotation (Documentation(info=" -

-Version 3.2.2 is backward compatible to version 3.2.1, that is models developed with -versions 3.0, 3.0.1, 3.1, 3.2, or 3.2.1 will work without any changes also with version 3.2.2 -(with exception of the, usually uncritical, non-backwards compatible changes listed below with regards to -external object libraries, and one bug fix introduced in 3.2.1 Build.3 for non-circular pipes -that can be non-backwards compatible if a user constructed a new pipe model based on -Modelica.Fluid.Pipes.BaseClasses.WallFriction.PartialWallFriction, see details below). -

- - - -

-The exact difference between package Modelica version 3.2.2 and version 3.2.1 is -summarized in the following two comparison tables: -

- - -

-This release of package Modelica, and the accompanying ModelicaTest, has been tested with the -following tools (the tools are listed alphabetically. At the time of the test, some of the -tools might not yet supported the complete Modelica package. For more details of the tests -see #1867): -

- - - -

-The following Modelica packages have been tested that they work together with this release of package Modelica -(alphabetical list): -

- - - -


-The following new libraries have been added: -

- - - - - - - - - - - - - - - - - - - -
Modelica.Electrical.PowerConverters - This library offers models for rectifiers, inverters and DC/DC-converters.
- (This library was developed by Christian Kral and Anton Haumer.) -
Modelica.Magnetic.QuasiStatic.FundamentalWave - This library provides quasi-static models of polyphase machines (induction machines, synchronous machines) in parallel (with the same parameters but different electric connectors) - to the transient models in Modelica.Magnetic.FundamentalWave.
- Quasistatic means that electric transients are neglected, voltages and currents are supposed to be sinusoidal. Mechanical and thermal transients are taken into account.
- This library is especially useful in combination with the Modelica.Electrical.QuasiStatic - library in order to build up very fast simulations of electrical circuits with sinusoidal currents and voltages.
- (This library was developed by Christian Kral and Anton Haumer.) -
Sublibraries of Modelica.Magnetic.FluxTubes - New elements for modeling ferromagnetic (static) and eddy current (dynamic) hysteresis effects and permanent magnets have been added. - The FluxTubes.Material package is also extended to provide hysteresis data for several magnetic materials. These data is partly based on own measurements. - For modeling of ferromagnetic hysteresis, two different hysteresis models have been implemented: The simple Tellinen model and the considerably - more detailed Preisach hysteresis model. The following packages have been added: - - (These extensions have been developed by Johannes Ziske and Thomas Bödrich as part of the Clean Sky JTI project; - project number: 296369; Theme: - JTI-CS-2011-1-SGO-02-026; - MOMOLIB - Modelica Model Library Development for Media, Magnetic Systems and Wavelets. - The partial financial support by the European Union for this development is highly appreciated.). -
Sublibraries for noise modeling - Several new sublibraries have been added allowing the modeling of reproducible noise. - The most important new sublibraries are (for more details see below): - - (These extensions have been developed by Andreas Klöckner, Frans van der Linden, Dirk Zimmer, and Martin Otter from - DLR Institute of System Dynamics and Control). -
Modelica.Utilities functions for matrix read/write - New functions are provided in the Modelica.Utilities.Streams - sublibrary to write matrices in MATLAB MAT format on file and read matrices in this format from file. - The MATLAB MAT formats v4, v6, v7 and v7.3 (in case the tool supports HDF5) are supported by these functions. - Additionally, example models are provided under - Modelica.Utilities.Examples - to demonstrate the usage of these functions in models. For more details see below.
- (These extensions have been developed by Thomas Beutlich from ITI GmbH). -
Modelica.Math sublibrary for FFT - The new sublibrary FastFourierTransform - provides utility and convenience functions to compute the Fast Fourier Transform (FFT). - Additionally two examples are present to demonstrate how to compute an FFT during continuous-time - simulation and store the result on file. For more details see below.
- (These extensions have been developed by Martin Kuhn and Martin Otter from - DLR Institute of System Dynamics and Control). -
- -


-The following new components have been added -to existing libraries: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Modelica.Blocks.Examples
NoiseExamples Several examples to demonstrate the usage of the blocks in the - new sublibrary Blocks.Noise.
Modelica.Blocks.Interfaces
PartialNoise Partial noise generator (base class of the noise generators in Blocks.Noise)
Modelica.Blocks.Math
ContinuousMean Calculates the empirical expectation (mean) value of its input signal
Variance Calculates the empirical variance of its input signal
StandardDeviation Calculates the empirical standard deviation of its input signal
Modelica.Blocks.Noise
GlobalSeed Defines global settings for the blocks of sublibrary Noise, - especially a global seed value is defined
UniformNoise Noise generator with uniform distribution
NormalNoise Noise generator with normal distribution
TruncatedNormalNoise Noise generator with truncated normal distribution
BandLimitedWhiteNoise Noise generator to produce band-limited white noise with normal distribution
Modelica.ComplexBlocks.Examples
ShowTransferFunction Example to demonstrate the usage of the block TransferFunction.
Modelica.ComplexBlocks.ComplexMath
TransferFunction This block allows to define a complex transfer function (depending on frequency input w) to obtain the complex output y.
Modelica.ComplexBlocks.Sources
LogFrequencySweep The logarithm of w performs a linear ramp from log10(wMin) to log10(wMax), the output is the decimal power of this logarithmic ramp.
Modelica.Electrical.Machines.Examples
ControlledDCDrivesCurrent, speed and position controlled DC PM drive
Modelica.Mechanics.Rotational.Examples.Utilities.
SpringDamperNoRelativeStatesIntroduced to fix ticket 1375
Modelica.Mechanics.Rotational.Components.
ElastoBacklash2Alternative model of backlash. The difference to the existing ElastoBacklash - component is that an event is generated when contact occurs and that the contact torque - changes discontinuously in this case. For some user models, this variant of a backlash model - leads to significantly faster simulations.
Modelica.Fluid.Examples.
NonCircularPipesIntroduced to check the fix of ticket 1681
Modelica.Media.Examples.
PsychrometricDataIntroduced to fix ticket 1679
Modelica.Math.Matrices.
balanceABC Return a balanced form of a system [A,B;C,0] - to improve its condition by a state transformation
Modelica.Math.Random.Generators.
Xorshift64star Random number generator xorshift64*
Xorshift128plus Random number generator xorshift128+
Xorshift1024star Random number generator xorshift1024*
Modelica.Math.Random.Utilities.
initialStateWithXorshift64star Return an initial state vector for a random number generator (based on xorshift64star algorithm)
automaticGlobalSeed Creates an automatic integer seed from the current time and process id (= impure function)
initializeImpureRandom Initializes the internal state of the impure random number generator
impureRandom Impure random number generator (with hidden state vector)
impureRandomInteger Impure random number generator for integer values (with hidden state vector)
Modelica.Math.Distributions.
Uniform Library of uniform distribution functions (functions: density, cumulative, quantile)
Normal Library of normal distribution functions (functions: density, cumulative, quantile)
TruncatedNormal Library of truncated normal distribution functions (functions: density, cumulative, quantile)
Weibull Library of Weibull distribution functions (functions: density, cumulative, quantile)
TruncatedWeibull Library of truncated Weibull distribution functions (functions: density, cumulative, quantile)
Modelica.Math.Special.
erfError function erf(u) = 2/sqrt(pi)*Integral_0_u exp(-t^2)*d
erfcComplementary error function erfc(u) = 1 - erf(u)
erfInvInverse error function: u = erf(erfInv(u))
erfcInv Inverse complementary error function: u = erfc(erfcInv(u))
sinc Unnormalized sinc function: sinc(u) = sin(u)/u
Modelica.Math.FastFourierTransform.
realFFTinfo Print information about real FFT for given f_max and f_resolution
realFFTsamplePoints Return number of sample points for a real FFT
realFFTReturn amplitude and phase vectors for a real FFT
Modelica.Utilities.Streams.
readMatrixSizeRead dimensions of a Real matrix from a MATLAB MAT file
readRealMatrixRead Real matrix from MATLAB MAT file
writeRealMatrixWrite Real matrix to a MATLAB MAT file
Modelica.Utilities.Strings.
hashStringCreates a hash value of a String
Modelica.Utilities.System.
getTimeRetrieves the local time (in the local time zone)
getPidRetrieves the current process id
- -


-The following existing components have been changed in a non-backward compatible way: -

- - - - - - - -
Electrical.Analog.Semiconductors.
HeatingDiode Removed protected variable k \"Boltzmann's constant\".
- Calculate protected constant q \"Electron charge\" from already known constants instead of defining a protected variable q.
HeatingNPN
- HeatingPNP 		Removed parameter K \"Boltzmann's constant\" and q \"Elementary electronic charge\".
- Calculate instead protected constant q \"Electron charge\" from already known constants.
- Users that have used these parameters might have broken their models; - the (although formal non-backwards compatible) change offers the users a safer use.
- -")); -end Version_3_2_2; - -class Version_3_2_1 "Version 3.2.1 (August 14, 2013)" - extends Modelica.Icons.ReleaseNotes; - - annotation (Documentation(info=" -

-Version 3.2.1 is backward compatible to version 3.2, that is models developed with -versions 3.0, 3.0.1, 3.1, or 3.2 will work without any changes also with version 3.2.1. -This version is a \"clean-up\" with major emphasis on quality improvement and -tool compatibility. The goal is that all -Modelica tools will support this package -and will interpret it in the same way. Short Overview: -

- - - -

-This release of package Modelica, and the accompanying ModelicaTest, has been tested with the -following tools (the tools are listed alphabetically. At the time of the test, some of the -tools might not yet supported the complete Modelica package): -

- - - -

-The following Modelica packages have been tested that they work together with this release of package Modelica -(alphabetical list): -

- - - -

-The new open source tables have been tested by T. Beutlich (ITI): -

- - - -

-The exact difference between package Modelica version 3.2 and version 3.2.1 is -summarized in a -comparison table. -

- -

-About 400 trac tickets have been fixed for this release. An overview is given -here. -Clicking on a ticket gives all information about it. -

- -


-The following new components have been added -to existing libraries: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Modelica.Blocks.Logical.
RSFlipFlop Basic RS flip flop
Modelica.Blocks.Math.
MinMaxOutput the minimum and the maximum element of the input vector
LinearDependency Output a linear combination of the two inputs
Modelica.Blocks.Nonlinear.
SlewRateLimiter Limit the slew rate of a signal
Modelica.Electrical.Digital.Memories
DLATRAM Level sensitive Random Access Memory
DLATROM Level sensitive Read Only Memory
Modelica.Electrical.Digital.Multiplexers
MUX2x1 A two inputs MULTIPLEXER for multiple value logic (2 data inputs, 1 select input, 1 output)
Modelica.Electrical.Machines.Examples.InductionMachines.
IMC_Initialize Steady-State Initialization example of InductionMachineSquirrelCage
Modelica.Electrical.Machines.Examples.SynchronousMachines.
SMPM_VoltageSource PermanentMagnetSynchronousMachine example fed by FOC
Modelica.Electrical.Polyphase.Examples.
TestSensors Example for polyphase quasiRMS sensors: A sinusoidal source feeds a load consisting of resistor and inductor
Modelica.Electrical.Polyphase.Sensors.
VoltageQuasiRMSSensor Continuous quasi voltage RMS sensor for polyphase system
CurrentQuasiRMSSensor Continuous quasi current RMS sensor for polyphase system
Modelica.Electrical.Polyphase.Blocks.
QuasiRMS Determine quasi RMS value of a polyphase system
Modelica.Electrical.Polyphase.Functions.
quasiRMS Calculate continuous quasi RMS value of input
activePower Calculate active power of voltage and current input
symmetricOrientation Orientations of the resulting fundamental wave field phasors
Modelica.Electrical.Spice3.Examples.
CoupledInductors
- CascodeCircuit
- Spice3BenchmarkDifferentialPair
- Spice3BenchmarkMosfetCharacterization
- Spice3BenchmarkRtlInverter
- Spice3BenchmarkFourBitBinaryAdder		 Spice3 examples and benchmarks from the SPICE3 Version e3 User's Manual
Modelica.Electrical.Spice3.Basic.
K_CoupledInductors Inductive coupling via coupling factor K
Modelica.Electrical.Spice3.Semiconductors.
M_NMOS2
- M_PMOS2
- ModelcardMOS2		 N/P channel MOSFET transistor with fixed level 2
J_NJFJFE
- J_PJFJFE
- ModelcardJFET		 N/P-channel junction field-effect transistor
C_Capacitor
- ModelcardCAPACITOR		 Semiconductor capacitor model
Modelica.Magnetic.FundamentalWave.Examples.BasicMachines.
IMC_DOL_Polyphase
- IMS_Start_Polyphase
- SMPM_Inverter_Polyphase
- SMEE_Generator_Polyphase
- SMR_Inverter_Polyphase		 Polyphase machine examples
Modelica.Fluid.Sensors.
MassFractions
- MassFractionsTwoPort		 Ideal mass fraction sensors
Modelica.Media.
R134a R134a (Tetrafluoroethane) medium model in the range (0.0039 bar .. 700 bar, - 169.85 K .. 455 K)
Modelica.Media.Air.
ReferenceAir Detailed dry air model with a large operating range (130 ... 2000 K, 0 ... 2000 MPa) - based on Helmholtz equations of state
ReferenceMoistAir Detailed moist air model (143.15 ... 2000 K)
MoistAir Temperature range of functions of MoistAir medium enlarged from - 240 - 400 K to 190 - 647 K.
Modelica.Media.Air.MoistAir.
velocityOfSound
- isobaricExpansionCoefficient
- isothermalCompressibility
- density_derp_h
- density_derh_p
- density_derp_T
- density_derT_p
- density_derX
- molarMass
- T_psX
- setState_psX
- s_pTX
- s_pTX_der
- isentropicEnthalpy		 Functions returning additional properties of the moist air medium model
Modelica.Thermal.HeatTransfer.Components.
ThermalResistor Lumped thermal element transporting heat without storing it (dT = R*Q_flow)
ConvectiveResistor Lumped thermal element for heat convection (dT = Rc*Q_flow)
Modelica.MultiBody.Examples.Constraints.
PrismaticConstraint
- RevoluteConstraint
- SphericalConstraint
- UniversalConstraint		 Demonstrates the use of the new Joints.Constraints joints by comparing - them with the standard joints.
Modelica.MultiBody.Joints.Constraints.
Prismatic
- Revolute
- Spherical
- Universal		 Joint elements formulated as kinematic constraints. These elements are - designed to break kinematic loops and result usually in numerically more - efficient and reliable loop handling as the (standard) automatic handling.
Modelica.Mechanics.Rotational.
MultiSensor Ideal sensor to measure the torque and power between two flanges and the absolute angular velocity
Modelica.Mechanics.Translational.
MultiSensor Ideal sensor to measure the absolute velocity, force and power between two flanges
Modelica.Math.
isPowerOf2 Determine if the integer input is a power of 2
Modelica.Math.Vectors.
normalizedWithAssert Return normalized vector such that length = 1 (trigger an assert for zero vector)
Modelica.Math.BooleanVectors.
countTrue Returns the number of true entries in a Boolean vector
enumerate Enumerates the true entries in a Boolean vector (0 for false entries)
index Returns the indices of the true entries of a Boolean vector
Modelica.Utilities.Files.
loadResource Return the absolute path name of a URI or local file name
Modelica.SIunits.
PressureDifference
- MolarDensity
- MolarEnergy
- MolarEnthalpy
- TimeAging
- ChargeAging
- PerUnit
- DerPressureByDensity
- DerPressureByTemperature		 New SI unit types
-")); -end Version_3_2_1; - -class Version_3_2 "Version 3.2 (Oct. 25, 2010)" - extends Modelica.Icons.ReleaseNotes; - - annotation (Documentation(info=" - -

-Version 3.2 is backward compatible to version 3.1, i.e., models developed with -versions 3.0, 3.0.1, or 3.1 will work without any changes also with version 3.2. -This version is a major improvement: -

- - - -

-Version 3.2 is slightly based on the Modelica Specification 3.2. It uses -the following new language elements (compared to Modelica Specification 3.1): -

- - - -

-A large part of the new classes has been developed with -partial financial support by -BMBF (BMBF Förderkennzeichen: 01IS07022F) -within the ITEA EUROSYSLIB research project. -We highly appreciate this funding. -

- -

-The following new libraries have been added: -

- - - - - - - - - - - - - - - - - - - - - - -
Complex - This is a top-level record outside of the Modelica Standard Library. - It is used for complex numbers and contains overloaded operators. - From a users point of view, Complex is used in a similar way as the - built-in type Real. Example:
-   Real a = 2;
-   Complex j = Modelica.ComplexMath.j;
-   Complex b = 2 + 3*j;
-   Complex c = (2*b + a)/b;
-   Complex d = Modelica.ComplexMath.sin(c);
-   Complex v[3] = {b/2, c, 2*d};
- (This library was developed by Marcus Baur, DLR.) -
Modelica.ComplexBlocks - Library of basic input/output control blocks with Complex signals.
- This library is especially useful in combination with the new - Modelica.Electrical.QuasiStatic - library in order to build up very fast simulations of electrical circuits with periodic - currents and voltages.
- (This library was developed by Anton Haumer.) -
Modelica.Electrical.QuasiStatic - Library for quasi-static electrical single-phase and polyphase AC simulation.
- This library allows very fast simulations of electrical circuits with sinusoidal - currents and voltages by only taking into account the quasi-static, periodic part - and neglecting non-periodic transients.
- (This library was developed by Anton Haumer and Christian Kral.) -
Modelica.Electrical.Spice3 - Library with components of the Berkeley - SPICE3 - simulator:
- R, C, L, controlled and independent sources, semiconductor device models - (MOSFET Level 1, Bipolar junction transistor, Diode, Semiconductor resistor). - The components have been intensively tested with more than 1000 test models - and compared with results from the SPICE3 simulator. All test models give identical - results in Dymola 7.4 with respect to the Berkeley SPICE3 simulator up to the relative - tolerance of the integrators.
- This library allows detailed simulations of electronic circuits. - Work on Level 2 SPICE3 models, i.e., even more detailed models, is under way. - Furthermore, a pre-processor is under development to transform automatically - a SPICE netlist into a Modelica model, in order that the many available - SPICE3 models can be directly used in a Modelica model.
- (This library was developed by Fraunhofer Gesellschaft, Dresden.) -
Modelica.Magnetic.FundamentalWave - Library for magnetic fundamental wave effects in electric machines for the - application in three phase electric machines. - The library is an alternative approach to the Modelica.Electrical.Machines library. - A great advantage of this library is the strict object orientation of the - electrical and magnetic components that the electric machines models are composed of. - This allows an easier incorporation of more detailed physical effects of - electrical machines. - From a didactic point of view this library is very beneficial for students in the field - of electrical engineering.
- (This library was developed by Christian Kral and Anton Haumer, using - ideas and source code of a library from Michael Beuschel from 2000.) -
Modelica.Fluid.Dissipation - Library with functions to compute convective heat transfer and pressure loss characteristics.
- (This library was developed by Thorben Vahlenkamp and Stefan Wischhusen from - XRG Simulation GmbH.) -
Modelica.ComplexMath - Library of complex mathematical functions (e.g., sin, cos) and of functions operating - on complex vectors.
- (This library was developed by Marcus Baur from DLR-RM, Anton Haumer, and - HansJürg Wiesmann.) -
- -


-The following new components have been added -to existing libraries: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Modelica.UsersGuide
Conventions - Considerably improved 'Conventions' for the Modelica Standard Library.
Modelica.Blocks.Examples
Filter
- FilterWithDifferentation
- FilterWithRiseTime
- RealNetwork1
- IntegerNetwork1
- BooleanNetwork1
- Interaction1 - 		Examples for the newly introduced block components.
Modelica.Blocks.Continuous
Filter Continuous low pass, high pass, band pass and band stop - IIR-filter of type CriticalDamping, Bessel, Butterworth and Chebyshev I.
Modelica.Blocks.Interaction.Show
RealValue
- IntegerValue
- BooleanValue		 Blocks to show the values of variables in a diagram animation.
Modelica.Blocks.Interfaces
RealVectorInput
- IntegerVectorInput
- BooleanVectorInput
- PartialRealMISO
- PartialIntegerSISO
- PartialIntegerMISO
- PartialBooleanSISO_small
- PartialBooleanMISO - 		Interfaces and partial blocks for the new block components.
Modelica.Blocks.Math
MultiSum
- MultiProduct
- MultiSwitch 		Sum, product and switch blocks with 1,2,...,N inputs - (based on connectorSizing annotation to handle vectors of - connectors in a convenient way).
Modelica.Blocks.MathInteger
MultiSwitch
- Sum
- Product
- TriggeredAdd		 Mathematical blocks for Integer signals.
Modelica.Blocks.Boolean
MultiSwitch
- And
- Or
- Xor
- Nand
- Nor
- Not
- RisingEdge
- FallingEdge
- ChangingEdge
- OnDelay		 Mathematical blocks for Boolean signals. - Some of these blocks are available also in library - Logical. - The new design is based on the connectorSizing annotation that allows - the convenient handling of an arbitrary number of input signals - (e.g., the \"And\" block has 1,2,...,N inputs, instead of only 2 inputs - in the Logical library). - Additionally, the icons are smaller so that the diagram area is - better utilized
Modelica.Blocks.Sources
RadioButtonSource Boolean signal source that mimics a radio button.
IntegerTable Generate an Integer output signal based on a table matrix - with [time, yi] values.
Modelica.Electrical.Analog.Examples
SimpleTriacCircuit,
- IdealTriacCircuit,
- AD_DA_conversion 		Examples for the newly introduced Analog components.
Modelica.Electrical.Analog.Ideal
IdealTriac,
- AD_Converter,
- DA_Converter 		AD and DA converter, ideal triac (based on ideal thyristor).
Modelica.Electrical.Analog.Semiconductors
SimpleTriac Simple triac based on semiconductor thyristor model.
Modelica.Electrical.Digital.Examples
Delay_example,
- DFFREG_example,
- DFFREGL_example,
- DFFREGSRH_example,
- DFFREGSRL_example,
- DLATREG_example,
- DLATREGL_example,
- DLATREGSRH_example,
- DLATREGSRL_example,
- NXFER_example,
- NRXFER_example,
- BUF3S_example,
- INV3S_example,
- WiredX_example 		Examples for the newly introduced Digital components.
Modelica.Electrical.Digital.Interfaces
UX01,
- Strength,
- MIMO 		Interfaces for the newly introduced Digital components.
Modelica.Electrical.Digital.Tables
ResolutionTable,
- StrengthMap,
- NXferTable,
- NRXferTable,
- PXferTable,
- PRXferTable,
- Buf3sTable,
- Buf3slTable 		New Digital table components.
Modelica.Electrical.Digital.Delay
InertialDelaySensitiveVector New Digital delay component.
Modelica.Electrical.Digital.Registers
DFFR,
- DFFREG,
- DFFREGL,
- DFFSR,
- DFFREGSRH,
- DFFREGSRL,
- DLATR,
- DLATREG,
- DLATREGL,
- DLATSR,
- DLATREGSRH,
- DLATREGSRL 		Various register components (collection of flipflops and latches) - according to the VHDL standard.
Modelica.Electrical.Digital.Tristates
NXFERGATE,
- NRXFERGATE,
- PXFERGATE,
- PRXFERGATE,
- BUF3S,
- BUF3SL,
- INV3S,
- INV3SL,
- WiredX 		Transfer gates, buffers, inverters and wired node.
Modelica.Electrical.Polyphase.Basic
MutualInductor Polyphase inductor providing a mutual inductance matrix model.
ZeroInductor Polyphase zero sequence inductor.
Modelica.Electrical.Machines
Examples Structured according to machine types:
- InductionMachines
- SynchronousMachines
- DCMachines
- Transformers
Losses.* Parameter records and models for losses in electrical machines and transformers (where applicable):
- Friction losses
- Brush losses
- Stray Load losses
- Core losses (only eddy current losses but no hysteresis losses; not for transformers)
Thermal.* Simple thermal ambience, to be connected to the thermal ports of machines,
- as well as material constants and utility functions.
Icons.* Icons for transient and quasi-static electrical machines and transformers.
Modelica.Electrical.Machines.Examples.InductionMachines.
AIMC_withLosses Induction machine with squirrel cage with losses
AIMC_Transformer Induction machine with squirrel cage - transformer starting
AIMC_withLosses Test example of an induction machine with squirrel cage with losses
Modelica.Electrical.Machines.Examples.SynchronousMachines.
SMPM_CurrentSource Permanent magnet synchronous machine fed by a current source
SMEE_LoadDump Electrical excited synchronous machine with voltage controller
Modelica.Electrical.Machines.Examples.DCMachines.
DCSE_SinglePhase Series excited DC machine, fed by sinusoidal voltage
DCPM_Temperature Permanent magnet DC machine, demonstration of varying temperature
DCPM_Cooling Permanent magnet DC machine, coupled with a simple thermal model
DCPM_QuasiStatic Permanent magnet DC machine, comparison between transient and quasi-static model
DCPM_Losses Permanent magnet DC machine, comparison between model with and without losses
Modelica.Electrical.Machines.BasicMachines.QuasiStaticDCMachines.
DC_PermanentMagnet
- DC_ElectricalExcited
- DC_SeriesExcited 		QuasiStatic DC machines, i.e., neglecting electrical transients
Modelica.Electrical.Machines.BasicMachines.Components.
InductorDC Inductor model which neglects der(i) if Boolean parameter quasiStatic = true
Modelica.Electrical.Machines.Interfaces.
ThermalPortTransformer
- PowerBalanceTransformer 		Thermal ports and power balances for electrical machines and transformers.
Modelica.Electrical.Machines.Utilities
SwitchedRheostat Switched rheostat, used for starting induction motors with slipring rotor.
RampedRheostat Ramped rheostat, used for starting induction motors with slipring rotor.
SynchronousMachineData The parameters of the synchronous machine model with electrical excitation (and damper) are calculated - from parameters normally given in a technical description, - according to the standard EN 60034-4:2008 Appendix C.
Modelica.Mechanics.MultiBody.Examples.Elementary.
HeatLosses Demonstrate the modeling of heat losses.
UserDefinedGravityField Demonstrate the modeling of a user-defined gravity field.
Surfaces Demonstrate the visualization of a sine surface,
- as well as a torus and a wheel constructed from a surface.
Modelica.Mechanics.MultiBody.Joints.
FreeMotionScalarInit Free motion joint that allows initialization and state selection
- of single elements of the relevant vectors
- (e.g., initialize r_rel_a[2] but not the other elements of r_rel_a;
- this new component fixes ticket - #274)
Modelica.Mechanics.MultiBody.Visualizers.
Torus Visualizing a torus.
VoluminousWheel Visualizing a voluminous wheel.
PipeWithScalarField Visualizing a pipe with scalar field quantities along the pipe axis.
Modelica.Mechanics.MultiBody.Visualizers.ColorMaps.
jet
- hot
- gray
- spring
- summer
- autumn
- winter 		Functions returning different color maps.
Modelica.Mechanics.MultiBody.Visualizers.Colors.
colorMapToSvg Save a color map on file in svg (scalable vector graphics) format.
scalarToColor Map a scalar to a color using a color map.
Modelica.Mechanics.MultiBody.Visualizers.Advanced.
Surface Visualizing a moveable, parameterized surface;
- the surface characteristic is provided by a function
- (this new component fixes ticket - #181)
PipeWithScalarField Visualizing a pipe with a scalar field.
Modelica.Mechanics.MultiBody.Visualizers.Advanced.SurfaceCharacteristics.
torus Function defining the surface characteristic of a torus.
pipeWithScalarField Function defining the surface characteristic of a pipe
- where a scalar field value is displayed with color along the pipe axis.
Modelica.Mechanics.Rotational.Examples.
HeatLosses Demonstrate the modeling of heat losses.
Modelica.Mechanics.Translational.Examples.
HeatLosses Demonstrate the modeling of heat losses.
Modelica.Fluid.Fittings.Bends
CurvedBend
- EdgedBend		 New fitting (pressure loss) components.
Modelica.Fluid.Fittings.Orifices.
ThickEdgedOrifice New fitting (pressure loss) component.
Modelica.Fluid.Fittings.GenericResistances.
VolumeFlowRate New fitting (pressure loss) component.
Modelica.Math
isEqual Determine if two Real scalars are numerically identical.
Modelica.Math.Vectors
find Find element in vector.
toString Convert a real vector to a string.
interpolate Interpolate in a vector.
relNodePositions Return vector of relative node positions (0..1).
Modelica.Math.Vectors.Utilities
householderVector
- householderReflection
- roots 		Utility functions for vectors that are used by the newly introduced functions, - but are only of interest for a specialist.
Modelica.Math.Matrices
continuousRiccati
- discreteRiccati 		Return solution of continuous-time and discrete-time - algebraic Riccati equation respectively.
continuousSylvester
- discreteSylvester 		Return solution of continuous-time and discrete-time - Sylvester equation respectively.
continuousLyapunov
- discreteLyapunov 		Return solution of continuous-time and discrete-time - Lyapunov equation respectively.
trace Return the trace of a matrix.
conditionNumber Compute the condition number of a matrix.
rcond Estimate the reciprocal condition number of a matrix.
nullSpace Return a orthonormal basis for the null space of a matrix.
toString Convert a matrix into its string representation.
flipLeftRight Flip the columns of a matrix in left/right direction.
flipUpDown Flip the rows of a matrix in up/down direction.
cholesky Perform Cholesky factorization of a real symmetric positive definite matrix.
hessenberg Transform a matrix to upper Hessenberg form.
realSchur Computes the real Schur form of a matrix.
frobeniusNorm Return the Frobenius norm of a matrix.
Modelica.Math.Matrices.LAPACK.
dtrevc
- dpotrf
- dtrsm
- dgees
- dtrsen
- dgesvx
- dhseqr
- dlange
- dgecon
- dgehrd
- dgeqrf
- dggevx
- dgesdd
- dggev
- dggevx
- dhgeqz
- dormhr
- dormqr
- dorghr		 New interface functions for LAPACK - (should usually not directly be used but only indirectly via - Modelica.Math.Matrices).
Modelica.Math.Matrices.Utilities.
reorderRSF
- continuousRiccatiIterative
- discreteRiccatiIterative
- eigenvaluesHessenberg
- toUpperHessenberg
- householderReflection
- householderSimilarityTransformation
- findLokal_tk		 Utility functions for matrices that are used by the newly introduced functions, - but are only of interest for a specialist.
Modelica.Math.Nonlinear
quadratureLobatto Return the integral of an integrand function using an adaptive Lobatto rule.
solveOneNonlinearEquation Solve f(u) = 0 in a very reliable and efficient way - (f(u_min) and f(u_max) must have different signs).
Modelica.Math.Nonlinear.Examples.
quadratureLobatto1
- quadratureLobatto2
- solveNonlinearEquations1
- solveNonlinearEquations2 		Examples that demonstrate the usage of the Modelica.Math.Nonlinear functions - to integrate over functions and to solve scalar nonlinear equations.
Modelica.Math.BooleanVectors.
allTrue Returns true, if all elements of the Boolean input vector are true.
anyTrue Returns true, if at least on element of the Boolean input vector is true.
oneTrue Returns true, if exactly one element of the Boolean input vector is true.
firstTrueIndex Returns the index of the first element of the Boolean vector that - is true and returns 0, if no element is true
Modelica.Icons.
Information
- Contact
- ReleaseNotes
- References
- ExamplesPackage
- Example
- Package
- BasesPackage
- VariantsPackage
- InterfacesPackage
- SourcesPackage
- SensorsPackage
- MaterialPropertiesPackage
- MaterialProperty 		New icons to get a unified view on different categories - of packages.
Modelica.SIunits.
ComplexCurrent
- ComplexCurrentSlope
- ComplexCurrentDensity
- ComplexElectricPotential
- ComplexPotentialDifference
- ComplexVoltage
- ComplexVoltageSlope
- ComplexElectricFieldStrength
- ComplexElectricFluxDensity
- ComplexElectricFlux
- ComplexMagneticFieldStrength
- ComplexMagneticPotential
- ComplexMagneticPotentialDifference
- ComplexMagnetomotiveForce
- ComplexMagneticFluxDensity
- ComplexMagneticFlux
- ComplexReluctance
- ComplexImpedance
- ComplexAdmittance
- ComplexPower		 SIunits to be used in physical models using complex variables, e.g.,
- Modelica.Electrical.QuasiStatic, - Modelica.Magnetic.FundamentalWave
ImpulseFlowRate
- AngularImpulseFlowRate		 New SIunits for mechanics.
- -


-The following existing components -have been improved in a -backward compatible way: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Modelica.Blocks.Sources.
Pulse
- SawTooth 		New parameter \"nperiod\" introduced to define the number of periods - for the signal type. Default is \"infinite number of periods - (nperiods=-1).
Modelica.Electrical.
Polyphase.* All dissipative components have now an optional heatPort connector - to which the dissipated losses are transported in form of heat. -
Machines.* To all electric machines (asynchronous and synchronous induction machines, DC machines) - and transformers loss models have been added (where applicable):
- Temperature dependent resistances (ohmic losses)
- Friction losses
- Brush losses
- Stray Load losses
- Core losses (only eddy current losses but no hysteresis losses; not for transformers)
- As default, temperature dependency and losses are set to zero.

- To all electric machines (asynchronous and synchronous induction machines, DC machines) - and transformers conditional thermal ports have been added, - to which the dissipated losses are flowing, if activated. - The thermal port contains a HeatPort - for each loss source of the specific machine type.

- To all electric machines (asynchronous and synchronous induction machines, DC machines) - a \"powerBalance\" result record has been added, summarizing converted power and losses. -
Modelica.Mechanics.
MultiBody.*
- Rotational.*
- Translational.*		 All dissipative components in Modelica.Mechanics have now an - optional heatPort connector to which the dissipated energy is - transported in form of heat.
- All icons in Modelica.Mechanics are unified according to the - Modelica.Blocks library:
- \"%name\": width: -150 .. 150, height: 40, color: blue
- other text: height: 30, color: black -
Modelica.Mechanics.MultiBody.
World Function gravityAcceleration is made replaceable, so that redeclaration - yields user-defined gravity fields. -
Modelica.Fluid.Valves.
ValveIncompressible
- ValveVaporizing
- ValveCompressible		 (a) Optional filtering of opening signal introduced to model - the delay time of the opening/closing drive. In this case, an optional - leakageOpening can be defined to model leakage flow and/or to - improve the numerics in certain situations. - (b) Improved regularization of the valve characteristics in some cases - so that it is twice differentiable (smooth=2), - instead of continuous (smooth=0).
Modelica.Fluid.Sources.
FixedBoundary
- Boundary_pT
- Boundary_ph		 Changed the implementation so that no non-linear algebraic - equation system occurs, if the given variables (e.g. p,T,X) do - not correspond to the medium states (e.g. p,h,X). This is - achieved by using appropriate \"setState_xxx\" calls to compute the - medium state from the given variables. If a nonlinear equation - system occurs, it is solved by a specialized handler inside the - setState_xxx(..) function, but in the model this equation system is - not visible.
Modelica.Media.Interfaces.
PartialMedium The min/max values of types SpecificEnthalpy, SpecificEntropy, - SpecificHeatCapacity increased, due to reported user problems.
- New constant C_nominal introduced to provide nominal values for - trace substances (utilized in Modelica.Fluid to avoid numerical problems; - this fixes ticket - #393).
Modelica.Thermal.
HeatTransfer.* All icons are unified according to the - Modelica.Blocks library:
- \"%name\": width: -150 .. 150, height: 40, color: blue
- other text: height: 30, color: black -
Modelica.Math.Matrices
QR A Boolean input \"pivoting\" has been added (now QR(A, pivoting)) to provide QR-decomposition without pivoting (QR(A, false)). Default is pivoting=true.
- -


-The following critical errors have been fixed (i.e., errors -that can lead to wrong simulation results): -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Modelica.Electrical.Digital.Delay.
InertialDelaySensitive In order to decide whether the rising delay (tLH) or - the falling delay (tHL) is used, the \"previous\" value of the - output y has to be used and not the \"previous\" value of the - input x (delayType = delayTable[y_old, x] and not - delayType = delayTable[x_old, x]). This has been corrected.
Modelica.Mechanics.MultiBody.Parts.
BodyBox
- BodyCylinder 		Fixes ticket - #373: - The \"Center of Mass\" was calculated as normalize(r)*length/2. This is - only correct if the box/cylinder is attached between frame_a and frame_b. - If this is not the case, the calculation is wrong. - The has been fixed by using the correct formula:
- r_shape + normalize(lengthDirection)*length/2
BodyShape
- BodyBox
- BodyCylinder 		Fixes ticket - #300: - If parameter enforceStates=true, an error occurred. - This has been fixed.
Modelica.Mechanics.Rotational.Components.
LossyGear In cases where the driving flange is not obvious, the component could - lead to a non-convergent event iteration. This has been fixed - (a detailed description is provided in ticket - #108 - and in the - attachment - of this ticket).
Gearbox If useSupport=false, the support flange of the internal LossyGear - model was connected to the (disabled) support connector. As a result, the - LossyGear was \"free floating\". This has been corrected.
Modelica.Fluid.Pipes.
DynamicPipe Bug fix for dynamic mass, energy and momentum balances - for pipes with nParallel>1.
Modelica.Fluid.Pipes.BaseClasses.HeatTransfer.
PartialPipeFlowHeatTransfer Calculation of Reynolds numbers for the heat transfer through - walls corrected, if nParallel>1. - This partial model is used by LocalPipeFlowHeatTransfer - for laminar and turbulent forced convection in pipes.
Modelica.Media.Interfaces.PartialLinearFluid
setState_psX Sign error fixed.
Modelica.Media.CompressibleLiquids.
LinearColdWater Fixed wrong values for thermal conductivity and viscosity.
- -


-The following uncritical errors have been fixed (i.e., errors -that do not lead to wrong simulation results, but, e.g., -units are wrong or errors in documentation): -

- - - - -
Modelica.Math.Matrices.LAPACK
dgesv_vec
- dgesv
- dgetrs
- dgetrf
- dgetrs_vec
- dgetri
- dgeqpf
- dorgqr
- dgesvx
- dtrsyl		 Integer inputs to specify leading dimensions of matrices have got a lower bound 1 (e.g., lda=max(1,n)) - to avoid incorrect values (e.g., lda=0) in the case of empty matrices.
- The Integer variable \"info\" to indicate the successful call of a LAPACK routine has been converted to an output where it had been a protected variable.
- -


-The following trac tickets have been fixed: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Modelica
- #155Wrong usage of \"fillColor\" and \"fillPattern\" annotations for lines
- #211Undefined function realString used in MSL
- #216Make MSL version 3.2 more Modelica 3.1 conform
- #218Replace `Modelica://`-URIs by `modelica://`-URIs
- #271Documentation URI errors in MSL 3.1
- #292Remove empty \"\" annotations\"
- #294Typo 'w.r.t' --> 'w.r.t.'
- #296Unify disclaimer message and improve bad style \"here\" links
- #333Fix real number formats of the form `.[0-9]+`
- #347invalid URI in MSL 3.2
- #355Non-standard annotations

Modelica.Blocks
- #227Enhance unit deduction functionality by adding 'unit=\"1\"' to some blocks\"
- #349Incorrect annotation in Blocks/Continuous.mo
- #374Parameter with no value at all in Modelica.Blocks.Continuous.TransferFunction

Modelica.Constants
- #356Add Euler-Mascheroni constant to Modelica.Constants

Modelica.Electrical.Analog
- #346Multiple text in Modelica.Electrical.Analog.Basic.Conductor
- #363Mixture of Real and Integer in index expressions in Modelica.Electrical.Analog.Lines
- #384Incomplete annotations in some examples
- #396Bug in Modelica.Electrical.Analog.Ideal.ControlledIdealIntermediateSwitch

Modelica.Machines
- #276Improve/fix documentation of Modelica.Electrical.Machines
- #288Describe thermal concept of machines
- #301Documentation of Electrical.Machines.Examples needs update
- #306Merge content of `Modelica.Electrical.Machines.Icons` into `Modelica.Icons`
- #362Incomplete example model for DC machines
- #375Strangeness with final parameters with no value but a start value

Modelica.Electrical.Polyphase
- #173m-phase mutual inductor
- #200adjust Polyphase to Analog
- #277Improve/fix documentation of Modelica.Electrical.Polyphase
- #352Odd annotation in Modelica.Electrical.Polyphase.Sources.SignalVoltage

Modelica.Fluid
- #215Bug in Modelica.Fluid.Pipes.DynamicPipe
- #219Fluid.Examples.HeatExchanger: Heat transfer is switched off and cannot be enabled

Modelica.Math
- #348Small error in documentation
- #371Modelica.Math functions declared as \"C\" not \"builtin\"\"

Modelica.Mechanics.MultiBody
- #50Error in LineForce handling of potential root
- #71Make MultiBody.World replaceable
- #1813d surface visualisation
- #210Description of internal gear wheel missing
- #242Missing each qualifier for modifiers in MultiBody.
- #251Using enforceStates=true for BodyShape causes errors
- #255Error in Revolute's handling of non-normalized axis of rotations
- #268Non-standard annotation in MultiBody,Examples.Systems.RobotR3
- #269What is the purpose of MultiBody.Examples.Systems.RobotR3.Components.InternalConnectors?
- #272Function World.gravityAcceleration should not be protected
- #274Convenient and mighty initialization of frame kinematics
- #286Typo in Multibody/Frames.mo
- #300enforceStates parameter managed incorrectly in BodyShape, BodyBox, BodyCylinder
- #320Replace non-standard annotation by `showStartAttribute`
- #373Error in Modelica Mechanics
- #389Shape.rxvisobj wrongly referenced in Arrow/DoubleArrow

Modelica.Mechanics.Rotational
- #108Problem with model \"Lossy Gear\" and approach to a solution
- #278Improve/fix documentation of Modelica.Mechanics.Rotational
- #381Bug in Modelica.Mechanics.Rotational.Gearbox

Modelica.Mechanics.Translational
- #279Improve/fix documentation of Modelica.Mechanics.Translational
- #310Erroneous image links in `Modelica.Mechanics.Translational`

Modelica.Media
- #72PartialMedium functions not provided for all media in Modelica.Media
- #217Missing image file Air.png
- #224dpT calculation in waterBaseProp_dT
- #393Provide C_nominal in Modelica.Media to allow propagating - value and avoid wrong numerical results

Modelica.StateGraph
- #206Syntax error in StateGraph.mo
- #261Modelica.StateGraph should mention the availability of Modelica_StateGraph2
- #354Bad annotation in Modelica.StateGraph.Temporary.NumericValue

Modelica.Thermal.FluidHeatFlow
- #280Improve/fix documentation of Modelica.Thermal.FluidHeatFlow

Modelica.Thermal.HeatTransfer
- #281Improve/fix documentation of Modelica.Thermal.HeatTransfer

Modelica.UsersGuide
- #198Name of components in MSL not according to naming conventions
- #204Minor correction to User's Guide's section on version management
- #244Update the contacts section of the User's Guide
- #267MSL-Documentation: Shouldn't equations be numbered on the right hand side?
- #299SVN keyword expansion messed up the User's guide section on version management

Modelica.Utilities
- #249Documentation error in ModelicaUtilities.h

ModelicaServices
- #248No uses statement on ModelicaServices in MSL 3.1
- -

-Note: -

- -")); -end Version_3_2; - -class Version_3_1 "Version 3.1 (August 14, 2009)" - extends Modelica.Icons.ReleaseNotes; - - annotation (Documentation(info=" - -

-Version 3.1 is backward compatible to version 3.0 and 3.0.1, -i.e., models developed with version 3.0 or 3.0.1 will work without any -changes also with version 3.1. -

- -

-Version 3.1 is slightly based on the Modelica Specification 3.1. It uses -the following new language elements (compared to Modelica Specification 3.0): -

- - - -

-The following new libraries have been added: -

- - - - - - - - - -
Modelica.Fluid - Components to model 1-dim. thermo-fluid flow in networks of vessels, pipes, - fluid machines, valves and fittings. All media from the - Modelica.Media library can be used (so incompressible or compressible, - single or multiple substance, one or two phase medium). - The library is using the stream-concept from Modelica Specification 3.1. -
Modelica.Magnetic.FluxTubes - Components to model magnetic devices based on the magnetic flux tubes concepts. - Especially to model - electromagnetic actuators. Nonlinear shape, force, leakage, and - Material models. Material data for steel, electric sheet, pure iron, - Cobalt iron, Nickel iron, NdFeB, Sm2Co17, and more. -
ModelicaServices - New top level package that shall contain functions and models to be used in the - Modelica Standard Library that requires a tool specific implementation. - ModelicaServices is then used in the Modelica package. - In this first version, the 3-dim. animation with model Modelica.Mechanics.MultiBody.Visualizers.Advanced.Shape - was moved to ModelicaServices. Tool vendors can now provide their own implementation - of the animation. -
- -


-The following new components have been added -to existing libraries: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Modelica.
versionBuild
versionDate
dateModified
revisionId 		New annotations from Modelica 3.1 for version handling added.
Modelica.UsersGuide.ReleaseNotes.
VersionManagement Copied from info layer of previous ReleaseNotes (to make it more - visible) and adapted it to the new possibilities in - Modelica Specification 3.1.
Modelica.Blocks.Math.
RectangularToPolar
- PolarToRectangular 		New blocks to convert between rectangular and polar form - of space phasors.
Modelica.Blocks.Routing.
Replicator New block to replicate an input signal to many output signals.
Modelica.Electrical.Analog.Examples.
AmplifierWithOpAmpDetailed
- HeatingResistor
- CompareTransformers
- OvervoltageProtection
- ControlledSwitchWithArc
- SwitchWithArc
- ThyristorBehaviourTest		 New examples to demonstrate the usage of new components.
Modelica.Electrical.Analog.Basic.
OpAmpDetailed
- TranslationalEMF
- M_Transformer		 New detailed model of an operational amplifier.
- New electromotoric force from electrical energy into mechanical translational energy.
- Generic transformer with choosable number of inductors
Modelica.Electrical.Analog.Ideal.
OpenerWithArc
- CloserWithArc
- ControlledOpenerWithArc
- ControlledCloserWithArc		 New switches with simple arc model.
Modelica.Electrical.Analog.Interfaces.
ConditionalHeatPort New partial model to add a conditional HeatPort to - an electrical component.
Modelica.Electrical.Analog.Lines.
M_Oline New multiple line model, both the number of lines and the number of segments choosable.
Modelica.Electrical.Analog.Semiconductors.
ZDiode
Thyristor		 Zener Diode with 3 working areas and simple thyristor model.
Modelica.Electrical.Polyphase.Ideal.
OpenerWithArc
CloserWithArc		 New switches with simple arc model (as in Modelica.Electrical.Analog.Ideal.
Modelica.Mechanics.MultiBody.Examples.Elementary.
RollingWheel
- RollingWheelSetDriving
- RollingWheelSetPulling		 New examples to demonstrate the usage of new components.
Modelica.Mechanics.MultiBody.Joints.
RollingWheel
- RollingWheelSet		 New joints (no mass, no inertia) that describe an - ideal rolling wheel and a ideal rolling wheel set consisting - of two wheels rolling on the plane z=0.
Modelica.Mechanics.MultiBody.Parts.
RollingWheel
- RollingWheelSet		 New ideal rolling wheel and ideal rolling wheel set consisting - of two wheels rolling on the plane z=0.
Modelica.Mechanics.MultiBody.Visualizers.
Ground New model to visualize the ground (box at z=0).
Modelica.Mechanics.Rotational.Interfaces.
PartialElementaryOneFlangeAndSupport2
- PartialElementaryTwoFlangesAndSupport2		 New partial model with one and two flanges and the support flange - with a much simpler implementation as previously.
Modelica.Mechanics.Translational.Interfaces.
PartialElementaryOneFlangeAndSupport2
- PartialElementaryTwoFlangesAndSupport2		 New partial model with one and two flanges and the support flange - with a much simpler implementation as previously.
Modelica.Media.IdealGases.Common.MixtureGasNasa.
setSmoothState Return thermodynamic state so that it smoothly approximates: - if x > 0 then state_a else state_b.
Modelica.Utilities.Internal.
PartialModelicaServices New package containing the interface description of - models and functions that require a tool dependent - implementation (currently only \"Shape\" for 3-dim. animation, - but will be extended in the future)
Modelica.Thermal.HeatTransfer.Components.
ThermalCollector New auxiliary model to collect the heat flows - from m heatports to a single heatport; - useful for polyphase resistors (with heatports) - as a junction of the m heatports.
Modelica.Icons.
VariantLibrary
- BaseClassLibrary
- ObsoleteModel		 New icons (VariantLibrary and BaseClassLibrary have been moved - from Modelica_Fluid.Icons to this place).
Modelica.SIunits.
ElectricalForceConstant New type added (#190).
Modelica.SIunits.Conversions.
from_Hz
- to_Hz		 New functions to convert between frequency [Hz] and - angular velocity [1/s]. (#156)
- -


-The following existing components -have been improved in a -backward compatible way: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Modelica.
Blocks
Mechanics
StateGraph 		Provided missing parameter values for examples - (these parameters had only start values)
Modelica.Electrical.Analog.Basic
Resistor, Conductor, VariableResistor, VariableConductor Conditional heatport added for coupling to thermal network.
Modelica.Electrical.Analog.Ideal
Thyristors, Switches, IdealDiode Conditional heatport added for coupling to thermal network.
Modelica.Electrical.Analog.Semiconductors
Diode, ZDiode, PMOS, NMOS, NPN, PNP Conditional heatport added for coupling to thermal network.
Modelica.Electrical.Polyphase.Basic
Resistor, Conductor, VariableResistor, VariableConductor Conditional heatport added for coupling to thermal network (as in Modelica.Electrical.Analog).
Modelica.Electrical.Polyphase.Ideal
Thyristors, Switches, IdealDiode Conditional heatport added for coupling to thermal network (as in Modelica.Electrical.Analog).
Modelica.Mechanics.MultiBody.Visualizers.Advanced.
Shape New implementation by inheriting from ModelicaServices. This allows a - tool vendor to provide its own implementation of Shape.
Modelica.StateGraph.
Examples Introduced \"StateGraphRoot\" on the top level of all example models.
Modelica.StateGraph.Interfaces.
StateGraphRoot
PartialCompositeStep
CompositeStepState 		Replaced the wrong Modelica code \"flow output Real xxx\" - by \"Real dummy; flow Real xxx;\". - As a side effect, several \"blocks\" had to be changed to \"models\".
PartialStep Changed model by packing the protected outer connector in to a model. - Otherwise, there might be differences in the sign of the flow variable - in Modelica 3.0 and 3.1.
Modelica.Utilities.Examples.
expression Changed local variable \"operator\" to \"opString\" since \"operator\" - is a reserved keyword in Modelica 3.1
- -


-The following uncritical errors have been fixed (i.e., errors -that do not lead to wrong simulation results, but, e.g., -units are wrong or errors in documentation): -

- - - - - - - - - - - - - - - -
Modelica.
Many models Removed wrong usages of annotations fillColor and fillPattern - in text annotations (#155, #185).
Modelica.Electrical.Machines
All machine models The conditional heatports of the instantiated resistors - (which are new in Modelica.Electrical.Analog and Modelica.Electrical.Polyphase) - are finally switched off until a thermal connector design for machines is implemented.
Modelica.Media.Air.MoistAir
saturationPressureLiquid
- sublimationPressureIce
- saturationPressure		 For these three functions, an error in the derivative annotation was corrected. However, the effect of - this bug was minor, as a Modelica tool was allowed to compute derivatives automatically via - the smoothOrder annotation.
Modelica.Math.Matrices.
eigenValues Wrong documentation corrected (#162)
- -")); -end Version_3_1; - -class Version_3_0_1 "Version 3.0.1 (Jan. 27, 2009)" - extends Modelica.Icons.ReleaseNotes; - - annotation (Documentation(info=" - -

-This Modelica package is provided under the Modelica License 2 -and no longer under Modelica License 1.1. There are the following reasons -why the Modelica Association changes from Modelica License 1.1 to this -new license text (note, the text below is not a legal interpretation of the -Modelica License 2. In case of a conflict, the language of the license shall prevail): -

- -
    -
  1. The rights of licensor and licensee are much more clearly defined. For example: - - We hope that this compromise between open source contributors, commercial - Modelica environments and Modelica users will motivate even more people to - provide their Modelica packages freely under the Modelica License 2.

    2. -
  2. There are several new provisions that shall make law suites against licensors and licensees more unlikely (so the small risk is further reduced).
    3. -
- -


-The following new components have been added -to existing libraries: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Electrical.Analog.Basic.
M_Transformer Transformer, with the possibility to - choose the number of inductors. The inductances and the coupled inductances - can be chosen arbitrarily.
Electrical.Analog.Lines.
M_OLine Segmented line model that enables the use of - multiple lines, that means, the number of segments and the number of - single lines can be chosen by the user. The model allows to investigate - phenomena at multiple lines like mutual magnetic or capacitive influence.
Mechanics.Translational.Components.Examples.
Brake Demonstrates the usage of the translational brake component.
Media.Interfaces.PartialMedium.
ThermoStates Enumeration type for independent variables to identify the independent - variables of the medium (pT, ph, phX, pTX, dTX).
- An implementation of this enumeration is provided for every medium. - (This is useful for fluid libraries that do not use the - PartialMedium.BaseProperties model).
setSmoothState Function that returns the thermodynamic state which smoothly approximates: - if x > 0 then state_a else state_b.
- (This is useful for pressure drop components in fluid libraries - where the upstream density and/or viscosity has to be computed - and these properties should be smooth a zero mass flow rate)
- An implementation of this function is provided for every medium.
Media.Common.
smoothStep Approximation of a general step, such that the characteristic - is continuous and differentiable.
Media.UsersGuide.
Future Short description of goals and changes of upcoming release of Modelica.Media.
Media.Media.Air.MoistAir.
isentropicExponent Implemented Missing Function from interface.
isentropicEnthalpyApproximation Implemented function that approximates the isentropic enthalpy change. -This is only correct as long as there is no liquid in the stream.
- -


-The following existing components -have been changed (in a -backward compatible way): -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Mechanics.Rotational.Interfaces.
PartialFriction Improvement of friction model so that in certain situations - the number of iterations is much smaller.
Mechanics.Translational.Components.Examples.
Friction Added a third variant, where friction is modelled with - the SupportFriction component.
Mechanics.Translational.Components.
MassWithStopAndFriction Improvement of friction model so that in certain situations - the number of iterations is much smaller.
Mechanics.Translational.Interfaces.
PartialFriction Improvement of friction model so that in certain situations - the number of iterations is much smaller.
Media.Examples.
SimpleLiquidWater
- IdealGasH20
- WaterIF97
- MixtureGases
- MoistAir 		Added equations to test the new setSmoothState(..) functions - including the analytic derivatives of these functions.
Media.Interfaces.PartialLinearFluid.
setState_pTX
- setState_phX
- setState_psX
- setState_dTX 		Rewritten function in one statement so that it is usually inlined.
Media.Interfaces.PartialLinearFluid.
consistent use of reference_d instead of density(state Change was done to achieve consistency with analytic inverse functions.
Media.Air.MoistAir.
T_phX Interval of nonlinear solver to compute T from p,h,X changed - from 200..6000 to 240 ..400 K.
- -


-The following critical errors have been fixed (i.e., errors -that can lead to wrong simulation results): -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Mechanics.MultiBody.Forces
WorldTorque Parameter \"ResolveInFrame\" was not propagated and therefore - always the default (resolved in world frame) was used, independently - of the setting of this parameter.
WorldForceAndTorque Parameter \"ResolveInFrame\" was not propagated and therefore - always the default (resolved in world frame) was used, independently - of the setting of this parameter.
- Furthermore, internally WorldTorque was used instead of - Internal.BasicWorldTorque and therefore the visualization of - worldTorque was performed twice.
Mechanics.MultiBody.Sensors
AbsoluteSensor Velocity, acceleration and angular acceleration were computed - by differentiating in the resolveInFrame frame. This has been corrected, by - first transforming the vectors in to the world frame, differentiating here - and then transforming into resolveInFrame. The parameter in the Advanced menu - resolveInFrameAfterDifferentiation is then superfluous and was removed .
AbsoluteVelocity The velocity was computed - by differentiating in the resolveInFrame frame. This has been corrected, by - first transforming the velocity in to the world frame, differentiating here - and then transforming into resolveInFrame
RelativeSensor If resolveInFrame <> frame_resolve and - resolveInFrameAfterDifferentiation = frame_resolve, a translation - error occurred, since frame_resolve was not enabled in this situation. - This has been corrected.
RelativeVelocity The velocity has have been computed - by differentiating in the resolveInFrame frame. This has been corrected, by - first transforming the relative position in to frame_a, differentiating here - and then transforming into resolveInFrame
TransformRelativeVector The transformation was wrong, since the parameters frame_r_in and frame_r_out - have not been propagated to the submodel that performs the transformation. - This has been corrected.
Mechanics.Translational.Components.
SupportFriction
- Brake 		The sign of the friction force was wrong and therefore friction accelerated - instead of decelerated. This was fixed.
SupportFriction The component was only correct for fixed support. - This was corrected.
Media.Interfaces.
PartialSimpleMedium
- PartialSimpleIdealGasMedium 		BaseProperties.p was not defined as preferred state and BaseProperties.T was - always defined as preferred state. This has been fixed by - Defining p,T as preferred state if parameter preferredMediumState = true. - This error had the effect that mass m is selected as state instead of p - and if default initialization is used then m=0 could give not the expected - behavior. This means, simulation is not wrong but the numerics is not as good - and if a model relies on default initial values, the result could be not - as expected.
- -


-The following uncritical errors have been fixed (i.e., errors -that do not lead to wrong simulation results, but, e.g., -units are wrong or errors in documentation): -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Blocks.Math.
InverseBlockConstraint Changed annotation preserveAspectRatio from true to false.
Blocks.Sources.
RealExpression
- IntegerExpression
- BooleanExpression 		Changed annotation preserveAspectRatio from true to false.
Electrical.Analog.Basic.
SaturatingInductor Replaced non-standard \"arctan\" by \"atan\" function.
Modelica.Electrical.Digital.
UsersGuide Removed empty documentation placeholders and added the missing - release comment for version 1.0.7
Modelica.Mechanics.Translational.Components.
MassWithStopAndFriction Changed usage of reinit(..), in order that it appears - only once for one variable according to the language specification - (if a tool could simulate the model, there is no difference).
Media.Interfaces.PartialSimpleMedium
pressure
- temperature
- density
- specificEnthalpy 		Missing functions added.
- -")); -end Version_3_0_1; - -class Version_3_0 "Version 3.0 (March 1, 2008)" - extends Modelica.Icons.ReleaseNotes; - - annotation (Documentation(info=" -

-Version 3.0 is not backward compatible to previous versions. -A conversion script is provided to transform models and libraries -of previous versions to the new version. Therefore, conversion -should be automatic. -

- -

-The following changes are present for the whole library: -

- - - -


-The following new components have been added -to existing libraries (note, the names in parentheses -are the new sublibrary names that are introduced in version 3.0): -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Blocks.Examples.
InverseModel Demonstrates the construction of an inverse model.
Blocks.Math.
InverseBlockConstraints Construct inverse model by requiring that two inputs - and two outputs are identical (replaces the previously, - unbalanced, TwoInputs and TwoOutputs blocks).
Electrical.Machines.Utilities
TransformerData A record that calculates required impedances (parameters) from nominal data of transformers.
Mechanics.MultiBody.Examples.Rotational3DEffects
GyroscopicEffects
- ActuatedDrive
- MovingActuatedDrive
- GearConstraint 		New examples to demonstrate the usage of the Rotational library - in combination with multi-body components.
Mechanics.MultiBody.Sensors
AbsolutePosition
- AbsoluteVelocity
- AbsoluteAngles
- AbsoluteAngularVelocity
- RelativePosition
- RelativeVelocity
- RelativeAngles
- RelativeAngularVelocity		 New sensors to measure one vector.
TransformAbsoluteVector
- TransformRelativeVector		 Transform absolute and/or relative vector into another frame.
Mechanics.Rotational.(Components)
Disc Right flange is rotated by a fixed angle with respect to left flange
IdealRollingWheel Simple 1-dim. model of an ideal rolling wheel without inertia
Mechanics.Translational.Sensors
RelPositionSensor
RelSpeedSensor
RelAccSensor
PowerSensor		 Relative position sensor, i.e., distance between two flanges
- Relative speed sensor
- Relative acceleration sensor
- Ideal power sensor
Mechanics.Translational(.Components)
SupportFriction
Brake
InitializeFlange		 Model of friction due to support
- Model of a brake, base on Coulomb friction
- Initializes a flange with pre-defined position, speed and acceleration .
Mechanics.Translational(.Sources)
Force2
LinearSpeedDependentForce
QuadraticSpeedDependentForce
- ConstantForce
ConstantSpeed
ForceStep		 Force acting on 2 flanges
- Force linearly dependent on flange speed
- Force quadratic dependent on flange speed
- Constant force source
- Constant speed source
- Force step
- -


-The following existing components -have been changed in a -non-backward compatible way -(the conversion script transforms models and libraries -of previous versions to the new version. Therefore, conversion -should be automatic): -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Blocks.Continuous.
CriticalDamping New parameter \"normalized\" to define whether filter is provided - in normalized or non-normalized form. Default is \"normalized = true\". - The previous implementation was a non-normalized filter. - The conversion script automatically introduces the modifier - \"normalized=false\" for existing models.
Blocks.Interfaces.
RealInput
- RealOutput		 Removed \"SignalType\", since extending from a replaceable class - and this is not allowed in Modelica 3.
The conversion script - removes modifiers to SignalType.
RealSignal
- IntegerSignal
- BooleanSignal		 Moved to library ObsoleteModelica3, since these connectors - are no longer allowed in Modelica 3
- (prefixes input and/or output are required).
Blocks.Interfaces.Adaptors.
AdaptorReal
- AdaptorBoolean
- AdaptorInteger		 Moved to library ObsoleteModelica3, since the models are not \"balanced\". - These are completely obsolete adaptors
between the Real, Boolean, Integer - signal connectors of version 1.6 and version ≥ 2.1 of the Modelica - Standard Library.
Blocks.Math.
ConvertAllUnits Moved to library ObsoleteModelica3, since extending from a replaceable class - and this is not allowed in Modelica 3.
It would be possible to rewrite this - model to use a replaceable component. However, the information about the - conversion
cannot be visualized in the icon in this case.
Blocks.Math.UnitConversions.
TwoInputs
- TwoOutputs		 Moved to library ObsoleteModelica3, since the models are not \"balanced\". - A new component
\"InverseBlockConstraints\" - is provided instead that has the same feature, but is \"balanced\".
Electrical.Analog.Basic.
HeatingResistor The heatPort has to be connected; otherwise the component Resistor (without heatPort) has to be used.
- cardinality() is only used to check whether the heatPort is connected.
Electrical.Polyphase.Examples.
Changed the instance names of components used in the examples to more up-to-date style.
Electrical.Machines.
Moved package Machines.Examples.Utilities to Machines.Utilities
Removed all nonSIunits; especially in DCMachines
- parameter NonSIunits.AngularVelocity_rpm rpmNominal was replaced by
- parameter SIunits.AngularVelocity wNominal
Changed the following component variable and parameter names to be more concise:
- Removed suffix \"DamperCage\" from all synchronous machines - since the user can choose whether the damper cage is present or not.
- RotorAngle ... RotorDisplacementAngle
- J_Rotor ... Jr
- Rr ........ Rrd (damper of synchronous machines)
- Lrsigma ... Lrsigmad (damper of synchronous machines)
- phi_mechanical ... phiMechanical
- w_mechanical ..... wMechanical
- rpm_mechanical ... rpmMechanical
- tau_electrical ... tauElectrical
- tau_shaft ........ tauShaft
- TurnsRatio ....... turnsRatio (AIMS)
- VsNom ............ VsNominal (AIMS)
- Vr_Lr ............ VrLockedRotor (AIMS)
- DamperCage ....... useDamperCage (synchronous machines)
- V0 ............... VsOpenCicuit (SMPM)
- Ie0 .............. IeOpenCicuit (SMEE) -
Interfaces. Moved as much code as possible from specific machine models to partials to reduce redundant code.
Interfaces.Adapter Removed to avoid cardinality; instead, the following solution has been implemented:
Sensors.RotorDisplacementAngle
Interfaces.PartialBasicMachine		 Introduced parameter Boolean useSupport=false \"enable / disable (=fixed stator) support\"
- The rotational support connector is only present with useSupport = true;
- otherwise the stator is fixed internally.
Electrical.Machines.Examples.
Changed the names of the examples to more meaningful names.
- Changed the instance names of components used in the examples to more up-to-date style.
SMEE_Generator Initialization of smee.phiMechanical with fixed=true
Mechanics.MultiBody.
World Changed default value of parameter driveTrainMechanics3D from false to true.
- 3-dim. effects in Rotor1D, Mounting1D and BevelGear1D are therefore taken
- into account by default (previously this was only the case, if - world.driveTrainMechanics3D was explicitly set).
Mechanics.MultiBody.Forces.
FrameForce
- FrameTorque
- FrameForceAndTorque		 Models removed, since functionality now available via Force, Torque, ForceAndTorque
WorldForce
- WorldTorque
- WorldForceAndTorque
- Force
- Torque
- ForceAndTorque		 Connector frame_resolve is optionally enabled via parameter resolveInFrame
. - Forces and torques and be resolved in all meaningful frames defined - by enumeration resolveInFrame.
Mechanics.MultiBody.Frames.
length
- normalize		 Removed functions, since available also in Modelica.Math.Vectors -
The conversion script changes the references correspondingly.
Mechanics.MultiBody.Joints.
Prismatic
- ActuatedPrismatic
- Revolute
- ActuatedRevolute
- Cylindrical
- Universal
- Planar
- Spherical
- FreeMotion		 Changed initialization, by replacing initial value parameters with - start/fixed attributes.
- When start/fixed attributes are properly supported - in the parameter menu by a Modelica tool,
- the initialization is considerably simplified for the - user and the implementation is much simpler.
- Replaced parameter \"enforceStates\" by the more general - built-in enumeration stateSelect=StateSelection.xxx.
- The conversion script automatically - transforms from the \"old\" to the \"new\" forms.
Revolute
- ActuatedRevolute		 Parameter \"planarCutJoint\" in the \"Advanced\" menu of \"Revolute\" and of - \"ActuatedRevolute\" removed.
- A new joint \"RevolutePlanarLoopConstraint\" introduced that defines the constraints - of a revolute joint
as cut-joint in a planar loop. - This change was needed in order that the revolute joint can be - properly used
in advanced model checking.
- ActuatedRevolute joint removed. Flange connectors of Revolute joint
- can be enabled with parameter useAxisFlange.
Prismatic
- ActuatedPrismatic		 ActuatedPrismatic joint removed. Flange connectors of Prismatic joint
- can be enabled with parameter useAxisFlange.
Assemblies Assembly joint implementation slightly changed, so that - annotation \"structurallyIncomplete\"
could be removed - (all Assembly joint models are now \"balanced\").
Mechanics.MultiBody.Joints.Internal
RevoluteWithLengthConstraint
- PrismaticWithLengthConstraint		 These joints should not be used by a user of the MultiBody library. - They are only provided to built-up the - MultiBody.Joints.Assemblies.JointXYZ joints. - These two joints have been changed in a slightly not backward compatible - way, in order that the usage in the Assemblies.JointXYZ joints results in - balanced models (no conversion is provided for this change since the - user should not have used these joints and the conversion would be too - complicated): - In releases before version 3.0 of the Modelica Standard Library, - it was possible to activate the torque/force projection equation - (= cut-torque/-force projected to the rotation/translation - axis must be identical to - the drive torque/force of flange axis) via parameter axisTorqueBalance. - This is no longer possible, since otherwise this model would not be - \"balanced\" (= same number of unknowns as equations). Instead, when - using this model in version 3.0 and later versions, the torque/force - projection equation must be provided in the Advanced menu of joints - Joints.SphericalSpherical and Joints.UniversalSpherical - via the new parameter \"constraintResidue\".
Mechanics.MultiBody.Parts.
BodyBox
- BodyCylinder		 Changed unit of parameter density from g/cm3 to the SI unit kg/m3 - in order to allow stricter unit checking.
The conversion script multiplies - previous density values with 1000.
Body
- BodyShape
- BodyBox
- BodyCylinder
- PointMass - Rotor1D		 Changed initialization, by replacing initial value parameters with - start/fixed attributes.
- When start/fixed attributes are properly supported - in the parameter menu by a Modelica tool,
- the initialization is considerably simplified for the - user and the implementation is much simpler.
The conversion script automatically - transforms from the \"old\" to the \"new\" form of initialization.
Mechanics.MultiBody.Sensors.
AbsoluteSensor
- RelativeSensor
- CutForceAndTorque		 New design of sensor components: Via Boolean parameters
- signal connectors for the respective vectors are enabled/disabled.
- It is not possible to automatically convert models to this new design.
- Instead, references in existing models are changed to ObsoleteModelice3.
- This means that these models must be manually adapted.
CutForce
- CutTorque		 Slightly new design. The force and/or torque component can be - resolved in world, frame_a, or frame_resolved.
- Existing models are automatically converted.
Mechanics.Rotational.
Moved components to structured sub-packages (Sources, Components)
Inertia
- SpringDamper
- RelativeStates		 Changed initialization, by replacing initial value parameters with - start/fixed attributes.
- When start/fixed attributes are properly supported - in the parameter menu by a Modelica tool,
- the initialization is considerably simplified for the - user and the implementation is much simpler.
- Parameter \"stateSelection\" in \"Inertia\" and \"SpringDamper\" replaced - by the built-in enumeration
stateSelect=StateSelection.xxx. - Introduced the \"stateSelect\" enumeration in \"RelativeStates\".
- The conversion script automatically - transforms from the \"old\" to the \"new\" forms.
LossyGear
- GearBox		 Renamed gear ratio parameter \"i\" to \"ratio\", in order to have a - consistent naming convention.
- Existing models are automatically converted.
SpringDamper
- ElastoBacklash
- Clutch
- OneWayClutch		 Relative quantities (phi_rel, w_rel) are used as states, if possible - (due to StateSelect.prefer).
- In most cases, relative states in drive trains are better suited as - absolute states.
This change might give changes in the selected states - of existing models.
- This might give rise to problems if, e.g., the initialization was not - completely defined in a user model,
since the default - initialization heuristic may give different initial values.
Mechanics.Translational.
Moved components to structured sub-packages (Sources, Components)
Adaptions corresponding to Rotational
Stop Renamed to Components.MassWithStopAndFriction to be more concise.
- MassWithStopAndFriction is not available with a support connector,
- since the reaction force can't be modeled in a meaningful way due to reinit of velocity v.
- Until a sound implementation of a hard stop is available, the old model may be used.
Media.
constant nX
- constant nXi
- constant reference_X
- BaseProperties		 The package constant nX = nS, now always, even for single species media. This also allows to define mixtures with only 1 element. The package constant nXi=if fixedX then 0 else if reducedX or nS==1 then nS - 1 else nS. This required that all BaseProperties for single species media get an additional equation to define the composition X as {1.0} (or reference_X, which is {1.0} for single species). This will also mean that all user defined single species media need to be updated by that equation.
SIunits.
CelsiusTemperature Removed, since no SI unit. The conversion script changes references to - SIunits.Conversions.NonSIunits.Temperature_degC
ThermodynamicTemperature
- TemperatureDifference		 Added annotation \"absoluteValue=true/false\" - in order that unit checking is possible
- (the unit checker needs to know for a unit that has an offset, - whether it is used as absolute or as a relative number)
SIunits.Conversions.NonSIunits.
Temperature_degC
- Temperature_degF
- Temperature_degRk 		Added annotation \"absoluteValue=true\" - in order that unit checking is possible
- (the unit checker needs to know for a unit that has an offset, - whether it is used as absolute or as a relative number)
StateGraph.Examples.
ControlledTanks The connectors of the ControlledTanks did not fulfill the new - restrictions of Modelica 3. This has been fixed.
Utilities Replacing inflow, outflow by connectors inflow1, inflow2, - outflow1, outflow2 with appropriate input/output prefixes in - order to fulfill the restrictions of Modelica 3 to arrive - at balanced models. No conversion is provided, since - too difficult and since the non-backward compatible change is in - an example.
Thermal.FluidHeatFlow.Sensors.

- pSensor
TSensor
dpSensor
dTSensor
m_flowSensor
V_flowSensor
H_flowSensor		 renamed to:
- PressureSensor
TemperatureSensor
RelPressureSensor
RelTemperatureSensor
MassFlowSensor
VolumeFlowSensor
EnthalpyFlowSensor -
Thermal.FluidHeatFlow.Sources.
Ambient
PrescribedAmbient		 available as one combined component Ambient
- Boolean parameters usePressureInput and useTemperatureInput decide - whether pressure and/or temperature are constant or prescribed
ConstantVolumeFlow
PrescribedVolumeFlow		 available as one combined component VolumeFlow
- Boolean parameter useVolumeFlowInput decides - whether volume flow is constant or prescribed
ConstantPressureIncrease
PrescribedPressureIncrease		 available as one combined component PressureIncrease
- Boolean parameter usePressureIncreaseInput decides - whether pressure increase is constant or prescribed
Thermal.FluidHeatFlow.Examples.
Changed the instance names of components used in the examples to more up-to-date style.
Thermal.HeatTransfer.(Components)
HeatCapacitor Initialization changed: SteadyStateStart removed. Instead - start/fixed values for T and der_T
(initial temperature and its derivative).


HeatCapacitor
ThermalConductor
ThermalConvection
BodyRadiation

- TemperatureSensor
RelTemperatureSensor
HeatFlowSensor

- FixedTemperature
PrescribedTemperature
FixedHeatFlow
PrescribedHeatFlow		 Moved components to sub-packages:

- Components.HeatCapacitor
Components.ThermalConductor
Components.ThermalConvection
Components.BodyRadiation

- Sensors.TemperatureSensor
Sensors.RelTemperatureSensor
Sensors.HeatFlowSensor

- Sources.FixedTemperature
Sources.PrescribedTemperature
Sources.FixedHeatFlow
Sources.PrescribedHeatFlow -
Thermal.FluidHeatFlow.Examples.
Changed the instance names of components used in the examples to more up-to-date style.
- -


-The following existing components -have been improved in a -backward compatible way: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Modelica.* Parameter declarations, input and output function arguments without description - strings improved
by providing meaningful description texts. -
Modelica.Blocks.Continuous.
TransferFunction Internal scaling of the controller canonical states introduced - in order to enlarge the range of transfer functions where the default - relative tolerance of the simulator is sufficient.
Butterworth
CriticalDamping 		Documentation improved and plots of the filter characteristics added.
Electrical.Analog.Basic.
EMF New parameter \"useSupport\" to optionally enable a support connector.
Icons.
RectangularSensor
- RoundSensor		 Removed drawing from the diagram layer (kept drawing only in - icon layer),
in order that this icon can be used in situations - where components are dragged in the diagram layer.
Math.Vectors.
normalize Implementation changed, so that the result is always continuous
- (previously, this was not the case for small vectors: normalize(eps,eps)). -
Mechanics.MultiBody.
Renamed non-standard keywords defineBranch, defineRoot, definePotentialRoot, - isRooted to the standard names:
- Connections.branch/.root/.potentialRoot/.isRooted.
Frames Added annotation \"Inline=true\" to all one-line functions - (which should be all inlined).
Mechanics.MultiBody.Parts.
Mounting1D
- Rotor1D
- BevelGear1D		 Changed implementation so that no longer modifiers for connector - variables are used,
because this violates the restrictions on - \"balanced models\" of Modelica 3.
Mechanics.Rotational.
InitializeFlange Changed implementation so that counting unknowns and - equations is possible without actual values of parameters.
Thermal.FluidHeatFlow.Interfaces.
TwoPort Introduced parameter Real tapT(final min=0, final max=1)=1
that defines the temperature of the heatPort - between inlet and outlet.
StateGraph.
InitialStep
- InitialStepWithSignal
- Step
- StepWithSignal		 Changed implementation so that no longer modifiers for output - variables are used,
because this violates the restrictions on - \"balanced models\" of Modelica 3.
- -


-The following critical errors have been fixed (i.e., errors -that can lead to wrong simulation results): -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Electrical.Analog.Examples.
CauerLowPassSC Wrong calculation of Capacitor1 both in Rn and Rp corrected - (C=clock/R instead of C=clock*R)
Mechanics.MultiBody.Parts.
Rotor1D The 3D reaction torque was not completely correct and gave in - some situations a wrong result. This bug should not influence the - movement of a multi-body system, but only the constraint torques - are sometimes not correct.
Mechanics.Rotational.
ElastoBacklash If the damping torque was too large, the reaction torque - could \"pull\" which is unphysical. The component was - newly written by limiting the damping torque in such a case - so that \"pulling\" torques can no longer occur. Furthermore, - during initialization the characteristics is made continuous - to reduce numerical errors. The relative angle and relative - angular velocities are used as states, if possible - (StateSelect.prefer), since relative quantities lead usually - to better behavior.
Position
Speed
Accelerate
Move		 The movement of the flange was wrongly defined as absolute; - this is corrected as relative to connector support.
- For Accelerate, it was necessary to rename - RealInput a to a_ref, as well as the start values - phi_start to phi.start and w_start to w.start. - The conversion script performs the necessary conversion of - existing models automatically.
Media.Interfaces.
PartialSimpleIdealGasMedium Inconsistency in reference temperature corrected. This may give - different results for functions:
- specificEnthalpy, specificInternalEnergy, specificGibbsEnergy, - specificHelmholtzEnergy.
Media.Air.
specificEntropy Small bug in entropy computation of ideal gas mixtures corrected.
Media.IdealGases.Common.MixtureGasNasa
specificEntropy Small bug in entropy computation of ideal gas mixtures corrected.
- -


-The following uncritical errors have been fixed (i.e., errors -that do not lead to wrong simulation results, but, e.g., -units are wrong or errors in documentation): -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Blocks.Tables.
CombiTable2D Documentation improved.
Electrica.Digital.Gates
AndGate
- NandGate
- OrGate
- NorGate
- XorGate
- XnorGate		 The number of inputs was not correctly propagated - to the included base model.
- This gave a translation error, if the number - of inputs was changed (and not the default used).
Electrica.Digital.Sources
Pulse Model differently implemented, so that - warning message about \"cannot properly initialize\" is gone.
Mechanics.Rotational.
BearingFriction
- Clutch
- OneWayClutch
- Brake
- Gear 		Declaration of table parameter changed from - table[:,:] to table[:,2].
Modelica.Mechanics.MultiBody.Examples.Loops.Utilities.
GasForce Unit of variable \"press\" corrected (from Pa to bar)
StateGraph.Examples.
SimpleFriction The internal parameter k is defined and calculated with the appropriate unit.
Thermal.FluidHeatFlow.Interfaces.
SimpleFriction The internal parameter k is defined and calculated with the appropriate unit.
- -")); -end Version_3_0; - -class Version_2_2_2 "Version 2.2.2 (Aug. 31, 2007)" - extends Modelica.Icons.ReleaseNotes; - - annotation (Documentation(info=" -

-Version 2.2.2 is backward compatible to version 2.2.1 and 2.2 with -the following exceptions: -

- - -

-An overview of the differences between version 2.2.2 and the previous -version 2.2.1 is given below. The exact differences (but without -differences in the documentation) are available in -Differences-Modelica-221-222.html. -This comparison file was generated automatically with Dymola's -ModelManagement.compare function. -

- -

-In this version, no new libraries have been added. The documentation -of the whole library was improved. -

- -


-The following new components have been added -to existing libraries: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Blocks.Logical.
TerminateSimulation Terminate a simulation by a given condition.
Blocks.Routing.
RealPassThrough
- IntegerPassThrough
- BooleanPassThrough		 Pass a signal from input to output - (useful in combination with a bus due to restrictions - of expandable connectors).
Blocks.Sources.
KinematicPTP2 Directly gives q,qd,qdd as output (and not just qdd as KinematicPTP). -
Electrical.Machines.Examples.
TransformerTestbench Transformer Testbench -
Rectifier6pulse 6-pulse rectifier with 1 transformer -
Rectifier12pulse 12-pulse rectifier with 2 transformers -
AIMC_Steinmetz Induction machine squirrel cage with Steinmetz connection -
Electrical.Machines.BasicMachines.Components.
BasicAIM Partial model for induction machine -
BasicSM Partial model for synchronous machine -
PartialAirGap Partial air gap model -
BasicDCMachine Partial model for DC machine -
PartialAirGapDC Partial air gap model of a DC machine -
BasicTransformer Partial model of three-phase transformer -
PartialCore Partial model of transformer core with 3 windings -
IdealCore Ideal transformer with 3 windings -
Electrical.Machines.BasicMachines.
Transformers Sub-Library for technical 3phase transformers -
Electrical.Machines.Interfaces.
Adapter Adapter to model housing of electrical machine -
Math.
Vectors New library of functions operating on vectors -
atan3 Four quadrant inverse tangent (select solution that is closest to given angle y0) -
asinh Inverse of sinh (area hyperbolic sine) -
acosh Inverse of cosh (area hyperbolic cosine) -
Math.Vectors
isEqual Determine if two Real vectors are numerically identical -
norm Return the p-norm of a vector -
length Return length of a vector (better as norm(), if further symbolic processing is performed) -
normalize Return normalized vector such that length = 1 and prevent zero-division for zero vector -
reverse Reverse vector elements (e.g., v[1] becomes last element) -
sort Sort elements of vector in ascending or descending order -
Math.Matrices
solve2 Solve real system of linear equations A*X=B with a B matrix - (Gaussian elimination with partial pivoting) -
LU_solve2 Solve real system of linear equations P*L*U*X=B with a B matrix - and an LU decomposition (from LU(..)) -
Mechanics.Rotational.
InitializeFlange Initialize a flange according to given signals - (useful if initialization signals are provided by a signal bus). -
Media.Interfaces.PartialMedium.
density_pTX Return density from p, T, and X or Xi -
Media.Interfaces.PartialTwoPhaseMedium.
BaseProperties Base properties (p, d, T, h, u, R, MM, x) of a two phase medium -
molarMass Return the molar mass of the medium -
saturationPressure_sat Return saturation pressure -
saturationTemperature_sat Return saturation temperature -
saturationTemperature_derp_sat Return derivative of saturation temperature w.r.t. pressure -
setState_px Return thermodynamic state from pressure and vapour quality -
setState_Tx Return thermodynamic state from temperature and vapour quality -
vapourQuality Return vapour quality -
Media.Interfaces.
PartialLinearFluid Generic pure liquid model with constant cp, - compressibility and thermal expansion coefficients -
Media.Air.MoistAir.
massFraction_pTphi Return the steam mass fraction from relative humidity and T -
saturationTemperature Return saturation temperature from (partial) pressure - via numerical inversion of function saturationPressure -
enthalpyOfWater Return specific enthalpy of water (solid/liquid) near - atmospheric pressure from temperature -
enthalpyOfWater_der Return derivative of enthalpyOfWater()\" function -
PsychrometricData Model to generate plot data for psychrometric chart -
Media.CompressibleLiquids.
- New sub-library for simple compressible liquid models
LinearColdWater Cold water model with linear compressibility -
LinearWater_pT_Ambient Liquid, linear compressibility water model at 1.01325 bar - and 25 degree Celsius -
SIunits.
TemperatureDifference Type for temperature difference -
- -


-The following existing components -have been improved: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Blocks.Examples.
BusUsage Example changed from the \"old\" to the \"new\" bus concept with - expandable connectors.
Blocks.Discrete.
ZeroOrderHold Sample output ySample moved from \"protected\" to \"public\" - section with new attributes (start=0, fixed=true). -
TransferFunction Discrete state x with new attributes (each start=0, each fixed=0). -
Electrical.
Analog
Polyphase		 Improved some icons. -
Electrical.Digital.Interfaces.
MISO Removed \"algorithm\" from this partial block. -
Electrical.Digital.Delay.
DelayParams Removed \"algorithm\" from this partial block. -
Electrical.Digital.Delay.
DelayParams Removed \"algorithm\" from this partial block. -
TransportDelay If delay time is zero, an infinitely small delay is - introduced via pre(x) (previously \"x\" was used). -
Electrical.Digital.Sources.
Clock
Step		 Changed if-conditions from \"xxx < time\" to \"time >= xxx\" - (according to the Modelica specification, in the second case - a time event should be triggered, i.e., this change leads - potentially to a faster simulation). -
Electrical.Digital.Converters.
BooleanToLogic
- LogicToBoolean
- RealToLogic
- LogicToReal		 Changed from \"algorithm\" to \"equation\" section - to allow better symbolic preprocessing -
Electrical.
Machines Slightly improved documentation, typos in - documentation corrected -
Electrical.Machines.Examples.
AIMS_start Changed QuadraticLoadTorque1(TorqueDirection=true) to - QuadraticLoadTorque1(TorqueDirection=false) since more realistic -
Electrical.Machines.Interfaces.
PartialBasicMachine Introduced support flange to model the - reaction torque to the housing -
Electrical.Machines.Sensors.
Rotorangle Introduced support flange to model the - reaction torque to the housing -
Mechanics.MultiBody.Examples.Elementary.
PointMassesWithGravity Added two point masses connected by a line force to demonstrate - additionally how this works. Connections of point masses - with 3D-elements are demonstrated in the new example - PointMassesWithGravity (there is the difficulty that the orientation - is not defined in a PointMass object and therefore some - special handling is needed in case of a connection with - 3D-elements, where the orientation of the point mass is not - determined by these elements.
Mechanics.MultiBody.Examples.Systems.
RobotR3 Changed from the \"old\" to the \"new\" bus concept with expandable connectors. - Replaced the non-standard Modelica function \"constrain()\" by - standard Modelica components. As a result, the non-standard function - constrain() is no longer used in the Modelica Standard Library.
Mechanics.MultiBody.Frames.Orientation.
equalityConstraint Use a better residual for the equalityConstraint function. - As a result, the non-linear equation system of a kinematic - loop is formulated in a better way (the range where the - desired result is a unique solution of the non-linear - system of equations becomes much larger).
Mechanics.MultiBody.
Visualizers. Removed (misleading) annotation \"structurallyIncomplete\" - in the models of this sub-library -
Mechanics.Rotational.
Examples For all models in this sub-library: -
    -
  • Included a housing object in all examples to compute - all support torques.
    • -
  • Replaced initialization by modifiers via the - initialization menu parameters of Inertia components.
    • -
  • Removed \"encapsulated\" and unnecessary \"import\".
    • -
  • Included \"StopTime\" in the annotations.
    • -
-
Mechanics.Rotational.Interfaces.
FrictionBase Introduced \"fixed=true\" for Boolean variables startForward, - startBackward, mode. -
Mechanics.Translational.Interfaces.
FrictionBase Introduced \"fixed=true\" for Boolean variables startForward, - startBackward, mode. -
Media.UsersGuide.MediumUsage.
TwoPhase Improved documentation and demonstrating the newly introduced functions -
Media.Examples.
WaterIF97 Provided (missing) units for variables V, dV, H_flow_ext, m, U. -
Media.Interfaces.
PartialMedium Final modifiers are removed from nX and nXi, to allow - customized medium models such as mixtures of refrigerants with oil, etc. -
PartialCondensingGases Included attributes \"min=1, max=2\" for input argument FixedPhase - for functions setDewState and setBubbleState (in order to guarantee - that input arguments are correct). -
Media.Interfaces.PartialMedium.
BaseProperties New Boolean parameter \"standardOrderComponents\". - If true, last element vector X is computed from 1-sum(Xi) (= default) - otherwise, no equation is provided for it in PartialMedium. -
IsentropicExponent \"max\" value changed from 1.7 to 500000 -
setState_pTX
- setState_phX
- setState_psX
- setState_dTX
- specificEnthalpy_pTX
- temperature_phX
- density_phX
- temperature_psX
- density_psX
- specificEnthalpy_psX		 Introduced default value \"reference_X\" for input argument \"X\". -
Media.Interfaces.PartialSimpleMedium.
setState_pTX
- setState_phX
- setState_psX
- setState_dTX		 Introduced default value \"reference_X\" for input argument \"X\". -
Media.Interfaces.PartialSimpleIdealGasMedium.
setState_pTX
- setState_phX
- setState_psX
- setState_dTX		 Introduced default value \"reference_X\" for input argument \"X\". -
Media.Air.MoistAir.
setState_pTX
- setState_phX
- setState_dTX		 Introduced default value \"reference_X\" for input argument \"X\". -
Media.IdealGases.Common.SingleGasNasa.
setState_pTX
- setState_phX
- setState_psX
- setState_dTX		 Introduced default value \"reference_X\" for input argument \"X\". -
Media.IdealGases.Common.MixtureGasNasa.
setState_pTX
- setState_phX
- setState_psX
- setState_dTX
- h_TX		 Introduced default value \"reference_X\" for input argument \"X\". -
Media.Common.
IF97PhaseBoundaryProperties
- gibbsToBridgmansTables 		Introduced unit for variables vt, vp. -
SaturationProperties Introduced unit for variable dpT. -
BridgmansTables Introduced unit for dfs, dgs. -
Media.Common.ThermoFluidSpecial.
gibbsToProps_ph
- gibbsToProps_ph
- gibbsToBoundaryProps
- gibbsToProps_dT
- gibbsToProps_pT		 Introduced unit for variables vt, vp. -
TwoPhaseToProps_ph Introduced unit for variables dht, dhd, detph. -
Media.
MoistAir Documentation of moist air model significantly improved. -
Media.MoistAir.
enthalpyOfVaporization Replaced by linear correlation since simpler and more - accurate in the entire region. -
Media.Water.IF97_Utilities.BaseIF97.Regions.
drhovl_dp Introduced unit for variable dd_dp. -
Thermal.
FluidHeatFlow Introduced new parameter tapT (0..1) to define the - temperature of the HeatPort as linear combination of the - flowPort_a (tapT=0) and flowPort_b (tapT=1) temperatures. -
- -


-The following critical errors have been fixed (i.e., errors -that can lead to wrong simulation results): -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Electrical.Machines.BasicMachines.Components.
ElectricalExcitation Excitation voltage ve is calculated as - \"spacePhasor_r.v_[1]*TurnsRatio*3/2\" instead of - \"spacePhasor_r.v_[1]*TurnsRatio -
Mechanics.MultiBody.Parts.
FixedRotation Bug corrected that the torque balance was wrong in the - following cases (since vector r was not transformed - from frame_a to frame_b; note this special case occurs very seldom in practice): -
  • frame_b is in the spanning tree closer to the root - (usually this is frame_a).
    • -
  • vector r from frame_a to frame_b is not zero.
    • -
-
PointMass If a PointMass model is connected so that no equations are present - to compute its orientation object, the orientation was arbitrarily - set to a unit rotation. In some cases this can lead to a wrong overall - model, depending on how the PointMass model is used. For this reason, - such cases lead now to an error (via an assert(..)) with an explanation - how to fix this. -
Media.Interfaces.PartialPureSubstance.
pressure_dT
- specificEnthalpy_dT - 		Changed wrong call from \"setState_pTX\" to \"setState_dTX\" -
Media.Interfaces.PartialTwoPhaseMedium.
pressure_dT
- specificEnthalpy_dT - 		Changed wrong call from \"setState_pTX\" to \"setState_dTX\" -
Media.Common.ThermoFluidSpecial.
gibbsToProps_dT
- helmholtzToProps_ph
- helmholtzToProps_pT
- helmholtzToProps_dT		 Bugs in equations corrected
Media.Common.
helmholtzToBridgmansTables
- helmholtzToExtraDerivs		 Bugs in equations corrected
Media.IdealGases.Common.SingleGasNasa.
density_derp_T Bug in equation of partial derivative corrected
Media.Water.IF97_Utilities.
BaseIF97.Inverses.dtofps3
- isentropicExponent_props_ph
- isentropicExponent_props_pT
- isentropicExponent_props_dT		 Bugs in equations corrected
Media.Air.MoistAir.
h_pTX Bug in setState_phX due to wrong vector size in h_pTX corrected. - Furthermore, syntactical errors corrected: -
  • In function massFractionpTphi an equation - sign is used in an algorithm.
    • -
  • Two consecutive semicolons removed
    • -
-
Media.Water.
waterConstants Bug in equation of criticalMolarVolume corrected. -
Media.Water.IF97_Utilities.BaseIF97.Regions.
region_ph
- region_ps		 Bug in region determination corrected. -
boilingcurve_p
- dewcurve_p		 Bug in equation of plim corrected. -
- -


-The following uncritical errors have been fixed (i.e., errors -that do not lead to wrong simulation results, but, e.g., -units are wrong or errors in documentation): -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Blocks.
Examples Corrected typos in description texts of bus example models. -
Blocks.Continuous.
LimIntegrator removed incorrect smooth(0,..) because expression might be discontinuous. -
Blocks.Math.UnitConversions.
block_To_kWh
block_From_kWh		 Corrected unit from \"kWh\" to (syntactically correct) \"kW.h\". -
Electrical.Analog.Examples.
HeatingNPN_OrGate Included start values, so that initialization is - successful
Electrical.Analog.Lines.
OLine Corrected unit from \"Siemens/m\" to \"S/m\". -
TLine2 Changed wrong type of parameter NL (normalized length) from - SIunits.Length to Real. -
Electrical.Digital.Delay.
TransportDelay Syntax error corrected - (\":=\" in equation section is converted by Dymola silently to \"=\"). -
Electrical.Digital
Converters Syntax error corrected - (\":=\" in equation section is converted by Dymola silently to \"=\"). -
Electrical.Polyphase.Basic.
Conductor Changed wrong type of parameter G from SIunits.Resistance to - SIunits.Conductance. -
Electrical.Polyphase.Interfaces.
Plug
 Made used \"pin\" connectors non-graphical (otherwise, - there are difficulties to connect to Plug). -
Electrical.Polyphase.Sources.
SineCurrent Changed wrong type of parameter offset from SIunits.Voltage to - SIunits.Current. -
Mechanics.MultiBody.Examples.Loops.
EngineV6 Corrected wrong crankAngleOffset of some cylinders - and improved the example. -
Mechanics.MultiBody.Examples.Loops.Utilities.
GasForce Wrong units corrected: - \"SIunitsPosition x,y\" to \"Real x,y\"; - \"SIunits.Pressure press\" to \"SIunits.Conversions.NonSIunits.Pressure_bar\" -
GasForce2 Wrong unit corrected: \"SIunits.Position x\" to \"Real x\". -
EngineV6_analytic Corrected wrong crankAngleOffset of some cylinders. -
Mechanics.MultiBody.Interfaces.
PartialLineForce Corrected wrong unit: \"SIunits.Position eRod_a\" to \"Real eRod_a\"; -
FlangeWithBearingAdaptor If includeBearingConnector = false, connector \"fr\" - + \"ame\" was not - removed. As long as the connecting element to \"frame\" determines - the non-flow variables, this is fine. In the corrected version, \"frame\" - is conditionally removed in this case.
Mechanics.MultiBody.Forces.
ForceAndTorque Corrected wrong unit: \"SIunits.Force t_b_0\" to \"SIunits.Torque t_b_0\". -
LineForceWithTwoMasses Corrected wrong unit: \"SIunits.Position e_rel_0\" to \"Real e_rel_0\". -
Mechanics.MultiBody.Frames.
axisRotation Corrected wrong unit: \"SIunits.Angle der_angle\" to - \"SIunits.AngularVelocity der_angle\". -
Mechanics.MultiBody.Joints.Assemblies.
JointUSP
JointSSP		 Corrected wrong unit: \"SIunits.Position aux\" to \"Real\" -
Mechanics.MultiBody.Sensors.
AbsoluteSensor Corrected wrong units: \"SIunits.Acceleration angles\" to - \"SIunits.Angle angles\" and - \"SIunits.Velocity w_abs_0\" to \"SIunits.AngularVelocity w_abs_0\" -
RelativeSensor Corrected wrong units: \"SIunits.Acceleration angles\" to - \"SIunits.Angle angles\" -
Distance Corrected wrong units: \"SIunits.Length L2\" to \"SIunits.Area L2\" and - SIunits.Length s_small2\" to \"SIunits.Area s_small2\" -
Mechanics.MultiBody.Visualizers.Advanced.
Shape Changed \"MultiBody.Types.Color color\" to \"Real color[3]\", since - \"Types.Color\" is \"Integer color[3]\" and there have been backward - compatibility problems with models using \"color\" before it was changed - to \"Types.Color\". -
Mechanics.Rotational.Interfaces.
FrictionBase Rewrote equations with new variables \"unitAngularAcceleration\" and - \"unitTorque\" in order that the equations are correct with respect - to units (previously, variable \"s\" can be both a torque and an - angular acceleration and this lead to unit incompatibilities) -
Mechanics.Rotational.
OneWayClutch
LossyGear		 Rewrote equations with new variables \"unitAngularAcceleration\" and - \"unitTorque\" in order that the equations are correct with respect - to units (previously, variable \"s\" can be both a torque and an - angular acceleration and this lead to unit incompatibilities) -
Mechanics.Translational.Interfaces.
FrictionBase Rewrote equations with new variables \"unitAngularAcceleration\" and - \"unitTorque\" in order that the equations are correct with respect - to units (previously, variable \"s\" can be both a torque and an - angular acceleration and this lead to unit incompatibilities) -
Mechanics.Translational.
Speed Corrected unit of v_ref from SIunits.Position to SIunits.Velocity -
Media.Examples.Tests.Components.
PartialTestModel
PartialTestModel2		 Corrected unit of h_start from \"SIunits.Density\" to \"SIunits.SpecificEnthalpy\" -
Media.Examples.SolveOneNonlinearEquation.
Inverse_sh_T - InverseIncompressible_sh_T
- Inverse_sh_TX		 Rewrote equations so that dimensional (unit) analysis is correct\" -
Media.Incompressible.Examples.
TestGlycol Rewrote equations so that dimensional (unit) analysis is correct\" -
Media.Interfaces.PartialTwoPhaseMedium.
dBubbleDensity_dPressure
dDewDensity_dPressure		 Changed wrong type of ddldp from \"DerDensityByEnthalpy\" - to \"DerDensityByPressure\". -
Media.Common.ThermoFluidSpecial.
ThermoProperties Changed wrong units: - \"SIunits.DerEnergyByPressure dupT\" to \"Real dupT\" and - \"SIunits.DerEnergyByDensity dudT\" to \"Real dudT\" -
ThermoProperties_ph Changed wrong unit from \"SIunits.DerEnergyByPressure duph\" to \"Real duph\" -
ThermoProperties_pT Changed wrong unit from \"SIunits.DerEnergyByPressure dupT\" to \"Real dupT\" -
ThermoProperties_dT Changed wrong unit from \"SIunits.DerEnergyByDensity dudT\" to \"Real dudT\" -
Media.IdealGases.Common.SingleGasNasa.
cp_Tlow_der Changed wrong unit from \"SIunits.Temperature dT\" to \"Real dT\". -
Media.Water.IF97_Utilities.BaseIF97.Basic.
p1_hs
- h2ab_s
- p2a_hs
- p2b_hs
- p2c_hs
- h3ab_p
- T3a_ph
- T3b_ph
- v3a_ph
- v3b_ph
- T3a_ps
- T3b_ps
- v3a_ps
- v3b_ps		 Changed wrong unit of variables h/hstar, s, sstar from - \"SIunits.Enthalpy\" to \"SIunits.SpecificEnthalpy\", - \"SIunits.SpecificEntropy\", \"SIunits.SpecificEntropy -
Media.Water.IF97_Utilities.BaseIF97.Transport.
cond_dTp Changed wrong unit of TREL, rhoREL, lambdaREL from - \"SIunits.Temperature\", \"SIunit.Density\", \"SIunits.ThermalConductivity\" - to \"Real\". -
Media.Water.IF97_Utilities.BaseIF97.Inverses.
tofps5
tofpst5		 Changed wrong unit of pros from \"SIunits.SpecificEnthalpy\" to - \"SIunits.SpecificEntropy\". -
Media.Water.IF97_Utilities.
waterBaseProp_ph Improved calculation at the limits of the validity. -
Thermal.
FluidHeatFlow
HeatTransfer		 Corrected wrong unit \"SIunits.Temperature\" of difference temperature - variables with \"SIunits.TemperatureDifference\". -
- -")); -end Version_2_2_2; - -class Version_2_2_1 "Version 2.2.1 (March 24, 2006)" - extends Modelica.Icons.ReleaseNotes; - - annotation (Documentation(info=" - -

-Version 2.2.1 is backward compatible to version 2.2. -

- -

-In this version, no new libraries have been added. -The following major improvements have been made: -

- - - -

-The following new components have been added to existing libraries: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Modelica.Blocks.Examples.
PID_Controller Example to demonstrate the usage of the - Blocks.Continuous.LimPID block.
Modelica.Blocks.Math.
UnitConversions.* New package that provides blocks for unit conversions. - UnitConversions.ConvertAllBlocks allows to select all - available conversions from a menu.
Modelica.Electrical.Machines.BasicMachines.SynchronousMachines.
SM_ElectricalExcitedDamperCage Electrical excited synchronous machine with damper cage
Modelica.Electrical.Machines.BasicMachines.Components.
ElectricalExcitation Electrical excitation for electrical excited synchronous - induction machines
DamperCage Unsymmetrical damper cage for electrical excited synchronous - induction machines. At least the user has to specify the dampers - resistance and stray inductance in d-axis; if he omits the - parameters of the q-axis, the same values as for the d.axis - are used, assuming a symmetrical damper.
Modelica.Electrical.Machines.Examples.
SMEE_Gen Test example 7: ElectricalExcitedSynchronousMachine - as Generator
Utilities.TerminalBox Terminal box for three-phase induction machines to choose - either star (wye) ? or delta ? connection
Modelica.Math.Matrices.
equalityLeastSquares Solve a linear equality constrained least squares problem:
- min|A*x-a|^2 subject to B*x=b
Modelica.Mechanics.MultiBody.
Parts.PointMass Point mass, i.e., body where inertia tensor is neglected.
Interfaces.FlangeWithBearing Connector consisting of 1-dim. rotational flange and its - 3-dim. bearing frame.
Interfaces.FlangeWithBearingAdaptor Adaptor to allow direct connections to the sub-connectors - of FlangeWithBearing.
Types.SpecularCoefficient New type to define a specular coefficient.
Types.ShapeExtra New type to define the extra data for visual shape objects and to - have a central place for the documentation of this data.
Modelica.Mechanics.MultiBody.Examples.Elementary
PointGravityWithPointMasses Example of two point masses in a central gravity field.
Modelica.Mechanics.Rotational.
UsersGuide A User's Guide has been added by using the documentation previously - present in the package documentation of Rotational.
Sensors.PowerSensor New component to measure the energy flow between two connectors - of the Rotational library.
Modelica.Mechanics.Translational.
Speed New component to move a translational flange - according to a reference speed
Modelica.Media.Interfaces.PartialMedium.
specificEnthalpy_pTX New function to compute specific enthalpy from pressure, temperature - and mass fractions.
temperature_phX New function to compute temperature from pressure, specific enthalpy, - and mass fractions.
Modelica.Icons.
SignalBus Icon for signal bus
SignalSubBus Icon for signal sub-bus
Modelica.SIunits.
UsersGuide A User's Guide has been added that describes unit handling.
Resistance
- Conductance		 Attribute 'min=0' removed from these types.
Modelica.Thermal.FluidHeatFlow.
Components.Valve Simple controlled valve with either linear or - exponential characteristic.
Sources. IdealPump Simple ideal pump (resp. fan) dependent on the shaft's speed; - pressure increase versus volume flow is defined as a linear - function. Torque * Speed = Pressure increase * Volume flow - (without losses).
Examples.PumpAndValve Test example for valves.
Examples.PumpDropOut Drop out of 1 pump to test behavior of semiLinear.
Examples.ParallelPumpDropOut Drop out of 2 parallel pumps to test behavior of semiLinear.
Examples.OneMass Cooling of 1 hot mass to test behavior of semiLinear.
Examples.TwoMass Cooling of 2 hot masses to test behavior of semiLinear.
- -

-The following components have been improved: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Modelica.
UsersGuide User's Guide and package description of Modelica Standard Library improved.
Modelica.Blocks.Interfaces.
RealInput
- BooleanInput
- IntegerInput		 When dragging one of these connectors the width and height - is a factor of 2 larger as a standard icon. Previously, - these connectors have been dragged and then manually enlarged - by a factor of 2 in the Modelica standard library.
Modelica.Blocks.
Continuous.* Initialization options added to all blocks - (NoInit, SteadyState, InitialState, InitialOutput). - New parameter limitsAtInit to switch off the limits - of LimIntegrator or LimPID during initialization
Continuous.LimPID Option to select P, PI, PD, PID controller. - Documentation significantly improved.
Nonlinear.Limiter
- Nonlinear.VariableLimiter
- Nonlinear.Deadzone		 New parameter limitsAtInit/deadZoneAtInit to switch off the limits - or the dead zone during initialization
Modelica.Electrical.Analog.
Sources Icon improved (+/- added to voltage sources, arrow added to - current sources).
Modelica.Electrical.Analog.Semiconductors.
Diode smooth() operator included to improve numerics.
Modelica.Electrical.Machines.BasicMachines.SynchronousMachines.
SM_PermanentMagnetDamperCage
- SM_ElectricalExcitedDamperCage
- SM_ReluctanceRotorDamperCage		 The user can choose \"DamperCage = false\" (default: true) - to remove all equations for the damper cage from the model.
Modelica.Electrical.Machines.BasicMachines.InductionMachines.
IM_SlipRing Easier parameterization: if the user selects \"useTurnsRatio = false\" - (default: true, this is the same behavior as before), - parameter TurnsRatio is calculated internally from - Nominal stator voltage and Locked-rotor voltage.
Modelica.Math.Matrices.
leastSquaresThe A matrix in the least squares problem might be rank deficient. - Previously, it was required that A has full rank.
Modelica.Mechanics.MultiBody.
all models
    -
  • All components with animation information have a new variable - specularCoefficient to define the reflection of ambient light. - The default value is world.defaultSpecularCoefficient which has - a default of 0.7. By changing world.defaultSpecularCoefficient, the - specularCoefficient of all components is changed that are not - explicitly set differently. Since specularCoefficient is a variable - (and no parameter), it can be changed during simulation. Since - annotation(Dialog) is set, this variable still appears in the - parameter menus.
    - Previously, a constant specularCoefficient of 0.7 was used - for all components.
    • -
  • Variable color of all components is no longer a parameter - but an input variable. Also all parameters in package Visualizers, - with the exception of shapeType are no longer parameters but - defined as input variables with annotation(Dialog). As a result, - all these variables appear still in parameter menus, but they can - be changed during simulation (e.g., color might be used to - display the temperature of a part).
    • -
  • All menus have been changed to follow the Modelica 2.2 annotations - \"Dialog, group, tab, enable\" (previously, a non-standard Dymola - definition for menus was used). Also, the \"enable\" annotation - is used in all menus - to disable input fields if the input would be ignored.
    • -
  • All visual shapes are now defined with conditional declarations - (to remove them, if animation is switched off). Previously, - these (protected) objects have been defined by arrays with - dimension 0 or 1.
    • -
Frames.resolveRelative The derivative of this function added as function and defined via - an annotation. In certain situations, tools had previously - difficulties to differentiate the inlined function automatically.
Forces.* The scaling factors N_to_m and Nm_to_m have no longer a default - value of 1000 but a default value of world.defaultN_to_m (=1000) - and world.defaultNm_to_m (=1000). This allows to change the - scaling factors for all forces and torques in the world - object.
Interfaces.Frame.a
- Interfaces.Frame.b
- Interfaces.Frame_resolve		 The Frame connectors are now centered around the origin to ease - the usage. The shape was changed, such that the icon is a factor - of 1.6 larger as a standard icon (previously, the icon had a - standard size when dragged and then the icon was manually enlarged - by a factor of 1.5 in the y-direction in the MultiBody library; - the height of 16 allows easy positioning on the standard grid size of 2). - The double line width of the border in icon and diagram layer was changed - to a single line width and when making a connection the connection - line is dark grey and no longer black which looks better.
Joints.Assemblies.* When dragging an assembly joint, the icon is a factor of 2 - larger as a standard icon. Icon texts and connectors have a - standard size in this enlarged icon (and are not a factor of 2 - larger as previously).
Types.* All types have a corresponding icon now to visualize the content - in the package browser (previously, the types did not have an icon).
Modelica.Mechanics.Rotational.
Inertia Initialization and state selection added.
SpringDamper Initialization and state selection added.
Move New implementation based solely on Modelica 2.2 language - (previously, the Dymola specific constrain(..) function was used).
Modelica.Mechanics.Translational.
Move New implementation based solely on Modelica 2.2 language - (previously, the Dymola specific constrain(..) function was used).
Modelica.Thermal.FluidHeatFlow.Interfaces.
SimpleFriction Calculates friction losses from pressure drop and volume flow.
Modelica.Thermal.FluidHeatFlow.Components.
IsolatedPipe
- HeatedPipe		 Added geodetic height as a source of pressure change; - feeds friction losses as calculated by simple friction to - the energy balance of the medium.
Modelica.Media.Interfaces.PartialMedium.FluidConstants.
HCRIT0Critical specific enthalpy of the fundamental - equation (base formulation of the fluid medium model).
SCRIT0Critical specific entropy of the fundamental - equation (base formulation of the fluid medium model).
deltahEnthalpy offset (default: 0) between the - specific enthalpy of the fluid model and the user-visible - specific enthalpy in the model: deltah = h_model - h_fundamentalEquation. -
deltasEntropy offset (default: 0) between the - specific entropy of the fluid model and the user-visible - specific entropy in the model: deltas = s_model - s_fundamentalEquation.
T_defaultDefault value for temperature of medium (for initialization)
h_defaultDefault value for specific enthalpy of medium (for initialization)
p_defaultDefault value for pressure of medium (for initialization)
X_defaultDefault value for mass fractions of medium (for initialization)
-

-The following errors have been fixed: -

- - - - - - - - - - - - - - - - - - - - - -
Modelica.Blocks.Tables.
CombiTable1D
- CombiTable1Ds
- CombiTable2D		 Parameter \"tableOnFile\" determines now whether a table is read from - file or used from parameter \"table\". Previously, if \"fileName\" was not - \"NoName\", a table was always read from file \"fileName\", independently - of the setting of \"tableOnFile\". This has been corrected.
- Furthermore, the initialization of a table is now performed in a - when-clause and no longer in a parameter declaration, because some - tools evaluate the parameter declaration in some situation more than - once and then the table is unnecessarily read several times - (and occupies also more memory).
Modelica.Blocks.Sources.
CombiTimeTable Same bug fix/improvement as for the tables from Modelica.Blocks.Tables - as outlined above.
Modelica.Electrical.Analog.Semiconductors.
PMOS
- NMOS
- HeatingPMOS
- HeatingNMOS		 The Drain-Source-Resistance RDS had actually a resistance of - RDS/v, with v=Beta*(W+dW)/(L+dL). The correct formula is without - the division by \"v\". This has now been corrected.
- This bug fix should not have an essential effect in most applications. - In the default case (Beta=1e-5), the Drain-Source-Resistance was - a factor of 1e5 too large and had in the default case the - wrong value 1e12, although it should have the value 1e7. The effect - was that this resistance had practically no effect.
Modelica.Media.IdealGases.Common.SingleGasNasa.
dynamicViscosityLowPressure Viscosity and thermal conductivity (which needs viscosity as input) - were computed wrong for polar gases and gas mixtures - (i.e., if dipole moment not 0.0). This has been fixed in version 2.2.1.
Modelica.Utilities.Streams.
readLine Depending on the C-implementation, the stream was not correctly closed. - This has been corrected by adding a \"Streams.close(..)\" - after reading the file content.
-")); -end Version_2_2_1; - -class Version_2_2 "Version 2.2 (April 6, 2005)" - extends Modelica.Icons.ReleaseNotes; - - annotation (Documentation(info=" - -

-Version 2.2 is backward compatible to version 2.1. -

- -

-The following new libraries have been added: -

- - - - - - -
Modelica.Media Property models of liquids and gases, especially -
    -
  • 1241 detailed gas models,
    • -
  • moist air,
    • -
  • high precision water model (according to IAPWS/IF97 standard),
    • -
  • incompressible media defined by tables (cp(T), rho(t), eta(T), etc. are defined by tables).
    • -
- The user can conveniently define mixtures of gases between the - 1241 gas models. The models are - designed to work well in dynamic simulations. They - are based on a new standard interface for media with - single and multiple substances and one or multiple phases - with the following features: -
    -
  • The independent variables of a medium model do not influence the - definition of a fluid connector port or how the - balance equations have to be implemented.
    - Used independent variables: \"p,T\", \"p,T,X\", \"p,h\", \"d,T\".
    • -
  • Optional variables, e.g., dynamic viscosity, are only computed - if needed.
    • -
  • The medium models are implemented with regards to efficient - dynamic simulation.
    • -
-
Modelica.Thermal.FluidHeatFlow Simple components for 1-dim., incompressible thermo-fluid flow - to model coolant flows, e.g., of electrical machines. - Components can be connected arbitrarily together (= ideal mixing - at connection points) and fluid may reverse direction of flow. -
-

-The following changes have been performed in the -Modelica.Mechanics.MultiBody library: -

- -")); -end Version_2_2; - -class Version_2_1 "Version 2.1 (Nov. 11, 2004)" - extends Modelica.Icons.ReleaseNotes; - - annotation (Documentation(info=" - -

This is a major change with respect to previous versions of the - Modelica Standard Library, because many new libraries and components - are included and because the input/output blocks (Modelica.Blocks) - have been considerably simplified: -

- - -

-The discussed changes of Modelica.Blocks are not backward compatible. -A script to automatically convert models to this new version is -provided. There might be rare cases, where this script does not convert. -In this case models have to be manually converted. -In any case you should make a back-up copy of your model -before automatic conversion is performed. -

-

-The following new libraries have been added: -

- - - - - - - - - - - - - - - - - -
Modelica.Electrical.DigitalDigital electrical components based on 2-,3-,4-, and 9-valued logic
- according to the VHDL standard
Modelica.Electrical.MachinesAsynchronous, synchronous and DC motor and generator models
Modelica.Math.MatricesFunctions operating on matrices such as solve() (A*x=b), leastSquares(),
- norm(), LU(), QR(), eigenValues(), singularValues(), exp(), ...
Modelica.StateGraph Modeling of discrete event and reactive systems in a convenient way using
- hierarchical state machines and Modelica as action language.
- It is based on JGrafchart and Grafcet and has a similar modeling power as
- StateCharts. It avoids deficiencies of usually used action languages.
- This library makes the ModelicaAdditions.PetriNets library obsolete.
Modelica.Utilities.FilesFunctions to operate on files and directories (copy, move, remove files etc.)
Modelica.Utilities.StreamsRead from files and write to files (print, readLine, readFile, error, ...)
Modelica.Utilities.StringsOperations on strings (substring, find, replace, sort, scanToken, ...)
Modelica.Utilities.SystemGet/set current directory, get/set environment variable, execute shell command, etc.
-

-The following existing libraries outside of the Modelica standard library -have been improved and added as new libraries -(models using the previous libraries are automatically converted -to the new sublibraries inside package Modelica): -

- - - - - - - - - - - - - -
Modelica.Blocks.Discrete Discrete input/output blocks with fixed sample period
- (from ModelicaAdditions.Blocks.Discrete)
Modelica.Blocks.Logical Logical components with Boolean input and output signals
- (from ModelicaAdditions.Blocks.Logical)
Modelica.Blocks.Nonlinear Discontinuous or non-differentiable algebraic control blocks such as variable limiter,
- fixed, variable and Pade delay etc. (from ModelicaAdditions.Blocks.Nonlinear)
Modelica.Blocks.Routing Blocks to combine and extract signals, such as multiplexer
- (from ModelicaAdditions.Blocks.Multiplexer)
Modelica.Blocks.Tables One and two-dimensional interpolation in tables. CombiTimeTable is available
- in Modelica.Blocks.Sources (from ModelicaAdditions.Tables)
Modelica.Mechanics.MultiBody Components to model the movement of 3-dimensional mechanical systems. Contains
- body, joint, force and sensor components, analytic handling of kinematic loops,
- force elements with mass, series/parallel connection of 3D force elements etc.
- (from MultiBody 1.0 where the new signal connectors are used;
- makes the ModelicaAdditions.MultiBody library obsolete)
-

-As a result, the ModelicaAdditions library is obsolete, because all components -are either included in the Modelica library or are replaced by much more -powerful libraries (MultiBody, StateGraph). -

-

-The following new components have been added to existing libraries. -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Modelica.Blocks.Logical.
Prey = pre(u): Breaks algebraic loops by an infinitesimal small
- time delay (event iteration continues until u = pre(u))
Edgey = edge(u): Output y is true, if the input u has a rising edge
FallingEdgey = edge(not u): Output y is true, if the input u has a falling edge
Changey = change(u): Output y is true, if the input u has a rising or falling edge
GreaterEqualOutput y is true, if input u1 is greater or equal than input u2
LessOutput y is true, if input u1 is less than input u2
LessEqualOutput y is true, if input u1 is less or equal than input u2
TimerTimer measuring the time from the time instant where the
- Boolean input became true
Modelica.Blocks.Math.
BooleanToRealConvert Boolean to Real signal
BooleanToIntegerConvert Boolean to Integer signal
RealToBooleanConvert Real to Boolean signal
IntegerToBooleanConvert Integer to Boolean signal
Modelica.Blocks.Sources.
RealExpressionSet output signal to a time varying Real expression
IntegerExpressionSet output signal to a time varying Integer expression
BooleanExpressionSet output signal to a time varying Boolean expression
BooleanTableGenerate a Boolean output signal based on a vector of time instants
Modelica.Mechanics.MultiBody.
Frames.from_T2Return orientation object R from transformation matrix T and its derivative der(T)
Modelica.Mechanics.Rotational.
LinearSpeedDependentTorqueLinear dependency of torque versus speed (acts as load torque)
QuadraticSpeedDependentTorqueQuadratic dependency of torque versus speed (acts as load torque)
ConstantTorqueConstant torque, not dependent on speed (acts as load torque)
ConstantSpeedConstant speed, not dependent on torque (acts as load torque)
TorqueStepConstant torque, not dependent on speed (acts as load torque)
-

-The following bugs have been corrected: -

- - - - - - - -
Modelica.Mechanics.MultiBody.Forces.
LineForceWithMass
- Spring		If mass of the line force or spring component is not zero, the
- mass was (implicitly) treated as \"mass*mass\" instead of as \"mass\"
Modelica.Mechanics.Rotational.
SpeedIf parameter exact=false, the filter was wrong
- (position was filtered and not the speed input signal)
-

-Other changes: -

- -")); -end Version_2_1; - -class Version_1_6 "Version 1.6 (June 21, 2004)" - extends Modelica.Icons.ReleaseNotes; - - annotation (Documentation(info=" - -

Added 1 new library (Electrical.Polyphase), 17 new components, - improved 3 existing components - in the Modelica.Electrical library and improved 3 types - in the Modelica.SIunits library. Furthermore, - this User's Guide has been started. The improvements - in more detail: -

-

-New components -

- - - - - - - - - - - - - - - - - - - - - - - - -
Modelica.Electrical.Analog.Basic.
SaturatingInductorSimple model of an inductor with saturation
VariableResistorIdeal linear electrical resistor with variable resistance
VariableConductorIdeal linear electrical conductor with variable conductance
VariableCapacitorIdeal linear electrical capacitor with variable capacitance
VariableInductorIdeal linear electrical inductor with variable inductance
Modelica.Electrical.Analog.Semiconductors.
HeatingDiodeSimple diode with heating port
HeatingNMOSSimple MOS Transistor with heating port
HeatingPMOSSimple PMOS Transistor with heating port
HeatingNPNSimple NPN BJT according to Ebers-Moll with heating port
HeatingPNPSimple PNP BJT according to Ebers-Moll with heating port
Modelica.Electrical.Polyphase
- A new library for polyphase electrical circuits
-

-New examples -

-

-The following new examples have been added to -Modelica.Electrical.Analog.Examples: -

-

-CharacteristicThyristors, -CharacteristicIdealDiodes, -HeatingNPN_OrGate, -HeatingMOSInverter, -HeatingRectifier, -Rectifier, -ShowSaturatingInductor -ShowVariableResistor -

-

-Improved existing components -

-

In the library Modelica.Electrical.Analog.Ideal, -a knee voltage has been introduced for the components -IdealThyristor, IdealGTOThyristor, IdealDiode in order -that the approximation of these ideal elements is improved -with not much computational effort.

-

In the Modelica.SIunits library, the following changes - have been made:

- - - - - - - -
Inductancemin=0 removed
SelfInductancemin=0 added
ThermodynamicTemperaturemin=0 added
-")); -end Version_1_6; - -class Version_1_5 "Version 1.5 (Dec. 16, 2002)" - extends Modelica.Icons.ReleaseNotes; - - annotation (Documentation(info=" - -

Added 55 new components. In particular, added new package - Thermal.HeatTransfer for modeling of lumped - heat transfer, added model LossyGear in Mechanics.Rotational - to model gear efficiency and bearing friction according to a new - theory in a robust way, added 10 new models in Electrical.Analog and - added several other new models and improved existing models. -

-

-New components -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Modelica.Blocks.
Continuous.DerDerivative of input (= analytic differentiations)
ExamplesDemonstration examples of the components of this package
Nonlinear.VariableLimiterLimit the range of a signal with variable limits
Modelica.Blocks.Interfaces.
RealPortReal port (both input/output possible)
IntegerPortInteger port (both input/output possible)
BooleanPortBoolean port (both input/output possible)
SIMOSingle Input Multiple Output continuous control block
IntegerBlockIconBasic graphical layout of Integer block
IntegerMOMultiple Integer Output continuous control block
IntegerSignalSourceBase class for continuous Integer signal source
IntegerMIBooleanMOsMultiple Integer Input Multiple Boolean Output continuous control block with same number of inputs and outputs
BooleanMIMOsMultiple Input Multiple Output continuous control block with same number of inputs and outputs of Boolean type
BusAdaptorsComponents to send signals to the bus or receive signals from the bus
Modelica.Blocks.Math.
RealToIntegerConvert real to integer signals
IntegerToRealConvert integer to real signals
MaxPass through the largest signal
MinPass through the smallest signal
EdgeIndicates rising edge of Boolean signal
BooleanChangeIndicates Boolean signal changing
IntegerChangeIndicates integer signal changing
Modelica.Blocks.Sources.
IntegerConstantGenerate constant signals of type Integer
IntegerStepGenerate step signals of type Integer
Modelica.Electrical.Analog.Basic.
HeatingResistorTemperature dependent electrical resistor
OpAmpSimple nonideal model of an OpAmp with limitation
Modelica.Electrical.Analog.Ideal.
IdealCommutingSwitchIdeal commuting switch
IdealIntermediateSwitchIdeal intermediate switch
ControlledIdealCommutingSwitchControlled ideal commuting switch
ControlledIdealIntermediateSwitchControlled ideal intermediate switch
IdealOpAmpLimitedIdeal operational amplifier with limitation
IdealOpeningSwitchIdeal opener
IdealClosingSwitchIdeal closer
ControlledIdealOpeningSwitchControlled ideal opener
ControlledIdealClosingSwitchControlled ideal closer
Modelica.Electrical.Analog.Lines.
TLine1Lossless transmission line (Z0, TD)
TLine2Lossless transmission line (Z0, F, NL)
TLine2Lossless transmission line (Z0, F)
Modelica.Icons.
FunctionIcon for a function
RecordIcon for a record
EnumerationIcon for an enumeration
Modelica.Math.
tempInterpol2temporary routine for vectorized linear interpolation (will be removed)
Modelica.Mechanics.Rotational.
Examples.LossyGearDemo1Example to show that gear efficiency may lead to stuck motion
Examples.LossyGearDemo2Example to show combination of LossyGear and BearingFriction
LossyGearGear with mesh efficiency and bearing friction (stuck/rolling possible)
Gear2Realistic model of a gearbox (based on LossyGear)
Modelica.SIunits.
ConversionsConversion functions to/from non SI units and type definitions of non SI units
EnergyFlowRateSame definition as Power
EnthalpyFlowRateReal (final quantity=\"EnthalpyFlowRate\", final unit=\"W\")
Modelica.
Thermal.HeatTransfer1-dimensional heat transfer with lumped elements
ModelicaAdditions.Blocks.Discrete.
TriggeredSamplerTriggered sampling of continuous signals
TriggeredMaxCompute maximum, absolute value of continuous signal at trigger instants
ModelicaAdditions.Blocks.Logical.Interfaces.
BooleanMIRealMOsMultiple Boolean Input Multiple Real Output continuous control block with same number of inputs and outputs
RealMIBooleanMOsMultiple Real Input Multiple Boolean Output continuous control block with same number of inputs and outputs
ModelicaAdditions.Blocks.Logical.
TriggeredTrapezoidTriggered trapezoid generator
HysteresisTransform Real to Boolean with Hysteresis
OnOffControllerOn-off controller
CompareTrue, if signal of inPort1 is larger than signal of inPort2
ZeroCrossingTrigger zero crossing of input signal
ModelicaAdditions.
Blocks.Multiplexer.ExtractorExtract scalar signal out of signal vector dependent on IntegerRealInput index
Tables.CombiTable1DsTable look-up in one dimension (matrix/file) with only single input
-

-Package-specific Changes -

- -

-Class-specific Changes -

-

-Modelica.SIunits -

-

Removed final from quantity attribute for Mass and MassFlowRate.

-

-Modelica.Blocks.Math.Sum -

-

Implemented avoiding algorithm section, which would lead to expensive function calls.

-

Modelica.Blocks.Sources.Step

-
-block Step \"Generate step signals of type Real\"
-        parameter Real height[:]={1} \"Heights of steps\";
- // parameter Real offset[:]={0} \"Offsets of output signals\";
-// parameter SIunits.Time startTime[:]={0} \"Output = offset for time < startTime\";
-// extends Interfaces.MO          (final nout=max([size(height, 1); size(offset, 1); size(startTime, 1)]));
-        extends Interfaces.SignalSource(final nout=max([size(height, 1); size(offset, 1); size(startTime, 1)]));
-
-

Modelica.Blocks.Sources.Exponentials

-

Replaced usage of built-in function exp by Modelica.Math.exp.

-

Modelica.Blocks.Sources.TimeTable

-

Interface definition changed from

-
-parameter Real table[:, :]=[0, 0; 1, 1; 2, 4] \"Table matrix (time = first column)\";
-
-

to

-
-parameter Real table[:, 2]=[0, 0; 1, 1; 2, 4] \"Table matrix (time = first column)\";
-
-

Did the same for subfunction getInterpolationCoefficients.

-

Bug in getInterpolationCoefficients for startTime <> 0 fixed:

-
-...
-        end if;
-  end if;
-  // Take into account startTime \"a*(time - startTime) + b\"
-  b := b - a*startTime;
-end getInterpolationCoefficients;
-
-

Modelica.Blocks.Sources.BooleanStep

-
-block BooleanStep \"Generate step signals of type Boolean\"
-        parameter SIunits.Time startTime[:]={0} \"Time instants of steps\";
-        parameter Boolean startValue[size(startTime, 1)]=fill(false, size(startTime, 1)) \"Output before startTime\";
-        extends Interfaces.BooleanSignalSource(final nout=size(startTime, 1));
-equation
-        for i in 1:nout loop
-//   outPort.signal[i] = time >= startTime[i];
-          outPort.signal[i] = if time >= startTime[i] then not startValue[i] else startValue[i];
-        end for;
-end BooleanStep;
-
-

-Modelica.Electrical.Analog

-

Corrected table of values and default for Beta by dividing them by 1000 -(consistent with the values used in the NAND-example model): -

- -

Corrected parameter defaults, unit and description for TrapezoidCurrent. -This makes the parameters consistent with their use in the model. -Models specifying parameter values are not changed. -Models not specifying parameter values did not generate trapezoids previously. -

-

Icon layer background changed from transparent to white:

- -

Basic.Transformer: Replaced invalid escape characters '\\ ' and '\\[newline]' in documentation by '|'.

-

Modelica.Mechanics.Rotational

-

Removed arrows and names documentation from flanges in diagram layer

-

Modelica.Mechanics.Rotational.Interfaces.FrictionBase

-

Modelica.Mechanics.Rotational.Position

-

Replaced reinit by initial equation

-

Modelica.Mechanics.Rotational.RelativeStates

-

Bug corrected by using modifier stateSelect = StateSelect.prefer as implementation

-

Modelica.Mechanics.Translational.Interfaces.flange_b

-

Attribute fillColor=7 added to Rectangle on Icon layer, i.e., it is now -filled with white and not transparent any more.

-

Modelica.Mechanics.Translational.Position

-

Replaced reinit by initial equation

-

Modelica.Mechanics.Translational.RelativeStates

-

Bug corrected by using modifier stateSelect = StateSelect.prefer as implementation

-

Modelica.Mechanics.Translational.Stop

-

Use stateSelect = StateSelect.prefer.

-

Modelica.Mechanics.Translational.Examples.PreLoad

-

Improved documentation and coordinate system used for example.

-

ModelicaAdditions.Blocks.Nonlinear.PadeDelay

-

Replaced reinit by initial equation

-

ModelicaAdditions.HeatFlow1D.Interfaces

-

Definition of connectors Surface_a and Surface_b:
-flow SIunits.HeatFlux q; changed to flow SIunits.HeatFlowRate q;

-

MultiBody.Parts.InertialSystem

-

Icon corrected.

-")); -end Version_1_5; - -class Version_1_4 "Version 1.4 (June 28, 2001)" - extends Modelica.Icons.ReleaseNotes; - -annotation (Documentation(info=" - - -
-

Version 1.4.1beta1 (February 12, 2001)

-

Adapted to Modelica 1.4

-
-

Version 1.3.2beta2 (June 20, 2000)

- -
-

Version 1.3.1 (Dec. 13, 1999)

-

-First official release of the library. -

-")); -end Version_1_4; - annotation (Documentation(info=" - -

-This section summarizes the changes that have been performed -on the Modelica standard library. Furthermore, it is explained in -Modelica.UsersGuide.ReleaseNotes.VersionManagement -how the versions are managed. -This is especially important for maintenance (bug fix) releases where the -main version number is not changed. -

- - - - - - - - - - - - - - - - - - -
Version 4.1.0March 15, 2024
Version 4.0.0June 4, 2020
Version 3.2.3January 23, 2019
Version 3.2.2April 3, 2016
Version 3.2.1August 14, 2013
Version 3.2Oct. 25, 2010
Version 3.1August 14, 2009
Version 3.0.1Jan. 27, 2009
Version 3.0March 1, 2008
Version 2.2.2Aug. 31, 2007
Version 2.2.1March 24, 2006
Version 2.2April 6, 2005
Version 2.1Nov. 11, 2004
Version 1.6June 21, 2004
Version 1.5Dec. 16, 2002
Version 1.4June 28, 2001
-")); -end ReleaseNotes; - -class Contact "Contact" - extends Modelica.Icons.Contact; - - annotation (Documentation(info=" -
The Modelica Standard Library (this Modelica package) is developed by contributors from different organizations (see list below). It is licensed under the BSD 3-Clause License by:
-

-
Modelica Association
-
(Ideella Föreningar 822003-8858 in Linköping)
-
c/o PELAB, IDA, Linköpings Universitet
-
S-58183 Linköping
-
Sweden
-
email: Board@Modelica.org
-
web: https://www.Modelica.org
-

- -
The development of this Modelica package, starting with version 3.2.3, is organized by:
-
Thomas Beutlich and Dietmar Winkler
-

- -
The development of this Modelica package of version 3.2.2 was organized by:
-
Anton Haumer
-
Technical Consulting & Electrical Engineering
-
D-93049 Regensburg
-
Germany
-
email: A.Haumer@Haumer.at
-

- -
The development of this Modelica package up to and including version 3.2.1 was organized by:
-
Martin Otter
-
Deutsches Zentrum für Luft- und Raumfahrt (DLR)
-
Institut für Systemdynamik und Regelungstechnik (SR)
-
Münchener Straße 20
-
D-82234 Weßling
-
Germany
-
email: Martin.Otter@dlr.de
-
-

Since end of 2007, the development of the sublibraries of package Modelica is organized by personal and/or organizational library officers assigned by the Modelica Association. They are responsible for the maintenance and for the further organization of the development. Other persons may also contribute, but the final decision for library improvements and/or changes is performed by the responsible library officer(s). In order that a new sublibrary or a new version of a sublibrary is ready to be released, the responsible library officers report the changes to the members of the Modelica Association and the library is made available for beta testing to interested parties before a final decision. A new release of a sublibrary is formally decided by voting of the Modelica Association members.

-

As of March 7th, 2020, the following library officers are assigned:

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Sublibraries Library officers
UsersGuideChristian Kral, Jakub Tobolar
BlocksMartin Otter, Anton Haumer
ClockedChristoff Bürger, Bernhard Thiele
ComplexBlocksAnton Haumer, Christian Kral
Blocks.TablesThomas Beutlich, Martin Otter, Anton Haumer
StateGraphHans Olsson, Martin Otter
Electrical.AnalogChristoph Clauss, Anton Haumer, Christian Kral, Kristin Majetta
Electrical.BatteriesAnton Haumer, Christian Kral
Electrical.DigitalChristoph Clauss, Kristin Majetta
Electrical.MachinesAnton Haumer, Christian Kral
Electrical.PolyphaseAnton Haumer, Christian Kral
Electrical.PowerConvertersChristian Kral, Anton Haumer
Electrical.QuasiStaticAnton Haumer, Christian Kral
Electrical.Spice3Christoph Clauss, Kristin Majetta, Joe Riel
Magnetic.FluxTubesThomas Bödrich, Anton Haumer, Christian Kral, Johannes Ziske
Magnetic.FundamentalWaveAnton Haumer, Christian Kral
Magnetic.QuasiStaticAnton Haumer, Christian Kral
Mechanics.MultiBodyMartin Otter, Jakub Tobolar
Mechanics.RotationalAnton Haumer, Christian Kral, Martin Otter, Jakub Tobolar
Mechanics.TranslationalAnton Haumer, Christian Kral, Martin Otter, Jakub Tobolar
FluidFrancesco Casella, Rüdiger Franke, Hubertus Tummescheit
Fluid.DissipationFrancesco Casella, Stefan Wischhusen
MediaFrancesco Casella, Rüdiger Franke, Hubertus Tummescheit
Thermal.FluidHeatFlowAnton Haumer, Christian Kral
Thermal.HeatTransferAnton Haumer, Christian Kral
MathHans Olsson, Martin Otter
ComplexMathAnton Haumer, Christian Kral, Martin Otter
UtilitiesDag Brück, Hans Olsson, Martin Otter
ConstantsHans Olsson, Martin Otter
IconsChristian Kral, Jakub Tobolar
UnitsChristian Kral, Martin Otter
C-SourcesThomas Beutlich, Hans Olsson, Martin Sjölund
ReferenceHans Olsson, Dietmar Winkler
ServicesHans Olsson, Martin Otter
ComplexAnton Haumer, Christian Kral
TestLeo Gall, Martin Otter
TestOverdeterminedLeo Gall, Martin Otter
TestConversion4Leo Gall, Martin Otter
ObsoleteModelica4Hans Olsson, Martin Otter
- -

-The following people have directly contributed to the implementation -of the Modelica package (many more people have contributed to the design): -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Marcus Baurpreviously at:
Institute of System Dynamics and Control
- DLR, German Aerospace Center,
- Oberpfaffenhofen, Germany		Complex
- Modelica.Math.Vectors
- Modelica.Math.Matrices
Peter BeaterUniversity of Paderborn, GermanyModelica.Mechanics.Translational
Thomas Beutlichpreviously at:
ESI ITI GmbH, Germany		Modelica.Blocks.Sources.CombiTimeTable
- Modelica.Blocks.Tables
Thomas BödrichDresden University of Technology, GermanyModelica.Magnetic.FluxTubes
Dag BrückDassault Systèmes AB, Lund, SwedenModelica.Utilities
Francesco CasellaPolitecnico di Milano, Milano, ItalyModelica.Fluid
- Modelica.Media
Christoph Claussuntil 2016:
- Fraunhofer Institute for Integrated Circuits,
- Dresden, Germany		Modelica.Electrical.Analog
- Modelica.Electrical.Digital
- Modelica.Electrical.Spice3
Jonas EbornModelon AB, Lund, SwedenModelica.Media
Hilding ElmqvistMogram AB, Lund, Sweden
- until 2015:
- Dassault Systèmes AB, Lund, Sweden		Modelica.Mechanics.MultiBody
- Modelica.Fluid
- Modelica.Media
- Modelica.StateGraph
- Modelica.Utilities
- Conversion from 1.6 to 2.0
Rüdiger FrankeABB Corporate Research,
Ladenburg, Germany		Modelica.Fluid
- Modelica.Media
Manuel GräberInstitut für Thermodynamik,
- Technische Universität Braunschweig, Germany		Modelica.Fluid
Anton HaumerConsultant, Regensburg,
Germany		Modelica.ComplexBlocks
- Modelica.Electrical.Machines
- Modelica.Electrical.Polyphase
- Modelica.Electrical.QuasiStatic
- Modelica.Magnetics.FundamentalWave
- Modelica.Mechanics.Rotational
- Modelica.Mechanics.Translational
- Modelica.Thermal.FluidHeatFlow
- Modelica.Thermal.HeatTransfer
- Modelica.ComplexMath
- Conversion from 1.6 to 2.0
- Conversion from 2.2 to 3.0
Hans-Dieter Joospreviously at:
Institute of System Dynamics and Control
- DLR, German Aerospace Center,
- Oberpfaffenhofen, Germany		Modelica.Math.Matrices
Christian KralModeling and Simulation of Electric Machines, Drives and Mechatronic Systems,
- Vienna, Austria		Modelica.ComplexBlocks
- Modelica.Electrical.Machines
- Modelica.Electrical.Polyphase
- Modelica.Electrical.QuasiStatic
- Modelica.Magnetics.FundamentalWave
- Modelica.Mechanics.Rotational
- Modelica.Mechanics.Translational
- Modelica.Thermal.FluidHeatFlow
- Modelica.Thermal.HeatTransfer
- Modelica.ComplexMath -
Sven Erik Mattssonuntil 2015:
- Dassault Systèmes AB, Lund, Sweden		Modelica.Mechanics.MultiBody
Hans OlssonDassault Systèmes AB, Lund, SwedenModelica.Blocks
- Modelica.Math.Matrices
- Modelica.Utilities
- Conversion from 1.6 to 2.0
- Conversion from 2.2 to 3.0
Martin OtterInstitute of System Dynamics and Control
- DLR, German Aerospace Center,
- Oberpfaffenhofen, Germany		Complex
- Modelica.Blocks
- Modelica.Fluid
- Modelica.Mechanics.MultiBody
- Modelica.Mechanics.Rotational
- Modelica.Mechanics.Translational
- Modelica.Math
- Modelica.ComplexMath
- Modelica.Media
- Modelica.SIunits
- Modelica.StateGraph
- Modelica.Thermal.HeatTransfer
- Modelica.Utilities
- ModelicaReference
- Conversion from 1.6 to 2.0
- Conversion from 2.2 to 3.0
Katrin Prölßpreviously at:
Modelon Deutschland GmbH, Hamburg, Germany
- until 2008:
- Department of Technical Thermodynamics,
- Technical University Hamburg-Harburg,
Germany		Modelica.Fluid
- Modelica.Media
Christoph C. Richteruntil 2009:
- Institut für Thermodynamik,
- Technische Universität Braunschweig,
- Germany		Modelica.Fluid
- Modelica.Media
André SchneiderFraunhofer Institute for Integrated Circuits,
Dresden, Germany		Modelica.Electrical.Analog
- Modelica.Electrical.Digital
Christian Schweigeruntil 2006:
- Institute of System Dynamics and Control,
- DLR, German Aerospace Center,
- Oberpfaffenhofen, Germany		Modelica.Mechanics.Rotational
- ModelicaReference
- Conversion from 1.6 to 2.0
Michael SielemannModelon Deutschland GmbH, Munich, Germany
- previously at:
- Institute of System Dynamics and Control
- DLR, German Aerospace Center,
- Oberpfaffenhofen, Germany		Modelica.Fluid
- Modelica.Media
Michael TillerXogeny Inc., Canton, MI, U.S.A.
- previously at:
- Emmeskay, Inc., Dearborn, MI, U.S.A.
- previously at:
- Ford Motor Company, Dearborn, MI, U.S.A.		Modelica.Media
- Modelica.Thermal.HeatTransfer
Hubertus TummescheitModelon, Inc., Hartford, CT, U.S.A.Modelica.Media
- Modelica.Thermal.HeatTransfer
Thorsten Vahlenkampuntil 2010:
- XRG Simulation GmbH, Hamburg, Germany		Modelica.Fluid.Dissipation
Nico WalterMaster thesis at HTWK Leipzig
- (Prof. R. Müller) and
- DLR Oberpfaffenhofen, Germany		Modelica.Math.Matrices
Michael WetterLawrence Berkeley National Laboratory, Berkeley, CA, U.S.A.Modelica.Fluid
Hans-Jürg WiesmannSwitzerlandModelica.ComplexMath
Stefan WischhusenXRG Simulation GmbH, Hamburg, GermanyModelica.Fluid.Dissipation
- Modelica.Media
- -")); - -end Contact; - -annotation (DocumentationClass=true, Documentation(info=" -

-Package Modelica is a standardized and pre-defined package -that is developed together with the Modelica language from the -Modelica Association, see -https://www.Modelica.org. -It is also called Modelica Standard Library. -It provides constants, types, connectors, partial models and model -components in various disciplines. -

-

-This is a short User's Guide for -the overall library. Some of the main sublibraries have their own -User's Guides that can be accessed by the following links: -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ComplexBlocksLibrary of basic input/output control blocks with Complex signals
Digital - Library for digital electrical components based on the VHDL standard - (2-,3-,4-,9-valued logic)
DissipationLibrary of functions for convective heat transfer and pressure loss characteristics
FluidLibrary of 1-dim. thermo-fluid flow models using the Modelica.Media media description
FluidHeatFlowLibrary of simple components for 1-dimensional incompressible thermo-fluid flow models
FluxTubes - Library for modelling of electromagnetic devices with lumped magnetic networks
FundamentalWaveLibrary for magnetic fundamental wave effects in electric machines
FundamentalWaveLibrary for quasi-static fundamental wave electric machines
MachinesLibrary for electric machines
Media - Library of media property models
MultiBody - Library to model 3-dimensional mechanical systems
PolyphaseLibrary for electrical components of one or more phases
PowerConvertersLibrary for rectifiers, inverters and DC/DC converters
QuasiStaticLibrary for quasi-static electrical single-phase and polyphase AC simulation
Rotational - Library to model 1-dimensional, rotational mechanical systems
Spice3Library for components of the Berkeley SPICE3 simulator
StateGraph - Library to model discrete event and reactive systems by hierarchical state machines
Translational - Library to model 1-dimensional, translational mechanical systems
Units Library of type definitions
Utilities - Library of utility functions especially for scripting (Files, Streams, Strings, System)
- -")); -end UsersGuide; - annotation ( preferredView="info", version="4.1.0",