BlueM.Sim application: Difference between revisions

Latest revision as of 05:56, 5 March 2022

BlueM.Sim | Downloads | Application | Theory | Development

This page is an aid to the application of BlueM.

Dataset

A BlueM.Sim dataset consists of several text files. The minimum requirements are an ALL-File - (general options) and a SYS-File - (System Plan). Furthermore, files for describing the different types of system elements must be included. All files must have the same filename (which is also the name of the dataset), only the file extensions differ. (The name of the dataset should not be longer than 32 characters! See Bug 13)
A QGIS plugin for creating BlueM.Sim input files, developed by Martin Grosshaus as part of his Master Thesis, is available on GitHub: https://github.com/bluemodel/BlueM.QGISInterface
It is possible to create a dataset using TALSIM, which can then be exported and used for BlueM.Sim. Minor modifications to the export files need to be carried out (see TALSIM Export).

See also Input files

Simulation

BlueM.Win Screenshot

Releases starting from 0.9.1

For individual simulations, it is easiest to use the BlueM.Win package.

Download the precompiled package BlueM.Win.zip and unzip.
Start the program BlueM.Win.exe
Select a dataset
Start the simulation
After successful simulation, view the simulation result in Wave.

The computational core (bluem.dll) can be controlled using the API of the BlueM.DLLAdapter.

Using BlueM.Sim with OpenMI

You need an OMI file, an example of which is provided below:

<LinkableComponent Type="IHWB.BlueM.OpenMIAdapter.BlueM_LinkableComponent" Assembly="D:\BlueM\IHWB.BlueM.OpenMIAdapter.dll">
  <Arguments>
    <Argument Key="FilePath" ReadOnly="true" Value="D:\Dataset\demoNA" />
    <Argument Key="AnzahlInterneZeitschritte" ReadOnly="true" Value="5" />
    <Argument Key="Guetemodell" ReadOnly="true" Value="false" />
    <Argument Key="Guetemodell_Abbauprozess" ReadOnly="true" Value="true" />
    <Argument Key="Guetemodell_Dispersion" ReadOnly="true" Value="false" />
    <Argument Key="Guetemodell_Merge" ReadOnly="true" Value="false" />
    <Argument Key="Simulationsanfang" ReadOnly="true" Value="28.12.1967 00:00" />
  </Arguments>
</LinkableComponent>

The directories have to be modified to point to the correct locations on your computer.

Explanation of the argument keys:

Location of the dataset (path and filename without ".ALL")

<Argument Key="FilePath" ReadOnly="true" Value="D:\Dataset\demoNA" />

How many internal timesteps within one OpenMI timestep

<Argument Key="AnzahlInterneZeitschritte" ReadOnly="true" Value="5" />

Use the water quality model (SWQM)?

<Argument Key="Guetemodell" ReadOnly="true" Value="false" />

Use degradation processes in the quality model ?

<Argument Key="Guetemodell_Abbauprozess" ReadOnly="true" Value="true" />

No effect yet !

<Argument Key="Guetemodell_Dispersion" ReadOnly="true" Value="false" />
<Argument Key="Guetemodell_Merge" ReadOnly="true" Value="false" />

Start date of the simulation:

<Argument Key="Simulationsanfang" ReadOnly="true" Value="28.12.1967 00:00" />

Release 0.9

BlueM.exe Screenshot

In the simplest case the compiled EXE file (BlueM.exe) is in the same directory as the dataset to be simulated. In this case, simply launch the EXE and then enter the dataset name.
You can specify the name of the dataset directly as a parameter to pass to BlueM.exe

C:\WorkingDir>"path\to\BlueM.exe" datasetname

To prevent the window from closing immediately when the simulation is finished or an error has occurred, a shortcut to BlueM.exe can be created. In the properties of the shortcut enter the following "target":

cmd.exe /K "path\to\BlueM.exe"

Also, specify the working directory as the directory in which the dataset is located.

Results

Depending on the settings, BlueM.Sim creates different result files. By default, the main results are written to a WEL-File.

See also output files

Errors / warnings

