NCAGGREGATE.DAT

Basic Information

File-Type

ncaggregate.dat

File-Form

FORMATTED

Version

May 2023

Description-Date

December 2020

Significance of the File

contains general steering data for the program NCAGGREGATE.

File-Contents (in Catchwords)

steering data

• Block Program_Parameters: general input data
  1. Input_Data_File: CF NetCDF file with input data
  2. Output_Data_File: CF NetCDF file with aggregated result data
  3. Aggregation_File: definition of control volumes in file of type ipds.dat
  4. Aggregation_EPSG: EPSG code (see http://www.epsg-registry.org/) for coordinates stored in Aggregation_File
  5. (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
  6. (optional) NC_Cmode_Id: creation mode flag used for CF NetCDF method 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).
  7. (optional) Max_Time_Steps_Per_Record: maximum number of time steps allowed to be transferred in one WRITE to disc file.
  8. (optional) Create_Missing_Variables: create additional (virtual) variables

     0 = do not create (default);

     1 = create (for DFlow FM UGRID CF NetCDF).

  9. (optional) With_Median: compute (.true.) median (>= 2 values) or do not compute (.false.);
  10. (optional) With_Percentiles_05_95: compute (.true.) percentiles Q05, Q95 (>= 11 values) or do not compute (.false.);
  11. (optional) With_Percentiles_01_99: compute (.true.) percentiles Q01, Q99 (>= 51 values) or do not compute (.false.).
• (optional) Block Exclude_Variable_From_NCAGGREGATE: list of variables to be excluded from aggregation.
  1. Variable: variable from Input_Data_File. Key can be prescribed several times. With exception of the variables listed here results will be computed for all variables suited for aggregation.
• (optional) Block Include_Only_Variable_for_NCAGGREAGTE: list of variables for which results are exclusively aggregated.
  1. Variable: variable from Input_Data_File. Key can be prescribed several times. Aggregation will be solely performed for the variables listed here.
• (optional) Block Probability_Distribution_Group: classification and list of variables for which probability distributions are computed. Block can be prescribed several times.
  1. Bounds_Name: classification from file bounds.cfg.dat which will be used to compute probability distributions for all subsequent variables.
  2. Variable: variable from Input_Data_File. Key can be prescribed several times. Probability distributions will be solely performed for the variables listed here. Variables listed here shall not be excluded via blocks Exclude_Variable_From_NCAGGREGATE or Include_Only_Variable_for_NCAGGREAGTE.

General Remarks

1. Dictionary file used from directory $PROGHOME/dic/:
   • ncaggregate_dico.dat.
2. If no online compression is used during output file creation, it is recommended to apply NCCOPY manually. Example:

nccopy -k 3 -d 5 <infile> <outfile>

Programs using this Type of File

NCAGGREGATE

Example-File

$PROGHOME/examples/ncaggregate/ncaggregate.dat

---

back to: File Descriptions

---

Overview