IDA Simulation Environment Bris Data AB, September 1999

128 Pages·2003·0.72 MB·English

IDA Simulation Environment

Bris Data AB, September 1999

Version: 2.11

Copyright Bris Data AB 1999
IDA Simulation Environment  Bris Data AB 1999

For those of you who don’t read manuals, do this:

1. Insert the CD and double click on the setup.exe file. Follow the
installation instructions
2. Start IDA 2.11 from the desktop
3. Read the manual! It provides a great deal of information, which makes
getting started easier.
2
IDA Simulation Environment  Bris Data AB 1999

Contents

1 A New IDA Application - basic steps................................................................... 6
1.1 Getting started.............................................................................................. 6
1.2 Source files .................................................................................................. 7
1.3 Ida NMF Translator...................................................................................... 7
1.3.1 A New Project....................................................................................... 8
1.3.2 A Project File......................................................................................... 8
1.3.3 Current settings..................................................................................... 9
1.3.4 Translate the Project............................................................................. 9
1.3.5 Make DLL............................................................................................ 10
1.3.6 Output files from IDA NMF Translator................................................. 10
1.4 IDA Modeller .............................................................................................. 10
1.4.1 New application dialog........................................................................ 10
1.4.2 Application name................................................................................. 10
1.4.3 Component libraries............................................................................ 11
1.4.4 Simulation type and Time scale.......................................................... 11
1.4.5 Installation: Subdirectory and files....................................................... 11
1.5 Check New Application.............................................................................. 11
1.5.1 Application........................................................................................... 11
1.5.2 The List of Basic Models..................................................................... 12
1.5.3 Insert objects....................................................................................... 12
1.5.4 Run Solver.......................................................................................... 12
1.5.5 Build a consistent system.................................................................... 13
2 A New Application, advanced steps.................................................................. 14
2.1 Graphical Interface..................................................................................... 14
2.1.1 Object Icons........................................................................................ 14
3 IDA Reference manual...................................................................................... 15
3.1 Overview.................................................................................................... 15
3.1.1 Introduction......................................................................................... 15
3.1.2 IDA Applications.................................................................................. 15
3.1.3 Glossary.............................................................................................. 15
3.1.4 IDA System......................................................................................... 17
3.1.5 Data objects........................................................................................ 17
3.2 Modeling..................................................................................................... 17
3.2.1 Levels of IDA systems......................................................................... 18
3.2.2 Working with IDA systems .................................................................. 19
3.2.3 Quitting the Program........................................................................... 21
3.2.4 Navigation in IDA system.................................................................... 21
3.2.5 Working with objects........................................................................... 23
3.2.6 Connections........................................................................................ 26
3.2.7 Parameter setting................................................................................ 31
3.2.8 Start Conditions................................................................................... 31
3.2.9 Boundary conditions............................................................................ 31
3.2.10 Preparing output.................................................................................. 33
3.3 Simulating .................................................................................................. 34
3.3.1 Running a simulation........................................................................... 34
3.3.2 Well-posed problem............................................................................ 34
3.3.3 Simulation data................................................................................... 34
3.3.4 Monitor Dialog..................................................................................... 35
3
IDA Simulation Environment  Bris Data AB 1999

