Actions

UNTRIM HYD.DAT

From BAWiki

Basic Information

File-Type

untrim_hyd.dat

Version

7.x / July 2003

Description-Date

November 2003

Significance of the File

contains specific input data related to the physical subsystem Hydrodynamics, Salt-, Temperature- and Suspended-Sediment-Transport of program UNTRIM.

File-Contents (in Catchwords)

  1. model type for calculation or provison of hydrodynamics as well as salt and or temperature transport the following methods are possible:
    1. No_Hydrodynamic_Model
     ;
    2. Read_Hydrodynamic_Data_From_File
     ;
    3. Untrim_Hydrodynamic_Model
     : the three-dimensional numerical model UNTRIM will be applied.
  2. existing files for hydrodynamics, salinity, temperature and suspended load when method Read_Hydrodynamic_Data_From_File was selected.
  3. times, if the global default values which have been specified in a file of type untrim_main.dat shall be replaced by the values specified for this physical submodel; the following specifications are possible:
    • control of simulation (period and time step);
    • area-/volume oriented output of results;
    • profile oriented output of results;
    • output for specific locations;
    • output of restart data.
  4. name and type of different input files; the following specifications are possible:
    • file with horizontal grid (filetype untrim_grid.dat);
    • file with vertical grid structure, which specifies the boundaries between vertical layers (filetype vertical.dat);
    • (optional) file with profile topography (filetype profil05.bin);
    • (optional) file with a list of specific locations (filetype location.dat);
    • (optional) initial condition for hydrodynamics, salinity, temperature and suspended load (filetype dirz.bin.r, dirz.bin.i and dirz.bin); in addition to the name of the file also date and time for the initial condition must be prescribed.
    Notice: for a three-dimensional simulation the results of a previous two-dimensional simulation can be used too.
    • (optional) alternative initial condition for salinity (filetype dirz.bin.r, dirz.bin.i and dirz.bin); in addition to the name of the file also date and time for the initial condition must be prescribed.
    Notice: for a three-dimensional simulation the results of a previous two-dimensional simulation can be used too.
    • (optional) alternative initial condition for temperature (filetype dirz.bin.r, dirz.bin.i and dirz.bin); in addition to the name of the file also date and time for the initial condition must be prescribed.
    Notice: for a three-dimensional simulation the results of a previous two-dimensional simulation can be used too.
    • (optional) alternative initial condition for suspended load (filetype dirz.bin.r, dirz.bin.i and dirz.bin); in addition to the name of the file also date and time for the initial condition must be prescribed.
    Notice: for a three-dimensional simulation the results of a previous two-dimensional simulation can be used too.
    • (optional) description of soil identification numbers (filetype soil.dat);
  5. name and type of different boundary data files;
    Notice: aforementioned files may be generated using program UTRRND.
  6. name and type of different output files; the following specifications are possible:
    • area oriented output of computed results (two-dimensional) in the overall model domain or in a tile (each of the subsequent files can be optionally specified):
    • volume oriented output of computed results (three-dimensional) in the overall model domain or in a tile (each of the subsequent files can be optionally specified):
    • (optional) output along profiles of computed results (depth-averaged data) along selected predefined profiles:
    • water level elevation,
    • depth averaged current velocity,
    • depth averaged salinity,
    • depth averaged temperature,
    • depth averaged suspended load,
    • depth averaged density,
    • depth averaged hydrodynamic pressure and
    • depth averaged vertical viscosity.
    • bottom shear stress
    (filetype dirz.bin.r, dirz.bin.i and dirz.bin);
    Notice: These files will be initialized with standard values immediately after opening.
    • (optional) output along profiles of computed results (three-dimensional data) along selected predefined profiles:
    • current velocity,
    • salinity,
    • temperature,
    • suspended load,
    • density,
    • hydrodynamic pressure and
    • vertical viscosity.
    (filetype dirz.bin.r, dirz.bin.i and dirz.bin);
    Notice: These files will be initialized with standard values immediately after opening.
    • (optional) output of results for specific locations, i.e. for water level elevation and depth averaged data:
    • water level elevation,
    • depth averaged current velocity,
    • depth averaged salinity,
    • depth averaged temperature,
    • depth averaged suspended load,
    • depth averaged density,
    • depth averaged hydrodynamic pressure and
    • depth averaged vertical viscosity.
    • bottom shear stress
    (filetype dirz.bin.r, dirz.bin.i and dirz.bin).
    Notice: Files contain synoptic data sets. Time series informations for specific locations can be obtained applying the program ZEITR on these data; These files will be initialized with standard values immediately after opening.
    • (optional) output of results for specific locations, i.e. for three-dimensional data:
    • current velocity,
    • salinity,
    • temperature,
    • suspended load,
    • density,
    • hydrodynamic pressure and
    • vertical viscosity.
    (filetype dirz.bin.r, dirz.bin.i and dirz.bin).
    Notice: Files contain synoptic data sets. Time series informations for specific locations can be obtained applying the program ZEITR on these data; These files will be initialized with standard values immediately after opening.
    • (optional) restart-data for hydrodynamics, salinity, temperature and suspended load (filetype dirz.bin.r, dirz.bin.i and dirz.bin). Notice: these files contain consistent synoptic data sets for the staggered computational grid and can therefore be used as initial conditions for a subsequent simulation; because they are defined on a staggered grid they cannot be used in conventional postprocessing programs.
  7. specifications for horizontal grid geometry control:
    • minimum distance between centers of elements which are adjacent to one edge.
  8. salt transport scheme:
    • no salt transport, and
    • simulate transport of salt.
  9. temperature transport scheme:
    • no temperature transport, and
    • simulate transport of temperature.
  10. suspended load transport scheme:
    • no suspended load transport, and
    • simulate transport of suspended load.
  11. approximation of pressure:
    • non-hydrostatic pressure, and
    • hydrodynamic pressure.
  12. approximation for horizontal viscosity/diffusivity
    • no horizontal exchange, and
    • constant (isotropic) horizontal exchange.
  13. approximation for vertical viscosity/diffusivity
    • no vertical exchange,
    • constant vertical exchange, and
    • k-eps equlibrium model, Rodi (1984).
  14. approximation for Coriolis-acceleration
    • no Coriolis acceleration, and
    • constant Coriolis acceleration (f-plane approximation).
  15. approximation for wall friction
    • free slip,
    • partial slip, and
    • no slip.
  16. flux limiter for scalar transport:
    • no flux limiter
    • Minmod
    • van Leer
    • Superbee

