Wave CardFormat2: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
Line 23: | Line 23: | ||
|WV_BOUNDARY_NESTING || STRING || 'OFF' or 'NONE'<br>'LINEAR'<br>'MORPHIC' || | |WV_BOUNDARY_NESTING || STRING || 'OFF' or 'NONE'<br>'LINEAR'<br>'MORPHIC' || | ||
|- | |- | ||
|WV_BOTTOM_FRICTION || STRING || 'OFF' or 'NONE'<br>'CONST_DARCY_WEISBACH'<br>'VAR_DARCY_WEISBACH'<br>'CONST_MANNINGS'<br>'VAR_MANNINGS' || | |WV_BOTTOM_FRICTION || STRING || 'OFF' or 'NONE'<br>'CONST_DARCY_WEISBACH'<br>'VAR_DARCY_WEISBACH'<br>'CONST_MANNINGS'<br>'VAR_MANNINGS' || Constant or variable bottom friction using Darcy Weisbach (c_f) or Mannings (n) | ||
|- | |- | ||
|WV_WETTING_DRYING || STRING || 'ON'<br>'OFF'<br>'ON_WITH_SEA-SWELL_FILES' || | |WV_WETTING_DRYING || STRING || 'ON'<br>'OFF'<br>'ON_WITH_SEA-SWELL_FILES' || | ||
Line 29: | Line 29: | ||
|WV_DIFFRACTION_INTENSITY || REAL || #.### || Range 0.0 <= [value] <= 1.0 | |WV_DIFFRACTION_INTENSITY || REAL || #.### || Range 0.0 <= [value] <= 1.0 | ||
|- | |- | ||
|WV_NUM_THREADS || INTEGER || # || Only used when WV_MATRIX_SOLVER is set to 'GAUSS-SEIDEL' | |WV_NUM_THREADS || INTEGER || # || Only used when WV_MATRIX_SOLVER is set to 'GAUSS-SEIDEL'<br>Optimum number is approximately #rows / 300 | ||
|- | |- | ||
|WV_NESTING_CELLS || INTEGER [INT INT ... INT INT]|| 0<br># # # ... # # || If 0, nothing else is read<br>If n>0, reads 'n' pairs of I J cell values | |WV_NESTING_CELLS || INTEGER [INT INT ... INT INT]|| 0<br># # # ... # # || If 0, nothing else is read<br>If n>0, reads 'n' pairs of I J cell values | ||
Line 35: | Line 35: | ||
|WV_OBSERVATION_CELLS || INTEGER [INT INT ... INT INT]|| 0<br># # # ... # # || If 0, nothing else is read<br>If n>0, reads 'n' pairs of I J cell values | |WV_OBSERVATION_CELLS || INTEGER [INT INT ... INT INT]|| 0<br># # # ... # # || If 0, nothing else is read<br>If n>0, reads 'n' pairs of I J cell values | ||
|- | |- | ||
|WV_BOTTOM_FRICTION_COEFF || REAL || #.## || Only used if WV_BOTTOM_FRICTION is a 'CONST' type | |WV_BOTTOM_FRICTION_COEFF || REAL || #.## || Only used if WV_BOTTOM_FRICTION is a 'CONST' type<br>Typical value is 0.005 for c_f and 0.025 for Mannings n. | ||
|- | |- | ||
|WV_FWD_REFLECTION_COEFF || REAL || #.## || | |WV_FWD_REFLECTION_COEFF || REAL || #.## || Range 0.0 <= [value] <= 1.0 | ||
|- | |- | ||
|WV_BWD_REFLECTION_COEFF || REAL || #.## || | |WV_BWD_REFLECTION_COEFF || REAL || #.## || Range 0.0 <= [value] <= 1.0 | ||
|- | |- | ||
|WV_BREAKING_FORMULA || STRING || 'EXT_GODA'<br>'EXT_MICHE'<br>'BATTJES_JANSSEN_78'<br>'CHAWLA_KIRBY'<br>'BATTJES_JANSSEN_07' || | |WV_BREAKING_FORMULA || STRING || 'EXT_GODA'<br>'EXT_MICHE'<br>'BATTJES_JANSSEN_78'<br>'CHAWLA_KIRBY'<br>'BATTJES_JANSSEN_07' || | ||
Line 47: | Line 47: | ||
|WV_ENABLE_INFRAGRAVITY || STRING || 'OFF'<br>'ON' || | |WV_ENABLE_INFRAGRAVITY || STRING || 'OFF'<br>'ON' || | ||
|- | |- | ||
|WV_ENABLE_MUDDY_BED || STRING || 'ON'<br>'OFF' || | |WV_ENABLE_MUDDY_BED || STRING || 'ON'<br>'OFF' || The kinematic viscosity is specified in 'mud.dat' in units of <math>m^2/sec</math> | ||
|- | |- | ||
|WV_ENABLE_NONLINEAR_WAVES || STRING || 'OFF'<br>'ON' || | |WV_ENABLE_NONLINEAR_WAVES || STRING || 'OFF'<br>'ON' || | ||
Line 55: | Line 55: | ||
|WV_ENABLE_RUNUP || STRING || 'OFF'<br>'REL_TO_ABS_DATUM'<br>'REL_TO_UPDATED_MWL' || | |WV_ENABLE_RUNUP || STRING || 'OFF'<br>'REL_TO_ABS_DATUM'<br>'REL_TO_UPDATED_MWL' || | ||
|- | |- | ||
|WV_ENABLE_WIND || STRING || 'ON'<br>'OFF' || | |WV_ENABLE_WIND || STRING || 'ON'<br>'OFF' || Winds are specified in 'wind.dat' in units of <math>m/sec</math> | ||
|- | |- | ||
|WV_BREAKING_OUTPUT || STRING || 'OFF' or 'NONE'<br>'BREAKING_INDICES'<br>'DISSIPATION_VALUES' || | |WV_BREAKING_OUTPUT || STRING || 'OFF' or 'NONE'<br>'BREAKING_INDICES'<br>'DISSIPATION_VALUES' || |
Revision as of 20:18, 25 October 2021
This format is the newest to be implemented and will be effective as of the release of SMS version 13.2 or CMS2D version 5.2.10 or later. This format mimics the same style as the CMS-Flow parameter file (*.cmcards) and is meant to be much more readable and understandable by end users.
In this format, the first line must have the card 'CMS_WAVE_STD' as the first thing on line 1. The value for the card must be the integer value 2. Remaining cards can come in any order, but must follow some rules depending on the card (which is shown as the first object on each line).
CARD | VALUE TYPE | OPTION LIST | NOTES |
---|---|---|---|
CMS_WAVE_STD | INTEGER | 2 | This should always be a '2' to read in this format. |
WV_PROPAGATION_TYPE | STRING | 'WIND_AND_SPECTRA' 'SPECTRA_ONLY' 'FAST-MODE' 'FAST-MODE_SPECTRA_ONLY' |
|
WV_PLANE_DEFINITION | STRING | ‘HALF-PLANE’ ‘FULL-PLANE’ ‘FULL-PLANE_WITH_REVERSE_SPECTRA’ |
|
WV_MATRIX_SOLVER | STRING | 'GAUSS-SEIDEL' 'ADI' |
|
WV_CURRENT_TYPE | STRING | 'OFF' or 'NONE' 'MULTIPLE' 'SINGLE' |
|
WV_BOUNDARY_NESTING | STRING | 'OFF' or 'NONE' 'LINEAR' 'MORPHIC' |
|
WV_BOTTOM_FRICTION | STRING | 'OFF' or 'NONE' 'CONST_DARCY_WEISBACH' 'VAR_DARCY_WEISBACH' 'CONST_MANNINGS' 'VAR_MANNINGS' |
Constant or variable bottom friction using Darcy Weisbach (c_f) or Mannings (n) |
WV_WETTING_DRYING | STRING | 'ON' 'OFF' 'ON_WITH_SEA-SWELL_FILES' |
|
WV_DIFFRACTION_INTENSITY | REAL | #.### | Range 0.0 <= [value] <= 1.0 |
WV_NUM_THREADS | INTEGER | # | Only used when WV_MATRIX_SOLVER is set to 'GAUSS-SEIDEL' Optimum number is approximately #rows / 300 |
WV_NESTING_CELLS | INTEGER [INT INT ... INT INT] | 0 # # # ... # # |
If 0, nothing else is read If n>0, reads 'n' pairs of I J cell values |
WV_OBSERVATION_CELLS | INTEGER [INT INT ... INT INT] | 0 # # # ... # # |
If 0, nothing else is read If n>0, reads 'n' pairs of I J cell values |
WV_BOTTOM_FRICTION_COEFF | REAL | #.## | Only used if WV_BOTTOM_FRICTION is a 'CONST' type Typical value is 0.005 for c_f and 0.025 for Mannings n. |
WV_FWD_REFLECTION_COEFF | REAL | #.## | Range 0.0 <= [value] <= 1.0 |
WV_BWD_REFLECTION_COEFF | REAL | #.## | Range 0.0 <= [value] <= 1.0 |
WV_BREAKING_FORMULA | STRING | 'EXT_GODA' 'EXT_MICHE' 'BATTJES_JANSSEN_78' 'CHAWLA_KIRBY' 'BATTJES_JANSSEN_07' |
|
WV_SET_GAMMA_BJ78 | REAL | #.## | Range 0.4 <= [value] <= 0.8, Only works with WV_BREAKING_FORMULA = 'BATTJES_JANSSEN_78' |
WV_ENABLE_INFRAGRAVITY | STRING | 'OFF' 'ON' |
|
WV_ENABLE_MUDDY_BED | STRING | 'ON' 'OFF' |
The kinematic viscosity is specified in 'mud.dat' in units of |
WV_ENABLE_NONLINEAR_WAVES | STRING | 'OFF' 'ON' |
|
WV_ENABLE_ROLLER | STRING | 'OFF' 'ON' |
|
WV_ENABLE_RUNUP | STRING | 'OFF' 'REL_TO_ABS_DATUM' 'REL_TO_UPDATED_MWL' |
|
WV_ENABLE_WIND | STRING | 'ON' 'OFF' |
Winds are specified in 'wind.dat' in units of |
WV_BREAKING_OUTPUT | STRING | 'OFF' or 'NONE' 'BREAKING_INDICES' 'DISSIPATION_VALUES' |
|
WV_RAD_STRESS_OUTPUT | STRING | 'OFF' or 'NONE' 'RAD_STRESS_FILE' 'STRESS_SETUP_FILES' |
|
WV_OUTPUT_XMDF | STRING | 'OFF' 'ON' |
|
END_PARAMETERS | [NONE] | [NONE] | Always the last card in the file and never has an option value. |