BAWiki - User contributions [en]

Program Descriptions

2023-02-27T16:16:57Z

Ak3jjuer: Wechsel der Programmzugehörigkeit von GRIDCONVERT von Pos nach Pre

__NOAUTOLINKS__
__NOAUTOLINKTARGET__
[[de:Programmkennblätter]]
{| width="80%"
| align="left" | At the BAW-DH there exists a comprehensive collection of software which has been mostly developed by the staff of the BAW-DH. The software was developed to assist engineers in solving practical problems. This page gives you a list in alphabetical order of the most important programs in use. For every listed program a short description of its functionality is available. More than that, you will also find information on closely related programs (fore-runners and after-runners). In addition to this an [[overview]] of required and optional input-files is given together with an enumerated list of the output-files generated by the program. 

The majority of the programs are written in Fortran (FORTRAN77, Fortran90, Fortran95, Fortran 2003). For details about the Fortran programming language see e. g.
[https://software.intel.com/en-us/node/525392 ''Intel Language Reference'']
|-
|
{| width="80%" cellpadding="5"
|- bgcolor="#d3d3d3"
! colspan="3" | explanation of colour codes
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| colspan="2" width="95%" valign="top" |
'''processing of measured data, preprocessing''' ''responsible''<nowiki>: </nowiki>P. Schade and G. Seiß ([mailto:pre.proghome@baw.de Working group PRE])
|- valign="top"
| width="5%" bgcolor="#0000ff" valign="top" | Sim
| colspan="2" width="95%" valign="top" |
'''numerical simulation''' ''responsible''<nowiki>: </nowiki>B. Fricke, A. Sehili and H. Weilbeer ([mailto:sim.proghome@baw.de Working group SIM])
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| colspan="2" width="95%" valign="top" |
'''postprocessing for numerical models and data analysis''' ''responsible''<nowiki>: </nowiki>J. Jürges, A. Rosenhagen and S. Spohr ([mailto:pos.proghome@baw.de Working group POS])
|- valign="top"
| width="5%" bgcolor="#ffff00" valign="top" | Son
| colspan="2" width="95%" valign="top" | '''others''' ''responsible''<nowiki>: individuals which are responsible for program maintenance.</nowiki>
|- bgcolor="#d3d3d3"
! colspan="3" | Advice to Users
|- valign="top"
| colspan="3" | users of the programs who detect errors or deficiencies should contact one of the above mentioned responsibles in dependence on the group to which the application program belongs.
|- bgcolor="#d3d3d3"
! colspan="3" | A
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[ABDF]]
| width="75%" valign="top" | analysis of data stored in direct access data files (BDF)
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[ADCP2BDF]]
| width="75%" valign="top" | conversion of ADCP workhorse data to BDF data format
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[ADCP2PROFILE]]
| width="75%" valign="top" | conversion of ADCP profile data to BDF data format
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[ANALTEL2D]]
| width="75%" valign="top" | interactive modification of a file of type ''selafin''
|- bgcolor="#d3d3d3"
! colspan="3" | B
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[BATCHPLOT]]
| width="75%" valign="top" | post processor for batch oriented visualisation of data
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[BFABSENK]]
| width="75%" valign="top" | computing of height changes inside groyne areas
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[BOERND]]
| width="75%" valign="top" | generation of boundary time-series (preparatory stage)
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[BSH2BAW]]
| width="75%" valign="top" | conversion of meteorological data into the ''mkwswawrt'' format
|- bgcolor="#d3d3d3"
! colspan="3" | C
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[CREATE_SIMPLE_UNTRIM2_GRID|create_simple_untrim2_grid]]
| width="75%" valign="top" | create simple grid for [[UNTRIM2]]
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[CROSSPRO]]
| width="75%" valign="top" | calculation and output of cross-sectional profiles, lying orthographical to a defined longitudinal river fairway profile
|- bgcolor="#d3d3d3"
! colspan="3" | D
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[DATA2GEOM]]
| width="75%" valign="top" | Conversion of BSH ASCII files to geom files
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[DATACONVERT]]
| width="75%" valign="top" | Conversion of Delft3D computational grid as well as computational results
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[DATAUS]]
| width="75%" valign="top" | extraction of soundings of an interesting area from ASCII-files (x,y,z) of various formats
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[DAVIT]]
| width="75%" valign="top" | interaktive visualisation and exploration of modelling results
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[DEPRO2D]]
| width="75%" valign="top" | interactive definition of profiles
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[DIDAMERGE]]
| width="75%" valign="top" | merging and thinning (in time) for synoptic data sets
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[DIDAMINTQ]]
| width="75%" valign="top" | integration and averaging for synoptic data sets along cross sections
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[DIDAMINTZ]]
| width="75%" valign="top" | calculation of depth integrated or averaged results for synoptic data sets
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[DIDARENAME]]
| width="75%" valign="top" | change of BDF file names
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[DIDASPLIT]]
| width="75%" valign="top" | splitting of large data sets or bathymetries into subdomains
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[DISPLAY_CONTROL_VOLUMES|display_control_volumes]]
| width="75%" valign="top" | tabular representation of spatially and temporally aggregated fluxes
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[DISPLAY_PERCENTILES|display_percentiles]]
| width="75%" valign="top" | visualization of statistics calculated with profile data
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[DREHE2D]]
| width="75%" valign="top" | translation and rotation of coordinates which are stored in different file types
|- bgcolor="#d3d3d3"
! colspan="3" | E
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[EDITOR]]
| width="75%" valign="top" | interactive modification and generation of GKS graphics
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[ENERF]]
| width="75%" valign="top" | calculation of synoptical quantities (e.g. energy flux) by using data results of numerical models
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[EVENTFILTER]]
| width="75%" valign="top" | filter of high and low water events and evaluation of their mean values
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[EXCELENZ]]
| width="75%" valign="top" | conversion of time-series data for further analysis or graphical display
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[EXKNO]]
| width="75%" valign="top" | extraction of time-series from model output at specific locations
|- bgcolor="#d3d3d3"
! colspan="3" | F
|- valign="top"
| width="5%" bgcolor="#ffff00" valign="top" | Son
| width="20%" valign="top" |
[[F77_TO_F90]]
| width="75%" valign="top" | rewrite FORTRAN77 source code to FORTRAN90 source code
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FD2ADDTOPO]]
| width="75%" valign="top" | creates an update grid for finite differences topography from echo soundings and updates a finite differences topography
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FD2BASIS]]
| width="75%" valign="top" | creates a basic grid with correct land/water distribution (format FIDISOR/FIDIRB) by using digitized border lines
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FD2DEL]]
| width="75%" valign="top" | creates difference topography from FIDISOR grids / modifies a FIDISOR grid with a difference topography
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FD2HYPSO]]
| width="75%" valign="top" | calculation of a frequency distribution of depth values of a finite difference topograph
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FD2KACHEL]]
| width="75%" valign="top" | generation of a tile-bathymetry and tile-data for FIDISOR/FIDIRB result files
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FD2MET]]
| width="75%" valign="top" | generation of meteorological boundary value files for finite difference methods
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FD2MOD]]
| width="75%" valign="top" | modify an area in a difference of two finite difference topographies
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FD2RIBA]]
| width="75%" valign="top" | dredging fairways in finite difference topographies
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FD2SPUELER]]
| width="75%" valign="top" | filling of fairways in finite difference topographies
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FD2TRIM]]
| width="75%" valign="top" | conversion of a FIDIRB-bathymetry into an equivalent TRIM-grid
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FDGITTER05]]
| width="75%" valign="top" | graphical preprocessor for finite difference grids
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FDGLUE]]
| width="75%" valign="top" | glues two meshes into a new finite difference grid
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FFT]]
| width="75%" valign="top" | fast fourier transformation of time series
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FILELIST_TO_GEOM]]
| width="75%" valign="top" | rewrite coordinates of many files containing a single location into one file
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FRQ2ZEITR]]
| width="75%" valign="top" | calculation of time series of the waterlevel from information about the frequencies, phases and amplitudes of the tidal harmonic constituents
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[FRQTIE]]
| width="75%" valign="top" | link result data of the program ''FRQWF'' to create new relationships
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[FRQWF]]
| width="75%" valign="top" | tidal harmonic analysis of water level
|- bgcolor="#d3d3d3"
! colspan="3" | G
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[GEOMFD2]]
| width="75%" valign="top" | generation of FD model bathymetry (FIDISOR/FIDIRB) and calendar-matrix
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[GEOTRANSFORMER]]
| width="75%" valign="top" | transformation of coordinates between different coordinate systems for different BAW file types.
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[GETDATA]]
| width="75%" valign="top" | Conversion of Delft3D computational results into netCDF files
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
| width="75%" valign="top" |
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[GRIDCONVERT]]
| width="75%" valign="top" | Converts computational grids for different mathematical methods
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| rowspan="2" width="20%" valign="top" |
[[GVIEW2D]]
| rowspan="2" width="75%" valign="top" | Graphical visualization of time-dependent physical quantities at a given position (so called geo position)
|- valign="bottom"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
|- bgcolor="#d3d3d3"
! colspan="3" | H
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[HSV]]
| width="75%" valign="top" | computation of settling velocities with a steering file ([[SV.DAT|sv.dat]]) of the SV package (SV=Settling Velocity)
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[HVIEW2D]]
| width="75%" valign="top" |two-dimensional graphical representation of CFD-data
|- bgcolor="#d3d3d3"
! colspan="3" | I
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[IGEL2D]]
| width="75%" valign="top" | interactive calculation of a borderline enclosing bearing data
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[INSEL2IPDS|insel2ipds]]
| width="75%" valign="top" | read several insel.dat and create one ipds file
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[INSPECT_CONTROL_VOLUMES|inspect_control_volumes]]
| width="75%" valign="top" | time series visualization of aggregated transport quantities
|- valign="top"
| width="5%" bgcolor="#ffff00" valign="top" | Son
| width="20%" valign="top" |
[[IO_VOLUME]]
| width="75%" valign="top" | converting data into the volume model for visualisation software profiles
|- bgcolor="#d3d3d3"
! colspan="3" | J
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[JANET]]
| width="75%" valign="top" | Interactive mesh generation and optimization tool
|- bgcolor="#d3d3d3"
! colspan="3" | K
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[KACHEL2D]]
| width="75%" valign="top" | extraction of part grids out of a finite element model grid
|- bgcolor="#d3d3d3"
! colspan="3" | L
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[LQ2PRO]]
| width="75%" valign="top" | visualization of data along longitudinal and/or cross-sectional profiles
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[LZKAF]]
| width="75%" valign="top" | calculation of long-term characteristic numbers of atmosphere
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[LZKMF]]
| width="75%" valign="top" | calculation of tide-independent characteristic numbers of morphodynamics
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[LZKSF]]
| width="75%" valign="top" | calculation of tide-independent characteristic numbers of salinity, temperature, suspended load, tracer load, bed load transport or eff. bed shear stress action
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[LZKVF]]
| width="75%" valign="top" | calculation of tide-independent characteristic numbers of current velocity
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[LZKWF]]
| width="75%" valign="top" | calculation of tide-independent characteristic numbers of water level
|- bgcolor="#d3d3d3"
! colspan="3" | M
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[MEDIANGLAETTUNG]]
| width="75%" valign="top" | smoothing of topographical information
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[MESKOR]]
| width="75%" valign="top" | correction of time-series data
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[METDIDA]]
| width="75%" valign="top" | conversion of meteorological data into the BAW-DH direct access format
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[MKRDAT]]
| width="75%" valign="top" | Generation of soil identification numbers for TRIM-2D
|- bgcolor="#d3d3d3"
! colspan="3" | N
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[NCAGGREGATE]]
| width="75%" valign="top" | aggregation for control volumes of data stored in (BAW) [[NetCDF|CF NetCDF]] files.
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[NCANALYSE]]
| width="75%" valign="top" | analysis program for data stored in (BAW) [[NetCDF|CF NetCDF]] files.
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[NCAUTO]]
| width="75%" valign="top" | classification of variables and extreme value analysis for (BAW) [[NetCDF|CF NetCDF]] files.
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[NCCHUNKIE]]
| width="75%" valign="top" | create chunked [[NetCDF|CF NetCDF]] files.
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[NCCUTOUT]]
| width="75%" valign="top" | cut out [[NetCDF|UGRID CF NetCDF]] files.
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[NCDELTA]]
| width="75%" valign="top" | program to compute differences for data stored in (BAW) [[NetCDF|CF NetCDF]] files.
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[NCDVAR]]
| width="75%" valign="top" | deletion of selected variables and dates from (BAW) [[NetCDF|CF NetCDF]] files.
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[NCMERGE]]
| width="75%" valign="top" | merge variables from different (BAW) [[NetCDF|CF NetCDF]] files in one single [[NetCDF|CF NetCDF]] file.
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[NCPLOT]]
| width="75%" valign="top" | plot program for visualisation of data stored in (BAW) [[NetCDF|CF NetCDF]] files.
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[NCPROFIL]]
| width="75%" valign="top" | plot program for visualisation of data stored in (BAW) [[NetCDF|CF NetCDF]] files on profiles.
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[NC2TABLE]]
| width="75%" valign="top" | data extraction program for data stored in (BAW) [[NetCDF|CF NetCDF]] files
|- bgcolor="#d3d3d3"
! colspan="3" | O
|- bgcolor="#d3d3d3"
! colspan="3" | P
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[PARTRACE]]
| width="75%" valign="top" | particle tracking within a two-dimensional depth-averaged velocity field
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[POLWIND]]
| width="75%" valign="top" | extraction of polygons out of an overall area
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[PLOTPROFILZEIT]]
| width="75%" valign="top" | Display (aggregated) profile data over time
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[POLYUMFORM]]
| width="75%" valign="top" | conversion of structure information files from several formats to a common BAW format
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[PGCALC]]
| width="75%" valign="top" | calculation of further physical quantities by using the results of a simulation
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[PREHYDRO]]
| width="75%" valign="top" | Processing of seaside boundary data for the BAW operational Model using BSHcmod data
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[PREMETEO]]
| width="75%" valign="top" | Mapping of the processed DWD atmospheric forcing on the Untrim estuary Grid
|- valign="top"
| width="5%" bgcolor="#0000ff" valign="top" | Sim
| width="20%" valign="top" |
[[PROPTEL]]
| width="75%" valign="top" | The BAW Operational Tide Model
|- bgcolor="#d3d3d3"
! colspan="3" | Q
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[QUICKPLOT|quickplot]]
| width="75%" valign="top" | data visualization (filetype [[CF-NETCDF.NC|cf-netcdf.nc]])
|- bgcolor="#d3d3d3"
! colspan="3" | R
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[ROSE]]
| width="75%" valign="top" | analysis and graphical display of a direction dependent relative frequency of occurrence for a vector time series
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[RSMERGE]]
| width="75%" valign="top" | adjustment of UNTRIM restart data to a different grid
|- bgcolor="#d3d3d3"
! colspan="3" | S
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[SYNGRID]]
| width="75%" valign="top" | generation of artificial bearing data
|- bgcolor="#d3d3d3"
! colspan="3" | T
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TAYLORDIAGRAM]]
| width="75%" valign="top" | creates a figure of type Talyor-Diagram
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TC2BAGGER]]
| width="75%" valign="top" | dredger-program for two-dimensional finite element grids
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TC2GEOM]]
| width="75%" valign="top" | conversion of a finite element topography into a finite difference topography
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TC2TR2]]
| width="75%" valign="top" | conversion of a TICAD topography into a ''TRIM'' topography
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TDKLF]]
| width="75%" valign="top" | computation of the tidal characteristic numbers of bed load transport or eff. bed shear stress action
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TDKSF]]
| width="75%" valign="top" | computation of the tidal characteristic numbers of salinity, suspended sediment concentration, tracer concentration and temperature
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TDKTIE]]
| width="75%" valign="top" | linking ''TIDKEN'' results
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TDKVF]]
| width="75%" valign="top" | computation of the tidal characteristic numbers of current
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TDKWF]]
| width="75%" valign="top" | computation of the tidal characteristic numbers of water level and morphodynamics
|- valign="top"
| width="5%" bgcolor="#0000ff" valign="top" | Sim
| width="20%" valign="top" |
[[TELEMAC-2D]]
| width="75%" valign="top" | two-dimensional finite element numerical model
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TEO]]
| width="75%" valign="top" | extraction of bearing data points from a KUEDAT bearing file
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TEOAX]]
| width="75%" valign="top" | extraction of bearing axes from a KUEDAT bearing file
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TICLQ2]]
| width="75%" valign="top" | extraction of bathymetry along longitudinal/cross-sectional profiles
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TICTRI]]
| width="75%" valign="top" | grid conversion into TRIGRID-format
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TIDKEN]]
| width="75%" valign="top" | computation of tidal characteristc numbers for individual time series
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TIMESHIFT]]
| width="75%" valign="top" | correction of profile data in time
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TM2DIDA]]
| width="75%" valign="top" | data conversion of the ''TELEMAC-2D''-results
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TM2RND]]
| width="75%" valign="top" | generation of boundary values for ''TELEMAC-2D''
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TOPVF]]
| width="75%" valign="top" | calculation of 2D/3D-areas and volumes of finite element meshes
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TOUTR]]
| width="75%" valign="top" | conversion of a grid file of any type to a grid file for the numerical model ''UNTRIM''
|- valign="top"
| width="5%" bgcolor="#ffff00" valign="top" | Son
| width="20%" valign="top" |
[[TR2APP]]
| width="75%" valign="top" | analysis of ''TRIM-2D''-results
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TR2ASCII]]
| width="75%" valign="top" | data conversion of the ''TRIM-2D''-results into ASCII format
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TR2DIDA]]
| width="75%" valign="top" | data conversion of the TRIM-2D-results
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TR2FIDI]]
| width="75%" valign="top" | conversion of a TRIM-bathymetry into a FIDISOR/FIDIRB bathymetry
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TR2GEOM]]
| width="75%" valign="top" | conversion of a TRIM-bathymetry into an equivalent finite element grid
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TR2ISSUSKONVERT]]
| width="75%" valign="top" | Support of ship handling simulators with 2D current data from hydronumeric simulations (TRIM2D/UNTRIM/TELEMAC)
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TR2KACHEL]]
| width="75%" valign="top" | generation of a tile-bathymetry and tile-data for TRIM-2D result files
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TR2LQ2]]
| width="75%" valign="top" | extraction of bathymetry along longitudinal/cross-sectional profiles from a TRIM bathymetry
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TR2MODATE]]
| width="75%" valign="top" | modification of date and time in a TRIM-2D results file
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TR2REFRESH]]
| width="75%" valign="top" | update a TRIM bathymetry
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TR2RND]]
| width="75%" valign="top" | generation of boundary value files for ''TRIM-2D''
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TR2VOR]]
| width="75%" valign="top" | generation of an optimized bathymetry as well as some index arrays for TRIM-2D
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TR3DIDA]]
| width="75%" valign="top" | data conversion of the ''TRIM-3D''-results
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TR3KACHEL]]
| width="75%" valign="top" | extraction of bathymetry, index-arrays and results out of a ''TRIM-3D''-overall-area
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TR3MODATE]]
| width="75%" valign="top" | modification of date and time in a ''TRIM-3D'' results file
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TRASSE]]
| width="75%" valign="top" | generation of data for a fairway finite element grid
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TRGITTER05]]
| width="75%" valign="top" | graphical preprocessor for a finite difference TRIM-2D grid
|- valign="top"
| width="5%" bgcolor="#0000ff" valign="top" | Sim
| width="20%" valign="top" |
[[TRIM-2D]]
| width="75%" valign="top" | two-dimensional finite difference model ''TRIM-2D''
|- valign="top"
| width="5%" bgcolor="#0000ff" valign="top" | Sim
| width="20%" valign="top" |
[[TRIM-3D]]
| width="75%" valign="top" | three-dimensional finite difference model ''TRIM-3D''
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TRIMKACH]]
| width="75%" valign="top" | generation of general input files and extraction of data by ''TR2KACHEL'' or ''TR3KACHEL''
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TRVZR]]
| width="75%" valign="top" | analysator of area result files of the numerical methods ''TRIM-2D'' or ''TRIM-3D''
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TSCALC]]
| width="75%" valign="top" | mathematical operations on time series data
|- bgcolor="#d3d3d3"
! colspan="3" | U
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[UNK]]
| width="75%" valign="top" | spectral wave model with non-linear dissipation
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[UNS]]
| width="75%" valign="top" | postprocessor with SediMorph functionality independent of a coupled hn model
|- valign="top"
| width="5%" bgcolor="#0000ff" valign="top" | Sim
| width="20%" valign="top" |
[[UNTRIM]]
| width="75%" valign="top" | finite difference/volume model (2D/3D) for unstructured grids UNTRIM
|- valign="top"
| width="5%" bgcolor="#0000ff" valign="top" | Sim
| width="20%" valign="top" |
[[UNTRIM2]]
| width="75%" valign="top" | finite difference/volume model (2D/3D) for unstructured grids ''UNTRIM2'',
with sub grid technology for precise representation of bathymetry
|- valign="top"
| width="5%" bgcolor="#0000ff" valign="top" | Sim
| width="20%" valign="top" |
[[UNTRIM2007]]
| width="75%" valign="top" | finite difference/volume model (2D/3D) for unstructured grids with static or dynamic bathymetry
|- valign="top"
| width="5%" bgcolor="#0000ff" valign="top" | Sim
| width="20%" valign="top" |
[[UNTRIM2007MONITOR]]
| width="75%" valign="top" | extraction of time series data out of an ''UnTRIM2007'' message file
|- valign="top"
| width="5%" bgcolor="#0000ff" valign="top" | Sim
| width="20%" valign="top" |
[[UNTRIMMONITOR]]
| width="75%" valign="top" | The program is used for the graphical visualization of information from the UnTRIM-Message-file
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[UPDA2D]]
| width="75%" valign="top" | update a model bathymetry and alignment of edges of elements along structures
|- valign="top"
| width="5%" bgcolor="#0000ff" valign="top" | Sim
| width="20%" valign="top" |
[[UPLAY]]
| width="75%" valign="top" | gui around ''UNTRIM2'' and ''NCPLOT'' to change grid depths, to let compute the hydrodynamic effect and to look at the computational results
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[UTRPRE]]
| width="75%" valign="top" | rounding UnTRIM2007 depths in order to get identical number of computational points
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[UTRRND]]
| width="75%" valign="top" | generation of boundary time series data from measured or computed data
|- bgcolor="#d3d3d3"
! colspan="3" | V
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[VOLUMETH]]
| width="75%" valign="top" | calculation of area distribution and volume sum function of a region inside an FE mesh
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[VOLUMETHAUTO]]
| width="75%" valign="top" | daemon for the programm ''VOLUMETH''
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[VTDK]]
| width="75%" valign="top" | calculation of differences between tidal characteristic numbers
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[VVIEW2D]]
| width="75%" valign="top" | two-dimensional graphical representation of CFD-data for vertical sections
|- bgcolor="#d3d3d3"
! colspan="3" | W
|- valign="top"
| width="5%" bgcolor="#0000ff" valign="top" | Sim
| width="20%" valign="top" |
[[WARM]]
| width="75%" valign="top" | mathematical wave model
|- valign="top"
| width="5%" bgcolor="#ffff00" valign="top" | Son
| width="20%" valign="top" |
[[WESPE]]
| width="75%" valign="top" | computation of one-dimensional wave spectra (JONSWAP and TMA)
|- bgcolor="#d3d3d3"
! colspan="3" | X
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[XTRDATA]]
| width="75%" valign="top" | extraction of ASCII-data from binary direct access files
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[XTRLQ2]]
| width="75%" valign="top" | extraction of binary data for longitudinal and/or cross-sectional profiles
|- bgcolor="#d3d3d3"
! colspan="3" | Y
|- bgcolor="#d3d3d3"
! colspan="3" | Z
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[ZEITR]]
| width="75%" valign="top" | conversion of synoptic data sets into equivalent time-series data
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[ZEITRIO]]
| width="75%" valign="top" | reading, formatting and writing of time series of different formats
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[ZWISCHENPUNKTE]]
| width="75%" valign="top" | generated topographical information

