UTRRND
From BAWiki
Basic Information
Name of Program
UTRRND
VersionDate
7.x / February 2022
DescriptionDate
February 2022
Catchwords
preprocessor
boundary timeseries data
boundary timeseries data from computational results
boundary timeseries data from measured data
source and sinkflow from measured data
numerical model TELEMAC2D
numerical model TRIM2D
numerical model TRIM3D
numerical model UNTRIM
numerical model UNTRIM2 (sub grid)
Short Description of Functionality
Program UTRRND is used as a preprocessor to generate boundary timeseries data for the different numerical models applied at BAW. The following services are provided by this program:
 Generation of boundary timeseries data which can be directly used in the numerical model UNTRIM;
 Preparation of timeseries data which can be later used as input in connexion with the generation of boundary time series data for the numerical models TELEMAC2D, TRIM2D and TRIM3D.
At the moment timeseries can be generated for the following physical quantities:
 water level elevation along open model boundaries,
 salinity along open model boundaries,
 temperature along open model boundaries,
 suspended sediment load (several sediment fractions) along open model boundaries,
 tracer load (several sediment fractions) along open model boundaries,
 sources (flowvolume with salinity, temperature and suspended sediment load (several fractions)) inside the modelling domain,
 sinks (flowvolume) inside the modelling domain, as well as
 sinks with immediate inflow of the withdrawn volume at a different location, with the possibility to alter temperature as well as salinity (e.g. due to the use as cooling water for a power plant) compared to the respective values at the outtake location.
The following data sources (input data) can be (alternatively) used:
 water level elevation along open boundaries
 results from a previous simulation run, and
 measured data from different locations.
 salinity, temperature, suspended sediment load and/or tracer load along open boundaries as well as sources and sinks (with or without temperature and/or salinity change).
 measured data from different locations.
Remark: input data must be in time series format. Measured data need not be available at constant time intervals.
Beyond that, program UTRRND offers a possibility to modify boundary time series data for water level elevation with respect to mean value, amplitude and phase when they are computed from numerical model results. In this situation the user must specify some additional data in files of type boewrt.dat.
Boundary nodes or grid cells can be either detected automatically by the program from the structure of the grid, or by means of some auxiliary informations prescribed by the user.
Time series data for sources and sinks are exclusively generated for the specific location given by the user.
InputFiles
 general input data (filetype utrrnd.dat).
 grid with boundary nodes or boundary grid cells for which boundary time series data shall be generated or which describes the modelling domain for which sources and sinks are going to be generated:
 for TELEMAC2D  filetype gitter05.dat/bin
 or
 for TRIM2D and TRIM3D  filetype tr2.topo.bin.ind
 or
 for UNTRIM  filetype untrim_grid.dat
 (optional) description of the vertical structure, e.g. the position of layers, when threedimensional boundary time series data shall be generated for the numerical model UNTRIM (filetype vertical.dat) This information is only of importance in connexion with the computation of salinity, temperature, suspended sediment load (several fractions) and tracer load (several fractions), along open boundaries or sources and sinks inside the modelling domain.
 (optional) if 2D/3Dresults of a previous numerical simulation shall be used:
 grid (filetype gitter05.dat/bin or untrim_grid.dat or profil05.bin or location_grid.dat)
 computed time series data (files of type dirz.bin.r, dirz.bin.i and dirz.bin)
 (optional) manually prescribed time series for modification of mean value, amplitude and phase of the time series derived from numerically calculated results (files of type boewrt.dat)
 This functionality is currently only available in connexion with water level elevation boundary data time series.
 (optional) if measured data shall be used to generate the boundary time series data (files of type boewrt.dat)
 (optional) definition of boundaries, in situations where the positions of boundary nodes or grid cells shall not be automatically determined from analysis of the grid structure:
 (optional) indices of boundary cells  if the numerical models TRIM2D or TRIM3D shall be later used (filetype fd2rnd.dat)
 (optional) definition of boundary sections  can be used together with all types of numerical models (filetype bsection.dat).
 These informations may be useful when boundary data time series are going to be generated for water level elevation, salinity and temperature. For sources and sinks this information is not even useful.
Support of coordinate reference systems :
 Files containing coordinate Information of type boewrt.dat, gitter05.dat/bin and untrim_grid.dat will be transformed into the sytem specified by BAWCRS during the reading process, if they contain a supported CRS internally as EPSG code. Use of BAWCRS leads to an export of the (valid) EPSG code into the boundary grid file. Further remarks are foud on page GEOTRANSFORMER.
 The use of BAWCRS is recommended, especially, if meteorological input data from NetCDF files are used during a model run.
 Nevertheless, the user shall add the EPSG code to the input data in all cases .
