UNK.DAT: Difference between revisions
From BAWiki
imported>Lang Guenther (water level, current velocity and bathymtrey can be also imported from NETCDF file(s)) |
Günther Lang (talk | contribs) (Reference to ISO 8601 for the file untrim_grid.dat) |
||
(3 intermediate revisions by one other user not shown) | |||
Line 2: | Line 2: | ||
|name_de=UNK.DAT | |name_de=UNK.DAT | ||
|filetype=unk.dat | |filetype=unk.dat | ||
|version= | |version=January 2020 | ||
|version_descr= | |version_descr=January 2020 | ||
|significance=contains specific input data related to the post processor program UnK (unstructured k-model). | |significance=contains specific input data related to the post processor program UnK (unstructured k-model). | ||
|filecontents= | |filecontents= | ||
# block '''Input_Files''', with different information concerning required as well as optional input files: | # block '''Input_Files''', with different information concerning required as well as optional input files: | ||
## key "'''Grid_File'''" with name and type ('''GITTER05''', '''UNTRIM_BAW''') for the file with the '''computational grid''' (filetype [[UNTRIM_GRID.DAT|untrim_grid.dat]] or [[GITTER05.DAT und GITTER05.BIN|gitter05.dat/bin]]). | ## key "'''Grid_File'''" with name and type ('''GITTER05''', '''UNTRIM_BAW''') for the file with the '''computational grid''' (filetype [[UNTRIM_GRID.DAT|untrim_grid.dat]] or [[GITTER05.DAT und GITTER05.BIN|gitter05.dat/bin]]). For files of the type '''UNTRIM_BAW''', the temporal validity of the (bathymetric) data can be expressed in the file name according to [https://en.wikipedia.org/wiki/ISO_8601 ISO 8601]. Example: untrim_grid_1957-04-23_GMT_P1Y.dat. | ||
## | ## Key "'''Wind_Speed_File'''" with name and type ('''BDF''' or '''NETCDF''') plus a (optional) '''maximum interpolation radius''' in case wind data are defined on an irregular grid for the file with space- and time-dependent '''wind speed''' above the computational domain (filetypes [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]] or [[CF-NETCDF.NC|cf-netcdf.nc]]). Remarks: | ||
##* regular grid data: this file must be created using program [[METDIDA]] or [[UNTRIM2007]]. The grid must be regular, which means that it must possess constant grid size DX in x direction as well as constant grid size DY in y direction. DX and DY may differ. | ##* regular grid data: this file must be created using program [[METDIDA]] or [[UNTRIM2007]]. The grid must be regular, which means that it must possess constant grid size DX in x direction as well as constant grid size DY in y direction. DX and DY may differ. | ||
##* irregular grid data: [[UNK]] automatically converts wind data onto a regular grid. In case no (optional) maximum interpolation radius is prescribed by the user [[UNK]] tries to compute a reasonable one automatically. | ##* irregular grid data: [[UNK]] automatically converts wind data onto a regular grid. In case no (optional) maximum interpolation radius is prescribed by the user [[UNK]] tries to compute a reasonable one automatically. | ||
## Key "'''K_Model_Steering_File'''" mit Name und Typ ('''STEERING''') der Datei mit den '''Eingabesteuerdaten''' für das Softwarepaket '''K_Model''' (Datei des Typs [[K_MODEL.DAT|k_model.dat]]). | ## Key "'''K_Model_Steering_File'''" mit Name und Typ ('''STEERING''') der Datei mit den '''Eingabesteuerdaten''' für das Softwarepaket '''K_Model''' (Datei des Typs [[K_MODEL.DAT|k_model.dat]]). | ||
##: Notice: this file must have been generated beforehand using program [[METDIDA]]. | ##: Notice: this file must have been generated beforehand using program [[METDIDA]]. | ||
## | ## Key "'''K_Model_Steering_File'''" with name and type ('''STEERING''') for the file with '''input data''' of the software package '''k_model''' (filetype [[K_MODEL.DAT|k_model.dat]]). | ||
## (optional) key "'''Water_Level_File'''" with space- and time-dependent '''water level''' within the computational domain.In case '''BDF''' use [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]], or [[CF-NETCDF.NC|cf-netcdf.nc]] ('''NETCDF''') otherwise. | ## (optional) key "'''Water_Level_File'''" with space- and time-dependent '''water level''' within the computational domain.In case '''BDF''' use [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]], or [[CF-NETCDF.NC|cf-netcdf.nc]] ('''NETCDF''') otherwise plus (optional) '''maximum interpolation radius'''. | ||
##: Notice: For case '''BDF''' water level data must be available for the computational grid prescribed in key "'''Grid_File'''". | ##: Notice: For case '''BDF''' water level data must be available for the computational grid prescribed in key "'''Grid_File'''". | ||
## (optional) key "'''Current_Velocity_File'''" with space- and time-dependent depth-averaged '''current velocity''' within the computational domain. In case '''BDF''' use [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]], or [[CF-NETCDF.NC|cf-netcdf.nc]] ('''NETCDF''') otherwise. | ## (optional) key "'''Current_Velocity_File'''" with space- and time-dependent depth-averaged '''current velocity''' within the computational domain. In case '''BDF''' use [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]], or [[CF-NETCDF.NC|cf-netcdf.nc]] ('''NETCDF''') otherwise plus (optional) '''maximum interpolation radius'''. | ||
##: Notice 1: For case '''BDF''' current velocity data must be available for the computational grid prescribed in key "'''Grid_File'''"; | ##: Notice 1: For case '''BDF''' current velocity data must be available for the computational grid prescribed in key "'''Grid_File'''"; | ||
##: Notice 2: For case '''NETCDF''' file must be identical with "'''Water_Level_File'''". | ##: Notice 2: For case '''NETCDF''' file must be identical with "'''Water_Level_File'''". | ||
## (optional) key "'''Bathymetry_Depth_File'''" with alternative or dynamic '''bathymetry depths''' within the computational domain. In case '''BDF''' use [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]], or [[CF-NETCDF.NC|cf-netcdf.nc]] ('''NETCDF''') otherwise. | ## (optional) key "'''Bathymetry_Depth_File'''" with alternative or dynamic '''bathymetry depths''' within the computational domain. In case '''BDF''' use [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]], or [[CF-NETCDF.NC|cf-netcdf.nc]] ('''NETCDF''') otherwise plus (optional) '''maximum interpolation radius'''. | ||
##: Notice 1: For case '''BDF''' bathymetry depth data must be available for the computational grid prescribed in key "'''Grid_File'''". | ##: Notice 1: For case '''BDF''' bathymetry depth data must be available for the computational grid prescribed in key "'''Grid_File'''". | ||
##: Notice 2: For case '''BDF''' the type of bathymetry depths must be consistent with the water level and velocity files; e.g. all files have alternative bathymetry depths; | ##: Notice 2: For case '''BDF''' the type of bathymetry depths must be consistent with the water level and velocity files; e.g. all files have alternative bathymetry depths; |
Latest revision as of 10:06, 13 January 2020
Basic Information
File-Type
unk.dat
File-Form
FORMATTED
Version
January 2020
Description-Date
January 2020
Significance of the File
contains specific input data related to the post processor program UnK (unstructured k-model).
File-Contents (in Catchwords)
- block Input_Files, with different information concerning required as well as optional input files:
- key "Grid_File" with name and type (GITTER05, UNTRIM_BAW) for the file with the computational grid (filetype untrim_grid.dat or gitter05.dat/bin). For files of the type UNTRIM_BAW, the temporal validity of the (bathymetric) data can be expressed in the file name according to ISO 8601. Example: untrim_grid_1957-04-23_GMT_P1Y.dat.
- Key "Wind_Speed_File" with name and type (BDF or NETCDF) plus a (optional) maximum interpolation radius in case wind data are defined on an irregular grid for the file with space- and time-dependent wind speed above the computational domain (filetypes dirz.bin.r, dirz.bin.i and dirz.bin or cf-netcdf.nc). Remarks:
- regular grid data: this file must be created using program METDIDA or UNTRIM2007. The grid must be regular, which means that it must possess constant grid size DX in x direction as well as constant grid size DY in y direction. DX and DY may differ.
- irregular grid data: UNK automatically converts wind data onto a regular grid. In case no (optional) maximum interpolation radius is prescribed by the user UNK tries to compute a reasonable one automatically.
- Key "K_Model_Steering_File" mit Name und Typ (STEERING) der Datei mit den Eingabesteuerdaten für das Softwarepaket K_Model (Datei des Typs k_model.dat).
- Notice: this file must have been generated beforehand using program METDIDA.
- Key "K_Model_Steering_File" with name and type (STEERING) for the file with input data of the software package k_model (filetype k_model.dat).
- (optional) key "Water_Level_File" with space- and time-dependent water level within the computational domain.In case BDF use dirz.bin.r, dirz.bin.i and dirz.bin, or cf-netcdf.nc (NETCDF) otherwise plus (optional) maximum interpolation radius.
- Notice: For case BDF water level data must be available for the computational grid prescribed in key "Grid_File".
- (optional) key "Current_Velocity_File" with space- and time-dependent depth-averaged current velocity within the computational domain. In case BDF use dirz.bin.r, dirz.bin.i and dirz.bin, or cf-netcdf.nc (NETCDF) otherwise plus (optional) maximum interpolation radius.
- Notice 1: For case BDF current velocity data must be available for the computational grid prescribed in key "Grid_File";
- Notice 2: For case NETCDF file must be identical with "Water_Level_File".
- (optional) key "Bathymetry_Depth_File" with alternative or dynamic bathymetry depths within the computational domain. In case BDF use dirz.bin.r, dirz.bin.i and dirz.bin, or cf-netcdf.nc (NETCDF) otherwise plus (optional) maximum interpolation radius.
- Notice 1: For case BDF bathymetry depth data must be available for the computational grid prescribed in key "Grid_File".
- Notice 2: For case BDF the type of bathymetry depths must be consistent with the water level and velocity files; e.g. all files have alternative bathymetry depths;
- Notice 2: For case NETCDF file must be identical with "Water_Level_File".
- block Simulation_Times with information for the simulation period:
- key "Start_Time" with start time given as DD.MM.YYYY-hh:mm:ss.nnnnnnnnn.
- key "End_Time" with end time given as DD.MM.YYYY-hh:mm:ss.nnnnnnnnn.
Notice:
- dictionary-file unk_dico.dat, usually present in directory $PROGHOME/dic/, will be automatically read by the application program in addition to the user-specified input file.
Programs using this Type of File
Example-File
please refer to $PROGHOME/examples/unk/unk.dat
and $PROGHOME/examples/unk/BSP_dynamic_bathymetry/unk.10min.dat
back to: File Descriptions