CMS-Wave Model Parameters: Difference between revisions

From CIRPwiki
Jump to navigation Jump to search
Line 25: Line 25:
! Number !! Variable !! Argument Type !! Range !! Description
! Number !! Variable !! Argument Type !! Range !! Description
|-
|-
|  1 || iprp ||  INTEGER || 0 - waves and wind input in *.eng <br /> 1 - waves only, neglect wind input in *.eng <br /> -1 - fast mode<br /> 2 - forced grid internal rotation <br /> 3 - without lateral energy flux || Wave propagation mode.
|  1 || iprp ||  INTEGER || 0 - waves and wind input in *.eng <br/> 1 - waves only, neglect wind input in *.eng <br/> -1 - fast mode <br/> 2 - forced grid internal rotation <br/> 3 - without lateral energy flux || Wave propagation mode.
|-
|-
| 2 || icur || INTEGER  || 0 - no current input <br /> 1 - with current input *.cur <br /> 2 -with *.cur, use only the 1st set current data || Current interaction  
| 2 || icur || INTEGER  || 0 - no current input <br /> 1 - with current input *.cur <br/> 2 -with *.cur, use only the 1st set current data || Current interaction  
|-
|-
| 3 || ibk  || INTEGER  || 0 - no wave breaking output <br /> 1 - output breaking indices <br /> 2 - output energy dissipation rate || Wave breaking output option
| 3 || ibk  || INTEGER  || 0 - no wave breaking output <br/> 1 - output breaking indices <br/> 2 - output energy dissipation rate || Wave breaking output option
|-
|-
| 4 || irs || INTEGER  || 0 - no wave radiation stress calculation or output <br /> 1 - calculate and output radiation stresses <br/> 2 - calculate and output radiation stresses plus setup/max-water-level|| Radiation stress and runup options.
| 4 || irs || INTEGER  || 0 - no wave radiation stress calculation or output <br/> 1 - calculate and output radiation stresses <br/> 2 - calculate and output radiation stresses plus setup/max-water-level|| Radiation stress and runup options.
|-
|-
| 5 || kout || INTEGER || >= 0 || Number of special wave output location, output spectrum in *.obs
| 5 || kout || INTEGER || >= 0 || Number of special wave output location, output spectrum in *.obs
and parameters in selhts.out
and parameters in selhts.out
|-
|-
| 6 || ibnd || INTEGER ||0 - no input a parent spectrum *.nst, 1 - read *.nst, averaging input spectrum,
| 6 || ibnd || INTEGER ||0 - no input a parent spectrum *.nst <br/> 1 - read *.nst, averaging input spectrum <br/> 2 - read *.nst, spatially variable spectrum input || Nesting option.
2 - read *.nst, spatially variable spectrum input || Nesting option.
|-
|-
| 7 || iwet|| INTEGER || 0 - allow wet/dry, default, 1 - without wet/dry, -1 allow wet/dry, output swell and local sea files, -2 - output combined steering wav files, -3 - output swell, local sea, and combined wav files || Wetting and drying options.
| 7 || iwet|| INTEGER || 0 - allow wet/dry, default <br/> 1 - without wet/dry <br/> -1 allow wet/dry, output swell and local sea files <br/> -2 - output combined steering wav files <br/> -3 - output swell, local sea, and combined wav files || Wetting and drying options.
|-
|-
| 8 || ibf || INTEGER || 0 - no bottom friction calc, 1 - constant Darcy-Weisbach coef, c_f, 2 -read variable c_f file, *.fric, 3 - constant Mannings n, 4 - read variable Mannings n file, *.fric || Bottom friction option.
| 8 || ibf || INTEGER || 0 - no bottom friction calc <br/> 1 - constant Darcy-Weisbach coef, c_f <br/> 2 -read variable c_f file, *.fric <br/> 3 - constant Mannings n <br/> 4 - read variable Mannings n file, *.fric || Bottom friction option.
|-
|-
| 9 || iark  || INTEGER ||  0 - without forward reflection, 1 - with forward reflection || Forward reflection option.
| 9 || iark  || INTEGER ||  0 - without forward reflection <br/> 1 - with forward reflection || Forward reflection option.
|-
|-
| 10 || iarkr || INTEGER || 0 - without backward reflection, 1 - with backward reflection || backward reflection option.
| 10 || iarkr || INTEGER || 0 - without backward reflection, 1 - with backward reflection || backward reflection option.
|-
|-
| 11 || icur || REAL  || 0 - no current input, 1 - with current input *.cur, 2 -with *.cur, use only the 1st set current data || Current interaction
| 11 || bf || REAL  || >=0 || constant bottom friction coef c_f or n
(typical value is 0.005 for c_f and 0.025 for Mannings n)
|-
|-
| 12 || icur || REAL  || 0 - no current input, 1 - with current input *.cur, 2 -with *.cur, use only the 1st set current data || Current interaction
| 12 || ark || REAL  || 0.0<=ark<=1.0 || Constant forward reflection coef, global specification (0 for zero reflection, 1 for full reflection).
|-
|-
| 13 || icur || REAL || 0 - no current input, 1 - with current input *.cur, 2 -with *.cur, use only the 1st set current data || Current interaction
| 13 || arkr || REAL || 0.0<=arkr<=1.0 || Constant backward reflection coef, global specification (
0 for zero reflection, 1 for full reflection)
|-
|-
| 14 || icur || REAL  || 0 - no current input, 1 - with current input *.cur, 2 -with *.cur, use only the 1st set current data || Current interaction
| 14 || iwvbk || INTEGER || 0 - Goda-extended <br/> 1 - Miche-extended <br/> 2 - Battjes and Janssen <br/> 3 - Chawla and Kirby) || Option for the primary wave breaking formula.
|-
|-
| 15 || icur || REAL  || 0 - no current input, 1 - with current input *.cur, 2 -with *.cur, use only the 1st set current data || Current interaction  
| 15 || nonln || INTEGER || 0 - none, default <br/> 1 - nonlinear wave-wave interaction || Nonlinear wave-wave interaction  
|-
|-
| 16 || icur || REAL  || 0 - no current input, 1 - with current input *.cur, 2 -with *.cur, use only the 1st set current data || Current interaction
| 16 || igrav || INTEGER || 0 - none, default <br/> 1 - infra-gravity wave enter inlets || Infragravity waves option.
|-
|-
| 17 || icur || REAL  || 0 - no current input, 1 - with current input *.cur, 2 -with *.cur, use only the 1st set current data || Current interaction
| 17 || irunup || INTEGER || 0 - none, default <br/> 1 - automatic, runup relative to absolute datum <br/>
2 - automatic, runup relative to updated MWL || Runup option.
|-
|-
| 18 || icur || REAL || 0 - no current input, 1 - with current input *.cur, 2 -with *.cur, use only the 1st set current data || Current interaction
| 18 || imud || INTEGER || 0 - none default <br/> 1 - Mud dissipation on || Mud dissipation option. The kinematic viscosity is specified in mud.dat in units of m<sup>2</sup>/sec
|-
|-
| 19 || icur || REAL  || 0 - no current input, 1 - with current input *.cur, 2 -with *.cur, use only the 1st set current data || Current interaction
| 19 || iwnd || INTEGER || 0 - none, default <br/> 1 - Spatially variable wind on || Spatially variable wind field option. The winds are specified in wind.dat in units of m/s and in the reference frame of the CMS-Wave grid
|-
|-
| 20 || icur || REAL  || 0 - no current input, 1 - with current input *.cur, 2 -with *.cur, use only the 1st set current data || Current interaction
| 20 || isolv || INTEGER || 0 - GSR solver, default <br/>  1 - ADI || Matrix solver for CMS-Wave.
|-
|-
| 21 || icur || REAL  || 0 - no current input, 1 - with current input *.cur, 2 -with *.cur, use only the 1st set current data || Current interaction
| 21 || ixmdf || INTEGER || 0 - output ascii, default <br/> 1 - output xmdf <br/> 2 - input & output xmdf || XMDF input and output options.
|-
|-
| 22 || icur || REAL || 0 - no current input, 1 - with current input *.cur, 2 -with *.cur, use only the 1st set current data || Current interaction
| 22 || iproc || INGEGER || 0 - same as 1, default || Number of threads for parallel computing. Optimum number is approximately equal to the total row number divided by 300. Only for isolv = 0.
|-
|-
| 23 || icur || REAL  || 0 - no current input, 1 - with current input *.cur, 2 -with *.cur, use only the 1st set current data || Current interaction  
| 23 || icur || REAL  || 0 - no current input, 1 - with current input *.cur, 2 -with *.cur, use only the 1st set current data || Current interaction  
Line 82: Line 84:
each of these 1<sup>st</sup> to 24<sup>th</sup> parameters are given below.
each of these 1<sup>st</sup> to 24<sup>th</sup> parameters are given below.
akap  = 0 to 4 (diffraction intensity, 0 for zero diffraction, 4 for strong diffraction)
akap  = 0 to 4 (diffraction intensity, 0 for zero diffraction, 4 for strong diffraction)
bf    =  constant bottom friction coef c_f or n
(typical value is 0.005 for c_f and 0.025 for Mannings n)
ark  =  0 to 1 (constant forward reflection coef, global specification,
0 for zero reflection, 1 for 100% or fully reflection)
arkr  =  0 to 1 (constant backward reflection coef, global specification,
0 for zero reflection, 1 for 100% or fully reflection)
iwvbk = 0 to 3 (option for the primary wave breaking formula:
0 for Goda-extended, 1 for Miche-extended,
2 for Battjes and Janssen, 3 for Chawla and Kirby)
nonln = 0 (none, default)  1 (nonlinear wave-wave interaction)
igrav  = 0 (none, default)  1 (infra-gravity wave enter inlets)
irunup = 0 (none, default)  1 (automatic, runup relative to absolute datum)
2 (automatic, runup relative to updated MWL)
imud  = 0 (mud.dat, default)  1 (none)  ---- useful to users who may not want to include the mud effect when the mud.dat exists (typical maximum kinematic viscosity in mud.dat
is 0.04 m<sup>2</sup>/sec)
iwnd  = 0 (wind.dat, default)  1 (none)  ----  useful in steering if users decide not
to read the spatially varied wind field input wind.dat when the wind.dat file exists
isolv  = 0 (GSR solver,  default)  1 (ADI)
ixmdf  = 0 (output ascii, default) 1 (output xmdf)  2 (input & output xmdf)
iproc  = 0 (same as 1, default)  n (n processors for isolv = 0)
optimum n = (total row number) /300