Notice:

  • dictionary-file hyd_untrim_dico.dat, normally present in directory $PROGHOME/dic/, will be automatically read by the application program in addition to the user-specified input file.
  • furthermore the following configuration files stored in the directory $PROGHOME/cfg/ are eventually automatically read by the program:
  • all_2d_water_level.dat
  • all_2d_velocity.dat
  • all_2d_salinity.dat
  • all_2d_temperature.dat
  • all_2d_suspended_load.dat
  • all_3d_velocity.dat
  • all_3d_salinity.dat
  • all_3d_temperature.dat
  • all_3d_suspended_load.dat
  • all_restart.dat
  • locations_2d.dat
  • locations_3d.dat
  • profiles_2d.dat
  • porfiles_3d.dat

Programs using this Type of File

UNTRIM

Additional Information

Language

Fortran90

File-Form

FORMATTED

File-Access

SEQUENTIAL

File-Extension

.dat

WRITE-Subroutine(s)/Module(s)

interactive generation, editor

READ-Subroutine(s)/Module(s)

mod_hyd_dico.f90

Original Version

G. Lang

Maintenance

G. Lang, H. Weilbeer, E. Rudolph

Example-File

please refer to $PROGHOME/examples/untrim/untrim_hyd.dat


back to: File Descriptions


Overview