SMS:CMS-Wave Control File

From XMS Wiki
Jump to: navigation, search

CMS-Wave parameter files (*.std) have been reworked for SMS 11.1 and later versions and their associated versions of CMS.

File Format

The new CMS-Wave parameters file (also referred to as an options or std file) begins with an identifier line. This line includes the text CMS_WAVE_STD and a version number.

Each subsequent line on the file includes a value, followed by a comment defining the option. The design was intended to replicate a card based ability to omit lines if the default value is to be used.

Sample File

CMS_WAVE_STD 1  !free format
1  !iprp
0  !icur
0  !ibreak
0  !irs
0  !kout
0  !ibnd
0  !iwet
0  !ibf
0  !iark
0  !iarkr
0  !iwvbk
0  !nonlin
0  !igrav
0  !irunup
1  !imud
1  !iwnd
4.0000  !akap
0.025  !bf
0.5000  !ark
0.3000  !arkr
0  !isolve
0  !ixmdf
1  !iproc
0  !iview
0  !inest


Old File Format

The old parameter file always contain a single line of data defining the parameter options for the simulation. This line will include either 6, 10 or 15 values. SMS writes all 15 values to the input files it creates. The other formats are supported for backward compatibility.

If only the first six values are present, the other nine values will be assigned default values. The default for the diffraction intensity factor is weak diffraction (akap = 1.0). The default for the other eight parameters is 0 (defined in table below).

If ten values exist in the file, bottom reflection is defaulted to off, forward reflection is defaulted to 50% and reverse reflection is defaulted to 30%.

After this single line, additional lines may be present to define the location of observation and nesting cells. CMS-Wave will save additional output (spectra) at these cells into the specified *.obs and *.nst files.

A sample file and table of the parameters is defined below.

iprp icur ibrk irs kout ibnd iwet ibf iark iarkr akap bf arc arkr iwvbk
kout rows (each row includes the I and J indices of a selected output cell
nestout
nestout rows (each row includes the I and J indices of selected nesting output cells

Sample Old File

1 0 0 0 2 0 0 0 0 0 4.000000 0.005000 0.500000 0.300000 0
10 15
23 41
4
28 7
27 8
28 9
29 10

Parameter definitions

Parameter Description
iprp -1, for fast-mode simulation
0, for wave generation and propagation (uses wind input and spectra)
1, for propagation only (neglect wind input)
2, for wind only (implies a zero energy spectra)
icur 0, no current file read
1, read current file with a dataset for each input spectra
2, read single data set from current file for all spectra
ibrk 0, no breaking file will be created
1, breaking file with be created with breaking index for each cell
2, breaking file with be created with energy dissipation flux saved for each cell
irs 0, no radiation stress gradient file will be created
1, radiation stress gradient file will be created
2, radiation stress gradient file and wave setup/maximum water level files will be created
kout 0, no selected output data files will be created
n, output spectra (.obs) and parameters (selhts.out) files will be created at n specified cells
ibnd 0, simulation will use single spectra (*.eng) file along offshore boundary
1, simulation will use nesting file (.nst) with linear interpolation of boundary input
2, simulation will use nesting file (.nst) with morphic interpolation of boundary input
iwet 0, normal wetting/drying (based on water level input)
1, no wetting/drying (water level input ignored)
ibf 0, no bottom friction
1, for bottom friction with constant Darcy-Weisbach type coefficient (bf)
2, for bottom friction with variable Darcy-Weisbach type coefficient (friction.dat)
3, for bottom friction with constant Manning coefficient (bf)
4, for bottom friction with variable Manning coefficient (friction.dat)
iark 0, no forward reflection
1, with forward reflection
iarkr 0, no backward reflection
1, with backward reflection
akap diffraction intensity factor (0 for no diffraction, 4 for strong diffraction)
bf constant bottom friction coefficient
ark constant forward reflection coefficient (0 for no reflection, 1 for maximum forward reflection)
arkr constant backward reflection coefficient (0 for no reflection, 1 for maximum backward reflection)
iwvbk 0, for extended Goda wave breaking (Sakai et al. 1989)
1, for extended Miche wave breaking (Battjes 1972; Mase et al. 2005b)
2, for Battjes and Janssen wave breaking (1978)
3, for Chawla and Kirby wave breaking (2002)

Related Topics