3.4 View the system and the results................................................................. 37
3.4.1 View types........................................................................................... 37
3.4.2 View Options....................................................................................... 41
3.4.3 Refreshing the view............................................................................. 42
3.4.4 To print or save a view........................................................................ 42
3.4.5 Graphic Print Options.......................................................................... 43
3.4.6 Diagrams............................................................................................. 43
3.4.7 Reports ............................................................................................... 49
3.5 Advanced features..................................................................................... 49
3.5.1 Resources........................................................................................... 49
3.5.2 Using Database................................................................................... 52
3.5.3 Parameter mapping............................................................................. 54
3.5.4 Editing forms....................................................................................... 55
3.5.5 Reports ............................................................................................... 57
3.5.6 Calendar Features .............................................................................. 57
3.5.7 Multi-language support........................................................................ 60
3.5.8 Batch mode......................................................................................... 60
3.6 Graphical Editor.......................................................................................... 61
3.6.1 Types of graphical elements............................................................... 61
3.6.2 Object Symbols................................................................................... 61
3.6.3 Connection Line.................................................................................. 61
3.6.4 Shapes................................................................................................ 62
3.6.5 Text elements...................................................................................... 62
3.6.6 Fields .................................................................................................. 63
3.6.7 Button.................................................................................................. 64
3.6.8 Insert a new Element into a Document ............................................... 64
3.6.9 Graphical attributes............................................................................. 66
3.6.10 Reading the cursor.............................................................................. 68
3.6.11 Selection............................................................................................. 69
3.6.12 To move or reshape graphical elements............................................. 70
3.6.13 Copy, Cut, Paste and Delete............................................................... 71
3.6.14 Drag and Drop..................................................................................... 72
3.6.15 Place for inserted element .................................................................. 72
3.6.16 Snap to Grid........................................................................................ 72
3.6.17 Editing the lines................................................................................... 72
3.7 User Interface............................................................................................. 74
3.7.2 Diagnostic messages.......................................................................... 82
3.8 Inside IDA SE............................................................................................. 86
3.8.1 IDA files............................................................................................... 86
3.8.2 Forms and symbol files....................................................................... 91
3.8.3 Report forms....................................................................................... 95
3.8.4 Data Objects. Object records.............................................................. 97
3.8.5 Resources and Database.................................................................. 104
3.8.6 Scripts............................................................................................... 104
3.8.7 Directory structure of IDA Modeller................................................... 109
3.9 Preparing a new application..................................................................... 111
3.9.1 Basic steps........................................................................................ 111
3.9.2 Enhanced user interface................................................................... 111
3.9.3 Advanced customization................................................................... 112
3.9.4 Tools................................................................................................. 116
4
IDA Simulation Environment  Bris Data AB 1999

3.9.5 Script methods.................................................................................. 117
3.9.6 Extending application........................................................................ 117
3.9.7 Online Help....................................................................................... 118
3.9.8 Distributing applications.................................................................... 119
4 Index................................................................................................................ 125

5
IDA Simulation Environment  Bris Data AB 1999

1 A New IDA Application - basic steps
1.1 Getting started
To create a new IDA application from scratch one must
1. Prepare model descriptions in NMF source format.
2. Translate the NMF files and generate application files.
3. Install the application in IDA Modeller.
Natural subsequent steps are
Check the application.
Customize the application.
As an example, let us list the necessary steps to create an application ELOSC.

1. Prepare NMF Source
1.1. Create anywhere on disk the project directory eloscdir and copy into this directory the
six files elcap.nmf, elcoil.nmf, eldiod.nmf, elnode.nmf, elres.nmf, global.nmf from the
subdirectory \samples\elosc, which exists in your IDA installation.
2. Translate NMF Source and generate a description file and a Dynamic Linked
Library (DLL)
2.2. Start IDA NMF Translator.
2.3. Select menu option Options/IDA Options…, then select the compiler you are using.
(Default is Lahey Fortran 90). Select menu option Project/New, then browse and select
the eloscdir directory.
2.4. Enter the name eloscnmf for the new project and click Save. (The created project file
eloscnmf.typ with a list of NMF files appears.)
2.5. Close the eloscnmf.typ file.
2.6. Select menu option Options/Load Options Set/NMF Release Set.
2.7. Select menu option Translate/Current project. The NMF files will be translated.
2.8. Select menu option Project/Make DLL. The Fortran files generated by the translation
will be compiled in a DOS window and combined into a new library eloscnmf.dll.
2.9. Close the DOS window when 'Finished' appears in the title bar.
2.10. Close the IDA NMF Translator window.
3. Install the application in IDA Modeller
3.11. Start IDA Modeller.
3.12. Select menu option Tools/New-Application.
3.13. Enter ELOSC as 'Application name'.
3.14. Click Add…, then browse to the project directory eloscdir and select file eloscnmf.eo.
3.15. Set 'Simulation type' to 'Dynamic' and 'Time scale' to 'Seconds'.
3.16. Click Install.
4. Check the application
4.17. Click toolbar icon Create new document.
4.18. Select 'IDA Application' Elosc, select 'Template' Elosc-System, click OK. A window
labeled '(Scheme)' appears.
4.19. Select menu option Insert/New Object..., and verify that the models COIL, DIODE,
EL_NODE, RESISTOR, and CAPACITOR from the new library are available under 'Insert
new object'.
6
IDA Simulation Environment  Bris Data AB 1999

