Actions

Difference between revisions of "NCANALYSE.DAT"

From BAWiki

imported>Lang Guenther
((optional) block TDKP_Quantiles added)
(Input_files, Data_File remark concerning type of MPI method used during read added: MPI COLLECTIVE or INDEPENDENT I/O)
 
(11 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
|name_de=NCANALYSE.DAT
 
|name_de=NCANALYSE.DAT
 
|filetype=ncanalyse.dat
 
|filetype=ncanalyse.dat
|version=February 2017
+
|version=October 2021
|version_descr=April 2017
+
|version_descr=October 2021
 
|significance=contains general steering data for the program [[NCANALYSE]].
 
|significance=contains general steering data for the program [[NCANALYSE]].
 
|filecontents=
 
|filecontents=
Line 25: Line 25:
 
*#: .false. = normal execution of program (default).
 
*#: .false. = normal execution of program (default).
 
*# (optional) '''CU_zero_slack''': critical value for current velocity in [m s-1]. Typically 1 [cm s-1] is predefined in the configuration files. This value is used to determine current slack. Current slack is recognized by the program in case magnitude of current velocity lies above this limit value and the direction of flow has changed.
 
*# (optional) '''CU_zero_slack''': critical value for current velocity in [m s-1]. Typically 1 [cm s-1] is predefined in the configuration files. This value is used to determine current slack. Current slack is recognized by the program in case magnitude of current velocity lies above this limit value and the direction of flow has changed.
 +
*# (optional) '''Compute_FE_Ratio''': Compute flood(current):ebb(current) characteristic numbers, in case they are marked using <OPT:COMPUTE_FE_RATIO> in a configuration file.
 +
*#: .true. = F:E-Kenngrößen berechnen
 +
*#: .false. = F:E-Kenngrößen nicht berechnen (Default)
 +
*# (optional) '''CFG_Level''':  some configuration files may contain lines including <OPT:CFG_Level_''number''> to allow for a more flexible use for different purposes.
 +
*#: 0 = activate lines including <OPT:CFG_Level_0> (default)
 +
*#: 1 = activate lines including <OPT:CFG_Level_1>
 +
*# (optional) '''Location_XY_EPSG''': EPSG code for X- and Y-coordinates used in '''Location''' blocks. In case this key is missing, EPSG code derived from input data (block '''Input_Files''') will be used.
 +
*# (optional) '''Gap_Fill''': control parameter for filling data gaps at reference locations by interpolation. If this key is not specified, data gaps (water level, current) are not automatically filled.
 +
*#: 0 = data gaps are not filled (default)
 +
*#: 1 = Data gaps are filled by spline interpolation
 
* 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.
 
*# '''End_Time''': end time of data analysis period.
 
*# '''End_Time''': end time of data analysis period.
 
* Block '''Input_Files''': [[NetCDF|CF NetCDF]] file with input data
 
* Block '''Input_Files''': [[NetCDF|CF NetCDF]] file with input data
*# '''Data_File''': name and type (NETCDF) of the input data file (filetype [[CF-NETCDF.NC|cf-netcdf.nc]]).
+
*# '''Data_File''': name and type (NETCDF) of the input data file (filetype [[CF-NETCDF.NC|cf-netcdf.nc]]). An optional third parameter may be used to choose between MPI COLLECTIVE I/O and MPI INDEPENDENT I/O (relevant for MPI program version only).
 
* Block '''Location''': reference locations (one block per location)
 
* Block '''Location''': reference locations (one block per location)
 
*# '''Name''': name of reference location.
 
*# '''Name''': name of reference location.
Line 50: Line 60:
 
*#* '''TDKV''' = [[Tidal Characteristic Numbers of Current]];
 
*#* '''TDKV''' = [[Tidal Characteristic Numbers of Current]];
 
*#* '''TDXF''' = [[Tidal Characteristic Numbers of Water Transport]];
 
*#* '''TDXF''' = [[Tidal Characteristic Numbers of Water Transport]];
*#* '''TDKS''' = [[Tidal Characteristic Numbers of Salinity]];
+
*#* '''TDKS''' or '''TDWS''' = [[Tidal Characteristic Numbers of Salinity]];
 
*#* '''TDXS''' = [[Tidal Characteristic Numbers of Salt Transport]];
 
*#* '''TDXS''' = [[Tidal Characteristic Numbers of Salt Transport]];
 
*#* '''TDKT''' = [[Tidal Characteristic Numbers of Temperature]];
 
*#* '''TDKT''' = [[Tidal Characteristic Numbers of Temperature]];
Line 60: Line 70:
 
*#* '''TDKB''' = [[Tidal Characteristic Numbers of Eff. Bed Shear Stress Action|Tidal Characteristic Numbers of Effective Bed Shear Stress]];
 
*#* '''TDKB''' = [[Tidal Characteristic Numbers of Eff. Bed Shear Stress Action|Tidal Characteristic Numbers of Effective Bed Shear Stress]];
 
*#* '''TDKG''' = [[Tidal Characteristic Numbers of Bed Load Transport]];
 
*#* '''TDKG''' = [[Tidal Characteristic Numbers of Bed Load Transport]];
 +
*#* '''TDKA''' = [[Tidal Characteristic Numbers of Potential Energy Anomaly]];
 
*#* '''FRQW''' = [[Harmonic Analysis of Water Level|Harmonic Analysis of Water Level (tidal constituents)]];
 
*#* '''FRQW''' = [[Harmonic Analysis of Water Level|Harmonic Analysis of Water Level (tidal constituents)]];
 
*#* '''FRQV''' = [[Harmonic Analysis of Current Velocity|Harmonic Analysis of Current Velocity (tidal constituents)]];
 
*#* '''FRQV''' = [[Harmonic Analysis of Current Velocity|Harmonic Analysis of Current Velocity (tidal constituents)]];
Line 72: Line 83:
 
*#* '''LZKG''' = [[Characteristic Numbers of Bed Load Transport (independent of tides)]];
 
*#* '''LZKG''' = [[Characteristic Numbers of Bed Load Transport (independent of tides)]];
 
*#* '''LZKB''' = [[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)]];
 
*#* '''LZKB''' = [[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)]];
 +
*#* '''LZKA''' = [[Characteristic Numbers of Potential Energy Anomaly (independent of tides)]];
 
*#* '''LZXF''' = [[Characteristic Numbers of Water Transport (independent of tides)]];
 
*#* '''LZXF''' = [[Characteristic Numbers of Water Transport (independent of tides)]];
 
*#* '''LZXS''' = [[Characteristic Numbers of Salt Transport (independent of tides)]];
 
*#* '''LZXS''' = [[Characteristic Numbers of Salt Transport (independent of tides)]];
Line 90: Line 102:
 
:** Block '''TDKV_Quantiles''': definition of quantiles.
 
:** Block '''TDKV_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 '''TDKS''':  
+
:* optional for '''TDKS''' or '''TDWS''':  
:** Block '''TDKS_Quantiles''': definition of quantiles.
+
:** Block '''TDKS_Quantiles''' or '''TDWS_Quantiles''': definition of quantiles.
 +
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
 +
:* optional for '''TDKT''':
 +
:** Block '''TDKT_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 '''TDKC''':  
 
:* optional for '''TDKC''':  
Line 98: Line 113:
 
:* optional for '''TDKP''':  
 
:* optional for '''TDKP''':  
 
:** Block '''TDKP_Quantiles''': definition of quantiles.
 
:** Block '''TDKP_Quantiles''': definition of quantiles.
 +
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
 +
:* optional for '''TDKG''':
 +
:** Block '''TDKG_Quantiles''': definition of quantiles.
 +
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
 +
:* optional for '''TDKB''':
 +
:** Block '''TDKB_Quantiles''': definition of quantiles.
 +
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
 +
:* optional for '''TDKA''':
 +
:** Block '''TDKA_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''' and '''FRQV''':  
 
:* optional for '''FRQW''' and '''FRQV''':  
Line 153: Line 177:
 
:**# '''Interval''': lower and upper bound of classes (intervals).
 
:**# '''Interval''': lower and upper bound of classes (intervals).
 
:** Block '''Bedfriction_Quantiles''': definition of quantiles.
 
:** Block '''Bedfriction_Quantiles''': definition of quantiles.
 +
:**# '''Value''': quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
 +
:* required for '''LZKA''':
 +
:** Block '''PE_Anomaly_Bounds''': definition of classes for PEA.
 +
:**# '''Interval''': lower and upper bound of classes (intervals).
 +
:** Block '''PE_Anomaly_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.
 
:* required for '''LZMW''':  
 
:* required for '''LZMW''':  
Line 182: Line 211:
 
#* '''TDKB_ncanalyse_cfg.dat''': definition file for  [[Tidal Characteristic Numbers of Eff. Bed Shear Stress Action|Tidal Characteristic Numbers of Effective Bed Shear Stress]];
 
#* '''TDKB_ncanalyse_cfg.dat''': definition file for  [[Tidal Characteristic Numbers of Eff. Bed Shear Stress Action|Tidal Characteristic Numbers of Effective Bed Shear Stress]];
 
#* '''TDKG_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Bed Load Transport]];
 
