Beruflich Dokumente
Kultur Dokumente
Hydromantis, Inc.
Consulting Engineers
Copyright © 2005 Hydromantis, Inc. All rights reserved.
No part of this work covered by copyright may be reproduced in any form or by any
means - graphic, electronic or mechanical, including photocopying, recording,
taping, or storage in an information retrieval system - without the prior written
permission of the copyright owner.
The information contained within this document is subject to change without notice.
Hydromantis, Inc. makes no warranty of any kind with regard to this material,
including, but not limited to, the implied warranties of merchantability and fitness
for a particular purpose. Hydromantis, Inc., shall not be liable for errors contained
herein or for incidental consequential damages in connection with the furnishing,
performance, or use of this material.
Trademarks
SimuWorks and all other Hydromantis trademarks and logos mentioned and/or
displayed are trademarks or registered trademarks of Hydromantis, Inc.
All other products or services mentioned in this document are identified by the
trademarks, service marks, or product names as designated by the companies who
market those products. Inquiries concerning such trademarks should be made directly
to those companies.
i
SimuWorks User’s Guide
Toolbar...................................................................................................................7
Unit Process Toolbar..............................................................................................7
Drawing Board.......................................................................................................8
Setup Options..................................................................................................................8
Drawing a Layout ...........................................................................................................9
Drawing Board Labels ...........................................................................................9
Unit Process Parameters..................................................................................................9
Labels...................................................................................................................10
Physical ................................................................................................................10
Operational...........................................................................................................10
Notes ....................................................................................................................10
Model Data....................................................................................................................11
Model Parameters ................................................................................................11
Temperature .........................................................................................................11
Simulation With SimuWorks ........................................................................................12
Outputs..........................................................................................................................12
Reports ..........................................................................................................................13
Tutorials......................................................................................................... 15
Introduction...................................................................................................................15
Tutorial 1: Basic Simulation ....................................................................... 17
Creating a Simple Layout .............................................................................................17
Creating Outputs ...........................................................................................................23
Running a Simulation....................................................................................................26
Tutorial 2: Data Input and Output ............................................................ 29
Adding Measured Data to a Graph................................................................................29
Adding Operational Data ..............................................................................................31
Exporting Data for Post-Processing ..............................................................................34
Creating a Simulation Report........................................................................................34
Tutorial 3: Influent Characterisation & Data........................................... 36
Understanding Influent Characterisation ......................................................................36
Influent Data Files.........................................................................................................37
How To…....................................................................................................... 41
Change Keycodes..........................................................................................................41
Change Keycode ..................................................................................................41
Manage Files.................................................................................................................42
Start a New File....................................................................................................42
Open.....................................................................................................................42
Save......................................................................................................................42
Save As ................................................................................................................42
Manage Drawing Board Objects ...................................................................................43
Selecting Objects..................................................................................................43
Cut........................................................................................................................44
Copy.....................................................................................................................44
Paste .....................................................................................................................45
ii
Table Of Contents
Delete................................................................................................................... 45
Move Layout Objects........................................................................................... 46
Connect Objects – Drawing the Flow Stream...................................................... 46
Delete Connections .............................................................................................. 47
Manage the Drawing Board Display............................................................................. 47
Display the Drawing Board Grid ......................................................................... 47
Display the Unit Process Labels .......................................................................... 47
Display the Unit Process Connection Points........................................................ 48
View Different Areas of the Drawing Board ....................................................... 48
Edit Parameters............................................................................................................. 48
Edit Influent Wastewater Characteristics............................................................. 48
Edit Unit Process Parameters............................................................................... 49
Edit Global Modelling Parameters....................................................................... 49
Edit Simulation Initial Conditions ....................................................................... 49
Create Data Files........................................................................................................... 50
Influent Data Files ............................................................................................... 50
Time-Varying Operational Parameters Data Files ............................................... 50
Measured Data Files ............................................................................................ 51
Manage Outputs and Output Tabs ................................................................................ 52
Create a New X-Y Graph..................................................................................... 52
Create a New Table or Bar Chart......................................................................... 53
Add a New Output Tab........................................................................................ 53
Change the Name of an Output Tab..................................................................... 53
Delete an Output Tab........................................................................................... 54
Reorder Outputs................................................................................................... 54
Move Outputs ...................................................................................................... 54
Change an Output’s Details ................................................................................. 54
Export Data for Post Processing .......................................................................... 55
Generate Report ............................................................................................................ 56
Generate Report ................................................................................................... 56
Export to GPS-X........................................................................................................... 56
Export Layout ...................................................................................................... 56
Edit a Basic Dialog ....................................................................................................... 56
Accept Edits to a Dialog ...................................................................................... 56
Cancel Edits to a Dialog ...................................................................................... 56
Change Units ................................................................................................................ 57
Locally on Individual Parameters ........................................................................ 57
Globally on all Parameters................................................................................... 57
Change Parameter Display Options .............................................................................. 57
Significant Figures............................................................................................... 57
iii
About This Guide
This user’s guide describes how to use the most popular features of SimuWorks, the
newest wastewater treatment simulation tool from Hydromantis Inc.
This section provides an overview of the organisation and conventions used in the
guide.
v
SimuWorks User’s Guide
Contents
This guide provides an overview of SimuWorks and details several popular features.
The guide is organised in five sections:
Section III: Getting Started – This section introduces the user interface and gives
an overview of the main features of the program.
Section IV: Tutorials – The section is subdivided into 3 tutorials that are organised
as step-by-step guides to the features and use of SimuWorks.
Section V: How To… – This section is a guide to the use of SimuWorks features
and is organised as a series of step-wise procedures.
Assumption
This guide assumes that you are familiar with the version of Windows you are using.
If you are not familiar with the Windows’ terms such as ‘click’, ‘drag’, ‘menu’, or
‘checkbox’, refer to your Windows’ documentation.
Guide Conventions
For readability, several images are used in the margins to identify and accentuate key
text. The images and their use are:
vi
Introducing SimuWorks
SimuWorks has been designed to give public and private planners, operators and
process specialists the ability to quickly evaluate the performance of a wastewater
treatment system. The software simulates both the steady state and dynamic
behaviour of each unit process based on the influent to the process. This gives the
user the option to simulate the average or the dynamic process behaviour. Typical
defaults have been used for each unit process model to increase the acceptability of
the generated results, but users are free to change the parameters as desired in an
effort to calibrate a given model. The software architecture has been designed
specifically with the user in mind. Its ease-of-use should make it the industry
standard for cost-effective simulation of uncomplicated wastewater treatment
systems including new facilities or the upgrade to existing facilities.
2 SimuWorks User’s Guide
About SimuWorks
Many dynamic process models have been included in SimuWorks including
equalisation, clarification and aeration. But, the backbone of this new simulator is its
new biological process model that includes carbon, 2-step nitrification,
denitrification and biological phosphorus removal. This new model developed
specifically for SimuWorks represents the state-of-the-art in dynamic wastewater
treatment process models.
Model Limitations
Although every attempt has been made to incorporate model features known to exist
in wastewater treatment systems, the user is cautioned about the limitations of
generalised modelling approaches. Necessity dictates that any generalised modelling
approach must include simplifying assumptions. Items such as engineering
judgment, equipment design limitations, site limitations among others things all enter
into the predictive power of the final model. The philosophy of SimuWorks is to
approach each of these problems in a sound fashion. During development of
SimuWorks, various models were reviewed and an attempt was made, where a
choice existed, to include the best possible model for each unit process.
SimuWorks Scope
A distinction should be made between the process models and SimuWorks, the
software package. Although based on a series of process models, the major
emphasis with SimuWorks has been to develop a user-friendly interface that gives
users the ability to link different mathematical models together. By linking the
models together, users can create a wastewater treatment model that incorporates the
unit processes from headworks to discharge. Further, SimuWorks is an enhancement
of previous dynamic simulators as Hydromantis has added a number of new models
and capabilities not commonly found in process simulators on the market today.
System Requirements
SimuWorks requires the following hardware and software as a minimum for
acceptable performance:
SimuWorks Installation
SimuWorks must be installed using the provided installation program. A hardlock
protection device is provided and is required to use all the features of the software.
The SimuWorks CD contains a program called Install.exe that is located in the root
directory. When the CD is placed in the drive the install screen will be displayed.
Note: If the install screen does not automatically appear, browse the CD and
run the program called Install.exe.
Once the installation has started you will be prompted for various pieces of
information including the SimuWorks version you would like to install, your name,
company name and keycode. After selecting an appropriate location for the program
and associated icons, the installation will take a few minutes to complete.
To start SimuWorks: Click the ‘Start’ button, click ‘Programs’, click the
‘Hydromantis SimuWorks’ program group, and select SimuWorks. Note that
SimuWorks will start in demonstration mode unless an appropriate hardlock
protection device is connected to the parallel or USB port on your computer.
User Interface
When SimuWorks is first launched, the user will see the Main Window.
The Main Window consists of the following key components:
• Title Bar
• Menu Bar
• Main Toolbar
• Unit Process Toolbar
• Drawing Board with Interface Tabs
• Information Toolbar
• Simulation Control Toolbar
6 SimuWorks User’s Guide
Window Control
Process
Toolbar
Drawing Board
Title Bar
The Title Bar can be used to move the position of the Main Window on the screen.
The title bar also contains the name of the program (i.e. SimuWorks) and the file
name of the file you are working on. An asterisk to the right of the file name
indicates that a layout change has been detected and the current file should be saved
to ensure no loss of information.
Getting Started 7
Menu Bar
The Menu Bar contains the following menus:
Detailed descriptions of the commands found in these menus appear throughout this
manual.
Toolbar
The Toolbar contains a number of common Windows shortcut buttons including
‘new’, ‘open’, ‘save’ ….
7
8 SimuWorks User’s Guide
Drawing Board
The Drawing Board is where the user ‘draws’ a schematic of the plant layout and
process flow.
Setup Options
The SimuWorks user interface
provides the user with the
ability to change several global
setup and layout-specific
options.
In addition to being able to change the units globally, SimuWorks allows the user to
change units of individual values if necessary. Right (or Left) -clicking directly on
the units of a variable will bring up a list of alternatives. The user can then select the
preferred units from the list.
Drawing a Layout
The drawing board forms the basis for the design of the system flow scheme. Unit
process objects are dragged from the Unit Process Toolbar to the drawing board with
the mouse. The objects are linked via virtual pipes to signal the flow of the liquid
and/or solid streams (see the ‘How To…’ chapter of this manual for more detailed
information on drawing a flow scheme and connecting objects).
In general, the unit process parameters, which can be found in the unit process dialog
(see the ‘How To…’ chapter of this manual for the procedure used to access this
9
10 SimuWorks User’s Guide
dialog), can be subdivided into four categories [note that not all the unit processes
have all categories]:
• Labels
• Physical
• Operational
• Notes
Labels
The labels tab allows the user to enter unique stream identifiers for process streams
on the drawing board. This feature makes it easier for the user to identify streams
when creating outputs or analysing data on outputs.
Physical
The physical tab is used for entering the physical characteristics of the particular unit
process such as the unit’s depth, surface area and/or volume. For unit processes with
pumps such as clarifiers and equalisation tanks, the user will specify the flow rates
on the physical tab.
Operational
The operational tab is used
to enter data related to the
operation of the unit process
and the underlying model.
For the CSTR and
Equalisation Tank, this tab
is called ‘Aeration’ and is
where the user will enter the
characteristics of the
aeration system in the tank.
For clarifiers, this tab is used
to specify the type of model
to be used (i.e. mechanistic
or empirical).
Notes
The notes tab is the final tab in each process dialog. This tab can be used to type
layout specific notes about specific objects. For instance it may be advantageous to
type notes about a CSTRs aeration system or assumptions made about a clarifier.
This tab contains a simple text editor so any text entries are valid. Information
entered here has no impact on the dynamic simulation results.
Getting Started 11
Model Data
Note: To effectively use SimuWorks, the user should understand the basics of
mathematical modelling and the impact of modelling parameters.
SimuWorks assumes that all bioreactors behave in a similar way. It is
believed that this simplification will introduce little or no error in its
predictive power, but users that require different models in different
bioreactors or different parameters in different bioreactors should
consider obtaining a copy of GPS-X, which is Hydromantis, Inc.’s other
wastewater treatment simulation tool.
Model Parameters
The biological model in
SimuWorks requires a
number of parameters. Some
users may find it necessary to
change these parameters
during the course of a
modelling project in order to
achieve a better fit between
measured and modelled
results. The model
parameters dialog can be
accessed by selecting Model
Parameters from the Input
menu.
Temperature
Biological reactions are subject to temperature effects. As such, a temperature
model has been included in SimuWorks so that seasonal impacts (due of temperature
changes) can be simulated. Users can enter a constant temperature so that the entire
simulation will be carried out at a
single specified temperature or
users can choose to vary
temperature with time.
11
12 SimuWorks User’s Guide
Next to the buttons are an indicator panel and a progress bar. During a simulation,
the indicator panel will blink indicating that a simulation is in progress. Similarly,
the progress bar will be coloured in as the simulation progresses as an indicator of
the per cent complete based on the entered ‘Stop at:’ time.
Outputs
The model outputs can be viewed in graphs, tables or bar
charts. These outputs can be created by clicking on the
Outputs tab located above the drawing board. A one-step simple wizard-like
operation is used to create and edit the outputs. This wizard gives the user easy
access to all the model variables so that users can easily add, and delete variables
from the outputs they have created.
Getting Started 13
Legend
Reports
SimuWorks has an advanced report functionality that allows users to print out a
detailed report of their simulation findings. Created through the File>Generate
Report menu option, the rich text formatted (*.rtf) file that is created is word
processor ready. Each report contains a number of sections as specified by the user
including a table of contents, a picture of the layout, model parameters, user inputs
and if a dynamic simulation has been performed, pictures of the outputs. Further,
any notes entered by the user are also incorporated in to the appendices for easy
access to all the information about the layout and the simulation.
13
Tutorials
Introduction
SimuWorks has many unique features that make it a powerful tool for the simulation
of wastewater treatment facilities. As you become acquainted with SimuWorks, you
will quickly see ways it can be used to make your engineering tasks more productive.
This Tutorial chapter is intended for first-time users of SimuWorks and is meant to
introduce the user to many of the features and procedures used in SimuWorks. To
best understand the material in these tutorials, you should have a background in the
fundamentals of wastewater treatment including the unit processes and typical
wastewater treatment facility modelling.
16 SimuWorks User’s Guide
This chapter is divided into 3 tutorials that cover various aspects and features of
SimuWorks.
As with the rest of this guide, it is assumed that you have a working knowledge of
your computer’s operating system and that SimuWorks is properly installed on your
computer.
Tutorials 17
Tutorial 1:
Basic Simulation
17
18 SimuWorks User’s Guide
Alternatively:
1. Access the drawing board edit menu by right-clicking on white space anywhere
on the drawing board.
2. Choose ‘Show grid lines’ from the displayed items. The drawing board grid will
be displayed on the active sheet.
The next step is to drag-and-drop the required unit processes from the Unit Process
Toolbar to the drawing board. To place an influent object on the drawing board:
3. Ensure that the Unit Process Toolbar is
visible
• if not, select the ‘Unit Process
Toolbar’ menu item in the Pane Slat
View>Toolbars drop-down menu to
display the toolbar on the left side of
the drawing board.
Tool Bar
Pane
4. Click on the ‘Unit Processes’ Pane Slat
to reveal the unit processes.
5. Click and drag the ‘Influent’ process icon from the Unit Process Toolbar to the
drawing board.
Tutorials 19
After each of the objects has been placed on the drawing board, the objects must be
connected to define the flow stream.
6. Place the cursor over the connection point of the influent arrow. The cursor
will change to a white block arrow.
7. With the cursor as a white block arrow, click and drag a pipe to the inlet
connection point of the primary clarifier object. Once the cursor turns to a green
block arrow, release the mouse button. A connection pipe will be drawn.
19
20 SimuWorks User’s Guide
Note: If placed at an appropriate connection point, the white arrow will turn
green to signify a suitable connection point. If an unacceptable
connection is attempted, the cursor will turn into a red icon.
10. On the Labels tab, select ‘Use model-based variation’ which will activate the
intraday options
11. Select ‘Sinusoidal variation’, change the Phase Shift to 0.0 and set the
Amplitude Multiplier to 0.5.
12. Click ‘Accept’.
13. Right-click on the primary clarifier object to bring up the clarifier object’s edit
menu.
14. Select ‘Edit Parameters’ from the listed items.
15. Click on the ‘Physical’ tab, and change the volume to 170m3 and the Underflow
– ‘Constant flow’ to 40m3.
16. Next, access the ‘Operational’ tab
and confirm that Empirical
Settling is selected and the Solids
removal is 60%.
17. Click ‘Accept’.
18. Right-click on the CSTR object to
bring up the object’s edit menu.
19. Select ‘Edit Parameters’ from the
listed items.
20. Click on the ‘Physical’ tab, and
change the volume to 700m3.
21. Next, access the ‘Aeration’ tab
and confirm that ‘DO setpoint’ is
selected and set to 2.0 mg/L.
22. Click ‘Accept’.
21
22 SimuWorks User’s Guide
30. Select ‘Save As’ from the File menu and save the layout with an appropriate
name and in a location of your choice.
Creating Outputs
With the layout completed, it is time to setup some outputs to view the model results.
33. Click on the ‘Create a new graph’ and enter a name for your graph and tab that it
will appear on.
34. Click ‘Setup’.
35. In the Setup Graph dialog, choose ‘Secondary’ from the Location – ‘Unit
Process’ drop-down box and ‘Secondary_o1’ in the Stream box.
36. Next, check the ‘snh free and ionized ammonia’ and the ‘no3 nitrate’
checkboxes found in the State Variables sub-list.
37. Click ‘Add’.
38. Click ‘Accept’. You have now created an X-Y graph.
23
24 SimuWorks User’s Guide
39. On the shortcut toolbar, locate and click on the ‘Tables/Bar Charts’ button. This
will open the Setup Tables/Bar Chart dialog.
40. Click on the ‘Create a new tables/bar chart’ and enter a name for your
table. Leave the ‘Create in tab:’ field as it is.
41. Click ‘Setup’.
Tutorials 25
42. In the Chart Variables dialog that automatically opens, check the ‘sp soluble
ortho-phosphate’, ‘stp filter phosphorus’, ‘xtp particulate phosphorus’ and ‘tp
total phosphorus’ checkboxes.
43. Click ‘Accept’.
44. The Setup Table/Bar Chart dialog is now displayed, choose ‘Influent’ from the
Location – ‘Unit Process’ drop-down box and ‘Influent_o1’ in the Stream box.
45. Click ‘Add’.
46. Next, choose ‘Primary’ from the Location – ‘Unit Process’ drop-down box and
‘Primary_o1’ in the Stream box.
47. Click ‘Add’.
48. Next, choose ‘Primary_u1’ in the
Stream box.
49. Click ‘Add’.
50. Next, choose ‘Secondary’ from the
Location – ‘Unit Process’ drop-down
box and ‘Secondary_o1’ in the Stream
box.
51. Click ‘Add’.
52. Finally, choose ‘Secondary_u1’ in the
Stream box.
53. Click ‘Add’.
25
26 SimuWorks User’s Guide
55. Return to the Layout tab (top right of drawing board) and single-click on the
CSTR object. This will display the CSTR object on the Information Toolbar.
56. Return to the Outputs tab.
Running a Simulation
57. In the ‘Stop at: ‘ entry field at the bottom of the window, enter 2.0.
58. Start the 2-day simulation by clicking on the ‘Play’
button to the left of the ‘Stop at’ entry field.
After running your 2-day simulation you should see something similar to what is
shown. Hopefully you will have noticed several things during the simulation
including, that the table values and Information Toolbar information are being
updated continuously and that the Y-axis of the graph was automatically rescaled to
fit the data plotted.
Tutorials 27
From the output it is difficult to see the effluent ammonia numbers so we shall now
reconfigure the graph setup.
27
28 SimuWorks User’s Guide
The graph will automatically re-scale and the ammonia line should now be more
clearly visible. Note that the ‘Details’ dialog where this scaling was changed can be
used to change the look of the graph and the lines drawn on it. It is also there that
items are removed from graphs (see the ‘Variables’ tab).
This example has provided a simple illustration of the basic simulation features of
SimuWorks. Future tutorials will address more complex issues including influent
data, influent characterisation, and inputting time-varying data like temperature and
flows.
Tutorials 29
Tutorial 2:
Data Input and Output
29
30 SimuWorks User’s Guide
3. Click the ‘Edit’ button that appears next to the influent arrow on the Information
Toolbar.
Note: You can also access the influent arrow parameters dialog by right-
clicking on the influent arrow in the drawing board area and selecting
‘Edit Parameters’ from the menu that appears or by double-clicking on
the influent arrow.
4. With the influent object’s parameters dialog open, select the ‘Labels’ tab.
5. Above and next to the influent arrow image, you will see two text fields. In the
entry field above the arrow type ‘Influent’, in the field to the right of arrow type
‘raw’.
6. Click ‘Accept’.
7. Repeat steps 2 to 6 for the Primary Clarifier, CSTR, Secondary Clarifier and
Pumped Splitter using the following labels:
After you have completed this labelling, if you click on the ‘Outputs’ (top-right of
the drawing board) you will notice that all of the graph labels have changed to reflect
the changes in the labels you have just made.
We will now setup a ‘Measured Data’ file. Measured data is assumed to be process-
related data (solids, CODs, BODs …) that were measured on-site to which the model
predictions will be compared. In this case we will assume that ammonia and nitrate
measurements are available.
In this case the cryptic variable is snh for ammonia, but users are referred to the X-Y
graph setup dialog to confirm the cryptic names they should use. In that dialog the
cryptic names precede the descriptive names.
Tutorials 31
10. In the second data column (3rd column), enter the string identifying nitrate in the
effluent (i.e. Secondary/seceff/sno3).
11. Create the columns of data as shown and save the file as a tab delimited txt file
with a name of your choice.
12. Close the txt file you have just created.
13. In SimuWorks, return to the ‘Layout’ tab (top-right of drawing board).
14. From the ‘Input’ menu on the Menu Bar, select “Measured Data’.
15. Select ‘File Input’.
16. Click on the’ Browse’ button and navigate to the txt file you just created.
17. Click Open.
31
32 SimuWorks User’s Guide
Note that this example is for illustrative purposes only and was chosen as it results in
a significant change in the model behaviour. Nevertheless, it should be noted that all
operational data are input in the same way.
20. Create a new X-Y graph on a new tab entitled ‘DO’ and place the CSTR
dissolved oxygen variable on this new graph (see steps 31 to 38 of Tutorial 1, if
you do not know how to create an X-Y graph).
21. Open some kind of text editor/spreadsheet program (for illustrative purposes,
MS Excel is used here).
In operational data files, a header line is not used as each operational data file is
assumed to have only two columns and each data file should contain only one
parameter. That is, if you wish to read in underflow and waste flow data from
prepared data files then you will have to create two files, one with the underflow data
and one with the waste flow data.
The first column of any operational data file must always be time and the second
column contains the parameter data in the DEFAULT units. The user is cautioned to
take care when preparing data files to ensure that the parameter units are correct.
22. Create the columns of data as shown and save the file as a tab delimited txt file
with a name of your choice.
28. Click on the ‘Load data from a file’ button found at the bottom of the Data Input
dialog.
29. Browse to the location of the text file you just created, and click Open. You will
notice that your data has now populated the cells.
30. Click ‘Accept’.
31. Click ‘Accept’.
32. Return to the Outputs tab.
33. Click ‘Play’ to run the simulation again. You will see that the data file you just
created and imported has been read in and has had an impact on the ammonia
and nitrate results.
SimuWorks also includes an option to interpolate between data points for operational
data.
34. Return to the DO time varying data and check the ‘Interpolate data’ checkbox to
try this option.
35. Click ‘Accept’.
36. Click ‘Accept’.
37. Return to the Outputs tab.
33
34 SimuWorks User’s Guide
38. Click ‘Play’ to run the simulation again. You will see that checking the
interpolate box has changed the model results.
Note: To export data directly from a graph or table the tables must have data
in the cells, or lines must be drawn on the graphs.
39. Right-click on any one of the graphs or tables you have created and select
‘Export Data’.
40. Give the text file a name and click ‘Save’. This sequence of events has created a
text file that contains the data used for that output. In the case of a table it is the
instantaneous data at the time of export. In the case of a graph, it is the time
varying data plotted on the graph.
41. Open a text editor (or spreadsheet program) and view the file that was created.
Occasionally a simulation is run and data of interest has inadvertently not been
placed on a graph. A new graph can be created and the simulation can be run again
or, you can ‘dump’ all the simulation data for all streams and search through this
data for the data of interest. This feature may be of particular interest when a
simulation takes a long time to run and re-running the simulation would not be
efficient.
50. Navigate to an appropriate directory, and choose a name for the report (the
report will have an rtf extension).
51. Click ‘Save’.
52. Now, with a word processor, like MS Word, open the rtf file.
Note: A table of contents has been encrypted into the report (cannot at first be
seen) automatically, but because each PC will have a different page
layout configuration, the user should ‘update fields’ if they would like the
table of contents to be visible. In MS Word (English edition), click F9 to
update the Table of Contents.
This example has provided a simple illustration of the basic data input and output
features of SimuWorks. The next tutorial will address more complex issues
including influent data, and influent characterisation.
35
36 SimuWorks User’s Guide
Tutorial 3:
Influent Characterisation & Data
4. Click on the ‘States’ tab. Here you will see a list of state variables used in
SimuWorks. These states are present in all streams in your model and form the
basis for the model predictions. In all streams but the influent, the values of the
states will be calculated. Only in the influent(s) can a user directly manipulate
the SimuWorks state variable values.
5. Click on the ‘COD Tree’ tab. Here you will see a dynamic schematic picture of
the relationships between the state variables (in the olive-coloured boxes on the
left) and the composite variables (in the blue and orange-coloured boxes on the
right). Click on the other Tree tabs to see other relationships.
6. Return to the ‘States’ tab and change the ‘xbh active heterotrophic biomass’ to
100.
7. Click on the ‘COD Tree’ tab to see how that change has resulted in changes to
the COD and solids composite variables. As active biomass is assumed to have
a BOD and contain nitrogen and phosphorus (ratios adjusted in the Model
Parameters dialog – see ‘Edit Global Modelling Parameters’ in the ‘Edit
Parameters’ section of the How To… chapter), click on all the Tree tabs and see
how this state variable change has resulted in changes to the BOD, TKN and TP
calculations.
There are two influent models (calculation paths) in SimuWorks: i) States; and ii)
Fractions. Depending on the data that you have you may find it useful to use the
States tab, the Fractions tab or a combination of both. Changing the entered data on
either of these tabs is allowed, and will result in the recalculation of all variables
when the user clicks ‘Accept’ OR, changes tabs. Note that changing state values on
the ‘States’ tab will have an impact on the numbers displayed on the ‘Fractions’ tab
and visa versa so care should be taken when entering the data to ensure that all
variables (states and composites) agree with measured values. The user is
encouraged to make use of the Tree tabs to help.
37
38 SimuWorks User’s Guide
All influent data files must be configured using the same format and data must be
entered for all states in the correct order.
9. In the first row, enter the following variables IN ORDER (each variable in
sequential cells, no stream labels are required):
//time, flow, si, srbc, srbf, ssh, xbh, xbp, xbao, xbno, xpha, xs, xi, xe, xii, snh, snd,
sni, xnd, sno2, sno3, sp, xppr, xpp, xpd, so, salk, fcv, fbod
The ‘//’ before ‘time’ is required so that SimuWorks will ignore this line. All
variables in a SimuWorks influent file must be entered in the correct SI units
irrespective of the default units chosen in the program. Time is entered in days, flow
must be in m3/d and the states are entered in g/m3 (equivalent to mg/L).
10. In subsequent rows enter data for all the states at every time interval specified.
The time interval between rows need not be equal.
11. Save the file as a tab delimited txt file.
12. Close the file.
13. In SimuWorks, access the influent object’s parameters menu by right-clicking
on the influent object and choosing ‘Edit Parameters’.
14. Select ‘File Input’ and browse to the file you just created.
15. Click ‘Open’.
16. You will have noticed that the tabs have changed, click on the ‘File Input’ tab
and you will see your data in the table. Your data will now be read in and used
as the simulation progresses.
17. Click ‘Accept’.
18. Click on the Outputs tab.
19. In the ‘Stop at: ‘ entry field at the bottom of the window, enter 2.0 if not already
done.
20. Start the 2-day simulation by clicking on the ‘Play’
button to the left of the ‘Stop at’ entry field and see
the impact of your influent data file on the simulation results.
21. Return to the ‘File Input’ tab in the influent parameters dialog.
22. At the bottom of this tab, select ‘Interpolate values between data points’.
23. Check the ‘Flow’ and/or the ‘Concentrations’ checkbox(es).
Tutorials 39
This concludes the tutorial section of the SimuWorks manual. The tutorials have
been designed to give new users an introduction to some of the basic features in
SimuWorks. For a more extensive list of procedures, the reader is referred to the
‘How To…’ chapter of this manual.
39
How To…
Change Keycodes
Change Keycode
To change the SimuWorks keycode:
1. Access the Licence Information dialog by selecting ‘Licence Information’ from
the Help menu.
2. Copy and Paste (or manually type) the new keycode into the Keycode entry
field.
3. Click ‘Accept’.
4. Restart SimuWorks to
activate the new keycode.
42 SimuWorks User’s Guide
Manage Files
Start a New File
There are three (3) ways to start a new file:
• By default, when SimuWorks is first opened from the
SimuWorks program group on the Start Menu, a new file
is created with a blank Drawing Board.
• If SimuWorks is open, a user can start a new project by:
o Clicking the ‘New’ shortcut button ( ) on the
Main Toolbar; or,
o Selecting ‘New’ from the File menu found on the
Menu Bar.
Open
To Open an existing SimuWorks file, a user can:
• Click on the ‘Open’ shortcut button ( ) on the Main Toolbar; or,
• Select ‘Open’ from the File menu found on the Menu Bar; or,
• If the layout of interest is one of the last four edited, it can be selected from
the list at the bottom of the File menu found on the Menu Bar.
Save
To Save a SimuWorks file, a user can:
• Click on the ‘Save’ shortcut button ( ) on the Main
Toolbar; or,
• Select ‘Save’ from the File menu found on the Menu Bar;
or,
• Use the ‘Save As’ command (see below).
Save As
To Save a new SimuWorks layout:
1. Select ‘Save As’ from the File menu found on the Menu Bar.
2. In the ‘File name’ entry field, enter a name for the layout to be saved.
3. If the displayed directory is not the correct directory for this file, use the drop-
down menu and shortcut buttons found at the top of the ‘Save’ dialog window to
navigate to the appropriate directory.
4. Click ‘Save’.
How To… 43
Tip: The name of an existing file can be changed by opening the file and
then selecting the ‘Save As’ command from the File Menu. When
prompted to do so, enter a new name for the file and click the ‘Save’
button.
Tip: The selection box also can be removed from the drawing board by
drawing a very small inclusion box that does not include a full grid cell in
an unoccupied grid cell.
43
44 SimuWorks User’s Guide
Cut
The ‘Cut’ command (when combined with the ‘Paste’ command) can be used to
move objects to a new location on the drawing board or to a new layout. It can also
be used to remove objects from the drawing board.
Note: It must be noted that if one or more objects is ‘Cut’ from the drawing
board, all output variables previously on graphs and in tables will be
removed. Pasting the objects to a new location on the same drawing
board does NOT restore the variables to the outputs.
Copy
The ‘Copy’ command can be used to create duplicate objects at a new location on the
drawing board.
Tip: A ‘quick key’ procedure for copying a single object on the drawing board
is also available. While holding down the <Ctrl> key, left-click the object
to be copied and drag the cursor to an unoccupied grid cell. A duplicate
object will be created there.
Paste
The ‘Paste’ command is used to transfer objects from the clipboard to the drawing
board.
Note: If the clipboard objects were copied then the ‘Paste’ command creates
duplicate objects on the drawing board that contain the same data as
the original objects.
Delete
A Single Layout Object
To ‘Delete’ a single layout object:
1. Access the object’s edit menu by right-clicking on
the unit process object.
2. Select ‘Delete’ from the displayed menu.
3. Answer ‘Yes’ to the delete warning message.
45
46 SimuWorks User’s Guide
To move an object:
1. Left-click on the object and while keeping the left mouse button depressed, drag
the object to its new location. Any connections to that object will be adjusted to
the new location.
Acceptable Connection
How To… 47
Delete Connections
To delete a connection between two objects:
1. Access the object’s edit menu by right-clicking on the unit process object.
2. Select ‘Delete “_____” connection’ from the displayed menu.
3. Answer ‘Yes’ to the delete warning message.
Alternatively:
1. Select the upstream end of the pipe that is to be
deleted and drag a pipe to an unoccupied grid cell.
Alternatively:
3. Access the drawing board edit menu by right-clicking on white space anywhere
on the drawing board.
4. Choose ‘Show grid lines’ from the displayed items. The drawing board grid will
be displayed.
Alternatively:
1. Access the drawing board edit menu by right-
clicking on white space anywhere on the drawing
board.
2. Choose ‘Show process labels’ from the displayed
items. The unit process labels will be displayed.
47
48 SimuWorks User’s Guide
Alternatively:
1. Access the drawing board edit menu by right-clicking on white space anywhere
on the drawing board.
2. Choose ‘Show connection
points’ from the displayed
items. The unit process
connection points will be
displayed.
Edit Parameters
Edit Influent Wastewater Characteristics
To edit the influent wastewater characteristics:
1. Access the influent wastewater process edit menu by right-clicking on the
influent object.
2. Select ‘Edit Parameters’ from the menu list.
3. In the displayed dialog change all the parameters that need changing.
4. Click ‘Accept’.
49
50 SimuWorks User’s Guide
//time, flow, si, srbc, srbf, ssh, xbh, xbp, xbao, xbno, xpha, xs, xi, xe, xii, snh, snd,
sni, xnd, sno2, sno3, sp, xppr, xpp, xpd, so, salk, fcv, fbod
The ‘//’ before ‘time’ is required so that SimuWorks will ignore this line; however,
including this line is recommended for purposes of clarity in the columns.
3. In subsequent rows enter data for all the states at every time interval specified.
4. Save the file as a tab delimited txt file.
5. Close the file.
6. In SimuWorks, access the influent object’s menu by right-clicking on the
influent object and selecting ‘Edit Parameters’.
7. Select ‘File Input’ and browse to the file you just created.
8. Click ‘Open’.
9. You will have noticed that the influent parameters tabs have changed, click on
the ‘File Input’ tab and you will see your data in the table. Your data will now
be read in and used as the simulation progresses.
All time-varying operational parameter data files must be configured using the same
format and each time-varying parameter should be in its own data file. The first
column is time and the second column is the data.
\
2. Enter the time in the first column and the data in the second.
3. Save the file as a tab delimited txt file.
4. Close the file.
5. In SimuWorks, access the object’s menu by right-clicking on the object and
selecting ‘Edit Parameters’.
How To… 51
6. Find the location of ‘Time Varying’ parameter and click on the ‘Data’ button.
7. Enter the data manually, or click on the From File image and browse to the file
you just created.
8. Click ‘Open’.
9. You will have noticed that the data has now been placed in the table. Your data
will now be read in and used as the simulation progresses.
Users are referred to the X-Y graph setup dialog to confirm the cryptic names they
should use. In that dialog, the cryptic names precede the descriptive names.
51
52 SimuWorks User’s Guide
The graph has now been created, but no variables have yet been placed onto the
graph. The following steps should be followed to add variables to the graph.
6. In the Setup Graph dialog, select a Unit Process and a Stream in the Location
sub-section.
7. From the State, Composite and Additional Variables sub-sections select the
checkboxes of the variables of interest for the chosen graph.
8. Click ‘Add’.
9. Continue selecting graphs, locations and/or variables and clicking ‘Add’ until all
graphs have the proper variables that you wish to display.
How To… 53
The table (or bar chart) has now been created, but no variables have yet been placed
onto the output. The following steps should be followed to add variables to the
output.
7. In the Chart Variables dialog, select the variables for the output.
8. Click ‘Accept’.
9. In the Setup Table/Bar Chart
dialog, choose the Location(s) to
be displayed on the chart.
10. Click ‘Add’ for each new location.
11. Continue selecting charts and
locations, and clicking ‘Add’ until
all charts have the proper variables
you want to display.
Alternatively, select ‘Rename Tab’ from the Edit menu in the Menu Bar.
53
54 SimuWorks User’s Guide
Alternatively, you can left-click on the desired graph/table/bar chart to give it the
‘focus’ (ie. a dotted line around it’s perimeter) and then select ‘Move’ or ‘Delete’
from the Edit menu in the Menu Bar.
Reorder Outputs
To change the arrangement of the SimuWorks outputs on a tab:
1. Select the output tab on which you would like to reorder the outputs.
2. Right-click anywhere on the tab to access the the output tab’s menu and select
‘Reorder’.
3. Using the directional buttons at the buttom of the dialog, select
the output to be reordered and move it to a new location.
4. If required, select another tab from the list on the left and
reorder as needed.
5. When complete, click ‘Accept’.
Move Outputs
To move an output from one tab to another:
1. Select the output tab on which you would like to move the outputs.
2. Right-click anywhere on the tab to access the the output tab’s
menu and select ‘Move’.
3. Select the tab that you would like to move the output to, or
create a new tab.
4. Click ‘Accept’.
Note: To export data directly from a graph or table the tables must have data
in the cells, or lines must be drawn on the graphs.
1. Right-click on any one of the graphs or tables you have created and select
‘Export Data’.
2. Give the text file a name and click ‘Save’. This sequence of
events has created a text file that contains the data used for that
output. In the case of a table it is the instantaneous data at the
time of export. In the case of a graph, it is the time varying data
plotted on the graph.
3. Open a text editor (or spreadsheet program) and view the file
that was created.
Occasionally a simulation is run and data of interest has inadvertently not been
placed on a graph. A new graph can be created and the simulation can be run again
or, you can ‘dump’ all the simulation data for all streams and search through this
data for the data of interest. This feature may be of particular interest when a
simulation takes a long time to run and re-running the
simulation would not be efficient.
55
56 SimuWorks User’s Guide
Generate Report
Generate Report
To generate a SimuWorks report:
1. Access the SimuWorks Report Setup dialog box by selecting ‘Generate Report’
from the File menu found on the Menu Bar.
2. Choose the required options by checking the appropriate checkboxes.
3. Click ‘Accept’.
4. Select a file name and location.
5. Click ‘Save’.
The report that is generated by this series of steps is a rich-text formatted (.rtf) file
that can be read by most advanced word processing programs. The user is cautioned
that the report generation feature of SimuWorks was tested only in MS Word.
Figures and the Table of Contents may not be properly displayed in all word
processors.
Export to GPS-X
Export Layout
To export a SimuWorks layout to GPS-X:
1. Select ‘Export to GPS-X…’ from the File menu found on the
Menu Bar.
2. Select a file name and location.
3. Click ‘Save’.
Change Units
Variables can by default be displayed with U.S. Units or SI Units, or a user can
change the units of specific parameters if necessary. SimuWorks includes a unit
conversion algorithm that automatically corrects any displayed value if the units are
changed. Units can be changed on-the-fly and SimuWorks will automatically make
the necessary changes in the appropriate
dialog boxes.
57