NCANALYSE.DAT: Difference between revisions

Revision as of 14:17, 29 February 2016

Basic Information

File-Type

ncanalyse.dat

File-Form

FORMATTED

Version

February 2016

Description-Date

February 2016

Significance of the File

contains general steering data for the program NCANALYSE.

File-Contents (in Catchwords)

steering data

Block Program_Parameters: general input data
1. Max_Read_Storage: maximum number of data items which can be read, stored and processed within one analysis cycle.
2. Min_Water_Depth: minimum water depth up to which analyses are carried through.
3. (optional) Create_Missing_Variables: create additional (virtual) variables
  0 = do not create (default);
  
  1 = create (actually only "magnitude_of_sea_water_velocity" for DFlow FM UGRID CF NetCDF).
4. (optional) NC_Deflate_Level: level (0 to 9) of online-compression used during write of the result file
  0 = no compression (default);
  
  5 = good compression (recommendation);
  
  9 = highest level of compression.
Block Data_Analysis_Period: period of data analysis
1. Start_Time: start time of data analysis period.
2. End_Time: end time of data analysis period.
Block Input_Files: CF NetCDF file with input data
1. Data_File: name and type (NETCDF) of the input data file (filetype cf-netcdf.nc).
Block Location: reference locations (one block per location)
1. Name: name of reference location.
2. Type: type of reference location:
  - 0 = reference location tide (must be specified exactely once);
  - 1 = reference location phase (must be specified exactely once);
  - 2 = auxiliary location (can be specified several times).
3. X: x-coordinate of location(specify either X and Y or LON and LAT).
4. Y: y-coordinate of location (specify either X and Y or LON und LAT).
5. LON: longitude of location (specify either X and Y or LON and LAT).
6. LAT: latitude of location (specify either X and Y or LON and LAT).
7. Z: z-coordinate of location (positive downwards).
8. Rank: rank of location(not for reference location phase).
9. Previous_Rank: refers to the rank of the previous location (not for reference location tide and reference location phase).
Block Input_Variables: names(s) for variables to be analysed
1. Name: name of variable to be analysed (must be a valid CF NetCDF variable name from the input data file).
Block Data_Analysis: type of analysis and CF NetCDF file for result data
1. Type: type of analysis:
  - TDKW = Tidal Characteristic Numbers of Water Level;
  - TDKV = Tidal Characteristic Numbers of Current;
  - TDKS = Tidal Characteristic Numbers of Salinity;
  - LZKW = Characteristic Numbers of Water Level (independent of tides);
  - LZKV = Characteristic Numbers of Current Velocity (independent of tides);
  - LZKS = Characteristic Numbers of Salinity (independent of tides);
  - LZKC = Characteristic Numbers of Suspended Sediment Concentration (independent of tides);
  - LZKP = Characteristic Numbers of Tracer Load (independent of tides);
  - LZKM = Characteristic Numbers of Morphodynamics (independent of tides);
  - LZKG = Characteristic Numbers of Bed Load Transport (independent of tides);
  - LZKB = Characteristic Numbers of Eff. Bed Shear Stress (independent of tides);
  - LZXF = Characteristic Numbers of Water Transport (independent of tides);
  - LZXS = Characteristic Numbers of Salt Transport (independent of tides);
  - LZXT = Characteristic Numbers of Heat Transport (independent of tides);
  - LZXP = Characteristic Numbers of Tracer Transport (independent of tides);
  - LZXC = Characteristic Numbers of Suspended Sediment Transport (independent of tides);
  - LZXE = Characteristic Numbers of Tidal Energy Transport.
2. Result_File: name and type (NETCDF) of the result file (filetype cf-netcdf.nc).
Optional Input Blocks for different analyses

To specify meaningful bounds, which are the interval boundaries for the various frequency distributions computed, the range of the physical quantity under consideration should be evaluated before, e.g. using program NCAUTO.

required for LZKW:
- Block Water_Level_Bounds: definition of classes for water level.
  1. Interval: lower and upper bound of classes (intervals).
- Block Water_Level_Quantiles: definition of quantiles.
  1. Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
required for LZKV:
- Block Current_Velocity_Bounds: definition of classes for current velocity.
  1. Interval: lower and upper bound of classes (intervals).
- Block Current_Velocity_Quantiles: definition of quantiles.
  1. Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