#* '''TDKG_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Bed Load Transport]];
 +
#* '''TDKA_ncanalyse_cfg.dat''': definition file for [[Tidal Characteristic Numbers of Potential Energy Anomaly]];
 
#* '''FRQW_ncanalyse_cfg.dat''': definition file for [[Harmonic Analysis of Water Level]];
 
#* '''FRQW_ncanalyse_cfg.dat''': definition file for [[Harmonic Analysis of Water Level]];
 
#* '''FRQV_ncanalyse_cfg.dat''': definition file for [[Harmonic Analysis of Current Velocity]];
 
#* '''FRQV_ncanalyse_cfg.dat''': definition file for [[Harmonic Analysis of Current Velocity]];
Line 194: Line 224:
 
#* '''LZKG_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Bed Load Transport (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)]];
 
#* '''LZKB_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Eff. Bed Shear Stress (independent of tides)]];
 +
#* '''LZKA_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Potential Energy Anomaly (independent of tides)]];
 
#* '''LZXF_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Water Transport (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)]];
 
#* '''LZXS_ncanalyse_cfg.dat''': definition file for [[Characteristic Numbers of Salt Transport (independent of tides)]];

Latest revision as of 09:10, 12 October 2021

Basic Information

File-Type

ncanalyse.dat

Version

