BAWiki - User contributions [en]

NCCHUNKIE

2022-11-07T08:04:51Z

Ak3glang: somelinks to IZW-Campus were updated

{{ProgramDescription
|name_de=NCCHUNKIE
|name=NCCHUNKIE
|version=April 2022
|version_descr=September 2022
|catchwords=
data conversion 
postprocessor 
automatic adjustment of number of data READ to chunk size of input data 
automatic computation of chunk sizes for result variables to support orthogonal data access 
parrallelization (''collective'' IO) using [http://de.wikipedia.org/wiki/Message_Passing_Interface MPI] 

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/]).''

|shortdescription=
Program NCCHUNKIE can be used to chunk data stored in [[CF-NETCDF.NC|cf-netcdf.nc]] files:
# Chunk sizes are computed automatically, and all dimensions are chunked to support orthogonal data access;
# Resulting chunks sizes lie somewhere between ''Disc Block Size'' and ''Chunk Buffer Size'';
# Online compression is used during storage of data (low level of compression used, level 1);
# A netCDF-4 file is created (serial version creates NetCDF4 ''classic model format'');
# Parameters ''cache size'' and ''cache nelems'' used within netCDF-4 API are automatically determined.

Just in case '''HDF error''' is detected during read of a data record, the program tries to reconstruct the wanted data set from adjacent (in time) records for the same variable. This type of repair works for time dependent variables only.

|inputfiles=
# No input steering data file required (parameters in command line or interactive specification);
# '''UGRID CF NetCDF data set''' (file type [[CF-NETCDF.NC]]).

|outputfiles=
# '''UGRID CF NetCDF data set''' (file type [[CF-NETCDF.NC]]);
# informative '''printer file''' of program execution (file type NCCHUNKIE.sdr) with informations related to program execution, required time for READ and WRITE of data, effective data transfer rates.
# '''trace''' of program execution (file type NCCHUNKIE.trc)

|methodology=
Some concepts published in [https://support.hdfgroup.org/pubs/papers/2008-06_netcdf4_perf_report.pdf https://support.hdfgroup.org/pubs/papers/2008-06_netcdf4_perf_report.pdf] were used.

|preprocessor=[[DATACONVERT]], [[GRIDCONVERT]], [[NCANALYSE]], [[NCAGGREGATE]], [[NCCUTOUT]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[NetCDF Operators]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=[[NCANALYSE]], [[NCAGGREGATE]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NC2TABLE]], [[NetCDF Operators]]
|language=Fortran95
|add_software=---
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
* [https://izw-campus.baw.de/ ''IZW-Campus''] (Podcast, available in German only)
** 2020-11-02: [https://izw-campus.baw.de/goto.php?target=cat_1832&client_id=iliasclient ''Chunking und NCCHUNKIE''];
** 2019-08-02: [https://izw-campus.baw.de/goto.php?target=cat_1831&client_id=iliasclient ''Anmerkungen zur Chunked I/O mit NetCDF-4 / HDF5''].
* Template file(s):
** No template files available.
}}

NCAGGREGATE

2022-11-07T08:01:22Z

Ak3glang: somelinks to IZW-Campus were updated

{{ProgramDescription
|name_de=NCAGGREGATE
|name=NCAGGREGATE
|version=July 2022
|version_descr=September 2022
|catchwords=
data analysis 
postprocessor 
synoptic data sets 
[[Analysis_of_Calculated_Results#Tidal_Characteristic_Numbers|tidal characteristic numbers]] 
[[Analysis_of_Calculated_Results#Characteristic_Numbers_.28independent_of_the_presence_of_tides.29|tide-independent characteristic numbers]] 
differences for synoptic data sets 
differences for tidal characteristic numbers 
differences for tide-independent characteristic numbers 
[[NetCDF|CF NetCDF]] format for 2D/3D data 
aggregated data for control volumes and exchanges 
orthogonal unstructured grid model 
support of computational results based on sub-grid bathymetry 
parallelization using [http://openmp.org/wp/ OpenMP] 
support of DMQS metadata and variables 
[[NetCDF#Quality assurance using NetCDF attributes|automatic quality assurance (value range)]] 
automatic adjustment of number of data READ to chunk size of input data 
automatic computation of chunk sizes for result variables to support orthogonal data access 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of [https://en.wikipedia.org/wiki/MD5 MD5 hash values] of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
optional use of ''Message Passing Interface'' (MPI, [https://www.mpi-forum.org/ MPI Forum])

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/]).''

|shortdescription=
Program NCAGGRGATE may be useful in different situations which are listed in the following. For each type of application a list of programs (with sequence of execution) is given:
* aggregation of synoptic transport data for control volumes aiming at a precise balance of transports (water volume, salt, etc.): Attention: To get an input file suitable for INSPECT_CONTROL_VOLUMES, the simulation must be performed at least with salt or temperature. Even if you are only interested in the hydrodynamics, NCAGGREGATE also has to aggregate the salt or temperature values. The aggregated synoptic water volume is otherwise not calculated. However, this physical quantity is required for the calculations performed in INSPECT_CONTROL_VOLUMES.
*# [[UNTRIM2007]] or [[UNTRIM2]],
*# NCAGGREGATE,
*# [[INSPECT_CONTROL_VOLUMES]] (check results),
*# [[NCANALYSE]], and
*# [[DISPLAY_CONTROL_VOLUMES]].
* aggregation of synoptic data (water level, current velocity, salinity, etc.) aiming at the reduction of data complexity:
*# [[UNTRIM2007]] or [[UNTRIM2]],
*# NCAGGREGATE, and
*# [[NCPLOT]].
* aggregation of characteristic numbers aiming at the reduction of data complexity:
*# [[UNTRIM2007]] or [[UNTRIM2]],
*# [[NCANALYSE]],
*# [[NCPLOT]] (check characteristic numbers),
*# NCAGGREGATE, and
*# [[NCPLOT]].
* aggregation of differences for characteristic numbers or synoptic data aiming at the reduction of data complexity:
*# [[UNTRIM2007]] or [[UNTRIM2]] (experimentally also for DFlow FM),
*# [[NCANALYSE]] (computation of characteristic numbers),
*# [[NCPLOT]] (check characteristic numbers),
*# [[NCDELTA]],
*# [[NCPLOT]] (check differences),
*# NCAGGREGATE, and
*# [[NCPLOT]].
During aggragation of classical data ''land binary masks'' (LBM) are automatically added to the result file. LBMs are used to describe the distribution of land and water at aggregation time. LBMs therefore empower visualization programs like [[NCPLOT]] to optimally present aggregated data in combination with a meaningful land-water-distribution.

Optionally the user is able to generate percentiles (0.01, 0.05, 0.50, 0.95 and 0.99) as well as probability distributions in addition to those aggregated data which are ''usually'' created. For further advice see [[NCAGGREGATE.DAT|ncaggregate.dat]].

[[File:ncaggregate_patch.png|thumb|'''Picture ''control volumes and exchanges'''''.]]

|inputfiles=
# '''general input data''' (file type [[NCAGGREGATE.DAT|ncaggregate.dat]]);
# file with '''classifications''' for probability distributions (file type [[BOUNDS.CFG.DAT|bounds.cfg.dat]]) Hint: (Recommended) Local configuration file or file from the directory ''$PROGHOME/cfg/''.
# '''synoptic data sets''' (file type [[CF-NETCDF.NC|cf-netcdf.nc]]);
# '''control volumes''' (file type [[IPDS.DAT|ipds.dat]]);
# for [[NetCDF#Automatic quality assurance using NetCDF attributes|automatic quality assurance]] (file type [[BOUNDS.CFG.DAT|bounds_verify.dat]]).

|outputfiles=
# '''data analysis result files''' (file type [[CF-NETCDF.NC|cf-netcdf.nc]]); see ''[[NetCDF aggregation for unstructured grids]]'' for details about the aggregational grid.
# (optional) informative '''printer file''' of program execution (file type ncaggregate.sdr)
# (optional) '''trace''' of program execution (file type ncaggregate.trc)

|methodology=
Physical data, suitable for aggregation, are collected for different control volumes as well as exchanges between adjacent control volumes.

Just in case '''HDF error''' is detected during read of a data record, the program tries to reconstruct the wanted data set from adjacent (in time) records for the same variable. This type of repair works for time dependent variables only.

|preprocessor=[[NCANALYSE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[UNTRIM2007]], [[UNTRIM2]], [[INSEL2IPDS]]
|postprocessor=[[DAVIT]], [[INSPECT_CONTROL_VOLUMES]], [[NCANALYSE]], [[NCAUTO]], [[NCCHUNKIE]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[NCPLOT]], [[NC2TABLE]], [[PLOTPROFILZEIT]]
|language=Fortran95
|add_software=---
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
* Presentations (available in German only):
** 2014-03-12: [http://ewisa.baw.de/files/09206_tv12_2014_03_12_aggregation_g_lang.pdf ''Aggregation von Daten''].
* [https://izw-campus.baw.de/ ''IZW-Campus''] (Podcast, available in German only)
**2020-12-07: [https://izw-campus.baw.de/goto.php?target=cat_1830&client_id=iliasclient ''Aggregation und NCAGGREGATE''].
* Template Files:
** template files available in '''$PROGHOME/examples/ncaggregate'''
}}

NCANALYSE

2022-11-07T07:58:08Z

Ak3glang: bracket added

{{ProgramDescription
|name_de=NCANALYSE
|name=NCANALYSE
|version=March 2022
|version_descr=September 2022
|catchwords=
data analysis 
postprocessor 
synoptic data sets 
measured time series data (optionally with [http://cfconventions.org/Data/cf-conventions/cf-conventions-1.6/build/cf-conventions.html#flags flag variables] for a more detailed qualification of data) 
depth averaged (2D) and depth structured data (3D) with z-layers 
[[Tidal Characteristic Numbers of Water Level|tidal characteristic numbers of water level]] 
[[Tidal Characteristic Numbers of Current|tidal characteristic numbers of current]], [[Tidal Characteristic Numbers of Water Transport|tidal characteristic numbers of water transport]] 
[[Tidal Characteristic Numbers of Salinity|tidal characteristic numbers of salinity]], [[Tidal Characteristic Numbers of Salt Transport|tidal characteristic numbers of salt transport]] 
[[Tidal Characteristic Numbers of Temperature|tidal characteristic numbers of temperature]], [[Tidal Characteristic Numbers of Heat Transport|tidal characteristic numbers of heat transport]] 
[[Tidal Characteristic Numbers of Suspended Sediment Transport|tidal characteristic numbers of suspended sediment]],
[[Tidal Characteristic Numbers of Suspended Load Transport|tidal characteristic numbers of suspended load transport]] 
[[Tidal Characteristic Numbers of Tracer Load|tidal characteristic numbers of tracer load]], [[Tidal Characteristic Numbers of Tracer Load Transport|tidal characteristic numbers of tracer load transport]] 
[[Tidal Characteristic Numbers of Eff. Bed Shear Stress Action|tidal characteristic numbers of effective bed shear stress]] 
[[Tidal Characteristic Numbers of Bed Load Transport|tidal characteristic numbers of bed load transport]] 
[[Tidal Characteristic Numbers of Potential Energy Anomaly|tidal characteristic numbers of potential energy anomaly]] 
[[Harmonic Analysis of Water Level|harmonic analysis of water level]] 
[[Harmonic Analysis of Current Velocity|harmonic analysis of current velocity]] 
[[Characteristic Numbers of Water Level (independent of tides)|characteristic numbers of water level (independent of tides)]] 
[[Characteristic Numbers of Current Velocity (independent of tides)|characteristic numbers of current velocity (independent of tides)]] 
[[Characteristic Numbers of Salinity (independent of tides)|characteristic numbers of salinity (independent of tides)]] 
[[Characteristic Numbers of Temperature (independent of tides)|characteristic numbers of temperature (independent of tides)]] 
[[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)|characteristic numbers of suspended sediment concentration (independent of tides)]] 
[[Characteristic Numbers of Tracer Load (independent of tides)|characteristic numbers of tracer load (independent of tides)]] 
[[Characteristic Numbers of Oxygen Concentration (independent of tides)|characteristic numbers of oxygen concentration (independent of tides)]] 
[[Characteristic Numbers of Morphodynamics (independent of tides)|characteristic numbers of morphodynamics (independent of tides)]] 
[[Characteristic Numbers of Bed Load Transport (independent of tides)|characteristic numbers of bedload transport (independent of tides)]] 
[[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)|characteristic numbers of effective bed shear stress (independent of tides)]] 
[[Characteristic Numbers of Water Transport (independent of tides)|characteristic numbers of water transport (independent of tides)]]
 
[[Characteristic Numbers of Salt Transport (independent of tides)|characteristic numbers of salt transport (independent of tides)]]
 
[[Characteristic Numbers of Heat Transport (independent of tides)|characteristic numbers of heat transport (independent of tides)]]
 
[[Characteristic Numbers of Tracer Transport (independent of tides)|characteristic numbers of tracer transport (independent of tides)]] 
[[Characteristic Numbers of Suspended Sediment Transport (independent of tides)|characteristic numbers of suspended sediment transport (independent of tides)]] 
[[Characteristic Numbers of Sediment Transport (independent of tides)|characteristic numbers of sediment transport (independent of tides)]] (bed and suspended load at the bottom) 
[[Characteristic Numbers of Tidal Energy Transport|characteristic numbers of tidal energy transport]] 
[[Characteristic Numbers of Potential Energy Anomaly (independent of tides)|characteristic numbers of potential energy anomaly]] 
[[Characteristic Numbers of Meteorological Data (independent of tides)|characteristic numbers of meteorological data (wind speed)]] 
[[Characteristic Numbers for Wave and Sea State (independent of tides)|characteristic numbers for wave and sea state (significant wave height)]] 
[[NetCDF|CF NetCDF]] format for 2D/3D data 
orthogonal unstructured grid model 
orthogonal unstructured grid model with subgrid information 
data at individual locations (''Discrete Sampling Geometry'' featureType = '''timeSeriesProfile''') 
data at multiple locations along trajectories (''Discrete Sampling Geometry'' featureType = '''trajectoryProfile''') 
parallelization using [http://openmp.org/wp/ OpenMP] and [http://en.wikipedia.org/wiki/Message_Passing_Interface MPI] 
[[NetCDF#Quality assurance using NetCDF attributes|automatic quality assurance (value range)]] 
automatic adjustment of number of READ data to chunk size of data 
automatic setting of WRITE chunk sizes for written variables 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of [https://en.wikipedia.org/wiki/MD5 MD5 hash values] of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
optional closing of data gaps at reference positions by interpolation 

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/]).''

|shortdescription=
Program NCANALYSE serves as an analysis program for data stored in CF netCDF data files.

|inputfiles=
# '''general input data''' (file type [[NCANALYSE.DAT|ncanalyse.dat]]);
# '''synoptic data sets''' (file type [[CF-NETCDF.NC]]);
# for [[NetCDF#Automatic quality assurance using NetCDF attributes|automatic quality assurance]] (file type [[BOUNDS.CFG.DAT|bounds_verify.dat]]).

|outputfiles=
# '''data analysis result files''' (file type [[CF-NETCDF.NC]])
# (optional) informative '''printer file''' of program execution (file type ncanalyse.sdr)
# (optional) '''trace''' of program execution (file type ncanalyse.trc)

|methodology=
The following data analysis methods are currently available:
* Tidal Characteristic Numbers:
*# [[Tidal Characteristic Numbers of Water Level]];
*# [[Tidal Characteristic Numbers of Current]];
*# [[Tidal Characteristic Numbers of Salinity]];
*# [[Tidal Characteristic Numbers of Temperature]];
*# [[Tidal Characteristic Numbers of Suspended Sediment Transport|Tidal Characteristic Numbers of Suspended Sediment]];
*# [[Tidal Characteristic Numbers of Tracer Load]];
*# [[Tidal Characteristic Numbers of Eff. Bed Shear Stress Action|Tidal Characteristic Numbers of Effective Bed Shear Stress]];
*# [[Tidal Characteristic Numbers of Bed Load Transport]];
*# [[Tidal Characteristic Numbers of Potential Energy Anomaly]].
* Tide-dependent Characteristic Numbers for Transport-Processes (based on ''exact'' integrals):
*# [[Tidal Characteristic Numbers of Water Transport]];
*# [[Tidal Characteristic Numbers of Salt Transport]];
*# [[Tidal Characteristic Numbers of Heat Transport]];
*# [[Tidal Characteristic Numbers of Suspended Load Transport]];
*# [[Tidal Characteristic Numbers of Tracer Load Transport]].
* Harmonic Analysis:
*# [[Harmonic Analysis of Water Level]];
*# [[Harmonic Analysis of Current Velocity]].
* Tide-Independent Characteristic Numbers:
*# [[Characteristic Numbers of Water Level (independent of tides)]];
*# [[Characteristic Numbers of Current Velocity (independent of tides)]];
*# [[Characteristic Numbers of Salinity (independent of tides)]];
*# [[Characteristic Numbers of Temperature (independent of tides)]];
*# [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)]];
*# [[Characteristic Numbers of Tracer Load (independent of tides)]];
*# [[Characteristic Numbers of Oxygen Concentration (independent of tides)]];
*# [[Characteristic Numbers of Morphodynamics (independent of tides)]];
*# [[Characteristic Numbers of Bed Load Transport (independent of tides)]];
*# [[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)]];
*# [[Characteristic Numbers of Potential Energy Anomaly (independent of tides)]].
* Tide-Independent Characteristic Numbers for Transport-Processes (based on ''exact'' integrals):
*# [[Characteristic Numbers of Water Transport (independent of tides)]];
*# [[Characteristic Numbers of Water Transport (independent of tides)]];
*# [[Characteristic Numbers of Salt Transport (independent of tides)]];
*# [[Characteristic Numbers of Heat Transport (independent of tides)]];
*# [[Characteristic Numbers of Tracer Transport (independent of tides)]];
*# [[Characteristic Numbers of Suspended Sediment Transport (independent of tides)]];
*# [[Characteristic Numbers of Sediment Transport (independent of tides)]] (bed an suspended load at the bottom).
* Tidal Energy Transport:
*# [[Characteristic Numbers of Tidal Energy Transport]]
* Characteristic Numbers of Meteorological Data:
*# [[Characteristic Numbers of Meteorological Data (independent of tides)|wind speed]].
* Characteristic Numbers for Wave and Sea State:
*# [[Characteristic Numbers for Wave and Sea State (independent of tides)|significant wave height]].

Just in case '''HDF error''' is detected during read of a data record, the program tries to reconstruct the wanted data set from adjacent (in time) records for the same variable. This type of repair works for time dependent variables only.

|preprocessor=[[BOE2NC]], [[DATACONVERT]], [[GRIDCONVERT]], [[NCAGGREGATE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCDVAR]], [[NCMERGE]], [[NetCDF Operators]], [[QUICKPLOT]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=[[DAVIT]], [[DISPLAY_CONTROL_VOLUMES]], [[NCAGGREGATE]], [[NCAUTO]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCDELTA]], [[NCDVAR]], [[NCPLOT]], [[NC2TABLE]], [[PLOTPROFILZEIT]], [[PLOTTS]]
|language=Fortran95
|add_software=---
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
* Presentations (many available in German only):
** 2021-06-16: [http://doi.org/10.13140/RG.2.2.20390.45120 ''Tidal Asymmetry - Classical Parameters vs Skewness''] (DOI: [http://doi.org/10.13140/RG.2.2.20390.45120 http://doi.org/10.13140/RG.2.2.20390.45120]);
** 2015-05-29: [http://ewisa.baw.de/files/12556_tv12_2015_05_29_tide_energie_transport_g_lang.pdf ''Tidewelle und Energietransport''] (DOI: [http://dx.doi.org/10.13140/RG.2.2.31352.14089 http://dx.doi.org/10.13140/RG.2.2.31352.14089]);
** 2014-12-03: [http://ewisa.baw.de/files/11284_tv12_2014_12_03_ncanalyse_lzks_g_lang.pdf ''NCANALYSE - Tideunabhängige Kennwerte des Salzgehalts''];
** 2014-12-03: [http://ewisa.baw.de/files/11285_tv12_2014_12_03_ncanalyse_tdks_g_lang.pdf ''NCANALYSE - Tidekennwerte des Salzgehalts''];
** 2014-10-08: [http://ewisa.baw.de/files/10587_tv12_2014_10_08_ncanalyse_lzkv_g_lang.pdf ''NCANALYSE - Tideunabhängige Kennwerte der Strömung''];
** 2014-09-10: [http://ewisa.baw.de/files/10588_tv12_2014_09_10_allgemein_g_lang.pdf ''NCANALYSE - Tidekennwerte der Strömung''];
** 2013-08-07: [http://ewisa.baw.de/files/08510_speech_2013-08-07.pdf ''NCANALYSE - Tideunabhängige Kennwerte des Wasserstands''];
** 2013-05-15: [http://ewisa.baw.de/files/08500_speech_2013-05-15.pdf ''NCANALYSE - Daten aus CF netCDF Dateien analysieren''].
* [https://izw-campus.baw.de/ ''IZW-Campus''] (Podcast, available in German only)
** 2022-04-25: [https://izw-campus.baw.de/goto.php?target=cat_4105&client_id=iliasclient ''NCANALYSE - Grundlagen am Beispiel der Analyse LZKW (tideunabhängige Kennwerte des Wasserstands)''];
** 2022-03-21: [https://izw-campus.baw.de/goto.php?target=cat_3829&client_id=iliasclient ''Energietransport einer Tidewelle''];
** 2021-11-29: [https://izw-campus.baw.de/goto.php?target=cat_3490&client_id=iliasclient ''NCANALYSE - Grundlagen - Wechselwirkung zwischen Salzgehalt und Schwebstoffgehalt''];
** 2021-10-18: [https://izw-campus.baw.de/goto.php?target=cat_3301&client_id=iliasclient ''NCANALYSE - Grundlagen verschiedener Kennwerte (Einfluss des Salzgehalts auf verschiedene Kenngrößen)''];
** 2021-09-13: [https://izw-campus.baw.de/goto.php?target=cat_3102&client_id=iliasclient ''NCANALYSE - Grundlagen TDKA (Tidekennwerte der Anomalie der Potentiellen Energie)''];
** 2021-08-09: [https://izw-campus.baw.de/goto.php?target=cat_1830&client_id=iliasclient ''NCANALYSE - Grundlagen TDKS (Tidekennwerte des Salzgehalts)''];
** 2021-06-07: [https://izw-campus.baw.de/goto.php?target=cat_2554&client_id=iliasclient ''NCANALYSE Update zu Skewness - aus Partialtiden des Wasserstands und der Strömung''];
** 2021-04-19: [https://izw-campus.baw.de/goto.php?target=cat_2329&client_id=iliasclient ''NCANALYSE - Grundlagen am Beispiel der Analyse FRQV (Harmonische Analyse der Strömung)''];
** 2021-03-08: [https://izw-campus.baw.de/goto.php?target=cat_2224&client_id=iliasclient ''NCANALYSE - Grundlagen am Beispiel der Analyse FRQW (Harmonische Analyse des Wasserstands)''];
** 2021-02-08: [https://izw-campus.baw.de/goto.php?target=cat_1940&client_id=iliasclient ''NCANALYSE - Grundlagen am Beispiel der Analyse TDKV (Tidekennwerte der Strömungsgeschwindigkeit)''];
** 2021-01-11: [https://izw-campus.baw.de/goto.php?target=cat_1853&client_id=iliasclient ''NCANALYSE - Grundlagen am Beispiel der Analyse TDKW (Tidekennwerte des Wasserstands)''].
* Template input files:
** template files available in '''$PROGHOME/examples/ncanalyse'''
}}

NCANALYSE

2022-11-07T07:54:53Z

Ak3glang: somelinks to IZW-Campus were updated

{{ProgramDescription
|name_de=NCANALYSE
|name=NCANALYSE
|version=March 2022
|version_descr=September 2022
|catchwords=
data analysis 
postprocessor 
synoptic data sets 
measured time series data (optionally with [http://cfconventions.org/Data/cf-conventions/cf-conventions-1.6/build/cf-conventions.html#flags flag variables] for a more detailed qualification of data) 
depth averaged (2D) and depth structured data (3D) with z-layers 
[[Tidal Characteristic Numbers of Water Level|tidal characteristic numbers of water level]] 
[[Tidal Characteristic Numbers of Current|tidal characteristic numbers of current]], [[Tidal Characteristic Numbers of Water Transport|tidal characteristic numbers of water transport]] 
[[Tidal Characteristic Numbers of Salinity|tidal characteristic numbers of salinity]], [[Tidal Characteristic Numbers of Salt Transport|tidal characteristic numbers of salt transport]] 
[[Tidal Characteristic Numbers of Temperature|tidal characteristic numbers of temperature]], [[Tidal Characteristic Numbers of Heat Transport|tidal characteristic numbers of heat transport]] 
[[Tidal Characteristic Numbers of Suspended Sediment Transport|tidal characteristic numbers of suspended sediment]],
[[Tidal Characteristic Numbers of Suspended Load Transport|tidal characteristic numbers of suspended load transport]] 
[[Tidal Characteristic Numbers of Tracer Load|tidal characteristic numbers of tracer load]], [[Tidal Characteristic Numbers of Tracer Load Transport|tidal characteristic numbers of tracer load transport]] 
[[Tidal Characteristic Numbers of Eff. Bed Shear Stress Action|tidal characteristic numbers of effective bed shear stress]] 
[[Tidal Characteristic Numbers of Bed Load Transport|tidal characteristic numbers of bed load transport]] 
[[Tidal Characteristic Numbers of Potential Energy Anomaly|tidal characteristic numbers of potential energy anomaly]] 
[[Harmonic Analysis of Water Level|harmonic analysis of water level]] 
[[Harmonic Analysis of Current Velocity|harmonic analysis of current velocity]] 
[[Characteristic Numbers of Water Level (independent of tides)|characteristic numbers of water level (independent of tides)]] 
[[Characteristic Numbers of Current Velocity (independent of tides)|characteristic numbers of current velocity (independent of tides)]] 
[[Characteristic Numbers of Salinity (independent of tides)|characteristic numbers of salinity (independent of tides)]] 
[[Characteristic Numbers of Temperature (independent of tides)|characteristic numbers of temperature (independent of tides)]] 
[[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)|characteristic numbers of suspended sediment concentration (independent of tides)]] 
[[Characteristic Numbers of Tracer Load (independent of tides)|characteristic numbers of tracer load (independent of tides)]] 
[[Characteristic Numbers of Oxygen Concentration (independent of tides)|characteristic numbers of oxygen concentration (independent of tides)]] 
[[Characteristic Numbers of Morphodynamics (independent of tides)|characteristic numbers of morphodynamics (independent of tides)]] 
[[Characteristic Numbers of Bed Load Transport (independent of tides)|characteristic numbers of bedload transport (independent of tides)]] 
[[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)|characteristic numbers of effective bed shear stress (independent of tides)]] 
[[Characteristic Numbers of Water Transport (independent of tides)|characteristic numbers of water transport (independent of tides)]]
 
[[Characteristic Numbers of Salt Transport (independent of tides)|characteristic numbers of salt transport (independent of tides)]]
 
[[Characteristic Numbers of Heat Transport (independent of tides)|characteristic numbers of heat transport (independent of tides)]]
 
[[Characteristic Numbers of Tracer Transport (independent of tides)|characteristic numbers of tracer transport (independent of tides)]] 
[[Characteristic Numbers of Suspended Sediment Transport (independent of tides)|characteristic numbers of suspended sediment transport (independent of tides)]] 
[[Characteristic Numbers of Sediment Transport (independent of tides)|characteristic numbers of sediment transport (independent of tides)]] (bed and suspended load at the bottom) 
[[Characteristic Numbers of Tidal Energy Transport|characteristic numbers of tidal energy transport]] 
[[Characteristic Numbers of Potential Energy Anomaly (independent of tides)|characteristic numbers of potential energy anomaly]] 
[[Characteristic Numbers of Meteorological Data (independent of tides)|characteristic numbers of meteorological data (wind speed)]] 
[[Characteristic Numbers for Wave and Sea State (independent of tides)|characteristic numbers for wave and sea state (significant wave height)]] 
[[NetCDF|CF NetCDF]] format for 2D/3D data 
orthogonal unstructured grid model 
orthogonal unstructured grid model with subgrid information 
data at individual locations (''Discrete Sampling Geometry'' featureType = '''timeSeriesProfile''') 
data at multiple locations along trajectories (''Discrete Sampling Geometry'' featureType = '''trajectoryProfile''') 
parallelization using [http://openmp.org/wp/ OpenMP] and [http://en.wikipedia.org/wiki/Message_Passing_Interface MPI] 
[[NetCDF#Quality assurance using NetCDF attributes|automatic quality assurance (value range)]] 
automatic adjustment of number of READ data to chunk size of data 
automatic setting of WRITE chunk sizes for written variables 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of [https://en.wikipedia.org/wiki/MD5 MD5 hash values] of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
optional closing of data gaps at reference positions by interpolation 

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/]).''

|shortdescription=
Program NCANALYSE serves as an analysis program for data stored in CF netCDF data files.

|inputfiles=
# '''general input data''' (file type [[NCANALYSE.DAT|ncanalyse.dat]]);
# '''synoptic data sets''' (file type [[CF-NETCDF.NC]]);
# for [[NetCDF#Automatic quality assurance using NetCDF attributes|automatic quality assurance]] (file type [[BOUNDS.CFG.DAT|bounds_verify.dat]]).

|outputfiles=
# '''data analysis result files''' (file type [[CF-NETCDF.NC]])
# (optional) informative '''printer file''' of program execution (file type ncanalyse.sdr)
# (optional) '''trace''' of program execution (file type ncanalyse.trc)

|methodology=
The following data analysis methods are currently available:
* Tidal Characteristic Numbers:
*# [[Tidal Characteristic Numbers of Water Level]];
*# [[Tidal Characteristic Numbers of Current]];
*# [[Tidal Characteristic Numbers of Salinity]];
*# [[Tidal Characteristic Numbers of Temperature]];
*# [[Tidal Characteristic Numbers of Suspended Sediment Transport|Tidal Characteristic Numbers of Suspended Sediment]];
*# [[Tidal Characteristic Numbers of Tracer Load]];
*# [[Tidal Characteristic Numbers of Eff. Bed Shear Stress Action|Tidal Characteristic Numbers of Effective Bed Shear Stress]];
*# [[Tidal Characteristic Numbers of Bed Load Transport]];
*# [[Tidal Characteristic Numbers of Potential Energy Anomaly]].
* Tide-dependent Characteristic Numbers for Transport-Processes (based on ''exact'' integrals):
*# [[Tidal Characteristic Numbers of Water Transport]];
*# [[Tidal Characteristic Numbers of Salt Transport]];
*# [[Tidal Characteristic Numbers of Heat Transport]];
*# [[Tidal Characteristic Numbers of Suspended Load Transport]];
*# [[Tidal Characteristic Numbers of Tracer Load Transport]].
* Harmonic Analysis:
*# [[Harmonic Analysis of Water Level]];
*# [[Harmonic Analysis of Current Velocity]].
* Tide-Independent Characteristic Numbers:
*# [[Characteristic Numbers of Water Level (independent of tides)]];
*# [[Characteristic Numbers of Current Velocity (independent of tides)]];
*# [[Characteristic Numbers of Salinity (independent of tides)]];
*# [[Characteristic Numbers of Temperature (independent of tides)]];
*# [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)]];
*# [[Characteristic Numbers of Tracer Load (independent of tides)]];
*# [[Characteristic Numbers of Oxygen Concentration (independent of tides)]];
*# [[Characteristic Numbers of Morphodynamics (independent of tides)]];
*# [[Characteristic Numbers of Bed Load Transport (independent of tides)]];
*# [[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)]];
*# [[Characteristic Numbers of Potential Energy Anomaly (independent of tides)]].
* Tide-Independent Characteristic Numbers for Transport-Processes (based on ''exact'' integrals):
*# [[Characteristic Numbers of Water Transport (independent of tides)]];
*# [[Characteristic Numbers of Water Transport (independent of tides)]];
*# [[Characteristic Numbers of Salt Transport (independent of tides)]];
*# [[Characteristic Numbers of Heat Transport (independent of tides)]];
*# [[Characteristic Numbers of Tracer Transport (independent of tides)]];
*# [[Characteristic Numbers of Suspended Sediment Transport (independent of tides)]];
*# [[Characteristic Numbers of Sediment Transport (independent of tides)]] (bed an suspended load at the bottom).
* Tidal Energy Transport:
*# [[Characteristic Numbers of Tidal Energy Transport]]
* Characteristic Numbers of Meteorological Data:
*# [[Characteristic Numbers of Meteorological Data (independent of tides)|wind speed]].
* Characteristic Numbers for Wave and Sea State:
*# [[Characteristic Numbers for Wave and Sea State (independent of tides)|significant wave height]].

Just in case '''HDF error''' is detected during read of a data record, the program tries to reconstruct the wanted data set from adjacent (in time) records for the same variable. This type of repair works for time dependent variables only.

|preprocessor=[[BOE2NC]], [[DATACONVERT]], [[GRIDCONVERT]], [[NCAGGREGATE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCDVAR]], [[NCMERGE]], [[NetCDF Operators]], [[QUICKPLOT]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=[[DAVIT]], [[DISPLAY_CONTROL_VOLUMES]], [[NCAGGREGATE]], [[NCAUTO]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCDELTA]], [[NCDVAR]], [[NCPLOT]], [[NC2TABLE]], [[PLOTPROFILZEIT]], [[PLOTTS]]
|language=Fortran95
|add_software=---
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
* Presentations (many available in German only):
** 2021-06-16: [http://doi.org/10.13140/RG.2.2.20390.45120 ''Tidal Asymmetry - Classical Parameters vs Skewness''] (DOI: [http://doi.org/10.13140/RG.2.2.20390.45120 http://doi.org/10.13140/RG.2.2.20390.45120]);
** 2015-05-29: [http://ewisa.baw.de/files/12556_tv12_2015_05_29_tide_energie_transport_g_lang.pdf ''Tidewelle und Energietransport''] (DOI: [http://dx.doi.org/10.13140/RG.2.2.31352.14089 http://dx.doi.org/10.13140/RG.2.2.31352.14089]);
** 2014-12-03: [http://ewisa.baw.de/files/11284_tv12_2014_12_03_ncanalyse_lzks_g_lang.pdf ''NCANALYSE - Tideunabhängige Kennwerte des Salzgehalts''];
** 2014-12-03: [http://ewisa.baw.de/files/11285_tv12_2014_12_03_ncanalyse_tdks_g_lang.pdf ''NCANALYSE - Tidekennwerte des Salzgehalts''];
** 2014-10-08: [http://ewisa.baw.de/files/10587_tv12_2014_10_08_ncanalyse_lzkv_g_lang.pdf ''NCANALYSE - Tideunabhängige Kennwerte der Strömung''];
** 2014-09-10: [http://ewisa.baw.de/files/10588_tv12_2014_09_10_allgemein_g_lang.pdf ''NCANALYSE - Tidekennwerte der Strömung''];
** 2013-08-07: [http://ewisa.baw.de/files/08510_speech_2013-08-07.pdf ''NCANALYSE - Tideunabhängige Kennwerte des Wasserstands''];
** 2013-05-15: [http://ewisa.baw.de/files/08500_speech_2013-05-15.pdf ''NCANALYSE - Daten aus CF netCDF Dateien analysieren''].
* [https://izw-campus.baw.de/ ''IZW-Campus''] (Podcast, available in German only)
** 2022-04-25: [https://izw-campus.baw.de/goto.php?target=cat_4105&client_id=iliasclient ''NCANALYSE - Grundlagen am Beispiel der Analyse LZKW (tideunabhängige Kennwerte des Wasserstands)''];
** 2022-03-21: [https://izw-campus.baw.de/goto.php?target=cat_3829&client_id=iliasclient ''Energietransport einer Tidewelle''];
** 2021-11-29: [https://izw-campus.baw.de/goto.php?target=cat_3490&client_id=iliasclient ''NCANALYSE - Grundlagen - Wechselwirkung zwischen Salzgehalt und Schwebstoffgehalt''];
** 2021-10-18: [https://izw-campus.baw.de/goto.php?target=cat_3301&client_id=iliasclient ''NCANALYSE - Grundlagen verschiedener Kennwerte (Einfluss des Salzgehalts auf verschiedene Kenngrößen)''];
** 2021-09-13: [https://izw-campus.baw.de/goto.php?target=cat_3102&client_id=iliasclient ''NCANALYSE - Grundlagen TDKA (Tidekennwerte der Anomalie der Potentiellen Energie)''];
** 2021-08-09: [https://izw-campus.baw.de/goto.php?target=cat_1830&client_id=iliasclient ''NCANALYSE - Grundlagen TDKS (Tidekennwerte des Salzgehalts)''];
** 2021-06-07: [https://izw-campus.baw.de/goto.php?target=cat_2554&client_id=iliasclient ''NCANALYSE Update zu Skewness - aus Partialtiden des Wasserstands und der Strömung''];
** 2021-04-19: [https://izw-campus.baw.de/goto.php?target=cat_2329&client_id=iliasclient ''NCANALYSE - Grundlagen am Beispiel der Analyse FRQV (Harmonische Analyse der Strömung)''];
** 2021-03-08: [https://izw-campus.baw.de/goto.php?target=cat_2224&client_id=iliasclient ''NCANALYSE - Grundlagen am Beispiel der Analyse FRQW (Harmonische Analyse des Wasserstands)''];
** 2021-02-08: https://izw-campus.baw.de/goto.php?target=cat_1940&client_id=iliasclient ''NCANALYSE - Grundlagen am Beispiel der Analyse TDKV (Tidekennwerte der Strömungsgeschwindigkeit)''];
** 2021-01-11: [https://izw-campus.baw.de/goto.php?target=cat_1853&client_id=iliasclient ''NCANALYSE - Grundlagen am Beispiel der Analyse TDKW (Tidekennwerte des Wasserstands)''].
* Template input files:
** template files available in '''$PROGHOME/examples/ncanalyse'''
}}

NCDELTA.DAT

2022-10-10T06:56:42Z

Ak3glang: text related to Max_Read_Storage modified.

{{FileDescription
|name_de=NCDELTA.DAT
|filetype=ncdelta.dat
|version=October 2022
|version_descr=October 2022
|significance=contains general steering data for the program [[NCDELTA]].
|filecontents=
'''steering data'''

* Block '''Program_Parameters''': general steering data
*# '''Max_Read_Storage''': number of data items in byte read from input file during each analysis cycle. This value gives a good approximation of [[NCDELTA|NCDELTA's]] mamximum memory requirements for each variable.
*# '''Max_Distance''': maximum distance in [m] up to which points with different location are compared.
*# (optional) '''Print_Modus_Classify''': parameter to steer informative printout messages in program section ''classification'':
*## '''0''' = no extensive messages printed;
*## '''1''' = more extensive messages about classified variables will be printed.
*# (optional) '''Print_Modus_Pairs''': parameter to steer informative printout messages in program section ''primary partner variables'':
*## '''0''' = no extensive messages printed;
*## '''1''' = more extensive messages about detected variable pairs will be printed;
*## '''2''' = also informations about rejected variable pairs will be printed.
*# (optional) '''Print_Modus_Define''': parameter to steer informative printout messages in program section ''definition of computational results'':
*##'''0''' = no extensive messages printed;
*## '''1''' = more extensive informations with respect to metadata of computational results will be printed.
*# (optional) '''Print_Modus_Compute''': parameter to steer informative printout messages in program section ''computation of results'':
*##'''0''' = no extensive messages printed;
*## '''1''' = more extensive messages about computational result variables will be printed.
*# (optional) '''NC_Deflate_Level''': deflate level (0,1,2,...,9) for online compression of data during write. 0 corresponds to no compression and 9 to maximum compression
*# (optional) '''NC_Cmode_Id''': ''creation mode flag'' used for [[NetCDF|CF NetCDF]] method [https://www.unidata.ucar.edu/software/netcdf/netcdf-4/newdocs/netcdf-f90/NF90_005fCREATE.html NF90_CREATE]. Typical values used in this application are:
*#* 4 = '''NF90_64BIT_OFFSET''' (NetCDF 64Bit file, no HDF - no online compression);
*#* 5 = '''NF90_CLASSIC_MODEL''' (HDF file without use of extended HDF features - with online compression).
* Block '''Data_Files''': data files
*# '''Reference_File''': file (NETCDF) with '''reference''' data (filetype [[CF-NETCDF.NC|cf-netcdf.nc]]);
*# '''Variant_File''': file (NETCDF) with '''variant''' data (filetype [[CF-NETCDF.NC|cf-netcdf.nc]]);
*# '''Result_File''': file (NETCDF) for '''result''' data (filetype [[CF-NETCDF.NC|cf-netcdf.nc]]);
*# (optional) '''Reference_Period''': start and end time of period of comparison for reference data (for synoptic data only);
*# (optional) '''Variant_Period''': start and end time of period of comparison for variant data (for synoptic data only).
* (optional) Block '''Data_Operations''': data operations
*# (optional) '''With_Ordinary_Differences''': compute (.true.) common differences (if possible) or do not compute (.false.);
*# (optional) '''With_Taylor_Diagram_Data''': compute (.true.) data for Taylor diagram (if possible) or do not compute (.false.); including skill scores according to Taylor (2001) equations 4 and 5;
*# (optional) '''With_Median''': compute (.true.) median (>= 32 events) or do not compute (.false.);
*# (optional) '''With_Percentiles_05_95''': compute (.true.) percentiles Q05, Q95 (>= 32 events) or do not compute (.false.);
*# (optional) '''With_Percentiles_01_99''': compute (.true.) percentiles Q01, Q99 (>= 51 events) or do not compute (.false.);
*# (optional) '''With_Murphy_Skill_1988''': compute (.true.) skill according to Murphy (1988) equation 4 or do not compute (.false.);
*# (optional) '''With_Skill_Willmott_1981''': compute (.true.) skill according to Willmott (1981) Index of agreement (d);
*# (optional) '''With_Original_Data''': copy (.true.) or not (.false.) input data from which ordinary differences are computed.
* (optional) Block '''Exclude_Variable_From_NCDELTA''': list of variables to be excluded from computation.
*# '''Variant_Variable''': variable from ''Variant-File''. Key can be prescribed several times. With exception of the variables listed here results will be computed for all primary variable pairs.
* (optional) Block '''Include_Only_Variable_for_NCDELTA''': list of variables for which results ar exclusively computed.
*# '''Variant_Variable''': variable from ''Variant-File''. Key can be prescribed several times. Results will be solely computed for the variables listed here.
* (optional) Block '''No_Normal_Vector_Variable''': The list of variables which are normal vectors is (mostly) automatically determined with [[NCDELTA]]. So far, unfortunately, not all of them can be safely identified based on CF metadata. With this list variables can be explicitely '''''excluded''''' from the class of normal vector variables.
*# '''Variable''': variable from ''Variant-File'' or ''Reference_File''. Key can be prescribed several times.
* (optional) Block '''Normal_Vector_Variable''': The list of variables which are normal vectors is (mostly) automatically determined with [[NCDELTA]]. So far, unfortunately, not all of them can be safely identified based on CF metadata. With this list variables can be explicitely '''''included''''' in the class of normal vector variables.
*# '''Variable''': variable from ''Variant-File'' or ''Reference_File''. Key can be prescribed several times.
* (optional) Block '''Label_Relation''': For intercomparison of ''fractioned'' variables, for which the relationship between individual ''fractions'' (sediment, tidal constituent, etc.) cannot be automatically determined. In such situations the corresponding names must be prescribed by the user. Block can be specified several times.
*# '''Variant_Label_KV''': name of a valid label coordinate variable from ''Variant_File'' or ''NONE''.
*# '''Reference_Label_KV''': name of a valid label coordinate variable from ''Reference_File'' or ''NONE''.
*# '''Relation''': ''name of a ''fraction'' in Variant_File'' ''':''' ''name of a ''fraction'' in Reference_File''. Key can be specified several times. ''NONE'' must be specified in case there exists no corresponding label coordinate variable. Colon is used as separator.

===General Remarks===
# Dictionary files used from directory '''''$PROGHOME/dic/''''':
#* '''''ncdelta_dico.dat'''''.
# Use Cases:
#* Case 1: '''Reference_File''' = simulation 1, '''Variant_File''' = simulation 2;
#* Case 2: '''Reference_File''' = measurement, '''Variant_File''' = simulation;
#* Case 3: '''Reference_File''' = measurement 1, '''Variant_File''' = measurement 2;
#: Synoptic data ''or'' data analysis results from program [[NCANALYSE]] can be used.
# General requirements:
#* Synoptic data:
#** length of time period must be identical (periods may differ), and
#** time step must be identical.
#* Analysis results ([[NCANALYSE]]):
#** length of period of data analysis must be comparable, and
#** number of events, e.g. tidal high water, must also be identical.
#* Z coordinate variables:
#: z coordinate variables, if present, must be consistent with respect to
#:* CF attribute ''positive'' all with value "down", or
#:* CF attribute ''positive'' all with value "up"
#: (see [http://cfconventions.org/ CF metadata conventions]).
# Special requirements:
#* ref. case 1:
#** same vertical structure (number of layers), and
#** identical (tracer-) fractions (if present).
#* ref. case 2:
#** identical (tracer-) fractions (if present), and
#** measured data may contain for the same (geographical) location (x,y) several measured data in different depths (z). Furthermore
#** for comparisons with measured current velocity attribute "name_id" of variable "current_velocity" must be set to 836. This requirement should be checked before execution (e.g. using ncdump). In case this condition is not fulfilled NCO tool NCATTED '''ncatted -a name_id,current_velocity,m,i,836 -O ''reference_file''.nc''' can be used to redefine "name_id" accordingly.
#* ref. case 3:
#** each (geographical) location is allowed to be present only once; locations with several stacked data positions are not allowed currently with this use case.

|nutzerprogramme=[[NCDELTA]]
|language=Fortran90
|fileform=FORMATTED
|fileaccess=SEQUENTIAL
|fileextension=.dat
|writemodules= ---
|readmodules=$PROGHOME/fortran/prg/ncdelta/*/mod_m_ncdelta_steer.f90
|contact_original=[mailto:guenther.lang@baw.de G. Lang]
|contact_maintenance=[mailto:guenther.lang@baw.de G. Lang], [mailto:susanne.spohr@baw.de S. Spohr]
|examplefile=$PROGHOME/examples/ncdelta/ncdelta.dat
}}

NCDELTA

2022-10-10T06:48:54Z

Ak3glang: version date modified

{{ProgramDescription
|name_de=NCDELTA
|name=NCDELTA
|version=October 2022
|version_descr=September 2022
|catchwords=
postprocessor 
differences of synoptic data (with optional restriction of time period) 
differences of characteristic numbers 
differences for extensive quantities 
input data for Taylor diagram 
median, percentiles (Q01, Q05, Q95, Q99) 
skill score according to Murphy (1988) equation 4 
skill score according to Taylor (2001) equations 4 and 5 
skill score according to Willmott (1981) Index of agreement (d) 
parallelization using [http://openmp.org/wp/ OpenMP] 
[[NetCDF#Quality assurance using NetCDF attributes|automatic quality assurance (value range)]] 
automatic adjustment of number of READ data to chunk size of data 
automatic setting of WRITE chunk sizes for written variables 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of [https://en.wikipedia.org/wiki/MD5 MD5 hash values] of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
optional use of ''Message Passing Interface'' (MPI, [https://www.mpi-forum.org/ MPI Forum])

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/]).''

|shortdescription=
Program computes differences for comparable variables (primary variable pairs) as well as additional statistical data derived from primary differences, but also data for Taylor diagrams (details see [[Differences of Calculated Results]]) can be computed for some types of data. Finding the primary variable pairs is done in an essentially automatical manner but can be altered to some extent by the user (see [[NCDELTA.DAT|ncdelta.dat]]). Primary differences are computed according to ''variant data'' '''minus''' ''reference data''.

Requirements for time-dependent primary variable pairs with individual constant time step:
# both data sets may contain a ''different'' number of data items (time steps), but the length of the time period to be compared must be identical, whereas the periods to be compared may differ ;
# constant time step for each data set may differ from each other, but the larger time step must an integer multiple of the smaller one.

Requirements for time-dependent primary variable pairs with variable time step:
# both data sets must contain an ''identical'' number of data items (time steps), with periods allowed to be different.

Remarks concerning the spatial location of data:
# data sets may differ with respect to their geographical location;
# areas for which data are defined must overlap to some degree;
# coordinates may be given in different coordinate systems, e. g. Gauß-Krüger and UTM;
# data for a location are compared with data for the nearest lying location, as far as the distance between the different locations does not exceed a prescribed maximum (see [[NCDELTA.DAT|ncdelta.dat]]).

Remarks concerning the comparison of extensive variables:
# for extensive variables the respective sizes of the computational cells (area, length) are taken into account.

|inputfiles=
# '''general input data''' (file type [[NCDELTA.DAT|ncdelta.dat]]);
# '''reference data''' (file type [[CF-NETCDF.NC]]);
# '''variant data''' (file type [[CF-NETCDF.NC]]);
# for [[NetCDF#Automatic quality assurance using NetCDF attributes|automatic quality assurance]] (file type [[BOUNDS.CFG.DAT|bounds_verify.dat]]).

|outputfiles=
# '''results''' (file type [[CF-NETCDF.NC]])
# (optional) informative '''printer file''' of program execution (file type ncdelta.sdr)
# (optional) '''trace''' of program execution (file type ncdelta.trc)

|methodology=
The program is subdivided into the following sections:
# read, check and print steering data prescribed by the user;
# read metadata for ''reference data'';
# read metadata for ''variant data'';
# copy metadata for reference as well as variant data to program specific data structures;
# compare metadata for substantial discrepancies (e. g. reference locations) between data sets;
# classify all reference as well as variant data;
# find primary variable pairs: each variant variable has one partner reference variable; primary computational results will be later derived from primary variable pairs;
# derive variables to be copied from reference as well as variant data file into the result file;
# compute interpolation matrices required for interpolation between reference data locations and variant data locations;
# create all metadata for the result file; essentially they stem from variables to be copied, from primary result variables, newly generated coordinate variables (time, vertical), as well as newly derived or to be copied measure and auxiliary variables;
# copy selceted variables from reference as well as variant file to the result file;
# compute all primary variables, (new) time and vertical coordinate variables, as well as weights and auxiliary variables. For primary variables optionally available axiliary variables with ''standard_name'' modifier ''status_flag'' are taken into account in case meaning ''good'' is represented by an appropriate flag (bit).
# with respect of the different skill scores used and computed by the program - references:
#* Murphy, Allan H. (1988) "Skill Scores Based on the Mean Square Error and Their Relationship to the Correlation Coefficient". Monthly Weather Review, Dec. 1988, Pages 2417 - 2424.
#* Taylor, Karl E. (2001) "Summarizing multiple aspects of model performance in a single diagram". Journal of Geophysical Research, Vol 106, No. D7, April 16, 2001, Pages 7183 - 7192.
#* Willmott, Cort J. (1981) "On the validation of models". Physical Geography, Pages 184–194.
Just in case '''HDF error''' is detected during read of a data record, the program tries to reconstruct the wanted data set from adjacent (in time) records for the same variable. This type of repair works for time dependent variables only.

|preprocessor=[[BOE2NC]], [[DATACONVERT]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCRCATMAT]], [[NetCDF Operators]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=[[DAVIT]], [[NCAUTO]], [[NCCHUNKIE]], [[NCPOLO]], [[NCPLOT]], [[NCCUTOUT]], [[NC2TABLE]], [[NCVIEW2D]], [[PLOTTS]], [[TAYLORDIAGRAM]]
|language=Fortran95
|add_software=none
|contact_original=G. Lang, S. Spohr
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
* Presentations (available in German only):
** 2015-07-15: [http://ewisa.baw.de/files/12835_tv12_2015_07_15_ncdelta_g_lang.pdf ''NCDELTA - Differenzen neu berechnet''].
* [https://izw-campus.baw.de/ ''IZW-Campus''] (Podcast, available in German only)
** 2022-05-30: [https://izw-campus.baw.de/goto.php?target=cat_4308&client_id=iliasclient ''NCDELTA - Berechnung von Differenzen''].
* Template Files:
** template files available in '''$PROGHOME/examples/ncdelta'''
}}

ZEITR

2022-09-06T12:03:45Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=ZEITR
|name=ZEITR
|version=4.x / April 2011
|version_descr=September 2022
|catchwords=
postprocessor 
finite element grid 
data conversion 
universal direct access format for 2D/3D-data 
universal direct access format for profile-data 
universal direct access format for data at specific locations 
equivalent time-series representation of synoptic data 
|shortdescription=
The program ZEITR is a postprocessor for different numerical models (e.g. TRIM-2D, TRIM-3D, TELEMAC-2D, UNTTRIM etc.). ZEITR converts synoptic data sets (2D or 3D scalar/vector data as well as data along profiles or at specific locations) or cross sectionally averaged/ integrated data for arbitrary physical quantities into equivalent time-series. For every node of the computational grid or profile or all of the so called profile master points (for cross sectionally averaged/ integrated data) all computed quantities can be converted into a time-series data representation.
|inputfiles=
# general input data (filetype [[ZEITR.DAT|zeitr.dat]])
# synoptic results which shall be converted (filetype [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]])
'''Notice''': further input files can be found on the file description pages of the aforementioned files.
|outputfiles=
# converted time-series data (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]])
# informative printer file (filetype zeitr.sdr)
# (optional) trace of program execution (filetype zeitr.trc)
|methodology=For every node of a computational grid or profile or all the so called profile master points the synoptic data are gathered as an equivalent time-serie and written to the direct access data file. Programs which use the data subsequently can access each calculated physical quantity at each node of the computational grid directly as a single data record.
|preprocessor=
[[ADCP2BDF]], [[DATACONVERT]], [[DIDAMERGE]], [[DIDAMINTQ]], [[DIDAMINTZ]], [[DIDARENAME]], [[DIDASPLIT]], [[ENERF]], [[METDIDA]], [[PGCALC]], [[TELEMAC-2D]], [[TM2DIDA]], [[TR2DIDA]], [[TR3DIDA]], [[TR2GEOM]], [[TRIM-2D]], [[TRIM-3D]], [[UNS]], [[UNTRIM]], [[UNTRIM2]], [[UNTRIM2007]], [[UTRRND]], [[XTRLQ2]]
|postprocessor=
[[ABDF]], [[DIDARENAME]], [[DIDASPLIT]], [[FRQWF]], [[GVIEW2D]], [[LZKAF]], [[LZKMF]], [[LZKSF]] [[LZKVF]], [[LZKWF]], [[TDKLF]], [[TDKSF]], [[TDKVF]], [[TDKWF]], [[TR2ISSUSKONVERT]], [[UTRRND]], [[WARM]], [[XTRDATA]]
|language=Fortran95
|add_software= -
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=see also $PROGHOME/examples/Zeitr/
}}

XTRLQ2

2022-09-06T12:01:37Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=XTRLQ2
|name=XTRLQ2
|version=4.x / March 2011
|version_descr=September 2022
|catchwords=postprocessor 
extraction of data along longitudinal or cross-sectional profiles 
universal direct access data format for 2D/3D-data 
universal direct access data format for profile-data 
support of morphodynamic data sets 
support of data sets with static (alternative) bathymetry
|shortdescription=
The program XTRLQ2 is a model-independent postprocessor which serves to extract data out of 2D/3D-datasets along one or more longitudinal or cross-sectional profiles. Every profile is defined by a sequence of an arbitrary number of 2D-locations which are connected by straight lines as well as additional points in between these 2D-locations. The extracted data are written in the universal direct access data format to a profile-data file.
The following datasets can be actually managed:
* synoptic data with static bathymetry (based on gridfile bathymetry),
* synoptic data with static (alternative) bathymetry (based on data set information),
* synoptic data with time dependent bathymetry (morphodynamic data set), as well as
* morphological (MDO) and sedimentological (STO) output data from package [[Mathematical Model SEDIMORPH|SediMorph]].
Besides the data which shall be extracted (e.g. current velocity) also the corresponding reference water surface is needed (e.g. water level elevation). If the reference data are not stored together with the data to be extracted they have to be made available via separate files. The same applies to the time dependent bathymetry.
|inputfiles=
# general input data (filetype [[XTRLQ2.DAT|xtrlq2.dat]]);
# all other required input files are described together with the before mentioned input data file.
|outputfiles=
# result files are described within the above mentioned input data file [[XTRLQ2.DAT|xtrlq2.dat]];
# informative printer file (filetype Xtrlq2.master.sdr);
# (optional) trace of program execution (filetype Xtrlq2.trc)
|methodology=From 2D/3D-data files, profile-data will be interpolated for any number of locations from surrounding data points.
In general the profile-data file has identical structure and contents (e.g. number of physical quantities stored, number of time-steps, etc.) compared with the 2D/3D-data file.
In case of morphodynamic data sets or data sets based on static (alternative) bathymetry the time dependent bathymetry will be taken into account appropriately.
|preprocessor=[[DATACONVERT]], [[DIDASPLIT]], [[TICLQ2]], [[TM2DIDA]], [[TR2DIDA]], [[TR3DIDA]], [[TR2GEOM]], [[UNK]], [[UNS]], [[UNTRIM]], [[UNTRIM2007]]
|postprocessor=ArcGIS Desktop (in German only), [[DATACONVERT]], [[DIDAMERGE]], [[DIDAMINTQ]], [[GVIEW2D]], [[LQ2PRO]], [[TIMESHIFT]], [[VVIEW2D]], [[XTRDATA]], [[ZEITR]]
|language=Fortran90
|add_software=-
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=see $PROGHOME/examples/Xtrlq2/
}}

XTRDATA

2022-09-06T11:59:34Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=XTRDATA
|name=XTRDATA
|version=June 2020
|version_descr=September 2022
|catchwords=postprocessor 
data conversion 
universal direct access format for 2D/3D-data 
universal direct access format for profile-data 
universal direct access format for data at specific locations 
extraction of binary time-series data into ASCII-format 
extraction of binary profile-data into ASCII-format (longitudinal profiles) 
extraction of binary 3D-data into ASCII-format (vertical profiles) 
extraction of cross sectionally averaged or integrated data 
time-varying (morpho-) dynamic bathymetry 
treatment of several variants for a physical quantity
|shortdescription=
The program XTRDATA is a postprocessor which is model-independent. It was designed to extract data at some given locations from binary direct access data files (time-series data as well as profile-data). The input-files can contain either area-, volume-, location- or profile-data (calculated data or results from various data analyses). The following data can be processed:
* results given as time-series data, or
* profile data for
:* synoptic data sets,
:* results from various data analyses and
:* results from comparisons between data analyses for different scenarios.
* cross sectionally averaged or integrated data sets,
:* synoptic data sets,
:* results from various data analyses and
:* results from comparisons between data analyses for different scenarios.
* 3D-data for
:* synoptic data sets,
:* results from various data analyses and
:* results from comparisons between data analyses for different scenarios.
For each physical quantity several variants can be treated (e.g. different fractions of suspended sediment) at the same time.
Data can be extracted for any number of locations of varying type, namely:
* 2D-Locations (x,y): for depth-averaged 2D data sets,
* profile master point (2D-location): for cross sectionally averaged or integrated data,
* 3D-Locations (x,y,z): for 3D data sets,
* longitudinal profile-data (at the surface, at the bottom, at a constant depth or in a computational layer): for profile data,
* longitudinal sections of cross sectionally averaged or integrated data (aligned data at so called profile master points), or
* vertical profile-data: for 3D data sets
The extracted data can be later used in one of the following applications:
* graphical display of time series using GKS-programs (filetype [[BOEWRT.DAT|boewrt.dat]])
* usage inside the spread sheet program EXCEL (filetype [[EXCEL.DAT|excel.dat]])
* graphical display and data analysis inside the XY plotting program ACE/gr (filetype [[XMGR.DAT|xmgr.dat]])
|inputfiles=
# general '''input data''' (filetype [[XTRDATA.DAT|xtrdata.dat]])
# result files (filetype [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]]))
# grid for 2D/3D-data (filetype [[GITTER05.DAT and GITTER05.BIN|gitter05.dat/bin]] or filetype [[UNTRIM_GRID.DAT|untrim_grid.dat]]) '''or''' profile-topography for profile-data (filetype [[PROFIL05.BIN|profil05.bin]]) '''or''' system file for specific locations (filetype [[LOCATION_GRID.DAT|location_grid.dat]])
# several other files are necessary to define the [[GEOPOS.DAT|2D-or 3D-Locations]] or profiles where data shall be extracted (see documentation for the file XtrData.dat)
|outputfiles=
# (optional) extracted '''time-series''' data in ASCII-format (files of type [[EXCEL.DAT|excel.dat]], [[XMGR.DAT|xmgr.dat]] or [[BOEWRT.DAT|boewrt.dat]])
# (optional) extracted '''profile-data''' (longitudinal or vertical profiles) in ASCII-format (files of type [[EXCEL.DAT|excel.dat]] or [[XMGR.DAT|xmgr.dat]])
# informative '''printer''' file (filetype XtrData.sdr)
# (optional) '''trace''' of program execution (filetype XtrData.trc)
|methodology=
For every 2D- or 3D-Location or profile the desired data are extracted from the original binary direct access files. As far as time-series or vertical profiles are concerned, the results are interpolated from the results at the three nearest neighbour nodes. Therefore the output locations need not to coincide with the nodes of the computational grid. Data along profiles are taken as they are stored in the binary data file. Cross sectionally averaged or integrated data are taken directly from the so called profile master point to which data are attached.
|preprocessor=[[ADCP2BDF]], [[ADCP2PROFILE]], [[DATACONVERT]], [[DIDAMINTQ]], [[DIDASPLIT]], [[FRQWF]], [[LZKMF]], [[LZKSF]], [[LZKVF]], [[LZKWF]], [[VTDK]], [[TDKLF]], [[TDKSF]], [[TDKVF]], [[TDKWF]], [[TELEMAC-2D]], [[TIMESHIFT]], [[TRIM-2D]], [[TRIM-3D]], [[UNS]], [[UNTRIM]], [[XTRLQ2]], [[ZEITR]]
|postprocessor=ACE/gr-Applications, [[EXCEL-Applications]], [[FFT]], [[TIDKEN]], [[TSCALC]], [[DISPLAY_PERCENTILES]], [[PLOTPROFILZEIT]]
|language=Fortran90
|add_software=-
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=please refer to $PROGHOME/examples/XtrData/
}}

VVIEW2D

2022-09-06T11:57:34Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=VVIEW2D
|name=VVIEW2D
|version=July 2012
|version_descr=September 2022
|catchwords=
graphical postprocessor 
finite element models 
finite difference models 
graphical presentation of data 
vertical sections along profiles 
universal direct access data format 
coloured isosurface representation 
isoline representation 
vector arrow representation 
vector circle representation 
hatched isosurface representation 
visualization of CFD-data for estuaries and coastal seas 
time-varying (morpho-) dynamic bathymetry 
|shortdescription=
The graphical postprocessor VVIEW2D can be used for a scaled graphical presentation of different scalar or vector quantities in 2D vertical sections. The data can be generated by means of different application programs. Either a single data set or a superposition of a scalar and a vector quantity can be plotted in several different ways. Beyound the generation of a pure graphical representation of the data some additional graphical elements (e.g. company logo, etc.) can be easily integrated into each figure.
The vertical sections are defined over arbitrary longitudinal profiles described as polygon lines.

The following methods of graphical presentation of data are actually integrated into VVIEW2D. Here comes a short list together with some example figures:

* [[VVIEW2D: Demo Examples: Coloured Isosurface Representation|coloured isosurface representation]]
** [[VVIEW2D: Demo Examples: Coloured Isosurface Representation#Eddy Viscosity|eddy viscosity]]
** [[VVIEW2D: Demo Examples: Coloured Isosurface Representation#Orthogonal Velocity 1|orthogonal velocity 1]]
** [[VVIEW2D: Demo Examples: Coloured Isosurface Representation#Orthogonal Velocity 2|orthogonal velocity 2]]
** [[VVIEW2D: Demo Examples: Coloured Isosurface Representation#Parallel Velocity 1|parallel velocity 1]]
** [[VVIEW2D: Demo Examples: Coloured Isosurface Representation#Parallel Velocity 2|parallel velocity 2]]
* isoline representation
** no example available at the moment
* [[VVIEW2D: Demo Examples: Vector Representation|vector representation]]
** [[VVIEW2D: Demo Examples: Vector Representation#Orthogonal Velocity 1|orthogonal velocity 1]]
** [[VVIEW2D: Demo Examples: Vector Representation#Orthogonal Velocity 2|orthogonal velocity 2]]
** [[VVIEW2D: Demo Examples: Vector Representation#Parallel Velocity 1|parallel velocity 1]]
** [[VVIEW2D: Demo Examples: Vector Representation#Parallel Velocity 2|parallel velocity 2]]
* [[VVIEW2D: Demo Examples: Hatching Representation|hatching representation]]
** [[VVIEW2D: Demo Examples: Hatching Representation#Orthogonal Velocity 1|orthogonal velocity 1]]
** [[VVIEW2D: Demo Examples: Hatching Representation#Orthogonal Velocity 2|orthogonal velocity 2]]

Construction as well as appearance of the data presented can be easily modified using different switches from within the application program in an interactive way by the user (see [[VVIEW2D: Switches of the Program VVIEW2D|switches of the program VVIEW2D]]).

Display of a physical vector quantity in a vertical section can be done in the following different ways:

# Display of the value of the vector quantity as a background coloured isosurface representation (or hatching representation alternatively) can be overlaid by
## vector arrows of constant length to demonstrate the orientation of the vector, which was projected into the vertical section, or alternatively
## as vector circles with constant diameter to demonstrate the orientation of the orthogonal component of the vector quantity in the vertical section. The orientation of the flow can be seen in this representation.
# Display of the value of the orthogonal or parallel component of the vector quantity as a background coloured isosurface representation (or hatching representation alternatively) can be done similar to above.
# Display of the amount of the (total) vector, or of the amount of its orthogonal or parallel components without superposition of vector arrows.
# Display of the component of a vector filed which is parallel to the vertical section as a vector arrow, whose length is proportional to the value of the projected component (Attention: the vertical component of the vector may be strongly superelevated). The arrow may be filled using a colour which corresponds to the value of the arrow.
# Display of the component of a vector field which is orthogonal to the vertical section as vector circles. The diameter of the circles is proportional to the value of the component. The direction of the flow is made visible by means of centered small circles in cases where the velocity is oriented towards the observer or by means of crossing diameter lines which are indicative for flow flowing from the observer into the vertical section.

Besides an automatic presentation by VVIEW2D each figure can be manipulated in an interactive way by the user (deletion, shift, enlargement, reduction, insertion, ... of graphical objects).
|inputfiles=
# general '''input data''' (filetype [[VVIEW2D.DAT|vview2d.dat]])
# '''colours''' file (filetype [[COLORS.DAT|colors.dat]])
# all other input files are described in the before mentioned input data file.
Furthermore the following standard configuration files from the directory''' $PROGHOME/cfg/''' are required:
* GKS parameter file: '''gkssystem.computername.dat'''
* definition of physical quantities and physical units: '''phydef.cfg.de/en.dat''', '''phydef.cfg.rest.dat''', '''phydef.cfg.si.dat''', '''phydef-cf.cfg.dat'''
* definition of hatching styles: '''hatch.cfg.dat'''
* DE/EN fraction names: '''fracdef.cfg.dat'
|outputfiles=
# result files are described in the above mentioned input data file [[VVIEW2D.DAT|vview2d.dat]].
# informative '''printer file''' (filetype vview2d.master.sdr)
# (optional) '''trace''' of program execution (filetype vview2d.trc)
|methodology=
All data which shall be displayed using VVIEW2D must be stored in direct access files conforming to BAW-DHs universal direct access data format. The geometry is defined by an arbitrary number of segments which are interconnected to form one or more profiles. Above any profile node where data are defined an arbitrary number of layers of data points can be present which need not be equal spaced.
During the first processing step the program generates a grid made out of triangles together with additional auxillary informations (grid of the vertical section). In a second step the data are interpolated onto the nodes of the generated mesh. The type of the projection ist taken into account for vector quantities (orthogonal or parallel component of the vector).
After that, contour lines, vector arrows or vector circles etc., heaven and hell are added to the overall scene.
In the final processing stage all the data which have been assigned to the scene are converted into one of the several possible graphical representations (see also the examples given above).
|preprocessor=
[[ADCP2PROFILE]], [[DIDAMERGE]], [[FRQWF]], [[LZKMF]], [[LZKSF]], [[LZKVF]], [[LZKWF]], [[TELEMAC-2D]], [[TDKLF]], [[TDKSF]], [[TDKVF]], [[TDKWF]], [[TIMESHIFT]], [[TRIM-2D]], [[TRIM-3D]], [[UNTRIM]], [[UNTRIM2]], [[UNTRIM2007]], [[VTDK]], [[XTRLQ2]]
|postprocessor=
[[EDITOR]]
|language=Fortran90
|add_software=GKS (by GTS-Gral)
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
Ion A. Angell und Gareth H. Griffith, 1989: Praktische Einführung in die Computer-Graphik mit zahlreichen Programmbeispielen, Hanser Verlag, 360 Seiten.

template files are available in $PROGHOME/examples/Vview2d/
}}

VTDK

2022-09-06T11:55:19Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=VTDK
|name=VTDK
|version=February 2020
|version_descr=September 2022
|catchwords=
postprocessor 
differences for simulation results 
differences for data analysis results 
synoptic data 
tidal characteristic numbers 
tide-independent characteristic numbers 
estuaries 
alternative bathymetry 
universal direct access data format for 2D/3D-data 
universal direct access data format for profile-data 
universal direct access format for data at specific locations 
|shortdescription=
The program VTDK is a postprocessor for different numerical models (e.g. TRIM-2D, TRIM-3D, TELEMAC-2D, UNTRIM, UNTRIM2007 etc.). VTDK automatically computes either differences between synoptic data sets or differences between (tidal) characteristic numbers which were evaluated for different scenarious or calculated by different numerical models. 2D/3D data, profile data as well as location oriented data can be equivalently processed. For 2D/3D data the grids do not to need to coincide (e.g. number of nodes or location of nodes). The results of VTDK difference analyses may be visualized/displayed with the graphical postprocessors HVIEW2D (for 2D/3D-data), LQ2PRO/VVIEW2D (for profile-data) or GVIEW2D (for location-oriented data).

If there exist for the same period of data analysis different analyses results A and B, the following quantities will be calculated for every '''tidal characteristic number''':

# difference B - A for every tidal cycle
# maximum difference B - A
# minimum difference B - A
# significance for the deviation of the mean values
# difference of the mean values
# difference of the maximum values
# difference of the minimum values

For '''tide-independent characteristic numbers''' (same period of data analysis) the following quantities are calculated:

# difference B - A for the period of data analysis

For '''synoptic data sets''' (the data sets must cover the same period of time) the following differences are calculated:

# difference B - A for all dates of the synoptic data sets
|inputfiles=
# general '''input data''' (filetype [[VTDK.DAT|vtdk.dat]])
# (optional) '''data analyses''' for the systems A and B (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]], and [[DIRZ.BIN|dirz.bin]])
# (optional) '''synoptic data sets''' for the systems A and B (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]], and [[DIRZ.BIN|dirz.bin]])
# '''grid''' for 2D/3D-data (filetype [[GITTER05.DAT and GITTER05.BIN|gitter05.dat/bin]] or filetype [[SELAFIN|selafin]] or filetype [[UNTRIM_GRID.DAT|untrim_grid.dat]])
#: '''or''' profile-topography for profile-data (filetype [[PROFIL05.BIN|profil05.bin]])
#: '''or''' system file for specific locations (filetype [LOCATION_GRID.DAT|location_grid.dat]])

Notice: Which physical data are transformed using what ever mathematical operator must be defined in the configuration file '''$PROGHOME/cfg/phyvgl.cfg.dat'''.
|outputfiles=
# (optional) '''difference between the data analyses results''' (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]], and [[DIRZ.BIN|dirz.bin]])
# (optional) '''difference between synoptic data''' sets (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]], and [[DIRZ.BIN|dirz.bin]])
# (optional) '''difference between topographies''' (bathymetries) (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]], and [[DIRZ.BIN|dirz.bin]])
# informative '''printer''' file (filetype vtdk.sdr)
# (optional) '''trace''' of program execution (filetype vtdk.trc)
|methodology=
At the beginning the geometric differences are evaluated for the systems A and B (if there are any). These informations are needed to map the A results onto the B grid. Thereafter all results for the analysed events are read. The differences are calculated for each event as well as the maximum/minimum difference and also the statistical significance for the deviation of the means. Finally the differences for the mean, maximum and minimum values are evaluated. For synoptic data sets at the moment only differences for identical dates ar evaluated.
|preprocessor=
[[DATACONVERT]], [[DIDAMERGE]], [[DIDARENAME]], [[DIDASPLIT]], [[ENERF]], [[LZKMF]], [[LZKSF]], [[LZKVF]], [[LZKWF]], [[PGCALC]], [[TELEMAC-2D]], [[TM2DIDA]], [[TR2DIDA]], [[TR3DIDA]], [[TDKLF]], [[TDKSF]], [[TDKVF]], [[TDKWF]], [[TR2APP]], [[TRIM-2D]], [[TRIM-3D]], [[UNTRIM]], [[UNTRIM2007]]
|postprocessor=
[[ABDF]], [[DIDAMERGE]], [[DIDARENAME]], [[DIDASPLIT]], [[ENERF]], [[GVIEW2D]], [[HVIEW2D]], [[LQ2PRO]], [[VVIEW2D]], [[XTRDATA]]
|language=Fortran90
|add_software= -
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=please refer to $PROGHOME/examples/Vtdk/
}}

UNS

2022-09-06T11:52:43Z

Ak3glang: working group SIM

{{ProgramDescription
|name_de=UNS
|name=UNS
|version=1.x / March 2007
|version_descr=September 2022
|catchwords=
postprocessor 
mathematical model SediMorph 
bed load transport 
pre-computed water level (hydrodynamic numerical model) 
pre-computed current velocity (hydrodynamic numerical model) 
user defined water level 
user defined current velocity 
periodic continuation
|shortdescription=
Program UNS is used to apply the numerical simulation package [[Mathematical Model SEDIMORPH|SEDIMORPH]] using

* pre-computed data from a hydrodynamic numerical model, or using
* simple user defined data

for water level an current velocity. This postprocessor supports (sensitivity) studies with SediMorph related to bed load transport of sediments as well as resulting morphological evolution independent of a directly coupled hydrodynamic numerical model, e.g. [[UNTRIM]].
|inputfiles=
# '''steering data''' file of type [[UNS.DAT|uns.dat]]. The extended description for this file contains comprehensive informations with respect to steering data as well as input data files.
|outputfiles=
# '''printer file'''
#* uns.sdr.
# (optional) '''trace file'''
#* uns.trc.
|methodology=
Computational results from a hydrodynamic numerical model or more simple user-specified data are read by the program and transferred to the computational package SediMorph. The simulation period can be longer than the period for which input data are available (data read period). This enables the user to repeat a data read period several times which is also called periodic continuation.
|preprocessor=
[[DATACONVERT]], [[DIDAMERGE]], [[DIDASPLIT]], [[UNTRIM]]
|postprocessor=
[[ABDF]], [[ArcGIS-Applications]] (German version only), [[DIDAMERGE]], [[DIDARENAME]], [[DIDASPLIT]], [[HVIEW2D]], [[XTRDATA]], [[XTRLQ2]], [[ZEITR]]
|language=Fortran90
|add_software= -
|contact_original=G. Lang, D. Wehr
|contact_maintenance=[mailto:sim.proghome@baw.de Working group SIM]
|documentation=for example input files please refer to $PROGHOME/examples/uns/
}}

UNK

2022-09-06T11:50:09Z

Ak3glang: working group SIM

{{ProgramDescription
|name_de=UNK
|name=UNK
|version=January 2020
|version_descr=September 2022
|catchwords=
post-processor 
numerical simulation 
spectral wave model 
unstructured mesh 
two-dimensional 
transient, non-linear 
action density balance equation 
waves, sea, swell 
wave propagation 
shoaling 
refraction due to depth variation 
refraction due to current variation 
energy input due to wind action 
nonlinear dissipation due to wave-turbulence interactions 
dissipation due to wave-bottom interaction 
portable SMP and SIMD programming using [https://www.openmp.org/ OpenMP] 
automatic determination of time-step in agreement with CFL-condition 
constant alternative bathymetry depth 
dynamic bathymetry depth 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of [https://en.wikipedia.org/wiki/MD5 MD5 hash values] of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 

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/]).''
|shortdescription=
'''Method'''

Program UNK (unstructured k-model) is a post processor for different mathematical current models and can be used to compute the development, propagation and dissipation of waves, sea and swell in the ocean, coastal waters or estuaries. UNK uses as a computational core the Spectral Wave Model with Nonlinear Dissipation - K-Modell, see also literature below - which was developed at the [http://www.gkss.de/ GKSS-Forschungszentrum]. 
From version 7.x on UNK processes input files with alternative or dynamic bathymetry depth, the first indicating a constant depth, which differs from the rigid layer depth.

'''Physical Processes'''

The following physical processes are currently taken into account by UNK:

* conservation of wave action density (action density balance equation);
* advection of wave action density due to currents;
* shoaling of waves due to variation of water depth and/or current velocity;
* refraction of waves due to horizontal gradients of water depth and/or current velocity;
* wind forcing at the free surface;
* dissipation due to turbulent diffusion;
* dissipation due to bottom friction.

'''Computational Results'''

* integral wave parameters for waves, sea and swell:
** significant wave height;
** wave peak period;
** wave mean period TM-1;
** wave period TM1;
** wave period TM2;
** wave mean direction;
** wave mean directional spread;
** acceleration (due to radiation stress).
* two-dimensional spectra for waves, sea and swell:
** frequency-direction wave spectrum.

'''Validation Document'''

See literature below.
|inputfiles=
# '''steering data''' (filetype [[UNK.DAT|unk.dat]]).
# '''steering data for the k-model''' (filetype [[K_MODEL.DAT|k_model.dat]]).

'''Notice''': further input files can be found on the file description pages of the aforementioned files.
|outputfiles=
More details concerning output files can be found on the fact sheet for filetype [[K_MODEL.DAT|k_model.dat]]. In addition to these files the following files are also generated:

# (optional) informative '''printer file''' (Dateityp unk.sdr);
|methodology=
please refer to documentation/literature
|preprocessor=
[[DATACONVERT]], [[DIDASPLIT]], [[DIDAMERGE]], [[METDIDA]], [[NCDVAR]], [[NCMERGE]], [[TM2DIDA]], [[TR2DIDA]], [[UNTRIM]]
|postprocessor=
[[ABDF]], [[DAVIT]], [[DIDAMERGE]], [[DIDARENAME]], [[DIDASPLIT]], [[HVIEW2D]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[NCPLOT]], [[NCVIEW2D]], [[XTRDATA]], [[XTRLQ2]], [[ZEITR]]
|language=Fortran90
|add_software= -
|contact_original=G. Lang
|contact_maintenance=[mailto:sim.proghome@baw.de Working group SIM]
|documentation=
* example files: please refer to $PROGHOME/examples/unk/
* Schneggenburger, C. (1998) : Spectral Wave Modelling with Nonlinear Dissipation, dissertation, 117 pages, report no. GKSS 98/E/42, [http://www.gkss.de/ GKSS-Forschungszentrum] Geesthacht.
}}

TRVZR

2022-09-06T11:47:33Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=TRVZR
|name=TRVZR
|version=October 1997
|version_descr=September 2022
|catchwords=postprocessor 
finite difference method 
numerical model TRIM-2D 
numerical model TRIM-3D 
time series 
waterlevel analysis
|shortdescription=The program TRVZR analyses the hydrodynamic files of the numerical methods [[TRIM-2D]] and [[TRIM-3D]].
|inputfiles=
#general input data (filetype [[TRVZR.DAT|trvzr.dat]])
#bathymetry and index arrays (filetype [[TR2.TOPO.BIN.IND|tr2.topo.bin.ind]])
#Trim-2D or Trim-3D hydrodynamic result files (area) (filetype [[TR2.RESULT|tr2.result]])
#(opt) boundary polygon to desribe, which cells should be analysed (filetype [[POLY.DAT|poly.dat]])
|outputfiles=
#analyse result files (split into information, results and differences) (filetypes [[TR_H.INFO.DAT|tr_h.Info.dat]], [[TR_H.ERGEB.DAT|tr_h.ergeb.dat]] and [[TR_H.DELTA.DAT|tr_h.delta.dat]])
#(optional) trace of program execution (filetype trvzr.trc)
|methodology=Every Trim-2D or Trim-3D result file contains the calculated water levels for each grid cell for a single date. Further on, for every grid cell the undisturbed water depth is known, so that the program can calculate which cells are flooded and which cells are dropped dry. For all flooded cells the program calculates the extreme water level and water column, the value for the flooded surface and the volume of the water body. All these results are stored in a file of the type [[TR_H.ERGEB.DAT|tr_h.ergeb.dat]].

If there are more than one Trim-2D or Trim-3D result files, then the program can also calculate the time variation of all above result values and stores these results in a file of the type [[TR_H.DELTA.DAT|tr_h.delta.dat]].
|preprocessor=[[TRIM-2D]], [[TRIM-3D]]
|postprocessor= -
|language=Fortran77
|add_software=-
|contact_original=J. Jürges
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=please refer to $PROGHOME/examples/trvzr
}}

TRIMKACH

2022-09-06T11:45:27Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=TRIMKACH
|name=TRIMKACH
|version=V 2.x
|version_descr=September 2022
|catchwords=postprocessor 
finite difference method 
numerical model TRIM-2D 
numerical model TRIM-3D 
extraction of data 
diskspace
|shortdescription=The shell-script TRIMKACH is a postprocessor for the numerical models TRIM-2D and TRIM-3D. It permanently looks for resultfiles. If it finds at least one file, the suitable extraction-program will be started, either [[TR2KACHEL]] or [[TR3KACHEL]]. They will extract bathymetry, index-arrays and model results inside of rectangular tiles and optionally delete the results of the overall area.
This deletion is recommended in order to reduce the diskspace used by the model results. Only the smaller extracted resultfiles remain.
Furthermore you can start TRIMKACH before the model has terminated execution. TRIMKACH is able to extract data while the model is still running and producing new results.
|inputfiles=

'''Input-Files for extracting TRIM-2D-data:'''

#general input data (filetype [[TR2KACHEL.DAT|tr2kachel.dat]])
#on SGI a batch-file of type tr2kachel.qsub
#bathymetry and TRIM-2D-index-arrays (filetype [[TR2.TOPO.BIN.IND|tr2.topo.bin.ind]])
#model results (filetype [[TR2.RESULT|tr2.result]])

'''Input-Files for extracting TRIM-3D-data:'''

#general input data (filetype [[TR3KACHEL.DAT|tr3kachel.dat]])
#on SGI a batch-file of type tr3kachel.qsub
#bathymetry and TRIM-2D-index-arrays (filetype [[TR2.TOPO.BIN.IND|tr2.topo.bin.ind]])
#TRIM-3D-index-arrays (filetype [[TR2.TOPO.BIN.I3D|tr2.topo.bin.i3d]])
#(optional) model results (filetype [[TR3.RESULT|tr3.result]])

|outputfiles=

'''Output-Files after extraction of TRIM-2D-data:'''

#bathymetry and TRIM-2D-index-arrays for the tile(s) (filetype [[TR2.TOPO.BIN.IND|tr2.topo.bin.ind]])
#model results for the tile(s) (filetype [[TR2.RESULT|tr2.result]])
#informative printer file (filetype tr2kachel.sdr)
#(optional) trace of program execution (filetype tr2kachel.trc)

'''Output-Files after extraction of TRIM-3D-data:'''

#bathymetry and TRIM-2D-index-arrays for the tile(s) (filetype [[TR2.TOPO.BIN.IND|tr2.topo.bin.ind]])
#TRIM-3D-index-arrays for the tile(s) (filetype [[TR2.TOPO.BIN.I3D|tr2.topo.bin.i3d]])
#(optional) model results for the tile(s) (filetype [[TR3.RESULT|tr3.result]])
#informative printer file (filetype tr3kachel.sdr)
#(optional) trace of program execution (filetype tr3kachel.trc)
|methodology=At first you have to start trimkach_inst.sh to copy trimkach.[ext] and some input files into the working directory. Then you are able to edit the input files and to adapt the specified parameters in trimkach.[ext]. The extension [ext] can be "SGI" or "hp". An important parameter is TRIM23 which decides whether TRIMKACH processes 2D- or 3D-data.
The parameter LOESCH should be handled with care. After setting LOESCH="LOESCHEN" and successful extraction of data the overall resultfiles are deleted.
The user should watch the processing in the beginning because wrong parameters do not stop the script.

Similar to a "daemon" the shell-script starts a process whenever it finds a result file. Opposite to a "daemon" TRIMKACH can be stopped automatically. There are two ways to terminate the script:

#the product of WARTE_S * MAXSUCH determines the runtime in seconds;
#LETZTE_RES contains a string with the time of the last TRIM-2D- or TRIM-3D-result that should be processed.

A short help is available executing "trimkach.[ext] h" on the commandline.
|preprocessor=[[TRIM-2D]], [[TRIM-3D]]
|postprocessor=[[TR2DIDA]], [[TR3DIDA]], [[TR2GEOM]]
|language=UNIX-commands
AWK
|add_software=AWK
|contact_original=P. Schade
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=$PROGHOME/examples/trimkach/
}}

TR3MODATE

2022-09-06T11:43:15Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=TR3MODATE
|name=TR3MODATE
|version=February 1998
|version_descr=September 2022
|catchwords=postprocessor 
finite difference method 
date modification 
numerical model TRIM-3D
|shortdescription=The program TR3MODATE is a postprocessor for the numerical model TRIM-3D. This program serves to modify the date in a hydrodynamic output result file.
This program must be always used if the final hydrodynamic state of a simulation run should be used as inital state for a new run at a different date and time compared to the final time and date of the foregoing simulation.
|inputfiles=
#general input data (filetype [[TR3MODATE.DAT|tr3modate.dat]])
#hydrodynamic model results (filetype [[TR3.RESULT|tr3.result]])
|outputfiles=
#results with modified date and time (filetype [[TR3.RESULT|tr3.result]])
#informative printer file (filetype tr3modate.sdr)
#(optional) trace of program execution (filetype tr3modate.trc)
|methodology=Date, time and hydrodynamic results are read first. Subsequently date and time will be modified to fit the users needs and are stored together with the unchanged model results in a new results file.
|preprocessor=[[TRIM-3D]]
|postprocessor=[[TRIM-3D]]
|language=Fortran90
|add_software=-
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=$PROGHOME/examples/tr3modate/
}}

TR3KACHEL

2022-09-06T11:41:14Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=TR3KACHEL
|name=TR3KACHEL
|version=V 1.x
|version_descr=September 2022
|catchwords=postprocessor 
finite difference method 
numerical model TRIM-3D 
extraction of bathymetry for a tile 
extraction of TRIM-3D index-arrays for a tile 
extraction of TRIM-3D results for a tile
|shortdescription=The program TR3KACHEL is a postprocessor for the numerical model TRIM-3D. It has been designed to extract index arrays as well as bathymetries and computational results out of an overall model area. After running TR3KACHEL the files of the extracted tile have the same type but a reduced size. Therefore they can be processed much faster. Graphical display of very large model areas might be limited by the present hardware. In this case splitting the data is highly recommended.

Several tiles can be created during one run of TR3KACHEL. Optional deletion of the overall computational results is possible.

The shell-script [[TRIMKACH]] makes efficient processing with TR3KACHEL possible. It generates general input data and starts TR2KACHEL on its own whenever it finds a resultfile. The use of TRIMKACH reduces the diskspace used by model results.
|inputfiles=
#general input data (filetype [[TR3KACHEL.DAT|tr3kachel.dat]])
#bathymetry and TRIM-2D-index-arrays of the overall area (filetype [[TR2.TOPO.BIN.IND|tr2.topo.bin.ind]])
#TRIM-3D-index-arrays of the overall area (filetype [[TR2.TOPO.BIN.I3D|tr2.topo.bin.i3d]])
#(optional) TRIM-3D computational results of the overall area (filetype [[TR3.RESULT|tr3.result]])
|outputfiles=
#bathymetry and TRIM-2D-index-arrays of the tile(s) (filetype [[TR2.TOPO.BIN.IND|tr2.topo.bin.ind]])
#TRIM-3D-index-arrays of the tile(s) (filetype [[TR2.TOPO.BIN.I3D|tr2.topo.bin.i3d]])
#(optional) TRIM-3D computational results of the tile(s) (filetype [[TR3.RESULT|tr3.result]])
#informative printer file (filetype tr3kachel.sdr)
#(optional) trace of program execution (filetype tr3kachel.trc)
|methodology=By cutting the global data parallel to the x- and y-axis the program creates rectangular tiles. The number of elements in the x- or y-direction of a tile should be even in order to guarantee successful further processing. The information of each tile is stored in separate files.

When the file of type [[TR2.TOPO.BIN.I3D|tr2.topo.bin.i3d]] of the tile already exists TR3KACHEL does not recreate it and reads the index-arrays from harddisk.

The user does not have to bother with maximum array sizes. TR3KACHEL calculates all array sizes internally.
|preprocessor=[[TRIM-3D]]
|postprocessor=[[TR3DIDA]]
|language=Fortran90
|add_software=-
|contact_original=P. Schade
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=$PROGHOME/examples/tr3kachel/
}}

TR3DIDA

2022-09-06T11:39:06Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=TR3DIDA
|name=TR3DIDA
|version=January 2001
|version_descr=September 2022
|catchwords=postprocessor 
finite difference method 
data conversion 
universal direct access data format 
numerical model TRIM-3D
|shortdescription=
The program TR3DIDA is a postprocessor for the numerical model TRIM-3D. This program serves to convert the results stored in the TRIM-3D result files (water level elevation, current velocity, salinity) into BAW-DHs standard data format (universal direct access data format).
Optional results (e.g. wind shear stress and bottom shear stress) could be converted as well.
The application of this program is a necessity for the usage of various model-independent postprocessors (for graphics and data analysis).
|inputfiles=
# general input data (filetype [[TR3DIDA.DAT|tr3dida.dat]])
# bathymetry and index-arrays (filetype [[TR2.TOPO.BIN.IND|tr2.topo.bin.ind]])
# equivalent grid (filetype [[GITTER05.DAT and GITTER05.BIN|gitter05.dat/bin]]) Notice: This file must be generated by TR2GEOM before using this program.
# model results (filetype [[TR3.RESULT|tr3.result]])
# (optional) protection polygons (filetype [[NODES.SAVE|nodes.save]])
|outputfiles=
# converted results (files of type [[DIRZ.BIN.R| dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]])
# informative printer file (filetype tr3dida.sdr)
# (optional) trace of program execution (filetype tr3dida.trc)
|methodology=
The results of a TRIM-3D simulation are interpolated from the staggered nodes of the computational grid (U-, V- and H-nodes) onto the nodes of the equivalent grid (triangles). The error due to interpolation is mainly influenced by the grid-size as well as the local gradients of the physical quantities. The evolution of the bottom can be optionally calculated as the difference between the original bathymetry and the actual bathymetry.
|preprocessor=[[TR2GEOM]], [[TR3KACHEL]], [[TRIM-3D]], [[TRIMKACH]]
|postprocessor=[[ABDF]], [[DIDAMERGE]],[[DIDAMINTZ]], [[DIDARENAME]], [[DIDASPLIT]], [[ENERF]], [[GVIEW2D]], [[HVIEW2D]], [[IO_VOLUME]], [[PGCALC]], [[VTDK]], [[XTRLQ2]], [[ZEITR]]
|language=Fortran90
|add_software=-
|contact_original=S. Spohr
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=please refer to $PROGHOME/examples/tr3dida/
}}

TR2MODATE

2022-09-06T11:36:49Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=TR2MODATE
|name=TR2MODATE
|version=December 1997
|version_descr=September 2022
|catchwords=
postprocessor 
finite difference method 
date modification 
numerical model TRIM-2D
|shortdescription=The program TR2MODATE is a postprocessor for the numerical model TRIM-2D. This program serves to modify the date in a hydrodynamic output result file.
This program must be always used if the final hydrodynamic state of a simulation run should be used as inital state for a new run at a different date and time compared to the final time and date of the foregoing simulation.
|inputfiles=
# general input data (filetype [[TR2MODATE.DAT|tr2modate.dat]])
# bathymetry and index-arrays (filetype [[TR2.TOPO.BIN.IND|tr2.topo.bin.ind]])
# hydrodynamic model results (filetype [[TR2.RESULT|tr2.result]])
|outputfiles=
# results with modified date and time (filetype [[TR2.RESULT|tr2.result]])
# informative printer file (filetype tr2modate.sdr)
# (optional) trace of program execution (filetype tr2modate.trc)
|methodology=
Date, time and hydrodynamic results are read first. Subsequently date and time will be modified to fit the users needs and are stored together with the unchanged model results in a new results file.
|preprocessor=[[TRIM-2D]]
|postprocessor=[[TRIM-2D]]
|language=Fortran90
|add_software=-
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=$PROGHOME/examples/tr2modate/
}}

TR2KACHEL

2022-09-06T11:34:48Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=TR2KACHEL
|name=TR2KACHEL
|version=V 3.x
|version_descr=September 2022
|catchwords=postprocessor 
finite difference method 
numerical model TRIM-2D 
extraction of bathymetry for a tile 
extraction of data for a tile
|shortdescription=The program TR2KACHEL is a postprocessor for the numerical model TRIM-2D. This program has been designed to extract bathymetry for a tile out of the overall modell area. The program also extracts the computational results for this limited tile area from the results calculated for the whole domain and stores them in separate files. Optional deletion of the overall computational results is possible.

The reduction of the amount of data due to the extraction process can be favourably used during graphic display and analysis of the data.

Several piles can be treated at the same time.

Please regard the shell-script [[TRIMKACH]] that generates general input data and starts TR2KACHEL whenever it finds a resultfile. The use of TRIMKACH reduces the diskspace used by model results.
|inputfiles=
#general input data (filetype [[TR2KACHEL.DAT|tr2kachel.dat]])
#bathymetry and index-arrays (filetype [[TR2.TOPO.BIN.IND|tr2.topo.bin.ind]])
#model results (filetype [[TR2.RESULT|tr2.result]])
|outputfiles=
#bathymetry and index-arrays for the tile(s) (filetype [[TR2.TOPO.BIN.IND|tr2.topo.bin.ind]])
#model results for the tile(s) (filetype [[TR2.RESULT|tr2.result]])
#informative printer file (filetype tr2kachel.sdr)
#(optional) trace of program execution (filetype tr2kachel.trc)
|methodology=Bathymetry as well as computational results are extracted without loss of information from the global files and are stored for each tile in separate files.
|preprocessor=[[TRIM-2D]]
|postprocessor=[[TR2DIDA]], [[TR2GEOM]], [[TR2ISSUSKONVERT]]
|language=Fortran95
|add_software=-
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=$PROGHOME/examples/tr2kachel/
}}

TR2ISSUSKONVERT

2022-09-06T11:32:43Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=TR2ISSUSKONVERT
|name=TR2ISSUSKONVERT
|version=3.5 / April 2014
|version_descr=September 2022
|catchwords=
postprocessor 
service of data 
ship handling simulation 
hydronumeric methods 
depth averaged velocity 
|shortdescription=
A program to convert results of numerical models from BDF format or TRIM2D format to a format usable by ship handling simulators.
|inputfiles=
# general input data (file type [[TRISSUSKONVERT.DAT|tr2issuskonvert.dat]])
# BDF data with 2D depth averaged current velocities and water level (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]])
# (opt) 2D mesh file which is joined to the BDF data(file type [[GITTER05.DAT and GITTER05.BIN|gitter05.dat/bin]])
# (opt) profiles mesh which is joined to the BDF data (file type [[PROFIL05.BIN|profil05.bin]])
# (opt) UnTRIM mesh which is joined to the BDF data (file type [[UNTRIM_GRID.DAT|untrim_grid.dat]])
# (opt) zu den BDF-Daten gehöriges selafin-Gitternetz (file type [[SELAFIN|selafin]])
# alternativly to BDF files TRIM2D result files (file type [[TR2.RESULT|tr2.result]]) can be processed.
: The mesh files have to be present with progam start.
: The BDF files must be provided in time series mode.
|outputfiles=
# ASCII file format for use in ship handling simulators with 2D depth averaged velocities
# liste of positions in output (ASCII table)
# Druckerdatei mit Informationen zum Programmablauf (file type tr2issuskonvert.sdr)
# (opt) Datei mit Testausgaben (file type tr2issuskonvert.trc)
|methodology=
Each time serie position inside a BDF file will be processed. The data will be put out for the predefined frame and minimal bathymetric depth. The coordinates will be put out in either original coordinates of the topographic mesh or in geographic coordinates (WGS84).
|preprocessor=[[TR2KACHEL]], [[ZEITR]]
|postprocessor=ship handling simulators
|language=Fortran95
|add_software= libgeodesy, NTv2 grid transformation routines
|contact_original=G. Seiß
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=$PROGHOME/examples/tr2issuskonvert
}}

TR2DIDA

2022-09-06T11:30:36Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=TR2DIDA
|name=TR2DIDA
|version=V4.x - January 2001
|version_descr=September 2022
|catchwords=postprocessor 
finite difference method 
data conversion 
universal direct access data format 
numerical model TRIM-2D
|shortdescription=The program TR2DIDA is a postprocessor for the numerical model TRIM-2D. This program serves to convert the results stored in the TRIM-2D result files (water level elevation, current velocity, salinity, suspended sediment concentration, as well as deposited suspended sediment mass, bed load transport, deposited bed load material mass, time-varying bathymetry and bottom evolution (will be calculated from other results)) into BAW-DHs standard data format (universal direct access data format).
Optional results (e.g. wind shear stress and bottom shear stress) could be converted as well.
The application of this program is a necessity for the usage of various model-independent postprocessors (for graphics and data analysis).
|inputfiles=
#general input data (filetype [[TR2DIDA.DAT|tr2dida.dat]])
#bathymetry and index-arrays (filetype [[TR2.TOPO.BIN.IND|tr2.topo.bin.ind]])
#equivalent grid (filetype [[GITTER05.DAT and GITTER05.BIN|gitter05.dat/bin]]) or systemfile (filetype sysdat.bin, will no longer be supported in the future)
#:Notice: This file must be generated by TR2GEOM before using this program.
#model results (filetype [[TR2.RESULT|tr2.result]])
#(optional) protection polygons (filetype [[NODES.SAVE|nodes.save]])
|outputfiles=
#converted results (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]])
#informative printer file (filetype tr2dida.sdr)
#(optional) trace of program execution (filetype tr2dida.trc)
|methodology=The results of a TRIM-2D simulation are interpolated from the staggered nodes of the computational grid (U-, V- and H-nodes) onto the nodes of the equivalent grid (triangles). The error due to interpolation is mainly influenced by the grid-size as well as the local gradients of the physical quantities. The evolution of the bottom can be optionally calculated as the difference between the original bathymetry and the actual bathymetry.
|preprocessor=[[TRIM-2D]], [[TR2GEOM]], [[TR2KACHEL]] [[TRIMKACH]]
|postprocessor=[[ABDF]], [[ADCP2PROFILE]], [[DIDAMERGE]], [[DIDARENAME]], [[DIDASPLIT]], [[ENERF]], [[GVIEW2D]], [[HVIEW2D]], [[IO_VOLUME]], [[PARTRACE]], [[PGCALC]], [[UNK]], [[VTDK]], [[XTRLQ2]], [[ZEITR]]
|language=Fortran90
|add_software=-
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=$PROGHOME/examples/tr2dida/
}}

TR2ASCII

2022-09-06T11:28:21Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=TR2ASCII
|name=TR2ASCII
|version=August 1997
|version_descr=September 2022
|catchwords=postprocessor 
finite difference method 
data conversion 
ascii data format 
numerical model TRIM-2D
|shortdescription=
The program TR2ASCII is a postprocessor for the numerical model TRIM-2D. This program serves to convert the results stored in TRIM-2D result files (water level elevation, current velocity, salinity) into ASCII-format. The results are stored for the locations of the nodes where water level elevation is calculated (velocities are going to be interpolated). Whether a location is flooded or dry, this is also indicated in the ASCII output file. Data conversion can be restricted to nodes inside or outside a given polygon.
|inputfiles=
# general input data (filetype [[TR2ASCII.DAT|tr2ascii.dat]])
# bathymetry and index-arrays (filetype [[TR2.TOPO.BIN.IND|tr2.topo.bin.ind]])
# model results (filetype [[TR2.RESULT|tr2.result]])
# (optional) surrounding polygon (Dateityp [[POLY.DAT|poly.dat]])
|outputfiles=
# converted results (file of type [[OUTASCII.DAT|outascii.dat]])
# informative printer file (filetype tr2ascii.sdr)
# (optional) trace of program execution (filetype tr2ascii.trc)
|methodology=No further information.
|preprocessor=[[TRIM-2D]]
|postprocessor=Look at the results using an editor.
|language=Fortran90
|add_software=-
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=$PROGHOME/examples/tr2ascii/
}}

TM2DIDA

2022-09-06T11:26:00Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=TM2DIDA
|name=TM2DIDA
|version=4.x / August 2003
|version_descr=September 2022
|catchwords=postprocessor 
finite element grid 
data conversion 
universal direct access data format 
numerical model TELEMAC-2D 
numerical model TSEF
|shortdescription=The program TM2DIDA is a postprocessor for the numerical models TELEMAC-2D and TSEF. This program serves to convert the results stored in the TELEMAC-2D (or TSEF) results file (option 1) into BAW-DHs standard data format (universal direct access data format).
|inputfiles=
# general input data (filetype [[TM2DIDA.DAT|tm2dida.dat]])
#(option 1) results file which shall be converted (filetype [[SELAFIN|selafin]])
#:in the steering file of type cas the following options must have been chosen for the numerical simulation:
##'''RESULTS FILE STANDARD''': must be 3
##for TELEMAC-2D: '''VARIABLES FOR GRAPHIC PRINTOUTS:''' (B,S) or (H,S) must be specified in any case
##for TSEF: '''VARIABLES FOR GRAPHIC PRINTOUTS:''' (B,S) must be specified in any case
#(option 2) optimized grid and bathymetry (filetype [[GEO|geo]])
|outputfiles=
#grid (filetype [[GITTER05.DAT and GITTER05.BIN|gitter05.dat/bin]])
#list of edges (filetype [[FKVZ.BIN|fkvz.bin]])
#list of neighbour elements (filetype [[FKEZ.BIN|fkez.bin]])
#converted results (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]])
#informative printer file (filetype tm2dida.sdr)
#(optional) trace of program execution (filetype tm2dida.trc)
|methodology=the results are converted without any loss of information
|preprocessor=[[ANALTEL2D]], [[TELEMAC-2D]], TSEF
|postprocessor=[[ABDF]], [[DIDAMERGE]], [[DIDARENAME]], [[DIDASPLIT]], [[ENERF]], [[GVIEW2D]], [[HVIEW2D]], [[IO_VOLUME]], [[PARTRACE]], [[PGCALC]], [[UNK]], [[VTDK]], [[XTRLQ2]], [[ZEITR]]
|language=Fortran90
|add_software=-
|contact_original=T. Damrau, G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=$PROGHOME/examples/tm2dida/
}}

TDKWF

2022-09-06T11:23:26Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=TDKWF
|name=TDKWF
|version=February 2020
|version_descr=September 2022
|catchwords=postprocessor 
analysis of numerically calculated results (2D/3D, profile-data as well as data at specific locations) 
tidal characteristic numbers of water level 
tidal characteristic numbers of morphodynamics 
estuary 
universal direct access format for 2D/3D-data 
universal direct access format for profile-data 
universal direct access format for data at specific locations 
parallelization using [http://openmp.org/wp/ OpenMP] 
|shortdescription=The program TDKWF is a postprocessor for different numerical models (e.g. TRIM-2D, TRIM-3D, TELEMAC-2D, UNTRIM, UnTRIM2007, etc.). TDKWF automatically computes the tidal characteristic numbers of water level for a given set of results (universal direct access data format). Similarly the program can be used to compute the tidal characteristic numbers of morphodynamics (evolution of bottom bathymetry). The output of TDKWF may be visualized/displayed e.g. with the graphical postprocessors HVIEW2D (for 2D/3D-data) or LQ2PRO (for profile-data).

Within the period of data analysis the following [[Tidal Characteristic Numbers of Water Level|tidal characteristic numbers of water level]] are calculated (some numbers are optionally calculated):
* [[Tidal Characteristic Numbers of Water Level#High Water Level (HW)|High Water Level (HW)]]
* [[Tidal Characteristic Numbers of Water Level#Low Water Level (LW)|Low Water Level (LW)]]
* [[Tidal Characteristic Numbers of Water Level#Mean Tide Level|Mean Tide Level]]
* [[Tidal Characteristic Numbers of Water Level#Tidal Range|Tidal Range]]
* [[Tidal Characteristic Numbers of Water Level#Flood Period|Flood Period]]
* [[Tidal Characteristic Numbers of Water Level#Ebb Period|Ebb Period]]
* [[Tidal Characteristic Numbers of Water Level#Flood Period:Ebb Period|Flood Period:Ebb Period]]
* [[Tidal Characteristic Numbers of Water Level#High Water Time (T_HW)|High Water Time (T_HW)]]
* [[Tidal Characteristic Numbers of Water Level#Low Water Time (T_LW)|Low Water Time (T_LW)]]
* [[Tidal Characteristic Numbers of Water Level#Inundation Period|Inundation Period]]

Additionally the following [[Tidal Characteristic Numbers of Morphodynamics]] are calculated (some numbers are optionally calculated):
* [[Tidal Characteristic Numbers of Morphodynamics#Maximum Tidal Depth|Maximum Tidal Depth]]
* [[Tidal Characteristic Numbers of Morphodynamics#Minimum Tidal Depth|Minimum Tidal Depth]]
* [[Tidal Characteristic Numbers of Morphodynamics#Mean Tidal Depth|Mean Tidal Depth]]
* [[Tidal Characteristic Numbers of Morphodynamics#Tidal Depth Variation|Tidal Depth Variation]]
* [[Tidal Characteristic Numbers of Morphodynamics#Tidal Depth Change|Tidal Depth Change]]
* [[Tidal Characteristic Numbers of Morphodynamics#Tidal Erosion|Tidal Erosion]]
* [[Tidal Characteristic Numbers of Morphodynamics#Tidal Deposition|Tidal Deposition]]
* [[Tidal Characteristic Numbers of Morphodynamics#Tidal Deposition/Tidal Erosion|Tidal Deposition/Tidal Erosion (dimensionless number)]]
For each characteristic number of water level as well as morphodynamics the following values are calculated for the period of data analysis:

# Characteristic value for each tide within the period of data analysis
# Mean value for the period of data analysis
# Maximum value for the period of data analysis
# Minimum value for the period of data analysis

For some characteristic numbers the mean values are computed using the length of a period, e.g. tide duration as weight. Maximum and minimum values are computed differently in dependence on the meaning of the characteristic number. Example: maximum high water (HW) corresponds to the largest (highest rise of) water level, whereas maximum low water (LW) is given by the smallest (deepest fall of) water level.
|inputfiles=
# general '''time-series input data''' (filetype [[TDKWF.DAT|tdkwf.dat]])
# '''synoptic data''' which shall be analysed (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]], and [[DIRZ.BIN|dirz.bin]])
# '''grid''' for 2D/3D-data (filetype [[GITTER05.DAT and GITTER05.BIN|gitter05.dat/bin]] or filetype [[UNTRIM_GRID.DAT|untrim_grid.dat]])
: '''or''' profile-topography for profile-data (filetype [[PROFIL05.BIN|profil05.bin]])
: '''or''' system file for specific locations (filetype [[LOCATION_GRID.DAT|location_grid.dat]])
|outputfiles=
# results of data analyses (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]], and [[DIRZ.BIN|dirz.bin]])
# informative printer file (filetype tdkwf.sdr)
# (optional) trace of program execution (filetype tdkwf.trc)
|methodology=At first the extreme events (HW and LW) are determined for a network of reference locations for each tidal cycle. This ensures the phase-correct ordering of the events for all nodes of the computational grid, profile-topography or individual locations respectively. To arrive at a more precise calculation of the times and values for all tidal characteristic numbers of water level a spline interpolation is used to interpolate between equidistant time series data at each nodal point. Drying and wetting of tidal flats is taken into account by the algorithm.

In case of a time varying bathymetry (morphodynamics) the characteristic numbers of water level are evaluated using depth values corresponding to the minimum depth within the period of data analysis. This also holds true in case a so called alternative bathymetry is used, when the depth in the grid file is equivalent to the depth of the unerodible layer and the actual depth is constant in time but smaller than the depth specified in the grid file.

In all situations with actual depth different from depth given in the grid file, besides HW and LW also the values for maximum tidal depth as well as minimum tidal depth must be computed.
|preprocessor=[[DIDARENAME]], [[DIDASPLIT]], [[ZEITR]]
|postprocessor=[[ABDF]], [[DIDARENAME]], [[DIDASPLIT]], [[GVIEW2D]], [[HVIEW2D]], [[LQ2PRO]], [[VTDK]], [[VVIEW2D]], [[XTRDATA]]
|language=Fortran90
|add_software= -
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=please refer to $PROGHOME/examples/Tdkwf/
}}

TDKVF

2022-09-06T11:21:01Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=TDKVF
|name=TDKVF
|version=9.x / July 2009
|version_descr=September 2022
|catchwords=postprocessor 
analysis of numerically calculated results (2D/3D, profile-data as well as data at specific locations) 
tidal characteristic numbers of current 
estuaries 
static (alternative) bathymetry 
universal direct access data format for 2D/3D-data 
universal direct access data format for profile-data 
universal direct access format for data at specific locations 
parallelization using [http://openmp.org/wp/ OpenMP]
|shortdescription=
The program TDKVF is a postprocessor for different numerical models (e.g. TRIM-2D, TRIM-3D, TELEMAC-2D, UNTRIM, UnTRIM2007 etc.). TDKVF automatically computes the tidal characteristic numbers of current for a given set of results (universal direct access data format).
Data analyses can only be performed for static (constant in time) bathymetry. Bathymetry data must be either present in the grid file or given as alternative bathymetry in the data file containing also the computational results for water level.
The results of TDKVF analyses may be visualized/displayed with the graphical postprocessors HVIEW2D (for 2D/3D-data) or LQ2PRO (for profile-data).

Within the period of data analysis the following [[Tidal Characteristic Numbers of Current|tidal characteristic numbers of current]] are calculated (some numbers are optionally calculated):
*[[Tidal Characteristic Numbers of Current#Flood Current|Flood Current]]
** [[Tidal Characteristic Numbers of Current#Maximum Flood Current Velocity|Maximum Flood Current Velocity]]
** [[Tidal Characteristic Numbers of Current#Mean Flood Current Velocity|Mean Flood Current Velocity]]
** [[Tidal Characteristic Numbers of Current#Flood Volume|Flood Volume]]
** [[Tidal Characteristic Numbers of Current#Flood Current Duration|Flood Current Duration]]
** [[Tidal Characteristic Numbers of Current#Slack Water Time of Flood Current|Slack Water Time of Flood Current]]
** [[Tidal Characteristic Numbers of Current#Slack Water Duration around Slack Water Time of Flood Current|Slack Water Duration around Slack Water Time of Flood Current]]
** [[Tidal Characteristic Numbers of Current#Slack Water Dislocation of Flood Current|Slack Water Dislocation of Flood Current]]
** [[Tidal Characteristic Numbers of Current#Differences of Time of Maximum Flood Current between Different Locations|Differences of Time of Maximum Flood Current between Different Locations]]
** [[Tidal Characteristic Numbers of Current#Flood Path|Flood Path]]

* [[Tidal Characteristic Numbers of Current#Ebb Current|Ebb Current]]
** [[Tidal Characteristic Numbers of Current#Maximum Ebb Current Velocity|Maximum Ebb Current Velocity]]
** [[Tidal Characteristic Numbers of Current#Mean Ebb Current Velocity|Mean Ebb Current Velocity]]
** [[Tidal Characteristic Numbers of Current#Ebb Volume|Ebb Volume]]
** [[Tidal Characteristic Numbers of Current#Ebb Current Duration|Ebb Current Duration]]
** [[Tidal Characteristic Numbers of Current#Slack Water Time of Ebb Current|Slack Water Time of Ebb Current]]
** [[Tidal Characteristic Numbers of Current#Slack Water Duration around Slack Water Time of Ebb Current|Slack Water Duration around Slack Water Time of Ebb Current]]
** [[Tidal Characteristic Numbers of Current#Slack Water Dislocation of Ebb Current|Slack Water Dislocation of Ebb Current]]
** [[Tidal Characteristic Numbers of Current#Differences of Time of Maximum Ebb Current between Different Locations|Differences of Time of Maximum Ebb Current between Different Locations]]
** [[Tidal Characteristic Numbers of Current#Ebb Path|Ebb Path]]

* [[Tidal Characteristic Numbers of Current#Tidal Cycle|Tidal Cycle]]
** [[Tidal Characteristic Numbers of Current#Residual Current|Residual Current]]
** [[Tidal Characteristic Numbers of Current#Eulerian Residual Path|Eulerian Residual Path]]
** [[Tidal Characteristic Numbers of Current#Residual Flow|Residual Flow]]
** [[Tidal Characteristic Numbers of Current#Tide Volume|Tide Volume]]
** [[Tidal Characteristic Numbers of Current#Ratio Flood Current Duration : Ebb Current Duration|Ratio Flood Current Duration : Ebb Current Duration]]
** [[Tidal Characteristic Numbers of Current#Ratio Max. Flood Current Velocity : Max. Ebb Current Velocity|Ratio Max. Flood Current Velocity : Max. Ebb Current Velocity]]
** [[Tidal Characteristic Numbers of Current#Ratio Mean Flood Current Velocity : Mean Ebb Current Velocity|Ratio Mean Flood Current Velocity : Mean Ebb Current Velocity]]
** [[Tidal Characteristic Numbers of Current#Ratio Flood Path : Ebb Path|Ratio Flood Path : Ebb Path]]
** [[Tidal Characteristic Numbers of Current#Ratio Flood Volume : Ebb Volume|Ratio Flood Volume : Ebb Volume]]

For each characteristic number of current the following values are being calculated for the period of data analysis:
# Characteristic value for each tide within the period of data analysis
# Mean value for the period of data analysis
# Maximum value for the period of data analysis
# Minimum value for the period of data analysis
|inputfiles=
# general '''input data''' (filetype [[TDKVF.DAT|tdkvf.dat]])
# '''synoptic data''' which shall be analysed (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]]and [[DIRZ.BIN|dirz.bin]])
# '''grid''' for 2D/3D-data (filetype [[GITTER05.DAT and GITTER05.BIN|gitter05.dat/bin]] or filetype [[UNTRIM_GRID.DAT|untrim_grid.dat]]) '''or''' profile-topography for profile-data (filetype [[PROFIL05.BIN|profil05.bin]]) '''or''' system file for specific locations (filetype [[LOCATION_GRID.DAT|location_grid.dat]])
|outputfiles=
# '''results of data analyses''' (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]]and [[DIRZ.BIN|dirz.bin]])
# informative '''printer''' file (filetype Tdkvf.sdr)
# (optional) '''trace''' of program execution (filetype Tdkvf.trc)
|methodology=
At first some extreme events (HW and LW) for the water level are determined for a network of reference locations for each tidal cycle. This ensures the phase-correct ordering of the events for all nodes of the computational grid respectively profile-topography. This first step is followed by a calculation of the times of slack water (ebb slack and flood slack). Thereafter the tidal characteristic numbers for the current are calculated at all nodal points, using the formerly calculated results at the reference locations. To obtain a more precise calculation of the times and values for all tidal characteristic numbers of water level a spline interpolation is used to interpolate between equidistant time series data at each nodal point. Drying and wetting of tidal flats is taken into account by the algorithm.
|preprocessor=[[DIDARENAME]], [[DIDASPLIT]], [[ZEITR]]
|postprocessor=[[ABDF]], [[DIDARENAME]], [[DIDASPLIT]], [[GVIEW2D]], [[HVIEW2D]], [[LQ2PRO]], [[VTDK]], [[VVIEW2D]], [[XTRDATA]]
|language=Fortran90
|add_software=-
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=please refer to $PROGHOME/examples/Tdkvf/
}}

TDKSF

2022-09-06T11:18:50Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=TDKSF
|name=TDKSF
|version=10.x / August 2012
|version_descr=September 2022
|catchwords=postprocessor 
analysis of numerically calculated results (2D/3D, profile-data as well as data at specific locations) 
tidal characteristic numbers of salinity 
tidal characteristic numbers of suspended sediment 
tidal characteristic numbers of tracer load 
tidal characteristic numbers of temperature 
estuaries 
static (alternative) bathymetry 
universal direct access data format for 2D/3D-data 
universal direct access data format for profile-data 
universal direct access format for data at specific locations 
|shortdescription=The program TDKSF is a postprocessor for different numerical models (e.g. TRIM-2D, TRIM-3D, TELEMAC-2D, UNTRIM, UNTRIM2007, etc.).
TDKSF automatically computes the

* tidal characteristic numbers of salinity,
* tidal characteristic numbers of suspended sediment,
* tidal characteristic numbers of tracer load, or the
* tidal characteristic numbers of temperature.

for a given set of results (universal direct access data format).

Data analyses can only be performed for static (constant in time) bathymetry. Bathymetry data must be either present in the grid file or given as alternative bathymetry in the data file containing also the computational results for water level.
The results of TDKSF analyses may be visualized/displayed with the graphical postprocessors HVIEW2D (for 2D/3D-data), LQ2PRO (for profile-data) or GVIEW2D (for specific locations).

Within the period of data analysis the following tidal characteristic numbers of salinity are calculated (some numbers are optionally calculated):

* Flood Current
:* [[Tidal Characteristic Numbers of Salinity#Flood Current|Advective Salt Transport due to Flood Current]]
* Ebb Current
:* [[Tidal Characteristic Numbers of Salinity#Ebb Current|Advective Salt Transport due to Ebb Current]]
* Tidal Cycle
:* [[Tidal Characteristic Numbers of Salinity#Tidal Cycle|Maximum Salinity during a Tidal Cycle]]
:* [[Tidal Characteristic Numbers of Salinity#Tidal Cycle|Minimum Salinity during a Tidal Cycle]]
:* [[Tidal Characteristic Numbers of Salinity#Tidal Cycle|Mean Salinity during a Tidal Cycle]]
:* [[Tidal Characteristic Numbers of Salinity#Tidal Cycle|Variation of Salinity during a Tidal Cycle]]
:* [[Tidal Characteristic Numbers of Salinity#Tidal Cycle|Residual Advective Salt Transport during a Tidal Cycle]]
:* [[Tidal Characteristic Numbers of Salinity#Tidal Cycle|Ratio Advective Salt Transport due to Flood Current : Advective Salt Transport due to Ebb Current]]

Within the period of data analysis the following tidal characteristic numbers of suspended sediment transport are calculated (some numbers are optionally calculated):

* Flood Current
:* [[Tidal Characteristic Numbers of Suspended Sediment Transport#Flood Current|Advective Suspended Sediment Transport due to Flood Current]]
* Ebb Current
:* [[Tidal Characteristic Numbers of Suspended Sediment Transport#Ebb Current|Advective Suspended Sediment Transport due to Ebb Current]]
* Tidal Cycle
:* [[Tidal Characteristic Numbers of Suspended Sediment Transport#Tidal Cycle|Maximum Suspended Sediment Concentration during a Tidal Cycle]]
:* [[Tidal Characteristic Numbers of Suspended Sediment Transport#Tidal Cycle|Minimum Suspended Sediment Concentration during a Tidal Cycle]]
:* [[Tidal Characteristic Numbers of Suspended Sediment Transport#Tidal Cycle|Mean Suspended Sediment Concentration during a Tidal Cycle]]
:* [[Tidal Characteristic Numbers of Suspended Sediment Transport#Tidal Cycle|Variation of Suspended Sediment Concentration during a Tidal Cycle]]
:* [[Tidal Characteristic Numbers of Suspended Sediment Transport#Tidal Cycle|Residual Advective Suspended Sediment Transport during a Tidal Cycle]]
:* [[Tidal Characteristic Numbers of Suspended Sediment Transport#Tidal Cycle|Ratio Advective Suspended Sediment Transport due to Flood Current : Advective Suspended Sediment Transport due to Ebb Current]]

Within the period of data analysis the following tidal characteristic numbers of tracer transport are calculated (some numbers are optionally calculated):

* Flood Current
:* [[Tidal Characteristic Numbers of Tracer Load#Flood Current|Advective Tracer Transport due to Flood Current]]
* Ebb Current
:* [[Tidal Characteristic Numbers of Tracer Load#Ebb Current|Advective Tracer Transport due to Ebb Current]]
* Tidal Cycle
:* [[Tidal Characteristic Numbers of Tracer Load#Tidal Cycle|Maximum Tracer Concentration during a Tidal Cycle]]
:* [[Tidal Characteristic Numbers of Tracer Load#Tidal Cycle|Minimum Tracer Concentration during a Tidal Cycle]]
:* [[Tidal Characteristic Numbers of Tracer Load#Tidal Cycle|Mean Tracer Concentration during a Tidal Cycle]]
:* [[Tidal Characteristic Numbers of Tracer Load#Tidal Cycle|Variation of Tracer Concentration during a Tidal Cycle]]
:* [[Tidal Characteristic Numbers of Tracer Load#Tidal Cycle|Residual Advective Tracer Transport during a Tidal Cycle]]
:* [[Tidal Characteristic Numbers of Tracer Load#Tidal Cycle|Ratio Advective Tracer Transport due to Flood Current : Advective Tracer Transport due to Ebb Current]]

Within the period of data analysis the following tidal characteristic numbers of temperature (heat) transport are calculated (some numbers are optionally calculated):

* Flood Current
:* [[Tidal Characteristic Numbers of Temperature#Flood Current|Advective Heat Transport due to Flood Current]]
* Ebb Current
:* [[Tidal Characteristic Numbers of Temperature#Ebb Current|Advective Heat Transport due to Ebb Current]]
* Tidal Cycle
:* [[Tidal Characteristic Numbers of Temperature#Tidal Cycle|Maximum Temperature during a Tidal Cycle]]
:* [[Tidal Characteristic Numbers of Temperature#Tidal Cycle|Minimum Temperature during a Tidal Cycle]]
:* [[Tidal Characteristic Numbers of Temperature#Tidal Cycle|Mean Temperature during a Tidal Cycle]]
:* [[Tidal Characteristic Numbers of Temperature#Tidal Cycle|Variation of Temperature during a Tidal Cycle]]
:* [[Tidal Characteristic Numbers of Temperature#Tidal Cycle|Residual Advective Heat Transport during a Tidal Cycle]]
:* [[Tidal Characteristic Numbers of Temperature#Tidal Cycle|Ratio Advective Heat Transport due to Flood Current : Advective Heat Transport due to Ebb Current]]

For each characteristic number of salinity, suspended sediment concentration, tracer concentration or temperature the following values are being calculated for the period of data analysis:

# Characteristic value for each tide within the period of data analysis
# Mean value for the period of data analysis
# Maximum value for the period of data analysis
# Minimum value for the period of data analysis
|inputfiles=
# general input data (filetype [[TDKSF.DAT|tdksf.dat]])
# synoptic results which shall be analysed (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]])
# grid for 2D/3D-data (filetype [[GITTER05.DAT and GITTER05.BIN|gitter05.dat/bin]] or filetype [[UNTRIM_GRID.DAT|untrim_grid.dat]])
:'''or''' profile-topography for profile-data (filetype [[PROFIL05.BIN|profil05.bin]])
:'''or''' system file for specific locations (filetype [[LOCATION_GRID.DAT|location_grid.dat]])
|outputfiles=
# results of data analyses (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]])
# informative printer file (filetype Tdksf.sdr)
# (optional) trace of program execution (filetype Tdksf.trc)
|methodology=
At first some extreme events (HW and LW) for the water level are determined together with the times for slack water (ebb slack and flood slack) for a network of reference locations for each tidal cycle. This ensures the phase-correct ordering of the events for all nodes of the computational grid respectively profile-topography or specific locations. Thereafter the tidal characteristic numbers are calculated at all nodal points, using the formerly calculated results at the reference locations. To obtain a more precise calculation of the times and values for all tidal characteristic numbers a spline interpolation is used to interpolate between equidistant time series data at each nodal point. Drying and wetting of tidal flats is taken into account by the algorithm.
|preprocessor=[[DIDARENAME]], [[DIDASPLIT]], [[ZEITR]]
|postprocessor=[[ABDF]], [[DIDARENAME]], [[DIDASPLIT]], [[GVIEW2D]], [[HVIEW2D]], [[LQ2PRO]], [[VTDK]], [[VVIEW2D]], [[XTRDATA]]
|language=Fortran90
|add_software=-
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=please refer to $PROGHOME/examples/Tdksf/
}}

TDKLF

2022-09-06T11:16:15Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=TDKLF
|name=TDKLF
|version=8.x / September 2009
|version_descr=September 2022
|catchwords=postprocessor 
analysis of numerically calculated results (2D/3D, profile-data as well as data at specific locations) 
tidal characteristic numbers of bed load transport (several sediment fractions) 
tidal characteristic numbers of eff. bed shear stress action 
estuaries 
static (alternative bathymetry) 
universal direct access data format for 2D/3D-data 
universal direct access data format for profile-data 
universal direct access format for data at specific locations
|shortdescription=
The program TDKLF is a postprocessor for different numerical models (e.g. TRIM-2D, TRIM-3D, TELEMAC-2D, UNTRIM2007 etc.). TDKLF automatically computes some tidal characteristic numbers of bed load transport or eff. bed shear stress action for a given set of results (universal direct access data format). The results of TDKLF analyses may be visualized/displayed with the graphical postprocessors HVIEW2D (for 2D/3D-data) or LQ2PRO (for profile-data).

Within the period of data analysis the following [[Tidal Characteristic Numbers of Bed Load Transport|tidal characteristic numbers of bed load transport]] are calculated (some numbers are optionally calculated):

* Flood Current
:* [[Tidal Characteristic Numbers of Bed Load Transport|bed load transport due to flood current]]
* Ebb Current
:* [[Tidal Characteristic Numbers of Bed Load Transport|bed load transport due to ebb current]]
* Tidal Cycle
:* [[Tidal Characteristic Numbers of Bed Load Transport|residual bed load transport during a tidal cycle]]
:* [[Tidal Characteristic Numbers of Bed Load Transport|ratio bed load transport due to flood current : bed load transport due to ebb current]]

Several fractions of sediment can be treated at the same time.

Within the period of data analysis the following tidal characteristic numbers of eff. bed shear stress action are calculated (some numbers are optionally calculated):

* Flood Current
:* [[Tidal Characteristic Numbers of Eff. Bed Shear Stress Action#Flood Current|action of eff. bed shear stress due to flood-current]]
* Ebb Current
:* [[Tidal Characteristic Numbers of Eff. Bed Shear Stress Action#Flood Current|action of eff. bed shear stress due to ebb-current]]
* Tidal Cycle
:* [[Tidal Characteristic Numbers of Eff. Bed Shear Stress Action#Flood Current|residual action of the eff. bed shear stress]]
:* [[Tidal Characteristic Numbers of Eff. Bed Shear Stress Action#Flood Current|ratio between flood- and ebb-current-induced action of the eff. bed shear stress]]

Notice: the word action is used above synonymously for integration over time of the eff. bed shear stress.

For each characteristic number of bed load transport the following values are being calculated for the period of data analysis:

# Characteristic value for each tide within the period of data analysis
# Mean value for the period of data analysis
# Maximum value for the period of data analysis
# Minimum value for the period of data analysis
|inputfiles=
# general '''input data''' (filetype [[TDKLF.DAT|tdklf.dat]])
# '''synoptic data''' which shall be analysed (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]])
# '''grid''' for 2D/3D-data (filetype [[GITTER05.DAT and GITTER05.BIN|gitter05.dat/bin]] or filetype [[SELAFIN|selafin]] or filetype [[UNTRIM_GRID.DAT|untrim_grid.dat]])
::'''or''' profile-topography for profile-data (filetype [[PROFIL05.BIN|profil05.bin]])
::'''or''' system file for specific locations (filetype [[LOCATION_GRID.DAT|location_grid.dat]])
|outputfiles=
# '''results of data analyses''' (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]])
# informative '''printer''' file (filetype Tdklf.sdr)
# (optional) '''trace''' of program execution (filetype Tdklf.trc)
|methodology=
At first some extreme events (HW and LW) for the water level are determined together with the times for slack water (ebb slack and flood slack) for a network of reference locations for each tidal cycle. This ensures the phase-correct ordering of the events for all nodes of the computational grid respectively profile-topography. Thereafter the tidal characteristic numbers are calculated at all nodal points, using the formerly calculated results at the reference locations. To obtain a more precise calculation of the times and values for all tidal characteristic numbers a spline interpolation is used to interpolate between equidistant time series data (water level, current velocity and bed load transport rate or eff. bed shear stress) at each nodal point. Drying and wetting of tidal flats is taken into account by the algorithm.
|preprocessor=[[DIDARENAME]], [[DIDASPLIT]], [[ZEITR]]
|postprocessor=[[ABDF]], [[DIDARENAME]], [[DIDASPLIT]], [[GVIEW2D]], [[HVIEW2D]], [[LQ2PRO]], [[VTDK]], [[VVIEW2D]], [[XTRDATA]]
|language=Fortran90
|add_software=-
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=please refer to $PROGHOME/examples/Tdklf/
}}

TAYLORTARGETDIAGRAM

2022-09-06T11:13:53Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=TAYLORTARGETDIAGRAM
|name=taylorTargetDiagram
|version=May 2019
|version_descr=September 2022
|catchwords=
Taylor-Diagram 
Target-Diagram 
model accuracy 
comparison of model and measurement 
[[NetCDF|CF NetCDF]] format 
[[MATLAB]] [[category:MATLAB stand-alone application]] 

Acknowledgement: ''This project took advantage of netCDF software developed by UCAR/Unidata ([http://www.unidata.ucar.edu/software/netcdf/ www.unidata.ucar.edu/software/netcdf/]).''

|shortdescription=
The application taylorTargetDiagram (see also [[TAYLORTARGETDIAGRAM.DAT|taylorTargetDiagram.dat]]) allows to visualize variables for the estimation of model performance (e.g. calculated by [[NCDELTA]]) as taylor and target diagrams and list them as table. 

This Program is a further development of [[TAYLORDIAGRAM]]. 

In the Taylor-Diagram standard deviation, correlation as well as pattern root mean square error (PRMSE) between reference and variant (e.g. model and observation) are graphically displayed. The target diagram shows the centered root-mean-square deviation and the bias. The combined presentation of the statistical characteristics of different physical quantities and locations in one diagram is possible. The statistical characteristics at different locations can also be combined to a mean value. As reference and variant values for the calculations of differences and statistcs results of different simulations or analyses as well as comparisons between measurements and model results may be used. 

<gallery>
Taylor.png |Example picture Taylor diagram
Target.png | Example picture Target diagram
TaylorTargetTable.png |Example picture of the resulting table
</gallery>

In addition to the figures, a table including the following statistical values can be generated:
* Root Mean Square Error (RMSE)
* Taylor Skill 4 (Equation 4 in Taylor (2001))
* Taylor Skill 5 (Equation 5 in Taylor (2001))
* Centered Root-Mean-Square-Difference
* Bias (deviation of the mean values)
* Mean values of reference and variant parameters
* Standard deviation of reference and variant parameters
* Correlation between reference and variant parameters
* Attributes of the locations of the parameters compared in [[NCDELTA]] (cartesian and geographic coordinates, depth, location name)
* File name of the output file of [[NCDELTA]]
* Number of data points used for the comparison
 

|inputfiles=
# '''general input information''' (file type [[TAYLORTARGETDIAGRAM.DAT|taylorTargetDiagram.dat]]);
# '''[[NCDELTA]]-Output files''' format ([[CF-NETCDF.NC|cf-netcdf.nc]]).

|outputfiles=
# Taylor-Diagram as bitmap (*.JPG,*.PNG), as a vector graphic (*.PDF,*.EPS) or as a MATLAB figure file (*.FIG).
# Target-Diagram as bitmap (*.JPG,*.PNG), as a vector graphic (*.PDF,*.EPS) or as a MATLAB figure file (*.FIG).
# (optional) Table of the model performance quantities (*.XLS)
# (optional) Text file with meta-information (*.TXT).

|methodology=
The necessary statistical characteristics are read with [[MATLAB]] from [[NCDELTA]] result files and are visualized. The switch „With_Taylor_Diagram_Data=true“ has to be set to "true" in [[NCDELTA.DAT]] so that the required statistical values are included in the [[CF-NETCDF.NC|cf-netcdf]]-file written by [[NCDELTA]]. 
The visualization of model accuracy in the taylor diagram is done according to Taylor (2001). 
The visualization of model accuracy in the target diagram is done according to Jolliff et al. (2009).
 

|preprocessor=[[NCDELTA]]
|postprocessor=[[MATLABFIGVIEWER]], Excel
|language=[[MATLAB]]
|add_software= Linux: MATLAB Compiler Runtime MCR R2015a in directory /usr/local/MATLAB/R2015a
|contact_original=U. Schiller, J. Benndorf, C. Rasquin
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS] with U. Schiller, J. Benndorf and C. Rasquin
|documentation= Taylor, Karl E. (2001) "Summarizing multiple aspects of model performance in a single diagram". Journal of Geophysical Research, Vol 106, No. D7, April 16, 2001, Pages 7183 - 7192. 
Jolliff et al. (2009) “Summary diagrams for coupled hydrodynamic-ecosystem model skill as-sessment”. Journal of Marine Systems. Vol 76, Issues 1–2, 20 February 2009, Pages 64-82, ISSN 0924-7963 Siehe auch unter [[MATLAB]].
* Example files:
** Example files can be found in '''$PROGHOME/examples/taylorTargetDiagram/'''
** A presentation with further examples and information can be found in '''$PROGHOME/examples/taylorTargetDiagram/_doc'''
}}

QUICKPLOT

2022-09-06T11:09:53Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=QUICKPLOT
|name=QUICKPLOT
|version=Linux: 2.16 unknown revision 
Windows: 2.16.02941
|version_descr=September 2022
|catchwords=
visualization 
animation 
Delft3D 
NetCDF CF 
OPeNDAP 
Deltares 
[[MATLAB]] [[category:MATLAB stand-alone application]] 
|shortdescription=
Delft3D-QUICKPLOT is an interactive tool for the visualisation and animation of numerical data. Data can be downloaded from hard disk (no surprise) and directly from Web-Servers compliant with the OPeNDAP technology.

It has been developed by Deltares but is an open source software and can be adapted to own needs according to the LGPL. Although the use is rather intuitive there is a user manual available on the Deltares Homepage:
* [http://oss.deltares.nl/web/delft3d/manuals Delft3D-Manuals], then click Delft3D-QUICKPLOT_User_Manual.pdf

|inputfiles=
# [[NetCDF]]-CF data on unstructured grids,
# NetCDF-CF data on structured grids (see [[CF-NETCDF.NC]]),
# Delft3D grid files,
# Delft3D output files,
# Delft3D boundary condition files,
# Delft3D/SOBEK meteo files,
# Delwaq binary files,
# Delwaq timeseries input files,
# ArcInfo ASCII grid files,
# complete list in menu "File" -> "Open File ...".

|outputfiles=
* graphical formats:
# EPS,
# PDF,
# JPG,
# PNG etc, complete list in Figure n in menu "File" -> "Print/Export"
* data formats:
# MATLAB data files *.mat in different versions,
# Tecplot,
# Tekal,
# sample file.

|methodology=
-

|preprocessor=[[DATACONVERT]], [[Mathematical_Model_DELFT3D|Mathematical Model Delft3D]], [[NCANALYSE]], [[UNTRIM]], [[UNTRIM2]]
|postprocessor=[[MATLAB]], [[MATLABFIGVIEWER]]
|language=MATLAB, C, JAVA
|add_software= Linux: MATLAB Compiler Runtime MCR R2013b im Verzeichnis /usr/local/MATLAB/R2013b
|contact_original=Deltares, P. Schade
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=please refer to $PROGHOME/examples/quickplot, 
[http://oss.deltares.nl/web/delft3d/manuals Delft3D-Manuals], then click Delft3D-QUICKPLOT_User_Manual.pdf. 
Back to [[MATLAB]]
}}

PGCALC

2022-09-06T11:06:54Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=PGCALC
|name=PGCALC
|version=2.x / January 2001
|version_descr=September 2022
|catchwords=Layer Thickness 
Geodetic Height 
Density 
Pressure 
Universal Direct Access Data Format
|shortdescription=
The Program PGCALC generates with synoptical data from numerical models further special data, e.g. Layer Thickness, Geodetic Height, Density and Pressure.
|inputfiles=
# general '''input data''' file (filetype [[PGCALC.DAT|pgcalc.dat]])
# '''grid''' for 2D/3D-data (filetype [[GITTER05.DAT and GITTER05.BIN|gitter05.dat/bin]] or filetype [[UNTRIM_GRID.DAT|untrim_grid.dat]])
#: '''or''' profile-topography for profile-data (filetype [[PROFIL05.BIN|profil05.bin]])
#: '''or''' system file for specific locations (filetype [[LOCATION_GRID.DAT|location_grid.dat]])
# '''synoptic data''' with the necessary physical quantities as input data (filetype [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] und [[DIRZ.BIN|dirz.bin]])
|outputfiles=
# '''calculated data''' (filetype [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] und [[DIRZ.BIN|dirz.bin]])
# informative '''printer''' file (filetype pgcalc.sdr)
# (optional) '''trace''' of program execution (filetype pgcalc.trc)
|methodology=
The Program calculates independent of the numerical method additional physical quantities. These may be useful in further Postprocessors (e.g. [[ENERF]]). Depending on the input data, 2D or 3D output data is generated.

Remarks concerning the physical output quantinies:

* Geodetic Height:
: corresponds to the local centre of gravity in a water column or a layer, referred to mNN as the reference level.

* Layer Thickness:
: stands for the height of a water column or a layer.

* Density:
: calculated water density by using salt contension and temperature.

* Pressure: (Total Pressure)
: pressure in the centre of a water column or layer, calculated with density, layer thickness and gravity; the air pressure and if present the hydrodynamic water pressure
: are added to the total water pressure
|preprocessor=[[DATACONVERT]], [[DIDARENAME]], [[DIDASPLIT]], [[TELEMAC-2D]], [[TM2DIDA]], [[TR2DIDA]], [[TR3DIDA]], [[TRIM-2D]] (along profiles), [[TRIM-3D]] (along profiles), [[UNTRIM]], [[VTDK]]
|postprocessor=[[ABDF]], [[DIDARENAME]], [[DIDASPLIT]], [[DIDAMINTQ]], [[DIDAMINTZ]], [[ENERF]], [[GVIEW2D]], [[HVIEW2D]], [[LQ2PRO]], [[VTDK]], [[ZEITR]]
|language=Fortran90
|add_software=-
|contact_original=A. Cords
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=$PROGHOME/examples/pgcalc/pgcalc.dat
}}

PLOTPROFILZEIT

2022-09-06T11:04:46Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=PLOTPROFILZEIT
|name=plotProfilZeit
|version=Juli 2018
|version_descr=September 2022
|catchwords=
Profile 
Aggregation 
Perzentile 
Hovmoeller 
ProfilZeit 
[[MATLAB]] [[Kategorie:MATLAB stand-alone application]]

|shortdescription=
The application '''plotProfilZeit''' can be used to display data on profiles and time. Data can also be based on profiles in terms of adjascent control volumes. 

Warning: If you do not plan to use the good old [[XTRDATA]] Input format, please use the newly re-engineered programm [[NCPROFIL]] instead of plotProfilZeit. 

plotProfilZeit is the predecessor of [[DISPLAY_PERCENTILES]] und "DISPLAY_HOVMOLLER". Both had previously been developed to display data along a profile. However, both used the same data types and were different only in the way they presented the data. Therefore, to simplify application maintenance, both functionalities were incorporated into one application, plotProfilZeit. [[DISPLAY_PERCENTILES]] is still available, but will not be further developed. "DISPLAY_HOVMOLLER" not available anymore. 

Possible ways to display data: 
* Type = '''Hovmoeller''': Physical quantities, which are based on a profile and are dependant on time, can be displayed with a hovmoeller diagram. The spatial dimension is displayed along the x-axis and time is displayed along the y-axis. The physical value at each point is color-coded.
* Type = '''Percentiles''': The temporal variation of the values can also be displayed in this way. The spatial dimension is again displayed along the x-axis, but the physical value itself is displayed along the y-axis. The temporal average at each point is displayed as a solid line over the x-dimension. The temporal variation is displayed as a grey area in the background, which is the area between to chosen percentile values, default is 5 % and 95 %.
* Type = '''Allevents''': The temporal evolution is displayed by showing all available synoptic values as single lines along the profile. A color spectrum is used to show the temporal evolution, as long as not too many events are overlapping.
* Type = '''Multidata''': This allows no display of the temporal variation. Instead, values from different runs can be compared. Single values from different data sets are displayed in one diagram. The variables must not contain a time dimension, thus can either be averages of a tidal characteristic analysis or results of a long-term analysis. 

[[File:Mesh0 node skalare Stroemungsgeschwindigkeit 2d 1.png|400 px|Beispiel '''Hovmoeller''']]
[[File:CVSwmean Mesh2 face tide mean su sumen 2.png|400 px|Beispiel '''Percentiles''']]
[[File:TSM 2.png|400 px|Beispiel '''Allevents''']]
[[File:CVMesh2 exch hor adv ssc flux res sumen 1.png|400 px|Beispiel '''Multidata''']]

Input formats: 
* Input_Format = '''Xtrdata''': Output of [[XTRDATA]], available as single events along a profile, format being [[EXCEL.DAT|excel.dat]]
* Input_Format = '''CVMesh2''' for Netcdf analysis results fuer Netcdf as well as aggregated but not analysed simulation results
* Input_Format = '''Mesh1''' for Netcdf simulation output on profiles ([[DATACONVERT]] result of [[DIRZ.BIN|BDF]] profile file)
* Input_Format = '''Mesh0''' for Netcdf results on profiles (Profile output of UnTRIM2009)

Error handling:
In contrast to the prior version, this program does not yet include a check of the steering file by Fortran-Modul dictionary_ui. Therefore, wrong keywords can lead to uncontrolled crashes withou understandable error messages.

|inputfiles=
# Steering file (example in $PROGHOME/examples/plotProfilZeit, type [[plotProfilZeit_steer.dat]])
# [[UNTRIM]] results in above mentioned formats.

|outputfiles=
# Figures (*.pdf, *.png, *.eps or *.fig)
# Excel sheet (optional)

|methodology=
Visualization with [[MATLAB]]. 
Further, some statistic values are calculated by the program in case of Type = Percentiles. This used the following Matlab functions: 
* percentiles: prctile
* mean: nanmean (nan meaning that NaNs are not taken into account)
* median: nanmedian
* maximum: nanmax
* minimum: nanmin 

|preprocessor=[[XTRDATA]], [[DATACONVERT]], [[NCAGGREGATE]], [[NCANALYSE]], [[UNTRIM]]
|postprocessor=[[MATLABFIGVIEWER]]
|language=[[MATLAB]] (erstellt mit Version R2016b)
|add_software= Needs installation of MATLAB Compiler Runtime (under linux: /usr/local/MATLAB/MATLAB_Runtime/v85)
|contact_original=A. Zorndt
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS] with A. Zorndt
|documentation=
Examples can be found unter $PROGHOME/examples/plotProfilZeit/. 
Descriptions of the method can be found here:
http://de.mathworks.com/help/stats/descriptive-statistics.html . 

Thanks to Tabea Brodhagen, Marissa Albers und Jens Jürges.

}}

PARTRACE

2022-09-06T11:02:04Z

Ak3glang: working group SIM

{{ProgramDescription
|name_de=PARTRACE
|name=PARTRACE
|version=October 2011
|version_descr=September 2022
|catchwords=analysis of numerically calculated results (2D) 
stochastic particle model 
particle path 
turbulent dispersion 
sinking velocity 
drift velocity 
sediment transport
|shortdescription=
PARTRACE simulates the movement of particles with user-defined properties in a time-dependent 2D-depth-averaged flowfield, which has been computed e.g. with [[TRIM-2D]], [[TELEMAC-2D]] or [[UNTRIM]] (two-dimensional, depth averaged results only). It is a tool for analyzing the motion of the water-body and the transport of sediments in estuarine flows. PARTRACE needs the flowfield data as direct access files of the type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]] and [[DIRZ.BIN|dirz.bin]]. In the input file [[PARTRACE.DAT|partrace.dat]] the user specifies the number of particle-emitting sources, their location as well as number of particles to be tracked, seeding time intervall, and particle properties such as mass density, diameter, settling velocity, diffusion properties, ect.. The following influences on the particle motion are taken into account:

* 2D-depth-averaged velocity field
* vertical convergence or divergence of streamlines due to inclination of the seabed and of the water-level surface
* settling velocity
* random diffusion due to turbulence and dispersion due to depth-averaging of the velocity field
* constant particle drift velocity at the water surface

To the end of the simulation the history of particle locations is written to file insel.dat and can be visualized e.g. with HVIEW2D as pathlines in the domain.
|inputfiles=
# general '''input data''' (filetype [[PARTRACE.DAT|partrace.dat]])
# '''grid''' for 2D/3D-data (filetype [[GITTER05.DAT and GITTER05.BIN|gitter05.dat/bin]] or filetype [[UNTRIM_GRID.DAT|untrim_grid.dat]])
# '''egde list''' of triangular grid (file type [[FKVZ.BIN|fkvz.bin]])
# '''neighbor element list''' of triangular grid (file type [[FKVZ.BIN|fkez.bin]])
# '''synoptic flow field''' results (filetype [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]], and [[DIRZ.BIN|dirz.bin]])
# (optional) initial location of particles, e.g. from a previous run (file name ftn41 on HP, or fort.41 on SGI)
|outputfiles=
# '''particle paths''' (file [[INSEL.DAT|insel.dat]])
# for the first 4 particles, '''ascii-files''' containing:
#* z-coordinates of particle, of the seabed and of the water-level surface, the ladder at the paticle location, respectively, as function of time (file names ftn21, ftn22,
#: ftn23, ftn24 on HP, or fort.21, ... on SGI)
#* the 3 velocity components of the particle as a function of time (file names ftn31, ftn32, ftn33, ftn34 on HP, or fort.31, ... on SGI)
# '''printer''' file (filetype partrace.sdr)
# (optional) '''trace''' of program execution (filetype partrace.trc)
|methodology=
To capture the effect of the depth-averaged velocity field, its components U and V at the 3 nodes of the triangle where the particle is currently located in, at time instances before and after the current simulation time, are made available. These data are linearly interpolated to the current simulation time and bilinearly interpolated onto the location of the particle. The motion of the particle in the 3 spatial directions is described by 3 coupled ordinary differential equations (ODEs) in time. They contain the interpolated velocity components and terms that characterize the other physical effects listed above. The system of ODEs is solved stepwise using a standard-Runge-Kutta method (see Numerical Recipes). This finally yields the path of a particle in the flowfield.
More information about PARTRACE is given in [[Mathematical Model PARTRACE|The Mathematical Model PARTRACE]]. A thorough documentation of the physical modelling used its features can be found in the Programmbeschreibung des Partikelverfahrens PARTRACE (currently in german only, sorry!).
|preprocessor=[[DATACONVERT]], [[TELEMAC-2D]], [[TR2DIDA]], [[TM2DIDA]], [[UNTRIM]]
|postprocessor=[[HVIEW2D]], davit, xmgr
|language=Fortran 95, partly C
|add_software=-
|contact_original=F. Bergemann
|contact_maintenance=[mailto:sim.proghome@baw.de Working group SIM]
|documentation=
please refer to $PROGHOME/examples/partrace/

Download the program description (in german language only) as PDF-file [http://www.baw.de/downloads/wasserbau/mathematische_verfahren/pdf/partrace1.pdf partrace.pdf]
}}

NC2TABLE

2022-09-06T10:59:12Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=NC2TABLE
|name=NC2TABLE
|version=April 2018
|version_descr=September 2022
|catchwords=
data conversion 
postprocessor 
synoptic data sets 
[[NetCDF|CF NetCDF]] format 
[https://en.wikipedia.org/wiki/Comma-separated_values CSV format] (''comma separated values'') 
tabular data 
support of DMQS metadata and variables 
automatic adjustment of number of data READ to chunk size of input data

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/]).''

|shortdescription=
Program NC2TABLE allows selective data extraction from [[NetCDF|CF NetCDF]] files to [https://en.wikipedia.org/wiki/Comma-separated_values CSV files].
Extracted data ares stored in tabular form and may be subsequently used in spread sheet programs like MS EXCEL.

===General Introduction===

Geophysical variables '''f_i''' stored in (netCDF) data files are typically dependent on different numbers of coordinates. According to the CF metadata standard, time and date as well as geographical location are the required minimum.

General form of a variable (function):

f = f_i(t,x[,z][,l][,c])

In the above definition, '''t''' means time, '''x''' stands for the (horizontal) location, '''z''' is either height or depth, '''l''' symbolizes a ''label'' (e. g. a sediment fraction) and '''c''' is typically representing (other) classes, e. g. for a probability distribution.

Expressions function and variable are synonymously used in the following.

===Structure of Tables===

Tables consist out of rows and columns. Tables are best suited for the following data presentations:
# '''Table Type 1''' (functional profile): The dependence of '''f_i''' on two different coordinates is displayed. The values of (optionally) present other coordinates are frozen in. Example: water level in dependence on (discrete) space '''x_m''' and (discrete) time '''t_n'''.
#:Typical combinations for axes are:
#:* Time series (Ts): '''f(t,x)''' Ts for several locations, '''f(t,z)''' Ts for several vertical layers, '''f(t,l)''' Ts for multiple sediment fractions and '''f(t,c)''' Ts for various classes (probability distribution) or frequencies (spectrum).
#:* Dependence on horizontal position: '''f(x,z)''' variation over height or depth, '''f(x,l)''' variation over sediment fractions and '''f(x,c)''' variation over classes (probability distribution) or frequencies (spectrum).
#:* Dependence on vertical position: '''f(z,l)''' variation over sediment fractions and '''f(z,c)''' variation over classes (probability distribution) or frequencies (spectrum).
#:* Other: '''f(l,c)''' probability distribution for various sediment fractions.
# '''Table Type 2''' (comparison of functions): The dependence of several functions '''f_i''', with '''i=1,n_i''', in dependence on a single coordinate can be displayed. All other coordinate values remain frozen in. Example: time series of water level, current velocity and salinity for a specific location.

Program NC2TABLE supports both above mentioned types of tables. For date and time data items the time zone used can be
selected via file [[NC2TABLE.DAT|nc2table.dat]].

|inputfiles=
# '''general input data''' (file type [[NC2TABLE.DAT|nc2table.dat]]);
# '''geophysical data''' (file type [[CF-NETCDF.NC|cf-netcdf.nc]]).

|outputfiles=
# '''ASCII tables''' (file type [[NC2TABLE.CSV|nc2table.csv]]) in [https://en.wikipedia.org/wiki/Comma-separated_values CSV file format];
# '''Metadata''' (filetype nc2table.txt) in readable form (text file);
# (optional) informative '''printer file''' of program execution (file type nc2table.sdr)
# (optional) '''trace''' of program execution (file type nc2table.trc)

|methodology=
Binary data are extracted an printed in tabular form according to the user requirements.

Just in case '''HDF error''' is detected during read of a data record, the program tries to reconstruct the wanted data set from adjacent (in time) records for the same variable. This type of repair works for time dependent variables only.

|preprocessor=[[DATACONVERT]], [[GRIDCONVERT]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=spread sheet program, text editor
|language=Fortran95
|add_software=---
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
template files available in '''$PROGHOME/examples/nc2table'''
}}

NCVIEW2D

2022-09-06T10:56:54Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=NCVIEW2D
|name=NCVIEW2D
|version=March 2021
|version_descr=September 2022
|catchwords=oostprozessor 
time series 
[[CF-NETCDF.NC|cf-netcdf.nc]]

|shortdescription=
[[NCVIEW2D]] is applied to visualize [[CF-NETCDF.NC|cf-netcdf.nc]] data as time series. The following objects are within a plot:

# plot window(s) (also subplots)
# y-axis
# data

A plot window can also have two y-axis with 5 individual data sets each. E. g. plot window 1 and its y-axis 1 can contain the measured and modeled water level, while plot window 2 could show measured salinity on the left y-axis and discharge on the right y-axis.
Plot windows are placed from north to south. Below the lowes window, the UUID of the [[CF-NETCDF.NC|cf-netcdf.nc]] data may be displayed as legend.

<gallery>
Time series.example 1.de.png|example 1
Time series.example 2.en.png|example 2
Time series.example 3.en.png|example 3
</gallery>

|Remarks=
# Variable names can be obtained via ncdump -h myData.nc
# Measurements from [[BOEWRT]] can be converted to [[CF-NETCDF.NC|cf-netcdf.nc]] using [[DATACONVERT]] or [[BOE2NC]]
# Only the last y-label/y-limit of a figure and an axis is used for visualization
# The maximum number of plot windows is 3.
# This project took advantage of netCDF software developed by UCAR/Unidata ([http://www.unidata.ucar.edu/software/netcdf/ Link]).

|inputfiles=
# req: [[NCVIEW2D.DAT]]

|outputfiles=
# [[MATLAB]] figure *.fig
# [[DMQS]] metadata (stored in figure)
# program log *.sdr
# errors and warning *.err
# opt: plot data stored as spreadsheet or [https://de.mathworks.com/help/matlab/timetables.html MATLAB Timetable]
# opt: other formats such as *.jpg, *.tif, *.svg, *.pdf, *.png

|methodology=
This program was written in [[MATLAB]] and takes advantage of existing PROGHOME methods, such as unit conversion or i/o of [[BOEWRT]] data. The program is subdivided in the following sections:

# Reading and checking the steering file
# Testing of the existence of input data and its variables
# Testing of the plausibility of input parameters
# Extracting optional parameters, which have been given in [[NCVIEW2D.DAT]], other data is set to a default value.
# Data import (file, variables)
# opt: data operations
# opt: data smoothing
# Testing of existence of x-axis limits
# Initialising the figure environment
# Initialising the the axis
# Initialising the the legend
# Initialising the UUID legend (if requested)
# Initialising the figure title (if requested)
# Initialising the figure box and grid lines (if requested)
# Initialising the textboxes (if requested)
# Writing [[DMQS]] information in *.fig
# Export *.fig
# opt: export further formats (if requested)
# opt: export of data as spreadsheet (xlsx) or [https://de.mathworks.com/help/matlab/timetables.html MATLAB Timetable]
# controlled end

|preprocessor=[[UNTRIM]], [[UNTRIM2]], [[UNK]], [[DATACONVERT]], [[BOE2NC]], [[NCDELTA]], [[NCANALYSE]], [[NCCUTOUT]], [https://www.deltares.nl/en/software/delft3d-flexible-mesh-suite/ Delft3D-Flexible Mesh]
|postprocessor=[[MATLAB]]
|language=MATLAB r2020b
|add_software= keine
|contact_original=R. Hagen
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS] with R. Hagen and U. Schiller

|documentation=
* Template Files:
** template files available in '''$PROGHOME/examples/ncdelta'''
}}

NCPROFIL

2022-09-06T10:54:04Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=NCPROFIL
|name=ncprofil
|version=Juni 2021
|version_descr=September 2022
|catchwords=
Profile 
Aggregation 
Perzentile 
Hovmoeller 
plotProfilZeit 
[[MATLAB]] [[Kategorie:MATLAB stand-alone application]]

|shortdescription=
The application '''ncprofil''' can be used to display data on profiles and time. Data can also be based on profiles in terms of adjascent control volumes. 

ncprofil is the predecessor of [[PLOTPROFILZEIT]], which is still available but will not be further developed. The difference is a re-engineering and adaptation to the new standards for Matlab-Proghome Tools. In a next step, the netcdf reading routine will be updated. In the re-engineering, the old input format [[XTRDATA]] was not included. 

Possible ways to display data: 
* Type = '''Hovmoeller''': Physical quantities, which are based on a profile and are dependant on time, can be displayed with a hovmoeller diagram. The spatial dimension is displayed along the x-axis and time is displayed along the y-axis. The physical value at each point is color-coded.
* Type = '''Percentiles''': The temporal variation of the values can also be displayed in this way. The spatial dimension is again displayed along the x-axis, but the physical value itself is displayed along the y-axis. The temporal average at each point is displayed as a solid line over the x-dimension. The temporal variation is displayed as a grey area in the background, which is the area between to chosen percentile values, default is 5 % and 95 %.
* Type = '''Prognose''': From the percentiles, predictive values can be calculated, according to the procedure applied in the Weser Estuary. For this, each percentile is rounded up by a rounding parameter (i. e. 1 cm for water level). Then, along river stretches of i. e. 5 km, the maximum rounded value is found and this is interpreted as the predicitve value for this area. Beside the display of the percentiles (see above), this predictive value is shown as a red line. The x-axis is the spatial dimension, while the y-axis shows the physical quantity.
* Type = '''Allevents''': The temporal evolution is displayed by showing all available synoptic values as single lines along the profile. A color spectrum is used to show the temporal evolution, as long as not too many events are overlapping.
* Type = '''Multidata''': This allows no display of the temporal variation. Instead, values from different runs can be compared. Single values from different data sets are displayed in one diagram. The variables must not contain a time dimension, thus can either be averages of a tidal characteristic analysis or results of a long-term analysis. 

[[File:Mesh0 node skalare Stroemungsgeschwindigkeit 2d 1.png|400 px|Beispiel '''Hovmoeller''']]
[[File:CVSwmean Mesh2 face tide mean su sumen 2.png|400 px|Beispiel '''Percentiles''']]
[[File:TSM 2.png|400 px|Beispiel '''Allevents''']]
[[File:CVMesh2 exch hor adv ssc flux res sumen 1.png|400 px|Beispiel '''Multidata''']]

Input formats: 
* Input_Format = '''CVMesh2''' for Netcdf analysis results fuer Netcdf as well as aggregated but not analysed simulation results
* Input_Format = '''Mesh1''' for Netcdf simulation output on profiles ([[DATACONVERT]] result of [[DIRZ.BIN|BDF]] profile file)
* Input_Format = '''Mesh0''' for Netcdf results on profiles (Profile output of UnTRIM2009)

|inputfiles=
# Steering file (example in $PROGHOME/examples/ncprofil, type [[ncprofil_steer.dat]])
# [[UNTRIM]] results in above mentioned formats.

|outputfiles=
# Figures (*.pdf, *.png, *.eps or *.fig)
# Excel sheet (optional)

|methodology=
Visualization with [[MATLAB]]. 
Further, some statistic values are calculated by the program in case of Type = Percentiles. This used the following Matlab functions: 
* percentiles: prctile
* mean: nanmean (nan meaning that NaNs are not taken into account)
* median: nanmedian
* maximum: nanmax
* minimum: nanmin 

|preprocessor=[[NCAGGREGATE]], [[NCANALYSE]], [[UNTRIM]]
|postprocessor=[[MATLABFIGVIEWER]]
|language=[[MATLAB]] (erstellt mit Version R2016b)
|add_software= Needs installation of MATLAB Compiler Runtime (under linux: /usr/local/MATLAB/MATLAB_Runtime/v85)
|contact_original=A. Zorndt
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS] with A. Zorndt and U. Schiller
|documentation=
Examples can be found unter $PROGHOME/examples/plotProfilZeit/. 
Descriptions of the method can be found here:
http://de.mathworks.com/help/stats/descriptive-statistics.html . 

Thanks to Ulrike Schiller for your help in updating the program.

}}

NCPLOT

2022-09-06T10:50:37Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=NCPLOT
|name=NCPLOT
|version=March 2022
|version_descr=September 2022
|catchwords=graphical postprocessor 
graphical presentation of CF NetCDF data (unknown attributes are ignored) 
finite element models 
finite difference models 
orthogonal unstructured grid model 
orthogonal unstructured grid model with subgrid information 
conversion or transformation (extensive - intensive) of physical units 
calculation of new quantities (for display) from one or several input data sets 
(optional) filter based on water depth 
(optional) filter based on number of observations 

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/]).''

|shortdescription=
The graphical postprocessor NCPLOT can be used for a graphical presentation
of simulation and analysis results, which is stored in CF NetCDF data format.
The data can be defined on nodes, edges or faces. The program works on 2D-data,
3D-data and on data with details scaled on a subgrid. 
[[File:NcplotBspFaceArea.png|thumb|250px|Picture 1: Salinity with underlaid topography.]]

The sample pictures illustrate the capability of the program NCPLOT. 
[[NCPLOT: Example figures|Example figures: NCPLOT]]

Basically, NCPLOT distinguishes linear from areal chart types.
For area charts the symbolization of the data is depending on the data value
(color legend, proportional arrow).
For linear charts, the values of data series are plotted on an axis.
The symbolization of the data series is independent of the data value.
 

[[NCPLOT: Area Charts|Area Charts]]:
* Map, or top view illustration
* Vertical section along profile (3D data)
* Time depth diagram (3D data)
* Hovmöller diagram: Temporal development along profile.
 
[[NCPLOT: Line Charts|Line Charts]]: 
* time series
* profile view
* depth profile
 
NCPLOT allows you to illustrate different diagrams of different types in one picture.
Line diagrams next to areal charts with static and possibly dynamic parts.
 

Picture series: 
Both line and area chart definitions can request the creation of picture series.
A picture can contain static and dynamic image components.
Dynamic components means parts of the image that vary over a picture series.
 

The following rule applies to the program: 
The first read dynamic definition determines the permitted length of the
picture series.
The program aborts, if a further dynamic diagram definition results a
different number of images.
 

Further tests are not carried out.
 

Different series diagrams from dynamic diagram definitions of the same
length are processed by the program. The static picture elements are displayed
on every picture in the series.
 

|inputfiles=
# '''general input data''' (file type [[NCPLOT.DAT|ncplot.dat]])
# '''result files''' (file type [[CF-NETCDF.NC]])
# file with '''interval definitions''' for color legends (file type [[BOUNDS.CFG.DAT|bounds.cfg.dat]]) Hint: (Recommended) Local configuration file or file from the directory ''$PROGHOME/cfg/''.
# file with '''list of definitions of palettes''' (file type [[PALETTES.CFG.DAT|palettes.cfg.dat]]) Hint: (Recommended) Provided file from the directory ''$PROGHOME/cfg/'' or local configuration file.
# file with '''definitions of colors''' (file type [[COLORS.CFG.DAT|colors.cfg.dat]]) Hint: (Recommended) Provided file from the directory ''$PROGHOME/cfg/'' or local configuration file.

For NCPLOT the following standard configuration files from the directory '''''$PROGHOME/cfg/''''' are required:
* GKS parameter file: '''gkssystem.computername.dat'''

|outputfiles=
# '''graphic files''' (format: CGM or SVG)
# (optional) informative '''printer file''' of program execution (file type ncplot.sdr)
# (optional) '''trace''' of program execution (file type ncplot.trc)

|methodology=
NCPLOT is a pure plot program without any user interaction at runtime.
The layout of the picture and the graphical presentation of the data has to be
described in the steering file.
 

NCPLOT creates vector graphics in CGM or SVG format.
 

For special data files it is possible to exclude data at places with low water
coverage from the display. The technic works only on original UnTRIM result files
in CF NetCDF format.
 

Just in case '''HDF error''' is detected during read of a data record,
the program tries to reconstruct the wanted data set from adjacent (in time)
records for the same variable.
This type of repair works for time dependent variables only.
 

|preprocessor=[[BOE2NC]], [[DATACONVERT]], [[GRIDCONVERT]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCUTOUT]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=---
|language=Fortran95
|add_software=GKS (by GTS-Gral)
|contact_original=G. Lang, S. Spohr
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
template files available in '''$PROGHOME/examples/ncplot'''
}}

NCPOLO

2022-09-06T10:47:57Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=NCPOLO
|name=NCPOLO
|version=August 2019
|version_descr=September 2022
|catchwords=Postprocessor 
time series 
hodograph 
scatterplots 
model skill

|shortdescription=
[[NCPOLO]] is applied in model calibration and validation. It corroborates validation illustration and skill scores combined with various export possibilities. With [[NCPOLO]], a observation-prediction comparison can be performed quickly. For a successful application of [[NCPOLO]], all measurements and model data must be available in pooled [[CF-NETCDF.NC|cf-netcdf.nc]] data. A time and space correlated difference, which can be interpreted by [[NCPOLO]] must be created with [[NCDELTA]].

Remarks:
* One should use [[BOE2NC]] for the preprocessing of non-pooled [[BOEWRT.DAT]] data
* Measurements should be checked, as [[NCPOLO]] does not perform any plausibility checks on input data
* Measurement names must be one-of-a-kind, as more than one measurement (e. g. multiple depths) are not possible to interpret yet.
* Stations are named from the long_name of the [[NCDELTA]] variant
* Model data can be provided in 2d and 3d
* [[NCDELTA]] '''must''' be run with ''with_original_data = .true.''
* The station name will be used troughout illustrations and skill scores. Thus it is smart to chose a short name.
* The processing of chunked data is usually faster, when using [[NCDELTA]]. One can chunk a [[CF-NETCDF.NC|cf-netcdf.nc]] file using [[NCCHUNKIE]].
* As the output can be defined in multiple languages, with more than 5 detailed times per tide gauge, the output mass can grow quickly to more than 1,000. Therefore, a user should only enable the illustrations, which are absolutely required.

Output of [[NCPOLO]]:
* time series (complete, parts)
* scatter plots (colored by density, uniform)
* hodographs of current (colored by density, uniform)
* box-whisker error distribution
* statistics (33 parameters)
* data export (per gauge)
* statistics export (per gauge, all gauges)

|inputfiles=
* req: steering[[NCPOLO.DAT]]

|outputfiles=
* (req) log (type *.sdr)
* (req) errors and warnings (type *.err)
* (req) time series (type PNG, FIG, EPS, FIG)
* (opt) scatter plot (type PNG, FIG, EPS, FIG)
* (opt) hodograph (type PNG, FIG, EPS, FIG)
* (opt) box-whisker plots (type PNG, FIG, EPS, FIG)
* (opt) statistic distribution (type PNG, FIG, EPS, FIG)
* (opt) statistic parameters (type DAT, CSV, LATEX)
* (opt) comparison data (type DAT, CSV, MAT)
* (opt) statistic overview (type DAT, CSV, MAT)

|methodology=
This program was created with [[MATLAB]] and [[PROGHOME]] methods.

|preprocessor=[[NCDELTA]], [[NCDVAR]], [[NCMERGE]]
|postprocessor=[[MATLAB]]
|language=MATLAB r2019a
|add_software= keine
|contact_original=R. Hagen
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS] and R. Hagen
|documentation=
* Template Files:
** template files available in '''$PROGHOME/examples/ncpolo/'''
}}

NCMERGE

2022-09-06T10:43:59Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=NCMERGE
|name=NCMERGE
|version=July 2022
|version_descr=September 2022
|catchwords=
postprocessor 
Merge contents of various [[CF-NETCDF.NC|netcdf.nc]] files 
Change of time step for optional time-equidistant data records 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of the [https://en.wikipedia.org/wiki/MD5 MD5 hash] values of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
optional use of ''Message Passing Interface'' (MPI, [https://www.mpi-forum.org/ MPI Forum])

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/]).''

|shortdescription=
The program enables merging variables from multiple [[CF-NETCDF.NC|netcdf.nc]] input files into one single [[CF-NETCDF.NC|netcdf.nc]] output file.

|inputfiles=
# '''general input data''' (file type [[NCMERGE.DAT|ncmerge.dat]]);
# '''Input data''', multiple files (file type [[CF-NETCDF.NC|cf-netcdf.nc]]).

|outputfiles=
# '''Output data''' (file type [[CF-NETCDF.NC|netcdf.nc]])
# (optional) informative '''printer file''' of program execution (file type ncmerge.sdr)
# (optional) '''trace''' of program execution (file type ncmerge.trc)

|methodology=
The program is subdivided into the following sections:
# Read, check and print the control data of the user;
# Read metadata of the input data;
# Transfer metadata into internal data objects;
# Classification of all variables of the input files;
# Determine transfer operations for primary variables;
# Determine transfer operations for all other variables;
# Comparison of the input data specified by the user with the data available in the input file;
# Create common time coordinate variables for all output variables;
# (optional) Adjustment of MD5 hash values between all input data files;
# Copy the variables to be transferred from the input files to the output file.

|preprocessor=[[DATACONVERT]], [[BOE2NC]], [[NCAGGREGATE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCRCATMAT]], [[NetCDF Operators]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=[[DAVIT]], [[NCAUTO]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCPLOT]], [[NCPOLO]], [[NC2TABLE]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|language=Fortran95
|add_software=none
|contact_original=G. Lang, S. Spohr
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
* [https://izw-campus.baw.de/ ''IZW-Campus''] (Podcast, available in German only)
** 2022-02-14: [https://izw-campus.baw.de/goto.php?target=cat_3742&client_id=iliasclient ''NCMERGE - Anwendung, Struktur, Code-Beispiele''].
* Template Files:
** template files available in '''$PROGHOME/examples/ncmerge'''
}}

NCDVAR

2022-09-06T10:41:58Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=NCDVAR
|name=NCDVAR
|version=August 2022
|version_descr=September 2022
|catchwords=
postprocessor 
Selective deletion or copying of variables in a [[CF-NETCDF.NC|netcdf.nc]] file 
Delete/Copy coordinate variables of a certain type (X-Y or LON-LAT) 
Delete/Copy variables belonging to a grid (''Mesh'') 
Delete/Copy of individual variables 
Deletion/Copying of individuual dates of synoptic, time-equidistant data records 
Automatic setting of the WRITE chunk size 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of the [https://en.wikipedia.org/wiki/MD5 MD5 hash] values of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
optional use of ''Message Passing Interface'' (MPI, [https://www.mpi-forum.org/ MPI Forum])

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/]).''

|shortdescription=
The program enables the selective deletion / copying of variables in a [[CF-NETCDF.NC|netcdf.nc]] input file into an equivalent output file.

|inputfiles=
# '''general input data''' (file type [[NCDVAR.DAT|ncdvar.dat]]);
# '''Input data''', data record to be thinned (file type [[CF-NETCDF.NC|cf-netcdf.nc]]).

|outputfiles=
# '''Output data''' (file type [[CF-NETCDF.NC|netcdf.nc]])
# (optional) informative '''printer file''' of program execution (file type ncdvar.sdr)
# (optional) '''trace''' of program execution (file type ncdvar.trc)

|methodology=
The program is subdivided into the following sections:
# Read, check and print the control data of the user;
# Read metadata of the input data;
# Transfer metadata into internal data objects;
# Classification of all variables of the input file;
# Comparison of the input data specified by the user with the data available in the input file;
# Mark all primary variables that can be selected by the user with '''COPY''' or '''DELETE''';
# Deriving the transfer method (COPY, DELETE) for the variables used by the primary variables (coordinate variable, auxiliary variable, etc.);
# Copy the variables to be transferred from the input to the output file.

|preprocessor=[[DATACONVERT]], [[BOE2NC]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCRCATMAT]], [[NetCDF Operators]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=[[DAVIT]], [[NCAUTO]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCPLOT]], [[NCPOLO]], [[NC2TABLE]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|language=Fortran95
|add_software=none
|contact_original=G. Lang, S. Spohr
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
* Template Files:
** template files available in '''$PROGHOME/examples/ncdvar'''
}}

NCDELTA

2022-09-06T10:39:34Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=NCDELTA
|name=NCDELTA
|version=June 2022
|version_descr=September 2022
|catchwords=
postprocessor 
differences of synoptic data (with optional restriction of time period) 
differences of characteristic numbers 
differences for extensive quantities 
input data for Taylor diagram 
median, percentiles (Q01, Q05, Q95, Q99) 
skill score according to Murphy (1988) equation 4 
skill score according to Taylor (2001) equations 4 and 5 
skill score according to Willmott (1981) Index of agreement (d) 
parallelization using [http://openmp.org/wp/ OpenMP] 
[[NetCDF#Quality assurance using NetCDF attributes|automatic quality assurance (value range)]] 
automatic adjustment of number of READ data to chunk size of data 
automatic setting of WRITE chunk sizes for written variables 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of [https://en.wikipedia.org/wiki/MD5 MD5 hash values] of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
optional use of ''Message Passing Interface'' (MPI, [https://www.mpi-forum.org/ MPI Forum])

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/]).''

|shortdescription=
Program computes differences for comparable variables (primary variable pairs) as well as additional statistical data derived from primary differences, but also data for Taylor diagrams (details see [[Differences of Calculated Results]]) can be computed for some types of data. Finding the primary variable pairs is done in an essentially automatical manner but can be altered to some extent by the user (see [[NCDELTA.DAT|ncdelta.dat]]). Primary differences are computed according to ''variant data'' '''minus''' ''reference data''.

Requirements for time-dependent primary variable pairs with individual constant time step:
# both data sets may contain a ''different'' number of data items (time steps), but the length of the time period to be compared must be identical, whereas the periods to be compared may differ ;
# constant time step for each data set may differ from each other, but the larger time step must an integer multiple of the smaller one.

Requirements for time-dependent primary variable pairs with variable time step:
# both data sets must contain an ''identical'' number of data items (time steps), with periods allowed to be different.

Remarks concerning the spatial location of data:
# data sets may differ with respect to their geographical location;
# areas for which data are defined must overlap to some degree;
# coordinates may be given in different coordinate systems, e. g. Gauß-Krüger and UTM;
# data for a location are compared with data for the nearest lying location, as far as the distance between the different locations does not exceed a prescribed maximum (see [[NCDELTA.DAT|ncdelta.dat]]).

Remarks concerning the comparison of extensive variables:
# for extensive variables the respective sizes of the computational cells (area, length) are taken into account.

|inputfiles=
# '''general input data''' (file type [[NCDELTA.DAT|ncdelta.dat]]);
# '''reference data''' (file type [[CF-NETCDF.NC]]);
# '''variant data''' (file type [[CF-NETCDF.NC]]);
# for [[NetCDF#Automatic quality assurance using NetCDF attributes|automatic quality assurance]] (file type [[BOUNDS.CFG.DAT|bounds_verify.dat]]).

|outputfiles=
# '''results''' (file type [[CF-NETCDF.NC]])
# (optional) informative '''printer file''' of program execution (file type ncdelta.sdr)
# (optional) '''trace''' of program execution (file type ncdelta.trc)

|methodology=
The program is subdivided into the following sections:
# read, check and print steering data prescribed by the user;
# read metadata for ''reference data'';
# read metadata for ''variant data'';
# copy metadata for reference as well as variant data to program specific data structures;
# compare metadata for substantial discrepancies (e. g. reference locations) between data sets;
# classify all reference as well as variant data;
# find primary variable pairs: each variant variable has one partner reference variable; primary computational results will be later derived from primary variable pairs;
# derive variables to be copied from reference as well as variant data file into the result file;
# compute interpolation matrices required for interpolation between reference data locations and variant data locations;
# create all metadata for the result file; essentially they stem from variables to be copied, from primary result variables, newly generated coordinate variables (time, vertical), as well as newly derived or to be copied measure and auxiliary variables;
# copy selceted variables from reference as well as variant file to the result file;
# compute all primary variables, (new) time and vertical coordinate variables, as well as weights and auxiliary variables. For primary variables optionally available axiliary variables with ''standard_name'' modifier ''status_flag'' are taken into account in case meaning ''good'' is represented by an appropriate flag (bit).
# with respect of the different skill scores used and computed by the program - references:
#* Murphy, Allan H. (1988) "Skill Scores Based on the Mean Square Error and Their Relationship to the Correlation Coefficient". Monthly Weather Review, Dec. 1988, Pages 2417 - 2424.
#* Taylor, Karl E. (2001) "Summarizing multiple aspects of model performance in a single diagram". Journal of Geophysical Research, Vol 106, No. D7, April 16, 2001, Pages 7183 - 7192.
#* Willmott, Cort J. (1981) "On the validation of models". Physical Geography, Pages 184–194.
Just in case '''HDF error''' is detected during read of a data record, the program tries to reconstruct the wanted data set from adjacent (in time) records for the same variable. This type of repair works for time dependent variables only.

|preprocessor=[[BOE2NC]], [[DATACONVERT]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCRCATMAT]], [[NetCDF Operators]], [[UNK]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=[[DAVIT]], [[NCAUTO]], [[NCCHUNKIE]], [[NCPOLO]], [[NCPLOT]], [[NCCUTOUT]], [[NC2TABLE]], [[NCVIEW2D]], [[PLOTTS]], [[TAYLORDIAGRAM]]
|language=Fortran95
|add_software=none
|contact_original=G. Lang, S. Spohr
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
* Presentations (available in German only):
** 2015-07-15: [http://ewisa.baw.de/files/12835_tv12_2015_07_15_ncdelta_g_lang.pdf ''NCDELTA - Differenzen neu berechnet''].
* [https://izw-campus.baw.de/ ''IZW-Campus''] (Podcast, available in German only)
** 2022-05-30: [https://izw-campus.baw.de/goto.php?target=cat_4308&client_id=iliasclient ''NCDELTA - Berechnung von Differenzen''].
* Template Files:
** template files available in '''$PROGHOME/examples/ncdelta'''
}}

NCCUTOUT

2022-09-06T10:36:49Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=NCCUTOUT
|name=NCCUTOUT
|version=July 2022
|version_descr=September 2022
|catchwords=
data analysis 
postprocessor 
cut out data 
synoptic data sets 
[[Analysis_of_Calculated_Results#Tidal_Characteristic_Numbers|tidal characteristic numbers]] 
[[Analysis_of_Calculated_Results#Characteristic_Numbers_.28independent_of_the_presence_of_tides.29|tide-independent characteristic numbers]] 
differences of data sets 
[[NetCDF|CF NetCDF]] format for 2D/3D data 
support of computational results based on sub-grid bathymetry 
support of DMQS metadata and variables 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of [https://en.wikipedia.org/wiki/MD5 MD5 hash values] of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
optional use of ''Message Passing Interface'' (MPI, [https://www.mpi-forum.org/ MPI Forum])

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/]).''

|shortdescription=
[[File:Nccutout_one_polygon.png|250px|thumb|right|Fig. 1: Results of the German Bight cut out from the modell area of the project EasyGSH-DB (BAW, 2018)]]
The postprocessor NCCUTOUT may help users to reduce the size of result files in order to save disk space and computation time in the subsequent processing steps. It cuts out data of UGRID compliant NetCDF files of the area type. In UGRID metadata language the files have to have at least one mesh topology variable with the attribute topology_dimension = 2. The cutting is typically defined by a polygon. The elements inside of the polygon get extracted to the result file. 

[[File:Nccutout_more_polygons.png|250px|thumb|right|Fig. 2: Results at separate faces (see north western and south eastern part) cut out of a model of the Jade Weser Estuary (BAW, 2018) ]]
But the cut out area can also be defined by two or more polygons which need not be direct neighbours, s. Fig. 2. Though the results may look like seperate spots of a location grid they share a common mesh topology.

Furthermore, the user can reduce disk space by extracting only a subset of the original geophysical variables. He can add them to a white list or alternatively to a black list. 
|inputfiles=
# '''general input data''' (file type [[NCCUTOUT.DAT|nccutout.dat]]);
# '''input UGRID CF NetCDFs''' (file type [[CF-NETCDF.NC|cf-netcdf.nc]]);
# '''cutout polygons''' (file type [[IPDS.DAT|ipds.dat]]);
# for [[NetCDF#Automatic quality assurance using NetCDF attributes|automatic quality assurance]] (file type [[BOUNDS.CFG.DAT|bounds_verify.dat]]).

|outputfiles=
# '''output UGRID CF NetCDFs''' (file type [[CF-NETCDF.NC|cf-netcdf.nc]]);
# (optional) informative '''printer file''' of program execution (file type nccutout.sdr)
# (optional) '''trace''' of program execution (file type nccutout.trc)

|methodology=
[[File:Nccutout_faces_subfaces.png|250px|thumb|right|Fig. 3: Extracting faces with all their subfaces in order to generate consistent meshes.(BAW,2018)]] NCCUTOUT can process NetCDF files supporting the UGRID idea of parent and child meshes, e.g. a computational grid with a coarse and a sub grid with higher resolution. Whether data gets cut out or not depends from the position of the geometric elements in the coarsest mesh. This is displayed in Fig. 3. Certain faces of the coarser computational grid are cut out and subsequently all subfaces inside these coarser faces are extracted. This method leads to consistent meshes and parent child connections.

Regarding the postprocessing workflow it is recommended to use NCCUTOUT directly after the numerical engines, e.g. UNTRIM2007 and UnTRIM2, so that the complete postprocessing benefits from the reduction.

An introduction how to collect DMQS metadata can be found [[Metadata_of_Model_results_in_Coastal_Engineering|here]].

Performance: Most of the program's CPU time is used by basic IO routines. Since output is in the tested examples considerably slower than input a reduction of the output data, area and geophysical variables, makes NCCUTOUT run faster.

|preprocessor=[[NCANALYSE]], [[NCCHUNKIE]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=[[DAVIT]], [[NCAGGREGATE]], [[NCANALYSE]], [[NCAUTO]], [[NCCHUNKIE]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[NCPLOT]], [[NC2TABLE]] and [[MATLAB]]
|language=Fortran95
|add_software=---
|contact_original=P. Schade, G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
* Template Files:
** general template files available in '''$PROGHOME/examples/nccutout'''
** in test directory for hydro-dynamic [[UNTRIM2007]] results: '''$PROGHOME/examples/nccutout/run/utr2007/elbe/nccut'''
** in test directory for hydro-dynamic [[UNTRIM2]] results: '''$PROGHOME/examples/nccutout/run/utr2009/easy/nccut'''
** in test directory for [[NCANALYSE]] results: '''$PROGHOME/examples/nccutout/run/ncana/easy/nccut'''
}}

Program Descriptions

2022-09-06T10:34:10Z

Ak3glang: working groups added

__NOAUTOLINKS__
__NOAUTOLINKTARGET__
[[de:Programmkennblätter]]
{| width="80%"
| align="left" | At the BAW-DH there exists a comprehensive collection of software which has been mostly developed by the staff of the BAW-DH. The software was developed to assist engineers in solving practical problems. This page gives you a list in alphabetical order of the most important programs in use. For every listed program a short description of its functionality is available. More than that, you will also find information on closely related programs (fore-runners and after-runners). In addition to this an [[overview]] of required and optional input-files is given together with an enumerated list of the output-files generated by the program. 

The majority of the programs are written in Fortran (FORTRAN77, Fortran90, Fortran95, Fortran 2003). For details about the Fortran programming language see e. g.
[https://software.intel.com/en-us/node/525392 ''Intel Language Reference'']
|-
|
{| width="80%" cellpadding="5"
|- bgcolor="#d3d3d3"
! colspan="3" | explanation of colour codes
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| colspan="2" width="95%" valign="top" |
'''processing of measured data, preprocessing''' ''responsible''<nowiki>: </nowiki>P. Schade and G. Seiß ([mailto:pre.proghome@baw.de Working group PRE])
|- valign="top"
| width="5%" bgcolor="#0000ff" valign="top" | Sim
| colspan="2" width="95%" valign="top" |
'''numerical simulation''' ''responsible''<nowiki>: </nowiki>B. Fricke, A. Sehili and H. Weilbeer ([mailto:sim.proghome@baw.de Working group SIM])
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| colspan="2" width="95%" valign="top" |
'''postprocessing for numerical models and data analysis''' ''responsible''<nowiki>: </nowiki>J. Jürges, A. Rosenhagen and S. Spohr ([mailto:pos.proghome@baw.de Working group POS])
|- valign="top"
| width="5%" bgcolor="#ffff00" valign="top" | Son
| colspan="2" width="95%" valign="top" | '''others''' ''responsible''<nowiki>: individuals which are responsible for program maintenance.</nowiki>
|- bgcolor="#d3d3d3"
! colspan="3" | Advice to Users
|- valign="top"
| colspan="3" | users of the programs who detect errors or deficiencies should contact one of the above mentioned responsibles in dependence on the group to which the application program belongs.
|- bgcolor="#d3d3d3"
! colspan="3" | A
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[ABDF]]
| width="75%" valign="top" | analysis of data stored in direct access data files (BDF)
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[ADCP2BDF]]
| width="75%" valign="top" | conversion of ADCP workhorse data to BDF data format
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[ADCP2PROFILE]]
| width="75%" valign="top" | conversion of ADCP profile data to BDF data format
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[ANALTEL2D]]
| width="75%" valign="top" | interactive modification of a file of type ''selafin''
|- bgcolor="#d3d3d3"
! colspan="3" | B
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[BATCHPLOT]]
| width="75%" valign="top" | post processor for batch oriented visualisation of data
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[BFABSENK]]
| width="75%" valign="top" | computing of height changes inside groyne areas
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[BOERND]]
| width="75%" valign="top" | generation of boundary time-series (preparatory stage)
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[BSH2BAW]]
| width="75%" valign="top" | conversion of meteorological data into the ''mkwswawrt'' format
|- bgcolor="#d3d3d3"
! colspan="3" | C
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[CREATE_SIMPLE_UNTRIM2_GRID|create_simple_untrim2_grid]]
| width="75%" valign="top" | create simple grid for [[UNTRIM2]]
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[CROSSPRO]]
| width="75%" valign="top" | calculation and output of cross-sectional profiles, lying orthographical to a defined longitudinal river fairway profile
|- bgcolor="#d3d3d3"
! colspan="3" | D
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[DATA2GEOM]]
| width="75%" valign="top" | Conversion of BSH ASCII files to geom files
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[DATACONVERT]]
| width="75%" valign="top" | Conversion of Delft3D computational grid as well as computational results
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[DATAUS]]
| width="75%" valign="top" | extraction of soundings of an interesting area from ASCII-files (x,y,z) of various formats
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[DAVIT]]
| width="75%" valign="top" | interaktive visualisation and exploration of modelling results
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[DEPRO2D]]
| width="75%" valign="top" | interactive definition of profiles
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[DIDAMERGE]]
| width="75%" valign="top" | merging and thinning (in time) for synoptic data sets
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[DIDAMINTQ]]
| width="75%" valign="top" | integration and averaging for synoptic data sets along cross sections
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[DIDAMINTZ]]
| width="75%" valign="top" | calculation of depth integrated or averaged results for synoptic data sets
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[DIDARENAME]]
| width="75%" valign="top" | change of BDF file names
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[DIDASPLIT]]
| width="75%" valign="top" | splitting of large data sets or bathymetries into subdomains
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[DISPLAY_CONTROL_VOLUMES|display_control_volumes]]
| width="75%" valign="top" | tabular representation of spatially and temporally aggregated fluxes
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[DISPLAY_PERCENTILES|display_percentiles]]
| width="75%" valign="top" | visualization of statistics calculated with profile data
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[DREHE2D]]
| width="75%" valign="top" | translation and rotation of coordinates which are stored in different file types
|- bgcolor="#d3d3d3"
! colspan="3" | E
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[EDITOR]]
| width="75%" valign="top" | interactive modification and generation of GKS graphics
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[ENERF]]
| width="75%" valign="top" | calculation of synoptical quantities (e.g. energy flux) by using data results of numerical models
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[EVENTFILTER]]
| width="75%" valign="top" | filter of high and low water events and evaluation of their mean values
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[EXCELENZ]]
| width="75%" valign="top" | conversion of time-series data for further analysis or graphical display
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[EXKNO]]
| width="75%" valign="top" | extraction of time-series from model output at specific locations
|- bgcolor="#d3d3d3"
! colspan="3" | F
|- valign="top"
| width="5%" bgcolor="#ffff00" valign="top" | Son
| width="20%" valign="top" |
[[F77_TO_F90]]
| width="75%" valign="top" | rewrite FORTRAN77 source code to FORTRAN90 source code
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FD2ADDTOPO]]
| width="75%" valign="top" | creates an update grid for finite differences topography from echo soundings and updates a finite differences topography
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FD2BASIS]]
| width="75%" valign="top" | creates a basic grid with correct land/water distribution (format FIDISOR/FIDIRB) by using digitized border lines
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FD2DEL]]
| width="75%" valign="top" | creates difference topography from FIDISOR grids / modifies a FIDISOR grid with a difference topography
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FD2HYPSO]]
| width="75%" valign="top" | calculation of a frequency distribution of depth values of a finite difference topograph
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FD2KACHEL]]
| width="75%" valign="top" | generation of a tile-bathymetry and tile-data for FIDISOR/FIDIRB result files
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FD2MET]]
| width="75%" valign="top" | generation of meteorological boundary value files for finite difference methods
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FD2MOD]]
| width="75%" valign="top" | modify an area in a difference of two finite difference topographies
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FD2RIBA]]
| width="75%" valign="top" | dredging fairways in finite difference topographies
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FD2SPUELER]]
| width="75%" valign="top" | filling of fairways in finite difference topographies
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FD2TRIM]]
| width="75%" valign="top" | conversion of a FIDIRB-bathymetry into an equivalent TRIM-grid
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FDGITTER05]]
| width="75%" valign="top" | graphical preprocessor for finite difference grids
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FDGLUE]]
| width="75%" valign="top" | glues two meshes into a new finite difference grid
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FFT]]
| width="75%" valign="top" | fast fourier transformation of time series
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FILELIST_TO_GEOM]]
| width="75%" valign="top" | rewrite coordinates of many files containing a single location into one file
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[FRQ2ZEITR]]
| width="75%" valign="top" | calculation of time series of the waterlevel from information about the frequencies, phases and amplitudes of the tidal harmonic constituents
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[FRQTIE]]
| width="75%" valign="top" | link result data of the program ''FRQWF'' to create new relationships
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[FRQWF]]
| width="75%" valign="top" | tidal harmonic analysis of water level
|- bgcolor="#d3d3d3"
! colspan="3" | G
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[GEOMFD2]]
| width="75%" valign="top" | generation of FD model bathymetry (FIDISOR/FIDIRB) and calendar-matrix
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[GEOTRANSFORMER]]
| width="75%" valign="top" | transformation of coordinates between different coordinate systems for different BAW file types.
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[GETDATA]]
| width="75%" valign="top" | Conversion of Delft3D computational results into netCDF files
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
| width="75%" valign="top" |
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[GRIDCONVERT]]
| width="75%" valign="top" | Converts computational grids for different mathematical methods
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| rowspan="3" width="20%" valign="top" |
[[GVIEW2D]]
| rowspan="3" width="75%" valign="top" | Graphical representation of time-dependent physical quantities at a given position (so called geo position)
|- valign="bottom"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
|- valign="bottom"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
|- bgcolor="#d3d3d3"
! colspan="3" | H
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[HSV]]
| width="75%" valign="top" | computation of settling velocities with a steering file ([[SV.DAT|sv.dat]]) of the SV package (SV=Settling Velocity)
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[HVIEW2D]]
| width="75%" valign="top" |two-dimensional graphical representation of CFD-data
|- bgcolor="#d3d3d3"
! colspan="3" | I
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[IGEL2D]]
| width="75%" valign="top" | interactive calculation of a borderline enclosing bearing data
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[INSEL2IPDS|insel2ipds]]
| width="75%" valign="top" | read several insel.dat and create one ipds file
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[INSPECT_CONTROL_VOLUMES|inspect_control_volumes]]
| width="75%" valign="top" | time series visualization of aggregated transport quantities
|- valign="top"
| width="5%" bgcolor="#ffff00" valign="top" | Son
| width="20%" valign="top" |
[[IO_VOLUME]]
| width="75%" valign="top" | converting data into the volume model for visualisation software profiles
|- bgcolor="#d3d3d3"
! colspan="3" | J
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[JANET]]
| width="75%" valign="top" | Interactive mesh generation and optimization tool
|- bgcolor="#d3d3d3"
! colspan="3" | K
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[KACHEL2D]]
| width="75%" valign="top" | extraction of part grids out of a finite element model grid
|- bgcolor="#d3d3d3"
! colspan="3" | L
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[LQ2PRO]]
| width="75%" valign="top" | visualization of data along longitudinal and/or cross-sectional profiles
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[LZKAF]]
| width="75%" valign="top" | calculation of long-term characteristic numbers of atmosphere
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[LZKMF]]
| width="75%" valign="top" | calculation of tide-independent characteristic numbers of morphodynamics
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[LZKSF]]
| width="75%" valign="top" | calculation of tide-independent characteristic numbers of salinity, temperature, suspended load, tracer load, bed load transport or eff. bed shear stress action
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[LZKVF]]
| width="75%" valign="top" | calculation of tide-independent characteristic numbers of current velocity
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[LZKWF]]
| width="75%" valign="top" | calculation of tide-independent characteristic numbers of water level
|- bgcolor="#d3d3d3"
! colspan="3" | M
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[MEDIANGLAETTUNG]]
| width="75%" valign="top" | smoothing of topographical information
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[MESKOR]]
| width="75%" valign="top" | correction of time-series data
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[METDIDA]]
| width="75%" valign="top" | conversion of meteorological data into the BAW-DH direct access format
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[MKRDAT]]
| width="75%" valign="top" | Generation of soil identification numbers for TRIM-2D
|- bgcolor="#d3d3d3"
! colspan="3" | N
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[NCAGGREGATE]]
| width="75%" valign="top" | aggregation for control volumes of data stored in (BAW) [[NetCDF|CF NetCDF]] files.
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[NCANALYSE]]
| width="75%" valign="top" | analysis program for data stored in (BAW) [[NetCDF|CF NetCDF]] files.
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[NCAUTO]]
| width="75%" valign="top" | classification of variables and extreme value analysis for (BAW) [[NetCDF|CF NetCDF]] files.
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[NCCHUNKIE]]
| width="75%" valign="top" | create chunked [[NetCDF|CF NetCDF]] files.
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[NCCUTOUT]]
| width="75%" valign="top" | cut out [[NetCDF|UGRID CF NetCDF]] files.
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[NCDELTA]]
| width="75%" valign="top" | program to compute differences for data stored in (BAW) [[NetCDF|CF NetCDF]] files.
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[NCDVAR]]
| width="75%" valign="top" | deletion of selected variables and dates from (BAW) [[NetCDF|CF NetCDF]] files.
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[NCMERGE]]
| width="75%" valign="top" | merge variables from different (BAW) [[NetCDF|CF NetCDF]] files in one single [[NetCDF|CF NetCDF]] file.
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[NCPLOT]]
| width="75%" valign="top" | plot program for visualisation of data stored in (BAW) [[NetCDF|CF NetCDF]] files.
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[NCPROFIL]]
| width="75%" valign="top" | plot program for visualisation of data stored in (BAW) [[NetCDF|CF NetCDF]] files on profiles.
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[NC2TABLE]]
| width="75%" valign="top" | data extraction program for data stored in (BAW) [[NetCDF|CF NetCDF]] files
|- bgcolor="#d3d3d3"
! colspan="3" | O
|- bgcolor="#d3d3d3"
! colspan="3" | P
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[PARTRACE]]
| width="75%" valign="top" | particle tracking within a two-dimensional depth-averaged velocity field
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[POLWIND]]
| width="75%" valign="top" | extraction of polygons out of an overall area
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[PLOTPROFILZEIT]]
| width="75%" valign="top" | Display (aggregated) profile data over time
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[POLYUMFORM]]
| width="75%" valign="top" | conversion of structure information files from several formats to a common BAW format
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[PGCALC]]
| width="75%" valign="top" | calculation of further physical quantities by using the results of a simulation
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[PREHYDRO]]
| width="75%" valign="top" | Processing of seaside boundary data for the BAW operational Model using BSHcmod data
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[PREMETEO]]
| width="75%" valign="top" | Mapping of the processed DWD atmospheric forcing on the Untrim estuary Grid
|- valign="top"
| width="5%" bgcolor="#0000ff" valign="top" | Sim
| width="20%" valign="top" |
[[PROPTEL]]
| width="75%" valign="top" | The BAW Operational Tide Model
|- bgcolor="#d3d3d3"
! colspan="3" | Q
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[QUICKPLOT|quickplot]]
| width="75%" valign="top" | data visualization (filetype [[CF-NETCDF.NC|cf-netcdf.nc]])
|- bgcolor="#d3d3d3"
! colspan="3" | R
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[ROSE]]
| width="75%" valign="top" | analysis and graphical display of a direction dependent relative frequency of occurrence for a vector time series
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[RSMERGE]]
| width="75%" valign="top" | adjustment of UNTRIM restart data to a different grid
|- bgcolor="#d3d3d3"
! colspan="3" | S
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[SYNGRID]]
| width="75%" valign="top" | generation of artificial bearing data
|- bgcolor="#d3d3d3"
! colspan="3" | T
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TAYLORDIAGRAM]]
| width="75%" valign="top" | creates a figure of type Talyor-Diagram
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TC2BAGGER]]
| width="75%" valign="top" | dredger-program for two-dimensional finite element grids
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TC2GEOM]]
| width="75%" valign="top" | conversion of a finite element topography into a finite difference topography
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TC2TR2]]
| width="75%" valign="top" | conversion of a TICAD topography into a ''TRIM'' topography
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TDKLF]]
| width="75%" valign="top" | computation of the tidal characteristic numbers of bed load transport or eff. bed shear stress action
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TDKSF]]
| width="75%" valign="top" | computation of the tidal characteristic numbers of salinity, suspended sediment concentration, tracer concentration and temperature
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TDKTIE]]
| width="75%" valign="top" | linking ''TIDKEN'' results
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TDKVF]]
| width="75%" valign="top" | computation of the tidal characteristic numbers of current
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TDKWF]]
| width="75%" valign="top" | computation of the tidal characteristic numbers of water level and morphodynamics
|- valign="top"
| width="5%" bgcolor="#0000ff" valign="top" | Sim
| width="20%" valign="top" |
[[TELEMAC-2D]]
| width="75%" valign="top" | two-dimensional finite element numerical model
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TEO]]
| width="75%" valign="top" | extraction of bearing data points from a KUEDAT bearing file
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TEOAX]]
| width="75%" valign="top" | extraction of bearing axes from a KUEDAT bearing file
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TICLQ2]]
| width="75%" valign="top" | extraction of bathymetry along longitudinal/cross-sectional profiles
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TICTRI]]
| width="75%" valign="top" | grid conversion into TRIGRID-format
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TIDKEN]]
| width="75%" valign="top" | computation of tidal characteristc numbers for individual time series
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TIMESHIFT]]
| width="75%" valign="top" | correction of profile data in time
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TM2DIDA]]
| width="75%" valign="top" | data conversion of the ''TELEMAC-2D''-results
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TM2RND]]
| width="75%" valign="top" | generation of boundary values for ''TELEMAC-2D''
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TOPVF]]
| width="75%" valign="top" | calculation of 2D/3D-areas and volumes of finite element meshes
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TOUTR]]
| width="75%" valign="top" | conversion of a grid file of any type to a grid file for the numerical model ''UNTRIM''
|- valign="top"
| width="5%" bgcolor="#ffff00" valign="top" | Son
| width="20%" valign="top" |
[[TR2APP]]
| width="75%" valign="top" | analysis of ''TRIM-2D''-results
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TR2ASCII]]
| width="75%" valign="top" | data conversion of the ''TRIM-2D''-results into ASCII format
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TR2DIDA]]
| width="75%" valign="top" | data conversion of the TRIM-2D-results
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TR2FIDI]]
| width="75%" valign="top" | conversion of a TRIM-bathymetry into a FIDISOR/FIDIRB bathymetry
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TR2GEOM]]
| width="75%" valign="top" | conversion of a TRIM-bathymetry into an equivalent finite element grid
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TR2ISSUSKONVERT]]
| width="75%" valign="top" | Support of ship handling simulators with 2D current data from hydronumeric simulations (TRIM2D/UNTRIM/TELEMAC)
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TR2KACHEL]]
| width="75%" valign="top" | generation of a tile-bathymetry and tile-data for TRIM-2D result files
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TR2LQ2]]
| width="75%" valign="top" | extraction of bathymetry along longitudinal/cross-sectional profiles from a TRIM bathymetry
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TR2MODATE]]
| width="75%" valign="top" | modification of date and time in a TRIM-2D results file
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TR2REFRESH]]
| width="75%" valign="top" | update a TRIM bathymetry
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TR2RND]]
| width="75%" valign="top" | generation of boundary value files for ''TRIM-2D''
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TR2VOR]]
| width="75%" valign="top" | generation of an optimized bathymetry as well as some index arrays for TRIM-2D
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TR3DIDA]]
| width="75%" valign="top" | data conversion of the ''TRIM-3D''-results
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TR3KACHEL]]
| width="75%" valign="top" | extraction of bathymetry, index-arrays and results out of a ''TRIM-3D''-overall-area
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TR3MODATE]]
| width="75%" valign="top" | modification of date and time in a ''TRIM-3D'' results file
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TRASSE]]
| width="75%" valign="top" | generation of data for a fairway finite element grid
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TRGITTER05]]
| width="75%" valign="top" | graphical preprocessor for a finite difference TRIM-2D grid
|- valign="top"
| width="5%" bgcolor="#0000ff" valign="top" | Sim
| width="20%" valign="top" |
[[TRIM-2D]]
| width="75%" valign="top" | two-dimensional finite difference model ''TRIM-2D''
|- valign="top"
| width="5%" bgcolor="#0000ff" valign="top" | Sim
| width="20%" valign="top" |
[[TRIM-3D]]
| width="75%" valign="top" | three-dimensional finite difference model ''TRIM-3D''
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TRIMKACH]]
| width="75%" valign="top" | generation of general input files and extraction of data by ''TR2KACHEL'' or ''TR3KACHEL''
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[TRVZR]]
| width="75%" valign="top" | analysator of area result files of the numerical methods ''TRIM-2D'' or ''TRIM-3D''
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[TSCALC]]
| width="75%" valign="top" | mathematical operations on time series data
|- bgcolor="#d3d3d3"
! colspan="3" | U
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[UNK]]
| width="75%" valign="top" | spectral wave model with non-linear dissipation
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[UNS]]
| width="75%" valign="top" | postprocessor with SediMorph functionality independent of a coupled hn model
|- valign="top"
| width="5%" bgcolor="#0000ff" valign="top" | Sim
| width="20%" valign="top" |
[[UNTRIM]]
| width="75%" valign="top" | finite difference/volume model (2D/3D) for unstructured grids UNTRIM
|- valign="top"
| width="5%" bgcolor="#0000ff" valign="top" | Sim
| width="20%" valign="top" |
[[UNTRIM2]]
| width="75%" valign="top" | finite difference/volume model (2D/3D) for unstructured grids ''UNTRIM2'',
with sub grid technology for precise representation of bathymetry
|- valign="top"
| width="5%" bgcolor="#0000ff" valign="top" | Sim
| width="20%" valign="top" |
[[UNTRIM2007]]
| width="75%" valign="top" | finite difference/volume model (2D/3D) for unstructured grids with static or dynamic bathymetry
|- valign="top"
| width="5%" bgcolor="#0000ff" valign="top" | Sim
| width="20%" valign="top" |
[[UNTRIM2007MONITOR]]
| width="75%" valign="top" | extraction of time series data out of an ''UnTRIM2007'' message file
|- valign="top"
| width="5%" bgcolor="#0000ff" valign="top" | Sim
| width="20%" valign="top" |
[[UNTRIMMONITOR]]
| width="75%" valign="top" | The program is used for the graphical visualization of information from the UnTRIM-Message-file
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[UPDA2D]]
| width="75%" valign="top" | update a model bathymetry and alignment of edges of elements along structures
|- valign="top"
| width="5%" bgcolor="#0000ff" valign="top" | Sim
| width="20%" valign="top" |
[[UPLAY]]
| width="75%" valign="top" | gui around ''UNTRIM2'' and ''NCPLOT'' to change grid depths, to let compute the hydrodynamic effect and to look at the computational results
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[UTRPRE]]
| width="75%" valign="top" | rounding UnTRIM2007 depths in order to get identical number of computational points
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[UTRRND]]
| width="75%" valign="top" | generation of boundary time series data from measured or computed data
|- bgcolor="#d3d3d3"
! colspan="3" | V
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[VOLUMETH]]
| width="75%" valign="top" | calculation of area distribution and volume sum function of a region inside an FE mesh
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[VOLUMETHAUTO]]
| width="75%" valign="top" | daemon for the programm ''VOLUMETH''
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[VTDK]]
| width="75%" valign="top" | calculation of differences between tidal characteristic numbers
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[VVIEW2D]]
| width="75%" valign="top" | two-dimensional graphical representation of CFD-data for vertical sections
|- bgcolor="#d3d3d3"
! colspan="3" | W
|- valign="top"
| width="5%" bgcolor="#0000ff" valign="top" | Sim
| width="20%" valign="top" |
[[WARM]]
| width="75%" valign="top" | mathematical wave model
|- valign="top"
| width="5%" bgcolor="#ffff00" valign="top" | Son
| width="20%" valign="top" |
[[WESPE]]
| width="75%" valign="top" | computation of one-dimensional wave spectra (JONSWAP and TMA)
|- bgcolor="#d3d3d3"
! colspan="3" | X
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[XTRDATA]]
| width="75%" valign="top" | extraction of ASCII-data from binary direct access files
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[XTRLQ2]]
| width="75%" valign="top" | extraction of binary data for longitudinal and/or cross-sectional profiles
|- bgcolor="#d3d3d3"
! colspan="3" | Y
|- bgcolor="#d3d3d3"
! colspan="3" | Z
|- valign="top"
| width="5%" bgcolor="#ffa500" valign="top" | Pos
| width="20%" valign="top" |
[[ZEITR]]
| width="75%" valign="top" | conversion of synoptic data sets into equivalent time-series data
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[ZEITRIO]]
| width="75%" valign="top" | reading, formatting and writing of time series of different formats
|- valign="top"
| width="5%" bgcolor="#ff0000" valign="top" | Pre
| width="20%" valign="top" |
[[ZWISCHENPUNKTE]]
| width="75%" valign="top" | generated topographical information

|}
----
back to [[BAW-Software Documentation]]
----
[[Overview]]

NCCHUNKIE

2022-09-06T10:26:33Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=NCCHUNKIE
|name=NCCHUNKIE
|version=April 2022
|version_descr=September 2022
|catchwords=
data conversion 
postprocessor 
automatic adjustment of number of data READ to chunk size of input data 
automatic computation of chunk sizes for result variables to support orthogonal data access 
parrallelization (''collective'' IO) using [http://de.wikipedia.org/wiki/Message_Passing_Interface MPI] 

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/]).''

|shortdescription=
Program NCCHUNKIE can be used to chunk data stored in [[CF-NETCDF.NC|cf-netcdf.nc]] files:
# Chunk sizes are computed automatically, and all dimensions are chunked to support orthogonal data access;
# Resulting chunks sizes lie somewhere between ''Disc Block Size'' and ''Chunk Buffer Size'';
# Online compression is used during storage of data (low level of compression used, level 1);
# A netCDF-4 file is created (serial version creates NetCDF4 ''classic model format'');
# Parameters ''cache size'' and ''cache nelems'' used within netCDF-4 API are automatically determined.

Just in case '''HDF error''' is detected during read of a data record, the program tries to reconstruct the wanted data set from adjacent (in time) records for the same variable. This type of repair works for time dependent variables only.

|inputfiles=
# No input steering data file required (parameters in command line or interactive specification);
# '''UGRID CF NetCDF data set''' (file type [[CF-NETCDF.NC]]).

|outputfiles=
# '''UGRID CF NetCDF data set''' (file type [[CF-NETCDF.NC]]);
# informative '''printer file''' of program execution (file type NCCHUNKIE.sdr) with informations related to program execution, required time for READ and WRITE of data, effective data transfer rates.
# '''trace''' of program execution (file type NCCHUNKIE.trc)

|methodology=
Some concepts published in [https://support.hdfgroup.org/pubs/papers/2008-06_netcdf4_perf_report.pdf https://support.hdfgroup.org/pubs/papers/2008-06_netcdf4_perf_report.pdf] were used.

|preprocessor=[[DATACONVERT]], [[GRIDCONVERT]], [[NCANALYSE]], [[NCAGGREGATE]], [[NCCUTOUT]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[NetCDF Operators]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=[[NCANALYSE]], [[NCAGGREGATE]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NC2TABLE]], [[NetCDF Operators]]
|language=Fortran95
|add_software=---
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
* [https://izw-campus.baw.de/ ''IZW-Campus''] (Podcast, available in German only)
** 2020-11-02: [https://izw-campus.baw.de/ilias.php?ref_id=1832&cmd=render&cmdClass=ilrepositorygui&cmdNode=uj&baseClass=ilrepositorygui ''Chunking und NCCHUNKIE''];
** 2019-08-02: [https://izw-campus.baw.de/ilias.php?ref_id=1831&cmd=render&cmdClass=ilrepositorygui&cmdNode=uj&baseClass=ilrepositorygui ''Anmerkungen zur Chunked I/O mit NetCDF-4 / HDF5''].
* Template file(s):
** No template files available.
}}

NCAUTO

2022-09-06T10:24:16Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=NCAUTO
|name=NCAUTO
|version=August 2020
|version_descr=September 2022
|catchwords=
data analysis 
postprocessor 
classification of variables in [[CF-NETCDF.NC|cf-netcdf.nc]] data files 
minimum, mean and maximum value as well as number of valid data 
automatic adjustment of number of READ data to chunk size of data 
optional use of ''Message Passing Interface'' (MPI, [https://www.mpi-forum.org/ MPI Forum])

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/]).''

|shortdescription=
Program NCAUTO classifies and determines extreme and mean values for data stored in [[CF-NETCDF.NC|cf-netcdf.nc]] files:
# classification of (geophysical) variables based on dimension name as well as dependence on time (as defined in CF attribute ''cell_methods'');
# minimum, mean and maximum value as well as number of valid data for all variables (all time steps);
# locations of minimum as well as maximum;
# time serie of minimum, mean and maximum values as well as number of valid data for all time-dependent variables.
For 2 and 3 the number of analysed variables can be (optionally) influenced through ASCII files ''include_only_variables.dat'' '''or''' ''exclude_variables.dat''.

Just in case '''HDF error''' is detected during read of a data record, the program tries to reconstruct the wanted data set from adjacent (in time) records for the same variable. This type of repair works for time dependent variables only.

|inputfiles=
# '''UGRID CF NetCDF data set''' (file type [[CF-NETCDF.NC]]);
# (optional) '''list of variables to be included''' (file with fixed name '''include_only_variables.dat''');
# (optional) '''list of variables to be excluded''' (file with fixed name '''exclude_variables.dat''').

Only one of files 2 and 3 is allowed to be present in the working directory. Invalid variable names are ingored.

|outputfiles=
# '''classification of variables''' (file type all_class.<''nc-inputfilename''>.sdr)
# (optional) file with '''minimum, mean and maximum value''' for all variables (file type all_stats.<''nc-inputfilename''>.sdr)
# (optional) file with '''time serie of minimum, mean and maximum values as well as number of valid data''' for each variable (and fraction) of a file (file type var_stats.<''nc-inputfilename''>.<''fraction-name''>.sdr)
# informative '''printer file''' of program execution (file type ncauto.sdr) with some useful informations about minimum, maximum, mean as well as locations of minimum and maximum.
# '''trace''' of program execution (file type ncauto.trc)

|methodology=
All variables contained in a file are read (time step by time step). Minimum, mean and maximum values as well as number of valid data are determined. Furthermore a classification for all geophysical variables is performed based on dimension names as well as their dependence on the time coordinate.

|preprocessor=[[DATACONVERT]], [[GRIDCONVERT]], [[NCANALYSE]], [[NCAGGREGATE]], [[NCCUTOUT]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[NetCDF Operators]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=text editor
|language=Fortran95
|add_software=---
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
template files available in '''$PROGHOME/examples/ncauto'''
}}

NCANALYSE

2022-09-06T10:21:25Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=NCANALYSE
|name=NCANALYSE
|version=March 2022
|version_descr=September 2022
|catchwords=
data analysis 
postprocessor 
synoptic data sets 
measured time series data (optionally with [http://cfconventions.org/Data/cf-conventions/cf-conventions-1.6/build/cf-conventions.html#flags flag variables] for a more detailed qualification of data) 
depth averaged (2D) and depth structured data (3D) with z-layers 
[[Tidal Characteristic Numbers of Water Level|tidal characteristic numbers of water level]] 
[[Tidal Characteristic Numbers of Current|tidal characteristic numbers of current]], [[Tidal Characteristic Numbers of Water Transport|tidal characteristic numbers of water transport]] 
[[Tidal Characteristic Numbers of Salinity|tidal characteristic numbers of salinity]], [[Tidal Characteristic Numbers of Salt Transport|tidal characteristic numbers of salt transport]] 
[[Tidal Characteristic Numbers of Temperature|tidal characteristic numbers of temperature]], [[Tidal Characteristic Numbers of Heat Transport|tidal characteristic numbers of heat transport]] 
[[Tidal Characteristic Numbers of Suspended Sediment Transport|tidal characteristic numbers of suspended sediment]],
[[Tidal Characteristic Numbers of Suspended Load Transport|tidal characteristic numbers of suspended load transport]] 
[[Tidal Characteristic Numbers of Tracer Load|tidal characteristic numbers of tracer load]], [[Tidal Characteristic Numbers of Tracer Load Transport|tidal characteristic numbers of tracer load transport]] 
[[Tidal Characteristic Numbers of Eff. Bed Shear Stress Action|tidal characteristic numbers of effective bed shear stress]] 
[[Tidal Characteristic Numbers of Bed Load Transport|tidal characteristic numbers of bed load transport]] 
[[Tidal Characteristic Numbers of Potential Energy Anomaly|tidal characteristic numbers of potential energy anomaly]] 
[[Harmonic Analysis of Water Level|harmonic analysis of water level]] 
[[Harmonic Analysis of Current Velocity|harmonic analysis of current velocity]] 
[[Characteristic Numbers of Water Level (independent of tides)|characteristic numbers of water level (independent of tides)]] 
[[Characteristic Numbers of Current Velocity (independent of tides)|characteristic numbers of current velocity (independent of tides)]] 
[[Characteristic Numbers of Salinity (independent of tides)|characteristic numbers of salinity (independent of tides)]] 
[[Characteristic Numbers of Temperature (independent of tides)|characteristic numbers of temperature (independent of tides)]] 
[[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)|characteristic numbers of suspended sediment concentration (independent of tides)]] 
[[Characteristic Numbers of Tracer Load (independent of tides)|characteristic numbers of tracer load (independent of tides)]] 
[[Characteristic Numbers of Oxygen Concentration (independent of tides)|characteristic numbers of oxygen concentration (independent of tides)]] 
[[Characteristic Numbers of Morphodynamics (independent of tides)|characteristic numbers of morphodynamics (independent of tides)]] 
[[Characteristic Numbers of Bed Load Transport (independent of tides)|characteristic numbers of bedload transport (independent of tides)]] 
[[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)|characteristic numbers of effective bed shear stress (independent of tides)]] 
[[Characteristic Numbers of Water Transport (independent of tides)|characteristic numbers of water transport (independent of tides)]]
 
[[Characteristic Numbers of Salt Transport (independent of tides)|characteristic numbers of salt transport (independent of tides)]]
 
[[Characteristic Numbers of Heat Transport (independent of tides)|characteristic numbers of heat transport (independent of tides)]]
 
[[Characteristic Numbers of Tracer Transport (independent of tides)|characteristic numbers of tracer transport (independent of tides)]] 
[[Characteristic Numbers of Suspended Sediment Transport (independent of tides)|characteristic numbers of suspended sediment transport (independent of tides)]] 
[[Characteristic Numbers of Sediment Transport (independent of tides)|characteristic numbers of sediment transport (independent of tides)]] (bed and suspended load at the bottom) 
[[Characteristic Numbers of Tidal Energy Transport|characteristic numbers of tidal energy transport]] 
[[Characteristic Numbers of Potential Energy Anomaly (independent of tides)|characteristic numbers of potential energy anomaly]] 
[[Characteristic Numbers of Meteorological Data (independent of tides)|characteristic numbers of meteorological data (wind speed)]] 
[[Characteristic Numbers for Wave and Sea State (independent of tides)|characteristic numbers for wave and sea state (significant wave height)]] 
[[NetCDF|CF NetCDF]] format for 2D/3D data 
orthogonal unstructured grid model 
orthogonal unstructured grid model with subgrid information 
data at individual locations (''Discrete Sampling Geometry'' featureType = '''timeSeriesProfile''') 
data at multiple locations along trajectories (''Discrete Sampling Geometry'' featureType = '''trajectoryProfile''') 
parallelization using [http://openmp.org/wp/ OpenMP] and [http://en.wikipedia.org/wiki/Message_Passing_Interface MPI] 
[[NetCDF#Quality assurance using NetCDF attributes|automatic quality assurance (value range)]] 
automatic adjustment of number of READ data to chunk size of data 
automatic setting of WRITE chunk sizes for written variables 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of [https://en.wikipedia.org/wiki/MD5 MD5 hash values] of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
optional closing of data gaps at reference positions by interpolation 

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/]).''

|shortdescription=
Program NCANALYSE serves as an analysis program for data stored in CF netCDF data files.

|inputfiles=
# '''general input data''' (file type [[NCANALYSE.DAT|ncanalyse.dat]]);
# '''synoptic data sets''' (file type [[CF-NETCDF.NC]]);
# for [[NetCDF#Automatic quality assurance using NetCDF attributes|automatic quality assurance]] (file type [[BOUNDS.CFG.DAT|bounds_verify.dat]]).

|outputfiles=
# '''data analysis result files''' (file type [[CF-NETCDF.NC]])
# (optional) informative '''printer file''' of program execution (file type ncanalyse.sdr)
# (optional) '''trace''' of program execution (file type ncanalyse.trc)

|methodology=
The following data analysis methods are currently available:
* Tidal Characteristic Numbers:
*# [[Tidal Characteristic Numbers of Water Level]];
*# [[Tidal Characteristic Numbers of Current]];
*# [[Tidal Characteristic Numbers of Salinity]];
*# [[Tidal Characteristic Numbers of Temperature]];
*# [[Tidal Characteristic Numbers of Suspended Sediment Transport|Tidal Characteristic Numbers of Suspended Sediment]];
*# [[Tidal Characteristic Numbers of Tracer Load]];
*# [[Tidal Characteristic Numbers of Eff. Bed Shear Stress Action|Tidal Characteristic Numbers of Effective Bed Shear Stress]];
*# [[Tidal Characteristic Numbers of Bed Load Transport]];
*# [[Tidal Characteristic Numbers of Potential Energy Anomaly]].
* Tide-dependent Characteristic Numbers for Transport-Processes (based on ''exact'' integrals):
*# [[Tidal Characteristic Numbers of Water Transport]];
*# [[Tidal Characteristic Numbers of Salt Transport]];
*# [[Tidal Characteristic Numbers of Heat Transport]];
*# [[Tidal Characteristic Numbers of Suspended Load Transport]];
*# [[Tidal Characteristic Numbers of Tracer Load Transport]].
* Harmonic Analysis:
*# [[Harmonic Analysis of Water Level]];
*# [[Harmonic Analysis of Current Velocity]].
* Tide-Independent Characteristic Numbers:
*# [[Characteristic Numbers of Water Level (independent of tides)]];
*# [[Characteristic Numbers of Current Velocity (independent of tides)]];
*# [[Characteristic Numbers of Salinity (independent of tides)]];
*# [[Characteristic Numbers of Temperature (independent of tides)]];
*# [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)]];
*# [[Characteristic Numbers of Tracer Load (independent of tides)]];
*# [[Characteristic Numbers of Oxygen Concentration (independent of tides)]];
*# [[Characteristic Numbers of Morphodynamics (independent of tides)]];
*# [[Characteristic Numbers of Bed Load Transport (independent of tides)]];
*# [[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)]];
*# [[Characteristic Numbers of Potential Energy Anomaly (independent of tides)]].
* Tide-Independent Characteristic Numbers for Transport-Processes (based on ''exact'' integrals):
*# [[Characteristic Numbers of Water Transport (independent of tides)]];
*# [[Characteristic Numbers of Water Transport (independent of tides)]];
*# [[Characteristic Numbers of Salt Transport (independent of tides)]];
*# [[Characteristic Numbers of Heat Transport (independent of tides)]];
*# [[Characteristic Numbers of Tracer Transport (independent of tides)]];
*# [[Characteristic Numbers of Suspended Sediment Transport (independent of tides)]];
*# [[Characteristic Numbers of Sediment Transport (independent of tides)]] (bed an suspended load at the bottom).
* Tidal Energy Transport:
*# [[Characteristic Numbers of Tidal Energy Transport]]
* Characteristic Numbers of Meteorological Data:
*# [[Characteristic Numbers of Meteorological Data (independent of tides)|wind speed]].
* Characteristic Numbers for Wave and Sea State:
*# [[Characteristic Numbers for Wave and Sea State (independent of tides)|significant wave height]].

Just in case '''HDF error''' is detected during read of a data record, the program tries to reconstruct the wanted data set from adjacent (in time) records for the same variable. This type of repair works for time dependent variables only.

|preprocessor=[[BOE2NC]], [[DATACONVERT]], [[GRIDCONVERT]], [[NCAGGREGATE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCDVAR]], [[NCMERGE]], [[NetCDF Operators]], [[QUICKPLOT]], [[UNTRIM2007]], [[UNTRIM2]]
|postprocessor=[[DAVIT]], [[DISPLAY_CONTROL_VOLUMES]], [[NCAGGREGATE]], [[NCAUTO]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCDELTA]], [[NCDVAR]], [[NCPLOT]], [[NC2TABLE]], [[PLOTPROFILZEIT]], [[PLOTTS]]
|language=Fortran95
|add_software=---
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
* Presentations (many available in German only):
** 2021-06-16: [http://doi.org/10.13140/RG.2.2.20390.45120 ''Tidal Asymmetry - Classical Parameters vs Skewness''] (DOI: [http://doi.org/10.13140/RG.2.2.20390.45120 http://doi.org/10.13140/RG.2.2.20390.45120]);
** 2015-05-29: [http://ewisa.baw.de/files/12556_tv12_2015_05_29_tide_energie_transport_g_lang.pdf ''Tidewelle und Energietransport''] (DOI: [http://dx.doi.org/10.13140/RG.2.2.31352.14089 http://dx.doi.org/10.13140/RG.2.2.31352.14089]);
** 2014-12-03: [http://ewisa.baw.de/files/11284_tv12_2014_12_03_ncanalyse_lzks_g_lang.pdf ''NCANALYSE - Tideunabhängige Kennwerte des Salzgehalts''];
** 2014-12-03: [http://ewisa.baw.de/files/11285_tv12_2014_12_03_ncanalyse_tdks_g_lang.pdf ''NCANALYSE - Tidekennwerte des Salzgehalts''];
** 2014-10-08: [http://ewisa.baw.de/files/10587_tv12_2014_10_08_ncanalyse_lzkv_g_lang.pdf ''NCANALYSE - Tideunabhängige Kennwerte der Strömung''];
** 2014-09-10: [http://ewisa.baw.de/files/10588_tv12_2014_09_10_allgemein_g_lang.pdf ''NCANALYSE - Tidekennwerte der Strömung''];
** 2013-08-07: [http://ewisa.baw.de/files/08510_speech_2013-08-07.pdf ''NCANALYSE - Tideunabhängige Kennwerte des Wasserstands''];
** 2013-05-15: [http://ewisa.baw.de/files/08500_speech_2013-05-15.pdf ''NCANALYSE - Daten aus CF netCDF Dateien analysieren''].
* [https://izw-campus.baw.de/ ''IZW-Campus''] (Podcast, available in German only)
** 2022-04-25: [https://izw-campus.baw.de/goto.php?target=cat_4105&client_id=iliasclient ''NCANALYSE - Grundlagen am Beispiel der Analyse LZKW (tideunabhängige Kennwerte des Wasserstands)''];
** 2022-03-21: [https://izw-campus.baw.de/goto.php?target=cat_3829&client_id=iliasclient ''Energietransport einer Tidewelle''];
** 2021-11-29: [https://izw-campus.baw.de/goto.php?target=cat_3490&client_id=iliasclient ''NCANALYSE - Grundlagen - Wechselwirkung zwischen Salzgehalt und Schwebstoffgehalt''];
** 2021-10-18: [https://izw-campus.baw.de/goto.php?target=cat_3301&client_id=iliasclient ''NCANALYSE - Grundlagen verschiedener Kennwerte (Einfluss des Salzgehalts auf verschiedene Kenngrößen)''];
** 2021-09-13: [https://izw-campus.baw.de/goto.php?target=cat_3102&client_id=iliasclient ''NCANALYSE - Grundlagen TDKA (Tidekennwerte der Anomalie der Potentiellen Energie)''];
** 2021-08-09: [https://izw-campus.baw.de/goto.php?target=cat_1830&client_id=iliasclient ''NCANALYSE - Grundlagen TDKS (Tidekennwerte des Salzgehalts)''];
** 2021-06-07: [https://izw-campus.baw.de/goto.php?target=cat_2554&client_id=iliasclient ''NCANALYSE Update zu Skewness - aus Partialtiden des Wasserstands und der Strömung''];
** 2021-04-19: [https://izw-campus.baw.de/ilias.php?ref_id=2329&cmd=render&cmdClass=ilrepositorygui&cmdNode=uj&baseClass=ilRepositoryGUI ''NCANALYSE - Grundlagen am Beispiel der Analyse FRQV (Harmonische Analyse der Strömung)''];
** 2021-03-08: [https://izw-campus.baw.de/ilias.php?ref_id=2224&cmd=render&cmdClass=ilrepositorygui&cmdNode=uj&baseClass=ilrepositorygui ''NCANALYSE - Grundlagen am Beispiel der Analyse FRQW (Harmonische Analyse des Wasserstands)''];
** 2021-02-08: [https://izw-campus.baw.de/ilias.php?ref_id=1940&cmd=render&cmdClass=ilrepositorygui&cmdNode=uj&baseClass=ilrepositorygui ''NCANALYSE - Grundlagen am Beispiel der Analyse TDKV (Tidekennwerte der Strömungsgeschwindigkeit)''];
** 2021-01-11: [https://izw-campus.baw.de/ilias.php?ref_id=1853&cmd=render&cmdClass=ilrepositorygui&cmdNode=uj&baseClass=ilrepositorygui ''NCANALYSE - Grundlagen am Beispiel der Analyse TDKW (Tidekennwerte des Wasserstands)''].
* Template input files:
** template files available in '''$PROGHOME/examples/ncanalyse'''
}}

NCAGGREGATE

2022-09-06T10:19:02Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=NCAGGREGATE
|name=NCAGGREGATE
|version=July 2022
|version_descr=September 2022
|catchwords=
data analysis 
postprocessor 
synoptic data sets 
[[Analysis_of_Calculated_Results#Tidal_Characteristic_Numbers|tidal characteristic numbers]] 
[[Analysis_of_Calculated_Results#Characteristic_Numbers_.28independent_of_the_presence_of_tides.29|tide-independent characteristic numbers]] 
differences for synoptic data sets 
differences for tidal characteristic numbers 
differences for tide-independent characteristic numbers 
[[NetCDF|CF NetCDF]] format for 2D/3D data 
aggregated data for control volumes and exchanges 
orthogonal unstructured grid model 
support of computational results based on sub-grid bathymetry 
parallelization using [http://openmp.org/wp/ OpenMP] 
support of DMQS metadata and variables 
[[NetCDF#Quality assurance using NetCDF attributes|automatic quality assurance (value range)]] 
automatic adjustment of number of data READ to chunk size of input data 
automatic computation of chunk sizes for result variables to support orthogonal data access 
Storage of the content of the ASCII input control files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
Storage of [https://en.wikipedia.org/wiki/MD5 MD5 hash values] of input files in [[CF-NETCDF.NC|netcdf.nc]] (as a variable) 
optional use of ''Message Passing Interface'' (MPI, [https://www.mpi-forum.org/ MPI Forum])

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/]).''

|shortdescription=
Program NCAGGRGATE may be useful in different situations which are listed in the following. For each type of application a list of programs (with sequence of execution) is given:
* aggregation of synoptic transport data for control volumes aiming at a precise balance of transports (water volume, salt, etc.): Attention: To get an input file suitable for INSPECT_CONTROL_VOLUMES, the simulation must be performed at least with salt or temperature. Even if you are only interested in the hydrodynamics, NCAGGREGATE also has to aggregate the salt or temperature values. The aggregated synoptic water volume is otherwise not calculated. However, this physical quantity is required for the calculations performed in INSPECT_CONTROL_VOLUMES.
*# [[UNTRIM2007]] or [[UNTRIM2]],
*# NCAGGREGATE,
*# [[INSPECT_CONTROL_VOLUMES]] (check results),
*# [[NCANALYSE]], and
*# [[DISPLAY_CONTROL_VOLUMES]].
* aggregation of synoptic data (water level, current velocity, salinity, etc.) aiming at the reduction of data complexity:
*# [[UNTRIM2007]] or [[UNTRIM2]],
*# NCAGGREGATE, and
*# [[NCPLOT]].
* aggregation of characteristic numbers aiming at the reduction of data complexity:
*# [[UNTRIM2007]] or [[UNTRIM2]],
*# [[NCANALYSE]],
*# [[NCPLOT]] (check characteristic numbers),
*# NCAGGREGATE, and
*# [[NCPLOT]].
* aggregation of differences for characteristic numbers or synoptic data aiming at the reduction of data complexity:
*# [[UNTRIM2007]] or [[UNTRIM2]] (experimentally also for DFlow FM),
*# [[NCANALYSE]] (computation of characteristic numbers),
*# [[NCPLOT]] (check characteristic numbers),
*# [[NCDELTA]],
*# [[NCPLOT]] (check differences),
*# NCAGGREGATE, and
*# [[NCPLOT]].
During aggragation of classical data ''land binary masks'' (LBM) are automatically added to the result file. LBMs are used to describe the distribution of land and water at aggregation time. LBMs therefore empower visualization programs like [[NCPLOT]] to optimally present aggregated data in combination with a meaningful land-water-distribution.

Optionally the user is able to generate percentiles (0.01, 0.05, 0.50, 0.95 and 0.99) as well as probability distributions in addition to those aggregated data which are ''usually'' created. For further advice see [[NCAGGREGATE.DAT|ncaggregate.dat]].

[[File:ncaggregate_patch.png|thumb|'''Picture ''control volumes and exchanges'''''.]]

|inputfiles=
# '''general input data''' (file type [[NCAGGREGATE.DAT|ncaggregate.dat]]);
# file with '''classifications''' for probability distributions (file type [[BOUNDS.CFG.DAT|bounds.cfg.dat]]) Hint: (Recommended) Local configuration file or file from the directory ''$PROGHOME/cfg/''.
# '''synoptic data sets''' (file type [[CF-NETCDF.NC|cf-netcdf.nc]]);
# '''control volumes''' (file type [[IPDS.DAT|ipds.dat]]);
# for [[NetCDF#Automatic quality assurance using NetCDF attributes|automatic quality assurance]] (file type [[BOUNDS.CFG.DAT|bounds_verify.dat]]).

|outputfiles=
# '''data analysis result files''' (file type [[CF-NETCDF.NC|cf-netcdf.nc]]); see ''[[NetCDF aggregation for unstructured grids]]'' for details about the aggregational grid.
# (optional) informative '''printer file''' of program execution (file type ncaggregate.sdr)
# (optional) '''trace''' of program execution (file type ncaggregate.trc)

|methodology=
Physical data, suitable for aggregation, are collected for different control volumes as well as exchanges between adjacent control volumes.

Just in case '''HDF error''' is detected during read of a data record, the program tries to reconstruct the wanted data set from adjacent (in time) records for the same variable. This type of repair works for time dependent variables only.

|preprocessor=[[NCANALYSE]], [[NCCHUNKIE]], [[NCCUTOUT]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[UNTRIM2007]], [[UNTRIM2]], [[INSEL2IPDS]]
|postprocessor=[[DAVIT]], [[INSPECT_CONTROL_VOLUMES]], [[NCANALYSE]], [[NCAUTO]], [[NCCHUNKIE]], [[NCDELTA]], [[NCDVAR]], [[NCMERGE]], [[NCPLOT]], [[NC2TABLE]], [[PLOTPROFILZEIT]]
|language=Fortran95
|add_software=---
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=
* Presentations (available in German only):
** 2014-03-12: [http://ewisa.baw.de/files/09206_tv12_2014_03_12_aggregation_g_lang.pdf ''Aggregation von Daten''].
* [https://izw-campus.baw.de/ ''IZW-Campus''] (Podcast, available in German only)
**2020-12-07: [https://izw-campus.baw.de/ilias.php?ref_id=1830&cmd=render&cmdClass=ilrepositorygui&cmdNode=uj&baseClass=ilrepositorygui ''Aggregation und NCAGGREGATE''].
* Template Files:
** template files available in '''$PROGHOME/examples/ncaggregate'''
}}

LZKWF

2022-09-06T10:16:27Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=LZKWF
|name=LZKWF
|version=4.x / August 2009
|version_descr=September 2022
|catchwords=
postprocessor 
analysis of numerically calculated results (2D/3D and profile-data) 
characteristic numbers of water level (independent of tides) 
static (alternative) bathymetry 
universal direct access format for 2D/3D-data 
universal direct access format for profile-data 
universal direct access format for data at specific locations 
parallel execution for Shared Memory (SGI machines) 
|shortdescription=
The program LZKWF is a postprocessor for different numerical models (e.g. TRIM-2D, TRIM-3D, TELEMAC-2D, UNTRIM, UNTRIM2007 etc.). LZKWF automatically computes several characteristic numbers of water level which are independent of the presence of tides. The data must be given as time-series (in universal direct access data format). The results of LZKWF analyses may be visualised/displayed with the graphical postprocessors HVIEW2D (for 2D/3D-data) or LQ2PRO (for profile-data).

Within the period of data analysis the following [[Characteristic Numbers of Water Level (independent of tides)|characteristic numbers (independent of tides)]] can be (optionally) calculated:

* [[Characteristic Numbers of Water Level (independent of tides)#Definitions for the tide-independent characteristic numbers of water level|High Water Level]]
* [[Characteristic Numbers of Water Level (independent of tides)#Definitions for the tide-independent characteristic numbers of water level|Low Water Level]]
* [[Characteristic Numbers of Water Level (independent of tides)#Definitions for the tide-independent characteristic numbers of water level|Mean Water Level]]
* [[Characteristic Numbers of Water Level (independent of tides)#Definitions for the tide-independent characteristic numbers of water level|Water Level Difference]]
* [[Characteristic Numbers of Water Level (independent of tides)#Definitions for the tide-independent characteristic numbers of water level|High Water Time]]
* [[Characteristic Numbers of Water Level (independent of tides)#Definitions for the tide-independent characteristic numbers of water level|Low Water Time]]
* [[Characteristic Numbers of Water Level (independent of tides)#Definitions for the tide-independent characteristic numbers of water level|Duration of Inundation]]
* [[Characteristic Numbers of Water Level (independent of tides)#Definitions for the tide-independent characteristic numbers of water level|Duration of Dry Period]]
* [[Characteristic Numbers of Water Level (independent of tides)#Definitions for the tide-independent characteristic numbers of water level|Maximum Rise Velocity]]
* [[Characteristic Numbers of Water Level (independent of tides)#Definitions for the tide-independent characteristic numbers of water level|Maximum Fall Velocity]]
* [[Characteristic Numbers of Water Level (independent of tides)#Definitions for the tide-independent characteristic numbers of water level|Standard Deviation of Water Level]]
* [[Characteristic Numbers of Water Level (independent of tides)#Definitions for the tide-independent characteristic numbers of water level|Variance of Water Level]]
* [[Characteristic Numbers of Water Level (independent of tides)#Definitions for the tide-independent characteristic numbers of water level|Duration of High Water]]
* [[Characteristic Numbers of Water Level (independent of tides)#Definitions for the tide-independent characteristic numbers of water level|Duration of Low Water]]
|inputfiles=
# general '''input data''' (filetype [[LZKWF.DAT|lzkwf.dat]])
# '''time series''' data which shall be analysed (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]], and [[DIRZ.BIN|dirz.bin]])
# grid for 2D/3D-data (filetype [[GITTER05.DAT and GITTER05.BIN|gitter05.dat/bin]] or filetype [[UNTRIM_GRID.DAT|untrim_grid.dat]])
: '''or''' profile-topography for profile-data (filetype [[PROFIL05.BIN|profil05.bin]])
: '''or''' system file for specific locations (filetype [[LOCATION_GRID.DAT|location_grid.dat]])
|outputfiles=
# '''results of data analyses''' (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]], and [[DIRZ.BIN|dirz.bin]])
# informative '''printer''' file (filetype lzkwf.sdr)
# (optional) '''trace''' of program execution (filetype lzkwf.trc)
|methodology=
An arbitrary long/short period of time can be chosen to calculate characteristic numbers of water level which are independent of tides. For every node of the grid the given time-serie is analysed automatically by means of several analyses modules. An (optional) calculation for the maximum values of the velocities for fall and rise of the water surface takes into account an averaging process of the respective velocities for a user-defined time intervall (typically 30 minutes).

For visualization of results with alternative bathymetry some additional results of program [[LZKMF]] are required. 
Namely

* [[Characteristic Numbers of Morphodynamics (independent of tides)#Definitions for the Tide-Independent Characteristic Numbers of Morphodynamics|maximum depth]], and
* [[Characteristic Numbers of Morphodynamics (independent of tides)#Definitions for the Tide-Independent Characteristic Numbers of Morphodynamics|minimum depth]].

These quantities must be available for the same period of data analysis.
|preprocessor=
[[DIDARENAME]], [[DIDASPLIT]], [[ZEITR]]
|postprocessor=
[[ABDF]], [[DIDARENAME]], [[DIDASPLIT]], [[HVIEW2D]], [[LQ2PRO]], [[VTDK]], [[VVIEW2D]], [[XTRDATA]]
|language=Fortran90
|add_software= -
|contact_original=G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=please refer to $PROGHOME/examples/Lzkwf/
}}

LZKVF

2022-09-06T10:14:10Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=LZKVF
|name=LZKVF
|version=3.1 / September 2012
|version_descr=September 2022
|catchwords=
postprocessor 
analysis of calculated results 
characteristic numbers of (depth averaged) current 
static (alternative) bathymetry; 
universal direct access data format 
|shortdescription=
The program LZKVF computes several characteristic numbers of current data. The data must be given as time-series (in universal direct access data format).
The results of LZKVF can be visualised/displayed with the graphical postprocessor [[HVIEW2D]].

The following characteristic numbers can be (optionally) calculated:

* [[Example figures: maximum current velocity|maximum current velocity]]
* [[Example figures: residual current velocity|mean current velocity]]
* [[Example figures: mean magnitude of current velocity|mean magnitude of current velocity]]
* [[Example figures: duration of high current velocity|duration of high current velocity]]
* [[Example figures: duration of low current velocity|duration of low current velocity]]
* [[Example figures: relative frequency distribution of current velocity|frequency distribution of current velocity]]

|inputfiles=
# general input data (filetype [[LZKVF.DAT|lzkvf.dat]])
# time series of current data (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]], and [[DIRZ.BIN|dirz.bin]])
# grid for 2D-data (filetype [[GITTER05.DAT and GITTER05.BIN|gitter05.dat/bin]] or filetype [[UNTRIM_GRID.DAT|untrim_grid.dat]])
|outputfiles=
# results of data analyses for the overall domain (files of type dirz.bin.r, dirz.bin.i, and dirz.bin)
# results of data analyses for sectors (files of type dirz.bin.r, dirz.bin.i, and dirz.bin)
# informative printer file (filetype lzkvf.sdr)
# (optional) trace of program execution (filetype lzkvf.trc)

|methodology=
* This program is able to generate statistics of current velocity time-series. LZKVF determines the frequency distribution of velocity for different velocity-intervals and sectors of current direction.
* The number of intervals and sectors as well as the value of their upper and lower limits can be defined by the user.
* Analyses can be carried through for depth averaged current velocity data only.
|preprocessor=
[[DIDARENAME]], [[DIDASPLIT]], [[ZEITR]]
|postprocessor=
[[ABDF]], [[DIDARENAME]], [[DIDASPLIT]], [[HVIEW2D]], [[LQ2PRO]], [[VTDK]], [[VVIEW2D]], [[XTRDATA]]
|language=Fortran90
|add_software= -
|contact_original=D. Wehr, G. Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=$PROGHOME/examples/Lzkvf/
}}

LZKSF

2022-09-06T10:02:37Z

Ak3glang: working group POS

{{ProgramDescription
|name_de=LZKSF
|name=LZKSF
|version=7.2 / August 2012
|version_descr=September 2022
|catchwords=
postprocessor 
analysis of numerically calculated results (2D/3D, profile-data as well as data at specific locations) 
characteristic numbers of salinity (independent of tides) 
characteristic numbers of suspended load (independent of tides) 
characteristic numbers of tracer load (independent of tides) 
characteristic numbers of temperature (independent of tides) 
characteristic numbers of bed load transport (independent of tides) 
characteristic numbers of eff. bed shear stress (independent of tides) 
static (alternative) bathyemtry 
universal direct access format for 2D/3D-data 
universal direct access format for profile-data 
universal direct access format for data at specific locations 
|shortdescription=
The program LZKSF is a postprocessor for different numerical models (e.g. TRIM-2D, TRIM-3D,
TELEMAC-2D, UNTRIM, UNTRIM2007 etc.). LZKSF automatically computes several characteristic numbers
of salinity, suspended load, tracer load, temperature, bed load transport or eff. bed shear stress which are
independent of the presence of tides. The data must be given as time-series (in universal
direct access data format). They can be defined in a 3D-volume, on a 2D-area, along profiles or
at specific locations. Data may be the output from either depth integrated (2D) or
depth structured (3D) numerical simulations.

The results of LZKSF analyses may be visualised/displayed with the graphical postprocessors
HVIEW2D (for 2D/3D-data), VVIEW2D (vertical sections along profiles) or LQ2PRO (for profile-data).

Within the period of data analysis the following [[Characteristic Numbers of Salinity (independent of tides)|characteristic numbers of salinity (independent of tides)]] can be (optionally) calculated:

* [[Characteristic Numbers of Salinity (independent of tides)#Definitions for the tide-independent characteristic numbers of salinity|Maximum Value of Salinity (HS)]]
* [[Characteristic Numbers of Salinity (independent of tides)#Definitions for the tide-independent characteristic numbers of salinity|Minimum Value of Salinity (LS)]]
* [[Characteristic Numbers of Salinity (independent of tides)#Definitions for the tide-independent characteristic numbers of salinity|Mean Value of Salinity (MS)]]
* [[Characteristic Numbers of Salinity (independent of tides)#Definitions for the tide-independent characteristic numbers of salinity|Maximum Variation of Salinity (DS)]]
* [[Characteristic Numbers of Salinity (independent of tides)#Definitions for the tide-independent characteristic numbers of salinity|Maximum Increase of Salinity]]
* [[Characteristic Numbers of Salinity (independent of tides)#Definitions for the tide-independent characteristic numbers of salinity|Maximum Decrease of Salinity]]
* [[Characteristic Numbers of Salinity (independent of tides)#Definitions for the tide-independent characteristic numbers of salinity|Standard Deviation of Salinity]]
* [[Characteristic Numbers of Salinity (independent of tides)#Definitions for the tide-independent characteristic numbers of salinity|Variance of Salinity]]
* [[Characteristic Numbers of Salinity (independent of tides)#Definitions for the tide-independent characteristic numbers of salinity|Duration of High Salinity]]
* [[Characteristic Numbers of Salinity (independent of tides)#Definitions for the tide-independent characteristic numbers of salinity|Duration of Low Salinity]]
* [[Characteristic Numbers of Salinity (independent of tides)#Definitions for the tide-independent characteristic numbers of salinity|Advective Salt Transport]]
* [[Characteristic Numbers of Salinity (independent of tides)#Definitions for the tide-independent characteristic numbers of salinity|Mean Advective Salt Transport]]
* [[Characteristic Numbers of Salinity (independent of tides)#Definitions for the tide-independent characteristic numbers of salinity|Maximum Advective Salt Transport]]
* [[Characteristic Numbers of Salinity (independent of tides)#Definitions for the tide-independent characteristic numbers of salinity|Minimum Advective Salt Transport]]

Within the period of data analysis the following [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)|characteristic numbers of suspended load (independent of tides)]] can be (optionally) calculated:

* [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)#Definitions for the tide-independent characteristic numbers of suspended sediment concentration|Maximum Value of Suspended Load]]
* [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)#Definitions for the tide-independent characteristic numbers of suspended sediment concentration|Minimum Value of Suspended Load]]
* [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)#Definitions for the tide-independent characteristic numbers of suspended sediment concentration|Mean Value of Suspended Load]]
* [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)#Definitions for the tide-independent characteristic numbers of suspended sediment concentration|Maximum Variation of Suspended Load]]
* [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)#Definitions for the tide-independent characteristic numbers of suspended sediment concentration|Maximum Increase of Suspended Load]]
* [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)#Definitions for the tide-independent characteristic numbers of suspended sediment concentration|Maximum Decrease of Suspended Load]]
* [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)#Definitions for the tide-independent characteristic numbers of suspended sediment concentration|Standard Deviation of Suspended Load]]
* [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)#Definitions for the tide-independent characteristic numbers of suspended sediment concentration|Variance of Suspended Load]]
* [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)#Definitions for the tide-independent characteristic numbers of suspended sediment concentration|Duration of High Suspended Load]]
* [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)#Definitions for the tide-independent characteristic numbers of suspended sediment concentration|Duration of Low Suspended Load]]
* [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)#Definitions for the tide-independent characteristic numbers of suspended sediment concentration|Advective Transport of Suspended Load]]
* [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)#Definitions for the tide-independent characteristic numbers of suspended sediment concentration|Mean Advective Suspended Load Transport]]
* [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)#Definitions for the tide-independent characteristic numbers of suspended sediment concentration|Maximum Advective Suspended Load Transport]]
* [[Characteristic Numbers of Suspended Sediment Concentration (independent of tides)#Definitions for the tide-independent characteristic numbers of suspended sediment concentration|Minimum Advective Suspended Load Transport]]

Within the period of data analysis the following [[Characteristic Numbers of Tracer Load (independent of tides)|characteristic numbers of tracer load (independent of tides)]] can be (optionally) calculated:

* [[Characteristic Numbers of Tracer Load (independent of tides)#Definitions for the tide-independent characteristic numbers of tracer concentration|Maximum Value of Tracer Load]]
* [[Characteristic Numbers of Tracer Load (independent of tides)#Definitions for the tide-independent characteristic numbers of tracer concentration|Minimum Value of Tracer Load]]
* [[Characteristic Numbers of Tracer Load (independent of tides)#Definitions for the tide-independent characteristic numbers of tracer concentration|Mean Value of Tracer Load]]
* [[Characteristic Numbers of Tracer Load (independent of tides)#Definitions for the tide-independent characteristic numbers of tracer concentration|Maximum Variation of Tracer Load]]
* [[Characteristic Numbers of Tracer Load (independent of tides)#Definitions for the tide-independent characteristic numbers of tracer concentration|Maximum Increase of Tracer Load]]
* [[Characteristic Numbers of Tracer Load (independent of tides)#Definitions for the tide-independent characteristic numbers of tracer concentration|Maximum Decrease of Tracer Load]]
* [[Characteristic Numbers of Tracer Load (independent of tides)#Definitions for the tide-independent characteristic numbers of tracer concentration|Standard Deviation of Tracer Load]]
* [[Characteristic Numbers of Tracer Load (independent of tides)#Definitions for the tide-independent characteristic numbers of tracer concentration|Variance of Tracer Load]]
* [[Characteristic Numbers of Tracer Load (independent of tides)#Definitions for the tide-independent characteristic numbers of tracer concentration|Duration of High Tracer Load]]
* [[Characteristic Numbers of Tracer Load (independent of tides)#Definitions for the tide-independent characteristic numbers of tracer concentration|Duration of Low Tracer Load]]
* [[Characteristic Numbers of Tracer Load (independent of tides)#Definitions for the tide-independent characteristic numbers of tracer concentration|Advective Tracer Transport]]
* [[Characteristic Numbers of Tracer Load (independent of tides)#Definitions for the tide-independent characteristic numbers of tracer concentration|Mean Advective Tracer Transport]]
* [[Characteristic Numbers of Tracer Load (independent of tides)#Definitions for the tide-independent characteristic numbers of tracer concentration|Maximum Advective Tracer Transport]]
* [[Characteristic Numbers of Tracer Load (independent of tides)#Definitions for the tide-independent characteristic numbers of tracer concentration|Minimum Advective Tracer Transport]]

Within the period of data analysis the following [[Characteristic Numbers of Temperature (independent of tides)|characteristic numbers of temperature (independent of tides)]] can be (optionally) calculated:

* [[Characteristic Numbers of Temperature (independent of tides)#Definitions for the Tide-Independent Characteristic Numbers of Temperature|Maximum Value of Temperature]]
* [[Characteristic Numbers of Temperature (independent of tides)#Definitions for the Tide-Independent Characteristic Numbers of Temperature|Minimum Value of Temperature]]
* [[Characteristic Numbers of Temperature (independent of tides)#Definitions for the Tide-Independent Characteristic Numbers of Temperature|Mean Value of Temperature]]
* [[Characteristic Numbers of Temperature (independent of tides)#Definitions for the Tide-Independent Characteristic Numbers of Temperature|Maximum Variation of Temperature]]
* [[Characteristic Numbers of Temperature (independent of tides)#Definitions for the Tide-Independent Characteristic Numbers of Temperature|Maximum Increase of Temperature]]
* [[Characteristic Numbers of Temperature (independent of tides)#Definitions for the Tide-Independent Characteristic Numbers of Temperature|Maximum Decrease of Temperature]]
* [[Characteristic Numbers of Temperature (independent of tides)#Definitions for the Tide-Independent Characteristic Numbers of Temperature|Standard Deviation of Temperature]]
* [[Characteristic Numbers of Temperature (independent of tides)#Definitions for the Tide-Independent Characteristic Numbers of Temperature|Variance of Temperature]]
* [[Characteristic Numbers of Temperature (independent of tides)#Definitions for the Tide-Independent Characteristic Numbers of Temperature|Duration of High Temperature]]
* [[Characteristic Numbers of Temperature (independent of tides)#Definitions for the Tide-Independent Characteristic Numbers of Temperature|Duration of Low Temperature]]
* [[Characteristic Numbers of Temperature (independent of tides)#Definitions for the Tide-Independent Characteristic Numbers of Temperature|Advective Heat Transport]]
* [[Characteristic Numbers of Temperature (independent of tides)#Definitions for the Tide-Independent Characteristic Numbers of Temperature|Mean Advective Heat Transport]]
* [[Characteristic Numbers of Temperature (independent of tides)#Definitions for the Tide-Independent Characteristic Numbers of Temperature|Maximum Advective Heat Transport]]
* [[Characteristic Numbers of Temperature (independent of tides)#Definitions for the Tide-Independent Characteristic Numbers of Temperature|Minimum Advective Heat Transport]]

Within the period of data analysis the following [[Characteristic Numbers of Bed Load Transport (independent of tides)|characteristic numbers of bed load transport(independent of tides)]] can be (optionally) calculated:

* [[Characteristic Numbers of Bed Load Transport (independent of tides)#Definitions for the tide-independent characteristic numbers of bed load transport|Advective Transport of Bed Load]]
* [[Characteristic Numbers of Bed Load Transport (independent of tides)#Definitions for the tide-independent characteristic numbers of bed load transport|Mean Advective Bed Load Transport]]
* [[Characteristic Numbers of Bed Load Transport (independent of tides)#Definitions for the tide-independent characteristic numbers of bed load transport|Maximum Advective Bed Load Transport]]
* [[Characteristic Numbers of Bed Load Transport (independent of tides)#Definitions for the tide-independent characteristic numbers of bed load transport|Minimum Advective Bed Load Transport]]

Within the period of data analysis the following [[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)|characteristic numbers of eff. bed shear stress (independent of tides)]] can be (optionally) calculated:

* [[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)#Definitions for the tide-independent characteristic numbers of salinity|Maximum Value of eff. Bed Shear Stress]]
* [[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)#Definitions for the tide-independent characteristic numbers of salinity|Minimum Value of eff. Bed Shear Stress]]
* [[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)#Definitions for the tide-independent characteristic numbers of salinity|Mean Value of eff. Bed Shear Stress]]
* [[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)#Definitions for the tide-independent characteristic numbers of salinity|Maximum Variation of eff. Bed Shear Stress]]
* [[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)#Definitions for the tide-independent characteristic numbers of salinity|Maximum Increase of eff. Bed Shear Stress]]
* [[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)#Definitions for the tide-independent characteristic numbers of salinity|Maximum Decrease of eff. Bed Shear Stress]]
* [[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)#Definitions for the tide-independent characteristic numbers of salinity|Standard Deviation of eff. Bed Shear Stress]]
* [[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)#Definitions for the tide-independent characteristic numbers of salinity|Variance of eff. Bed Shear Stress]]
* [[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)#Definitions for the tide-independent characteristic numbers of salinity|Duration of High eff. Bed Shear Stress]]
* [[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)#Definitions for the tide-independent characteristic numbers of salinity|Duration of Low eff. Bed Shear Stress]]
|inputfiles=
# general '''input data''' (filetype [[LZKSF.DAT|lzksf.dat]])
# '''time series data''' which shall be analysed (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]], and [[DIRZ.BIN|dirz.bin]])
# '''grid''' for 2D/3D-data (filetype [[GITTER05.DAT und GITTER05.BIN|gitter05.dat/bin]] or filetype [[UNTRIM_GRID.DAT|untrim_grid.dat]])
: '''or''' profile-topography for profile-data (filetype [[PROFIL05.BIN|profil05.bin]])
: '''or''' system file for specific locations (filetype [[LOCATION_GRID.DAT|location_grid.dat]])
|outputfiles=
# '''results of data analyses''' (files of type [[DIRZ.BIN.R|dirz.bin.r]], [[DIRZ.BIN.I|dirz.bin.i]], and [[DIRZ.BIN|dirz.bin]])
# informative '''printer''' file (filetype lzksf.sdr)
# (optional) '''trace''' of program execution (filetype lzksf.trc)
|methodology=
An arbitrary long/short period of time can be chosen to calculate characteristic numbers of salinity, suspended load, tracer load, temperature, bed load transport or eff. bed shear stress which are independent of tides. For every node of the grid the given time-serie is analysed automatically by means of several analyses modules. An (optional) calculation for the maximum values of the increase or decrease of salinity takes into account an averaging process of the respective salinities for a user-defined time intervall (typically 30 minutes). Drying and wetting of computational nodes is correctly taken into account.
|preprocessor=
[[DIDARENAME]], [[DIDASPLIT]], [[ZEITR]]
|postprocessor=
[[ABDF]], [[DIDARENAME]], [[DIDASPLIT]], [[HVIEW2D]], [[LQ2PRO]], [[VTDK]], [[VVIEW2D]], [[XTRDATA]]
|language=Fortran90
|add_software= -
|contact_original=Lang
|contact_maintenance=[mailto:pos.proghome@baw.de Working group POS]
|documentation=please refer to $PROGHOME/examples/Lzksf/
}}