4.20. Select DIODE and click OK. An empty box appears in the 'Scheme' window. Drag
and drop to suitable location and size. Repeat this process for one copy of each of the
other models (object types) from the library.
4.21. Select menu option Tools/Run. After a while you should get an error message from
IDA Solver without reference to unknown model types.
5. Customize, by getting Icons for Component Types
Object icons for the selected example are already available in the IDA installation.
Thus, we can just fetch them and make them available for the modeller.
5.22. Copy all ids-files from samples\elosc subdirectory to lib\elosc subdirectory under the
IDA installation directory.
6. Test the customized application
6.23. Select menu option File/Open, then select oscillator.idm from samples subdirectory. The
boxes now show the prefabricated icons.
6.24. Select menu option Tools/Run. A simulation is run.

The rest of this chapter explains each step in detail, using the ELOSC application as
an example. It also indicates what should be done in a general case.
1.2 Source files
1) Create somewhere the project directory eloscdir and copy into it the files elcap.nmf,
elcoil.nmf, eldiod.nmf, elnode.nmf, elres.nmf, global.nmf from the \samples\elosc subdirectory.
These files, except global.nmf, contain basic models for the ELOSC application. They are text
files and can be prepared by any text editor. Here we have a one-to-one correspondence
between files and names, but in fact only model names are essential. However, using the same
name for files and models is a good practice.
Currently, long file names are not supported.
The file global.nmf contains global declarations, which are common to the five basic models. It
is the standard file for global declarations; it includes quantity types, link types and constants
from files quant.nmf, link.nmf, const.nmf. You may edit global.nmf to include new global
declarations; the included files should not be edited.
To get the most support from the project handling utilities, you should put all your NMF files
in the same directory. The directory can have any name acceptable to Windows.
In a general case:
1a. Create a new directory (a project directory).
1b. Put all NMF sources into the project directory.
1c. If any of the models use non-standard type declarations, an appropriate global.nmf that
contains the required declarations should also be put in the project directory.
1.3 Ida NMF Translator
2) Start IDA NMF Translator.
With IDA NMF Translator you should:
- translate source files to generate Fortran files for the models, plus a description file
intended for IDA Modeller (eloscnmf.eo);
- compile and link the Fortran files into a dynamic link library for IDA Solver
(eloscnmf.dll).
7
IDA Simulation Environment  Bris Data AB 1999

There is a simple way to start the translator in the selected directory: double-click on an NMF
file, then close the window with the file in the Translator main window.
1.3.1 A New Project
3) Select menu option Options/IDA Options…, then select the compiler you are using.
(Default is Lahey Fortran 90). Select menu option Project/New, then browse and select the
eloscdir directory.
4) Enter the name eloscnmf for the new project and click Save. (The newly created project
file eloscnmf.typ with a list of NMF files appears.)
A project allows you to process all NMF files in a directory as a batch.
The directory can have any name. A project file name must also be selected – this is the
default name for the library and description files. You can use the same name for the
directory, the project file, and the application. This is the recommended practice.
In the current version of the project utilities, the project and the NMF files should not use
names longer than 8 characters. The application name may be longer.
When a new project file is Saved, the Translator puts a number of support files into the current
directory and creates an empty subdirectory LF90. The files makefile. and nmf.cfg are created in
the current directory. The files global.nmf and ida.cfg are copied from subdirectory idafiles in
the IDA installation, unless they already exist in the current directory. Each operation is
reflected in the translator message window.
In a general case:
3. Select menu option Project/New, then browse and select the project directory created
earlier.
4. Enter a name for the new project file and click Save.
1.3.2 A Project File
5) When the new project file eloscnmf.typ is created, a list of the NMF files included in the
project appears:
elcap.nmf 3.02
elcoil.nmf 3.02
eldiod.nmf 3.02
elnode.nmf 3.02
elres.nmf 3.02
Close the eloscnmf.typ text window.
A project file is just a text file with extension typ (default). It contains a list of NMF source
file names. Each name is in a separate line and is followed by the current NMF version
number (this is utilized when the dll is being created).
As a rule, all these files are from the same directory as the project file, so there is no need to
specify a full path; file name and extension will do. If necessary, files from other directories
can be added, but such files must be specified with full path names.
A project file can be edited just as any text file: Select menu option Project/Edit project file.
In a general case:
5a. Make sure all the sources you need get into the project file, optionally edit the project file
to add references, including full path, to files residing in other directories.
5b. Close the text window with the project file.
8
IDA Simulation Environment  Bris Data AB 1999