Remark: the user should also read the comments stored in the different template files available (please refer to $PROGHOME/examples/utrrnd/).
OutputFiles
 systemfiles with locations of the nodes or cells where boundary time series data were generated (filetype location_grid.dat); the system files will contain the user specified coordinate reference System (CRS), if the Environment variable BAWCRS is set to a valid EPSG code value. Valid EPSG codes are described on the page GEOTRANSFORMER.
 synoptic boundary data for all boundary data locations (files of type dirz.bin.r, dirz.bin.i and dirz.bin)
 Remark: these result files are especially useful in connexion with the application of the numerical model UNTRIM.
 (optional) boundary time series data (filetype rndwerte.dat)
 Remark: this data file can be used as input file for the programs TM2RND and TR2RND respectively to generate boundary time series data for the numerical models TELEMAC2D or TRIM2D and TRIM3D.
 Remark: This option is only available when boundary data time series for water level elevation, salinity or temperature are going to be generated.
 (optional) indices of boundary cells, if either TRIM2D or TRIM3D shall be later used, and the boundary grid cells have not been already specified as input data before (filetype fd2rnd.dat)
 This option is only available when boundary data time series for water level elevation, salinity or temperature are going to be generated.
 (optional) lineprinter file contains useful informations related to program execution (filetype utrrnd.sdr);
 (optional) file with trace of program execution (filetype utrrnd.trc).
Methodology
 how boundary locations are determined (water level elevation, salinity, temperature, suspended sediment load (several fractions) and tracer load (several fractions))
 If the user does not explicitely specify informations which describe the positions of boundary nodes or grid cells the latter ones will be automatically determined by the program. The algorithm tries to determine all open boundary nodes from the grid structure.
 If the user has specified additional informations (e.g. fd2rnd.dat or bsection.dat), they are used to determine the locations of boundary nodes or grid cells which are situated along the outer boundary of a computational grid.
 interpolation using computational results (water level elevation)
 For any location where boundary time series data shall be generated at first the closest lying computational points are determined. Thereafter the time serie at the location of the boundary node will be determined from the numerically computed time series by means of a linear interpolation. No interpolation is done with respect to time.
 If a boundary node or grid cell is located outside the computational domain the closest lying computational point will be determined and the computed time series data will be used directly without any interpolation or extrapolation.
 Interpolated data can be optionally modified using userspecified values with respect to mean value, amplitude and phase. The modification parameters can be both, space as well as time dependent. Data necessary must be prescribed by the user in files of type boewrt.dat.
 interpolation using measured data (water level elevation)
 If measured data form the basis for interpolation of boundary time series data they will be interpolated to the location of the boundary node or grid cell in an analogous manner as described above for computational result based data.
 An important difference exists for the generation of boundary time series data of water level elevation. In this situation an analysis to determine times of high and low water is carried through beforehand to determine the time shifts which are applied to the measured data before they are going to be interpolated to obtain a boundary time serie of water level elevation. This type of interpolation (time shift) can be optionally switched off in case the data to be interpolated are not dominated by the tides.
commandline mode:
The interactive requests can be avoided by using the commandline mode.
Help about this mode: utrrnd[.i18] help !
Program(s) to run before this Program
EXKNO, FFT, FRQ2ZEITR, MESKOR, TSCALC, UTRPRE, ZEITR, ZEITRIO
Program(s) to run after this Program
FDGITTER05, GVIEW2D, TM2RND, TR2RND, UNTRIM, UNTRIM2, UNTRIM2007, ZEITR
Additional Information
Language
Fortran95
Additional software

Original Version
G. Lang
Maintenance
Documentation/Literature
 please refer to $PROGHOME/examples/utrrnd/
 ./BSP_becken_src_snk/ : example files for a closed basin with one sink and one source.
 ./BSP_becken_wind/ : example files for wind influence on water level elevation and current velocity in a closed basin.
 ./BSP_hafen/ : example files for wave propagation in a harbour basin.
 ./BSP_kanal_w_gradient/ : example files for a straight channel with constant water level gradient;
 ./BSP_kanal_w_inflow/ : example files for a straight channel with constant inflow (discharge).
 ./BSP_soliton / : propagation of a solitary wave in a straight wave channel.
 ./BSP_becken_power_plant/ : example files for a closed basin with one sink, where the water is immediately reintroduced at a different location with respective alteration of temperature as well as salinity (useful for simulations of the cooling of a power plant).
 there are also more general informations concerning the generation of boundary conditions available
 especially have a look to the literature list and the graphical representation for the generation of time series data from measured or simulated data
back to Program Descriptions