|}
----
back to [[BAW-Software Documentation]]
----
[[Overview]]

GRIDCONVERT

2023-02-27T16:13:44Z

Ak3jjuer: Wechsel der Programmzugehörigkeit von Pos nach Pre

{{ProgramDescription
|name_de=GRIDCONVERT
|name=GRIDCONVERT
|version=April 2019
|version_descr=September 2022
|catchwords=
conversion of computational grids 
read and write computational grids in different file formats 

Acknowledgment: ''This project took advantage of netCDF software developed by UCAR/Unidata ([http://www.unidata.ucar.edu/software/netcdf/ www.unidata.ucar.edu/software/netcdf/]).''

|shortdescription=
The program GRIDCONVERT can be used to convert computational grids for different mathematical methods:

* between different file formats but identical structure of the computational grid,
* between different grid types and different file formats,
* refinement (factor 4) of an UNTRIM grid, as well as
* flattening of all sub grid scale bathymetry variations within all grid cells and along all edges and
* conversion of constructions in insel.dat files.

In addition to that also the following functionality is available:
* compute some statistical data for a grid,
* find some differences between two grids, and
* compare initial bathymetry used with [[UNTRIM]] between cases one-grid simulation versus two-grid simulation.

Due to some specific properties of computational grids for mathematical methods the number of possible conversions remains naturally very limited. The grid will not be optimized automatically with respect to the specific requirements of the different mathematical models.
|inputfiles=
# '''computational grid (input formats)'''
:: The following file formats are currently supported:
::* [[DELFT3D.GRD|delft3d.grd]], [[DELFT3D.DEP|delft3d.dep]], [[DELFT3D.ENC|delft3d.enc]], [[DELFT3D.DRY|delft3d.dry]],
::* [[DELFT3D.THD|delft3d.thd]], [[DELFT3D.LWL|delft3d.lwl]], [[DELFT3D.EXT|delft3d.ext]] as well as [[DELFT3D.BND|delft3d.bnd]],
::* [[GITTER05.DAT and GITTER05.BIN|gitter05.dat/bin]],
::* [[SELAFIN|selafin]],
::* [[UNTRIM_GRID.DAT|untrim_grid.dat]],
::* [[UTRSUB_GRID.DAT|utrsub_grid.dat]],
::* [[PLTSUB_GRID.UPI|pltsub_grid.upi]],
::* [[LOCATION_GRID.DAT|location_grid.dat]],
::* [[PROFIL05.BIN|profil05.bin]] and
::* [[INSEL.DAT|insel.dat]] (which does not contain a computational grid but structures as groynes or islands).
# '''(optional) global metadata'''
::* [[NC_META.DAT|nc_meta.dat]].
In case file ''nc_meta.dat'' is present in the current working directory, this file will be read by the application. Otherwise the respective file from $PROGHOME/cfg will be read.
|outputfiles=
# '''computational grid (output formats)'''
:: The following file formats are currently supported:
::* [[GITTER05.DAT and GITTER05.BIN|gitter05.dat/bin]],
::* [[UNTRIM_GRID.DAT|untrim_grid.dat]],
::* [[UTRSUB_GRID.DAT|utrsub_grid.dat]],
::* [[PLTSUB_GRID.UPI|pltsub_grid.upi]],
::* [[INSEL.DAT|insel.dat]] and
::* [[CF-NETCDF.NC|cf-netcdf.nc]] (actual only [[GITTER05.DAT and GITTER05.BIN|gitter05.dat/bin]], [[INSEL.DAT|insel.dat]], [[UNTRIM_GRID.DAT|untrim_grid.dat]], [[UTRSUB_GRID.DAT|utrsub_grid.dat]], [[PLTSUB_GRID.UPI|pltsub_grid.upi]], [[LOCATION_GRID.DAT|location_grid.dat]] and [[PROFIL05.BIN|profil05.bin]]).

Remark: In case the files [[UTRSUB_GRID.DAT|utrsub_grid.dat]] and [[PLTSUB_GRID.UPI|pltsub_grid.upi]] are both present in the working directory, all data related to the so called plot subgrid will be transferred to the NetCDF file. If the latter file is missing, no data related to the plot subgrid will be stored in the NetCDF file.

|methodology=The computational grid informations are converted using various methods from the software package '''H_GRID''' as well as written to file in different formats.
Files with information concerning locations are converted by the software package called '''L_GRID'''.
The software package '''P_GRID''' converts files with profile grid data.: 
The software package '''IO_INSEL''' converts construction data of insel.dat files. GRIDCONVERT enables the user to select the construction types, e.g. "DAMM", which should be converted.


''Notice'': You can add some optional information blocks to the input file (except: profil05.bin). This is the way to put additional meta data, e.g. of the CF-convention, into the CF-NetCDF file.
To add CF informations to a file of type [[PROFIL05.BIN|profil05.bin]] put the meta data in an ASCII-file with the same name and the extension '.dat'. 
See example file: 
''$PROGHOME/examples/gridconvert/data/loc/lg.allCFinfo.dat'' or 
''$PROGHOME/examples/lib/h_grid/h_grid_test_g05_plus_CF_Info_input.dat'' or 
''$PROGHOME/examples/lib/h_grid/h_grid_test_utr_plus_CF_Info_input.dat'' or 
''$PROGHOME/examples/lib/h_grid/h_grid_test_sub_plus_CF_Info_input.dat'' or 
''$PROGHOME/examples/lib/p_grid/profil05.CF_Test.dat'' or 
''$PROGHOME/examples/gridconvert/data/ins/insel.all.dat''

|preprocessor=[[DAVIT]], [[Mathematical_Model_DELFT3D|DELFT3D]], [[JANET]], [[TELEMAC-2D]], [[UNTRIM]]
|postprocessor=[[DATACONVERT]], [[DAVIT]], [[HVIEW2D]], [[JANET]], [[NCANALYSE]], [[NCAUTO]], [[NCCHUNKIE]], [[NCPLOT]], [[NC2TABLE]], [[UNTRIM]], [[UTRPRE]] and diverse NetCDF-Tools, e.g. NCPLOT, QUICKPLOT
|language=Fortran90
|add_software=-
|contact_original=G. Lang
|contact_maintenance=[mailto:pre.proghome@baw.de Working group PRE]
|documentation=example files: 
$PROGHOME/examples/gridconvert/, 
$PROGHOME/examples/gridconvert/data/loc/, 
$PROGHOME/examples/gridconvert/data/ins/ ([[INSEL.DAT|insel.dat]]). 

Further informations: 
All NetCDF conventions, which are relevant to store the typical BAW-specific data, are documented in the [[NetCDF|NetCDF-Pages of BAW-Wiki]].
}}

OP WEIR.DAT

2021-03-30T13:12:50Z

Ak3jjuer: changed location of example file

{{FileDescription
|name_de=OP_WEIR.DAT
|filetype=op_weir.dat
|version=March 2021
|version_descr=March 2021
|significance= [[File:Illustration opweir en.png|350px|thumb|right]] contains input data to control [[UNTRIM2]] weir sections depending on model results at runtime. The advantage of using this steering file is that user does not have to know or estimate the exact times of changes on the weir height. In this file, observation points inside the model can be defined to steer changes on the weir height when for example the waterlevel exceeds or falls below a given threshold at the observation point. Similar control conditions can be defined based on the magnitude or direction of the current velocity, or the speed of waterlevel change. Also, the difference of the waterlevels and current magnitudes at two given observation points can be used to define control conditions. Additionally, specific dates, times or weekdays can be used and different conditions can be combined logically (AND or OR connections).
|filecontents=
'''Input Steering Data'''

* general input data (block '''General_Data''')
** key "'''EPSG'''" : '''EPSG-Code''' of all horizontal coordinates in this file.
** key "'''Time_Zone'''" : '''Time zone''' of all times in this file.

* control data of one weir section (block '''Operational_Weir''') : This block contains conditions and data necessary to control how a weir should be operated in runtime. This block might refer to one weir section but the conditions described here can be used multiple times. Different weir sections can use the same Operational_Weir block, if all weir sections should be controlled in the same way. On the contrary, different weir sections have to use different Operational_Weir blocks, if they should be controlled in a different way. For the model, weir sections are different when: the weir type (bottom_up or top_down) is not the same; the sill depth of the weir is different, or the conditions to close and open the weir are different. The name of the weir is the parameter that identifies the block in the modelling system.
** Key "Weir_Name" : '''Description of the weir''' without blank spaces. This key has to be different in all defined Operational_Weir blocks. The description will be used to identify the block from outside (e.g. from a utromp2009 steering file).
** Key "Weir_Type" : '''Type of the weir''' (bottom_up or top_down). If this key is not defined, "bottom_up" will be used by default. This information must coincide with the information defined in the weir section of the corresponding utromp2009 steering file.
*** bottom_up: Water can flow over the weir only. The weir gate closes by moving upwards and opens to the bottom.
*** top_down: Water can flow under the gate only. The weir gate closes downwards and opens to the top.
** Key "Target_Weir_Height" : '''Target height''' of the weir after a control operation
*** This key can be used multiple times to define different target weir heights
*** Parameter 1 defines a unique name. This name is required later on in the file as a reference.
*** Parameter 2 defines the height in m above mean sea level.
** Key "Start_Weir_Height" : Name of the '''initial weir height at the beginning of the model run'''. The name must refer to parameter 1 of key [[#TWH|"Target_Weir_Height"]].
** Key "Weir_Speed" : '''Speed of weir gates''' to change the height of the weir.
*** Parameter 1 defines a unique name. This name is required later on in the file as a reference.
*** Parameter 2 defines the speed in m/s.
*** This key can be used multiple times to define different speeds (e.g. a typical speed and a maximum speed for the operation in hazardous situations).
** Key "Observation_Coordinates" : '''Coordinates of an observation point''', where model results can be measured.
*** Important: An observation point should always be wet. Otherwise no control conditions to open or close a weir gate can be checked.
*** Parameter 1 defines a unique name. This name is required as a reference for other keys in the file.
*** Parameter 2 and 3 defines the geographical location (x- and y-coordinates).
*** Parameter 4 defines the vertical position in m above mean sea level.
** Key "Threshold" : '''Threshold of a measurement value''' that has to be exceeded to start the change of a weir height.
*** Parameter 1 defines a unique name. This name is required as a reference for other keys in the file.
*** Parameter 2 defines the type of threshold. The following types are defined:
**** "waterlevel" = threshold to be compared with a waterlevel at an observation point
**** "current_magnitude" = threshold to be compared with a current velocity magnitude at an observation point
**** "current_direction" = threshold to be compared with a current direction at an observation point
**** "diff_waterlevel" = threshold to be compared with a waterlevel difference between two observation points
**** "diff_current_magnitude" = threshold to be compared with a current velocity magnitude difference between two observation points
**** "gradt_waterlevel" = threshold to be compared with the speed of waterlevel changes at an observation point
**** "date" = threshold to be compared with the current date of simulation
**** "time" = threshold to be compared with the current time of simulation
**** "day_of_week" = threshold to be compared with the current date of the week of simulation
*** Parameter 3 defines the threshold value. The following forms with respect to the type of threshold are allowed:
**** "waterlevel": Floating point value in m above mean sea level
**** "current_magnitude": Floating point value in m/s, greater or equal to 0
**** "current_direction": Floating point value in degrees east (0 degree = direction points to the east; 90 degree = direction points to the north; 180 degree = direction points to the west; 270 degree = direction points to the south)
**** "diff_waterlevel": Floating point value in m
**** "diff_current_magnitude": Floating point value in m/s
**** "gradt_waterlevel": Floating point value in m/h (!)
**** "date": String of characters, Format = "DD.MM.YYYY"
**** "time": String of characters, Format = "hh:mm:ss" or "hh:mm:ss.nnnnnnnnn"
**** "day_of_week": Integer value with the following meaning: 1=Sunday; 2=Monday; 3=Tuesday; 4=Wednesday; 5=Thursday; 6=Friday; 7=Saturday
** Key "Control_Condition" : Information about '''control conditions''', which have to be fulfilled to start opening or closing a weir. There are three different types of control conditions. Each of them will be described as follows:
*** Type 1: Compare a computed value at an observation point with a threshold
**** Parameter 1 defines a unique name. This name is required as a reference for other keys in the file.
**** Parameter 2 is the name of the observation point as defined in key [[#OC|"Observation_Coordinates"]].
**** Parameter 3 is the comparison operator: Allowed are ">", "<", ">=", "<=", "==" or "/="
**** Parameter 4 is the name of the threshold as defined in key [[#TH|"threshold"]].
*** Type 2: Compare the difference of computed values at two different observation points with a threshold
**** Parameter 1 defines a unique name. This name is required as a reference for other keys in the file.
**** Parameter 2 are the two names of the observation points as defined in the key [[#OC|"Observation_Coordinates"]]. The order of the names is important to compute the right sign of the difference. The notation ist "name1[-]name2" (without blank spaces).
**** Parameter 3 is the comparison operator: Allowed are ">", "<", ">=", "<=", "==" or "/="
**** Parameter 4 is the name of the threshold as defined in key [[#TH|"threshold"]].
*** Type 3: Two different control conditions will be connected logically with "AND" or "OR"
**** Parameter 1 defines a unique name. This name is required as a reference for other keys in the file.
**** Parameter 2 is the name of control condition one.
**** Parameter 3 is the connecting operator: Allowed are "AND" or "OR".
**** Parameter 4 is the name of control condition two.
** Key "Conditional_Weir_Height" : Combination of a control condition, which has to be fulfilled to start open or close a weir and a target weir height. At least one '''combination of control condition and target weir height''' is necessary. Typically, there are two combinations, one to close a weir and one to re-open it.
*** Parameter 1 is the name of control condition, which has to be fulfilled to start open or close a weir. The name must refer to parameter 1 of key [[#CC|"Control_Condition"]].
*** Parameter 2 defines a priority value as an integer. The higher this value the higher the priority of the condition behind this combination. The priorität is important only in case there are different conditions fulfilled at the same time. In this case the new target weir height will be the one with the highest priority. It is not allowed to use identical priority values.
*** Parameter 3 is the name of the new target weir height. The name must refer to parameter 1 of key [[#TWH|"Target_Weir_Height"]].
*** Parameter 4 is the name of the speed of the weir gates to change the height. The name must refer to parameter 1 of key [[#WS|"Weir_Speed"]].
*** Parameter 5 defines a stopping time period (format = "dddddd-hh:mm:ss.nnnnnnnnn"). The stopping time is a period starting directly after reaching the target weir height. During this period no conditions will be checked. As a result, it is not possible that the height of the weir can change again during this period. The stopping time period can be zero. But a stopping time period larger than zero makes sense to rule out unwanted weir closings or openings because of up or down surges.
** Key "Observation_Start_End" : '''Start and end of a time period''' where control conditions to open or close a weir will be checked. This gives the user the opportunity to limit the checking of control conditions to a part of the simulation period. The user can define several periods by using this key multiple times. Without this key the control conditions to open or close a weir will be checked during the whole simulation period.
*** Parameter 1 defines the starting date and time. Format = "DD.MM.YYYY-hh:mm:ss.nnnnnnnnn"
*** Parameter 2 defines the ending date and time (same format).

'''General Remarks'''

# While reading this steering data file the '''dictionary file op_weir_dico.dat''' will be automatically accessed in directory '''$PROGHOME/dic/''' to support input.
|nutzerprogramme=
[[UNTRIM2]]
|language=Fortran90
|fileform=FORMATTED
|fileaccess=SEQUENTIAL
|fileextension=.dat
|writemodules=interactive generation (editor)
|readmodules=mod_m_op_weir_steer.f90 in fortran/lib/op_weir
|contact_original=[mailto:victoria.ortiz@baw.de V. Ortiz], [mailto:jens.juerges@baw.de J. Jürges]
|contact_maintenance=[mailto:victoria.ortiz@baw.de V. Ortiz], [mailto:jens.juerges@baw.de J. Jürges]
|examplefile=please refer to $PROGHOME/examples/op_weir/op_weir.dat
}}

OP WEIR.DAT

2021-03-30T12:53:16Z

Ak3jjuer: better english

OP WEIR.DAT

2021-03-30T12:24:23Z

Ak3jjuer: Picture added

{{FileDescription
|name_de=OP_WEIR.DAT
|filetype=op_weir.dat
|version=March 2021
|version_descr=March 2021
|significance= [[File:Illustration opweir en.png|350px|thumb|right]] contains input data to control [[UNTRIM2]] weir sections depending on model results at runtime. The advantage is that the model user is no longer forced to enter exact times of weir height changes before the start of the model run. Instead e.g. the waterlevel at a given observation point inside the model is able to start a change of weir height if this waterlevel exceeds or falls below a given threshold. As well the magnitude of the current velocity or the direction of the current velocity or the speed of waterlevel change or the difference of waterlevels or current magnitudes at two given observation points can be used to compare with thresholds. Additionally specific dates or times or weekdays can be used and differnet conditions can be combined logically (and or or connections).
|filecontents=
'''Input Steering Data'''

* general input data (block '''General_Data''')
** key "'''EPSG'''" : '''EPSG-Code''' of all horizontical coordinates in this file.
** key "'''Time_Zone'''" : '''Time zone''' of all times in this file.

* control data of one weir section (block '''Operational_Weir''') : This block contains conditions and data necessary to control the height and change of height of one weir section. This block can be used multiple times. Different weir sections can use the same Operational_Weir block, if all weir sections should be controlled in the same way. Different weir sections have to use different Operational_Weir blocks, if they shuld be controlled in a different way. Different means, that the weir type (bottom_up or top_down) is different or the sill depth of the weir is different or the conditions to close and open the weir are different. The name of the weir is the description to identify the block from outside.
** Key "Weir_Name" : '''Description of the weir''' without blank spaces. The descriptions of different Operational_Weir blocks have to be different. The description will be used to identify the block from outside (e.g. from a utromp2009 steering file).
** Key "Weir_Type" : '''Type of the weir''' (bottom_up oder top_down). If this key will not be used "bottom_up" will be used. This information must coincide with the information in the corresponding utromp2009 steering file.
*** bottom_up: The weir gate opens to the bottom. Water can flow over the gate only.
*** top_down: The weir gate opens to the top. Water can flow beneath the gate only.
** Key "Target_Weir_Height" : '''Target height''' of the weir after a control operation
*** This key can be used multiple times to define different target heights
*** Parameter 1 defines a unique name. This name has to be used later on as a reference.
*** Parameter 2 defines the height in m above mean sea level.
** Key "Start_Weir_Height" : Name of the '''initial weir height at the beginning of the model run'''. The name must refer to parameter 1 of key [[#TWH|"Target_Weir_Height"]].
** Key "Weir_Speed" : '''Speed of weir gates''' to change the height of the weir.
*** Parameter 1 defines a unique name. This name has to be used later on as a reference.
*** Parameter 2 defines the speed in m/s.
*** This key can be used multiple times to define different speeds (e.g. a typical speed and a maximum speed in case of a dangerous situation).
** Key "Observation_Coordinates" : '''Coordinates of an observation point''', where model results can be measured.
*** Important: An observation point should always be wet. Otherwise no control conditions to open or close a weir gate can be checked.
*** Parameter 1 defines a unique name. This name has to be used later on as a reference.
*** Parameter 2 and 3 defines the spatial position (x- and y-coordinates).
*** Parameter 4 defines the vertikal position in m above mean sea level.
** Key "Threshold" : '''Threshold of a measurement value''' that has to be exceeded to start the change of a weir height.
*** Parameter 1 defines a unique name. This name has to be used later on as a reference.
*** Parameter 2 defines the type of threshold. The following types are defined:
**** "waterlevel" = threshold to be compared with a waterlevel at an observation point
**** "current_magnitude" = threshold to be compared with a current velocity magnitude at an observation point
**** "current_direction" = threshold to be compared with a current direction at an observation point
**** "diff_waterlevel" = threshold to be compared with a waterlevel difference between two observation points
**** "diff_current_magnitude" = threshold to be compared with a current velocity magnitude difference between two observation points
**** "gradt_waterlevel" = threshold to be compared with the speed of waterlevel changes at an observation point
**** "date" = threshold to be compared with the current date of simulation
**** "time" = threshold to be compared with the current time of simulation
**** "day_of_week" = threshold to be compared with the current date of the week of simulation
*** Parameter 3 defines the threshold value. The following forms with respect to the type of threshold are allowed:
**** "waterlevel": Floating point value in m above mean sea level
**** "current_magnitude": Floating point value in m/s, greater or equal to 0
**** "current_direction": Floating point value in degrees east (0 degree = direction points to the east ; 90 degree = direction points to the north ; 180 degree = direction points to the west ; 270 degree = direction points to the south)
**** "diff_waterlevel": Floating point value in m
**** "diff_current_magnitude": Floating point value in m/s
**** "gradt_waterlevel": Floating point value in m/h (!)
**** "date": String of characters , Format = "DD.MM.YYYY"
**** "time": String of characters , Format = "hh:mm:ss" or "hh:mm:ss.nnnnnnnnn"
**** "day_of_week": Integer value with the following meaning: 1=sunday ; 2=monday ; 3=tuesday ; 4=wednesday ; 5=thursday ; 6=friday ; 7=saturday
** Key "Control_Condition" : Information about '''control conditions''', which have to be fullfilled to start opening or closing a weir. There are three different types of control conditions. Each of them will be described as follows:
*** Type 1: Compare a computed value at an observation point with a threshold
**** Parameter 1 defines a unique name. This name has to be used later on as a reference.
**** Parameter 2 is the name of the observation point as defined in key [[#OC|"Observation_Coordinates"]].
**** Parameter 3 is the comparison operator: Allowed are ">", "<", ">=", "<=", "==" or "/="
**** Parameter 4 is the name of the threshold as defined in key [[#TH|"threshold"]].
*** Type 2: Compare the difference of computed values at two different observation points with a threshold
**** Parameter 1 defines a unique name. This name has to be used later on as a reference.
**** Parameter 2 are the two names of the observation points as defined in the key [[#OC|"Observation_Coordinates"]]. The order of the names is important to compute the right sign of the difference. The notation ist "name1[-]name2" (without blank spaces).
**** Parameter 3 is the comparison operator: Allowed are ">", "<", ">=", "<=", "==" or "/="
**** Parameter 4 is the name of the threshold as defined in key [[#TH|"threshold"]].
*** Type 3: Two different control conditions will be connected logically with "AND" or "OR"
**** Parameter 1 defines a unique name. This name has to be used later on as a reference.
**** Parameter 2 is the name of control condition one.
**** Parameter 3 is the connecting operator: Allowed are "AND" or "OR".
**** Parameter 4 is the name of control condition two.
** Key "Conditional_Weir_Height" : Combination of a control condition, which has to be fullfilled to start open or close a weir and a target weir height. At least one '''combination of control condition and target weir height''' is necessary. Typically there are two combinations, one to close a weir and one to re-open it.
*** Parameter 1 is the name of control condition, which has to be fullfilled to start open or close a weir. The name must refer to parameter 1 of key [[#CC|"Control_Condition"]].
*** Parameter 2 defines a priority value as an integer. The higher this value the higher the priority of the condition behind this combination. The priorität is important only in case there are different conditions fullfilled at the same time. In this case the new target weir height will be the one with the highest priority. It is not allowed to use identical priority values.
*** Parameter 3 is the name of the new target weir height. The name must refer to parameter 1 of key [[#TWH|"Target_Weir_Height"]].
*** Parameter 4 is the name of the speed of the weir gates to change the height. The name must refer to parameter 1 of key [[#WS|"Weir_Speed"]].
*** Parameter 5 defines a stopping time period (format = "dddddd-hh:mm:ss.nnnnnnnnn"). The stopping time is a period starting directly after reaching the target weir height. During this period no conditions will be checked. As a result it is not possible that the height of the weir can change again during this period. The stopping time period can be zero. But a stopping time period larger than zero makes sense to rule out unwanted weir closings or openings because of up or downsurges.
** Key "Observation_Start_End" : '''Start and end of a time period''' where control conditions to open or close a weir will be checked. This gives the user the opportunity to limit the checking of control conditions to a part of the simulation period. The user can define several periods by using this key multiple times. Without this key the control conditions to open or close a weir will be checked during the whole simulation period.
*** Parameter 1 defines the starting date and time. Format = "DD.MM.YYYY-hh:mm:ss.nnnnnnnnn"
*** Parameter 2 defines the ending date and time (same format).

'''General Remarks'''

# While reading this steering data file the '''dictionary file op_weir_dico.dat''' will be automatically accessed in directory '''$PROGHOME/dic/''' to support input.
|nutzerprogramme=
[[UNTRIM2]]
|language=Fortran90
|fileform=FORMATTED
|fileaccess=SEQUENTIAL
|fileextension=.dat
|writemodules=interactive generation (editor)
|readmodules=mod_m_op_weir_steer.f90 in fortran/lib/op_weir
|contact_original=[mailto:victoria.ortiz@baw.de V. Ortiz], [mailto:jens.juerges@baw.de J. Jürges]
|contact_maintenance=[mailto:victoria.ortiz@baw.de V. Ortiz], [mailto:jens.juerges@baw.de J. Jürges]
|examplefile=please refer to $PROGHOME/examples/untrim2009/op_weir.dat
}}

File:Illustration opweir en.png

2021-03-30T12:23:20Z

Ak3jjuer: Visualization of current velocities in a longitudinal profile in front of a weir and behind. These velocities at both observation points (together with thresholds) can be used to start change the height of a weir.

== Summary ==
Visualization of current velocities in a longitudinal profile in front of a weir and behind. These velocities at both observation points (together with thresholds) can be used to start change the height of a weir.

OP WEIR.DAT

2021-03-30T10:28:15Z

Ak3jjuer: internal links added

{{FileDescription
|name_de=OP_WEIR.DAT
|filetype=op_weir.dat
|version=March 2021
|version_descr=March 2021
|significance=contains input data to control [[UNTRIM2]] weir sections depending on model results at runtime. The advantage is that the model user is no longer forced to enter exact times of weir height changes before the start of the model run. Instead e.g. the waterlevel at a given observation point inside the model is able to start a change of weir height if this waterlevel exceeds or falls below a given threshold. As well the magnitude of the current velocity or the direction of the current velocity or the speed of waterlevel change or the difference of waterlevels or current magnitudes at two given observation points can be used to compare with thresholds. Additionally specific dates or times or weekdays can be used and differnet conditions can be combined logically (and or or connections).
|filecontents=
'''Input Steering Data'''

* general input data (block '''General_Data''')
** key "'''EPSG'''" : '''EPSG-Code''' of all horizontical coordinates in this file.
** key "'''Time_Zone'''" : '''Time zone''' of all times in this file.

* control data of one weir section (block '''Operational_Weir''') : This block contains conditions and data necessary to control the height and change of height of one weir section. This block can be used multiple times. Different weir sections can use the same Operational_Weir block, if all weir sections should be controlled in the same way. Different weir sections have to use different Operational_Weir blocks, if they shuld be controlled in a different way. Different means, that the weir type (bottom_up or top_down) is different or the sill depth of the weir is different or the conditions to close and open the weir are different. The name of the weir is the description to identify the block from outside.
** Key "Weir_Name" : '''Description of the weir''' without blank spaces. The descriptions of different Operational_Weir blocks have to be different. The description will be used to identify the block from outside (e.g. from a utromp2009 steering file).
** Key "Weir_Type" : '''Type of the weir''' (bottom_up oder top_down). If this key will not be used "bottom_up" will be used. This information must coincide with the information in the corresponding utromp2009 steering file.
*** bottom_up: The weir gate opens to the bottom. Water can flow over the gate only.
*** top_down: The weir gate opens to the top. Water can flow beneath the gate only.
** Key "Target_Weir_Height" : '''Target height''' of the weir after a control operation
*** This key can be used multiple times to define different target heights
*** Parameter 1 defines a unique name. This name has to be used later on as a reference.
*** Parameter 2 defines the height in m above mean sea level.
** Key "Start_Weir_Height" : Name of the '''initial weir height at the beginning of the model run'''. The name must refer to parameter 1 of key [[#TWH|"Target_Weir_Height"]].
** Key "Weir_Speed" : '''Speed of weir gates''' to change the height of the weir.
*** Parameter 1 defines a unique name. This name has to be used later on as a reference.
*** Parameter 2 defines the speed in m/s.
*** This key can be used multiple times to define different speeds (e.g. a typical speed and a maximum speed in case of a dangerous situation).
** Key "Observation_Coordinates" : '''Coordinates of an observation point''', where model results can be measured.
*** Important: An observation point should always be wet. Otherwise no control conditions to open or close a weir gate can be checked.
*** Parameter 1 defines a unique name. This name has to be used later on as a reference.
*** Parameter 2 and 3 defines the spatial position (x- and y-coordinates).
*** Parameter 4 defines the vertikal position in m above mean sea level.
** Key "Threshold" : '''Threshold of a measurement value''' that has to be exceeded to start the change of a weir height.
*** Parameter 1 defines a unique name. This name has to be used later on as a reference.
*** Parameter 2 defines the type of threshold. The following types are defined:
**** "waterlevel" = threshold to be compared with a waterlevel at an observation point
**** "current_magnitude" = threshold to be compared with a current velocity magnitude at an observation point
**** "current_direction" = threshold to be compared with a current direction at an observation point
**** "diff_waterlevel" = threshold to be compared with a waterlevel difference between two observation points
**** "diff_current_magnitude" = threshold to be compared with a current velocity magnitude difference between two observation points
**** "gradt_waterlevel" = threshold to be compared with the speed of waterlevel changes at an observation point
**** "date" = threshold to be compared with the current date of simulation
**** "time" = threshold to be compared with the current time of simulation
**** "day_of_week" = threshold to be compared with the current date of the week of simulation
*** Parameter 3 defines the threshold value. The following forms with respect to the type of threshold are allowed:
**** "waterlevel": Floating point value in m above mean sea level
**** "current_magnitude": Floating point value in m/s, greater or equal to 0
**** "current_direction": Floating point value in degrees east (0 degree = direction points to the east ; 90 degree = direction points to the north ; 180 degree = direction points to the west ; 270 degree = direction points to the south)
**** "diff_waterlevel": Floating point value in m
**** "diff_current_magnitude": Floating point value in m/s
**** "gradt_waterlevel": Floating point value in m/h (!)
**** "date": String of characters , Format = "DD.MM.YYYY"
**** "time": String of characters , Format = "hh:mm:ss" or "hh:mm:ss.nnnnnnnnn"
**** "day_of_week": Integer value with the following meaning: 1=sunday ; 2=monday ; 3=tuesday ; 4=wednesday ; 5=thursday ; 6=friday ; 7=saturday
** Key "Control_Condition" : Information about '''control conditions''', which have to be fullfilled to start opening or closing a weir. There are three different types of control conditions. Each of them will be described as follows:
*** Type 1: Compare a computed value at an observation point with a threshold
**** Parameter 1 defines a unique name. This name has to be used later on as a reference.
**** Parameter 2 is the name of the observation point as defined in key [[#OC|"Observation_Coordinates"]].
**** Parameter 3 is the comparison operator: Allowed are ">", "<", ">=", "<=", "==" or "/="
**** Parameter 4 is the name of the threshold as defined in key [[#TH|"threshold"]].
*** Type 2: Compare the difference of computed values at two different observation points with a threshold
**** Parameter 1 defines a unique name. This name has to be used later on as a reference.
**** Parameter 2 are the two names of the observation points as defined in the key [[#OC|"Observation_Coordinates"]]. The order of the names is important to compute the right sign of the difference. The notation ist "name1[-]name2" (without blank spaces).
**** Parameter 3 is the comparison operator: Allowed are ">", "<", ">=", "<=", "==" or "/="
**** Parameter 4 is the name of the threshold as defined in key [[#TH|"threshold"]].
*** Type 3: Two different control conditions will be connected logically with "AND" or "OR"
**** Parameter 1 defines a unique name. This name has to be used later on as a reference.
**** Parameter 2 is the name of control condition one.
**** Parameter 3 is the connecting operator: Allowed are "AND" or "OR".
**** Parameter 4 is the name of control condition two.
** Key "Conditional_Weir_Height" : Combination of a control condition, which has to be fullfilled to start open or close a weir and a target weir height. At least one '''combination of control condition and target weir height''' is necessary. Typically there are two combinations, one to close a weir and one to re-open it.
*** Parameter 1 is the name of control condition, which has to be fullfilled to start open or close a weir. The name must refer to parameter 1 of key [[#CC|"Control_Condition"]].
*** Parameter 2 defines a priority value as an integer. The higher this value the higher the priority of the condition behind this combination. The priorität is important only in case there are different conditions fullfilled at the same time. In this case the new target weir height will be the one with the highest priority. It is not allowed to use identical priority values.
*** Parameter 3 is the name of the new target weir height. The name must refer to parameter 1 of key [[#TWH|"Target_Weir_Height"]].
*** Parameter 4 is the name of the speed of the weir gates to change the height. The name must refer to parameter 1 of key [[#WS|"Weir_Speed"]].
*** Parameter 5 defines a stopping time period (format = "dddddd-hh:mm:ss.nnnnnnnnn"). The stopping time is a period starting directly after reaching the target weir height. During this period no conditions will be checked. As a result it is not possible that the height of the weir can change again during this period. The stopping time period can be zero. But a stopping time period larger than zero makes sense to rule out unwanted weir closings or openings because of up or downsurges.
** Key "Observation_Start_End" : '''Start and end of a time period''' where control conditions to open or close a weir will be checked. This gives the user the opportunity to limit the checking of control conditions to a part of the simulation period. The user can define several periods by using this key multiple times. Without this key the control conditions to open or close a weir will be checked during the whole simulation period.
*** Parameter 1 defines the starting date and time. Format = "DD.MM.YYYY-hh:mm:ss.nnnnnnnnn"
*** Parameter 2 defines the ending date and time (same format).

'''General Remarks'''

# While reading this steering data file the '''dictionary file op_weir_dico.dat''' will be automatically accessed in directory '''$PROGHOME/dic/''' to support input.
|nutzerprogramme=
[[UNTRIM2]]
|language=Fortran90
|fileform=FORMATTED
|fileaccess=SEQUENTIAL
|fileextension=.dat
|writemodules=interactive generation (editor)
|readmodules=mod_m_op_weir_steer.f90 in fortran/lib/op_weir
|contact_original=[mailto:victoria.ortiz@baw.de V. Ortiz], [mailto:jens.juerges@baw.de J. Jürges]
|contact_maintenance=[mailto:victoria.ortiz@baw.de V. Ortiz], [mailto:jens.juerges@baw.de J. Jürges]
|examplefile=please refer to $PROGHOME/examples/untrim2009/op_weir.dat
}}

OP WEIR.DAT

2021-03-12T07:43:33Z

Ak3jjuer: Key "conditional_weir_height" added

{{FileDescription
|name_de=OP_WEIR.DAT
|filetype=op_weir.dat
|version=March 2021
|version_descr=March 2021
|significance=contains input data to control [[UNTRIM2]] weir sections depending on model results at runtime. The advantage is that the model user is no longer forced to enter exact times of weir height changes before the start of the model run. Instead e.g. the waterlevel at a given observation point inside the model is able to start a change of weir height if this waterlevel exceeds or falls below a given threshold. As well the magnitude of the current velocity or the direction of the current velocity or the speed of waterlevel change or the difference of waterlevels or current magnitudes at two given observation points can be used to compare with thresholds. Additionally specific dates or times or weekdays can be used and differnet conditions can be combined logically (and or or connections).
|filecontents=
'''Input Steering Data'''

* general input data (block '''General_Data''')
** key "'''EPSG'''" : '''EPSG-Code''' of all horizontical coordinates in this file.
** key "'''Time_Zone'''" : '''Time zone''' of all times in this file.

* control data of one weir section (block '''Operational_Weir''') : This block contains conditions and data necessary to control the height and change of height of one weir section. This block can be used multiple times. Different weir sections can use the same Operational_Weir block, if all weir sections should be controlled in the same way. Different weir sections have to use different Operational_Weir blocks, if they shuld be controlled in a different way. Different means, that the weir type (bottom_up or top_down) is different or the sill depth of the weir is different or the conditions to close and open the weir are different. The name of the weir is the description to identify the block from outside.
** Key "'''Weir_Name'''" : '''Description of the weir''' without blank spaces. The descriptions of different Operational_Weir blocks have to be different. The description will be used to identify the block from outside (e.g. from a utromp2009 steering file).
** Key "'''Weir_Type'''" : '''Type of the weir''' (bottom_up oder top_down). If this key will not be used "bottom_up" will be used. This information must coincide with the information in the corresponding utromp2009 steering file.
*** bottom_up: The weir gate opens to the bottom. Water can flow over the gate only.
*** top_down: The weir gate opens to the top. Water can flow beneath the gate only.
** Key "'''Target_Weir_Height'''" : '''Target height''' of the weir after a control operation
*** This key can be used multiple times to define different target heights
*** Parameter 1 defines a unique name. This name has to be used later on as a reference.
*** Parameter 2 defines the height in m above mean sea level.
** Key "'''Start_Weir_Height'''" : Name of the '''initial weir height at the beginning of the model run'''. The name must refer to parameter 1 of key "Target_Weir_Height".
** Key "'''Weir_Speed'''" : '''Speed of weir gates''' to change the height of the weir.
*** Parameter 1 defines a unique name. This name has to be used later on as a reference.
*** Parameter 2 defines the speed in m/s.
*** This key can be used multiple times to define different speeds (e.g. a typical speed and a maximum speed in case of a dangerous situation).
** Key "'''Observation_Coordinates'''" : '''Coordinates of an observation point''', where model results can be measured.
*** Important: An observation point should always be wet. Otherwise no control conditions to open or close a weir gate can be checked.
*** Parameter 1 defines a unique name. This name has to be used later on as a reference.
*** Parameter 2 and 3 defines the spatial position (x- and y-coordinates).
*** Parameter 4 defines the vertikal position in m above mean sea level.
** Key "'''Threshold'''" : '''Threshold of a measurement value''' that has to be exceeded to start the change of a weir height.
*** Parameter 1 defines a unique name. This name has to be used later on as a reference.
*** Parameter 2 defines the type of threshold. The following types are defined:
**** "waterlevel" = threshold to be compared with a waterlevel at an observation point
**** "current_magnitude" = threshold to be compared with a current velocity magnitude at an observation point
**** "current_direction" = threshold to be compared with a current direction at an observation point
**** "diff_waterlevel" = threshold to be compared with a waterlevel difference between two observation points
**** "diff_current_magnitude" = threshold to be compared with a current velocity magnitude difference between two observation points
**** "gradt_waterlevel" = threshold to be compared with the speed of waterlevel changes at an observation point
**** "date" = threshold to be compared with the current date of simulation
**** "time" = threshold to be compared with the current time of simulation
**** "day_of_week" = threshold to be compared with the current date of the week of simulation
*** Parameter 3 defines the threshold value. The following forms with respect to the type of threshold are allowed:
**** "waterlevel": Floating point value in m above mean sea level
**** "current_magnitude": Floating point value in m/s, greater or equal to 0
**** "current_direction": Floating point value in degrees east (0 degree = direction points to the east ; 90 degree = direction points to the north ; 180 degree = direction points to the west ; 270 degree = direction points to the south)
**** "diff_waterlevel": Floating point value in m
**** "diff_current_magnitude": Floating point value in m/s
**** "gradt_waterlevel": Floating point value in m/h (!)
**** "date": String of characters , Format = "DD.MM.YYYY"
**** "time": String of characters , Format = "hh:mm:ss" or "hh:mm:ss.nnnnnnnnn"
**** "day_of_week": Integer value with the following meaning: 1=sunday ; 2=monday ; 3=tuesday ; 4=wednesday ; 5=thursday ; 6=friday ; 7=saturday
** Key "'''Control_Condition'''" : Information about '''control conditions''', which have to be fullfilled to start opening or closing a weir. There are three different types of control conditions. Each of them will be described as follows:
*** Type 1: Compare a computed value at an observation point with a threshold
**** Parameter 1 defines a unique name. This name has to be used later on as a reference.
**** Parameter 2 is the name of the observation point as defined in key "Observation_Coordinates".
**** Parameter 3 is the comparison operator: Allowed are ">", "<", ">=", "<=", "==" or "/="
**** Parameter 4 is the name of the threshold as defined in key "threshold".
*** Type 2: Compare the difference of computed values at two different observation points with a threshold
**** Parameter 1 defines a unique name. This name has to be used later on as a reference.
**** Parameter 2 are the two names of the observation points. The order of the names is important to compute the right sign of the difference. The notation ist "name1[-]name2" (without blank spaces).
**** Parameter 3 is the comparison operator: Allowed are ">", "<", ">=", "<=", "==" or "/="
**** Parameter 4 is the name of the threshold as defined in key "threshold".
*** Type 3: Two different control conditions will be connected logically with "AND" or "OR"
**** Parameter 1 defines a unique name. This name has to be used later on as a reference.
**** Parameter 2 is the name of control condition one.
**** Parameter 3 is the connecting operator: Allowed are "AND" or "OR".
**** Parameter 4 is the name of control condition two.
** Key "'''Conditional_Weir_Height'''" : Combination of a control condition, which has to be fullfilled to start open or close a weir and a target weir height. At least one '''combination of control condition and target weir height''' is necessary. Typically there are two combinations, one to close a weir and one to re-open it.
*** Parameter 1 is the name of control condition, which has to be fullfilled to start open or close a weir. The name must refer to parameter 1 of key "Control_Condition".
*** Parameter 2 defines a priority value as an integer. The higher this value the higher the priority of the condition behind this combination. The priorität is important only in case there are different conditions fullfilled at the same time. In this case the new target weir height will be the one with the highest priority. It is not allowed to use identical priority values.
*** Parameter 3 is the name of the new target weir height. The name must refer to parameter 1 of key "Target_Weir_Height".
*** Parameter 4 is the name of the speed of the weir gates to change the height. The name must refer to parameter 1 of key "Weir_Speed".
*** Parameter 5 defines a stopping time period (format = "dddddd-hh:mm:ss.nnnnnnnnn"). The stopping time is a period starting directly after reaching the target weir height. During this period no conditions will be checked. As a result it is not possible that the height of the weir can change again during this period. The stopping time period can be zero. But a stopping time period larger than zero makes sense to rule out unwanted weir closings or openings because of up or downsurges.
** Key "'''Observation_Start_End'''" : '''Start and end of a time period''' where control conditions to open or close a weir will be checked. This gives the user the opportunity to limit the checking of control conditions to a part of the simulation period. The user can define several periods by using this key multiple times. Without this key the control conditions to open or close a weir will be checked during the whole simulation period.
*** Parameter 1 defines the starting date and time. Format = "DD.MM.YYYY-hh:mm:ss.nnnnnnnnn"
*** Parameter 2 defines the ending date and time (same format).

'''General Remarks'''

# While reading this steering data file the '''dictionary file op_weir_dico.dat''' will be automatically accessed in directory '''$PROGHOME/dic/''' to support input.
|nutzerprogramme=
[[UNTRIM2]]
|language=Fortran90
|fileform=FORMATTED
|fileaccess=SEQUENTIAL
|fileextension=.dat
|writemodules=interactive generation (editor)
|readmodules=mod_m_op_weir_steer.f90 in fortran/lib/op_weir
|contact_original=[mailto:victoria.ortiz@baw.de V. Ortiz], [mailto:jens.juerges@baw.de J. Jürges]
|contact_maintenance=[mailto:victoria.ortiz@baw.de V. Ortiz], [mailto:jens.juerges@baw.de J. Jürges]
|examplefile=please refer to $PROGHOME/examples/untrim2009/op_weir.dat
}}

OP WEIR.DAT

2021-03-11T15:55:25Z

Ak3jjuer: Added more keys

{{FileDescription
|name_de=OP_WEIR.DAT
|filetype=op_weir.dat
|version=March 2021
|version_descr=March 2021
|significance=contains input data to control [[UNTRIM2]] weir sections depending on model results at runtime. The advantage is that the model user is no longer forced to enter exact times of weir height changes before the start of the model run. Instead e.g. the waterlevel at a given observation point inside the model is able to start a change of weir height if this waterlevel exceeds or falls below a given threshold. As well the magnitude of the current velocity or the direction of the current velocity or the speed of waterlevel change or the difference of waterlevels or current magnitudes at two given observation points can be used to compare with thresholds. Additionally specific dates or times or weekdays can be used and differnet conditions can be combined logically (and or or connections).
|filecontents=
'''Input Steering Data'''

* general input data (block '''General_Data''')
** key "'''EPSG'''" : '''EPSG-Code''' of all horizontical coordinates in this file.
** key "'''Time_Zone'''" : '''Time zone''' of all times in this file.

* control data of one weir section (block '''Operational_Weir''') : This block contains conditions and data necessary to control the height and change of height of one weir section. This block can be used multiple times. Different weir sections can use the same Operational_Weir block, if all weir sections should be controlled in the same way. Different weir sections have to use different Operational_Weir blocks, if they shuld be controlled in a different way. Different means, that the weir type (bottom_up or top_down) is different or the sill depth of the weir is different or the conditions to close and open the weir are different. The name of the weir is the description to identify the block from outside.
** Key "'''Weir_Name'''" : '''Description of the weir''' without blank spaces. The descriptions of different Operational_Weir blocks have to be different. The description will be used to identify the block from outside (e.g. from a utromp2009 steering file).
** Key "'''Weir_Type'''" : '''Type of the weir''' (bottom_up oder top_down). If this key will not be used "bottom_up" will be used. This information must coincide with the information in the corresponding utromp2009 steering file.
*** bottom_up: The weir gate opens to the bottom. Water can flow over the gate only.
*** top_down: The weir gate opens to the top. Water can flow beneath the gate only.
** Key "'''Target_Weir_Height'''" : '''Target height''' of the weir after a control operation
*** This key can be used multiple times to define different target heights
*** Parameter 1 defines a unique name. This name has to be used later on as a reference.
*** Parameter 2 defines the height in m above mean sea level.
** Key "'''Start_Weir_Height'''" : Name of the '''initial weir height at the beginning of the model run'''. The name must refer to parameter 1 of key "Target_Weir_Height".
** Key "'''Weir_Speed'''" : '''Speed of weir gates''' to change the height of the weir.
*** Parameter 1 defines a unique name. This name has to be used later on as a reference.
*** Parameter 2 defines the speed in m/s.
*** This key can be used multiple times to define different speeds (e.g. a typical speed and a maximum speed in case of a dangerous situation).
** Key "'''Observation_Coordinates'''" : '''Coordinates of an observation point''', where model results can be measured.
*** Important: An observation point should always be wet. Otherwise no control conditions to open or close a weir gate can be checked.
*** Parameter 1 defines a unique name. This name has to be used later on as a reference.
*** Parameter 2 and 3 defines the spatial position (x- and y-coordinates).
*** Parameter 4 defines the vertikal position in m above mean sea level.
** Key "'''Threshold'''" : '''Threshold of a measurement value''' that has to be exceeded to start the change of a weir height.
*** Parameter 1 defines a unique name. This name has to be used later on as a reference.
*** Parameter 2 defines the type of threshold. The following types are defined:
**** "waterlevel" = threshold to be compared with a waterlevel at an observation point
**** "current_magnitude" = threshold to be compared with a current velocity magnitude at an observation point
**** "current_direction" = threshold to be compared with a current direction at an observation point
**** "diff_waterlevel" = threshold to be compared with a waterlevel difference between two observation points
**** "diff_current_magnitude" = threshold to be compared with a current velocity magnitude difference between two observation points
**** "gradt_waterlevel" = threshold to be compared with the speed of waterlevel changes at an observation point
**** "date" = threshold to be compared with the current date of simulation
**** "time" = threshold to be compared with the current time of simulation
**** "day_of_week" = threshold to be compared with the current date of the week of simulation
*** Parameter 3 defines the threshold value. The following forms with respect to the type of threshold are allowed:
**** "waterlevel": Floating point value in m above mean sea level
**** "current_magnitude": Floating point value in m/s, greater or equal to 0
**** "current_direction": Floating point value in degrees east (0 degree = direction points to the east ; 90 degree = direction points to the north ; 180 degree = direction points to the west ; 270 degree = direction points to the south)
**** "diff_waterlevel": Floating point value in m
**** "diff_current_magnitude": Floating point value in m/s
**** "gradt_waterlevel": Floating point value in m/h (!)
**** "date": String of characters , Format = "DD.MM.YYYY"
**** "time": String of characters , Format = "hh:mm:ss" or "hh:mm:ss.nnnnnnnnn"
**** "day_of_week": Integer value with the following meaning: 1=sunday ; 2=monday ; 3=tuesday ; 4=wednesday ; 5=thursday ; 6=friday ; 7=saturday
** Key "'''Control_Condition'''" : Information about '''control conditions''', which have to be fullfilled to start opening or closing a weir. There are three different types of control conditions. Each of them will be described as follows:
*** Type 1: Compare a computed value at an observation point with a threshold
**** Parameter 1 defines a unique name. This name has to be used later on as a reference.
**** Parameter 2 is the name of the observation point as defined in key "Observation_Coordinates".
**** Parameter 3 is the comparison operator: Allowed are ">", "<", ">=", "<=", "==" or "/="
**** Parameter 4 is the name of the threshold as defined in key "threshold".
*** Type 2: Compare the difference of computed values at two different observation points with a threshold
**** Parameter 1 defines a unique name. This name has to be used later on as a reference.
**** Parameter 2 are the two names of the observation points. The order of the names is important to compute the right sign of the difference. The notation ist "name1[-]name2" (without blank spaces).
**** Parameter 3 is the comparison operator: Allowed are ">", "<", ">=", "<=", "==" or "/="
**** Parameter 4 is the name of the threshold as defined in key "threshold".
*** Type 3: Two different control conditions will be connected logically with "AND" or "OR"
**** Parameter 1 defines a unique name. This name has to be used later on as a reference.
**** Parameter 2 is the name of control condition one.
**** Parameter 3 is the connecting operator: Allowed are "AND" or "OR".
**** Parameter 4 is the name of control condition two.
** Key "'''Observation_Start_End'''" : '''Start and end of a time period''' where control conditions to open or close a weir will be checked. This gives the user the opportunity to limit the checking of control conditions to a part of the simulation period. The user can define several periods by using this key multiple times. Without this key the control conditions to open or close a weir will be checked during the whole simulation period.
*** Parameter 1 defines the starting date and time. Format = "DD.MM.YYYY-hh:mm:ss.nnnnnnnnn"
*** Parameter 2 defines the ending date and time.

'''General Remarks'''

# While reading this steering data file the '''dictionary file op_weir_dico.dat''' will be automatically accessed in directory '''$PROGHOME/dic/''' to support input.
|nutzerprogramme=
[[UNTRIM2]]
|language=Fortran90
|fileform=FORMATTED
|fileaccess=SEQUENTIAL
|fileextension=.dat
|writemodules=interactive generation (editor)
|readmodules=mod_m_op_weir_steer.f90 in fortran/lib/op_weir
|contact_original=[mailto:victoria.ortiz@baw.de V. Ortiz], [mailto:jens.juerges@baw.de J. Jürges]
|contact_maintenance=[mailto:victoria.ortiz@baw.de V. Ortiz], [mailto:jens.juerges@baw.de J. Jürges]
|examplefile=please refer to $PROGHOME/examples/untrim2009/op_weir.dat
}}

OP WEIR.DAT

2021-03-11T12:57:35Z

Ak3jjuer: List of keys added

OP WEIR.DAT

2021-03-11T09:34:59Z

Ak3jjuer: First creation

File Descriptions

2021-03-11T07:41:58Z

Ak3jjuer: new item: file op_weir

__NOAUTOLINKS__
__NOAUTOLINKTARGET__
[[de:Dateikennblätter]]
===Short Description of Computer Files of the BAW-DH===

This page shows you a alphabetically sorted list of the most important types of data files used at the BAW-DH. 
----
* [[ABDF.DAT|abdf.dat]]: general input data for program ''[[ABDF]]''
* [[ADCP2BDF.DAT|adcp2bdf.dat]]: general input data for program ''[[ADCP2BDF]]''
* [[ADCP2PROFILE.DAT|adcp2profile.dat]]: general input data for program ''[[ADCP2PROFILE]]''
* [[ADCP_PROFILE.DAT|adcp_profile.dat]]: contains the measured data of ''one'' ADCP moving ship profile
* [[ADCP_WH.DAT|adcp_wh.dat]]: ADCP workhorse measured data
* [[ASCII.DAT|ascii.dat]]: general ASCII data file
----
* [[BAGGER.DAT|bagger.dat]]: dredger-polygons file for ''[[TC2BAGGER]]''
* [[BATCHPLOT.DAT|batchplot.dat]]: specific input data for program ''[[BATCHPLOT]]''
* [[BDF_FILE_CFG.DAT|bdf_file_cfg.dat]]: contains configuration data for the universal direct access data files
* [[BFABSENK.DAT|bfabsenk.dat]]: general input data for the program ''BFABSENK''
* [[BOERND.DAT|boernd.dat]]: general input data for the program ''BOERND''
* [[BOEWRT.DAT|boewrt.dat]]: contains measured or calculated time-series data for a single location
* [[BOUNDS.CFG.DAT|bounds.cfg.dat]]: List of interval definitions for various programs, e. g. [[NCANALYSE]] or [[NCPLOT]]
* [[BSECTION.DAT|bsection.dat]]: definitions of boundary sections for generation of boundary time series data
* [[BSH2BAW.DAT|bsh2baw.dat]]: general input data for the program BSH2BAW
----
* [[CF-NETCDF.NC|cf-netcdf.nc]]: BAW instance of a [[NetCDF]] file
* [[COLORS.DAT|colors.dat]]: color table
* [[COLORS.CFG.DAT|colors.cfg.dat]]: list of color definitions for the program ''[[NCPLOT]]''
* [[CONLIM.DAT|conlim.dat]]: boundary conditions file for ''[[TELEMAC-2D]]''
* [[CROSSPRO.DAT|crosspro.dat]]: general input data for program ''[[CROSSPRO]]''
----
* [[DATA2GEOM.DAT|data2geom.dat]]: general input data for the program ''[[DATA2GEOM]]''
* [[DATACONVERT.DAT|dataconvert.dat]]: general input data for the program ''[[DATACONVERT]]''
* [[DATEILISTE.DAT|dateiliste.dat]]: liste of filenames with complete path
* [[DELFT3D.BND|delft3d.bnd]]: Contains the location and description of open boundaries for the integrated modeling system ''DELFT3D''
* [[DELFT3D.DEP|delft3d.dep]]: Contains the bathymetry in the model area for the integrated modeling system ''DELFT3D''
* [[DELFT3D.DRY|delft3d.dry]]: Contains the locations of permanently dry points for the integrated modeling system ''DELFT3D''
* [[DELFT3D.ENC|delft3d.enc]]: Contains the co-ordinates of the grid enclosure for the integrated modeling system ''DELFT3D''
* [[DELFT3D.EXT|delft3d.ext]]: Contains location and type of 2D weir effects for the integrated modeling system ''DELFT3D''
* [[DELFT3D.GRD|delft3d.grd]]: Contains the co-ordinates of the orthogonal curvilinear grid for the integrated modeling system ''DELFT3D''
* [[DELFT3D.LWL|delft3d.lwl]]: Contains location and type of local weir effects including friction for the integrated modeling system ''DELFT3D''
* [[DELFT3D.THD|delft3d.thd]]: Contains location and type for thin, permanently dry dams for the integrated modeling system ''DELFT3D''
* [[DIDAMERGE.DAT|didamerge.dat]]: general input data for program ''[[DIDAMERGE]]''
* [[DIDAMINTQ.DAT|didamintq.dat]]: general input data for the program ''[[DIDAMINTQ]]''
* [[DIDAMINTQ.CFG|didamintq.cfg]]: special configuration data for the program ''[[DIDAMINTQ]]''
* [[DIDAMINTZ.DAT|didamintz.dat]]: general input data for the program ''[[DIDAMINTZ]]''
* [[DIDAMINTZ.CFG.DAT|didamintz.cfg.dat]]: configuration file for the program ''[[DIDAMINTZ]]''
* [[DIDARENAME.DAT|didarename.dat]]: general input data for program ''[[DIDARENAME]]''
* [[DIDASPLIT.DAT|didasplit.dat]]: general input data for program ''[[DIDASPLIT]]''
* [[DEPRO2D.DAT|depro2d.dat]]: general input data for program ''[[DEPRO2D]]''
* [[DIGI.GKK|digi.gkk]]: Contains digitized line type structures
* [[DI-MF.DAT|di-mf.dat]]: Master file of program ''[[TR2APP]]'' with information about filenames
* [[DIRZ.BIN.R|dirz.bin.r]]: recordlength-file of the universal direct access data files
* [[DIRZ.BIN.I|dirz.bin.i]]: information-file of the universal direct access data files
* [[DIRZ.BIN|dirz.bin]]: data-file of the universal direct access data files
* [[DREDGESIM.DAT|dredgesim.dat]]: user specific steering data for dredging and disposal package ''DredgeSim''
* [[DTOPO.DAT|dtopo.dat]]: difference of two finite difference topographies
----
* [[ENERF.DAT|enerf.dat]]: general input data for the program ''[[ENERF]]''
* [[ENERF.CFG.DAT|enerf.cfg.dat]]: configuration file (calculation rules) for the program ''[[ENERF]]''
* [[EVENTFILTER.DAT|eventfilter.dat]]: general input data for the program ''[[EVENTFILTER]]''
* [[EVENTSTATISTIC.DAT and EVENTSTATISTIC.EXCEL|eventstatistic.dat/.excel]]: statistics of high water and low water
* [[EXCEL.DAT|excel.dat]]: contains data to be used in the ''EXCEL'' spread sheet program
* [[EXCELENZ.DAT|excelenz.dat]]: general input data for the program ''excelenz''
----
* [[FDGITTER05.DAT|fdgitter05.dat]]: names of input files for program ''[[FDGITTER05]]''
* [[FDGLUE.DAT|fdglue.dat]]: general input data for program ''[[FDGLUE]]''
* [[FD2ADDTOPO.DAT|fd2addtopo.dat]]: general input data for program ''[[FD2ADDTOPO]]''
* [[FD2BASIS.DAT|fd2basis.dat]]: general input data for program ''[[FD2BASIS]]''
* [[FD2DEL.DAT|fd2del.dat]]: general input data for program ''[[FD2DEL]]''
* [[FD2HYPSO.DAT|fd2hypso.dat]]: general input data for program ''[[FD2HYPSO]]''
* [[FD2MET.DAT|fd2met.dat]]: general input data for program ''[[FD2MET]]''
* [[FD2MOD.DAT|fd2mod.dat]]: general input data for program ''[[FD2MOD]]''
* [[FD2TRIM.DAT|fd2trim.dat]]: contains general input data ''[[FD2TRIM]]''
* [[FD-MATRIX.BIN|fd-matrix.bin]]: matrix to change depth values of a finite difference topography
* [[FD2BAGGER.CELLSAVE|fd2bagger.cellsave]]: indices of protected finite difference cells
* [[FD2BAGGER.FLUSSKM|fd2bagger.flusskm]]: kilometer marks of a fairway
* [[FD2BAGGER.POLY|fd2bagger.poly]]: coordinates of a fairway polygon
* [[FD2BAGGER.REFLIST|fd2bagger.reflist]]: reference list with minimum depth values along a fairway
* [[FD2BAGGER.RIFFEL|fd2bagger.riffel]]: beginning and end kilometer marks for ripple structures along a fairway
* [[FD2KACHEL.DAT|fd2kachel.dat]]: general input data for program ''[[FD2KACHEL]]''
* [[FD2RIBA.DAT|fd2riba.dat]]: general input data for program ''[[FD2RIBA]]''
* [[FD2RND.DAT|fd2rnd.dat]]: description of the boundary grid cells for ''[[TR2RND]]''
* [[FD2SPUELER.DAT|fd2spueler.dat]]: general input data for program ''[[FD2SPUELER]]''
* [[FFTEIN.DAT|fftein.dat]]: general input data for the program ''FFT''
* [[FKEZ.BIN|fkez.bin]]: neighbour-elements of elements (TICAD-format)
* [[FKVZ.BIN|fkvz.bin]]: edge connexions of elements (TICAD-format)
* [[FRAMES.DAT|frames.dat]]: frames for graphic programs
* [[FRQ2ZEITR.DAT|frq2zeitr.dat]]: general input data for program ''FRQ2[[ZEITR]]''
* [[FRQSINGLE.DAT and FRQSINGLE.TEX|frqsingle.dat/tex]]: file with error parameters of harmonic analysis
* [[FRQWF.DAT|frqwf.dat]]: general input data for the program ''[[FRQWF]]''
* [[FRQTIE.DAT|frqtie.dat]]: general input data for the program ''[[FRQTIE]]''
----
* [[GEO|geo]]: optimized finite element grid for ''[[TELEMAC-2D]]''
* [[GEOM.DAT|geom.dat]]: bearing data
* [[GEOMFD2.DAT|geomfd2.dat]]: general input data for program ''[[GEOMFD2]]''
* [[GEOPOS.DAT|geopos.dat]]: file for description of geopositions, extendable with tidal amplitudes
* [[GITTER05.DAT and GITTER05.BIN|gitter05.dat/bin]]: two-dimensional finite element grid (TICAD-format)
* [[GKPUNKT.DAT|gkpunkt.dat]]: list of point attributes
* [[GPROFIL.DAT|gprofil.dat]]: geo position descriptions of a longitudinal or cross sectional profile
* [[GROYNES.DAT|groynes.dat]]: groyne data
* [[GVIEW2D.DAT|gview2d.dat]]: general input data for program ''[[GVIEW2D]]''
----
* [[HRPI-MF.DAT|hrpi-mf.dat]]: Master file of program ''[[TR2APP]]'' with information about secondary reference points
* [[HVIEW2D.DAT|hview2d.dat]]: general input data for program ''[[HVIEW2D]]''
* [[HY-TAB.DAT|hy-tab.dat]]: Table of a frequency distribution of depth values of a finite difference bathymetry
----
* [[IGEL2D.DAT|igel2d.dat]]: general input data for the program ''[[IGEL2D]]''
* [[INSEL.DAT|insel.dat]]: digitalized structures (groynes, islands, etc.)
* [[IO_VOLUME.DAT|io_volume.dat]]: general input data for the program ''IO_VOLUME''
* [[IPDS.DAT|ipds.dat]]: initial values of physical datasets (e.g. to define start conditions)
* [[ISOERG.DAT|isoerg.dat]]: informations for plotting additional isolines in various graphical programs
----
* [[K_MODEL.DAT|k_model.dat]]: specific input data related to the ''k-[[model]]'' package
* [[KACHEL2D.DAT|kachel2d.dat]]: general input data for the program ''[[KACHEL2D]]''
* [[KENNUNGEN.DAT|kennungen.dat]]: file with a list of keys of tidal constituents or geopositions
* [[KMATTR.DAT|kmattr.dat]]: physical data related to a river chainage
* [[KNOERG.BIN|knoerg.bin]]: calculated results at choosen positions
* [[KNOK.GITTER05.DAT und KNOK.GITTER05.BIN|knok.gitter05.dat/bin]]: nodal markers for a finite element grid (TICAD-format)
* [[KUEDAT.DAT|kuedat.dat]]: bearing data file of format ''KUEDAT'' containing bearing points and lines
----
* [[LQ2ATTR.DAT|lq2attr.dat]]: user defined plot attributes for program ''[[LQ2PRO]]''
* [[LQ2PRO.DAT|lq2pro.dat]]: general input data for the program ''[[LQ2PRO]]''
* [[LZKAF.DAT|lzkaf.dat]]: general input data for the program ''[[LZKAF]]''
* [[LZKMF.DAT|lzkmf.dat]]: general input data for the program ''[[LZKMF]]''
* [[LZKSF.DAT|lzksf.dat]]: general input data for the program ''[[LZKSF]]''
* [[LZKVF.DAT|lzkvf.dat]]: general input data for the program ''[[LZKVF]]''
* [[LZKWF.DAT|lzkwf.dat]]: general input data for the program ''[[LZKWF]]''
* [[LAYOUT.DAT|layout.dat]]: plot-layout for GKS-programs
* [[LIGHTS.DAT|lights.dat]]: file for color scale information for programs ''[[FDGITTER05]], [[HVIEW2D]]''
* [[LOCATION.DAT|location.dat]]: list of files with descriptions of ''specific locations''
* [[LOCATION_GRID.DAT|location_grid.dat]]: system file with data for an arbitrary number of ''specific locations''
----
* [[MEDIANGLAETTUNG.DAT|medianglaettung.dat]]: input control data for the program ''[[MEDIANGLAETTUNG]]''
* [[METDIDA.DAT|metdida.dat]]: general input data for the program ''[[METDIDA]]''
* [[METDIDA.CFG.DAT|metdida.cfg.dat]]: configuration file for the program ''[[METDIDA]]''
* [[MIX_UNTRIM.DAT|mix_untrim.dat]]: configuration file for the package ''MIX''
* [[MKRDAT.DAT|mkrdat.dat]]: general input data for the program ''[[MKRDAT]]''
* [[MKWSWAWRT.DAT|mkwswawrt.dat]]: contains meteorological data and is read by the program ''[[FD2MET]]'' .
----
* [[NCAGGREGATE.DAT|ncaggregate.dat]]: general input data for the program ''[[NCAGGREGATE]]''
* [[NCANALYSE.DAT|ncanalyse.dat]]: general input data for the program ''[[NCANALYSE]]''
* [[NCDELTA.DAT|ncdelta.dat]]: general input data for the program ''[[NCDELTA]]''
* [[NCDVAR.DAT|ncdvar.dat]]: general input data for the program ''[[NCDVAR]]''
* [[NCPLOT.DAT|ncplot.dat]]: general input data for the program ''[[NCPLOT]]''
* [[NC_META.DAT|nc_meta.dat]]: user specific global metadata for CF [[NetCDF]] files
* [[NC2TABLE.CSV|nc2table.csv]]: result file (tabular data) from program [[NC2TABLE]]
* [[NC2TABLE.DAT|nc2table.dat]]: general input data for the program [[NC2TABLE]]
* [[NEIGH.DAT|neigh.dat]]: TRIGRID list of neighbours
* [[NETCDF.CDF|netcdf.cdf]]: NetCDF file format
* [[NODES.SAVE|nodes.save]]: polygons for protection of depth values at nodal points
----
* [[OP_WEIR.DAT|op_weir.dat]]: input data to control [[UNTRIM2]] weir sections depending on model results at runtime
* [[OUTASCII.DAT|outascii.dat]]: computational results from ''[[TRIM-2D]]'' converted into ASCII format
* [[OUTHVIEW2D.DAT|outhview2d.dat]]: data displayed by ''HVIEW2D'' converted into ASCII format
----
* [[PAI-MF.DAT|pai-mf.dat]]: Master file of program ''TR2APP'' with information about run of program
* [[PALETTES.CFG.DAT|palettes.cfg.dat]]: list of pallet definitions for the program ''NCPLOT''
* [[PARTRACE.DAT|partrace.dat]]: general input data for the program ''[[PARTRACE]]''
* [[PDI-MF.DAT|pdi-mf.dat]]: Master file of program ''TR2APP'' with information about physical data
* [[PGCALC.DAT|pgcalc.dat]]: general input-data for program ''[[PGCALC]]''
* [[PLOTTS.DAT|plotts.dat]]: general input-data for program ''[[PLOTTS]]"
* [[PLTSUB_GRID.UPI|pltsub_grid.upi]]: grid file for plotting purposes of the numerical model ''UnTRIM2''
* [[POLY|poly]]: planar straight line graph (TRIANGLE-format)
* [[POLY.DAT|poly.dat]]: surrounding polygon
* [[PRF.ANALYSE.DAT|prf.analyse.dat]]: results of a profile analysis
* [[PROF.BIN|prof.bin]]: one-dimensional segment grid
* [[PROFIL05.BIN|profil05.bin]]: file with profile bathymetries
* [[PROFILES3D.DAT|profiles3d.dat]]: definition of profiles
----
* [[RSMERGE.DAT|rsmerge.dat]]: general input data for the program ''RsMerge''
* [[RAND.DAT|rand.dat]]: coordinates of a borderline
* [[RELAX.DAT|relax.dat]]: solver options and solver accuracy
* [[RGZ.DAT|rgz.dat]]: description of boundary grid cells
* [[RNDWERTE.DAT|rndwerte.dat]]: boundary values for numerical models
* [[ROSE.DAT|rose.dat]]: general input data for the program ''[[ROSE]]''
----
* [[SEDIMORPH.DAT|sedimorph.dat]]: user specified steering data for the morphodynamic computational module ''SediMorph''
* [[SELAFIN|selafin]]: results file of ''TELEMAC-2D''
* [[SOIL.DAT|soil.dat]]: description of soil types
* [[SOLWRT.DAT|solwrt.dat]]: contains time-series data for a single location, please do not use any longer
* [[SPEK.OUT|spek.out]]: one-dimensional wave spectra, computed by program ''[[WESPE]]''
* [[SV.DAT|sv.dat]]: input data for software package SV (various settling velocity models)
* [[SYNGRID.DAT|syngrid.dat]]: general input data for the program ''[[SYNGRID]]''
----
* [[TDKLF.DAT|tdklf.dat]]: general input data for the program ''[[TDKLF]]''
* [[TDKSF.DAT|tdksf.dat]]: general input data for the program ''[[TDKSF]]''
* [[TDKVF.DAT|tdkvf.dat]]: general input data for the program ''[[TDKVF]]''
* [[TDKWF.DAT|tdkwf.dat]]: general input data for the program ''[[TDKWF]]''
* [[TC2BAGGER.DAT|tc2bagger.dat]]: general input data for the program ''[[TC2BAGGER]]''
* [[TC2GEOM.DAT|tc2geom.dat]]: general input data for the program ''[[TC2GEOM]]''
* [[TC2TR2.DAT|tc2tr2.dat]]: general input data for the program ''[[TC2TR2]]''
* [[TDKNEU.DAT|tdkneu.dat]]: general input data for the program ''[[TIDKEN]]''
* [[TDKTIE.DAT|tdktie.dat]]: general input data for the program ''[[TDKTIE]]''
* [[TECPLOT|tecplot]]: standard input data for the visualization software ''[[TECPLOT]]''
* [[TELEMAC2D.CAS|telemac2d.cas]]: general input data for the program ''TELEMAC-2D''
* [[TELEMAC.DAT|telemac.dat]]: additional baw-specific input data for the programs ''TELEMAC-2D'' and ''TELEMAC-3D''
* [[TELEMAC2D.PRINCI.F|telemac2d.princi.f]]: FORTRAN main program for ''TELEMAC-2D''
* [[TEO.DAT|teo.dat]]: general input data for the program ''TEO''
* [[TEOAX.DAT|teoax.dat]]: general input data for the program ''[[TEOAX]]''
* [[TICLQ2.DAT|ticlq2.dat]]: general input data for the program ''[[TICLQ2]]''
* [[TICTRI.DAT|tictri.dat]]: general input data for the program ''[[TICTRI]]''
* [[TIDECLOCK.DAT|tideclock.dat]]: informations for plotting in tide clock in various graphical programs
* [[TIDEGRUNDDATEN.DAT|tidegrunddaten.dat]]: file containing basic information on the tidal constituents
* [[TI-MF.DAT|ti-mf.dat]]: Master file of program ''TR2APP'' with information about areas of interest
* [[TIMESHIFT.DAT|timeshift.dat]]: general input data for the program ''[[TIMESHIFT]]''
* [[TMA|tma]]: TMA-spectrum, computed by program ''[[WESPE]]''
* [[TM2DIDA.DAT|tm2dida.dat]]: general input data for the program ''[[TM2DIDA]]''
* [[TM2.RBH.BIN|tm2.rbh.bin]]: hydrodynamic boundary values for ''TELEMAC-2D''
* [[TM2.RBH.BIN.I|tm2.rbh.bin.i]]: informations on hydrodynamic boundary values for ''TELEMAC-2D''
* [[TM2.RBS.BIN|tm2.rbs.bin]]: salinity boundary values for ''TELEMAC-2D''
* [[TM2.RBS.BIN.I|tm2.rbs.bin.i]]: informations on salinity boundary values for ''TELEMAC-2D''
* [[TM2RND.DAT|tm2rnd.dat]]: general input data for the program ''[[TM2RND]]''
* [[TOPO.BIN|topo.bin]]: finite difference topography with depth values for all cells
* [[TOPVF.DAT|topvf.dat]]: general input data for the program ''[[TOPVF]]''
* [[TOUTR.DAT|toutr.dat]]: general input data for the program ''toUtr''
* [[TPROFIL.DAT|tprofil.dat]]: depth profile
* [[TR2FIDI.DAT|tr2fidi.dat]]: general input data for the program ''[[TR2FIDI]]''
* [[TR2LQ2.DAT|tr2lq2.dat]]: general input data for the program ''[[TR2LQ2]]''
* [[TR2.RESULT|tr2.result]]: results files of ''[[Trim|TRIM]]-2D''
* [[TRIM2D.DAT|trim2d.dat]]: general input data for the program ''[[TRIM-2D]]''
* [[TRIM2D.BED.DAT|trim2d.bed.dat]]: general input data for bed load transport for the programs ''TRIM-2D'' and ''[[TRIM-3D]]''
* [[TRIM3D.DAT|trim3d.dat]]: general input data for the program ''[[TRIM-3D]]''
* [[TR2.RBH.BIN|tr2.rbh.bin]]: hydrodynamic boundary values for ''TRIM-2D'' and ''TRIM-3D''
* [[TR2.RBH.BIN.I|tr2.rbh.bin.i]]: informations on hydrodynamic boundary values for ''TRIM-2D'' and ''TRIM-3D''
* [[TR2.RBS.BIN|tr2.rbs.bin]]: salinity boundary values for ''TRIM-2D'' and ''TRIM-3D''
* [[TR2.RBS.BIN.I|tr2.rbs.bin.i]]: informations on salinity boundary values for ''TRIM-2D'' and ''TRIM-3D''
* [[TR2.RBC.BIN|tr2.rbc.bin]]: suspended sediment boundary values for ''TRIM-2D'' and ''TRIM-3D''
* [[TR2.RBC.BIN.I|tr2.rbc.bin.i]]: informations on suspended sediment boundary values for ''TRIM-2D'' and ''TRIM-3D''
* [[TR2.RBW.BIN|tr2.rbw.bin]]: control structure boundary values for ''TRIM-2D'' and ''TRIM-3D''
* [[TR2.RBW.BIN.I|tr2.rbw.bin.i]]: informations on control structure boundary values for ''TRIM-2D'' and ''TRIM-3D''
* [[TR2.MET.BIN|tr2.met.bin]]: meteorological boundary values for ''TRIM-2D'', ''TRIM-3D'' and ''TELEMAC-2D''
* [[TR2.MET.BIN.I|tr2.met.bin.i]]: informations on meteorological boundary values for ''TRIM-2D'', ''TRIM-3D'' and ''TELEMAC-2D''
* [[TR2.SOIL.BIN.IND|tr2.soil.bin.ind]]: distribution of soil types for ''TRIM-2D''
* [[TR2.TOPO.BIN|tr2.topo.bin]]: bathymetry ''TRIM-2D''
* [[TR2.TOPO.BIN.IND|tr2.topo.bin.ind]]: bathymetry and index arrays for ''TRIM-2D'' and ''TRIM-3D''
* [[TR2.TOPO.BIN.I3D|tr2.topo.bin.i3d]]: 3D index arrays generated by ''TRIM-3D''
* [[TR2ASCII.DAT|tr2ascii.dat]]: general input data for the program ''[[TR2ASCII]]''
* [[TR2DIDA.DAT|tr2dida.dat]]: general input data for the program ''[[TR2DIDA]]''
* [[TR2GEOM.DAT|tr2geom.dat]]: general input data for the program ''[[TR2GEOM]]''
* [[TR2KACHEL.DAT|tr2kachel.dat]]: general input data for the program ''[[TR2KACHEL]]''
* [[TR2MODATE.DAT|tr2modate.dat]]: general input data for the program ''[[TR2MODATE]]''
* [[TR2REFRESH.DAT|tr2refresh.dat]]: general input data for the program ''[[TR2REFRESH]]''
* [[TR2VOR.DAT|tr2vor.dat]]: general input data for the program ''[[TR2VOR]]''
* [[TR3.RESULT|tr3.result]]: results files of ''TRIM-3D''
* [[TR3DIDA.DAT|tr3dida.dat]]: general input data for the program ''[[TR3DIDA]]''
* [[TR3KACHEL.DAT|tr3kachel.dat]]: general input data for the program ''[[TR3KACHEL]]''
* [[TR3MODATE.DAT|tr3modate.dat]]: general input data for the program ''[[TR3MODATE]]''
* [[TRASSE.DAT|trasse.dat]]: general input data for the program ''[[TRASSE]]''
* [[TRGITTER05.DAT|trgitter05.dat]]: general input data for the program ''[[TRGITTER05]]''
* [[TRIANG.DAT|triang.dat]]: TRIGRID list of nodal point connexions
* [[TRVZR.DAT|trvzr.dat]]: general input data for the program ''[[TRVZR]]''
* [[TR_H.DELTA.DAT|tr_h.delta.dat]]: difference results of an analysis of Trim area result files
* [[TR_H.ERGEB.DAT|tr_h.ergeb.dat]]: results of an analysis of Trim area result files
* [[TR_H.INFO.DAT|tr_h.info.dat]]: information about an analysis of Trim area result files
* [[TSCALC.DAT|tscalc.dat]]: general input data for the program ''[[TSCALC]]''
* [[TTASF.ASF|ttasf.asf]]: amplitude and phase (ascii) data for different tidal constituents at different locations
* [[TTBPT.BPT|ttbpt.bpt]]: linked data for different physical data at various locations
* [[TXI-MF.DAT|txi-mf.dat]]: Master file of program ''TR2APP'' with text information
----
* [[UCD|ucd]]: standard input format for ''AVS/Express'' and other visualization software
* [[UNIGRID.DAT and UNIGRID.BIN|unigrid.dat/.bin]]: grid file of format ''Unigrid''
* [[UNK.DAT|unk.dat]]: general input data for the postprocessor ''UNK''
* [[UNS.DAT|uns.dat]]: general input data for the postprocessor ''UNS''
* [[UNTRIM_GRID.DAT|untrim_grid.dat]]: grid file for the numerical model ''Untrim''
* [[UNTRIM2.DAT|untrim2.dat]]: master input file for the mathematical model ''UnTRIM2'', with sub grid technology
* [[UNTRIM_2007.DAT|untrim2007.dat]]: master input file for the mathematical model ''UnTRIM2007''
* [[UNTRIM_MAIN.DAT|untrim_main.dat]]: main input data file for the numerical model ''UnTRIM''
* [[UPDA2D.DAT|upda2d.dat]]: general input data for the program ''[[UPDA2D]]''
* [[UTRPRE.DAT|utrpre.dat]]: general input data for the program ''[[UTRPRE]]''
* [[UTRRND.DAT|utrrnd.dat]]: general input data for the program ''[[UTRRND]]''
* [[UTRSUB_GRID.DAT|utrsub_grid.dat]]: grid file for the numerical model ''UnTRIM2''
----
* [[VERTICAL.DAT|vertical.dat]]: contains details with respect to the description of a vertical grid structure
* [[VI-MF.DAT|vi-mf.dat]]: Master file of program ''TR2APP'' with information about structure of directories
* [[VOLUMETH.DAT|volumeth.dat]]: general input data for the program ''[[VOLUMETH]]''
* [[VOLUMETH.PLT|volumeth.plt]]: Program flow control parametrs for an automatical result graphic generation for volume calculations with the daemon ''[[VOLUMETHAUTO]]''
* [[VOLSUM.DAT and VOLSUM.EXCEL.DAT|volsum.dat/volsum.excel.dat]]: area distribution and volum sum function of a region
* [[VTDK.DAT|vtdk.dat]]: general input data for the program ''[[VTDK]]''
* [[VVIEW2D.DAT|vview2d.dat]]: general input data for program ''[[VVIEW2D]]''
----
* [[WAQ-files]]: sveral files for offline coupling with DelWAQ (D-Water Quality - [http://www.deltaressystems.com/hydro/product/621497/delft3d-suite Delft3D Suite])
* [[WARM.DAT|warm.dat]]: general input data for program ''[[WARM]]''
----
* [[XTRDATA.DAT|xtrdata.dat]]: general input data for the program ''[[XTRDATA]]''
* [[XTRLQ2.DAT|xtrlq2.dat]]: general input data for the program ''[[XTRLQ2]]''
* [[XMGR.DAT|xmgr.dat]]: contains data for the XY plotting program ''ACE/gr''
----
* [[ZEITR.DAT|zeitr.dat]]: general input data for the program ''[[ZEITR]]''
* [[ZEILE.TIDKEN.DAT|zeile.tidken.dat]]: analysis results of the program ''[[TIDKEN]]''
* [[ZEITPUNKTE.DAT|zeitpunkte.dat]]: self defined points of time (different formats available)
* [[ZEITRIO.DAT|zeitrio.dat]]: optional input data for the program ''[[ZEITRIO]]''
* [[ZI-MF.DAT|zi-mf.dat]]: Master file of program ''TR2APP'' with information about time values
* [[ZPROFIL.DAT|zprofil.dat]]: contains depth dependent data
* [[ZWISCHENPUNKTE.DAT|zwischenpunkte.dat]]: input control data for the progam ''[[ZWISCHENPUNKTE]]''

----
back to [[BAW-Software Documentation]]
----
[[Overview]]

IPDS.DAT

2021-02-19T07:37:12Z

Ak3jjuer: adjust allowed values for additional roughness

{{FileDescription
|name_de=IPDS.DAT
|filetype=ipds.dat
|version=1.4
|version_descr=February 2021
|significance=A file of type ipds.dat contains '''i'''nitial values of '''p'''hysical '''d'''ata'''s'''ets
The possibilities using this file (e.g. to define start conditions) may illustrate these [[IPDS.DAT:Interpolation examples|examples]].
All improvements coming with Version 1.4 are marked as follows: New in V1.4
|filecontents=
# Block date_and_time
#* date and time specification
#* exactly one specification allowed
#* the following formats are implemented:
#:* DD.MM.YYYY-hh:mm:ss
#:* DD.MM.YYYY-hh:mm:ss.nnnnnnnnn
#:* DD.MM.YYYY-hh:mm:ss.nnnnnnnnn-ZONE
#* legend:
#:* DD = day of month (two digits 01-31)
#:* MM = month of year (two digits 01-12)
#:* YYYY = year (four digits)
#:* hh = hour of day (two digits 00-23)
#:* mm = minute of hour (two digits 00-59)
#:* ss = second of minute (two digits 00-59)
#:* nnnnnnnnn = nanoseconds (nine digits)
#:* ZONE = time zone (UTC/MEZ/MESZ/+3H/..)
#* key line: '''datetime = DD.MM.YYYY-hh:mm:ss.nnnnnnnnn-ZONE'''
# Block '''global_constant_values'''
#* definition of physical constant values in the whole area (default values)
#* exactly one '''global_constant_values''' block allowed
#* these default values can be overwritten by regional valid values via the regional_values) blocks
#* implemented physical values:
#:* water level
#::* key line: '''waterlevel = ..value..'''
#::* exactly one specification allowed
#:* salinity
#::* key line: '''salinity = ..value..'''
#::* exactly one specification allowed
#:* temperature
#::* key line: '''temperature = ..value..'''
#::* exactly one specification allowed
#:* sediment fractions and porosity
#::* key line for one sediment fraction: '''sediment_fraction = ..sediment_name.. ..fraction..'''
#::* use as many sediment fraction key lines as necessary
#::* key line for porosity: '''porosity = ..fraction..'''
#::* exactly one specification allowed for porosity
#::* all used sediment names must be identical to the names defined in the sediment classification file (type [[SOIL.DAT|soil.dat]])
#::* the sum of all sediment fractions must be 1
#:* ripple wave number
#::* the wave number k defines both direction and wavelength (λ) of a ripple structure (k = 2 π / λ)
#::* defining the wave number by giving its x- und y-component values
#::* key line: '''ripple_wavenumber = ..x-component.. ..y-component..'''
#::* exactly one specification allowed
#:* ripple height
#::* key line: '''ripple_height = ..value..'''
#::* exactly one specification allowed
#:* dune wave number
#::* the wave number k defines both direction and wavelength (λ) of a dune structure (k = 2 π / λ)
#::* defining the wave number by giving its x- und y-component values
#::* key line:'''dune_wavenumber = ..x-component.. ..y-component..'''
#::* exactly one specification allowed
#:* dune height
#::* key line: '''dune_height = ..value..'''
#::* exactly one specification allowed
#:* depth of the unerodable layer
#::* implemented are two ways ("absolute" and "relative") of giving the depth of the unerodable layer
#::* absolute depth is necessary if the unerodable layer lies in a geodetic (absolute) depth
#::* relative depth means the unerodable layer lies in a depth relative to the bottom of the water body (negative values represents values below the bottom of the water body)
#::* key line:'''<nowiki> rigid_layer_depth = relative|absolute ..value..</nowiki>'''
#::* exactly one specification allowed
#:* roughness of the unerodable layer
#::* the roughness of the unerodable layer is important if there are no sediments left at the bottom of the water body
#::* two specifications are necessary to define the roughness of the unerodable layer
#:::* specification of the used bed shear stress formula (at this time only the effective bed roughness according to nikuradse is implemented)
#:::* specification of the roughness coefficient
#::* key line: '''rigid_layer_roughness = nikuradse ..value..'''
#:* control volume number
#::* key line: '''control_volume_number = ..value..'''
#:* additional roughness
#::* key line: '''additional_roughness = nikuradse ..value..'''
#::* the roughness value must be greater or equal -1 and less than 1
#:* concentration of suspended load
#::* key line: '''suspendedload = ..sediment_name.. ..value..'''
#::* use as many concentration of suspended load key lines as necessary
#:* z0 roughness length
#::* key line: '''z0_roughnesslength = ..value..'''
#::* the roughness value must be greater or equal 0 and less than 10
#:* chezy bottom friction coefficient
#::* key line: '''bottom_friction_chezy = ..chezy-value..'''
#::* the roughness value must be greater or equal 0 and less than 1000
#:* manning bottom friction coefficient
#::* key line: '''bottom_friction_manning_str = ..manning-value..'''
#::* the roughness value must be greater or equal 0 and less than 1000
#:* nikuradse bottom friction coefficient
#::* key line: '''bottom_friction_nikuradse = ..nikuradse-value..'''
#::* the roughness value must be greater or equal 0 and less than 1
#:* white colebrook bottom friction coefficient
#::* key line: '''bottom_friction_white_colebr = ..white-colebrook-value..'''
#::* the roughness value must be greater or equal 0 and less than 1
#:* taylor bottom friction coefficient
#::* key line: '''bottom_friction_taylor = ..taylor-value..'''
#::* the roughness value must be greater or equal 0 and less than 0.1
#:* time dependent bathymetry
#::* key line: '''time_dependent_bathymetry = ..value..'''
#::* the bathymetry value must be greater or equal -99 and less than +99
#:* critical stress for deposition
#::* key line: '''critical_stress_for_deposition = ..value..'''
#::* the critical stress value must be greater or equal 0 and less than 99
#:* critical stress for erosion
#::* key line: '''critical_stress_for_erosion = ..value..'''
#::* the critical stress value must be greater or equal 0 and less than 99
#:* erodibility parameter
#::* key line: '''erodibility_parameter = ..value..'''
#::* the erodibility value must be greater or equal 0 and less than 100
#:* sediment mass
#::* key line: '''sediment_mass = ..value..'''
#::* the sediment mass value must be greater or equal 0 and less than 1 Million
#:* current velocity in x direction
#::* key line: '''current_velocity_(x-dir.) = ..value..'''
#::* the velocity value must be greater or equal -10 and less or equal +10
#:* current velocity in y direction
#::* key line: '''current_velocity_(y-dir.) = ..value..'''
#::* the velocity value must be greater or equal -10 and less or equal +10
#:* deposition rate
#::* key line: '''deposition_rate = ..sediment_name.. ..value..'''
#::* use as many deposition rate key lines as necessary
#:* mean wave period
#::* key line: '''mean_wave_period = ..value..'''
#::* the wave period value must be greater than 0 and less or equal 100
#:* significant wave height
#::* key line: '''significant_wave_height = ..value..'''
#::* the wave height value must be greater or equal 0 and less or equal 15
#:* mean wave direction x component
#::* key line: '''mean_wave_direction_(x-dir.) = ..value..'''
#::* the direction value must be greater or equal -10 and less or equal +10
#:* mean wave direction y component
#::* key line: '''mean_wave_direction_(y-dir.) = ..value..'''
#::* the direction value must be greater or equal -10 and less or equal +10
#:* artificial porosity
#::* key line: '''artificial_porosity = ..value..'''
#::* the porosity value must be greater or equal 0 and less or equal 1
#:* hydrodynamic pressure
#::* key line: '''hydrodynamic_pressure = ..value..'''
#::* the pressure value must be greater or equal -0.1 and less or equal +0.1
#:* tracer fraction
#::* key line: '''tracer_fraction = ..tracer_name.. ..value..'''
#::* use as many tracer key lines as necessary
#:* turbulent kinetic energy
#::* key line: '''turbulent_kinetic_energy = ..value..'''
#::* the energy value must be greater or equal 0 and less or equal 10
#:* generic length scale
#::* key line: '''generic_length_scale = ..value..'''
#::* the length scale value must be greater or equal 0 and less or equal 10
# Block '''region'''
#* definition of regions
#* the maximum number of regions is unlimited
#* at least one region is necessary to define regional differing physical values
#* it is allowed to use no regions
#* each region needs a name:
#:* this name will be used as an identification key
#:* notice case sensitivity
#:* key line: '''region_name = ..name..'''
#* description of the border polygon
#:* the border polygon need at least three border points
#:* the maximum number of border points is unlimited
#:* the border polygon will be closed automatically
#:* key line for one border point: '''border_point = ..x-coordinate.. ..y-coordinate..'''
# Block '''sampling_point'''
#* definition of positions related to measured data
#* the maximum number of positions is unlimited
#* at least one position is necessary to define regional differing physical values
#* it is allowed to use no positions
#* each position needs a name:
#:* this name will be used as an identification key
#:* notice case sensitivity
#:* key line: '''sampling_point_name = ..name..'''
#* position specification
#:* specification of x- and y-coordinate
#:* only one position specification is allowed
#:* key line: '''sampling_point_xy = ..x-coordinate.. ..y-coordinate..'''
#* definition of physical values valid at the position
#:* it is allowed to use the same physical values as described in the global_constant_values block
# Block '''regional_values'''
#* definition of regional differing physical values
#* specification of regions with physical values related to positions
#* in the space between the positions the physical values will be interpolated
#* the maximum number of these blocks is unlimited
#* it is allowed to use no '''regional_values''' block (the physical constant values for the whole area will not change)
#* sorting the regional_values blocks so that the block with the lowest priority will come first (this is important only if the regions overlap)
#* specification of the region
#:* key line: '''<nowiki>region = inside|outside ..name..</nowiki>'''
#:* the name of the region must match with the region identification key defined in one of the region blocks
#:* with the "inside" or "outside" key word it is possible to define the region of interest inside or outside the region border polygon
#* specification of the geodetic layer
#:* key lines: '''lower_validity_level = ..lower_limit..''' '''upper_validity_level = ..upper_limit..'''
#:* both specifications are not necessary
#* specification of positions
#:* the maximum number of positions is only limited to the maximum number of defined sampling_point blocks
#:* at least one position is necessary
#:* in the presence of only one position the physical values are constant over the whole region of interest
#:* the names of all positions must match with the position identification keys defined in the sampling_point blocks
#:* key line: '''sampling_point = ..name..'''
#* specification of a maximum distance between positions and a given point P. Only positions inside a distance radius around P are used for interpolation.
#:* only one specification allowed
#:* the value for maximum distance must be greater zero
#:* key line: '''sampling_point_maxdist = ..maximum_distance_to_positions..'''
#:* the key line ist not necessary. if maximum distance ist not specified, the default value ('''40.E6''') will be used. so it is ensured that older IPDS files (version 1.1) will produce the same result as before.
#:* The following pictures will document the influence of the maximum distance: Visualized in all pictures is the computed distribution of fine sand (.063-.177 mm grain diameter) for the mouth of the ems river. the computation started with 1382 measurement positions from the [http://www.rijkswaterstaat.nl/over_ons/adressen_en_diensten/landelijkediensten/waterdienst/waterdienst_locatie_zuiderwagenplein.aspx Rijksinstituut voor Kust en Zee (RIKZ)] sediment atlas. The colours represents different rates of fine sand: red represents 100%, yellow 75%, green 50% and dark blue 0% rate of fine sand.
:* [[:File:Ems_maxdist300m.png|The maximum distance to the positions (300m)]] corresponds to the internal grid resolution The interpolation takes place only around positions. For all other grid points the measurement positions all too far away. The locations of the positions come clearly to sight. (642x768 Pixel, 21kB).
:* [[:File:Ems_maxdist1000m.png|The maximum distance to the positions (1000m)]] is about 3-4 times greater than the internal grid resolution The interpolation takes place in all areas where positions are not too far away The result as a first approximation is nature alike. In wide areas will be no interpolation, because of the great distance to positions. (642x768 Pixel, 30kB).
:* [[:File:Ems_maxdistdef.png|No specification of a maximum distance]] The interpolation takes place everywhere for all grid points. Far away of the positions the result will be artificial. (642x768 Pixel, 85kB).
* specification of the interpolation method
* key line: '''<nowiki>interpolation_method = nearest_points_in_sectors | linear_distance_weighting | triangular_interpolation</nowiki>'''
* The interpolation method '''nearest_points_in_sectors''' is developed at BAW and and tries to look for the nearest positions in different directions (sectors) for a point of interest. The physical values at all positions found will be averaged dependant to the square of the distance to the positions (1/d**2).
* New in V1.4 The method '''linear_distance_weighting''' works as described for '''nearest_points_in_sectors''' with one difference: The physical values will be averaged dependant to the distance to the positions (1/d).
* At first the interpolation method '''triangular_interpolation''' creates a grid of all available positions. This grid follows Delaunay-criteria and covers a convex hull around all positions. The grid generation process takes place in an external software package so called [http://members.allstream.net/~bjoe/ GEOMPACK] (author: Barry Joe) and gives back the grid via the interface '''ext_ipds_setup_mespos_tria'''.
|nutzerprogramme=[[GEOTRANSFORMER]], [[NCAGGREGATE]], [[NCCUTOUT]], [[TELEMAC-2D]] [SediMorph], [[UNS]], [[UNTRIM]] [SediMorph], [[UNTRIM2]], [[UNTRIM2007]] [SediMorph]
|language=Fortran90
|fileform=FORMATTED
|fileaccess=SEQUENTIAL
|fileextension=.dat
|writemodules=-
|readmodules=$PROGHOME/fortran/lib/io_ipds/hp/mod_io_ipds_ui.f90 
$PROGHOME/fortran/lib/io_ipds/SGI/mod_io_ipds_ui.f90
|contact_original=[mailto:jens.juerges@baw.de J. Jürges]
|contact_maintenance=[mailto:jens.juerges@baw.de J. Jürges]
|examplefile=$PROGHOME/examples/ipds/ipds.dat
}}

UPLAY

2020-03-12T09:26:34Z

Ak3jjuer: Adjustments to version 1.3 from march 2020

{{ProgramDescription
|name_de=UPLAY
|name=uplay
|version=March 2020
|version_descr=March 2020
|catchwords=
numerical simulation 
hydrodynamic 
visualization 
learning program 

|shortdescription=
UPLAY is a GUI around [[UNTRIM2]] and [[NCPLOT]]. With UPLAY the user is able to change grid depths graphically, to let compute the hydrodynamical effect of that grid depth change and to look at the results.

The change of grid depths will be done within the GUI. There are a (small) number of color classes each representing one depth value. Using UPLAY in standard manner there are 5 different color classes: "blue" representing 10 m below sea surface, "light blue" (-5m), "green" (-2m), "orange" (0m) and "red" representing 2 m above sea surface. The user activates one color class and clicks on grid elements to change the depth of that element to the color representing value.

[[File:UPLAY1.png|thumb|250px|Image 1: Front end of UPLAY after the user changed the grid depth values of the "sandbox model" and computing and presenting the image of the computational results of the current velocities]]

To compute the hydrodynamic effect UPLAY does the following in the background after the user started a simulation by clicking the right button:
# Writing current grid files (format [[UTRSUB_GRID.DAT|utrsub_grid.dat]] and [[PLTSUB_GRID.UPI|pltsub_grid.upi]])
# Provide input files for [[UNTRIM2]] and execute an [[UNTRIM2]] simulation
# Provide input files for NCPLOT and create images containing the computational results (current velocity and water level) for one specific moment in time

The vector gaphics created by NCPLOT will be converted by UPLAY to the pixel format [https://en.wikipedia.org/wiki/BMP_file_format BMP] and presented to the user.

|inputfiles=
UPLAY is started by default without any input files. In this case UPLAY gets his input files from this directory: <tt>$PROGHOME/shellscripts/uplay/sandbox/</tt>. However, the user can prepare his own folder with input files if he does not want to use the "sandbox model". In this case the user has to provide the following files in his own folder and has to hand over the name of the folder by using the option <tt>-userdir <name_userdir></tt>:
* input files for UPLAY:
** '''uplay.dat''': input steering file for UPLAY. It controls in particular the layout of UPLAY
** '''grid files''' (format [[UTRSUB_GRID.DAT|utrsub_grid.dat]] and [[PLTSUB_GRID.UPI|pltsub_grid.upi]]): Position of grid edges and depth of subgrid edges and elements. Please note that in the current version of UPLAY every grid edge and element consists of only one subgrid edge and element.
* input files for [[UNTRIM2]]:
** '''[[UNTRIM2.DAT|untrim2009.dat]]''': input steering file for [[UNTRIM2]]. A coupling together with the K-Model or with Sedimorph or with the settling velocity package SV is not supported by UPLAY.
** '''utromp2009.dat''': input steering file of the hydrodynamic package UTROMP_2009. The description of initial and boundary values has to be simple: boundary input files are not supported as well as initial files.
** '''[[UNTRIM_EQS.DAT|eqs.dat]]''': input steering file of the density package EQS
** '''[[VERTICAL.DAT|vertical.dat]]''': input steering file describing the vertical resolution
** '''run_untrim2009_user.sh''': UNIX-shellscript to launch an [[UNTRIM2]] simulation run
* input files to create images of the computational results:
** '''[[NC2TABLE.DAT|nc2table.dat]]''': input steering file for [[NC2TABLE]]. [[NC2TABLE]] has to write the computational results to an ASCII file to compute the actual range of values.
** '''run_nc2table_user.sh''': UNIX-shellscript to launch an [[NC2TABLE]] run
** '''[[NCPLOT.DAT|ncplot_velo.dat]]''': input steering file for [[NCPLOT]] to create an image of the current velocities
** '''run_ncplot_velo_user.sh''': UNIX-shellscript to launch an [[NCPLOT]] run to create an image of the current velocities at the end of the simulation. In this shellscript the conversion from vector to bitmap image is included. Note that this conversion has to be adjusted to the location and size of the printing.
** '''[[NCPLOT.DAT|ncplot_wlev.dat]]''': input steering file for [[NCPLOT]] to create an image of the waterlevels
** '''run_ncplot_wlev_user.sh''': UNIX-shellscript to launch an [[NCPLOT]] run to create an image of the waterlevels at the end of the simulation. In this shellscript the conversion from vector to bitmap image is included. Note that this conversion has to be adjusted to the location and size of the printing.
** '''[[NCPLOT.DAT|ncplot_wlev_zg.dat]]''': input steering file for [[NCPLOT]] to create an image of the temporal development of the waterlevels. This image will not be shown by UPLAY, but can be useful to check whether the computaional results are a time independent solution.
** '''run_ncplot_wlev_zg_user.sh''': UNIX-shellscript to launch an [[NCPLOT]] run to create an image of the temporal development of the waterlevels.

|outputfiles=
* as in [[UNTRIM2]] and [[NCPLOT]]

|methodology=
For each model run, a subfolder is created in the working directory. In the subfolder of a model simulation all result files of [[UNTRIM2]] and [[NCPLOT]] are kept. They are thus still available after generating and presenting with UPLAY. The naming for the subfolders is composed of a letter and 4 digits: At the start UPLAY searches for a letter that has not yet been used. Thus, in a folder simulations of up to 26 UPLAY sessions can be kept. Every simulation within a UPLAY session increases the four-digit counter by one. This allows up to 9999 simulations to be performed within a UPLAY session.

The program UPLAY can be called without a control file and without transfer parameters. In this case, a prepared "sandbox model" (a 2.5 km long and 500 m wide test channel with rectangular elements with a resolution of 500 m) is used. This is a 2D model for calculating hydrodynamics without the influence of density. Salt, heat, suspended particles and tracers are not included in the model. At the upstream edge, the inflow is controlled via a FLOW boundary with a constant value of 2000 m3 s-1. At the downstream edge, a water level boundary is implemented with constant value of +1 m. The simulation period is 1.5 hours with a time step of 90 seconds. The aim of the simulation is to calculate the resulting stationary solution. Therefore, the implicitness factor theta of [[UNTRIM2]] is equal to 1. Various tests have shown that the chosen time period is long enough to have a stationary solution at the end of the period. [[NCPLOT]] generates images of the flow and the waterlevels for the last moment of time. These images are read in and displayed by UPLAY.

'''Transfer parameters'''

<tt>-h</tt>

UPLAY shows a help text instead of starting the program in a normal manner.

<tt>-userdir <name_userdir></tt>

In standard case UPLAY gets his input files from this directory: <tt>$PROGHOME/shellscripts/uplay/sandbox/</tt>. However, the user can prepare his own folder with input files if he does not want to use the "sandbox model". In this case the user has to provide the input files in his own folder and has to hand over the name of the folder by using the option <tt>-userdir <name_userdir></tt>

Note that in this case the user is responsible that the input files describe the right time index to create images. The "sandbox model" uses the 61st time index in den CF-netCDF result files. The same applies to the names of the result files. For this purpose, the placeholder <tt><RUN></tt> may be used in the input files. This placeholder is replaced by UPLAY with the currently valid run name (equal to the folder name).

If the user wants to use his own grid, then the grid may contain only one subelement per grid element and only one subedge per grid edge. It is also important that the depths of the grid elements and the depths of the predefined color classes match. There must not be a grid element with a depth that is not covered by the color classes. UPLAY treats depth values as equal if the difference is less than 1 mm.

Most likely the UNIX-shellscripts has to be adjusted due to the circumstance that the conversion of the vector graphics to a bitmap image the program needs to know the correct cutout values.

<tt>-adjusted_velocity_color_palette <yes no adjusted></tt>

Adjust the color palette to the current range of velocity values? If the answer is "yes" or "adjusted", the adjustment takes place. If "no", UPLAY uses a standard range of values. Default ist "no".

<tt>-adjusted_waterlevel_color_palette <yes no adjusted></tt>

Adjust the color palette to the current range of waterlevel values? If the answer is "yes" or "adjusted", the adjustment takes place. If "no", UPLAY uses a standard range of values. Default ist "adjusted".

<tt>-untrim2009_exe <name_und_pfad_zum_untrim2009_executable></tt>

Executable file for program [[UNTRIM2]]. Without using this transfer parameter UPLAY uses a standard executable from within $PROGHOME.

<tt>-nc2table_exe <name_und_pfad_zum_nc2table_executable></tt>

Executable file for program [[NC2TABLE]]. Without using this transfer parameter UPLAY uses a standard executable from within $PROGHOME.

<tt>-ncplot_exe <name_und_pfad_zum_ncplot_executable></tt>

Executable file for program [[NCPLOT]]. Without using this transfer parameter UPLAY uses a standard executable from within $PROGHOME.

'''Hints for programmers'''

UPLAY consists of three parts: First a Fortran-Program, which works as a front end to show the grid depths, to let the user change the grid depths an to show the images of the computational results. Second a collection of UNIX-shellscripts as a back end to control simulation an creation of images. The third part is a UNIX-shellscript as a starting program. This starting script will fullfill all the necessary conditions for a successful use of the front end.

The communication between front and back end is done through data files and UNIX environment variables.

The Fortran Program uses the following PROGHOME software packages:
* <tt>h_grid</tt> for in- and output of grid files
* <tt>dic-io</tt> to read the UPLAY steering file
* <tt>base-library</tt> for basic functions (e.g. to read windows bitmap files (BMP))

In addition, the Fortran program absolutely needs the GKS (graphical kernel system) installation for basic drawing functions and a netCDF installation.

'''Limitations'''

* A coupling of [[UNTRIM2]] together with the K-Model or with Sedimorph or with the settling velocity package SV is not supported by UPLAY.
* If [[UNTRIM2]] has to solve the transport equation for salt, heat, suspended particles or tracers UPLAY does not support the creation of images of the computational results of salinity, temperature or concentration.

|preprocessor=
[[UTRPRE]]
|postprocessor=
[[DAVIT]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCAUTO]], [[NCDELTA]], [[NCPLOT]], [[NC2TABLE]], [[UNTRIM2007MONITOR]]
|language=Fortran90
|add_software= GKS (graphical kernel system)
|contact_original=[mailto:jens.juerges@baw.de J. Jürges]
|contact_maintenance=[mailto:jens.juerges@baw.de J. Jürges]
|documentation= -
}}