required for LZKS:
- Block Salinity_Bounds: definition of classes for salinity.
  1. Interval: lower and upper bound of classes (intervals).
- Block Salinity_Quantiles: definition of quantiles.
  1. Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
required for LZKC:
- Block Suspended_Sediment_Bounds: definition of classes for suspended sediment concentration.
  1. Interval: lower and upper bound of classes (intervals).
- Block Suspended_Sediment_Quantiles: definition of quantiles.
  1. Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
required for LZKP:
- Block Tracer_Bounds: definition of classes for tracer load.
  1. Interval: lower and upper bound of classes (intervals).
- Block Tracer_Quantiles: definition of quantiles.
  1. Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
required for LZKM:
- Block Bathymetry_Bounds: definition of classes for bathymetry.
  1. Interval: lower and upper bound of classes (intervals).
- Block Bathymetry_Quantiles: definition of quantiles.
  1. Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
required for LZKG:
- Block Bedload_Bounds: definition of classes for bedload transport.
  1. Interval: lower and upper bound of classes (intervals).
- Block Bedload_Quantiles: definition of quantiles.
  1. Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
required for LZKB:
- Block Bedfriction_Bounds: definition of classes for eff. bed shear stress.
  1. Interval: lower and upper bound of classes (intervals).
- Block Bedfriction_Quantiles: definition of quantiles.
  1. Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.

General Remarks

Dictionary files used from directory $PROGHOME/dic/:
- ncanalyse_dico.dat and
- ncanalyse_config_dico.dat.
Standard configuration files used from directory $PROGHOME/cfg/:
- TDKW_ncanalyse_cfg.dat: definition file for Tidal Characteristic Numbers of Water Level;
- TDKV_ncanalyse_cfg.dat: definition file for Tidal Characteristic Numbers of Current;
- TDKS_ncanalyse_cfg.dat: definition file for Tidal Characteristic Numbers of Salinity;
- LZKW_ncanalyse_cfg.dat: definition file for Characteristic Numbers of Water Level (independent of tides);
- LZKV_ncanalyse_cfg.dat: definition file for Characteristic Numbers of Current Velocity (independent of tides);
- LZKS_ncanalyse_cfg.dat: definition file for Characteristic Numbers of Salinity (independent of tides);
- LZKC_ncanalyse_cfg.dat: definition file for Characteristic Numbers of Suspended Sediment Concentration (independent of tides);
- LZKP_ncanalyse_cfg.dat: definition file for Characteristic Numbers of Tracer Load (independent of tides);
- LZKM_ncanalyse_cfg.dat: definition file for Characteristic Numbers of Morphodynamics (independent of tides);
- LZKG_ncanalyse_cfg.dat: definition file for Characteristic Numbers of Bed Load Transport (independent of tides);
- LZKB_ncanalyse_cfg.dat: definition file for Characteristic Numbers of Eff. Bed Shear Stress (independent of tides);
- LZXF_ncanalyse_cfg.dat: definition file for Characteristic Numbers of Water Transport (independent of tides);
- LZXS_ncanalyse_cfg.dat: definition file for Characteristic Numbers of Salt Transport (independent of tides);
- LZXT_ncanalyse_cfg.dat: definition file for Characteristic Numbers of Heat Transport (independent of tides);
- LZXP_ncanalyse_cfg.dat: definition file for Characteristic Numbers of Tracer Transport (independent of tides);
- LZXC_ncanalyse_cfg.dat: definition file for Characteristic Numbers of Suspended Sediment Transport (independent of tides);
- LZXE_ncanalyse_cfg.dat: definition file for Characteristic Numbers of Tidal Energy Transport;

Programs using this Type of File

NCANALYSE

Example-File

$PROGHOME/examples/ncanalyse/ncanalyse.dat

back to: File Descriptions

Overview

@@ Line 58: / Line 58: @@
 *#* '''LZXE''' = [[Characteristic Numbers of Tidal Energy Transport]].
 *# '''Result_File''': name and type (NETCDF) of the result file (filetype [[CF-NETCDF.NC|cf-netcdf.nc]]).