1.3.3 Current settings
6) Select menu option Options/Load Options Set/NMF Release Set.
There are many options available in the translator; all have defaults and normally these are
adequate. There are, however, a few options that quite often require attention and we will
briefly touch upon these here (for comprehensive descriptions use online help).
The options that govern where source and target code are located, are set automatically when
a project is selected or created. If changes are needed, the options are found under
Options/Directories/...
Options/Safety vs. Optimization/.. control, among other things, the translator's reaction on errors
detected in the source code. The normal behavior is to abort translation after completed
syntax checking. However, errors can be described as fatal or non-fatal. When non standard
NMF features are intentionally used, or during model development, it may desirable to
continue translation when only non-fatal errors have been reported.
Under Options/IDA options you can control the generation of IDA specific output. One change
that may be interesting during model development is to turn off the generation of an eo
description file for the Modeller.
The complete set of options is stored in a configuration file with extension .cfg. Two standard
settings are available via Options/Load Options Set/... The NMF Release Set gives generation of
for and eo files and causes Break on error. The NMF Debug Set suppresses eo files and allows
non-fatal errors. It is useful when you just want to check the consistency of a newly created
set of NMF files.
IDA Modeller version is set to 2.1 for both Debug and Release.
You can customize your own option settings and save them in a config file in the current
directory, using Options/Save and Options/Load Options Set/Custom.

In a general case:
6. Select menu Options/Load Options Set, then go on with:
a. NMF Debug Set – if you are not sure that all sources are correct,
b. NMF Release Set – if you believe all sources to be correct, or
c. Custom if you need any special options.
1.3.4 Translate the Project
7) Select menu option Translate/Current project.
In the ELOSC sample case, the translator produces the description file eloscnmf.eo and five
Fortran files elcap.for, elcoil.for, eldiod.for, elnode.for, elres.for.
The name of the eo file will be the same as that of the dll file, which in turn gets the project
name by default. The dll name can be changed via Options/IDA Options.
This step is the main task of IDA NMF Translator. It reads global declarations and source
files, checks syntax and semantics, reports errors and warnings and, under normal
circumstances, generates a set of Fortran codes for each model. Errors, warnings and
messages (e.g. what files were generated) appear in the message window. All generated files
are put in the 'Target code' directory, which by default is the current directory (can be changed
by options, not recommended to use with Project features).
9
IDA Simulation Environment  Bris Data AB 1999

If the Translator reports errors, locate them (double click on error messages) and correct them.
Repeat translation until source is translated properly.
In a general case, when you have a fresh set of source files and have selected NMF Debug
options:
7a. Select menu option Translate/Current project.
7b. If errors were reported, correct them, and repeat step 7a.
7c. Select menu Options/Load Options Set/NMF Release Set.
7d. Select menu option Translate/Current project again.
1.3.5 Make DLL
8) Select menu option Project/Make DLL.
9) Close the DOS window when 'Finished' appears in the title bar.
A DOS window is opened, and DMAKE is run in it. Close the window when DMAKE is
finished. The file eloscnmf.dll has been generated in the current directory.
Option Project/Make DLL is used to create a dynamic linked library from the translated Fortran
files. Intermediate obj-files are put into a local subdirectory LF90. The dll file will get the
project name by default. The dll name can be changed via Options/IDA Options. The dll is used
as a component library by IDA Solver.
The DMAKE utility uses some script files and other files; some of these reside in the current
directory and are generated by IDA NMF Translator at various stages of the process (makefile,
_callpr4.*).
1.3.6 Output files from IDA NMF Translator
10) Close the IDA NMF Translator window.
Among all the files now residing in the eloscdir directory, only two are essential for the
remaining steps: eloscnmf.eo and eloscnmf.dll. The IDA NMF Translator has fulfilled its task
and may be closed.
In a general case the dll- and eo-files will have the same name.
The project directory should be left intact, if you want to continue developing the application
by adding new basic models or improving old ones. If not, you may delete all files and
subdirectories except <descript>.dll, <descript>.eo, and NMF sources including non-standard
global.nmf. The NMF files can be used as online documentation in IDA Modeller, if they are
copied to the lib directory.
1.4 IDA Modeller
11) Start IDA Modeller.
We have created the new files eloscnmf.eo and eloscnmf.dll required for the new application
ELOSC. Before you can use the new application, these files must be installed in IDA Modeller,
and you must make some minor tuning. This is handled in the New-Application dialog.
1.4.1 New application dialog
12) Select menu option Tools/New-Application.
1.4.2 Application name
13) Enter ELOSC as 'Application name'.
10