Skip to content

Commit

Permalink
Merge pull request #59 from tbeu/fix-dummy-annotations
Browse files Browse the repository at this point in the history
Fix dummy annotations
  • Loading branch information
Franciscus van der Linden committed Nov 20, 2014
2 parents 844e9e7 + f9a6360 commit d81e808
Show file tree
Hide file tree
Showing 33 changed files with 583 additions and 644 deletions.
48 changes: 24 additions & 24 deletions PlanarMechanics/Examples/FreeBody.mo
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
within PlanarMechanics.Examples;
model FreeBody "A simple free falling body"
extends Modelica.Icons.Example;

inner PlanarWorld planarWorld
annotation (Placement(transformation(extent={{-30,-10},{-10,10}})));
Parts.Body body(m=1, I=0.1,
animate=true,
a(each fixed=false),
r(each fixed=true),
v(each fixed=true),
phi(fixed=true),
w(fixed=true))
annotation (Placement(transformation(extent={{10,-10},{30,10}})));
annotation (
experiment(StopTime=3),
Documentation(revisions="<html>
<p><img src=\"modelica://PlanarMechanics/Resources/Images/dlr_logo.png\"/> <b>Developed 2010-2014 at the DLR Institute of System Dynamics and Control</b></p></html>",
info="<html>
<p>The gravity is defined in the planarWorld component</p>
<p><img src=\"modelica://PlanarMechanics/Resources/Images/FreeBody_1.png\"/></p>
<p>The DAE has 73&nbsp;scalar unknowns and 73&nbsp;scalar equations.</p>
</html>"));
end FreeBody;
within PlanarMechanics.Examples;
model FreeBody "A simple free falling body"
extends Modelica.Icons.Example;

inner PlanarWorld planarWorld
annotation (Placement(transformation(extent={{-30,-10},{-10,10}})));
Parts.Body body(m=1, I=0.1,
animate=true,
a(each fixed=false),
r(each fixed=true),
v(each fixed=true),
phi(fixed=true),
w(fixed=true))
annotation (Placement(transformation(extent={{10,-10},{30,10}})));
annotation (
experiment(StopTime=3),
Documentation(revisions="<html>
<p><img src=\"modelica://PlanarMechanics/Resources/Images/dlr_logo.png\"/> <b>Developed 2010-2014 at the DLR Institute of System Dynamics and Control</b></p></html>",
info="<html>
<p>The gravity is defined in the planarWorld component</p>
<p><img src=\"modelica://PlanarMechanics/Resources/Images/FreeBody_1.png\"/></p>
<p>The DAE has 73&nbsp;scalar unknowns and 73&nbsp;scalar equations.</p>
</html>"));
end FreeBody;
4 changes: 1 addition & 3 deletions PlanarMechanics/Examples/InvertedCraneCrab.mo
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,5 @@ equation
<li>revolute.phi</li>
</ul>
</html>"),
experiment(StopTime=3),
Diagram(coordinateSystem(preserveAspectRatio=false, extent={{-100,-100},{
100,100}}), graphics));
experiment(StopTime=3));
end InvertedCraneCrab;
6 changes: 2 additions & 4 deletions PlanarMechanics/Examples/Pendulum.mo
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@ equation
connect(revolute.frame_a, fixed.frame) annotation (Line(
points={{-40,0},{-46,0},{-46,-1.22125e-015},{-50,-1.22125e-015}},
color={95,95,95},
thickness=0.5,
smooth=Smooth.None));
thickness=0.5));
annotation (experiment(StopTime=3),
Documentation(revisions="<html><p><img src=\"modelica://PlanarMechanics/Resources/Images/dlr_logo.png\"/> <b>Developed 2010-2014 at the DLR Institute of System Dynamics and Control</b></p></html>", info="<html>
<p><img src=\"modelica://PlanarMechanics/Resources/Images/Pendulum_1.png\"/></p>
Expand All @@ -43,6 +42,5 @@ equation
<li>revolute.phi</li>
<li>revolute.w</li>
</ul>
</html>"),
Diagram(graphics));
</html>"));
end Pendulum;
2 changes: 1 addition & 1 deletion PlanarMechanics/Examples/package.mo
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ package Examples "Collection of introductory examples"
</html>",
info="<html>
<p>
This package is a collection of simulatable examples which show the use of the library models and elements.
This package is a collection of simulatable examples which show the use of the library models and elements.
</p>
</html>"));
end Examples;
80 changes: 40 additions & 40 deletions PlanarMechanics/GearComponents/Examples/PlanetaryGear.mo
Original file line number Diff line number Diff line change
@@ -1,40 +1,40 @@
within PlanarMechanics.GearComponents.Examples;
model PlanetaryGear "Rigid planetary gearbox"
extends Modelica.Icons.Example;

Utilities.RigidNoLossPlanetary planetary(
useHeatPort=true,
r_s=1,
r_p=1,
r_r=3,
J_s=1e-3,
J_p=1e-3,
J_c=1e-3,
J_r=1e-3)
annotation (Placement(transformation(extent={{0,0},{40,40}})));
Modelica.Thermal.HeatTransfer.Components.HeatCapacitor heatCapacitor(C=1)
annotation (Placement(transformation(extent={{-10,-10},{10,10}},
rotation=90,
origin={-20,-30})));
Modelica.Mechanics.Rotational.Sources.ConstantSpeed SunSpeed(w_fixed=1)
annotation (Placement(transformation(extent={{-50,0},{-30,20}})));
Modelica.Mechanics.Rotational.Sources.ConstantTorque RingTorque(tau_constant=
1) annotation (Placement(transformation(extent={{-50,30},{-30,50}})));
equation
connect(heatCapacitor.port, planetary.heatPort) annotation (Line(
points={{-10,-30},{0,-30},{0,0}},
color={191,0,0}));
connect(planetary.flange_Sun,SunSpeed. flange) annotation (Line(
points={{0,20},{-10,20},{-10,10},{-30,10}}));
connect(RingTorque.flange, planetary.flange_Ring) annotation (Line(
points={{-30,40},{-10,40},{-10,32},{0,32}}));
annotation (Documentation(info="<html>
<p>The model shows the possibilities of the gear connection models.
In this example only one of 3 planets is modelled. This reduction can be done because of the symmetry of the gears. For more advanced topics like load sharing between gears, more advanced models should be used.</p>
<p>
The ring gear is driven using a 1&nbsp;Nm load, the velocity of the sun is fixed to 1&nbsp;rad/s.
</p>
</html>", revisions=
"<html><p><img src=\"modelica://PlanarMechanics/Resources/Images/dlr_logo.png\"/> <b>Developed 2010-2014 at the DLR Institute of System Dynamics and Control</b></p></html>"),
experiment(StopTime=10));
end PlanetaryGear;
within PlanarMechanics.GearComponents.Examples;
model PlanetaryGear "Rigid planetary gearbox"
extends Modelica.Icons.Example;

Utilities.RigidNoLossPlanetary planetary(
useHeatPort=true,
r_s=1,
r_p=1,
r_r=3,
J_s=1e-3,
J_p=1e-3,
J_c=1e-3,
J_r=1e-3)
annotation (Placement(transformation(extent={{0,0},{40,40}})));
Modelica.Thermal.HeatTransfer.Components.HeatCapacitor heatCapacitor(C=1)
annotation (Placement(transformation(extent={{-10,-10},{10,10}},
rotation=90,
origin={-20,-30})));
Modelica.Mechanics.Rotational.Sources.ConstantSpeed SunSpeed(w_fixed=1)
annotation (Placement(transformation(extent={{-50,0},{-30,20}})));
Modelica.Mechanics.Rotational.Sources.ConstantTorque RingTorque(tau_constant=
1) annotation (Placement(transformation(extent={{-50,30},{-30,50}})));
equation
connect(heatCapacitor.port, planetary.heatPort) annotation (Line(
points={{-10,-30},{0,-30},{0,0}},
color={191,0,0}));
connect(planetary.flange_Sun,SunSpeed. flange) annotation (Line(
points={{0,20},{-10,20},{-10,10},{-30,10}}));
connect(RingTorque.flange, planetary.flange_Ring) annotation (Line(
points={{-30,40},{-10,40},{-10,32},{0,32}}));
annotation (Documentation(info="<html>
<p>The model shows the possibilities of the gear connection models.
In this example only one of 3 planets is modelled. This reduction can be done because of the symmetry of the gears. For more advanced topics like load sharing between gears, more advanced models should be used.</p>
<p>
The ring gear is driven using a 1&nbsp;Nm load, the velocity of the sun is fixed to 1&nbsp;rad/s.
</p>
</html>", revisions=
"<html><p><img src=\"modelica://PlanarMechanics/Resources/Images/dlr_logo.png\"/> <b>Developed 2010-2014 at the DLR Institute of System Dynamics and Control</b></p></html>"),
experiment(StopTime=10));
end PlanetaryGear;
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
within PlanarMechanics.GearComponents.Examples.Utilities.Interfaces;
partial model PlanetaryGearInterface "Planetary gear interface"
extends PlanarMechanics.Utilities.Icons.PlanetaryGear;
extends Modelica.Thermal.HeatTransfer.Interfaces.PartialConditionalHeatPort;

Modelica.Mechanics.Rotational.Interfaces.Flange_b flange_Ring
"Flange of shaft"
annotation (Placement(transformation(extent={{-110,50},{-90,70}}),
iconTransformation(extent={{-110,50},{-90,70}})));
Modelica.Mechanics.Rotational.Interfaces.Flange_b flange_Sun
"Flange of shaft"
annotation (Placement(transformation(extent={{-110,-10},{-90,10}}),
iconTransformation(extent={{-110,-10},{-90,10}})));
Modelica.Mechanics.Rotational.Interfaces.Flange_a flange_Carrier
annotation (
Placement(transformation(extent={{90,-10},{110,10}}),iconTransformation(
extent={{90,-10},{110,10}})));
annotation (Documentation(revisions="<html>
<p><img src=\"modelica://PlanarMechanics/Resources/Images/dlr_logo.png\"/> <b>Developed 2010-2014 at the DLR Institute of System Dynamics and Control</b></p>
</html>", info="<html>
<p>This partial class contains common interfaces for a planetary gear model.</p>
</html>"));
end PlanetaryGearInterface;
within PlanarMechanics.GearComponents.Examples.Utilities.Interfaces;
partial model PlanetaryGearInterface "Planetary gear interface"
extends PlanarMechanics.Utilities.Icons.PlanetaryGear;
extends Modelica.Thermal.HeatTransfer.Interfaces.PartialConditionalHeatPort;

Modelica.Mechanics.Rotational.Interfaces.Flange_b flange_Ring
"Flange of shaft"
annotation (Placement(transformation(extent={{-110,50},{-90,70}}),
iconTransformation(extent={{-110,50},{-90,70}})));
Modelica.Mechanics.Rotational.Interfaces.Flange_b flange_Sun
"Flange of shaft"
annotation (Placement(transformation(extent={{-110,-10},{-90,10}}),
iconTransformation(extent={{-110,-10},{-90,10}})));
Modelica.Mechanics.Rotational.Interfaces.Flange_a flange_Carrier
annotation (
Placement(transformation(extent={{90,-10},{110,10}}),iconTransformation(
extent={{90,-10},{110,10}})));
annotation (Documentation(revisions="<html>
<p><img src=\"modelica://PlanarMechanics/Resources/Images/dlr_logo.png\"/> <b>Developed 2010-2014 at the DLR Institute of System Dynamics and Control</b></p>
</html>", info="<html>
<p>This partial class contains common interfaces for a planetary gear model.</p>
</html>"));
end PlanetaryGearInterface;
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ package Utilities "Utility elements used for gear example models"
extends Modelica.Icons.UtilitiesPackage;


annotation (Icon(graphics), Documentation(info="<html>
annotation ( Documentation(info="<html>
<p>
This package contains auxiliary packages and elements to be only used in context with the examples of gear components.
</p>
Expand Down
2 changes: 1 addition & 1 deletion PlanarMechanics/GearComponents/Examples/package.mo
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ annotation (Documentation(revisions="<html>
<p><img src=\"modelica://PlanarMechanics/Resources/Images/dlr_logo.png\"/> <b>Developed 2010-2014 at the DLR Institute of System Dynamics and Control</b></p>
</html>", info="<html>
<p>
This package is a collection of simulatable models which show the usage of gear components.
This package is a collection of simulatable models which show the usage of gear components.
</p>
</html>"));
end Examples;
6 changes: 3 additions & 3 deletions PlanarMechanics/GearComponents/Examples/package.order
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
PlanetaryGear
SpurGear
Utilities
PlanetaryGear
SpurGear
Utilities
11 changes: 1 addition & 10 deletions PlanarMechanics/GearComponents/RigidNoLossExternal.mo
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@ protected

MB.Visualizers.Advanced.Shape pointA(
shapeType="cylinder",
color={0,0,0},
specularCoefficient=0.5,
length=0.15,
width=r_a/10,
Expand All @@ -74,7 +73,6 @@ protected

MB.Visualizers.Advanced.Shape pointB(
shapeType="cylinder",
color={0,0,0},
specularCoefficient=0.5,
length=0.15,
width=r_a/10,
Expand Down Expand Up @@ -217,7 +215,6 @@ equation
47.6059},{24.5443,47.9909},{26.559,43.6734},{26.9421,41.7643},{
29.9832,41.8761},{30.2251,43.8082},{31.9173,48.2619},{34.6414,
48.0765},{35.7144,43.4344},{35.6922,41.4874}},
smooth=Smooth.None,
fillColor={255,0,0},
fillPattern=FillPattern.Solid,
pattern=LinePattern.None),
Expand Down Expand Up @@ -266,22 +263,16 @@ equation
-47.8875,25.9962},{-47.2592,23.6526},{-44.1521,23.8756},{-43.865,
26.2849},{-42.8073,29.0581},{-42.0308,30.2359},{-39.75,30.0005},{
-39.2305,28.6889},{-38.7618,25.758},{-38.973,23.3409}},
smooth=Smooth.None,
fillColor={255,160,160},
fillPattern=FillPattern.Solid,
lineThickness=0.5,
pattern=LinePattern.None),
Line(
points={{-100,0},{-44,0}},
color={0,0,0},
smooth=Smooth.None,
thickness=1),
Line(
points={{30,0},{100,0}},
color={0,0,0},
smooth=Smooth.None,
thickness=1)}), Icon(graphics),
Documentation(revisions=
thickness=1)}), Documentation(revisions=
"<html><p><img src=\"modelica://PlanarMechanics/Resources/Images/dlr_logo.png\"/> <b>Developed 2010-2014 at the DLR Institute of System Dynamics and Control</b> </p></html>",
info="<html>
<p>In this model an ideal gear connection is modelled. It is based on the paper from van der Linden , <a href=\"http://dx.doi.org/10.3384/ecp12076303\">Modelling of Elastic Gearboxes Using a Generalized Gear Contact Model</a>. However, no gear elasticity is modelled.</p>
Expand Down
11 changes: 1 addition & 10 deletions PlanarMechanics/GearComponents/RigidNoLossInternal.mo
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,6 @@ protected

MB.Visualizers.Advanced.Shape pointA(
shapeType="cylinder",
color={0,0,0},
specularCoefficient=0.5,
length=0.15,
width=r_a/10,
Expand All @@ -74,7 +73,6 @@ protected

MB.Visualizers.Advanced.Shape pointB(
shapeType="cylinder",
color={0,0,0},
specularCoefficient=0.5,
length=0.15,
width=r_a/10,
Expand Down Expand Up @@ -166,8 +164,6 @@ equation
annotation (defaultComponentName="gear",Diagram(graphics={
Line(
points={{38,0},{98,0}},
color={0,0,0},
smooth=Smooth.None,
thickness=1),
Polygon(
points={{8.6901,40.9645},{9.3284,42.8041},{11.9096,46.8087},{14.5357,
Expand Down Expand Up @@ -223,7 +219,6 @@ equation
-8.8881,42.8976},{-8.1588,47.6059},{-5.4557,47.9909},{-3.441,
43.6734},{-3.0579,41.7643},{-0.0168,41.8761},{0.2251,43.8082},{
1.9173,48.2619},{4.6414,48.0765},{5.7144,43.4344},{5.6922,41.4874}},
smooth=Smooth.None,
fillColor={255,0,0},
fillPattern=FillPattern.Solid,
pattern=LinePattern.None),
Expand Down Expand Up @@ -270,17 +265,13 @@ equation
28.59},{-21.8875,25.9962},{-21.2592,23.6526},{-18.1521,23.8756},{
-17.865,26.2849},{-16.8073,29.0581},{-16.0308,30.2359},{-13.75,
30.0005},{-13.2305,28.6889},{-12.7618,25.758},{-12.973,23.3409}},
smooth=Smooth.None,
fillColor={255,160,160},
fillPattern=FillPattern.Solid,
lineThickness=0.5,
pattern=LinePattern.None),
Line(
points={{-100,0},{-20,0}},
color={0,0,0},
smooth=Smooth.None,
thickness=1)}), Icon(graphics),
Documentation(revisions=
thickness=1)}), Documentation(revisions=
"<html><p><img src=\"modelica://PlanarMechanics/Resources/Images/dlr_logo.png\"/> <b>Developed 2010-2014 at the DLR Institute of System Dynamics and Control</b> </p></html>",
info="<html>
<p>In this model an ideal gear connection is modelled. It is based on the paper from van der Linden , <a href=\"http://dx.doi.org/10.3384/ecp12076303\">Modelling of Elastic Gearboxes Using a Generalized Gear Contact Model</a>. However, no gear elasticity is modelled.</p>
Expand Down
Loading

0 comments on commit d81e808

Please sign in to comment.