Errors cause the simulation to stop and must be remedied. All errors are logged to an *.ERR file in the dataset directory. The *.ERR file contains the date and time of the simulation in the filename and is preserved until deleted by the user. The error messages sometimes contain error constants.
Warnings that occur during the simulation are also logged to a file ($WARN.TMP), which is deleted each time a new simulation is started.

@@ Line 3: / Line 3: @@
 This page is an aid to the application of BlueM.
-==Record==
+==Dataset==
-* A record consists of several text files. Mandatory for each simulation are [[TSIM.ALL|ALL]]- (general information) and the [[TSIM.SYS|SYS]] file - (System Plan). Furthermore, files for a description of the system elements should be in the required manner. All files must have the same file name (name = record), only the file extensions differ. <small>(The name of the record shall consist of not more than 32 characters! ''See Bug 13'')</small>
+* A BlueM.Sim dataset consists of several text files. The minimum requirements are an [[ALL-File]] - (general options) and a [[SYS-File]] - (System Plan). Furthermore, files for describing the different types of system elements must be included. All files must have the same filename (which is also the name of the dataset), only the file extensions differ. <small>(The name of the dataset should not be longer than 32 characters! ''See Bug 13'')</small>
-* It is possible to make a record using [[TALSIM]], after creating these can be exported and used for BlueM. These are minor modifications to the export files. See [[TALSIM Export]].
+* A QGIS plugin for creating BlueM.Sim input files, developed by Martin Grosshaus as part of his Master Thesis, is available on GitHub: https://github.com/bluemodel/BlueM.QGISInterface
+* It is possible to create a dataset using [[TALSIM]], which can then be exported and used for BlueM.Sim. Minor modifications to the export files need to be carried out (see [[TALSIM Export]]).
 ''See also [[BlueM Eingabedateien|Input files]]''
 ==Simulation==
-[[Bild:BlueMWin_screenshot.png|thumb|BlueM.Win Screenshot]]
+[[File:BlueMWin_screenshot.png|thumb|BlueM.Win Screenshot]]
-===Release 0.9.1===
+===Releases starting from 0.9.1===
 For individual simulations, it is easiest to use the '''[[BlueM.Win]]''' package.
-* [[BlueM Downloads|Download]] the prebuilt package <code>BlueM.Win.zip</code>  and unzip.
+* [[BlueM Downloads|Download]] the precompiled package <code>BlueM.Win.zip</code>  and unzip.
-* Start the file <code>BlueM.Win.exe</code>
+* Start the program '''<code>BlueM.Win.exe</code>'''
-* Select a record
+* Select a dataset
-* Start simulation
+* Start the simulation
-* After successful simulation, view the simulation result in BlueM.Wave.
+* After successful simulation, view the simulation result in [[Wave]].
-For <code>bluem.dll</code> from another application address, the [[BlueM.DLLAdapter]] can be used.<br clear="all"/>
+The computational core (<code>bluem.dll</code>) can be controlled using the API of the [[BlueM.DLLAdapter]].
+====Using BlueM.Sim with OpenMI====
+You need an OMI file, an example of which is provided below:
+<source lang="xml">
+<LinkableComponent Type="IHWB.BlueM.OpenMIAdapter.BlueM_LinkableComponent" Assembly="D:\BlueM\IHWB.BlueM.OpenMIAdapter.dll">
+  <Arguments>
+    <Argument Key="FilePath" ReadOnly="true" Value="D:\Dataset\demoNA" />
+    <Argument Key="AnzahlInterneZeitschritte" ReadOnly="true" Value="5" />
+    <Argument Key="Guetemodell" ReadOnly="true" Value="false" />
+    <Argument Key="Guetemodell_Abbauprozess" ReadOnly="true" Value="true" />
+    <Argument Key="Guetemodell_Dispersion" ReadOnly="true" Value="false" />
+    <Argument Key="Guetemodell_Merge" ReadOnly="true" Value="false" />
+    <Argument Key="Simulationsanfang" ReadOnly="true" Value="28.12.1967 00:00" />
+  </Arguments>
+</LinkableComponent>
+</source>
+The directories have to be modified to point to the correct locations on your computer.
+<u>Explanation of the argument keys:</u>
+Location of the dataset (path and filename without ".ALL")
+<source lang="xml"><Argument Key="FilePath" ReadOnly="true" Value="D:\Dataset\demoNA" /></source>
+How many internal timesteps within one OpenMI timestep
+<source lang="xml"><Argument Key="AnzahlInterneZeitschritte" ReadOnly="true" Value="5" /></source>
+Use the water quality model ([[SWQM]])?
+<source lang="xml"><Argument Key="Guetemodell" ReadOnly="true" Value="false" /></source>
+Use degradation processes in the quality model ?
+<source lang="xml"><Argument Key="Guetemodell_Abbauprozess" ReadOnly="true" Value="true" /></source>
+No effect yet !
+<source lang="xml">
+<Argument Key="Guetemodell_Dispersion" ReadOnly="true" Value="false" />
+<Argument Key="Guetemodell_Merge" ReadOnly="true" Value="false" />
+</source>
+Start date of the simulation:
+<source lang="xml"><Argument Key="Simulationsanfang" ReadOnly="true" Value="28.12.1967 00:00" /></source>
 ===Release 0.9===