October 2021

Description-Date

October 2021

Significance of the File

contains general steering data for the program NCANALYSE.

File-Contents (in Catchwords)

steering data

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.
      1. Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
  • optional for TDKV:
    • Block TDKV_Quantiles: definition of quantiles.
      1. Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
  • optional for TDKS or TDWS:
    • Block TDKS_Quantiles or TDWS_Quantiles: definition of quantiles.
      1. Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
  • optional for TDKT:
    • Block TDKT_Quantiles: definition of quantiles.
      1. Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
  • optional for TDKC:
    • Block TDKC_Quantiles: definition of quantiles.
      1. Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
  • optional for TDKP:
    • Block TDKP_Quantiles: definition of quantiles.
      1. Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
  • optional for TDKG:
    • Block TDKG_Quantiles: definition of quantiles.
      1. Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
  • optional for TDKB:
    • Block TDKB_Quantiles: definition of quantiles.
      1. Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
  • optional for TDKA:
    • Block TDKA_Quantiles: definition of quantiles.
      1. Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
  • optional for FRQW and FRQV:
    • Block Tidal_Constituents: list of tidal constituents
      1. 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
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 LZKT:
    • Block Temperature_Bounds: definition of classes for temperature.
      1. Interval: lower and upper bound of classes (intervals).
    • Block Temperature_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 LZKO:
    • Block Oxygen_Bounds: definition of classes for oxygen concentration.
      1. Interval: lower and upper bound of classes (intervals).
    • Block Oxygen_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.
  • required for LZKA:
    • Block PE_Anomaly_Bounds: definition of classes for PEA.
      1. Interval: lower and upper bound of classes (intervals).
    • Block PE_Anomaly_Quantiles: definition of quantiles.
      1. Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
  • required for LZMW:
    • Block Wind_Bounds: definition of classes for wind speed.
      1. Interval: lower and upper bound of classes (intervals).
    • Block Wind_Quantiles: definition of quantiles.
      1. Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.
  • required for LZSS:
    • Block Sig_Wave_Bounds: definition of classes for significant wave height.
      1. Interval: lower and upper bound of classes (intervals).
    • Block Sig_Wave_Quantiles: definition of quantiles.
      1. Value: quantile from interval ] 0.0, 1.0 [; for median choose Value = 0.5.

General Remarks

  1. Dictionary files used from directory $PROGHOME/dic/:
    • ncanalyse_dico.dat and
    • ncanalyse_config_dico.dat.
  2. Standard configuration files used from directory $PROGHOME/cfg/:

Programs using this Type of File

NCANALYSE

Additional Information

Language

Fortran90

File-Form

FORMATTED

File-Access

SEQUENTIAL

File-Extension

.dat

WRITE-Subroutine(s)/Module(s)

---

READ-Subroutine(s)/Module(s)

$PROGHOME/fortran/prg/ncanalyse/*/mod_m_ncanalyse_steer.f90

Original Version

G. Lang

Maintenance

G. Lang, S. Spohr

Example-File

$PROGHOME/examples/ncanalyse/ncanalyse.dat


back to: File Descriptions


Overview