OpenModelica/C3/Modelica-Packages/English - Revision history

Nancyvarkey at 08:41, 5 April 2016

2016-04-05T08:41:16Z

Show changes

Kaushik Datta at 17:40, 4 April 2016

2016-04-04T17:40:07Z

Kaushik Datta at 17:39, 4 April 2016

2016-04-04T17:39:10Z

Kaushik Datta at 17:21, 4 April 2016

2016-04-04T17:21:37Z

Kaushik Datta at 17:04, 4 April 2016

2016-04-04T17:04:58Z

Show changes

Kaushik Datta at 13:10, 4 April 2016

2016-04-04T13:10:02Z

Kaushik Datta: Created page with "{| border=1 ||'''Visual Cue''' ||'''Narration''' |- || Slide: '''Title Slide''' || Welcome to the Spoken Tutorial on '''Packages''' as a part of the spoken tutorial series o..."

2016-03-19T15:55:17Z

Created page with "{| border=1 ||'''Visual Cue''' ||'''Narration''' |- || Slide: '''Title Slide''' || Welcome to the Spoken Tutorial on '''Packages''' as a part of the spoken tutorial series o..."

New page

{| border=1
||'''Visual Cue'''
||'''Narration'''

|-
|| Slide:

'''Title Slide'''
|| Welcome to the Spoken Tutorial on '''Packages''' as a part of the spoken tutorial series on '''OpenModelica'''.

|-
|| Slide:

'''Learning Objectives'''
|| In this tutorial, we are going to learn:

* How to create a package of classes in '''Modelica'''.

* How to reference classes in a '''package'''.

* How to import a '''package'''.

* How to use '''Modelica Library'''.

|-
|| Slide:

'''System Requirements'''
|| To record this tutorial, I am using

* '''OpenModelica 1.9.2'''
* '''Ubuntu''' Operating System version '''14.04'''
* '''gedit'''.

'''Windows''' users may use '''Notepad''' instead of '''gedit'''.

|-
|| Slide:

'''Prerequisites'''
|| To practise this tutorial, you need

* Knowledge of '''class''' and '''type definition''' in '''Modelica'''.
* Prerequisite tutorials are mentioned on our website.

Please go through them.

|-
|| Slide:

'''Package'''
|| '''Package''' is a specialized class in '''Modelica'''.

It is a collection of '''classes'''.

'''Classes''' here may mean '''models, functions, types''' or any specialized '''classes'''.

'''package''' can be stored as a single file.

It can also be stored as a directory.

We will first learn about single file storage.

|-
|| Slide:

'''Single file storage'''
|| All classes of a package may be stored in a single file with '''.mo''' extension.

It is not recommended as the code may get lengthy in a few cases.

|-
|| /* OMEdit */

Click on '''Modeling''' button at bottom right
|| Let me switch to '''OMEdit''' to demonstrate single file storage for a package.

|-
||
|| Please download and save all the files available on our website.

You may see that there is a file and a folder bearing the name '''spokenTutorialExamples'''.

Please download both of them.

|-
||
|| Now, let me open the necessary files in '''OMEdit'''.

'''Press Ctrl + O'''.

Go to the appropriate location on your system and select

* '''spokenTutorialExamples.mo''',

* '''bouncingBallWithUserTypes''',

* '''bouncingBallWithImport'''.

Note that I have not selected the folder '''spokenTutorialExamples'''.

|-
||
|| Double click on '''spokenTutorialExamples''' in '''Libraries Browser'''.

|-
||
|| Switch to '''Text View''' if the file opens in '''Icon/Diagram View'''.

|-
|| /* spokenTutorialExamples */

'''package spokenTutorialExamples '''
|| The first line defines the name of package.

Evidently, name of this package is '''spokenTutorialExamples'''.

Let me scroll down a little.

|-
|| Highlight piecewise //

'''class freeFall'''

'''model bouncingBall'''

'''model bouncingBallWithUserTypes'''

//
|| Note that this package consists of

* '''freeFall'''
* '''bouncingBall'''
* '''bouncingBallWithUserTypes''' models.

All three models were discussed in prerequisite tutorials.

Let me scroll down.

|-
|| '''end spokenTutorialExamples;'''
|| The '''end''' statement indicates where a package ends.

|-
||
|| We have viewed all '''classes''' and '''models''' of this package at one place.

Now, let us learn how to view individual classes in a package.

|-
|| Click on the (+) button with '''spokenTutorialExamples''' in '''Libraries Browser'''.
|| Click on the (+) button beside '''spokenTutorialExamples''' in '''Libraries Browser'''.

This displays the names of '''classes''' present in this package.

|-
|| Double-click on '''freeFall'''.
|| Double-click on '''freeFall''' in '''Libraries Browser'''.

'''freeFall''' class has now opened.

Individual classes of a package may be simulated.

Click on '''simulate''' button.

Note that the class has simulated.

Go back to '''modeling view'''.

Similarly, other classes of the package may be viewed and simulated.

|-
|| Click on '''spokenTutorialExamples''' tab.
|| Click on '''spokenTutorialExamples''' tab.

|-
|| Hover over '''Simulate''' button in toolbar.
|| Note that '''Simulate''' icon doesn’t appear in toolbar.

A package cannot be simulated.

|-
||
|| Let us now unload '''spokenTutorialExamples''' from OMEdit.

Do a right-click on '''spokenTutorialExamples''' in '''Libraries Browser''' and select '''unload'''.

This is done so as to avoid conflict when demonstrating directory storage.

|-
||
|| Let me go back to the slides.

|-
|| Slide:

'''Directory storage'''
|| '''Packages''' may also be stored as directories as we’ve already discussed.

In this case, classes are stored in separate files.

Name of directory is same as that of the package.

A file named '''package.mo''' needs to be included in the directory.

Each file in the directory starts with a '''within''' statement.

|-
||
|| Now, let me demonstrate the example folder '''spokenTutorialExamples''' that you’ve downloaded.

Note that this folder represents the same package as that we have already discussed.

We shall understand more about directory storage using both '''OMEdit''' and '''gedit'''.

|-
||
|| Let me demonstrate the file structure of this folder.

Go to the location where you saved the downloaded files on your system.

|-
|| /* spokenTutorialExamples folder */
|| Double-click on '''spokenTutorialExamples''' folder.

Notice that it has following files:

* '''package.mo''',

* '''freeFall.mo''',

* '''bouncingBall.mo''',

* '''bouncingBallWithUserTypes.mo'''.

|-
|| /* Directory */
|| '''package.mo''' indicates that this folder represents a package.

Without this file, the folder doesn’t represent a Modelica package.

Apart from this file, this package has models named

* '''freeFall''',

* '''bouncingBall''' and

* '''bouncingBallWithUserTypes'''.

|-
|| /* OMEdit */

'''Ctrl+O'''

'''spokenTutorialExamples → package.mo'''
|| Now, let me switch to '''OMEdit''' to demonstrate directory storage.

Press '''Ctrl + O'''. Navigate to the '''spokenTutorialExamples''' folder.

Select the '''package.mo''' file from this folder.

|-
|| Double-click on '''spokenTutorialExamples''' in '''Libraries Browser'''.
|| You can see '''spokenTutorialExamples''' package in '''Libraries Browser'''.

Double-click on '''spokenTutorialExamples''' icon.

|-
|| /* spokenTutorialExamples */
|| Switch to '''Text View''' if it opens in '''Icon/Diagram View'''.

|-
|| /* spokenTutorialExamples */

'''Scroll down'''
|| If you scroll down, you will notice that the package looks same as single-file storage.

|-
||
|| The difference between single file and directory storage can only be understood when we open this '''package''' using a text editor like '''gedit'''.

|-
|| Right-click on '''spokenTutorialExamples''' and select '''unload'''.
|| Unload '''spokenTutorialExamples'''.

|-
|| /* Download location */

Double-click on '''bouncingBall.mo''', '''bouncingBallWithUserTypes ,freeFall, package.mo'''.
|| Let me go to '''spokenTutorialExamples''' folder that you’ve downloaded and open all the files using '''gedit'''.

|-
|| '''within;'''
|| '''within''' indicates that this file relates to a '''package'''.

|-
|| '''package spokenTutorialExamples'''
|| Name of this package is '''spokenTutorialExamples'''.

|-
|| '''end spokenTutorialExamples;'''
|| '''package.mo''' file can only contain the '''within''' statement and package declaration.

|-
|| Click on '''freeFall''' tab.
|| Click on '''freeFall''' tab.

|-
|| /* freeFall */

'''within spokenTutorialExamples;'''
|| This indicates that this model belongs to '''spokenTutorialExamples''' package.

Rest of this file has information specific to '''freeFall''' class.

|-
||
|| You may see that other models in this package namely '''bouncingBallWithUserTypes , bouncingBall''' follow a similar syntax.

But, we didn’t observe '''within''' statement when we opened the package in '''OMEdit'''.

This indicates that '''within''' statement helps OMEdit recognise the file structure.

Hence, it is omitted by OMEdit while displaying the '''package'''.

|-
||
|| Let me go back to the slides.

|-
|| Slide:

'''Modelica Library'''
|| '''Modelica Library''' is an open-source package.

'''OMEdit''' loads this library for every session.

It can be located in the '''Libraries Browser'''.

It has classes from mechanical, electrical and thermal domains.

'''Classes''' from this library can be referenced and used.

|-
||
|| Let me switch to '''OMEdit''' to demonstrate '''Modelica Library'''.

|-
|| Click on '''(plus) Modelica '''
|| Expand '''Modelica''' in the '''Libraries Browser''' using the (plus) button.

This library has packages named '''Blocks , Complex Blocks''' etc.

Note that a package may further contain packages as well.

|-
|| Click '''on (plus) SIunits'''
|| Of special mention is the '''SIunits''' package.

Click on (plus) button beside '''SIunits''' for expanding it.

|-
|| Click on '''(minus) SIunits'''
|| Note that there are type definitions available for quantities like Angle, Length etc.

We shall now understand how to use classes from '''SIunits''' package using '''bouncingBallWithImport''' model.

Compress '''SIunits'''.

|-
|| Double-click on '''bouncingBallWithUserTypes''' and '''bouncingBallWithImport''' icons in '''Libraries Browser'''.
|| Scroll down in '''Libraries Browser'''.

Double-click on '''bouncingBallWithUserTypes''' and '''bouncingBallWithImport'''.

|-
||
|| Let me shift '''OMEdit''' window to the left for better visibility.

|-
||
|| Let me discuss '''bouncingBallWithUserTypes''' first.

This model was discussed in prerequisite tutorials.

|-
|| /* bouncingBallWithUserTypes */

'''type Length = Real(unit = “m”);'''

'''type Velocity = Real(unit = “m/s”);'''
|| This model has type definitions named '''Length''' and '''Velocity'''.

'''SIunits''' package from '''Modelica Library''' also has these type definitions.

It saves time to use these type definitions instead of explicitly defining them in every class.

|-
|| /* bouncingBallWithImport */
|| Click on '''bouncingBallWithImport''' tab.

|-
|| '''Modelica.SIunits.Length '''h;
|| A '''class''' in a package is referenced using '''dot'''.

'''Modelica.SIunits''' references '''SIunits''' package which belongs to '''Modelica''' library.

|-
|| Modelica.SIunits.Length''' h'''<nowiki>;</nowiki>
|| Variable '''h''' is declared to be of '''Length''' type defined in '''SIunits''' package.

|-
|| '''Modelica.SIunits.Velocity v;'''
|| Similarly, variable '''v''' is declared to be of '''Velocity''' type in '''SIunits''' package.

|-
||
|| parameter '''radius''' and '''g''' are similarly defined.

|-
|| Click on '''Simulate''' button.

Select '''h''' in '''Variables Browser'''.

|| Now, let me simulate this class.

Click on '''simulate''' button at the top.

You may observe that the output is the same as in the case of '''bouncingBallWithUserTypes'''.

|-
||
|| It is tedious to use the full name of a class every time.

This can be simplified using '''import''' statement.

Now, we shall type a few statements that show the use of '''import'''.

The statements to be typed are provided in text file named '''import-statements.txt'''.

Go to the location where you saved the files on your system and double-click on '''import-statements.txt'''.

|-
| style="border:1pt solid #000000;padding:0.176cm;"| /* gedit */

Copy the statements:

import '''Modelica.SIunits.Length''';

import '''Modelica.SIunits.Velocity''';

'''Length h''';

'''Velocity v''';
|| Let me switch to '''gedit'''.

Click on '''import-statements.txt''' tab.

Copy the statements.

|-
|| Paste //

import '''Modelica.SIunits.Length''';

import '''Modelica.SIunits.Velocity''';

'''Length h''';

'''Velocity v''';

//
|| Switch to '''OMEdit'''.

Paste the statements in '''bouncingBallWithImport''' model.

|-
|| Delete // '''Modelica.SIunits.Length''' //

'''Modelica.SIunits.Velocity''' //
|| Delete the declaration statements for '''Length''' and '''Velocity'''.

Save the model by pressing '''Ctrl + S'''.

|-
|| Click on '''Simulate''' button.
|| Let me simulate this class.

Click on '''Simulate''' button.

|-
|| Select '''h''' in '''Variables Browser''' and Click on '''Modeling''' button.
|| Note that the output is same as in previous case.

Switch to '''Modeling''' perspective.

|-
|| //

'''import Modelica.SIunits.Length;'''

'''import Modelica.SIunits.Velocity;'''

//
|| In this case, Modelica looks up for '''Length''' and '''Velocity''' type definitions in the path mentioned in '''import''' statements.

This saves the trouble of referring to the package every time.

A detailed discussion of '''lookup rules''' is beyond the scope of this tutorial.

|-
|| Delete //

'''import Modelica.SIunits.Length;'''

'''import Modelica.SIunits.Velocity;'''

//
|| Let me use one '''import''' statement instead of two.

Delete the two import statements.

|-
|| Type //

'''import Modelica.SIunits.*;'''
|| Type '''import (space) Modelica (dot) SIunits (dot) asterisk'''.

|-
||
|| This is known as wild-card import.

This way, any class from '''SIunits''' may be accessed.

|-
|| Click on '''simulate'''.
|| Save the model by pressing '''Ctrl + S''' and click on '''Simulate''' button.

|-
|| Select '''h'''
|| Select '''h''' in '''Variables Browser'''.

Note that the result is same as in previous case.

|-
|| Click on '''Modeling'''.
|| Delete the result and switch to '''Modeling perspective'''.

|-
||
|| Let me go back to the slides.

|-
||
|| This brings us to the end of this tutorial.

|-
|| Slide:

'''About the Spoken Tutorial project'''
|| Watch the video available at the link shown below:

[http://spoken-tutorial.org/ http][http://spoken-tutorial.org/ ://][http://spoken-tutorial.org/ spoken][http://spoken-tutorial.org/ -][http://spoken-tutorial.org/ tutorial][http://spoken-tutorial.org/ .][http://spoken-tutorial.org/ org] /What\_is\_a\_Spoken\_Tutorial

It summarises the '''Spoken Tutorial project'''.

If you do not have good bandwidth, you can download and watch it.

|-
|| Slide:

'''Spoken Tutorial Workshops'''
|| We conducts workshops using spoken tutorials.

Give certificates.

Please contact us.

|-
|| Slide:

'''Forum'''
|| If you have questions in this tutorial, please visit the webpage mentioned.

|-
|| Slide:

'''Textbook Companion Project'''
|| We coordinate coding of solved examples from popular books.

We give honorarium to contributors.

Please visit our website.

|-
|| Slide:

'''Lab Migration Project'''
|| We help migrate labs from commercial simulators to '''OpenModelica'''.

|-
|| Slide:

'''Acknowledgements'''
|| '''Spoken Tutorial Project''' is supported by '''NMEICT, MHRD''' Government of India.

|-
|| Slide:

'''Thanks'''
|| We thank '''OpenModelica''' development team for their support.

|-
||
|| I would like to thank you for joining me in this tutorial.

← Older revision		Revision as of 17:40, 4 April 2016
Line 446:		Line 446:

	'''Windows''' users may use notepad to open this file.		'''Windows''' users may use notepad to open this file.
−

	\|-		\|-

@@ Line 15: / Line 15: @@
 || In this tutorial, we are going to learn:
-* How to create a package of classes in '''Modelica'''.
+* How to create a '''package''' of '''classes''' in '''Modelica'''.
-* How to reference classes in a '''package'''.
+* How to reference '''classes''' in a '''package'''.
 * How to import a '''package''' and
@@ Line 54: / Line 54: @@
 It is a collection of '''classes'''.
-It can be stored as a single file or a directory.
+It can be stored as a '''single file''' or a '''directory'''.
-We will first learn about single file storage.
+We will first learn about '''single file storage'''.
 |-
@@ Line 62: / Line 62: @@
 '''Single file storage'''
-|| In single file storage all classes belonging to a package are written in a single file.
+|| In '''single file storage''' all classes belonging to a '''package''' are written in a '''single file'''.
 It is not recommended as it may get lengthy in a few cases.
@@ Line 70: / Line 70: @@
 Click on '''Modeling''' button at bottom right
-|| Now let me switch to '''OMEdit''' to demonstrate single file storage for a package.
+|| Now let me switch to '''OMEdit''' to demonstrate '''single file storage''' for a '''package'''.
 |-
@@ Line 118: / Line 118: @@
 || Now let me discuss '''spokenTutorialExamples'''
-First line defines the name of a package.
+First line defines the name of a '''package'''.
 Evidently, name of this package is '''spokenTutorialExamples'''.
@@ Line 225: / Line 225: @@
 * '''bouncingBall'''.
-We shall understand more about directory storage using both OMEdit and gedit.
+We shall understand more about directory storage using both '''OMEdit''' and '''gedit'''.
 |-
@@ Line 231: / Line 231: @@
 || Note that '''package.mo''' indicates that this folder represents a package.
-Without this file, the folder doesn’t represent a Modelica package.
+Without this file, the folder doesn’t represent a '''Modelica package'''.
 |-
@@ Line 252: / Line 252: @@
 Double-click on '''spokenTutorialExamples''' icon.
 |-
@@ Line 263: / Line 261: @@
 '''Scroll down'''
-|| If you scroll down, you may notice that this package is the same as that we have seen in single file storage.
+|| If you scroll down, you may notice that this package is the same as that we have seen in '''single file storage'''.
 |-
@@ Line 269: / Line 267: @@
 || The difference between single file and directory storage can only be understood when we open this '''package''' using a text editor like '''gedit'''.
-You may use notepad or any other text editor if you are using windows.
+You may use notepad or any other text editor if you are using '''Windows'''.
 |-
@@ Line 281: / Line 279: @@
 || Switch to '''spokenTutorialExamples''' folder and open all the files using '''gedit'''.
-Now all the files are open in gedit.
+Now all the files are open in '''gedit'''.
 Let us take a look at '''package.mo''' first.
@@ Line 297: / Line 295: @@
 |-
 || '''end spokenTutorialExamples;'''
-|| '''package.mo''' file can only contain the '''within''' statement and package declaration.
+|| '''package.mo''' file can only contain the '''within''' statement and '''package''' declaration.
 |-
@@ Line 313: / Line 311: @@
 |-
 ||
-|| You may see that other models in this package namely '''bouncingBallWithUserTypes and bouncingBall''' follow a similar syntax as well.
+|| You may see that other models in this package namely '''bouncingBallWithUserTypes''' and '''bouncingBall''' follow a similar syntax as well.
 But, we didn’t observe '''within''' statement when we opened the package in '''OMEdit'''.
-This indicates that '''within''' statement helps OMEdit recognize the file structure.
+This indicates that '''within''' statement helps '''OMEdit''' recognize the file structure.
-Hence, it is omitted by OMEdit while displaying the '''package'''.
+Hence, it is omitted by '''OMEdit''' while displaying the '''package'''.
 |-
@@ Line 349: / Line 347: @@
 || Locate '''Modelica''' icon in '''Libraries Browser''' and expand it.
-Note that '''Modelica Library''' has packages named '''Blocks , Complex Blocks''' etc.
+Note that '''Modelica Library''' has packages named '''Blocks, Complex Blocks''' etc.
-You may note that a package may further contain packages as well as it evident here.
+You may note that a package may further contain packages as well as is evident here.
 |-
 || Click '''on (plus) SIunits'''
-|| Of special mention is the '''SIunits''' package.
+|| Of special mentioned is the '''SIunits''' package.
 Expand it.
@@ Line 361: / Line 359: @@
 |-
 || Click on '''(minus) SIunits'''
-|| This package has type definitions for physical quantities like Angle, Length, Position etc.
+|| This package has type definitions for physical quantities like '''Angle, Length, Position''' etc.
 We shall see how to use these type definitions using '''bouncingBallWithImport''' class.
@@ Line 447: / Line 445: @@
 Double-click on '''import-statements.txt'''.
-Windows users may use notepad to open this file.
+'''Windows''' users may use notepad to open this file.
@@ Line 462: / Line 460: @@
 '''Velocity v''';
-|| The file is now open in gedit.
+|| The file is now open in '''gedit'''.
-Copy all the statements using Ctrl+C or by doing right click.
+Copy all the statements using '''Ctrl+C''' or by doing right click.
 |-
@@ Line 541: / Line 539: @@
 '''import Modelica.SIunits.*;'''
-|| And type '''import (space) Modelica (dot) SIunits (dot) asterisk''' (semicolon)
+|| And type '''import (space) Modelica (dot) SIunits (dot) asterisk (semicolon)'''
 Save this model by pressing '''Ctrl + S'''
@@ Line 547: / Line 545: @@
 |-
 ||
-|| This statement is known as a wild-card import.
+|| This statement is known as a '''wild-card import'''.
 This way, any class from '''SIunits''' may be accessed without explicitly mentioning it.
@@ Line 598: / Line 596: @@
 It summarises the '''Spoken Tutorial project'''.
-If you have questions in this Spoken Tutorial, please visit the website shown.
+If you have questions in this '''Spoken Tutorial''', please visit the website shown.
 |-

@@ Line 151: / Line 151: @@
 |-
 || Click on the (+) button with '''spokenTutorialExamples''' in '''Libraries Browser'''.
-|| Click on the (+) button beside '''spokenTutorialExamples''' icon in '''Libraries Browser'''.
+|| Click on the (+) button besides '''spokenTutorialExamples''' icon in '''Libraries Browser'''.
 This displays the names of '''classes''' present in this package.
@@ Line 415: / Line 415: @@
 || Note that parameters '''radius''' and '''g''' are declared in a similar fashion.
-|-
+Now let me '''Simulate''' this model.
-|| Now let me '''Simulate''' this model.
 Click on '''Simulate''' button in the toolbar.
@@ Line 424: / Line 423: @@
 Select '''h''' in the '''Variables Browser'''.
 || Note that the plot obtained is similar to the one seen in the case of '''bouncingBallWithUserTypes'''.

@@ Line 554: / Line 554: @@
 ||
 || This brings us to the end of this tutorial.
 |-