Delft3d-Quickplot User Manual
Delft3d-Quickplot User Manual
Delft3D
QUICKPLOT
User Manual
Delft3D-QUICKPLOT
User Manual
Version: 2.15.30932
26 May 2014
Delft3D-QUICKPLOT, User Manual
Contents
1 Introduction 1
1.1 Version information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.2 List of major changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
1.3 Known issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2 Getting started 5
2.1 Starting the program . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2 Selecting a data file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.3 Selecting a data field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.4 Selecting time and location . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.5 Creating a plot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
3 Plotting options 15
3.1 Data units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
3.2 Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
3.3 Axes type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
3.4 Plot coordinate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
3.5 Vector style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
3.6 Vector scaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
3.7 Vertical scaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.8 Presentation type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
3.9 Formatting of texts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
3.10 Colouring vectors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
3.11 Colouring dams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
3.12 Thresholds for contours . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
3.13 Colour . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
3.14 Fill polygons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
3.15 Text box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
3.16 Line style . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
3.17 Line width . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
3.18 Marker settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
3.19 Colour limits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
3.20 Colour map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
3.21 Colour bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
3.22 Field thinning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.23 Clipping data values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
3.24 Clipping coordinate values . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
5 Digging deeper 33
5.1 Setting preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
5.1.1 General preferences . . . . . . . . . . . . . . . . . . . . . . . . . . 33
5.1.2 Quick View preferences . . . . . . . . . . . . . . . . . . . . . . . . 33
5.1.3 Grid View preferences . . . . . . . . . . . . . . . . . . . . . . . . . 33
5.2 Combining multiple data sets in one plot . . . . . . . . . . . . . . . . . . . . 37
5.3 Difference of Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
5.4 Plot Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Deltares iii
Delft3D-QUICKPLOT, User Manual
iv Deltares
Contents
Deltares v
Delft3D-QUICKPLOT, User Manual
vi Deltares
List of Figures
List of Figures
2.1 Delft3D-QUICKPLOT main window . . . . . . . . . . . . . . . . . . . . . . . 6
2.2 The ‘File Open’ command can be selected in two ways: from the File menu
and from the toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.3 The File menu contains a list of the most recently opened files . . . . . . . . 7
2.4 The leftmost buttons on the toolbar of the main window are used for file oper-
ations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.5 User interface after opening a Delft3D-FLOW map file. . . . . . . . . . . . . 8
2.6 List of data fields in the Delft3D-FLOW map file. . . . . . . . . . . . . . . . . 9
2.7 The list of plot options is changed after selection of the water level from the
dropdown list. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2.8 Optional listing of the times associated with the various time steps. . . . . . . 11
2.9 Selection of a cross-section along a grid line in M direction: one M value, all N
values. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.10 Selection of a cross-section piecewise along a grid lines. . . . . . . . . . . . 12
2.11 Selection of an arbitrary cross-section using (x,y) co-ordinates. . . . . . . . . 12
2.12 Example of the station list in case of a history file. . . . . . . . . . . . . . . . 12
2.13 2D Plot of the water levels. . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
2.14 Plot of the water levels along a grid line of constant M. . . . . . . . . . . . . 14
2.15 Time-series plot of the convergence of the water levels at point M=40, N=134
to a stationary solution. Markers added for clarity (see section 3.18).. . . . . 14
Deltares vii
Delft3D-QUICKPLOT, User Manual
3.24 Marker option selecting circles with a blue border and fill colour dependent on
the local value. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
3.25 The colour limits have been set manually to 5 and 30, respectively. . . . . . . 25
3.26 List of colour maps available to the Delft3D-QUICKPLOT user. . . . . . . . . 26
3.27 A colour map can be selected from the dropdown list. The colour map preview
will update when another colour map has been selected. . . . . . . . . . . . 26
3.28 Checkboxes for plotting a vertical (or optionally horizontal) colour bar. . . . . 26
3.29 Optional field thinning based on grid numbers (uniform thinning) or distance. 27
3.30 Example of a marker plot without thinning (left), uniform thinning (factor 2) and
distance thinning (right). . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
3.31 This setting will clip the values equal to -999, or larger than 0 and less than or
equal to 4, or larger than 7. . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
viii Deltares
List of Figures
Deltares ix
Delft3D-QUICKPLOT, User Manual
x Deltares
List of Tables
List of Tables
4.1 Overview of the data export options . . . . . . . . . . . . . . . . . . . . . . 29
Deltares xi
Delft3D-QUICKPLOT, User Manual
xii Deltares
1 Introduction
This manual describes the features of Delft3D-QUICKPLOT. The program can be used to
visualise and animate numerical results produced by the Delft3D modules and some other
programs (a.o. UNIBEST, SOBEK, PHAROS). The program has been developed using MAT-
LAB. The Delft3D-MATLAB interface contains a version of Delft3D-QUICKPLOT that inte-
grates seamlessly with the MATLAB environment.
Delft3D-QUICKPLOT has been developed to be a user-friendly, flexible and robust tool for
interactive data visualisation and animation. For instance, all active buttons and edit fields
have tool tips that provide online help. Therefore, Chapter 2 contains only a short tutorial to
get you familiar with the main program window for creating basic plots. Chapter 3 describes
all plot options. Chapter 4 explains how to export and print figures. Chapter 5 addresses the
more advanced features of Delft3D-QUICKPLOT.
Delft3D-QUICKPLOT was created using MATLAB and the MATLAB Compiler by The Math-
Works, Inc.. This program requires technology of The MathWorks to run, a.o. the MATLAB
Compiler Runtime (MCR) Libraries. These MCR Libraries have been installed as a sepa-
rate step during the Delft3D installation. This technology is governed by additional license
conditions; please read the The MathWorks license agreement for details (this agreement is
included in license.txt in the MCR Installation directory).
Version Description
2.14 new colour maps, improved z-layer support, improved Pharos support, support
for D-Water Quality/ECO on Telemac and SOBEK-2D (arcgrid) grids
2.13 white or coloured background for printing, plot options undockable, plot manager
resizable, shape file support extended, PART files with bed layer accepted, sup-
port for NEFIS 5 files larger than 4GB, segment numbers, support for data on
polygons, conditional user defined function, only selected component exported
to .mat file, z-layer model supported for COM en WAQ files, TRITON support,
1DV PART stations, units for PART, boundaries for TRIM, multiple print/export
2.12 3D support for Telemac, support for multi-sediment fraction output dredging
his file, support for wind data on TRIM, COM and WAVM files, update for
trim2rst compatible with new TRIM files, import for QUICKIN HLS files,clip data
of patches with undefined corner, patch plots for vector defined at grid corner
points corrected
Deltares 1
Delft3D-QUICKPLOT, User Manual
Version Description
2.11 avi file export (windows only), net transport in balance files, "all" option imple-
mented for stations, remember last 9 data files opened, export vectors to shape
file, support for SWAN spectral files, plot against path, rev.path, x, or y, sup-
port for generalised sigma TRIM file, netCDF support, vector style changeable,
preferences for plot box and axes colour, list of vector components extended
2.10 optional treatment of Delwaq history file as 1D channel, water depth added for
SDS files, arbitrary cross-section, limiting factors, balance plots, default figure
from file, persistent last file type between sessions, new license library
2.09 unit conversion, export tekal time-series, improved z-layer support for trih-files,
improved support for enclosure files
2.08 grid export to shape file, concatenate option for time series (user defined vari-
ables), animate across figures, quantity names in samples export, export grid
line as spline
2.07 basic support for data exported in MATLAB file format as input, levels (such as
water levels) can be combined with cross-sectional plots of 3D data sets.
2.06 support for more trih/trim/trah fields, dry points on grid, froude number and head
from trim file, ldb support improved, export bug related to subfield selection re-
solved, run both log and script files, unit discharge instead of discharge from
com file, time line option for scalar data sets, distinguish identically named items
in plot manager, ldb plotting added to Grid View window, options persistent when
reloading, support for wind and pressure ARC grid files, vector components from
trih file corrected.
2.05 morphological scale factor support trih/trim, toolbars, markers plotting improved,
wavm support, update of plot manager.
2.01 support for closed (filled-in) polygons, line width, colour maps from file, dis-
charge stations and observation points on grid, multiple sample values, shape
file export improved, text box option, bitmap import added, render figures
in background, correction current velocity and energy transport location on
hwgxy file, correction depth-averaged velocity for z-model on trim file, correc-
tion magnitude in plane, corrections to automatic identification of new fields in
com/trim/tram, retain last print settings.
2 Deltares
Introduction
Deltares 3
Delft3D-QUICKPLOT, User Manual
4 Deltares
2 Getting started
Basically there are just four or five steps to get your first plots using Delft3D-QUICKPLOT:
start the program, select the file, select the data field, select the time and location, and press
plot. The following text will show you how to get your first plots of some Delft3D-FLOW map
and history files (other files can be processed in exactly the same way).
As the program starts, the main program window appears. It will initially look as shown in Fig-
ure 2.1. The left part of the window contains the fields for opening and closing files, selecting
data sets, time steps and plotting locations, and the buttons for creating the actual plots. The
right part of the window (now empty) will contain all options for the selected data set (plot and
export options).
From the standard file selection window that appears select the data file you want to process.
The selection window contains a number of pre-configured filename filters, such as Delft3D
output file <∗.dat> and Delft3D grid file <∗.grd;*.rgf>.
Remarks:
If the file is located on a server that supports OPeNDAP, you may also select the appro-
priate website using the Open URL... menu option. Specify for example:
http://iridl.ldeo.columbia.edu/SOURCES/.WORLDBATH432/.bath/dods
Although the selection interface lists for the Delft3D output files only the data files
<∗.dat>, the accompanying definition files <∗.def> are always required for reading
the data files. Similarly, D-Water Quality aggregated grid files consist of pairs of grid
<∗.cco> and aggregation <∗.lga> files. Furthermore, shape files require in general
shape description <∗.shp>, index <∗.shx> and attribute date <∗.dbf> files. So, in
general one has to realise that the file you select in Delft3D-QUICKPLOT may not be
the only file needed to read the data contained in it. Have a look at Appendix A for an
overview of the files associated with all supported file types.
The filename filter does not influence the automatic recognition procedure that follows
the selection procedure, so any file may be selected with any filename filter active.
Once you have opened one or more files, the File menu contains a list of the most
recently opened files (upto 9) for quick access (see Figure 2.3). This list is persistent
between Delft3D-QUICKPLOT sessions.
Deltares 5
Delft3D-QUICKPLOT, User Manual
Figure 2.2: The ‘File Open’ command can be selected in two ways: from the File menu
and from the toolbar
6 Deltares
Getting started
Figure 2.3: The File menu contains a list of the most recently opened files
Figure 2.4: The leftmost buttons on the toolbar of the main window are used for file oper-
ations.
data fields available from the selected file are shown. The Quick View button for plotting the
result is activated, and some plotting and export options are available from the right part of
the window. This basically indicates that you can already create your first plot now, but let us
first inspect the other parts of the interface.
The button to the left of the Open a data file button is the File reload button. If the opened
file has been changed, you can press this button to update the information initially read
from the data file (e.g. number of time steps stored in the file). This has the basically same
result as re-opening the file. However, file option settings (see below) are persistent when
reloading, but they are reset upon re-opening the file.
Pressing the Close file button to the right of the Open a data file button removes the active
file (i.e. the file selected in the dropdown list of opened files below) from the list of open
files.
Pressing the File options button to the right of the Close file button opens another window
containing some extra commands available for the selected file. For instance, in case of
a Delft3D grid file there will be buttons for opening spatial input files defined on the grid
(such as bathymetry, restart files, and thin dams). The file options dialog is an extension to
the main window, i.e. all changes made in the file options dialog will immediately affect the
main window and vice versa. If you leave it open; it will update automatically if you switch
between files in the main program window. Check out the relevant section in section 5.7
to see what functionality the file options dialog provides for your file format.
Finally, the last button on the right after the separator can be used to open a previously
saved figure (stored MATLAB format).
The purpose of the other toolbar buttons further to the right is explained in Chapter 5.
Deltares 7
Delft3D-QUICKPLOT, User Manual
8 Deltares
Getting started
Different quantities allow for different types of plots and, therefore, the lists of plot and export
options in the right part of the window will adapt to your selection. Figure 2.7 shows the list
of options if the water level (or any other scalar 2D quantity) is selected; the options will be
discussed in Chapter 3. Furthermore, the number of time steps depends on the selected data
field; the example file contains 6 time steps for the water level as indicated by the edit box
below the datafield list box.
The domain selection box between the file selection box and the datafield selection box is
only active when the file may contain multiple domains. Similarly, the subfield selection box
immediately below the datafield selection box is only active when the datafield contains multi-
ple subfields (e.g. the datafield ‘sediment transport’ may have subfields for sediment fractions
1, 2, etc.)
Deltares 9
Delft3D-QUICKPLOT, User Manual
Figure 2.7: The list of plot options is changed after selection of the water level from the
dropdown list.
10 Deltares
Getting started
Figure 2.8: Optional listing of the times associated with the various time steps.
Figure 2.9: Selection of a cross-section along a grid line in M direction: one M value, all
N values.
Remark:
If you want to see the times associated with the time steps stored in the file, check
the Show Times checkbox (see Figure 2.8). Reading and displaying a large number
of times can be very time consuming and you should be careful when opening data
files (generally history files) containing a large number of time steps: uncheck the Show
Times checkbox first.
If instead of a 2D plot of the whole domain, you want a plot of a cross-section along an M grid
line uncheck the All checkbox associated with M and specify the M-value of the desired grid
line as shown in Figure 2.9.
Remarks:
The valid range of grid and time step numbers is indicated to the right of the M/N/K
and time step edit boxes, respectively. The indicated range of grid points includes the
extra row of points added due to staggering of the variables on the computational grid.
Depending on the selected data field, the first and last grid lines may or may not have
data defined on it.
Instead of selecting a block of M and N indices, you may want to select a generic
cross-section that runs piecewise along grid lines (or diagonal lines). This can be ac-
complished by selecting the (MN) option as shown in Figure 2.10. The M and N pairs
should be separated using spaces, commas or semi-colons. Once the input has been
parsed Delft3D-QUICKPLOT will separate to co-ordinate pairs by semi-colons and the
co-ordinate indices by commas as shown in the figure. See also section 5.9 on selecting
such cross-sections interactively.
Another option is to select an arbitrary cross-section using (x,y) co-ordinates. This
feature is activated using the (XY) option as shown in Figure 2.11. The x and y co-
Deltares 11
Delft3D-QUICKPLOT, User Manual
ordinates should be separated using spaces, commas or semi-colons. Once the input
has been parsed Delft3D-QUICKPLOT will separate to co-ordinate pairs by semi-colons
and the co-ordinate indices by commas as shown in the figure. See also section 5.9 on
selecting such cross-sections interactively.
It is currently not yet possible to make generic horizontal slices (such as along Z-planes
instead of K-planes).
If you want a time-series plot at any computational point of the grid, select All (or multiple)
time steps and one M and one N (and optionally one K) co-ordinate.
Remarks:
Multiple time steps can be selected by typing the time steps in the Time Step edit box.
This is particularly useful if the data file contains many time steps; type for instance
1:10:301 if you want to plot every 10th time step of a series of 301 time steps.
The extraction of a time-series from a map-file is carried out by reading for each selected
time step the whole domain and selecting only the requested point. This procedure is
more flexible yet also slower than selecting history points in the Delft3D input.
If you have opened a history file, for instance a Delft3D-FLOW trih-file, the spatial dimensions
m and n will not be available. Instead you can select the observation point or cross-section
name from the station list as shown in Figure 2.12.
12 Deltares
Getting started
Remarks:
If you have selected multiple time steps and a spatially extended plot domain (i.e., all or
multiple M, N or K co-ordinates), the Quick View button will have changed into a Quick
Animate button. Pressing the button will cause the program to animate the selected
plot by looping over the selected time steps. The same result can also be obtained by
selecting one time step initially and using the Animation menu in the plot.
It is currently not possible to plot data sets on a 3D domain (i.e. all or multiple M, N
and K co-ordinates selected). Always specify a single M, N or K co-ordinate for 3D data
sets.
If there are multiple time steps and if you have selected only one, or if you have selected
only one M, N or K co-ordinate, the plot will contain an active slider in the lower left corner
of the plot. You can select other time steps and other spatial co-ordinates using that slider.
See Chapter 5.7 for information on how to use the slider, how to create animations, how to
combine plots, and how to define your own variables.
Deltares 13
Delft3D-QUICKPLOT, User Manual
Figure 2.14: Plot of the water levels along a grid line of constant M.
Figure 2.15: Time-series plot of the convergence of the water levels at point M=40, N=134
to a stationary solution. Markers added for clarity (see section 3.18)..
14 Deltares
3 Plotting options
As already indicated in the ‘Getting started’ chapter, the plot options available in the right
part of the window are constantly adjusting to the selections that you make in the left part
of the window (different data fields from the data file, different selections of space and time
co-ordinates). Note that the list of options, which is by default docked into the right part of the
main window, can also be undocked to a separate window using the undock/dock button at
the top right corner of the option list, just above the scroll bar.
This chapter describes all available options. We will use a 2D vector field (for instance the
depth averaged velocity) as the main example since most options apply to it. Initially the list
of options will look as shown in Figure 3.2a: the plot will result in a field of blue automatically
scaled vectors.
Remarks:
The export option is discussed in Chapter 5.
Changing an option will only affect the options below it. The best way to work through
the list is from top to bottom.
The options interface has been programmed to be “lazy”, that is, the options retain their
setting when switching between data files and data fields. This helps to make consistent
plots of different datasets.
If there are more options available than fit on the screen, the slider just to the right of
the list of options becomes active and it allows you to scroll through all relevant options
(as shown in Figure 3.2b).
Deltares 15
Delft3D-QUICKPLOT, User Manual
Figure 3.2: List of plot options depending on the plot type: (a, left) vector and (b, right)
scalar.
16 Deltares
Plotting options
3.2 Component
This option is only available for vector quantities. Basically, it allows you to select between
different types of derived quantities. A vector quantity may be plotted as a vector, but you can
also plot its magnitude, direction (according to nautical definition) or one of its components
in computational space (M, N) or physical space (X, Y, Z, in plotting plane or perpendicular).
These derived quantities are all scalar quantities, which results in the adjustment of the op-
tions below as shown in Figure 3.2b. Plotting a scalar quantity, such as the water level, gives
the same options as the plotting of a derived quantity such as the velocity magnitude.
Component Description
vector vector
vector (split x, y ) vector plot showing decomposition of vector quantity in x and y
components
vector (split m, n) vector plot showing decomposition of vector quantity in compo-
nents in m and n direction
magnitude magnitude of the vector quantity: (u2x + u2y + u2z )1/2
magnitude in plane magnitude of the vector quantity in the selected plane: (u2m +
u2z )1/2 in case of a vertical plane along an m grid line
normal component vector component perpendicular to plane: equals n component in
case of a vertical plane along an m grid line
angle (...) angle of vector in horizontal plane in degrees or radians clockwise
from North (nautical convention)
x component vector component in x direction
y component vector component in y direction
z component vector component in z direction (corresponds to k direction)
m component vector component in local direction of m grid line
n component
Deltares vector component in local direction of n grid line 17
Delft3D-QUICKPLOT, User Manual
If either one of the options with manual scaling is selected, you are requested to enter a
scaling value: a value of 2.5 indicates that a unit vector (e.g. 1 m/s) is plotted as a vector of
2.5 m length (see Figure 3.8).
Remark:
It is not yet possible to get a legend or unit vector in the plot for reference.
18 Deltares
Plotting options
Deltares 19
Delft3D-QUICKPLOT, User Manual
Figure 3.11: Unrestricted vertical scaling on the left (skewed arrows), vertical scaling fac-
tor of 100 used on the right (non-skewed arrows: arrows corrected for verti-
cal scaling).
20 Deltares
Plotting options
Remarks:
In the case of a patches plot, the uniformly coloured grid cells have their corner points
at depth points of the staggered Delft3D grid. This implies that variables not defined
at the water level point (such as the bed levels in their traditional location) have to
be transformed in some way. The bed level data in the Delft3D-FLOW map file and
the Delft3D communication file are processed in accordance with the selected drying-
flooding criterion. Other variables and bed levels stored in files without information on
the drying-flooding procedure are averaged to the water level points.
In the case of a continuous shades plot or a contour (lines or patches) plot data is lin-
early interpolated between the points at which the values are defined. The interpolation
is carried out across any thin dams that may exist. Furthermore, if the values are de-
fined at the water level points in the centre of the grid cells, there will be half of a grid cell
missing along the outer rim of the plot area. Since version 2.15, the option ‘Extend to
Domain Edge’ is available to fill in these gaps along the boundaries (see Figure 3.13).
The continuous shades plot is not a 2D plot, but basically a 3D plot. The values (or when
available z-data) is used to generate a 3D surface. Combining continuous shades plots
with other plot types is therefore generally not possible.
Deltares 21
Delft3D-QUICKPLOT, User Manual
Figure 3.14: Options available for the formatting of the numerical values.
Figure 3.16: Vector colour dependent on the velocity magnitude (vector length).
22 Deltares
Plotting options
Figure 3.17: Checkbox to indicate optional colouring of thin dam like structures such as
weirs.
Remarks:
If you want only one contour line at an integer value, say 12, you will have to shift it
a little (say, 12.001) to distinguish it from a number indicating the number of automatic
contours.
Areas below the lowest threshold will be clipped. Add a big negative value to prevent
this.
3.13 Colour
You can change the colour used for line graphs, vector fields, values and uniformly coloured
contour lines by clicking on the coloured rectangle of the colour option and selecting the colour
from the standard colour interface. This colour option sets also the colour of the lines if the
presentation type is set to patches with lines or contour patches with lines.
Deltares 23
Delft3D-QUICKPLOT, User Manual
24 Deltares
Plotting options
Figure 3.24: Marker option selecting circles with a blue border and fill colour dependent
on the local value.
Remark:
The colour limits influence the automatic selection of contouring thresholds (see sec-
tion 3.12).
Figure 3.25: The colour limits have been set manually to 5 and 30, respectively.
Deltares 25
Delft3D-QUICKPLOT, User Manual
Figure 3.27: A colour map can be selected from the dropdown list. The colour map pre-
view will update when another colour map has been selected.
Furthermore, it allows you to have any combination of such ranges as shown in Figure 3.31.
Remark:
If you clip values in a certain range, for instance between 0 and 4, and two neighbouring
data points have values at either side outside the range, say -1 and 5, then a continuous
shades plot may still contain some interpolated values in the clipped range.
Figure 3.28: Checkboxes for plotting a vertical (or optionally horizontal) colour bar.
26 Deltares
Plotting options
Figure 3.29: Optional field thinning based on grid numbers (uniform thinning) or distance.
Figure 3.30: Example of a marker plot without thinning (left), uniform thinning (factor 2)
and distance thinning (right).
Figure 3.31: This setting will clip the values equal to -999, or larger than 0 and less than
or equal to 4, or larger than 7.
Deltares 27
Delft3D-QUICKPLOT, User Manual
28 Deltares
4 Export and printing options
At the end of the list of plotting options, there will always be one field that allows you to export
data to a number of file formats (see Figure 4.1). The first section of this chapter lists what
kind of file types are available under which conditions. The second section addresses the
exporting of figures for further processing.
grid file 2DH field, single time grid depends on definition of selected
step data field: hydrodynamic or morphologic
grid
grid file (old format) 2DH field, single time the old grid format with limited precision
step co-ordinates
spline one grid line, single spline format used by RGFGRID
time step
QUICKIN file 2DH field standard format for Delft3D fields
Delft3D-MOR field file 2DH field, scalar val- obsolete file format, use QUICKIN for-
ues mat instead
SIMONA box file 2DH field, scalar val- 3rd party file format, use QUICKIN for-
ues mat instead
ARCview shape 2DH field, (not contin- standard GIS format
uous shades), single
time step
landboundary file polygonal data sets landboundary format used Delft3D
TEKAL file at most 10 time steps largely self-describing ASCII file format
Tecplot file at most 10 time steps ASCII or BINARY file format used by the
visualisation program Tecplot
CSV file 1 point, multiple time time-value ASCII file
steps
sample file 1 time step x-y-value or x-y-z-value ASCII file
mat file always MATLAB binary format1
1
The stand-alone version of Delft3D-QUICKPLOT writes the data in mat files compatible with MATLAB version
6. QUICKPLOT versions running within MATLAB as part of the Delft3D-MATLAB toolbox can also export to mat
files native to versions 7 and up.
Deltares 29
Delft3D-QUICKPLOT, User Manual
Figure 4.2: Select the printing and exporting option from the File menu of a figure.
Remarks:
Exporting large datasets to mat files may exhaust system resources. Use Delft3D-
MATLAB interface instead.
Exported data may depend on selected component and presentation type.
If you select the Print/Export option from the File menu (or if you press Ctrl+P), the print/export
dialog appears as shown in Figure 4.3. Currently, you can export your figures to the following
file types: PostScript (PS), Encapsulated PostScript (EPS), TIFF, PNG and JPEG files. On
Windows PCs you have the additional option of exporting to WindowsŠ EMF (Enhanced Meta
File) format, sending the figure to the clipboard as bitmap or metafile, and you can send the
figure to any of the installed Windows printers (selectable using the Options... button).
The dialog also allows you to select multiple figures to print or export. By default only the
figure from which you activated the Print/Export process is selected for printing or exporting.
If you select multiple figures, you will be asked to give a name for each figure separately.
30 Deltares
Export and printing options
If you are exporting or printing to a medium that supports vector graphics (such as, PostScript
files) set the printing method to painters for the best quality. The zbuffer method will always re-
sult in a bitmap representation of the image and, therefore, it is only advantageous if the image
is so complex that the painters method fails. For the current version of Delft3D-QUICKPLOT,
this applies probably only to 3D plots with continuous shades.
Remark:
Exporting or printing a series of pictures is possible using the animation functionality as
described in section 5.6. Selecting export/print as output option in the animation dialog
brings up the same dialog for exporting and printing files as shown in Figure 4.3.
Deltares 31
Delft3D-QUICKPLOT, User Manual
32 Deltares
5 Digging deeper
At the end of the ‘Getting started’ chapter, we shortly introduced the slider in the lower left
corner of each plot and indicated that it can be used to select other time steps and other
spatial co-ordinates. This chapter describes how to
Deltares 33
Delft3D-QUICKPLOT, User Manual
34 Deltares
Digging deeper
Deltares 35
Delft3D-QUICKPLOT, User Manual
36 Deltares
Digging deeper
Figure 5.5: Overlay plot of the water level using patches and the depth averaged velocity
using red vectors.
The text on the Add to Plot button will turn red if the program detects some incompatibilities
in the plot settings. These checks currently include a check on dimensionality of the data set
(e.g. trying to add a 2D spatial data set to a time-series plot) and a check on units (e.g. a
velocity magnitude [m/s] cannot be added to a water level [m] plot, nor should a water level in
[m] be added to a plot of water levels in [ft]). Although the text turns red to warn you of such
conflicts, the button will still works such that you can still combine data sets in one plot.
Remarks:
It is not possible to combine two plots with different colour maps in one figure.
It is not possible to combine two plots with different colour scaling in one axes.
It is not possible to combine plots with the presentation type set to continuous shades
with other plot types, such as contours and vectors.
Deltares 37
Delft3D-QUICKPLOT, User Manual
Remarks:
When looking at differences, please check the limits of vertical axes and color bars care-
fully. If the differences are small and irregular they may very well result from numerical
noise in the computations.
Since the algorithm checks for identical time and space dimensions, the differencing will
fail if you change the number of output stations or the number of time steps. Supporting
such changes is considered for a future release.
The algorithm doesn’t check for location or time changes, i.e. if you change grid, output
times, or output stations (or reorder them) while keeping the grid dimensions, number of
time steps and number of output stations identical then the ‘Diff Files’ option will allow
you to subtract the data from the original simulation. The graphs will show you the
location and times of the original (top) simulation.
38 Deltares
Digging deeper
Deltares 39
Delft3D-QUICKPLOT, User Manual
Figure 5.8: Activation of the Plot Manager from the Window menu of the main program
window.
creating new figures (some standard paper layouts are provided) and opening previously
saved figures, saving figures, setting figure options (not yet available), deleting figures;
creating new axes, setting axes options (not yet available) and deleting axes;
deleting items (in axes), requesting information on items, and linking items for animations.
The selection boxes for figures and axes allow you to select all figures and axes. The list
box shows the names of the items in the selected axes (which may be located in multiple
figures). If the bare names of the items are the same, the names are automatically extended
with the name of the file, selected time steps and M, N or K indices, and plot type if one or
more of these labels will help to distinguish between the items. More detailed information
(in particular plot characteristics) for the selected item can be obtained by clicking the item
information button in the toolbar. Multiple items across multiple axes or even figures can be
40 Deltares
Digging deeper
The new figure button allows you to create a new figure with a standard layout. Figure 5.10
shows a couple of standard layouts available. All plots except for the free format figure contain
the standard Deltares border. You can edit all texts in the border by selecting the Edit Border
option from the Edit menu in the figure (see Figures 5.11 and 5.12). More flexibility in figure
layouts can be achieved making your own set of standard plot layouts and by using the load
figure option instead of the new figure option. Because stand-alone Delft3D-QUICKPLOT
saves figures in the figure file format of MATLAB 6.5, you can also open any figure created in
MATLAB 6.5.
Furthermore, you can add axes to and remove axes from the selected figure using the next
row of buttons. There are three options for adding axes:
one plot. In this case one big axes is created (identical to the default axes that appears
when pressing Quick View).
user selected subplot. In this case a number of plots can be created based on a regular
grid as illustrated by Figures 5.13 and 5.14. Note that the plots are numbered row-wise
starting in the upper-left corner.
user positioned subplot. In this case, you are asked to interactively draw the location of
the axes in the figure. The axes labels extend outside the indicated area.
If you want to add a plot to a certain axes, select the figure to which the axes belong from the
list of figures and, subsequently, select the axes from the list of axes. Now, the desired axes
are active and you can use the Add to Plot option to add a dataset to the active axes. The
lower listbox in the Plot Manager lists all items/quantities plotted in the axes (or if you check
the ‘all’ checkbox to the right of the axes listbox, all items in the current figure are listed). You
can select and delete some of them and you can link them for an animation (see also Sections
5.5 (interacting with plots) and 5.6 (animating results).
A zoom action should always start inside the plot area of the axes. It works by dragging a
zoom area with the left mouse button pressed down. When the zoom-in mode is activated,
you can zoom out with a right click. When the zoom-out mode is activated, you can zoom
out with the left button (single click) and zoom in with the right button (drag zoom area). It is
only possible to zoom out up to the dimensions of the original plot. The rotation option is not
relevant for most plots. Only a plot for plots created using Presentation Type set to continuous
value, 3D particle tracks from D-Waq PART and vector plots of the 3D velocity fields, the
rotation functionality can be useful. Rotate the axes by pressing and holding down the left
mouse button. Preliminary the vertical exaggeration factor is kept fixed at 30, which is enough
to visualise 3D topography. When zooming in on a rotated plot, use single clicks only; do not
drag a zoom window.
A slider is drawn in the lower left corner of the plot window. The slider can be used to change
the time step, station or M, N, K co-ordinate of one or more of the objects in the plot. The
Deltares 41
Delft3D-QUICKPLOT, User Manual
Figure 5.10: A couple of standard figure layouts created using the new figure button of
the Plot Manager: 1 plot – portrait, 2 plots, vertical – portrait, 4 plots, 2x2 –
portrait, 2 plots, horizontal – landscape.
42 Deltares
Digging deeper
Figure 5.11: Select Edit Border from the Edit menu to edit the border texts.
Figure 5.12: The layout of the editor for the border texts matches the layout of the boxes.
Figure 5.13: Dialog for defining five ‘user selected subplots’ based on a regular grid of 3
plots on a row and 2 plots above each other. All plots are created except
plot number 5 (see Figure 5.14).
Deltares 43
Delft3D-QUICKPLOT, User Manual
Figure 5.14: Five ‘user defined subplots’ with an indication of their row-wise numbering.
44 Deltares
Digging deeper
Deltares 45
Delft3D-QUICKPLOT, User Manual
46 Deltares
Digging deeper
Figure 5.18: Slider and object/dimension selection button marked with the character v.
currently selected time step, station or M, N, K co-ordinate is shown in the tooltip of the slider.
To the right of the slider, there is a small button marked with the character v; that button,
allows you to select the object and dimension (i.e., time step, station, M, N, or K co-ordinate)
to be varied (see Figure 5.18). Left click on the button and select from the menu that appears
the object and dimension that you want to vary: the current selection is marked with a check
mark (see the right part of Figure 5.18). If the dimension of the newly selected object matches
your previous selection (i.e., same number of time steps or same number of grid points) the
program will ask whether you would like to link the parameter changes of the selected object
with those of the previous object(s). If you answer this question confirmatively, both the newly
selected object and the previously selected ones will be affected by the state of the slider.
To unlink the objects, select any of the objects again. The same functionality can also be
accessed by using the link items button in the Plot Manager; if you want to link a large number
of items that approach will be faster.
output: The first field allows you to indicate whether you want each picture of the animation
written to be stored. You may select one of the supported bitmap formats (TIF, JPG, PNG
or BMP), output via the print/export option (automatically send a series of figures to the
printer) or create an AVI file (Windows only).
render in background: When creating output (other than to the screen), you can select the
option to render in background. This accelerates the image generation. This option is not
Deltares 47
Delft3D-QUICKPLOT, User Manual
available for BMP files which are created from screen grabs.
steps: The second field allows you to select the time steps and spatial co-ordinates that
should be part of the animation. You can walk through the steps in any order you like, e.g.
backwards (97:-1:1) or more detailed in one range (1:19 20:5:95).
loop until stopped: The last field enables you to animate the selected steps repeatedly
until the animation is explicitly stopped. This option only available if the output option is
set to no output.
maximum frame rate: Because animations on small datasets and fast hardware may be
too fast to follow, you can set a maximum display frame rate. This frame rate is also used
when creating an AVI animation as the frame rate of the animation.
script: When you run QUICKPLOT as part of the Delft3D-MATLAB interface from within
MATLAB, you may optionally specify an m-file script to run after each plot update. This
allows you to make final adjustments to the plot using MATLAB features. This option is not
available in the standalone Delft3D-QUICKPLOT version.
The default setting is to animate the results for the full range of the dimension to be varied (for
instance all time steps or all N co-ordinates) without storing the pictures. Instead of storing
the pictures on disk, the program can also copy the files to the clipboard (useful if you have
another program that can collect them automatically) or send them to a printer. The animation
can be stopped by pressing Ctrl+H or selecting Stop from the Animation menu.
Remarks:
If you are using the animation option for the purpose of creating files (i.e. not for imme-
diate viewing), you may generally cover or minimise the figure that is being animated (or
select Render in Background). However, there is one exception: BMP files are created
using a screen capture process which will produce undesired effects when the figure
playing the animation is not on top.
When creating an animation it is generally best to use consistent colouring and scaling
for all pictures/frames of the animation. Set vector scaling, colour thresholds and colour
limits manually as indicated in Sections 3.6, 3.12 and 3.19. For 1D and 2DV plots, use
the zoom option explained in section 5.5 to keep the plot ranges fixed.
48 Deltares
Digging deeper
Figure 5.20: Clicking Define Var. will lead to the definition of a variable representing the
last water level field in the selected Delft3D communication file.
The first step is defining the variables. The main program window contains one button that has
not yet been explained, namely Define Var., and it does as you probably have guessed, lead
to the definition of a variable. The variable will represent the data selection at the moment that
the variable was defined. For instance, in the case shown in Figure 5.20, defining a variable
now will cause it to represent the last water level in the selected Delft3D communication file.
However, if you check the Time Step – All checkbox first, the variable will represent the water
level field at all 97 time steps. Careful data selection before defining the variables is important.
Clicking the Define Var. button will open a small dialog window requesting a name for the
variable (see Figure 5.21). The dialog will persist until you have specified a unique variable
name. Suppose that we define two variables: ‘water level’ and ‘velocity’ representing all 97
water levels and depth averaged velocity fields in the Delft3D communication file used above.
Deltares 49
Delft3D-QUICKPLOT, User Manual
Figure 5.21: Dialog window requesting a unique name for the variable.
Figure 5.22: Virtual file labelled <user defined variables> in the list of data files.
Once you have defined variables, the label <user defined variables> will be available in the
list of data files as shown by Figure 5.22. If we select it, the list of data fields will contain the
two variables that we had defined: ‘water level’ and ‘velocity’ (see Figure 5.23). It is possible
to make plots using these two variables in exactly the same way as the original data fields and
all plot and export options still apply.
The variables can be manipulated by clicking on the File options button. The file options
dialog for the virtual file <user defined variables> allows you to define new variables based
on functional relationships of one or two existing variables. The dialog window is shown in
Figure 5.24. The following operators are available:
A+B, A-B, A/B, A*B, max(A,B), min(A,B): combine two data sets of compatible size
+ constant, * constant, ĉonstant, max(A,constant), min(A,constant): combine a data set
with a constant
10log, abs: compute logarithm or absolute value of data set
magnitude: compute magnitude of vector field
series: A,B: treat second variables as a continuation of the first variable (e.g. combine
50 Deltares
Digging deeper
Figure 5.24: File options dialog window for <user defined variables> while defining a
new conditional variable.
data sets from separate files into one large virtual time-series)
A under condition B: use the value of the first variable when the second variable is in a
certain range of values. Acceptable condition statements include a value, e.g. 3, a range,
e.g. [2 3], or all values larger or smaller than a certain value, e.g. >3. See also section 5.7
on clipping data values.
max, alg. mean, min, sum of M, N, K: compute maximum, algebraic mean, minimum
and sum of a field variable in the indicated grid direction. The spatial co-ordinates are
averaged along the indicated direction.
Remarks:
Two variables have compatible dimensions if all dimensions (time and space) match for
the two variables or if dimensions that do not match are equal to 1 for either one of the
variables.
The alg. mean M, N, K operators compute the algebraic mean and not the weighted
average. For instance, the ‘alg. mean K’ operator merely sums all variables in the K
direction and divides the sum by the number of points in the vertical, so the computed
value does not correspond to the depth averaged value.
Given the operators listed above and the two variables, the Froude number can be defined in
five steps assuming a horizontal bed level at 5 m below the reference level:
1 select the variable ‘velocity’, select operator ‘magnitude’, define a new variable called
‘magnitude(velocity)’
Deltares 51
Delft3D-QUICKPLOT, User Manual
Figure 5.25: Main program window showing the newly defined variable ‘Froude’.
2 select the variable ‘water level’, select operator ‘+ constant’, specify constant ‘5’, define a
new variable ‘water depth’
3 select the variable ‘water depth’, select operator ‘* constant’, specify constant ‘9.8’, define
a new variable ‘water depth * 9.8’
4 select the variable ‘water depth * 9.8’, select operator ‘ĉonstant’, specify constant ‘0.5’,
define a new variable ‘sqrt(gh)’
5 select the variable ‘magnitude(velocity)’, select operator ‘A/B’, select the variable ‘sqrt(gh)’,
define a new variable ‘Froude’
Switch back to the main program window. The variable ‘Froude’ and all other intermediate
variables are now available for plotting. Since the original variables, called ‘water level’ and
‘velocity’, were both defined for the whole domain and for all time steps, so is the variable
‘Froude’. All plot and export options still apply.
Remark:
The variables are currently self-containing, that is the internal definition of the variable
‘Froude’ contains all information on the intermediate steps and information on the orig-
inal variables ‘water level’ and ‘velocity’. If all other variables are deleted (using the
Delete Variable button in the file options dialog) and all files are closed, the ‘Froude’
variable will still be able to plot as long as the files are still in their original location
and contain valid data. Because of reasons of memory efficiency and flexibility, this
52 Deltares
Digging deeper
Figure 5.26: Open the colour map editor by clicking on the colour map preview.
A colour map editor window will open as shown in Figure 5.27. It will initially show the colour
map selected in the plot options. The colours that form the basis of the colour map are indi-
cated by little triangles below the colour bar. The active colour is indicated by a black triangle
whereas the other colours are indicated by white triangles. Left clicking on the colour bar
selects the nearest colour. Right clicking on the colour map adds a colour at the selected
location; the colour will initially match the colour in the original colour map (see Figure 5.28).
The colour can be changed by specifying the red, green and blue components (or the resepec-
tive components in case of another colour space) or by selecting the colour from a standard
colour selection interface (accessible by clicking the Select Colour button in the lower left cor-
ner). The location of the colour on the colour map can be changed by left click and dragging
the colour. Colours can be removed from the colour map by left clicking on them and dragging
them away from colour bar.
When you are satisfied with the new colour map, specify a new name, save it in the colormaps
directory as a file with an extension ‘.clrmap’ and close the colour map editor; the new colour
will be selected in the main window. If you donŠt like the changes donŠt save the colour map,
just press the Close button or open another colour map.
Remark:
Make sure that the colour map has a unique name. The program will behave incorrectly
Deltares 53
Delft3D-QUICKPLOT, User Manual
if there are multiple colour maps with the same name. Note: the name of the colour
map used by Delft3D-QUICKPLOT is the name you specify in the user interface; not
the name of the file.
The interface can be used as an alternative way of selecting a grid line or area to be plotted.
The selection procedure should be started from the Select menu of the Grid selection window
or the associated toolbar button. There are ten selection options: Grid Point, (whole) Grid
Line, Grid Line Segment, Piecewise Grid Line, Shortest Path, Arbitrary (x,y) Line, Grid Range,
Whole Grid, Arbitrary Rectangle, and Arbitrary Area. Figure 5.29 shows a selected Grid
Range; Figure 5.30 shows a General Line while being drawn (toolbar buttons and menus
disabled). A Grid Point is selected using a single click. A Grid Line is selected using one click
to select one point and a second click to select the grid line direction. A Grid Line Segment
is selected by subsequently clicking on the start and end point. The selection process of
Piecewise Grid Line, Shortest Path, Arbitrary Line and Arbitrary Area start and continue with
left mouse clicks and finish with a right mouse click. A Grid Range and Arbitrary Rectangle
require two clicks indicating two opposite corners of the range to be selected. The Whole Grid
option does not require any clicks. The number of options accessible depends on the data set
chosen. During the selection process the mouse co-ordinates are indicated in the lower left
corner: both X, Y and M, N co-ordinates. When the selection process is switched off, you can
zoom in by dragging a zoom area while keeping the left mouse button pressed and zoom out
by pressing the right mouse button.
Remarks:
54 Deltares
Digging deeper
Figure 5.29: Grid selection window after the selection of a Grid Range.
Deltares 55
Delft3D-QUICKPLOT, User Manual
The grid selection window switches between the hydrodynamic and morphologic grid
depending on the location of definition of the selected data field in the main program
interface.
For large models (re)drawing the Grid selection window may require a significant amount
of time, therefore, it is advised to keep the window closed in general.
For reference one can load one or more land boundary files from the File, Show Land
Boundary menu in the Grid View window. These land boundaries will remain to be
displayed until you select the File, Show Land Boundary menu item and cancel the
selection of a new land boundary file. Acceptable file formats are Tekal two column
landboundary files, BNA files, ArcInfo generate files and polyline Esri shape files.
56 Deltares
Digging deeper
Open the Delft3D-QUICKPLOT command line interface (menu item: Show Command
Line). In general you will not need this, it is used for testing out new functionality.
Record commands to a log file (menu item: Record Log File).
Record commands to a MATLAB script file (menu item: Record MATLAB Script).
Stop recording the commands (menu item: Stop Recording)
Play/re-run a log file (menu item: Run Log File).
When the recording of commands is started all commands will be written in ASCII format to
a file (extension .qplog) specified by you until you stop the recording. The commands stored
in a log file can be played back, that is, log files can be used as macros. To repeat the list of
commands stored in a log file, select the Run Log File option and select the file. The MATLAB
script file is intended for use with the Delft3D-MATLAB interface, but can be re-run using the
Run Log File option as well.
In addition to writing the commands to a log or script file, it is possible to echo the commands
to the Delft3D-QUICKPLOT Message Window.
This manual does not explain the commands in the log file. Below you find an example of the
log file of the procedure to define the Froude variable in section 5.7 from the opening of the
file until the first plot.
openfile 'd:\Delft3D\tutorial\waq\f34\com-f34-waq.dat'
selectfield 'water level'
Deltares 57
Delft3D-QUICKPLOT , User Manual
allt 1
defvariable 'water level'
selectfield 'depth averaged velocity'
defvariable 'velocity'
selectfile '<user defined variables>'
fileoptions 'selectvar' 'velocity'
fileoptions 'selectoperator' 'magnitude'
fileoptions 'defvariable' 'magnitude(velocity)'
fileoptions 'selectvar' 'water level'
fileoptions 'selectoperator' '+ constant'
fileoptions 'const' 5
fileoptions 'defvariable' 'water depth'
fileoptions 'selectoperator' '* constant'
fileoptions 'const' 9.8
fileoptions 'defvariable' 'water depth * 9.8'
fileoptions 'selectoperator' '^ constant'
fileoptions 'const' 0.5
fileoptions 'defvariable' 'sqrt(gh)'
fileoptions 'selectvar' 'magnitude(velocity)'
fileoptions 'selectoperator' 'A/B'
fileoptions 'selectvar2' 'sqrt(gh)'
fileoptions 'defvariable' 'Froude'
selectfield 'Froude'
allt 0
quickview
Remarks:
Interactive commands (manipulation of plots) are not recorded.
As an alternative to a log file, you can write a MATLAB script file. Its basic syntax is the
same, but it consists of valid MATLAB commands to be used in combination with the
Delft3D-MATLAB interface that allows for integration of Delft3D-QUICKPLOT features
and the tools of the MATLAB environment. The equivalent MATLAB script reads:
d3d_qp('openfile','d:\Delft3D\tutorial\waq\f34\com-f34-waq.dat')
d3d_qp('selectfield','water level')
d3d_qp('allt',1)
d3d_qp('defvariable','water level')
d3d_qp('selectfield','depth averaged velocity')
d3d_qp('defvariable','velocity')
d3d_qp('selectfile','<user defined variables>')
d3d_qp('fileoptions','selectvar','velocity')
d3d_qp('fileoptions','selectoperator','magnitude')
d3d_qp('fileoptions','defvariable','magnitude(velocity)')
d3d_qp('fileoptions','selectvar','water level')
d3d_qp('fileoptions','selectoperator','+ constant')
d3d_qp('fileoptions','const',5)
d3d_qp('fileoptions','defvariable','water depth')
d3d_qp('fileoptions','selectoperator','* constant')
d3d_qp('fileoptions','const',9.8)
d3d_qp('fileoptions','defvariable','water depth * 9.8')
58 Deltares
Digging deeper
Figure 5.32: End result of the example log file and MATLAB script.
Deltares 59
Delft3D-QUICKPLOT, User Manual
d3d_qp('fileoptions','selectoperator','^ constant')
d3d_qp('fileoptions','const',0.5)
d3d_qp('fileoptions','defvariable','sqrt(gh)')
d3d_qp('fileoptions','selectvar','magnitude(velocity)')
d3d_qp('fileoptions','selectoperator','A/B')
d3d_qp('fileoptions','selectvar2','sqrt(gh)')
d3d_qp('fileoptions','defvariable','Froude')
d3d_qp('selectfield','Froude')
d3d_qp('allt',0)
d3d_qp('quickview')
60 Deltares
A Supported file formats
The following sections list for each supported file format the quantities that may be read from
the indicated file. Often the file will not contain all the data sets specified. The following
abbreviations are used to indicate the location:
Abbreviation Meaning
morphologic grid D
hydrodynamic grid Z(1)
domain decomposition boundaries UV
open boundaries UV
closed boundaries UV
thin dams UV
temporarily inactive water level points Z
temporarily inactive velocity points UV
air temperature ◦C Z
cloud coverage % Z
relative air humidity % Z
wind speed m/s Z
wave height m Z
wave vector m Z
orbital velocity amplitude m/s Z
wave period s Z
wave length m Z
short-wave energy J/m2 Z
roller energy J/m2 Z
transport velocity of roller energy m/s Z (UV)
transport velocity of wave energy m/s Z (UV)
wave force N/m2 Z (UV)
roller force N/m2 Z (UV)
water level (when dry: bed level) m Z
water level m Z
water depth m Z
depth averaged velocity m/s Z (UV)
horizontal velocity m/s Z (UV), c
Deltares 61
Delft3D-QUICKPLOT, User Manual
62 Deltares
Supported file formats
(1) In the current version of the program, the hydrodynamic grid connects the 3D co-ordinates
of the cell centres of the computation grid points. This may change in a future release to
represent the bounding boxes of the grid cells.
(2)These fields are expanded depending on the contents of the data file. Units: temperature in
◦C ,salinity in ppt, secondary flow in m/s, sediment concentrations in kg/m3 , turbulent kinetic
energy in m2 /s2 , energy dissipation in m2 /s3 . The user defined tracer concentrations are in
unknown units.
(3)These locations are only valid if the correct drying/flooding setting is selected in the file
options dialog.
(4)Units depend on the model input. By default the units are (m3 /m)/s where the volume
represents m3 stone. It can also be switched to (m3 /m)/s where the volume represents m3
bed volume, or kg/(ms).
(5)New 2D and 3D fields of the same dimension as the grid are automatically detected. They
are assumed to be located at water level points.
The file options dialog for a Delft3D-FLOW map file allows you to (see Figure A.1):
1 select dpsopt for old output files that do not yet contain that information
2 select a time step and export the data to a binary Delft3D-FLOW restart file (hydrody-
namics only) or to a one time step Delft3D-FLOW map file (for restarting morphological
simulations)
3 select a time step and perform a time step analysis using the data of that time step
4 export bed stratigraphy (sediment fraction) to Golder ASCII file format for further analysis
in Petrel software
5 switch between hydrodynamic time and morphological time
64 Deltares
Supported file formats
(1) These fields are expanded depending on the contents of the data file. Units: temperature
in ◦ C, salinity in ppt, secondary flow in m/s, sediment concentrations in kg/m3 , turbulent kinetic
energy in m2 /s2 , energy dissipation in m2 /s3 . The user defined tracer concentrations are in
unknown units.
(2)Units depend on the model input. By default the units are (m3 /m)/s where the volume
represents m3 stone. It can also be switched to (m3 /m)/s where the volume represents m3
bed volume, or kg/sm.
The file options dialog for a Delft3D-FLOW history file allows you to (see Figure A.2):
drogue track -
Deltares 65
Delft3D-QUICKPLOT, User Manual
(1) In the current version of the program, the hydrodynamic grid connects the 3D co-ordinates
of the cell centres of the computation grid points. This may change in a future release to
represent the bounding boxes of the grid cells.
66 Deltares
Supported file formats
(2)The names and units of these fields are adjusted according to the roughness formulation
used in the simulation. Units: Manning n in s/m1/3 , White-Colebrook/Nikuradse k in m, Chézy
in m1/2 /s, z0 in m.
(3)New 2D and 3D fields of the same dimension as the grid are automatically detected. They
are assume to be located at water level points.
The file options dialog for a Delft3D communication file allows you to (see Figure A.3):
1 perform a time step analysis using the data of the last flow time step on the communication
file (requires also the Delft3D-FLOW map file)
wave grid D
wind velocity m/s D
water depth m D
Deltares 67
Delft3D-QUICKPLOT, User Manual
(1)New 2D and 3D fields of the same dimension as the grid are automatically detected. They
are assume to be located at wave points (i.e. depth points).
morphologic grid D
hydrodynamic grid Z(1)
water level m Z
water depth m Z
velocity (horizontal) m/s Z (UV), c
velocity in depth averaged flow direction m/s Z (UV), c
velocity normal to depth averaged flow direction m/s Z (UV), c
depth averaged velocity m/s Z (UV)
spiral flow intensity m/s Z
u roughness Chezy C m1/2 /s Z (U)
v roughness Chezy C m1/2 /s Z (V)
initial bedload transport m3 /m Z
avg bedload transport (m3 /m)/s Z
bedload transport per frac (m3 /m)/s Z
total bedload transport (m3 /m)/s Z
initial susp. transport m3 /m Z
avg susp. transport (m3 /m)/s Z
susp. transport per frac (m3 /m)/s Z
total susp. transport (m3 /m)/s Z
concentration m3 /m3 Z
bed exchange contribution m3 /m3 D
bed level increment m D
68 Deltares
Supported file formats
(1) In the current version of the program, the hydrodynamic grid connects the 3D co-ordinates
of the cell centres of the computation grid points. This may change in a future release to
represent the bounding boxes of the grid cells.
(2)New 2D and 3D fields of the same dimension as the grid are automatically detected. They
are assume to be located at water level points.
Deltares 69
Delft3D-QUICKPLOT, User Manual
morphologic grid D
bedload transport m3 /m Z
entrainment m3 /m3 D
bed level m D
cumulative erosion/sedimentation m D
GUU grid distance m Z (U)
GVU grid distance m Z (U)
GVV grid distance m Z (V)
GUV grid distance m Z (V)
cell area water level point m2 Z
cell area bottom point m2 D
other fields(1) Z(1)
(1)New 2D and 3D fields of the same dimension as the grid are automatically detected. They
are assume to be located at water level points.
70 Deltares
Supported file formats
Deltares 71
Delft3D-QUICKPLOT, User Manual
morphologic grid D
contract dredging depth m Z
cumulative dredging depth m D
bed level m D
GUU grid distance m Z (U)
GVU grid distance m Z (U)
GVV grid distance m Z (V)
GUV grid distance m Z (V)
cell area water level point m2 Z
cell area bottom point m2 D
Required extra files: D-Water Quality grid file (<name.lga> and <name.cco>) otherwise the
files are treated as D-Water Quality and PART history files.
72 Deltares
Supported file formats
aggregated grid D
segment number centres
constituents(1) (1) centres
(1) These fields are expanded depending on the contents of the data file.
Deltares 73
Delft3D-QUICKPLOT, User Manual
(1)The total chlorophyll quantity results in a special plot showing the development of the
chlorophyll concentration over time and the factors that limit its growth. See Figure A.4.
(2) These fields are expanded depending on the contents of the data file.
(3)The bed layer quantities will only occur for output files of a D-Waq PART simulation with
sedimentation process switched on.
Remarks:
It is currently only possible to create limiting factors plots for the whole simulation period.
It is currently not possible to change the colour settings of the limiting factors plot.
The file options dialog for a D-Water Quality or PART history file allows you to (see Figure A.5):
1 switch between station based data selection (default) or to treat all stations as lying on
one line as a 1D model
2 switch to D-Water Quality balance file handling (see section A.14)
74 Deltares
Supported file formats
Figure A.5: File options dialog for D-Water Quality or PART history file.
constituents(1) station
(1) These fields are expanded depending on the contents of the data file.
(1) These fields are expanded depending on the contents of the data file.
(2)The balances result in special plots showing the contribution of all relevant processes in
the mass balance of the constituent considered over time. See Figure A.6 for an example.
Deltares 75
Delft3D-QUICKPLOT, User Manual
Remarks:
It is currently only possible to create balance plots for the whole simulation period.
It is currently not possible to change the colour settings of the balance plot
The file options dialog for a D-Water Quality balance file allows you to (see Figure A.7):
76 Deltares
Supported file formats
Figure A.7: File options dialog for D-Water Quality balance file.
(1) These fields are expanded depending on the contents of the data file.
(2)The bed layer quantities will only occur for output files of a D-Waq PART simulation with
sedimentation process switched on.
particle track -
aggregated grid D
segment number centres
Deltares 77
Delft3D-QUICKPLOT, User Manual
morphologic grid D
hydrodynamic grid Z(1)
(1) In the current version of the program, the hydrodynamic grid connects the co-ordinates
of the cell centres of the computation grid points. This may change in a future release to
represent the bounding boxes of the grid cells (i.e. equal to morphologic grid in plan).
The file options dialog for a Delft3D grid file allows you to (see Figure A.8):
1 load additional attribute files (QUICKIN depth file, Delft3D-FLOW restart file, Delft3D-
FLOW enclosure file, Delft3D-FLOW thin dam file, Delft3D-FLOW dry points file, Delft3D-
FLOW observation point file, Delft3D-FLOW cross-section file, Delft3D-FLOW discharge
station file, Delft3D-FLOW 2D weir file, Delft3D-MOR dredge map output file, Incremental
file, Delft3D-MOR field file, SIMONA box file, SIMONA/Baseline 2d weir file, SIMONA/Baseline
thin dam file, Delft3D-FLOW trachytope area file) onto the grid
2 in case of a Delft3D-FLOW restart file: select the number of layers, substances, and
turbulent quantities.
3 in case of a Delft3D-FLOW restart file: convert between PC and UNIX platforms (and
optionally change the number of layers)
4 in case of a QUICKIN depth file: select the data location, data ordering and Delft3D-FLOW
dpsopt option for interpolation to cell centres.
(1) These fields are expanded depending on the contents of the data file.
Plotted as added dataset on Delft3D grid file (see section A.18). The SIMONA system itself
78 Deltares
Supported file formats
does not have a strict definition of a depth file. The box file currently supported should start
with the BOX record and it should contain all records below that level.
data field(1) D
(1) These fields are expanded depending on the contents of the data file.
water level m Z
(horizontal) velocity m/s Z (UV), c
substance Z, c
turb. quantity Z, i
data field(1) Z
Deltares 79
Delft3D-QUICKPLOT, User Manual
(1) These fields are expanded depending on the contents of the data file.
thindams UV
Plotted as added dataset on Delft3D grid file (see section A.18). The SIMONA system itself
does not have a strict definition of a thin dam file. The thin dam ("schotjes") files generated by
the Baseline preprocessing system are currently supported.
thindams UV
weirs m UV
Plotted as added dataset on Delft3D grid file (see section A.18). The SIMONA system itself
does not have a strict definition of a 2d weir file. The 2d weir ("overlaten") files generated by
the Baseline preprocessing system are currently supported.
weirs m UV
80 Deltares
Supported file formats
dry points Z
cross-sections UV
Deltares 81
Delft3D-QUICKPLOT, User Manual
Plotted as added dataset on Delft3D grid file (see section A.18). This file format is equivalent
to the SIMONA Nikuradse area files generated by the Baseline preprocessing system.
area fraction(1) Z
dredged volume m3 D
dumped volume m3 D
cumulative dredged volume m3 D
cumulative dumped volume m3 D
bed level increment m D
volume in depot m3
dredged volume m3
dumped volume m3
morf tree
morf tree with time management
82 Deltares
Supported file formats
(1) These fields are expanded depending on the contents of the data file.
(1) These fields are expanded depending on the contents of the data file.
samples xy
depth grid D
hydrodynamic grid Z(1)
thin dams UV
temporarily inactive velocity points UV
weirs UV
wave height m Z
wave vector m Z
wave period s Z
wave number - Z
Deltares 83
Delft3D-QUICKPLOT, User Manual
(1) In the current version of the program, the hydrodynamic grid connects the 3D co-ordinates
of the cell centres of the computation grid points. This may change in a future release to
represent the bounding boxes of the grid cells.
(2) These fields are expanded depending on the contents of the data file.
(3) The minimum/maximum field is expanded depending on the contents of the data file into
quantities named ‘<variable1> at <minimum|maximum> <variable2>’, e.g. ‘water level at
maximum velocity magnitude’. The name is abbreviated to ‘<minimum|maximum> <variable2>’
if <variable1> equals <variable2>, e.g. ‘minimum velocity in m-direction’.
84 Deltares
Supported file formats
Special support for extensions used by Delft-FLS and SOBEK Overland Flow module: <∗.adp>,
<∗.amu>, <∗.amv>, <∗.amh>, <∗.amz>, <∗.amc>, <∗.aht>, <∗.afb>, <∗.afw>, <∗.acx>,
<∗.ahx>
Optionally plotted as added dataset on Delft3D grid file (see section A.18).
classified waterdepth Z
classified velocity Z
classified waterlevel Z
classified u-velocity Z
classified v-velocity Z
File <∗.his>
File format Ascii file
waterdepth m station
waterlevel m station
velocity m/s station
Deltares 85
Delft3D-QUICKPLOT, User Manual
discharge m3 /s cross-section
data fields(1) xy
(1) These fields are expanded depending on the contents of the data file.
(1) These fields are expanded depending on the contents of the data file.
(2) Location depends on file contents: time-series or 1D/2D/3D spatial data.
line xy
86 Deltares
Supported file formats
line xy
line xy
line xy
The file options dialog for a bitmap file allows you to:
1 specify the lower-left co-ordinates of the bitmap as well as the width for georeferencing.
These data are used when plotting the bitmap.
2 create a figure containing an axes object such that the plotted bitmap exactly fits the figure.
grid
data fields(1)
Deltares 87
Delft3D-QUICKPLOT, User Manual
(1) These fields are expanded depending on the contents of the data file.
network xy
datafields(1) xy
(1)These fields are expanded depending on the contents of the flowmap.his, minmax.his,
gsedmap.his, kafhmap.his, kafpmap.his, kafrmap.his, kaphmap.his, kappmap.his, saltmap.his,
sedtmap.his, morpmap.his, sobekwq.map, calcpnt.his and reachseg.his files in the same di-
rectory.
88 Deltares
Supported file formats
grid vertices
water level m vertices
bed level m vertices
water depth m vertices
velocity m/s vertices
breaking coefficient gamma vertices
weighted mean wave height dir. m vertices
wave height m vertices
wave phase vertices
wave image m vertices
maximum velocity m/s vertices
maximum velocity direction radians vertices
minimum velocity m/s vertices
wave number vertices
phase velocity m/s vertices
group velocity m/s vertices
potential (real part) vertices
potential (imag part) vertices
seiches potential (real part) vertices
seiches potential (imag part) vertices
weighted period Tm-1,0 s vertices
wave number based on Tm-1,0 vertices
radial frequency based on Tm-1,0 vertices
data fields(1) vertices
data fields (frequency graph)(1)(2) stations
(1) These fields are expanded depending on the contents of the data file.
(2) These quantities result in special frequency graphs.
Deltares 89
Delft3D-QUICKPLOT, User Manual
The stand-alone version of Delft3D-QUICKPLOT accepts only MATLAB files created by the
standalone version itself or created from within MATLAB 6. When saving data from within a
more recent MATLAB releases, use the version 6 compatible MAT-file format.
(1) Field name, unit and location are determined from the contents of the data file.
90 Deltares
Supported file formats
H1/3 m (2)
Hrms m (2)
H1% m (2)
H2% m (2)
Tm s (2)
T1/3 s (2)
Hm0 m (2)
Tm-1,0 s (2)
Tm0,1 s (2)
(1) The list of cross-sectional rays will be automatically expanded based on file contents.
(2) Variable defined on coarse grid, points, or rays.
(3) Variable defined on grid, coarse grid, points, rays.
Remark:
The implementation supports CF conventions
(1) The list of data fields will be automatically expanded based on file contents.
drainage plot(1)
data field(2)
Deltares 91
Delft3D-QUICKPLOT, User Manual
(1) The drainage plot results in special plot as shown in Figure A.11.
(2) The name of the quantity will be automatically determined from the file contents.
(1) The list of data fields will be automatically expanded based on file contents.
92 Deltares
Supported file formats
grid vertices
data fields(1) vertices
(1) The list of data fields will be automatically expanded based on file contents.
(1) The list of data fields will be automatically expanded based on file contents.
Deltares 93
Delft3D-QUICKPLOT, User Manual
94 Deltares
PO Box 177 +31 (0)88 335 81 88
2600 MH Delft [email protected]
Rotterdamseweg 185 www.deltaressystems.nl
2629 HD Delft
The Netherlands