NCANALYSE.DAT: Difference between revisions
From BAWiki
imported>Lang Guenther (INformations added for analysis mode LZSS, plus optional Block TDKW_Quantiles) |
imported>Lang Guenther (harmonic analysis of water level (tidal constituents) added) |
||
Line 2: | Line 2: | ||
|name_de=NCANALYSE.DAT | |name_de=NCANALYSE.DAT | ||
|filetype=ncanalyse.dat | |filetype=ncanalyse.dat | ||
|version= | |version=July 2016 | ||
|version_descr= | |version_descr=July 2016 | ||
|significance=contains general steering data for the program [[NCANALYSE]]. | |significance=contains general steering data for the program [[NCANALYSE]]. | ||
|filecontents= | |filecontents= | ||
Line 18: | Line 18: | ||
*#: 5 = good compression (recommendation); | *#: 5 = good compression (recommendation); | ||
*#: 9 = highest level of compression. | *#: 9 = highest level of compression. | ||
*# (optional) '''FRQ_use_j_v_correction''': nodal correction in tidal constituent analysis | |||
*#: .true. = use nodal correction in computation of tidal constituents (default); | |||
*#: .false. = ''neglect'' nodal correction in computation of tidal constituents. | |||
* Block '''Data_Analysis_Period''': period of data analysis | * Block '''Data_Analysis_Period''': period of data analysis | ||
*# '''Start_Time''': start time of data analysis period. | *# '''Start_Time''': start time of data analysis period. | ||
Line 46: | Line 49: | ||
*#* '''TDKC''' = [[Tidal Characteristic Numbers of Suspended Sediment Transport|Tidal Characteristic Numbers of Suspended Sediment]]; | *#* '''TDKC''' = [[Tidal Characteristic Numbers of Suspended Sediment Transport|Tidal Characteristic Numbers of Suspended Sediment]]; | ||
*#* '''TDKP''' = [[Tidal Characteristic Numbers of Tracer Load]]; | *#* '''TDKP''' = [[Tidal Characteristic Numbers of Tracer Load]]; | ||
*#* '''FRQW''' = [[Harmonic Analysis of Water Level|Harmonic Analysis of Water Level (tidal constituents)]]; | |||
*#* '''LZKW''' = [[Characteristic Numbers of Water Level (independent of tides)]]; | *#* '''LZKW''' = [[Characteristic Numbers of Water Level (independent of tides)]]; | ||
*#* '''LZKV''' = [[Characteristic Numbers of Current Velocity (independent of tides)]]; | *#* '''LZKV''' = [[Characteristic Numbers of Current Velocity (independent of tides)]]; | ||
Line 71: | Line 75: | ||
:** Block '''TDKW_Quantiles''': definition of quantiles. | :** Block '''TDKW_Quantiles''': definition of quantiles. | ||
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5. | :**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5. | ||
:* optional for '''FRQW''': | |||
:** Block '''Tidal_Constituents''': list of tidal constituents | |||
:**# '''Value''': code of tidal constituent, e. g. Mm, Mf, K_1, O_1, S_2, M_2, M_4, M_6, M_8. | |||
* '''Optional Required Input Blocks''' for different analyses | * '''Optional Required 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]]. | : 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]]. | ||
Line 144: | Line 151: | ||
#* '''TDKC_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Suspended Sediment Transport|Tidal Characteristic Numbers of Suspended Sediment]]; | #* '''TDKC_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Suspended Sediment Transport|Tidal Characteristic Numbers of Suspended Sediment]]; | ||
#* '''TDKP_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Tracer Load]]; | #* '''TDKP_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Tracer Load]]; | ||
#* '''FRQW_ncanalyse_cfg.dat''': definition file for [[Harmonic Analysis of Water Level]]; | |||
#* '''LZKW_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Water Level (independent of tides)]]; | #* '''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)]]; | #* '''LZKV_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Current Velocity (independent of tides)]]; |
Revision as of 07:57, 28 July 2016
Basic Information
File-Type
ncanalyse.dat
File-Form
FORMATTED
Version
July 2016
Description-Date
July 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
- Max_Read_Storage: maximum number of data items which can be read, stored and processed within one analysis cycle.
- Min_Water_Depth: minimum water depth up to which analyses are carried through.
- (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).
- (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.
- (optional) FRQ_use_j_v_correction: nodal correction in tidal constituent analysis
- .true. = use nodal correction in computation of tidal constituents (default);
- .false. = neglect nodal correction in computation of tidal constituents.
- Block Data_Analysis_Period: period of data analysis
- Start_Time: start time of data analysis period.
- End_Time: end time of data analysis period.
- Block Input_Files: CF NetCDF file with input data
- Data_File: name and type (NETCDF) of the input data file (filetype cf-netcdf.nc).
- Block Location: reference locations (one block per location)
- Name: name of reference location.
- 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).
- X: x-coordinate of location(specify either X and Y or LON and LAT).
- Y: y-coordinate of location (specify either X and Y or LON und LAT).
- LON: longitude of location (specify either X and Y or LON and LAT).
- LAT: latitude of location (specify either X and Y or LON and LAT).
- Z: z-coordinate of location (positive downwards).
- Rank: rank of location(not for reference location phase).
- 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
- 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
- Type: type of analysis:
- TDKW = Tidal Characteristic Numbers of Water Level;
- TDKV = Tidal Characteristic Numbers of Current;
- TDKS = Tidal Characteristic Numbers of Salinity;
- TDKT = Tidal Characteristic Numbers of Temperature;
- TDKC = Tidal Characteristic Numbers of Suspended Sediment;
- TDKP = Tidal Characteristic Numbers of Tracer Load;
- FRQW = Harmonic Analysis of Water Level (tidal constituents);
- 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);
- LZKT = Characteristic Numbers of Temperature (independent of tides);
- LZKC = Characteristic Numbers of Suspended Sediment Concentration (independent of tides);
- LZKP = Characteristic Numbers of Tracer Load (independent of tides);
- LZKO = Characteristic Numbers of Oxygen Concentration (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);
- LZXG = Characteristic Numbers of Sediment Transport (independent of tides) (bed and suspended load at the bottom);
- LZXE = Characteristic Numbers of Tidal Energy Transport;
- LZMW = Characteristic Numbers of Meteorological Data (Wind Speed);
- LZSS = Characteristic Numbers for Wave and Sea State (significant wave height).
- Result_File: name and type (NETCDF) of the result file (filetype cf-netcdf.nc).
- Type: type of analysis:
- 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.
- optional for TDKW:
- Block TDKW_Quantiles: definition of quantiles.
- Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
- Block TDKW_Quantiles: definition of quantiles.
- optional for FRQW:
- Block Tidal_Constituents: list of tidal constituents
- Value: code of tidal constituent, e. g. Mm, Mf, K_1, O_1, S_2, M_2, M_4, M_6, M_8.
- Block Tidal_Constituents: list of tidal constituents
- optional for TDKW:
- Optional Required 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.
- Interval: lower and upper bound of classes (intervals).
- Block Water_Level_Quantiles: definition of quantiles.
- Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
- Block Water_Level_Bounds: definition of classes for water level.
- required for LZKV:
- Block Current_Velocity_Bounds: definition of classes for current velocity.
- Interval: lower and upper bound of classes (intervals).
- Block Current_Velocity_Quantiles: definition of quantiles.
- Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
- Block Current_Velocity_Bounds: definition of classes for current velocity.
- required for LZKS:
- Block Salinity_Bounds: definition of classes for salinity.
- Interval: lower and upper bound of classes (intervals).
- Block Salinity_Quantiles: definition of quantiles.
- Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
- Block Salinity_Bounds: definition of classes for salinity.
- required for LZKT:
- Block Temperature_Bounds: definition of classes for temperature.
- Interval: lower and upper bound of classes (intervals).
- Block Temperature_Quantiles: definition of quantiles.
- Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
- Block Temperature_Bounds: definition of classes for temperature.
- required for LZKC:
- Block Suspended_Sediment_Bounds: definition of classes for suspended sediment concentration.
- Interval: lower and upper bound of classes (intervals).
- Block Suspended_Sediment_Quantiles: definition of quantiles.
- Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
- Block Suspended_Sediment_Bounds: definition of classes for suspended sediment concentration.
- required for LZKP:
- Block Tracer_Bounds: definition of classes for tracer load.
- Interval: lower and upper bound of classes (intervals).
- Block Tracer_Quantiles: definition of quantiles.
- Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
- Block Tracer_Bounds: definition of classes for tracer load.
- required for LZKO:
- Block Oxygen_Bounds: definition of classes for oxygen concentration.
- Interval: lower and upper bound of classes (intervals).
- Block Oxygen_Quantiles: definition of quantiles.
- Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
- Block Oxygen_Bounds: definition of classes for oxygen concentration.
- required for LZKM:
- Block Bathymetry_Bounds: definition of classes for bathymetry.
- Interval: lower and upper bound of classes (intervals).
- Block Bathymetry_Quantiles: definition of quantiles.
- Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
- Block Bathymetry_Bounds: definition of classes for bathymetry.
- required for LZKG:
- Block Bedload_Bounds: definition of classes for bedload transport.
- Interval: lower and upper bound of classes (intervals).
- Block Bedload_Quantiles: definition of quantiles.
- Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
- Block Bedload_Bounds: definition of classes for bedload transport.
- required for LZKB:
- Block Bedfriction_Bounds: definition of classes for eff. bed shear stress.
- 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.
- Block Bedfriction_Bounds: definition of classes for eff. bed shear stress.
- required for LZMW:
- Block Wind_Bounds: definition of classes for wind speed.
- Interval: lower and upper bound of classes (intervals).
- Block Wind_Quantiles: definition of quantiles.
- Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
- Block Wind_Bounds: definition of classes for wind speed.
- required for LZSS:
- Block Sig_Wave_Bounds: definition of classes for significant wave height.
- Interval: lower and upper bound of classes (intervals).
- Block Sig_Wave_Quantiles: definition of quantiles.
- Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
- Block Sig_Wave_Bounds: definition of classes for significant wave height.
- required for LZKW:
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;
- TDKT_ncanalyse_cfg.dat: definition file for Tidal Characteristic Numbers of Temperature;
- TDKC_ncanalyse_cfg.dat: definition file for Tidal Characteristic Numbers of Suspended Sediment;
- TDKP_ncanalyse_cfg.dat: definition file for Tidal Characteristic Numbers of Tracer Load;
- FRQW_ncanalyse_cfg.dat: definition file for Harmonic Analysis of Water Level;
- 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);
- LZKT_ncanalyse_cfg.dat: definition file for Characteristic Numbers of Temperature (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);
- LZKO_ncanalyse_cfg.dat: definition file for Characteristic Numbers of Oxygen Concentration (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);
- LZXG_ncanalyse_cfg.dat: definition file for Characteristic Numbers of Sediment Transport (independent of tides) (bed an suspended load at the bottom);
- LZXE_ncanalyse_cfg.dat: definition file for Characteristic Numbers of Tidal Energy Transport;
- LZMW_ncanalyse_cfg.dat: definition file for Characteristic Numbers of Meteorological Data (Wind Speed);
- LZSS_ncanalyse_cfg.dat: definition file for Characteristic Numbers for Wave and Sea State (significant wave height).
Programs using this Type of File
Example-File
$PROGHOME/examples/ncanalyse/ncanalyse.dat
back to: File Descriptions