Actions

DATACONVERT: Difference between revisions

From BAWiki

imported>BAWiki 3
No edit summary
(working group POS)
 
(69 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{FileDescription
{{ProgramDescription
|name_de=DATACONVERT.DAT
|name_de=DATACONVERT
|filetype=dataconvert.dat
|name=DATACONVERT
|version=6.x / December 2009
|version=August 2020
|version_descr=December 2009
|version_descr=September 2022
|significance=Contains various input steering data for the postprocessor DATACONVERT
|catchwords=conversion of Delft3D computational grid<br />
|filecontents=
conversion of Delft3D computational results<br />
Contains various input steering data, which are required during conversion of computational results for the integrated modelling system Delft3D. Original data are stored in NetCDF data files and are going to be converted and written to BAW-specific BDF data files.
conversion of (DWD) NetCDF data files<br />
merge of (DWD) NetCDF data files in one NetCDF file<br />
conversion of BDF data into CF NetCDF data <br />
conversion of meteorological data into the Delft3D format METEO_DLFT <br />
conversion of timeseries in BOEWRT format into CF NetCDF data (with optional [[BOEWRT.DAT#Status-Flag_Variable|status flag variable]])<br />
conversion of CF SGRID NetCDF into CF UGRID NetCDF<br />


    * informations related to output files (block Output_Information)
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/]).''
        1. file to store converted depth averaged (2D-) computational results (filetype dirz.bin.R, dirz.bin.I and dirz.bin).
            Notice: data for multiple computational domains are going to be gathered and stored in this file.
        2. file to store the converted computational grid (filetype untrim_grid.dat).
            Notice: computational grid data for multiple computational domains are going to be gathered and stored in this grid file.
        3. (optional) file to store converted depth dependent (3D-) computational results (filetype dirz.bin.R, dirz.bin.I and dirz.bin).
            Notice: data for multiple computational domains are going to be gathered and stored in this file.
        4. (optional) file with description of the vertical layer structure (z-layers), to be used for the converted computational results (filetype vertical.dat).
            Notice: this file must be always specified in situations when three-dimensional data are going to be generated by conversion.
        5. (optional) threshold depth for drying and wetting.
            Notice: the value prescribed shall be not smaller than the one used during the Delft3D simulation.
        6. (optional) start time for data conversion.
            Notice: if not specified the first date contained in the input data will be used.
        7. (optional) end time for data conversion.
            Notice: if not specified the last date contained in the input data will be used.
        8. (optional) time step for data conversion.
            Notice: if not specified all dates contained in the input data will be converted.
        9. (optional) maximum increase of depth during a morphodynamic simulation. Depth at all grid points is increased by this amount to cover depth variation due to morphodynamics within a z-layered (vertical) grid. Exception: depths at (protected) structures will not be altered.
            Notice: if this parameter is not prescribed all depth values will remain unchanged.
        10. (optional) steering parameter for the method chosen to compute initial depth values at grid points. Depths can be computed from values prescribed in grid files or in computational result files.
            Notice: if this parameter is not prescribed, depth values are derived from grid data only.
        11. (optional) steering parameter for type of method used to compute depth values for new edges inserted during the grid refinement process. Method can be either MEAN, MAX or MIN.
            Notice: if this parameter is missing, method MEAN will be used.
        12. (optional) steering parameter for rounding of time and date information (digits for nanoseconds). The number of digits for nanoseconds (0 - 9) has to be prescribed. In case 0 (zero) is prescribed, no digits for nanoseconds are taken into account and all internal time and date items are rounded to seconds.
            Notice: if this parameter is not specified, no time and date item will be subject to rounding (full accuracy).
    * informations related to input files (block Input_Files).
      Notice: this block can be specified several times, i. e. one time for each computational domain.
        1. name of NetCDF-file which contains the computational results from Delft3D going to be converted (filetype netcdf.cdf; Notice: has to be specified only once per computational domain), plus (optional) code numbers for the converted physical quantities (Notice: in case code numbers are not specified, all quantities which are feasible for conversion are going to be converted automatically).
        2. name of file which contains the computational grid going to be converted (filetype delft3d.grd).
            Additionally the following files of type delft3d.dep and delft3d.enc must be present in the working directory.
            Optionally files of type delft3d.dry, delft3d.thd, delft3d.lwl, delft3d.ext as well as delft3d.bnd may be present in the working directory.


            Remark 1: Only one file with extension grd per computational domain can be specified. The other (related) files are only allowed to differ with respect to their extension.
|shortdescription=Program DATACONVERT is used to convert computational results and data:
 
* '''mode 1''': conversion of computational results from the integrated modelling system Delft3D into BAW-specific data formats, with<br />
            Remark 2: For each computational domain the converted computational grid as well as the converted computational results are stored in files of type untrim_grid.dat dirz.bin.R, dirz.bin.I and dirz.bin.  
** conversion of a Delft3D computational grid into UnTRIM grid format,
 
** conversion of two-dimensional (depth averaged) Delft3D computational results into BDF data format (2D),
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.  
** conversion and depth averaging of three-dimensional Delft3D computational results into BDF data format (2D), and
|nutzerprogramme=
** conversion of three-dimensional Delft3D computational results (sigma-coordinates) into BDF data format (3D, z-layers).<br />
[[DATACONVERT]]
Dynamic model bathymetry (morphodynamics) is supported for 2D as well as 3D computational results. If Delft3D model results have been produced for a domain decomposition run, the converted results are written to different domain-specific data files and are not yet combined into one single file.<br /><br />
|language=Fortran90
A conversion into the subsequent physical output quantities is currently possible:
|fileform=FORMATTED
# water level,
|fileaccess=SEQUENTIAL
# current velocity,
|fileextension=.dat
# salinity,
|writemodules=editor
# temperature,
|readmodules=$PROGHOME/fortran/prg/dataconvert/*/mod_m_dataconvert_steu.f90
# bathymetry (static),
|contact_original=[mailto:guenther.lang@baw.de G. Lang]
# transient bathymetric depth,
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
# vertical erosion,
|examplefile=please refer to '''$PROGHOME/examples/dataconvert/'''
# suspended load (icode=7),
# ''new'': (mass) bed load transport rate (icode=621), converted from a volume transport rate,
# ''new'': (mass) suspended load transport rate (icode=622), converted from a volume transport rate and
# ''new'': bottom shear stress
* '''mode 2''': conversion of (DWD) NetCDF data files into BAW-specific data formats, with
** generation of a grid from data points defined in the NetCDF data file, and
** conversion of NetCDF data into BAWs BDF file format.<br />
* '''mode 3''': merge contents of several (DWD) NetCDF data files into a single NetCDF data file, with
** transfer of meta data as well as data for identical dates into a single NetCDF data file.
* '''mode 4''': conversion of [[DIRZ.BIN|BDF]] data into [[CF-NETCDF.NC|cf-netcdf.nc]] data, for
** [[NetCDF synoptic data at multiple locations|synoptic data at multiple locations]].
** [[NetCDF synoptic data for triangular grid|synoptic data for triangular grid]].
** [[NetCDF synoptic (morphological) data for triangular grid|synoptic (morphological) data for triangular grid]].
** [[NetCDF synoptic data for unstructured grid|synoptic data for unstructured grid]].
** [[NetCDF synoptic data for multiple profiles|synoptic data for multiple profiles]].
* '''mode 6''': conversion of meteorological data into Delft3D format METEO_DLFT.
* '''mode 7''': conversion of timeseries and meta information in [[BOEWRT.DAT|BOEWRT format]] into [[CF-NETCDF.NC|cf-netcdf.nc]] data according to NODC's [http://www.nodc.noaa.gov/data/formats/netcdf/#templatesexamples feature type template for timeSeries]. Creation of optional [[BOEWRT.DAT#Status-Flag_Variable|status flag variable]] for description of data quality is supported.
* '''mode 8''': conversion of CF SGRID NetCDF into CF UGRID NetCDF (see [[CF-NETCDF.NC|cf-netcdf.nc]]).
|inputfiles=
# '''steering data'''
#: file of type [[DATACONVERT.DAT|dataconvert.dat]]. The extended description for this file contains comprehensive informations with respect to steering data, input as well as output data files.
# '''computational grid'''
#* '''mode 1'''
#**[[DELFT3D.GRD|delft3d.grd]],
#**[[DELFT3D.DEP|delft3d.dep]], and
#**[[DELFT3D.ENC|delft3d.enc]].
#**(optional) [[DELFT3D.DRY|delft3d.dry]],
#**(optional) [[DELFT3D.THD|delft3d.thd]],
#**(optional) [[DELFT3D.LWL|delft3d.lwl]],
#**(optional) [[DELFT3D.EXT|delft3d.ext]], as well as
#**(optional) [[DELFT3D.BND|delft3d.bnd]].
#* '''mode 2''' - no grid file required
#* '''mode 3''' - no grid file required
#* '''mode 4'''
#** [[LOCATION_GRID.DAT|location_grid.dat]] or [[CF-NETCDF.NC|cf-netcdf.nc]] (from [[GRIDCONVERT]]).
#** [[GITTER05.DAT and GITTER05.BIN|gitter05.dat and gitter05.bin]] or [[CF-NETCDF.NC|cf-netcdf.nc]] (from [[GRIDCONVERT]]).
#** [[UNTRIM_GRID.DAT|untrim_grid.dat]] or [[CF-NETCDF.NC|cf-netcdf.nc]] (from [[GRIDCONVERT]]).
#** [[UTRSUB_GRID.DAT|utrsub_grid.dat]] (only with ''false'' subgrid - one subpolygon/polygon, one subedge/edge).
#** [[PROFIL05.BIN|profil05.bin]] or [[CF-NETCDF.NC|cf-netcdf.nc]] (from [[GRIDCONVERT]]).
#* ''' mode 6'''
#** all grid file formats used with BDF data, e. g. [[GITTER05.DAT and GITTER05.BIN|gitter05.dat and gitter05.bin]].
#* '''mode 7''' - no grid file required
#* '''mode 8''' - no grid file required
# '''(optional) global metadata'''
#* [[Metadata_of_Model_results_in_Coastal_Engineering|Setting metadata via shell scripts]], envrionment variables can of a simulation can be set in a run script. Variables describing the project can be stored in a project script (German: Auftragsskript) under $PROGHOME/bin/dmqs. So, DMQS compliant metadata is generated.
#* [[NC_META.DAT|nc_meta.dat]], 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.
# '''computational results or data'''
#* '''mode 1'''
#** [[NETCDF.CDF|netcdf.cdf.]]
#* '''mode 2'''
#** [[NETCDF.CDF|netcdf.cdf.]]
#* '''mode 3'''
#** [[NETCDF.CDF|netcdf.cdf.]]
#* ''' mode 4'''
#** BDF data files [[DIRZ.BIN|dirz.bin]], [[DIRZ.BIN.I|dirz.bin.I]] and [[DIRZ.BIN.R|dirz.bin.R]]
#* '''mode 6'''
#** meteorological BDF files [[DIRZ.BIN|dirz.bin]], [[DIRZ.BIN.I|dirz.bin.I]] and [[DIRZ.BIN.R|dirz.bin.R]].
#* '''mode 7'''
#**time series in [[BOEWRT.DAT|boewrt.dat]].
#* '''mode 8'''
#** [[NETCDF.CDF|netcdf.cdf]] (CF SGRID NetCDF).
#(optional) '''vertical structure'''
#* '''mode 1'''
#** [[ VERTICAL.DAT|vertical.dat.]]
#* '''mode 2''' - no vertical structure required
#* '''mode 3''' - no vertical structure required
#* '''mode 4''' - no vertical structure required
#* '''mode 6''' - no vertical structure required
#* '''mode 7''' - no vertical structure required
#* '''mode 8''' - no vertical structure required
|outputfiles=
# '''converted computational grid'''
#* '''mode 1'''
#** [[UNTRIM_GRID.DAT|untrim_grid.dat.]]
#* '''mode 2'''
#** [[GITTER05.DAT and GITTER05.BIN|gitter05.dat/bin]]
#* '''mode 3''' - no grid generated
#* '''mode 4'''
#** (optional) [[CF-NETCDF.NC|cf-netcdf.nc]]
#* '''mode 6'''
#** implicit regular grid
#* '''mode 7''' - no grid generated
#* '''mode 8''' - no grid generated
# '''converted computational results'''
#* '''mode 1'''
#** [[DIRZ.BIN.R|dirz.bin.r]],
#** [[DIRZ.BIN.I|dirz.bin.i]], and
#** [[DIRZ.BIN|dirz.bin.]]
#* '''mode 2'''
#** [[DIRZ.BIN.R|dirz.bin.r]],
#** [[DIRZ.BIN.I|dirz.bin.i]], and
#** [[DIRZ.BIN|dirz.bin.]]
#* '''mode 3'''
#** [[NETCDF.CDF|netcdf.cdf]].
#* '''mode 4'''
#** [[CF-NETCDF.NC|cf-netcdf.nc]],
#* '''mode 6'''
#** [[METEO_DLFT]]
#* '''mode 7'''
#** [[CF-NETCDF.NC|cf-netcdf.nc]].
#* '''mode 8'''
#** [[CF-NETCDF.NC|cf-netcdf.nc]] (CF UGRID NetCDF).
# '''printer file'''
#* dataconvert.sdr.
# (optional) '''trace file'''
#* dataconvert.trc.
|methodology=The original computational grid is in case converted using methods from software package H_GRID or L_GRID. Interpolation of computational results is performed using methods from the H_IP package. Read and Write of computational data is carried through essentially using methods from software package IO_DATASET and in mode 6 also using IO_DELFT.
|preprocessor=[http://www.baw.de/methoden/index.php5/Mathematisches_Verfahren_DELFT3D DELFT3D], [[GETDATA]], [[GRIDCONVERT]], [[UNTRIM2007]], [[UNTRIM2]], [[XTRLQ2]].
|postprocessor=[[ABDF]], [[ADCP2PROFILE]], [[ArcGIS-Applications]], [[DAVIT]], [[Mathematical_Model_DELFT3D|DELFT3D]], [[DIDAMERGE]], [[DIDARENAME]], [[DIDASPLIT]], [[ENERF]], [[GVIEW2D]], [[HVIEW2D]], [[IO_VOLUME]], [[METDIDA]], [[NCANALYSE]], [[NCAUTO]], [[NCCHUNKIE]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[NCPLOT]], [[NCRCATMAT]], [[NC2TABLE]], [[NCVIEW2D]], [[NetCDF Operators]], [[PARTRACE]], [[PGCALC]], [[PLOTPROFILZEIT]], [[PLOTTS]], [[QUICKPLOT]], [[UNK]], [[UNS]], [[VTDK]], [[XTRDATA]], [[XTRLQ2]], [[ZEITR]].  
|language=Fortran90
|add_software=-
|contact_original=G. Lang, P. Schade
|contact_maintenance=[mailto:pos.proghome@baw.de Arbeitsgruppe POS]
|documentation=for example input files please refer to $PROGHOME/examples/dataconvert/
}}
}}

Latest revision as of 08:50, 6 September 2022

Basic Information

Name of Program

DATACONVERT

Version-Date

August 2020

Description-Date

September 2022

Catchwords

conversion of Delft3D computational grid
conversion of Delft3D computational results
conversion of (DWD) NetCDF data files
merge of (DWD) NetCDF data files in one NetCDF file
conversion of BDF data into CF NetCDF data
conversion of meteorological data into the Delft3D format METEO_DLFT
conversion of timeseries in BOEWRT format into CF NetCDF data (with optional status flag variable)
conversion of CF SGRID NetCDF into CF UGRID NetCDF

Acknowledgment: This project took advantage of netCDF software developed by UCAR/Unidata (www.unidata.ucar.edu/software/netcdf/).

Short Description of Functionality

Program DATACONVERT is used to convert computational results and data:

  • mode 1: conversion of computational results from the integrated modelling system Delft3D into BAW-specific data formats, with
    • conversion of a Delft3D computational grid into UnTRIM grid format,
    • conversion of two-dimensional (depth averaged) Delft3D computational results into BDF data format (2D),
    • conversion and depth averaging of three-dimensional Delft3D computational results into BDF data format (2D), and
    • conversion of three-dimensional Delft3D computational results (sigma-coordinates) into BDF data format (3D, z-layers).

Dynamic model bathymetry (morphodynamics) is supported for 2D as well as 3D computational results. If Delft3D model results have been produced for a domain decomposition run, the converted results are written to different domain-specific data files and are not yet combined into one single file.

A conversion into the subsequent physical output quantities is currently possible:

  1. water level,
  2. current velocity,
  3. salinity,
  4. temperature,
  5. bathymetry (static),
  6. transient bathymetric depth,
  7. vertical erosion,
  8. suspended load (icode=7),
  9. new: (mass) bed load transport rate (icode=621), converted from a volume transport rate,
  10. new: (mass) suspended load transport rate (icode=622), converted from a volume transport rate and
  11. new: bottom shear stress

Input-Files

  1. steering data
    file of type dataconvert.dat. The extended description for this file contains comprehensive informations with respect to steering data, input as well as output data files.
  2. computational grid
  3. (optional) global metadata
    • Setting metadata via shell scripts, envrionment variables can of a simulation can be set in a run script. Variables describing the project can be stored in a project script (German: Auftragsskript) under $PROGHOME/bin/dmqs. So, DMQS compliant metadata is generated.
    • nc_meta.dat, 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.
  4. computational results or data
  5. (optional) vertical structure
    • mode 1
    • mode 2 - no vertical structure required
    • mode 3 - no vertical structure required
    • mode 4 - no vertical structure required
    • mode 6 - no vertical structure required
    • mode 7 - no vertical structure required
    • mode 8 - no vertical structure required

Output-Files

  1. converted computational grid
  2. converted computational results
  3. printer file
    • dataconvert.sdr.
  4. (optional) trace file
    • dataconvert.trc.

Methodology

The original computational grid is in case converted using methods from software package H_GRID or L_GRID. Interpolation of computational results is performed using methods from the H_IP package. Read and Write of computational data is carried through essentially using methods from software package IO_DATASET and in mode 6 also using IO_DELFT.

Program(s) to run before this Program

DELFT3D, GETDATA, GRIDCONVERT, UNTRIM2007, UNTRIM2, XTRLQ2.

Program(s) to run after this Program

ABDF, ADCP2PROFILE, ArcGIS-Applications, DAVIT, DELFT3D, DIDAMERGE, DIDARENAME, DIDASPLIT, ENERF, GVIEW2D, HVIEW2D, IO_VOLUME, METDIDA, NCANALYSE, NCAUTO, NCCHUNKIE, NCDELTA, NCDVAR, NCMERGE, NCPLOT, NCRCATMAT, NC2TABLE, NCVIEW2D, NetCDF Operators, PARTRACE, PGCALC, PLOTPROFILZEIT, PLOTTS, QUICKPLOT, UNK, UNS, VTDK, XTRDATA, XTRLQ2, ZEITR.

Additional Information

Language

Fortran90

Additional software

-

Original Version

G. Lang, P. Schade

Maintenance

Arbeitsgruppe POS

Documentation/Literature

for example input files please refer to $PROGHOME/examples/dataconvert/


back to Program Descriptions


Overview