-[[Bild:BlueMExe_screenshot.png|thumb|BlueM.exe Screenshot]]
+[[File:BlueMExe_screenshot.png|thumb|BlueM.exe Screenshot]]
-* In the simplest case the compiled EXE file ([[BlueM Downloads|BlueM.exe]]) is in the same directory as the data to be simulated. In this case, simply launch the EXE at the request of the record name. Then the simulation starts.
+* In the simplest case the compiled EXE file ([[BlueM Downloads|BlueM.exe]]) is in the same directory as the dataset to be simulated. In this case, simply launch the EXE and then enter the dataset name.
-* You can specify the name of the data directly as a parameter to pass to BlueM.exe
+* You can specify the name of the dataset directly as a parameter to pass to BlueM.exe
-:<dos>C:\Arbeitsverzeichnis>"Pfad\zu\BlueM.exe" Datensatzname</dos>
+:<pre class="dos">C:\WorkingDir>"path\to\BlueM.exe" datasetname</pre>
-* To prevent the window from closing immediately when the simulation is finished or an error has occurred,  a shortcut to BlueM.exe can be created. In the properties of the shortcut enter the following "target" :
+* To prevent the window from closing immediately when the simulation is finished or an error has occurred, a shortcut to BlueM.exe can be created. In the properties of the shortcut enter the following "target":
-:<pre>cmd.exe /K "Pfad\zu\BlueM.exe"</pre>
+:<pre>cmd.exe /K "path\to\BlueM.exe"</pre>
-:Under "Start in" the working directory must be specified, i.e., the directory in which the record is located.
+:Also, specify the working directory as the directory in which the dataset is located.
 ==Results==
-* Depending on the setting BlueM creates result files. By default, the [[WEL-file]].
+* Depending on the settings, BlueM.Sim creates different result files. By default, the main results are written to a [[WEL-File]].
 ''See also [[BlueM Ausgabedateien|output files]]''
 ===Errors / warnings===
-* In some cases, the blue model for a global program termination gives an  '''[[ERROR-Konstanten | ERROR-Constant]]''' back. (In case a  '''[[$FEHL.TMP]]'''  file is generated, there is also the ERROR constant in the left column).
+* Errors cause the simulation to stop and must be remedied. All errors are logged to an [[ERR-File|*.ERR file]] in the dataset directory. The *.ERR file contains the date and time of the simulation in the filename and is preserved until deleted by the user. The error messages sometimes contain [[ERROR-Konstanten | error constants]].
-* Warnings (eg, Buffer overflows) are written during the simulation in the file '''[[$WARN.TMP]]''' .
+* Warnings that occur during the simulation are also logged to a file ([[$WARN.TMP]]), which is deleted each time a new simulation is started.
 [[Kategorie: BlueM.Sim Anwendung|A]]