View source for UNTRIM

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