BAWiki - User contributions [en]

WARM

2022-12-12T10:22:11Z

Ak3bfric:

{{ProgramDescription
|name_de=WARM
|name=WARM
|version=V1.x/August 1999
|version_descr=August 1999
|catchwords=numerical simulation of wave propagation 
two-dimensional energy density spectrum 
wave rays 
shoaling 
refraction of waves due to bathymetry and current velocity 
energy input due to wind induced shear stress 
energy dissipation due to turbulence and bottom friction
|shortdescription=
The mathematical model [[Mathematical Model WARM|WARM]] (Wave Ray Model) is a wave model which is based on the transport equation for the two-dimensional energy density spectrum. The equation is solved in the frequency directional domain. The model is able to take into account several effects related to the influence of bathymetry, current velocity and water level, namely
* refraction by bottom friction and current variations,
* shoaling,
* wave current interaction (wave blocking), as well as
* non-linear dissipation of wave energy.

WARM was developed on behalf of Bundesanstalt für Wasserbau, Außenstelle Küste by [http://www.gkss.de/ GKSS Research Center], Geesthacht.
|inputfiles=
# general input data (filetype [[WARM.DAT|warm.dat]])
# model topography:
#* steady wave propagation (filetype [[TOPO.BIN|topo.bin]])
#* unsteady wave propagation influenced by changing water level elevation and current velocities (filetype [[GITTER05.DAT and GITTER05.BIN|gitter05.dat/bin]] or [[UNTRIM_GRID.DAT|untrim_grid.dat]])
# (optional) computational results (time series) for hydrodynamics (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]]) '''Notice''': in situations where time series of computed hydrodynamic data are used the corresponding grid file of type gitter05.dat/bin must be supplied.
# (optional) wind field (filetype [[TR2.MET.BIN.I|tr2.met.bin.i]] and filetype [[TR2.MET.BIN|tr2.met.bin]])
|outputfiles=
# paths of wave rays (filetype [[INSEL.DAT|insel.dat]])
# (optional) trace of program execution (filetype warm.trc)
|methodology=
In a first computational step paths for wave rays are determined. The equation for energy transport is used to calculate the two-dimensional energy density spectrum. This equation is solved in the frequency directional domain. The calculations are carried through on a grid which consists of a set of right-angled triangles.
|preprocessor=[[FDGITTER05]], [[FD2MET]], [[TR2GEOM]], [[ZEITR]]
|postprocessor=[[FDGITTER05]], [[HVIEW2D]]
|language=Fortran77
|add_software=-
|contact_original=[http://www.gkss.de/ GKSS Research Center,Geesthacht]
|contact_maintenance=[mailto:sim.proghome@baw.de Working Group SIM]
|documentation=see $PROGHOME/examples/warm/ 
please refer also to Anwendung des Seegangsmodells WARM published in No. 1/1998 of Supercomputing News (text is available in German only). This text illustrates the application of the model to study wave motion in the harbour of Rostock-Warnemünde.
}}

UPLAY

2022-12-12T10:21:49Z

Ak3bfric:

{{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:sim.proghome@baw.de Working Group SIM]
|documentation= -
}}

UNTRIMMONITOR

2022-12-12T10:21:20Z

Ak3bfric:

{{ProgramDescription
|name_de=UNTRIMMONITOR
|name=UNTRIMMONITOR
|version=1.0 / July 2006
|version_descr=October 2006
|catchwords=
numerical simulation 
analysis of UnTrim-Message-Files 
|shortdescription=
The program UNTRIMMONITOR is used for the graphical visualization of information from the UNTRIM-Message-file. The values of '''iter''', '''ntres''' (number of iterations) and '''maxError''' (measure for the quality of the solution) are time-series. The program is able to make a plot of these parameters. Additionally the parameter '''maxError''' is shown in an XY coordinate system. The described parameters provide an indication of the performance of the numerical code as well as the quality of the computational results.
The routine also exports time-series data to a semicolon-separated-data file, which can easily be imported in spreadsheats (e.g. EXCEL). The evaluation can be performed during the simulation or after the end of a model run, so that deficiencies of the simulation can be recognized promptly.

The represented parameters are:

# '''iter''': Number of iterations of the free surface
# '''ntres''': Number of iterations for the solution of the transport equations, separately for each tracer (e.g. salinity, temperature, suspended load)
# '''maxError''': maximum error of the iterative computed water level in the whole model area; this value is the difference between the iterative computed water level and the water level, which will be obtained after inserting the computed velocity in the continuity equation.

The following figure shows an example for a simulation. The time-series of the named parameters are plotted on the right hand side (produced with UnTrimMonitor). A picture of the current velocity at a critical stage with a large number of iteration is shown on the left hand side of the figure. [[:file:Untrimmonitor.png|figure]]
|inputfiles=
UNTRIM '''Messagefile''' (filetype untrim.msg)
|outputfiles=
# (optional) '''pixel image''' (filetype untrimmonitor.png)
# (optional) '''ASCII-File''' (filetype untrimmonitor.monitor) semicolon separated columns of the simulation time steps, '''iter''', '''ntres''', '''maxError'''
|methodology=
The program reads the values of iter, ntres and maxError from the UnTrim-Message-file first. After that the parameters can be plotted or be written to a semicolon-separated-data file. This type of file can easily be imported in spreadsheats and processed in other tools (e.g. EXCEL)
|preprocessor=
[[UNTRIM]]
|postprocessor=
EXCEL
|language=java
|add_software= -
|contact_original=[mailto:reiner.schubert@baw.de R. Schubert], [mailto:ulrike.schiller@baw.de U. Schiller]
|contact_maintenance=[mailto:sim.proghome@baw.de Working Group SIM]
|documentation= -
}}

UNTRIM2007MONITOR

2022-12-12T10:20:54Z

Ak3bfric:

{{ProgramDescription
|name_de=UNTRIM2007MONITOR
|name=UNTRIM2007MONITOR
|version=1.3 / January 2017
|version_descr=January 2017
|catchwords=numerical simulation 
analysis of UNTRIM2007 printer file 
output of time series data 
|shortdescription=The program UNTRIM2007MONITOR extracts relevant information out of an [[UNTRIM2007]] printer file.
|inputfiles=
# '''printer file''' with information on execution of program UNTRIM2007 (filetype untrim2007.master.sdr)
|outputfiles=
# '''time series files''' derived from printer file (filetype [[BOEWRT.DAT|boewrt.dat]])
# '''position files''' derived from printer file (filetype [[GEOM.DAT|geom.dat]])
|methodology=Extraction of time series out of an UNTRIM2007 printer file. UNTRIM2007MONITOR looks for
search strings to identify lines with data inside.

Example: If UNTRIM2007MONITOR finds the search string "# CHECKED: CR_ext Max =", then the columns
25 to 34 contains the maximum flow courant number of the current time step.

Since version 1.3 the definition of the search strings and thus detectable physical quantities takes place with a configuration file ('''untrim2007monitor.cfg.dat'''). A standard configuration file with almost 100 search strings (January 2017) is located under $PROGHOME/cfg, so that this configuration file will be used automatically, if the program can't find a user-provided configuration file in the working directory.

The extraction creates time series with a resolution as high as the time step of the simulation.

Each time serie will be written in a different file of type [[BOEWRT.DAT|boewrt.dat]]. There is no graphical output. Instead, the program
[[GVIEW2D]] can read and visualize all time serie files.

Since version 1.3 all extractable physical quantities are stored in groups, because it can not be assured, that the extraction of all different physical quantities works properly within one program execution. This is because within one program execution the file to be read and all files to be written are open simultaneously. The time serie values are not stored in the memory. Advantage: The number of time steps is not limited and does not depend on the size of the memory. Disadvantage: The number of open files is limited and thus the number of simultaneously extractable physical quantities within one program execution is limited. Tests have shown that it is possible to write more than 200 files simultaneously and that it is presently not necessary to group the physical quantities. In the future this feature could be more important if even more physical quantities will be added to the configuration file.

The following physical quantities are accessible after extraction within time serie files of type [[BOEWRT.DAT|boewrt.dat]]:
* UnTRIM core
** accuracy of the solution of the water levels
** accuracy of the water volume of time step i
** accuracy of the total water volume
** number of CG iterations
** maximum courant numbers for flow and internal waves
** number of edges where courant criteria (flow and internal waves) are not fulfilled
** number of sub steps to fulfill courant criterion for transport equation for each UNTRIM specie
** "mass" of all UNTRIM species
** surface flux of all UNTRIM species
** bottom flux of all UNTRIM species
** fluid volume
** water surface area
** dry area
* SediMorph core
** SediMorph accretion- and erosion volume
** SediMorph volume of all fractions
** min/mean/max x- and y-velocity
** maximum bottom shear stress
* SV model
** min/mean/max absolut velocity gradient
** min/mean/max turbulent shear stress
* K model
** min/mean/max water level
** min/mean/max depth
** min/mean/max x- and y-velocity
* Values at open boundary
** min/mean/max water level
** min/mean/max salinity
** min/mean/max suspended sediment concentration
* Values at atmosphere boundary
** min/mean/max wind velocity
** min/mean/max wind drag coefficient
** min/mean/max normalised atmospheric pressure
* Values at bottom boundary
** min/mean/max bottom drag coefficient
** min/mean/max flux of sediments from water column to soil
** min/mean/max flux of sediments from soil to water column
** min/mean/max residual flux of sediments
* Values inside water body
** min/mean/max normalised water density
** min/mean/max horizontal turbulent viscosity
** min/mean/max horizontal turbulent diffusivity
** min/mean/max vertical turbulent viscosity
** min/mean/max vertical turbulent diffusivity
** min/mean/max settling velocity

The following physical quantities are accessible after extraction within position files of type [[GEOM.DAT|geom.dat]]:
* coordinates of edges with the maximum flow courant number
* coordinates of edges with the maximum internal wave courant number
These files can be visualized with [[JANET]].
|preprocessor=[[UNTRIM2007]]
|postprocessor=[[GVIEW2D]], [[JANET]]
|language=Fortran90
|add_software=-
|contact_original=[mailto:jens.juerges@baw.de J. Jürges]
|contact_maintenance=[mailto:sim.proghome@baw.de Working Group SIM]
|documentation=please refer to $PROGHOME/examples/untrim2007monitor/
}}

UNTRIM2007

2022-12-12T10:20:21Z

Ak3bfric:

{{ProgramDescription
|name_de=UNTRIM2007
|name=untrim2007
|version=February 2020
|version_descr=January 2022
|catchwords=
numerical simulation 
finite difference method 
finite volume method 
unstructured orthogonal grid 
two-dimensional, three-dimensional 
unsteady, non-linear 
hydrostatic, non-hydrostatic 
reynoldsaveraged Navier Stokes equations (RANS) 
tidal dynamics (long waves) 
transport of conservative substances (salt, temperature, suspended sediments, tracers) 
two-equation turbulence modelling 
numerical method UNTRIM2007 
sub-model for water density EQS 
sub-model for mixing length turbulence modelling MIX 
sub-model for settling velocity modelling SV 
sub-model for morphodynamics SEDIMORPH 
sub-model for dredging and disposal DredgeSim 
sub-model for short waves K-Model 
portable SMP-programming using [http://openmp.org/wp/ OpenMP] 
storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
storage of [https://en.wikipedia.org/wiki/MD5 MD5 hash values] of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 

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=
'''Method'''

The three-dimensional finite difference / finite volume numerical model UNTRIM2007 can be used to simulate flow and transport processes in different free-surface flow problems. In contrast to conventional finite difference methods UNTRIM2007 is able to operate on an unstructured orthogonal grid.

'''Physical Processes'''

The following physical processes are currently taken into account by UnTRIM2007:

* reynoldsaveraged Navier-Stokes equations (RANS)
** local acceleration (inertia)
** advective acceleration
** Coriolis acceleration
** barotropic pressure gradient
** baroclinic pressure gradient
** hydrostatic or non-hydrostatic pressure
** horizontal turbulent viscosity
** vertical turbulent viscosity influenced by density stratification
** bottom friction
** wind friction
** sources and sinks
** bottom evolution
** horizontal acceleration due to wave effects (by means of radiation stress)
** morphodynamic bathymetry
** body forces due to short waves
* transport of substances
** local rate of change of concentration
** advective rate of change of concentration
** optional flux limiter : Minmod, van Leer or Superbee
** horizontal turbulent diffusivity
** vertical turbulent diffusivity influenced by density stratification
** settling of particles, deposition and erosion (for suspended sediments)
** sources and sinks
** sinks with immediate return inflow at a different location, with optional modification of inflow-temperature as well as -salinity
* turbulence modelling
** constant
** mixing length (various parametrizations)
** two-equation model (turbulent kinetic energy, generic length scale)

'''Primary Computational Results'''

* free surface elevation
* bottom bathymetry and bed evolution rate
* current velocity
* concentration of substances (salinity, temperature, suspended load, tracers)
* turbulent kinetic energy and turbulent length scale
* hydrodynamic pressure

|inputfiles=
# general '''input data''' (filetype [[UNTRIM_2007.DAT|untrim2007.dat]])
# all other input data are described in the aforementioned input file as well as in the further used steering files listed there.
# (optional) DMQS metadata can be set in the batch script of the simulation and in the central project script, see http://wiki.baw.de/en/index.php/Metadata_of_Model_results_in_Coastal_Engineering .
# (optional) If DMQS metadata has not been set '''global metadata''' stored in files of type [[NC_META.DAT|nc_meta.dat]]) can be an alternative. 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=
# all output data files are either described with filteype [[UNTRIM_2007.DAT|untrim2007.dat]] or with all other filteypes used in the aforementioned master input file.
# [[CF-NETCDF.NC]] files can be generated optionally.
# printer file with informations on program execution (filetype untrim2007.master.sdr).
# (optional) trace file (filetype untrim2007.trc).
|methodology=
-
|preprocessor=
[[NCDVAR]], [[NCMERGE]], [[UTRPRE]], [[UTRRND]]
|postprocessor=
[[ABDF]], [[DATACONVERT]], [[DAVIT]], [[DIDAMINTQ]], [[GVIEW2D]], [[HVIEW2D]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCAUTO]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[NCPLOT]], [[NC2TABLE]], [[UNTRIM2007MONITOR]], [[VTDK]], [[VVIEW2D]], [[XTRLQ2]], [[ZEITR]]
|language=Fortran90
|add_software= -
|contact_original=[mailto:info.hamburg@baw.de V. Casulli], [mailto:guenther.lang@baw.de G. Lang]
|contact_maintenance=[mailto:sim.proghome@baw.de Working Group SIM]
|documentation=
* please refer to $PROGHOME/examples/untrim2007/
}}

UNTRIM2

2022-12-12T10:19:46Z

Ak3bfric:

{{ProgramDescription
|name_de=UNTRIM2
|name=untrim2
|version=January 2020
|version_descr=January 2022
|catchwords=
numerical simulation 
finite difference method 
finite volume method 
sub grid technology 
unstructured orthogonal grid 
two-dimensional, three-dimensional 
unsteady, non-linear 
conservative and non-conservative ELM for momentum transport 
hydrostatic, non-hydrostatic 
reynoldsaveraged Navier Stokes equations (RANS) 
tidal dynamics (long waves) 
transport of conservative substances (salt, temperature, suspended sediments, tracers) 
two-equation turbulence modelling 
weirs and imposed surfaces (pressurized flow) 
numerical method UNTRIM2 
sub-model for water density EQS 
sub-model for mixing length turbulence modelling MIX 
sub-model for settling velocity modelling SV 
sub-model for morphodynamics SEDIMORPH (partially implemented) 
sub-model for dredging and disposal DredgeSim (not implemented yet) 
sub-model for short waves K-Model 
portable SMP-programming using [http://openmp.org/wp/ OpenMP] 
offline coupling with D-Water Quality [http://www.deltaressystems.com/hydro/product/621497/delft3d-suite Delft3D Suite] 
optional computation of chunk sizes for result variables (see [[NetCDF#File_Chunking|File Chunking]]) 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of [https://en.wikipedia.org/wiki/MD5 MD5 hash values] of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 

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=
'''Method'''

The three-dimensional finite difference / finite volume numerical model UNTRIM2 can be used to simulate flow and transport processes in different free-surface flow problems. In contrast to conventional finite difference methods UNTRIM2 is able to operate on an unstructured orthogonal grid. The bathymetry of the model domain can be described with higher resolution compared to the computational grid using sub grid technology.

'''Physical Processes'''

The following physical processes are currently taken into account by UnTRIM2:

* reynoldsaveraged Navier-Stokes equations (RANS)
** local acceleration (inertia)
** advective acceleration
** Coriolis acceleration
** barotropic pressure gradient
** baroclinic pressure gradient
** hydrostatic or non-hydrostatic pressure
** horizontal turbulent viscosity
** vertical turbulent viscosity influenced by density stratification
** bottom friction
** wind friction
** sources and sinks
** bottom evolution
** horizontal acceleration due to wave effects (by means of radiation stress)
** morphodynamic bathymetry
** body forces due to short waves
* transport of substances
** local rate of change of concentration
** advective rate of change of concentration
** optional flux limiter : Minmod, van Leer or Superbee
** horizontal turbulent diffusivity
** vertical turbulent diffusivity influenced by density stratification
** settling of particles, deposition and erosion (for suspended sediments)
** sources and sinks
** sinks with immediate return inflow at a different location, with optional modification of inflow-temperature as well as -salinity
* turbulence modelling
** constant
** mixing length (various parametrizations)
** two-equation model (turbulent kinetic energy, generic length scale)

'''Primary Computational Results'''

* free surface elevation
* bottom bathymetry and bed evolution rate
* current velocity
* concentration of substances (salinity, temperature, suspended load, tracers)
* turbulent kinetic energy and turbulent length scale
* hydrodynamic pressure

|inputfiles=
# general '''input data''' (filetype [[UNTRIM2.DAT|untrim2.dat]])
# all other input data are described in the aforementioned input file as well as in the further used steering files listed there.
|outputfiles=
# all output data files are either described with filteype [[UNTRIM2.DAT|untrim2.dat]] or with all other filteypes used in the aforementioned master input file. See also [[CF-NETCDF.NC|cf-netcdf.nc]] and [[WAQ-files]].
# printer file with informations on program execution (filetype untrim2.master.sdr).
# (optional) trace file (filetype untrim2.trc).
|methodology=
-
|preprocessor=
[[CREATE_SIMPLE_UNTRIM2_GRID]], [[DATACONVERT]], [[NCDVAR]], [[NCMERGE]], [[UTRPRE]], [[UTRRND]]
|postprocessor=
[[ABDF]], [[DAVIT]], [[GVIEW2D]], [[LQ2PRO]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCAUTO]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[NCPLOT]], [[NCVIEW2D]], [[NC2TABLE]], [[QUICKPLOT]], [[VVIEW2D]], [[ZEITR]]
|language=Fortran90
|add_software= -
|contact_original=[mailto:info.hamburg@baw.de V. Casulli], [mailto:guenther.lang@baw.de G. Lang]
|contact_maintenance=[mailto:sim.proghome@baw.de Working Group SIM]
|documentation=
* please refer to $PROGHOME/examples/untrim2009/
}}

UNTRIM

2022-12-12T10:19:05Z

Ak3bfric:

{{ProgramDescription
|name_de=UNTRIM
|name=UNTRIM
|version=2.x / April 2005
|version_descr=November 2013
|catchwords=
numerical simulation 
finite difference method 
finite volume method 
unstructured orthogonal grid 
two-dimensional, three-dimensional 
unsteady, non-linear 
hydrostatic, non-hydrostatic 
reynoldsaveraged Navier Stokes equations (RANS) 
tidal dynamics (long waves) 
wave propagation (short waves, wave spectrum) 
transport of conservative tracers (salt, temperature, suspended sediments) 
numerical method UNTRIM 
morphodynamic sub-model SEDIMORPH 
portable SMP-programming using [http://openmp.org/wp/ OpenMP] 
|shortdescription=
'''Method'''

The three-dimensional finite difference / finite volume [[Mathematical Model UNTRIM|numerical model UNTRIM]] can be used to simulate flow and transport processes in different free-surface flow problems. In contrast to conventional finite difference methods UnTRIM is able to operate on an unstructured orthogonal grid.

'''Physical Processes'''

The following physical processes are currently taken into account by UNTRIM:

* reynoldsaveraged Navier-Stokes equations (RANS)
** local acceleration (inertia)
** advective acceleration
** Coriolis acceleration
** barotropic pressure gradient
** baroclinic pressure gradient
** hydrostatic or non-hydrostatic pressure
** horizontal turbulent viscosity
** vertical turbulent viscosity influenced by density stratification
** bottom friction
** wind friction
** sources and sinks
* transport of tracers
** local rate of change of concentration
** advective rate of change of concentration
** optional flux limiter : Minmod, van Leer or Superbee
** horizontal turbulent diffusivity
** vertical turbulent diffusivity influenced by density stratification
** settling of particles, deposition and erosion (for suspended sediments)
** sources and sinks
** sinks with immediate return inflow at a different location, with optional modification of inflow-temperature as well as -salinity

'''Computational Results'''

* free surface elevation
* current velocity
* concentration of tracers (e.g. salinity, temperature, suspended load)
* vertical turbulent eddy-viscosity
* hydrodynamic pressure
* water density

If a three-dimensional simulation is carried through the depth-averaged results are also computed in addition to the three-dimensional ones.

'''Validation Document'''

A PDF-version of the validation document is freely available for download:

* (approx. 1.2 MB) [http://www.baw.de/downloads/wasserbau/mathematische_verfahren/pdf/vd-untrim-2004.pdf UNTRIM standard validation document]

additional physical sub-models
The numerical method UnTRIM is coupled to the following (independent) physical sub-models:

# morphodynamic computational package SediMorph: for details please refer to [[SEDIMORPH.DAT|sedimorph.dat]].
# spectral wave model k-model: for details please refer [[K_MODEL.DAT|k_model.dat]]
|inputfiles=
# '''main input data''' (filetype [[UNTRIM_MAIN.DAT|untrim_main.dat]]).
# '''Hydrodynamics and Salt Transport''' (filetype [[UNTRIM_HYD.DAT|untrim_hyd.dat]]);
# '''Atmosphere''' (filetype [[UNTRIM_ATM.DAT|untrim_atm.dat]]);
# '''Bedload-Transport''' (filetype [[UNTRIM_BED.DAT|untrim_bed.dat]]);
# '''Equation of State''' (filetype [[UNTRIM_EQS.DAT|untrim_eqs.dat]]);
# '''Morphodynamic Evolution''' (filetype [[UNTRIM_MOR.DAT|untrim_mor.dat]]);
# '''Suspended Sediment Transport''' (filetype [[UNTRIM_SUS.DAT|untrim_sus.dat]]);
# '''Wind Waves''' (filetype [[UNTRIM_WAV.DAT|untrim_wav.dat]]).

'''Notice''': further input files can be found on the file description pages of the aforementioned files.
|outputfiles=
the number and type of result files does mainly depend on the output parameters chosen for the different physical sub models. Typically the following types of files will be generated:

# file with '''modified computational grid''' (filetype [[UNTRIM_GRID.DAT|untrim_grid.dat]]);
#: '''Notice''': this (modified) system file must be used during postprocessing of computational results in the overall domain;
# (optional) file with '''modified profile topography''' (filetype [[PROFIL05.BIN|profil05.bin]]);
#: '''Notice''': this (modified) profile topography must be used during postprocessing of computational results along profiles;
# (optional) '''system file for specific locations''' (filetype [[LOCATION_GRID.DAT|location_grid.dat]]);
#: '''Notice''': this system file must be used for postprocessing of results generated for specific locations.
# (optional) '''computational results''' for the overall domain, at specific locations or along profiles (filetype [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]]);
# (optional) '''restart files''', which are necessary for a later continuation of the simulation (filetype [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]]);
# (optional) informative '''printer file''' (Dateityp untrim_main.sdr);
# (optional) '''trace of program execution''' (filetype untrim_main.trc).
# message file (filetype untrim.msg); parts of this file can be visualised and processed using [[UNTRIMMONITOR]].
|methodology=
please refer to documentation/literature
|preprocessor=
[[GRIDCONVERT]], [[GVIEW2D]], [[JANET]], [[RSMERGE]], [[TICLQ2]], [[TOUTR]], [[UTRRND]]
|postprocessor=
[[ABDF]], [[ADCP2PROFILE]], [[DIDAMERGE]], [[DIDAMINTQ]], [[DIDAMINTZ]], [[DIDARENAME]], [[DIDASPLIT]], [[ENERF]], [[GRIDCONVERT]], [[GVIEW2D]], [[HVIEW2D]], [[IO_VOLUME]], [[LQ2PRO]], [[NCVIEW2D]], [[PARTRACE]], [[PGCALC]], [[PLOTPROFILZEIT]], [[PLOTTS]], [[QUICKPLOT]], [[RSMERGE]], [[TIMESHIFT]], [[UNS]], [[UNTRIMMONITOR]], [[VTDK]], [[VVIEW2D]], [[XTRDATA]], [[XTRLQ2]], [[ZEITR]]
|language=Fortran90
|add_software= -
|contact_original=[mailto:info.hamburg@baw.de V. Casulli]
|contact_maintenance=[mailto:sim.proghome@baw.de Working Group SIM]
|documentation=
* please refer to $PROGHOME/examples/untrim/
** '''./BSP_becken_src_snk/''' : example files for a closed basin with one sink and one source.
** '''./BSP_becken_wind/''' : example files for wind influence on water level elevation and current velocity in a closed basin.
** '''./BSP_hafen/''' : example files for wave propagation in a harbour basin.
** '''./BSP_kanal_w_gradient/''' : example files for a straight channel with constant water level gradient;
** '''./BSP_kanal_w_inflow/''' : example files for a straight channel with constant inflow (discharge).
** '''./BSP_kanal_salt_heat/''' : example files for a straight channel with outtake-inflow situation, additionally taking alterations of inflow-temperature and -salinity into account.
** '''./BSP_soliton /''' : propagation of a solitary wave in a straight wave channel.
* [http://www3.interscience.wiley.com/journal/69502070/abstract Casulli, Vincenzo and Roy A. Walters (2000)], An unstructured, three-dimensional model based on the shallow water equations, International Journal for Numerical Methods in Fluids 2000, 32: 331 - 348.
* see also [[Mathematical Model UNTRIM|numerical model UNTRIM]].
}}

TRIM-3D

2022-12-12T10:14:17Z

Ak3bfric:

{{ProgramDescription
|name_de=TRIM-3D
|name=TRIM-3D
|version=4.x / January 2001
|version_descr=October 2001
|catchwords=numerical simulation 
finite difference method 
three-dimensional, transient, nonlinear 
hydrostatic pressure, non-hydrostatic pressure 
Navier-Stokes-Equations, Reynolds-Equations 
tidal dynamics 
short waves 
advection-diffusion equation 
salt transport 
numerical model TRIM-3D
|shortdescription=The three-dimensional finite difference numerical model TRIM-3D can be used to simulate flow and transport processes in different free-surface flow problems.
The following list of physical processes are taken into account by TRIM-3D:

* Reynolds-Equations (time-averaged Navier-Stokes-Equations)
:*local acceleration (inertia)
:*advective acceleration
:*Coriolis acceleration
:*barotropic pressure gradient
:*baroclinic pressure gradient
:*hydrostatic or non-hydrostatic pressure
:*turbulent diffusion in horizontal directions
:*vertical turbulent viscosity influenced by density stratification
:*bottom friction
:*wind friction
:*time-varying height of control-structures (weirs)
* advection-diffusion equation
:*local rate of change of concentration
:*advctive rate of change of concentration
:*turbulent diffusion in horizontal directions
:*vertical turbulent diffusivity influenced by density stratification

Horizontal turbulent diffusion is parameterized using constant coefficients.

With the aid of the numerical model TRIM-3D the following physical quantities can be calculated:

* free surface elevation
* current velocity
* salinity
* vertical turbulent eddy-viscosity
* vertical turbulent eddy-diffusivity
* hydrodynamic pressure
* water density
* bottom shear stress
* wind shear stress

A comprehensive description of TRIM-3D in the form of a standard validation document is unfortunately not available at the moment.
|inputfiles=Several input-files are identical with those of the numerical model TRIM-2D.

#general input data (filetype [[TRIM3D.DAT|trim3d.dat]])
#general input data for bed load transport (filetype [[TRIM2D.BED.DAT|trim2d.bed.dat]])
#:Notice: informations contained in this file are not used by the current version of the program.
#bathymetry and index arrays (filetype [[TR2.TOPO.BIN.IND|tr2.topo.bin.ind]])
#boundary values file for hydrodynamics (filetype [[TR2.RBH.BIN.I|tr2.rbh.bin.i]] and filetype [[TR2.RBH.BIN|tr2.rbh.bin]])
#(optional) boundary values file for salinity (filetype [[TR2.RBS.BIN.I|tr2.rbs.bin.i]] and filetype [[TR2.RBS.BIN|tr2.rbs.bin]])
#:Notice: only depth-independent boundary values can be prescribed in the current version of the program.
#(optional) boundary values file for suspended sediment concentration (filetype [[TR2.RBC.BIN.I|tr2.rbc.bin.i]] and filetype [[TR2.RBC.BIN|tr2.rbc.bin]])
#:Notice: informations contained in this file are not used by the current version of the program.
#(optional) control structure boundary condition file (filetype [[TR2.RBW.BIN.I|tr2.rbw.bin.i]] and filetype tr2.rbw.bin)
#(optional) wind field (filetype [[TR2.MET.BIN.I|tr2.met.bin.i]] and filetype [[TR2.MET.BIN|tr2.met.bin]])
#(optional) initial conditions (filetype [[TR3.RESULT|tr3.result]])
#:'''TR2first_H:''' hydrodynamics
#:'''TR2first_S:''' salinity
#(optional) manually defined initial conditions which are variable in space (filetype tr3.deffields.dat)
#(optional) profile-topography (filetype [[PROFIL05.BIN|profil05.bin]])
|outputfiles=
#(optional) results files (filetype [[TR3.RESULT|tr3.result]])
#(optional) time series of computed results at specific locations (filetype [[KNOERG.BIN|knoerg.bin]])
#(optional) computed results along profiles (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]])
#(optional) safety output of computational results at regular intervals (filetype [[TR3.RESULT|tr3.result]])
#:'''TR2save_H:''' hydrodynamics
#:'''TR2save_S:''' salinity
#3D-index-arrays (filetype [[TR2.TOPO.BIN.I3D|tr2.topo.bin.i3d]])
#printer file with informations about essential parameters used and informative messages during program execution (filetype trim3d.echo)
#(optional) trace of program execution (filetype trim3d.trc)
|methodology= -
|preprocessor=[[FD2MET]], [[TR2LQ2]], [[TR2VOR]], [[TR2RND]], TR3RND (under construction)
|postprocessor=[[ADCP2PROFILE]], [[DIDAMERGE]], [[DIDAMINTQ]], [[DIDAMINTZ]], [[DIDARENAME]], [[DIDASPLIT]], [[ENERF]], [[GVIEW2D]], [[LQ2PRO]], [[PGCALC]], [[TIDKEN]], [[TR2GEOM]], [[TR3DIDA]], [[TR3KACHEL]], [[TR3MODATE]], [[TRIMKACH]], [[TRVZR]], [[VTDK]], [[VVIEW2D]], [[XTRDATA]], [[ZEITR]]
|language=Fortran90
|add_software=-
|contact_original=[mailto:vincenzo.casulli@ing.unitn.it V. Casulli],[mailto:günther.lang@baw.de G. Lang]
|contact_maintenance=[mailto:sim.proghome@baw.de Working Group SIM]
|documentation=please refer to $PROGHOME/examples/trim3d/

general informations: Numerische Methoden für Strömungen, Stoff- und Wärmetransport (available in German only).
}}

TRIM-2D

2022-12-12T10:13:38Z

Ak3bfric:

{{ProgramDescription
|name_de=TRIM-2D
|name=TRIM-2D
|version=12.x
|version_descr=March 2003
|catchwords=numerical simulation 
finite difference method 
two-dimensional, transient, nonlinear 
shallow water equations 
tidal dynamics 
advection-diffusion equation 
salt transport 
suspended sediment transport 
deposition and resuspension 
bed load transport 
numerical model TRIM-2D 
portable SMP-programming using [http://openmp.org/wp/ OpenMP] 
morphodynamic evolution of the bottom due to suspended load as well as bed load transport
|shortdescription=The two-dimensional finite difference numerical model TRIM-2D can be used to simulate flow and transport processes in different free-surface flow problems.
The following list of physical processes are taken into account by TRIM-2D:

* shallow water equations
:*local acceleration (inertia)
:*advective acceleration
:*Coriolis acceleration
:*barotropic pressure gradient
:*baroclinic pressure gradient (depth integrated)
:*turbulent diffusion and dispersion
:*bottom friction
:*wind friction
:*time-varying height of control-structures (weirs)
* advection-diffusion equation
:*local rate of change of concentration
:*advctive rate of change of concentration
:*turbulent diffusion and dispersion
:*settling velocity depends on turbulence intensity
* Exchange of suspended sediments between the bottom layer and the water column
:*resuspension of deposited suspended sediments above a critical bottom shear stress (critical shear stress for resuspension)
:*deposition of suspended sediments below a critical bottom shear stress (critical shear stress for deposition)
* bed load transport of sediments
:*bed load transport rate is given by the transport capacity of the flow (vanRIJN, BAGNOLD)
* morphodynamic evolution of the bottom
:*net erosion/deposition due to bed load transport
:*net erosion/deposition due to suspended load transport

Turbulent diffusion as well as dispersion is parameterized using constant coefficients.

With the aid of the numerical model TRIM-2D the following physical quantities can be calculated:

* free surface elevation
* depth-averaged current velocity
* depth-averaged salinity
* depth-averaged suspended sediment concentration
* deposited suspended sediment mass
* bed load transport rate
* deposited bed load material mass
* bottom shear stress
* wind shear stress
* depth erosion
* time varying depth of the bottom

A comprehensive description of TRIM-2D is available in the form of a [http://www.baw.de/methoden/index.php5?title=Mathematisches_Verfahren_TRIM-2D&action=edit&redlink=1 Standard Validation Document] (in German only).
|inputfiles=
#general input data (filetype [[TRIM2D.DAT|trim2d.dat]])
#general input data for bed load transport (filetype [[TRIM2D.BED.DAT|trim2d.bed.dat]])
#solver accuracy (filetype [[RELAX.DAT|relax.dat]])
#bathymetry and index arrays (filetype [[TR2.TOPO.BIN.IND|tr2.topo.bin.ind]])
#boundary values file for hydrodynamics (filetype [[TR2.RBH.BIN.I|tr2.rbh.bin.i]] and filetype [[TR2.RBH.BIN|tr2.rbh.bin]])
#(optional) boundary values file for salinity (filetype [[TR2.RBS.BIN.I|tr2.rbs.bin.i]] and filetype [[TR2.RBS.BIN|tr2.rbs.bin]])
#(optional) boundary values file for suspended sediment concentration (filetype [[TR2.RBC.BIN.I|tr2.rbc.bin.i]] and filetype [[TR2.RBC.BIN|tr2.rbc.bin]])
#(optional) control structure boundary condition file (filetype [[TR2.RBW.BIN.I|tr2.rbw.bin.i]] and filetype [[TR2.RBW.BIN|tr2.rbw.bin]])
#(optional) wind field (filetype [[TR2.MET.BIN.I|tr2.met.bin.i]] and filetype [[TR2.MET.BIN|tr2.met.bin]])
#(optional) description of soil types (filetype [[SOIL.DAT|soil.dat]])
#(optional) distribution of soil types (filetype [[TR2.SOIL.BIN.IND|tr2.soil.bin.ind]])
#(optional) initial conditions (filetype [[TR2.RESULT|tr2.result]])
#:'''TR2first_H:''' hydrodynamics, depth of the bottom 
#:'''TR2first_S:''' salinity 
#:'''TR2first_C:''' suspended sediment concentration 
#:'''TR2first_B:''' deposited suspended sediments 
#:'''TR2first_L:''' bed load transport rate and deposited bed load material 
# (optional) profile-topography (filetype [[PROFIL05.BIN|profil05.bin]])
|outputfiles=
# computational results at the end of the simulation (filetype [[TR2.RESULT|tr2.result]])
#:'''TR2last_H:''' hydrodynamics, depth of the bottom 
#:'''TR2last_S:''' salinity 
#:'''TR2last_C:''' suspended sediment concentration 
#:'''TR2last_B:''' deposited suspended sediments 
#:'''TR2last_L:''' bed load transport rate and deposited bed load material 
#:'''TR2last_A:''' optional results (e.g. wind shear stress, bottom shear stress) 
#(optional, in case of morphodynamic simulation) final bathymetry and index arrays (filetype [[TR2.TOPO.BIN.IND|tr2.topo.bin.ind]])
#(optional) results files (filetype [[TR2.RESULT|tr2.result]])
#(optional) time series of computed results at specific locations (filetype [[KNOERG.BIN|knoerg.bin]])
#(optional) computed results along profiles (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]])
#(optional) safety output of computational results at regular intervals (filetype [[TR2.RESULT|tr2.result]])
#:'''TR2save_H:''' hydrodynamics, depth of the bottom 
#:'''TR2save_S:''' salinity 
#:'''TR2save_C:''' suspended sediment concentration 
#:'''TR2save_B:''' deposited suspended sediments 
#:'''TR2save_L:''' bed load transport rate and deposited bed load material 
#:'''TR2save_A:''' optional results (e.g. wind shear stress, bottom shear stress) 
#printer file with informations about essential parameters used and informative messages during program execution (filetype trim2d.echo)
#(optional) trace of program execution (filetype trim2d.trc)
|methodology=See information in [http://www.baw.de/methoden/index.php5?title=Mathematisches_Verfahren_TRIM-2D&action=edit&redlink=1 the Standard Validation Document] (in German only).
|preprocessor=[[FD2MET]], [[MKRDAT]], [[TR2LQ2]], [[TR2VOR]], [[TR2RND]]
|postprocessor=[[DIDAMERGE]], [[DIDAMINTQ]], [[DIDARENAME]], [[DIDASPLIT]], [[ENERF]], [[GVIEW2D]], [[LQ2PRO]], [[PGCALC]], [[TIDKEN]], [[TR2APP]], [[TR2ASCII]], [[TR2DIDA]], [[TR2GEOM]], [[TR2KACHEL]], [[TR2MODATE]], [[TRIMKACH]], [[TRVZR]], [[VTDK]], [[VVIEW2D]], [[XTRDATA]], [[ZEITR]]
|language=Fortran90
|add_software=-
|contact_original=[mailto:vincenzo.casulli@ing.unitn.it V. Casulli], [mailto:rtcheng@usgs.gov R. T. Cheng],[mailto:günther.lang@baw.de G. Lang], [mailto:elisabeth.rudolph@baw.de E. Rudolph]
|contact_maintenance=[mailto:sim.proghome@baw.de Working Group SIM]
|documentation=$PROGHOME/examples/trim2d/,
[http://www.baw.de/methoden/index.php5?title=Mathematisches_Verfahren_TRIM-2D&action=edit&redlink=1 Standard Validation Document] (in German only),
general informations: [http://www.baw.de/downloads/wasserbau/mathematische_verfahren/programmkennbl_de/pdf/nummeth1.pdf Numerische Methoden für Strömungen, Stoff- und Wärmetransport] (available in German only).
}}

TELEMAC-2D

2022-12-12T10:13:00Z

Ak3bfric:

{{ProgramDescription
|name_de=TELEMAC-2D
|name=TELEMAC-2D
|version=V5P0
|version_descr=February 2008
|catchwords=numerical simulation 
finite element method 
two-dimensional, transient, nonlinear 
shallow water equations 
tidal dynamics 
advection-diffusion equation 
salt-transport 
numerical model TELEMAC-2D
|shortdescription=
The two-dimensional finite element numerical model TELEMAC-2D can be used to simulate flow and transport processes in different free-surface flow problems.
The following list of physical processes are taken into account by TELEMAC-2D:

* shallow water equations
** local acceleration (inertia)
** advective acceleration
** Coriolis acceleration
** barotropic pressure gradient
** baroclinic pressure gradient (depth integrated)
** atmospheric pressure gradient
** turbulent diffusion and dispersion
** bottom friction
** wind friction
Turbulence can be optionally calculated using a K-Epsilon turbulence model.
* advection-diffusion equation
* Boussinesq-equation

With the aid of the numerical model TELEMAC-2D the following physical quantities can be calculated:
* depth-averaged scalar velocity
* depth-averaged velocity in x-direction
* depth-averaged velocity in y-direction
* surface wave celerity C
* water depth
* free surface elevation
* bathymetric depth (bottom)
* Froude number
* Courant number
* depth-averaged scalar flowrate
* depth-averaged flowrate in x-direction
* depth-averaged flowrate in y-direction
* depth-averaged tracer concentration
* depth-averaged turbulent kinetic energy
* depth-averaged turbulent dissipation
* depth-averaged turbulent viscosity

TELEMAC-2D has been developed from '''Laboratoire d'Hydraulique der EDF-DER''' (Chatou, Paris). A comprehensive description of the system is available in "TELEMAC-2D Modelling System - Users Manual".
|inputfiles=
# general input data (filetype [[TELEMAC2D.CAS|telemac2d.cas]])
# FORTRAN main program for TELEMAC-2D (filetype [[TELEMAC2D.PRINCI.F|telemac2d.princi.f]])
# optimized grid and bathymetry (filetype [[GEO|geo]])
# boundary conditions file (filetype [[CONLIM.DAT|conlim.dat]])
# (optional) file with informations about BAW-boundary condition files (filetype [[TM2RND.DAT|tm2rnd.dat]])
# (optional) file with information about BAW-boundary condition files, BAW-output-files, BAW-output-grids and BAW-output periods (filetype [[TELEMAC.DAT|telemac.dat]])
# (optional) boundary values file for hydrodynamics (filetype [[TM2.RBH.BIN.I|tm2.rbh.bin.I]] and filetype [[TM2.RBH.BIN|tm2.rbh.bin]])
# (optional) boundary values file for salinity (filetype [[TM2.RBH.BIN.I|tm2.rbh.bin.I]] and filetype [[TM2.RBH.BIN|tm2.rbh.bin]])
# (optional) boundary values for meteorology (BDF-format) (filetype [[DIRZ.BIN.I|dirz.bin.i]]and [[DIRZ.BIN|dirz.bin]])
# (optional) initial conditions from an earlier TELEMAC-2D simulation (filetype [[SELAFIN|selafin]])

|outputfiles=
# binary results file (filetype [[SELAFIN|selafin]])
# protocol of program execution (filetype cas_process.sortie)
# results for the model area, on profiles and at points of interest (filetype [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]]and [[DIRZ.BIN|dirz.bin]]) with modified topographies (filetype [[GITTER05.DAT and GITTER05.BIN|gitter05.dat/bin]], [[PROFIL05.BIN|profil05.bin]] and [[LOCATION_GRID.DAT|location_grid.dat]]) )
|methodology=See "TELEMAC-2D Modelling System, Principal Note"
|preprocessor=[[METDIDA]], [[TICLQ2]], [[TM2RND]], [[JANET]]
|postprocessor=[[ANALTEL2D]], [[ABDF]], [[DIDAMERGE]], [[DIDAMINTQ]], [[DIDAMINTZ]], [[DIDARENAME]], [[DIDASPLIT]], [[ENERF]], [[GRIDCONVERT]], [[GVIEW2D]], [[HVIEW2D]], [[IO_VOLUME]], [[LQ2PRO]], [[PARTRACE]], [[PGCALC]], [[TM2DIDA]], [[VTDK]], [[VVIEW2D]], [[XTRDATA]], [[ZEITR]]
|language=Fortran90
|add_software=-
|contact_original=Laboratoire National d'Hydraulique der [http://www.edf.fr/edf-fr-accueil-1.html EDF-DER], Chatou-Paris
|contact_maintenance=[mailto:sim.proghome@baw.de Working Group SIM]
|documentation=TELEMAC-2D Modelling System - Users Manual 
$PROGHOME/examples/telemac2d/ 
$PROGHOME/fortran/systel/Telemac-Dokumentation/tele2d/index.htm
}}

PROPTEL

2022-12-12T10:12:19Z

Ak3bfric:

{{ProgramDescription
|name_de=PROPTEL
|name=PROPTEL
|version=1.x / November 2011
|version_descr=November 2011
|catchwords=
oprerationelles Modell, Tideelbemodell 
|shortdescription=
PROPTEL ist eine operationelles Model zur Wasserstands- und Strömungs- und Temperaturs- und Salztransportvorhersage
in den Nordseeästuare, das auch bei extremen Ereignissen wie Sturmfluten, Sturmebben, schnell ansteigenden
Oberwasserzuflüssen und sehr niedrigen Wasserständen zuverlässige Vorhersagen liefert. Das im
BAW-Vorhersagemodell-Elbe verwendet zur Zeit [[UNTRIM2007|untrim2007]] als Kern für die Lösung der Hydrodynamischen
und Transport Gleichungen. Die Randwerte des atmosphärischen Antriebe werden vom Preprozessor [[PREMETEO|PREMETEO]]
vorbereitet. Am offenen Rand wird das Modell mit Daten vom Preprozessor [[PREHYDRO|PREHYDRO]] gesteurt. Der
Oberwasserzufluss wird asu gemessene Daten gelesen.
|inputfiles=
allgemeine''' Eingabedaten''': Datei des Typs '''proptel.inp'''. Diese Steuerdatei ist ein fortran NAMELIST und enthält die
Namen der von [[PREHYDRO|PREHYDRO]] und [[PREMETEO|PREMETEO]] bereitgestellten Dateien sowie deren Zeitliche Auflösung.
|outputfiles=
# BDF-Dateien für Wasserstand, Strömung, Salsgehalt und Temperatur.
# ASCII-Datei für den Wasserstand an vorab definierte Einzelpositionnen (Pegel) zum Vergleich mit Messungen.
# Druckerdatei mit Informationen zum Programmablauf (Datei des Typs proptel.master.sdr).
|methodology=
Das Model lauft grundsächlich wie untrim2007. Für ein Dauerbetrieb im operationellen-Mode wird das Model von einem cronjob
gestartet. Es wird ersrt nach neuen verfügbaren Datein gesucht die die Modelle BSHcmod und COSMO-EU erzeugt haben. Falls
Sie vorhanden sind werden die beoden Preprozessoren [[PREHYDRO|PREHYDRO]] und [[PREMETEO|PREMETEO]] gestartet um
Daten für Untrim vorzubereiten. Im nachhinein werden Skripte für den Update der Steudateien utromp2007.dat, untrim2007.dat und
proptel.inp gestartet. Untrim2007 startet dann einen neuen Lauf für die Vorhersage der nächsten 24 Stunden.
|preprocessor=
[[PREHYDRO|PREHYDRO]], [[PREMETEO|PREMETEO]]
|postprocessor=
[[ABDF]], [[BATCHPLOT]], [[DIDAMINTQ]], [[GVIEW2D]], [[HVIEW2D]], [[UNTRIM2007MONITOR]], [[VTDK]], [[VVIEW2D]], [[XTRLQ2]], [[ZEITR]]
|language=Fortran95
|add_software=ProgHome
|contact_original=[mailto:aissa.sehili@baw.de A. Sehili]
|contact_maintenance=[mailto:sim.proghome@baw.de Working Group SIM]
|documentation=Musterdateien finden sich in $PROGHOME/examples/premeteo/
}}