iview  = 0 (half-plane, default) 1 (full-plane) --- in the full plane, users can provide additional input wave spectrum file wave.spc (same format as the *.eng) along the opposite side boundary
iview  = 0 (half-plane, default) 1 (full-plane) --- in the full plane, users can provide additional input wave spectrum file wave.spc (same format as the *.eng) along the opposite side boundary

Revision as of 18:18, 16 March 2011

Model Control

CMS-Wave Model Control window.

To setup the model parameters for CMS-Wave:

1. Go to CMS-Wave, Model Control, and turn on Allow wetting and drying and Bed friction (Figure 38),

2. Users can also specify constant or varied forward and backward reflection coefficients in Settings,

3. Water level and wind information are optional source as specified under Wave Source in addition to the spectral input data,

4. File, Save As, Wave.sim (selecting the Save As Type as


CMS-Wave Model Control File

The *.std has a maximum of 24 parameters - the first 15 parameters are more the basic ones as described in the CMS-Wave Technical Report (CHL-TR-08-13) while the remaining 9 parameters are relatively new for advanced CMS-Wave features.

Table 1. CMS-Wave parameters in STD file

Number Variable Argument Type Range Description
1 iprp INTEGER 0 - waves and wind input in *.eng
1 - waves only, neglect wind input in *.eng
-1 - fast mode
2 - forced grid internal rotation
3 - without lateral energy flux
Wave propagation mode.
2 icur INTEGER 0 - no current input
1 - with current input *.cur
2 -with *.cur, use only the 1st set current data
Current interaction
3 ibk INTEGER 0 - no wave breaking output
1 - output breaking indices
2 - output energy dissipation rate
Wave breaking output option
4 irs INTEGER 0 - no wave radiation stress calculation or output
1 - calculate and output radiation stresses
2 - calculate and output radiation stresses plus setup/max-water-level
Radiation stress and runup options.
5 kout INTEGER >= 0 Number of special wave output location, output spectrum in *.obs

and parameters in selhts.out

6 ibnd INTEGER 0 - no input a parent spectrum *.nst
1 - read *.nst, averaging input spectrum
2 - read *.nst, spatially variable spectrum input
Nesting option.
7 iwet INTEGER 0 - allow wet/dry, default
1 - without wet/dry
-1 allow wet/dry, output swell and local sea files
-2 - output combined steering wav files
-3 - output swell, local sea, and combined wav files
Wetting and drying options.
8 ibf INTEGER 0 - no bottom friction calc
1 - constant Darcy-Weisbach coef, c_f
2 -read variable c_f file, *.fric
3 - constant Mannings n
4 - read variable Mannings n file, *.fric
Bottom friction option.
9 iark INTEGER 0 - without forward reflection
1 - with forward reflection
Forward reflection option.
10 iarkr INTEGER 0 - without backward reflection, 1 - with backward reflection backward reflection option.
11 bf REAL >=0 constant bottom friction coef c_f or n

(typical value is 0.005 for c_f and 0.025 for Mannings n)

12 ark REAL 0.0<=ark<=1.0 Constant forward reflection coef, global specification (0 for zero reflection, 1 for full reflection).
13 arkr REAL 0.0<=arkr<=1.0 Constant backward reflection coef, global specification (

0 for zero reflection, 1 for full reflection)

14 iwvbk INTEGER 0 - Goda-extended
1 - Miche-extended
2 - Battjes and Janssen
3 - Chawla and Kirby)
Option for the primary wave breaking formula.
15 nonln INTEGER 0 - none, default
1 - nonlinear wave-wave interaction
Nonlinear wave-wave interaction
16 igrav INTEGER 0 - none, default
1 - infra-gravity wave enter inlets
Infragravity waves option.
17 irunup INTEGER 0 - none, default
1 - automatic, runup relative to absolute datum

