SMS:BOUSS-2D Parameter File

The BOUSS-2D parameter file contains a series of comments and keywords that define the components and control the options of a simulation. Any line that begins withs "#" symbol is a comment and is ignored by the model. However, some utilities exist that may utilize comments.

Keywords begin with a ":" and are followed by values associated with the keyword.

The parameter file format is shown in Figure 1.

# ############################################################### # BOUSS-2D Run Parameter File: cirp_ideal.par # Written by: SMS # Creation Date: Tuesday June 22 16:49 2004 ###############################################################	File Header
# # Bathymetric Grid Parameters # :BATHY_FILE filename.grd :TIDAL_OFFSET offset value	Definition of grid and tidal offset
# # Damping Parameters :DAMPING_FILE filename.grd	Keywords for damping or porosity spatial input data */
# # Wavemaker #1 parameters # :START_WAVEMAKER : WM_POS_I1 value (column number) : WM_POS_J1 value (row number) : WM_POS_I2 value (column number) : WM_POS_J2 value (row number) : WAVE_TYPE value (Regular/Irreg_Uni/Irreg_Multi) : WAVE_HEIGHT value (meters) : WAVE_PERIOD value (seconds) : WAVE_DIRECTION value (degrees from North) : WAVE_CYCLES value (integer) :END_WAVEMAKER	The Wave maker definition. The position values must correspond to a single row or column. The values required depend on the wave type and method of defining that wave. The values shown illustrate a regular wave.
# # Simulation parameters # :DURATION value (seconds) :TIME_STEP value (seconds) :CHEZY_COEFF value (unitless default = 50) :SMAGORINSKY_CONST value (unitless default = 0.2) :NONLINEAR_OPTION value (Strong/Weak) :CHECK_WAVE_BREAKING value (Yes/No default - Yes) :TURB_LENGTH_SCALE value (meters0 :CALC_WAVE_RUNUP value (Yes/No default - No)	General model parameters
# # Output Parameters # :OUTPUT_FILE_PREFIX file prefix # # Output File for Significant Wave Height # :HS_FILE file prefix_hs.grd # # Output File for Mean Currents # :MEAN_UV_FILE file prefix_mean_uv.grd # # Output File for Mean Wave Direction # :THETA_FILE file prefix_theta.grd	Single Timestep (Steady State) spatially varied output options
# # Surface Elevation Animation File Output Options # :SAVE_ETA_ANIMATION : ETA_ANIM_FILE file prefix.eta : START_TIME value (seconds) : END_TIME value (seconds) : SAVE_TIME_STEP value (seconds) : SAVE_FULL_GRID value (Yes/No default = Yes) :END_SAVE_ETA_ANIMATION # # Velocity Animation File Output Options # :SAVE_UV_ANIMATION : UV_ANIM_FILE file prefix.uv : START_TIME value (seconds) : END_TIME value (seconds) : SAVE_TIME_STEP value (seconds) : SAVE_FULL_GRID value (Yes/No default = Yes) :END_SAVE_UV_ANIMATION	Multiple Timestep (transient animations) spatially varied output options
# # Time Series Output File Names # :TS_ETA_FILE file prefix_ts_eta.ts1 :TS_U_FILE file prefix_ts_u.ts1 :TS_V_FILE file prefix_ts_v.ts1 :TS_PRESSURE_FILE file prefix_ts_pressure.ts1 :TS_Q_FILE file prefix_ts_q.ts1 :TS_RUNUP_FILE file prefix_ts_runup.ts1	Header for time series output options - must be included to create TS1 files
# # Time Series Output Options # :SAVE_TIMESERIES value (id) : SAVE_TS_ETA value (Yes/No) : SAVE_TS_UV value (Yes/No) : SAVE_TS_PRESSURE value (Yes/No) : SAVE_TS_Q value (Yes/No) : TS_X value (meters) : TS_Y value (meters) : TS_Z_UV value (meters above bed) :END_SAVE_TIMESERIES #	Time Series specification block. Repeated as many times as needed.
# # Time Series Runup Output Options # :SAVE_RUNUP value (id) : TS_X value (meters) :END_SAVE_RUNUP #	Runup Series specification block. Repeated as many times as needed. Currently only supported for 1D mode
# # Output File for XMDF Solution File # :SOLUTION_FILE_OPTION value (0 - BOUSS-2D Native, 1 - XMDF, 2 - Both) :XMDF_SOLUTION_FILE file prefix_sol.h5	Output format selection

Figure 1. BOUSS2D Parameter File Format.