Skip to content

Commit ad956a3

Browse files
dietmarwdietmarw
committed
Generate release hierarchy from master
2 parents 1eee2c1 + 374afcd commit ad956a3

26 files changed

+767
-1208
lines changed

‎README.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,21 @@ Free library from the Modelica Association for interface definitions and archite
66

77
This Modelica library provides standard interface definitions for automotive subsystems and vehicle models. These are designed to promote compatibility between the various automotive libraries and provide a flexible, powerful structure for vehicle modelling. The main focus of the library is on defining the interfaces for the individual subsystems and a number of vehicle model examples are included to demonstrate how they might be used.
88

9-
![VehicleInterfaces](VehicleInterfaces 1.2.1/Resources/Images/conventionalVehicle.png)
9+
![VehicleInterfaces](VehicleInterfaces 1.2.2/Resources/Images/conventionalVehicle.png)
1010

1111
For an automotive library to be compatible with other libraries based on this set of interface definitions they should extend the interface definition from within this library and following the naming convention for the signal bus.
1212

1313
This library also contains a proposal for a naming convention covering the whole model library and the developers of this library would recommend that this convention is followed by other developers to ensure a consistent naming convention across the whole set of automotive models.
1414

1515
## Current release
1616

17-
Download [VehicleInterfaces v1.2.2 (2013-03-13)](../../archive/v1.2.2.zip)
17+
Download [VehicleInterfaces v1.2.2 (2014-06-30)](../../archive/v1.2.2.zip)
1818

1919
#### Release notes
2020

21-
* [Version v1.2.2 (2013-03-13)](../../archive/v1.2.2.zip)
21+
* [Version v1.2.2 (2014-06-30)](../../archive/v1.2.2.zip)
2222
* Further adaption to the conventions of the Modelica Specification 3.2 Revision 2, removal of Dymola specific visualization.
23+
* Clean-up of superfluous annotations and HTML syntax and links
2324
* [Version v1.2.1 (2013-10-01)](../../archive/v1.2.1.zip)
2425
* Adapted to the conventions of the *Modelica Standard Library 3.2.1*.
2526