-* required for '''LZKW''':
+* '''Optional Input Blocks''' for different analyses
-** Block '''Water_Level_Bounds''': definition of classes for water level.
+: To specify meaningful ''bounds'', which are the interval boundaries for the various frequency distributions computed, the range of the physical quantity under consideration should be evaluated before, e.g. using program [[NCAUTO]].
-**# '''Interval''': lower and upper bound of classes (intervals).
+:* required for '''LZKW''':
-** Block '''Water_Level_Quantiles''': definition of quantiles.
+:** Block '''Water_Level_Bounds''': definition of classes for water level.
-**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
+:**# '''Interval''': lower and upper bound of classes (intervals).
-* required for '''LZKV''':
+:** Block '''Water_Level_Quantiles''': definition of quantiles.
-** Block '''Current_Velocity_Bounds''': definition of classes for current velocity.
+:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
-**# '''Interval''': lower and upper bound of classes (intervals).
+:* required for '''LZKV''':
-** Block '''Current_Velocity_Quantiles''': definition of quantiles.
+:** Block '''Current_Velocity_Bounds''': definition of classes for current velocity.
-**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
+:**# '''Interval''': lower and upper bound of classes (intervals).
-* required for '''LZKS''':
+:** Block '''Current_Velocity_Quantiles''': definition of quantiles.
-** Block '''Salinity_Bounds''': definition of classes for salinity.
+:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
-**# '''Interval''': lower and upper bound of classes (intervals).
+:* required for '''LZKS''':
-** Block '''Salinity_Quantiles''': definition of quantiles.
+:** Block '''Salinity_Bounds''': definition of classes for salinity.
-**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
+:**# '''Interval''': lower and upper bound of classes (intervals).
-* required for '''LZKC''':
+:** Block '''Salinity_Quantiles''': definition of quantiles.
-** Block '''Suspended_Sediment_Bounds''': definition of classes for suspended sediment concentration.
+:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
-**# '''Interval''': lower and upper bound of classes (intervals).
+:* required for '''LZKC''':
-** Block '''Suspended_Sediment_Quantiles''': definition of quantiles.
+:** Block '''Suspended_Sediment_Bounds''': definition of classes for suspended sediment concentration.
-**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
+:**# '''Interval''': lower and upper bound of classes (intervals).
-* required for '''LZKP''':
+:** Block '''Suspended_Sediment_Quantiles''': definition of quantiles.
-** Block '''Tracer_Bounds''': definition of classes for tracer load.
+:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
-**# '''Interval''': lower and upper bound of classes (intervals).
+:* required for '''LZKP''':
-** Block '''Tracer_Quantiles''': definition of quantiles.
+:** Block '''Tracer_Bounds''': definition of classes for tracer load.
-**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
+:**# '''Interval''': lower and upper bound of classes (intervals).
-* required for '''LZKM''':
+:** Block '''Tracer_Quantiles''': definition of quantiles.
-** Block '''Bathymetry_Bounds''': definition of classes for bathymetry.
+:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
-**# '''Interval''': lower and upper bound of classes (intervals).
+:* required for '''LZKM''':
-** Block '''Bathymetry_Quantiles''': definition of quantiles.
+:** Block '''Bathymetry_Bounds''': definition of classes for bathymetry.
-**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
+:**# '''Interval''': lower and upper bound of classes (intervals).
-* required for '''LZKG''':
+:** Block '''Bathymetry_Quantiles''': definition of quantiles.
-** Block '''Bedload_Bounds''': definition of classes for bedload transport.
+:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
-**# '''Interval''': lower and upper bound of classes (intervals).
+:* required for '''LZKG''':
-** Block '''Bedload_Quantiles''': definition of quantiles.
+:** Block '''Bedload_Bounds''': definition of classes for bedload transport.
-**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
+:**# '''Interval''': lower and upper bound of classes (intervals).
-* required for '''LZKB''':
+:** Block '''Bedload_Quantiles''': definition of quantiles.
-** Block '''Bedfriction_Bounds''': definition of classes for eff. bed shear stress.
+:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
-**# '''Interval''': lower and upper bound of classes (intervals).
+:* required for '''LZKB''':
-** Block '''Bedfriction_Quantiles''': definition of quantiles.
+:** Block '''Bedfriction_Bounds''': definition of classes for eff. bed shear stress.
-**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
+:**# '''Interval''': lower and upper bound of classes (intervals).
+:** Block '''Bedfriction_Quantiles''': definition of quantiles.
+:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
 ===General Remarks===