2 - automatic, runup relative to updated MWL || Runup option.

18 imud INTEGER 0 - none default
1 - Mud dissipation on
Mud dissipation option. The kinematic viscosity is specified in mud.dat in units of m2/sec
19 iwnd INTEGER 0 - none, default
1 - Spatially variable wind on
Spatially variable wind field option. The winds are specified in wind.dat in units of m/s and in the reference frame of the CMS-Wave grid
20 isolv INTEGER 0 - GSR solver, default
1 - ADI
Matrix solver for CMS-Wave.
21 ixmdf INTEGER 0 - output ascii, default
1 - output xmdf
2 - input & output xmdf
XMDF input and output options.
22 iproc INGEGER 0 - same as 1, default Number of threads for parallel computing. Optimum number is approximately equal to the total row number divided by 300. Only for isolv = 0.
23 icur REAL 0 - no current input, 1 - with current input *.cur, 2 -with *.cur, use only the 1st set current data Current interaction
24 icur REAL 0 - no current input, 1 - with current input *.cur, 2 -with *.cur, use only the 1st set current data Current interaction


Among these 24 parameters in *.std, the first 6 parameters are always required in CMS-Wave and the remaining ones starting any parameter after the 6th will be assigned to the default values if not provided in the *.std. The more specific use and options associated with each of these 1st to 24th parameters are given below. akap = 0 to 4 (diffraction intensity, 0 for zero diffraction, 4 for strong diffraction)

iview = 0 (half-plane, default) 1 (full-plane) --- in the full plane, users can provide additional input wave spectrum file wave.spc (same format as the *.eng) along the opposite side boundary (an imaginary origin for wave.spc at the opposite corner; users can rotate the CMS-Wave grid by 180 deg in SMS to generate this wave.spc)

Figure 6.1 shows the CMS-Wave interface window for Model Control in SMS11.

  • Full-plane – In this mode, CMS-Wave performs two half-plane runs in the same grid. The first

run is in the half-plane with the principle wave direction toward the shore. The second run is in the seaward half-plane. Upon the completion of the second run, two half-plane results are combined to one full-plane solution. Because the run time for the full-plane is approximately twice of the regular half-plane, users shall consider the full-plane mode only if the full-plane features like wave generation and propagation in a bay or around an island. An example is to run the Shark River wave case, 2009.sim, in the full plane (modify 2009.std).