Actions

UNTRIM2.DAT

From BAWiki

Basic Information

File-Type

untrim2.dat

Version

December 2018

Description-Date

December 2018

Significance of the File

contains general input data for the program UNTRIM2, sub grid technology

File-Contents (in Catchwords)

Input Steering Data

  • general input data (block Program_Parameters)
    • key "Dry_Limit" : minimum water depth; dummy variable, not used.
    • key "Language" : language selection.
      • DE: German.
      • EN: English.
    • key "Morphodynamics" : morphodynamic bathymetry.
      • .false.: use static, time independent bathymetry in all model components.
      • .true.: use dynamic, time varying bathymetry in all model components. Do not use, not implemented yet.
    • key "Comment" : comment for a short description of the simulation.
    • key "Simulation_Period" period of model simulation.
      • start of simulation period,
      • end of simulation period, and
      • numerical time step.
    The simulation period must be an integer multiple of the numerical time step.
    • key "Array_Output_Period" period of data output for the full model domain.
      • start of data output,
      • end of data output, and
      • interval between two subsequent write operations.
    The length of the period of data output must be an integer multiple of the data output interval. All write operations must coincide with simulation time steps.
    • key "Profile_Output_Period" period of data output for longitudinal and cross sectional profiles.
      • start of data output,
      • end of data output, and
      • interval between two subsequent write operations.
    The length of the period of data output must be an integer multiple of the data output interval. All write operations must coincide with simulation time steps.
    • key "Location_Output_Period" period of data output for specific locations.
      • start of data output,
      • end of data output, and
      • interval between two subsequent write operations.
    The length of the period of data output must be an integer multiple of the data output interval. All write operations must coincide with simulation time steps.
    • key "Restart_Output_Period" period of data output for restart data.
      • start of data output,
      • end of data output, and
      • interval between two subsequent write operations.
    The length of the period of data output must be an integer multiple of the data output interval. All write operations must coincide with simulation time steps.
    • (optional) key "Array_Output_Period_NetCDF_3D" period of data output for the full model domain, NetCDF 3D only.
      • start of data output,
      • end of data output, and
      • interval between two subsequent write operations.
    The length of the period of data output must be an integer multiple of the data output interval. All write operations must coincide with simulation time steps.
    • (optional) key "WAQ_Output_Period" period of data output for the input files of the water quality model DelWAQ.
      • start of data output,
      • end of data output, and
      • interval between two subsequent write operations.
    The length of the period of data output must be an integer multiple of the data output interval. All write operations must coincide with simulation time steps.
  • package related input steering data (block Package_Steering_Files).
    • key "UNTRIM2009_Steering_File" : input data for package UTROMP2009, to steer the computational core of UNTRIM2 (filetype utromp2.dat).
    • (optional) key "EQS_Steering_File" : input data for package EQS, to steer computation of water density using different equations of state (filetype untrim_eqs.dat). In case this key is not specified, standard methods from package UTROMP2009 will be used to compute water density.
    • (optional) key "MIX_Steering_File" : input data for package MIX, to steer turbulence modelling using various mixing length models (filetype mix_untrim.dat). In case this key is not specified, standard methods from package UTROMP2009 will be used to compute turbulence.
    • (optional) key "SV_Steering_File" : input data for package SV, to steer computation of settling velocity for suspended sediments by use of different parameterizations (filetype sv.dat). In case this key is not specified, standard methods from package UTROMP2009 will be used to compute settling velocity of suspended sediments.
    • (optional) key "SM_Steering_File" : input data for package SediMorph, to steer the computation of bottom friction parameter, bedload transport, erosion of suspended sediments, as well as morphodynamic changes of bottom bathymetry (filetype sedimorph.dat). In case this key is not specified, standard methods from package UTROMP2009 will be used to compute the aforementioned quantities.
      Notice: currently only implemented for use with bottom friction parameter.
    • (optional) key "DS_Steering_File" : input data for package DredgeSim, to steer the computation of dredging and disposal (filetype dredgesim.dat). In case this key is not specified, the before mentioned processes are neglected. Functionality is only available in combination with package SediMorph.
      Notice: do not use, not implemented yet.
    • (optional) key "KM_Steering_File" : input data for package K-Model, to steer the computation of short waves (filetype k_model.dat). In case this key is not specified, short waves are neglected.

General Remarks

  1. While reading this steering data file the dictionary file untrim2009_main_dico.dat will be automatically accessed in directory $PROGHOME/dic/ to support input.

Programs using this Type of File

UNTRIM2

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_m_untrim2009_steer.f90

Original Version

G. Lang

Maintenance

E. Rudolph, A. Sehili, H. Weilbeer

Example-File

please refer to $PROGHOME/examples/untrim2009/untrim2009.dat


back to: File Descriptions


Overview