OutputΒΆ

SPECIFICATION OF RESULT FOLDER

  • RESULT_FOLDER: result folder name, e.g., RESULT_FOLDER = /Users/tmp/

SPECIFICATION OF OUTPUT VARIABLES

  • NumberStations: number of station for output. If NumberStations \(> 0\), need input i,j in STATION_FILE
  • DEPTH_OUT: logical parameter for output depth. T or F.
  • U: logical parameter for output u. T or F.
  • V: logical parameter for output v. T or F.
  • ETA: logical parameter for output \(\eta\). T or F.
  • MASK: logical parameter for output wetting-drying MASK. T or F.
  • MASK9: logical parameter for output MASK9 (switch for Boussinesq/NSWE). T or F.
  • SourceX: logical parameter for output source terms in x direction. T or F.
  • SourceY: logical parameter for output source terms in y direction. T or F.
  • P: logical parameter for output of momentum flux in x direction. T or F.
  • Q: logical parameter for output of momentum flux in y direction. T or F.
  • Fx: logical parameter for output of numerical flux F in x direction. T or F.
  • Fy: logical parameter for output of numerical flux F in y direction. T or F.
  • Gx: logical parameter for output of numerical flux G in x direction. T or F.
  • Gy: logical parameter for output of numerical flux G in y direction. T or F.
  • AGE: logical parameter for output of breaking age. T or F.
  • HMAX: logical parameter for output of recorded maximum surface elevation . T or F.
  • HMIN: logical parameter for output of recorded minimum surface elevation . T or F.
  • UMAX: logical parameter for output of recorded maximum velocity . T or F.
  • VORMAX: logical parameter for output of recorded maximum vorticity . T or F.
  • MFMAX: logical parameter for output of recorded maximum momentum flux . T or F.
  • WaveHeight: logical parameter for output of wave height, Hsig, Hrms, Havg. T or F.
  • OUT_METEO: logical parameter for output of pressure field. T or F.

Output Format

The output files are saved in the result directory defined by RESULT_FOLDER in input.txt. A file name is a combination of variable name and an output series number such as eta_00001, eta_00002, .... The format and read/write algorithm are consistent with a depth file. Output for stations is a series of numbered files such as sta_0001, sta_0002 .... (NOTE: four digit numbers here vs. five digit numbers for 2D output like eta_00001).

  • ASCII format

The default format is ASCII. The format and read algorithm are consistent with a depth file.

  • BINARY format

When FIELD_IO_TYPE = BINARY is specified in input.txt, the 2D output files such as eta_00001, ... are in the binary format. Here’s an example of reading in matlab:

>>fileID=fopen(‘eta_00001’);

>>eta=fread(fileID,[Mglob Nglob],’*double’);

>>fclose(fileID);

>>pcolor(eta),shading flat

  • Other format

Other formats such as NetCDF and HDF5 are also provided but not distributed in the master Github repository.