‎VehicleInterfaces 1.2.2/Accessories.mo‎

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,19 @@ package Accessories "Collection of accessory subsystem definitions"
99
<p><b>Tutorial - Defining a new accessories model</b></p>
1010
<p>The following process will demonstrate how to create a new accessories model using these interface definitions. This tutorial will guide you through building an accessory subsystem with a power steering pump and alternator. Both will be modelled using speed dependant torque loss maps.</p>
1111
<ol>
12-
<li>Create a new model that extends <b>VehicleInterfaces.Accessories.Interfaces.Base</b>, it should look like this:</li>
13-
<br><br><img src=\"modelica://VehicleInterfaces/Resources/Images/buildNewAccessories1.png\"><br><br>
14-
<li>In the component browser, right click on <b>Base</b> and select <b>Parameters</b> from the context menu to produce the following parameter dialog:</li>
15-
<br><br><img src=\"modelica://VehicleInterfaces/Resources/Images/buildNewAccessories3.png\"><br><br>
12+
<li>Create a new model that extends <b>VehicleInterfaces.Accessories.Interfaces.Base</b>, it should look like this:
13+
<br><br><img src=\"modelica://VehicleInterfaces/Resources/Images/buildNewAccessories1.png\"><br><br></li>
14+
<li>In the component browser, right click on <b>Base</b> and select <b>Parameters</b> from the context menu to produce the following parameter dialog:
15+
<br><br><img src=\"modelica://VehicleInterfaces/Resources/Images/buildNewAccessories3.png\"><br><br></li>
1616
<li>This dialog allows you to enable/disable the optional bearing connectors within the engineFlange by setting <b>includeEngineBearing</b> as required.</li>
1717
<li>You can now define your accessory model as required</li>
1818
</ol>
1919
<h4>Adding an alternator and power steering pump</h4>
2020
<p>The following steps demonstrate how to create a simple accessories model. The subsystem will include an alternator and power steering pump that are modelled separately but both use speed-dependant torque loss maps.</p>
2121
<p>Starting from step 2 above.</p>
2222
<ol>
23-
<li>Add the following blocks and connections to the diagram.</li>
24-
<br><br><img src=\"modelica://VehicleInterfaces/Resources/Images/buildNewAccessories2.png\"><br><br>
23+
<li>Add the following blocks and connections to the diagram:
24+
<br><br><img src=\"modelica://VehicleInterfaces/Resources/Images/buildNewAccessories2.png\"><br><br></li>
2525
<li>Next, we need to check to see if any connections to the control signal bus are required for the driveline, see <a href=\"Modelica://VehicleInterfaces.UsersGuide.SignalBus\">a complete list</a> of the minimum connections required. In this case we don't need to add any signals to the control signal bus.</li>
2626
<li>The model is now complete and should check successfully and can be used in any model compatible with the VehicleInterfaces library</li>
2727
</ol>
@@ -36,8 +36,7 @@ package Accessories "Collection of accessory subsystem definitions"
3636
Modelica.Mechanics.MultiBody.Interfaces.FlangeWithBearing engineFlange(
3737
final includeBearingConnector=includeAccessoriesBearing or
3838
usingMultiBodyEngine) "Source of drive torque"
39-
annotation (Placement(transformation(extent={{90,-10},{110,10}},
40-
rotation=0)));
39+
annotation (Placement(transformation(extent={{90,-10},{110,10}})));
4140
Mechanics.MultiBody.MultiBodyEnd end_2(final includeBearingConnector=
4241
includeAccessoriesBearing or usingMultiBodyEngine)
4342
annotation (Placement(transformation(
@@ -71,7 +70,7 @@ package Accessories "Collection of accessory subsystem definitions"
7170
end Base;
7271
annotation (Documentation(info="<html>
7372
<p>
74-
A collection of partial base classes which define interfaces for accessories models.
73+
A collection of partial base classes which define interfaces for accessories models.
7574
</p>
7675
</html>"));
7776
end Interfaces;
@@ -81,11 +80,9 @@ A collection of partial base classes which define interfaces for accessories mod
8180
extends VehicleInterfaces.Icons.Empty;
8281
extends Interfaces.Base;
8382

84-
annotation (Diagram(coordinateSystem(preserveAspectRatio=false, extent={{-100,
85-
-100},{100,100}})),
86-
Documentation(info="<html>
83+
annotation ( Documentation(info="<html>
8784
<p>
88-
Empty accessories subsystem. Using this empty model in overall vehicle architecture the functionality of accessories subsystem can be eliminated.
85+
Empty accessories subsystem. Using this empty model in overall vehicle architecture the functionality of accessories subsystem can be eliminated.
8986
</p>
9087
</html>"));
9188
end NoAccessories;
@@ -105,16 +102,15 @@ Empty accessories subsystem. Using this empty model in overall vehicle architect
105102
Modelica.Mechanics.MultiBody.Parts.Rotor1D inertia(
106103
J=accessoriesInertia,
107104
n=axisOfRotation) annotation (Placement(transformation(extent={{20,-10},
108-
{40,10}}, rotation=0)));
105+
{40,10}})));
109106
Modelica.Mechanics.Rotational.Sources.ConstantTorque torqueLoss(
110107
tau_constant=accessoriesLoad,
111108
useSupport=includeAccessoriesBearing)
112109
annotation (Placement(transformation(extent={{-20,-10},
113-
{0,10}}, rotation=0)));
110+
{0,10}})));
114111
Modelica.Mechanics.MultiBody.Parts.Mounting1D torqueReaction(
115112
n=axisOfRotation) if includeAccessoriesBearing
116-
annotation (Placement(transformation(extent={{110,-20},{90,-40}},
117-
rotation=0)));
113+
annotation (Placement(transformation(extent={{110,-20},{90,-40}})));
118114
protected
119115
outer Modelica.Mechanics.MultiBody.World world;
120116
equation
@@ -133,9 +129,7 @@ Empty accessories subsystem. Using this empty model in overall vehicle architect
133129
points={{30,-10},{30,-20},{100,-20}},
134130
color={95,95,95},
135131
thickness=0.5));
136-
annotation (Diagram(coordinateSystem(preserveAspectRatio=true, extent={{-100,
137-
-100},{100,100}})),
138-
Documentation(info="<html>
132+
annotation ( Documentation(info="<html>
139133
<p>Simple accessory model with a single inertia and constant torque loss.</p>
140134
</html>"));
141135
end MinimalAccessories;

‎VehicleInterfaces 1.2.2/Atmospheres.mo‎

Lines changed: 39 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -10,68 +10,73 @@ package Atmospheres "Collection of atmosphere subsystem definitions"
1010
<p>This tutorial will guide you through the definition of the <b>ConstantAtmosphere</b> model.</p>
1111
<ol>
1212
<li>Start creating a new model by extending the base atmosphere definition which can be found at <b>VehicleInterfaces.Atmospheres.Interfaces.Base</b></li>
13-
<li>This base atmosphere definition includes 4 partial function definitions that we need to provide complete functions for in our new atmosphere model. The following functions need to be defined:</li>
13+
<li>This base atmosphere definition includes 4 partial function definitions that we need to provide complete functions for in our new atmosphere model. The following functions need to be defined:
1414
<ul>
1515
<li>windVelocity</li>
1616
<li>density</li>
1717
<li>temperature</li>
1818
<li>humidity</li>
19-
</ul>
19+
</ul></li>
2020
<li>Determine the model assumptions to be used. We will create a model with constant atmospheric conditions, i.e. fixed pressure, temperature, humidity and a constant wind. Create the following functions within the model created in step 1.</li>
21-
<li>Define the windVelocity function. This function is used to define the wind velocity based on the position relative to the world axis:</li>
22-
<br><br><pre>
23-
function constantWindVelocity
21+
<li>Define the windVelocity function. This function is used to define the wind velocity based on the position relative to the world axis:
22+
<pre>
23+
24+
function constantWindVelocity
2425
extends VehicleInterfaces.Atmospheres.Interfaces.Base.windVelocity;
2526
input Modelica.SIunits.Velocity[3] windVelocity;
26-
algorithm
27+
algorithm
2728
v := windVelocity;
2829
end constantWindVelocity;
29-
30-
</pre>
31-
<li>Define the density function. This function is used to define the density based on the position relative to the world axis:</li>
32-
<br><br><pre>
33-
function constantDensity \"Determine density\"
30+
31+
</pre></li>
32+
<li>Define the density function. This function is used to define the density based on the position relative to the world axis:
33+
<pre>
34+
35+
function constantDensity \"Determine density\"
3436
extends VehicleInterfaces.Atmospheres.Interfaces.Base.density;
3537
input Modelica.SIunits.Density density \"Density\";
36-
algorithm
38+
algorithm
3739
rho := density;
3840
end constantDensity;
39-
40-
</pre>
41-
<li>Define the temperature function. This function is used to define the temperature based on the position relative to the world axis:</li>
42-
<br><br><pre>
43-
function constantTemperature \"Determine temperature\"
41+
42+
</pre></li>
43+
<li>Define the temperature function. This function is used to define the temperature based on the position relative to the world axis:
44+
<pre>
45+
46+
function constantTemperature \"Determine temperature\"
4447
extends VehicleInterfaces.Atmospheres.Interfaces.Base.temperature;
4548
input Modelica.SIunits.Temperature T0 \"Constant temperature\";
46-
algorithm
49+
algorithm
4750
T := T0;
4851
end constantTemperature;
49-
50-
</pre>
51-
<li>Define the humidity function. This function is used to define the humidity based on the position relative to the world axis:</li>
52-
<br><br><pre>
53-
function constantHumidity \"Determine humidity\"
52+
53+
</pre></li>
54+
<li>Define the humidity function. This function is used to define the humidity based on the position relative to the world axis:
55+
<pre>
56+
57+
function constantHumidity \"Determine humidity\"
5458
extends VehicleInterfaces.Atmospheres.Interfaces.Base.humidity;
5559
input Real h0 \"Constant humidity\";
56-
algorithm
60+
algorithm
5761
h := h0;
5862
end constantTemperature;
59-
60-
</pre>
61-
<li>We now need to redeclare the functions in the base atmosphere definition to be the functions shown above. We do this with the following code assuming that the above functions have been defined within the class <b>ConstantAtmosphere</b>:</li>
62-
<br><br><pre>
63-
model ConstantAtmosphere \"Atmosphere with constant conditions\"
63+
64+
</pre></li>
65+
<li>We now need to redeclare the functions in the base atmosphere definition to be the functions shown above. We do this with the following code assuming that the above functions have been defined within the class <b>ConstantAtmosphere</b>:
66+
<pre>
67+
68+
model ConstantAtmosphere \"Atmosphere with constant conditions\"
6469
extends VehicleInterfaces.Atmospheres.Interfaces.Base(
6570
redeclare final function windVelocity = constantWindVelocity (windVelocity=v),
6671
redeclare final function density = constantDensity (density=rho),
6772
redeclare final function temperature = constantTemperature (T0=T),
6873
redeclare final function humidity = constantHumidity(h0=h));
69-
74+
7075
//Rest of model definition
7176
...
7277
end ConstantAtmosphere;
73-
74-
</pre>
78+
79+
</pre></li>
7580
<li>Adding these redeclares also means we need to add 4 parameters to the model <b>v</b>, <b>rho</b>, <b>h</b> and <b>T</b> which are the constant wind velocity, density, humidity and temperature respectively.</li>
7681
<li>This model is now complete and can be used. The ConstantAtmosphere definition included in VehicleInterfaces actually has pressure, temperature and wind velocity as it's parameters and automatically calculates the air density.</li>
7782
</ol>
@@ -172,7 +177,7 @@ Dummy model to demonstrate how the air humidity model should be defined and incl
172177
end Base;
173178
annotation (Documentation(info="<html>
174179
<p>
175-
A collection of base classes which define interfaces for atmosphere models.
180+
A collection of base classes which define interfaces for atmosphere models.
176181
</p>
177182
</html>"));
178183
end Interfaces;
@@ -231,8 +236,7 @@ A collection of base classes which define interfaces for atmosphere models.
231236
defaultComponentPrefixes="inner",
232237
Icon(coordinateSystem(preserveAspectRatio=false, extent={{-200,-100},{200,
233238
100}},
234-
grid={2,2},
235-
initialScale=0.1)),
239+
grid={2,2})),
236240
Documentation(info="<html>
237241
<p>
238242
This is the simplest atmosphere model with constant characteristics.

‎VehicleInterfaces 1.2.2/Blocks.mo‎

Lines changed: 12 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,13 @@ package Blocks "Collection of input/output fixed causality blocks"
66
extends Modelica.Blocks.Interfaces.BlockIcon;
77

88
Modelica.Blocks.Interfaces.RealInput u "Input signal"
9-
annotation (Placement(transformation(extent={{-140,-20},{-100,20}},
10-
rotation=0)));
9+
annotation (Placement(transformation(extent={{-140,-20},{-100,20}})));
1110
Modelica.Blocks.Interfaces.RealOutput y "Output signal"
12-
annotation (Placement(transformation(extent={{100,-10},{120,10}},
13-
rotation=0)));
11+
annotation (Placement(transformation(extent={{100,-10},{120,10}})));
1412
equation
1513
y = u;
1614

17-
annotation (Icon(coordinateSystem(preserveAspectRatio=false, extent={{-100,
18-
-100},{100,100}})),
19-
Documentation(info="<html>
15+
annotation ( Documentation(info="<html>
2016
<p>Passes a Real signal through without modification. Enables signals to be read out of one bus, have their name changed and be sent back to a bus.</p>
2117
</html>"));
2218
end RealPassThrough;
@@ -25,17 +21,13 @@ package Blocks "Collection of input/output fixed causality blocks"
2521
extends Modelica.Blocks.Interfaces.IntegerBlockIcon;
2622

2723
Modelica.Blocks.Interfaces.IntegerInput u "Input signal"
28-
annotation (Placement(transformation(extent={{-140,-20},{-100,20}},
29-
rotation=0)));
24+
annotation (Placement(transformation(extent={{-140,-20},{-100,20}})));
3025
Modelica.Blocks.Interfaces.IntegerOutput y "Output signal"
31-
annotation (Placement(transformation(extent={{100,-10},{120,10}},
32-
rotation=0)));
26+
annotation (Placement(transformation(extent={{100,-10},{120,10}})));
3327
equation
3428
y = u;
3529

36-
annotation (Icon(coordinateSystem(preserveAspectRatio=false, extent={{-100,
37-
-100},{100,100}})),
38-
Documentation(info="<html>
30+
annotation ( Documentation(info="<html>
3931
<p>Passes a Integer signal through without modification. Enables signals to be read out of one bus, have their name changed and be sent back to a bus.</p>
4032
</html>"));
4133
end IntegerPassThrough;
@@ -44,17 +36,13 @@ package Blocks "Collection of input/output fixed causality blocks"
4436
extends Modelica.Blocks.Interfaces.BooleanBlockIcon;
4537

4638
Modelica.Blocks.Interfaces.BooleanInput u "Input signal"
47-
annotation (Placement(transformation(extent={{-140,-20},{-100,20}},
48-
rotation=0)));
39+
annotation (Placement(transformation(extent={{-140,-20},{-100,20}})));
4940
Modelica.Blocks.Interfaces.BooleanOutput y "Output signal"
50-
annotation (Placement(transformation(extent={{100,-10},{120,10}},
51-
rotation=0)));
41+
annotation (Placement(transformation(extent={{100,-10},{120,10}})));
5242
equation
5343
y = u;
5444

55-
annotation (Diagram(coordinateSystem(preserveAspectRatio=false, extent={{-100,
56-
-100},{100,100}})),
57-
Documentation(info="<html>
45+
annotation ( Documentation(info="<html>
5846
<p>Passes a Boolean signal through without modification. Enables signals to be read out of one bus, have their name changed and be sent back to a bus.</p>
5947
</html>"));
6048
end BooleanPassThrough;
@@ -88,16 +76,14 @@ package Blocks "Collection of input/output fixed causality blocks"
8876
Line(points={{-90,-78},{76,-78}}, color={192,192,192}),
8977
Line(
9078
points={{-80,22},{32,-78}},
91-
color={0,0,0},
92-
smooth=Smooth.None),
79+
color={0,0,0}),
9380
Text(
9481
extent={{28,54},{98,30}},
9582
lineColor={95,95,95},
9683
textString="1..0"),
9784
Polygon(
9885
points={{-8,42},{28,42},{16,46},{16,38},{28,42},{-8,42}},
9986
lineColor={0,0,0},
100-
smooth=Smooth.None,
10187
fillColor={0,0,0},
10288
fillPattern=FillPattern.Solid)}),
10389
Diagram(coordinateSystem(
@@ -130,8 +116,7 @@ package Blocks "Collection of input/output fixed causality blocks"
130116
Text(extent={{-92,77},{-72,57}}, textString="1"),
131117
Line(
132118
points={{-58,64},{26,0}},
133-
color={0,0,0},
134-
smooth=Smooth.None)}),
119+
color={0,0,0})}),
135120
Documentation(info="<HTML>
136121
<p>
137122
This block is used to invert a normalized input signal u from [0..1] to [1..0].
@@ -140,7 +125,7 @@ Formally, the output <b>y</b> is computed as:
140125
<pre>
141126
y = 1 - u;
142127
</pre>
143-
128+
144129
</HTML>
145130
"));
146131
end InvertNormalizedInput;

0 commit comments

Comments
 (0)