Wave CardFormat2: Difference between revisions

From CIRPwiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(15 intermediate revisions by the same user not shown)
Line 4: Line 4:


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).
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).
Option that is '''Bolded''' is the default.




{| class="wikitable"
{| class="wikitable"
|+ Caption text
|-
|-
! CARD !! VALUE TYPE !! OPTION LIST !! NOTES
! CARD !! VALUE TYPE !! OPTION LIST !! NOTES
|-
|-
|CMS_WAVE_STD || INTEGER || 2 || This should always be a '2' to read in this format.
|CMS_WAVE_STD || INTEGER || '''2''' || This should always be a '2' to read in this format.
|-
|-
|WV_PROPAGATION_TYPE || STRING || 'WIND_AND_SPECTRA'<br>'SPECTRA_ONLY'<br>'FAST-MODE'<br>'FAST-MODE_SPECTRA_ONLY' ||  
|WV_PROPAGATION_TYPE || STRING || '''"WIND_AND_SPECTRA"'''<br>"SPECTRA_ONLY"<br>"FAST-MODE"<br>"FAST-MODE_SPECTRA_ONLY" ||  
|-
|-
|WV_PLANE_DEFINITION || STRING || ‘HALF-PLANE’<br>‘FULL-PLANE’<br>‘FULL-PLANE_WITH_REVERSE_SPECTRA’ ||
|WV_PLANE_DEFINITION || STRING || '''"HALF-PLANE"'''<br>"FULL-PLANE"<br>"FULL-PLANE_WITH_REVERSE_SPECTRA" || Spectral input file is '<project>.spec' (or .eng).<br><br>
|-
|-
|WV_MATRIX_SOLVER || STRING || 'GAUSS-SEIDEL'<br>'ADI' ||
|WV_MATRIX_SOLVER || STRING || '''"GAUSS-SEIDEL"'''<br>"ADI" ||
|-
|-
|WV_CURRENT_TYPE || STRING     || 'OFF' or 'NONE'<br>'MULTIPLE'<br>'SINGLE' ||
|WV_CURRENT_TYPE || STRING || '''"OFF"'''<br>"MULTIPLE"<br>"SINGLE" ||Current values will be in '<project>.cur' file.
|-
|-
|WV_BOUNDARY_NESTING || STRING || 'OFF' or 'NONE'<br>'LINEAR'<br>'MORPHIC' ||
|WV_BOUNDARY_NESTING || STRING || '''"OFF"'''<br>"AVERAGE_SPECTRA"<br>"INVERSE_DISTANCE" ||
|-
|-
|WV_BOTTOM_FRICTION || STRING  || 'OFF' or 'NONE'<br>'CONSTANT_DARCY_WEISBACH'<br>'VARIABLE_DARCY_WEISBACH'<br>'CONSTANT_MANNINGS'<br>'VARIABLE_MANNINGS' || If CONSTANT, use WV_BOTTOM_FRICTION_COEFF card also<br><br>If VARIABLE, values will be in '<project>.fric' file.
|WV_BOTTOM_FRICTION || STRING  || '''"OFF"'''<br>"CONSTANT_DARCY_WEISBACH"<br>"VARIABLE_DARCY_WEISBACH"<br>"CONSTANT_MANNINGS"<br>"VARIABLE_MANNINGS" || If CONSTANT, use WV_BOTTOM_FRICTION_COEFF card also<br><br>If VARIABLE, values will be in '<project>.fric' file.
|-
|-
|WV_FWD_REFLECTION || STRING || 'OFF'<br>'CONSTANT'<br>'VARIABLE' || If CONSTANT, use WV_FWD_REFLECTION_COEFF card also<br><br>If VARIABLE, values will be in '<project>.fref' file.
|WV_FWD_REFLECTION || STRING || '''"OFF"'''<br>"CONSTANT"<br>"VARIABLE" || If CONSTANT, use WV_FWD_REFLECTION_COEFF card also<br><br>If VARIABLE, values will be in '<project>.fref' file.
|-
|-
|WV_BWD_REFLECTION || STRING || 'OFF'<br>'CONSTANT'<br>'VARIABLE' || If CONSTANT, use WV_BWD_REFLECTION_COEFF card also<br><br>If VARIABLE, values will be in '<project>.bref' file.
|WV_BWD_REFLECTION || STRING || '''"OFF"'''<br>"CONSTANT"<br>"VARIABLE" || If CONSTANT, use WV_BWD_REFLECTION_COEFF card also<br><br>If VARIABLE, values will be in '<project>.bref' file.
|-
|-
|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" ||
|-
|-
|WV_DIFFRACTION_INTENSITY || REAL || #.### || Range 0.0 <= [value] <= 1.0
|WV_DIFFRACTION_INTENSITY || REAL || #.### || Range 0.0 <= [value] <= 4.0
|-
|-
|WV_NUM_THREADS || INTEGER || # || Only used when WV_MATRIX_SOLVER is set to 'GAUSS-SEIDEL'<br><br>Optimum number is approximately #rows / 300
|WV_NUM_THREADS || INTEGER || # || Only used when WV_MATRIX_SOLVER is set to 'GAUSS-SEIDEL'<br><br>Optimum number is approximately #rows / 300
Line 38: Line 39:
|-
|-
|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_LIMIT_OBSERVATION_OUTPUT || STRING || '''"OFF"'''<br>"ON" || ON turns off all output for observation cells except information in SELHT file.
|-
|-
|WV_BOTTOM_FRICTION_COEFF || REAL || #.## || Only used if WV_BOTTOM_FRICTION is a 'CONST' type<br><br>Typical value is 0.005 for c_f and 0.025 for Mannings n.
|WV_BOTTOM_FRICTION_COEFF || REAL || #.## || Only used if WV_BOTTOM_FRICTION is a 'CONST' type<br><br>Typical value is 0.005 for c_f and 0.025 for Mannings n.
Line 45: Line 48:
|WV_BWD_REFLECTION_COEFF || REAL || #.## || Only used if WV_BWD_REFLECTION is a 'CONST' type<br><br>Range 0.0 <= [value] <= 1.0
|WV_BWD_REFLECTION_COEFF || REAL || #.## || Only used if WV_BWD_REFLECTION is a 'CONST' type<br><br>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"<br>"MICHE_ORIGINAL"<br>"LIFTING_BREAKING" ||
|-
|-
|WV_SET_GAMMA_BJ78 || REAL || #.## || Range 0.4 <= [value] <= 0.8<br><br>Only works with WV_BREAKING_FORMULA = 'BATTJES_JANSSEN_78' and is Optional
|WV_SET_GAMMA_BJ78 || REAL || #.## || Range 0.4 <= [value] <= 0.8<br><br>Only works with WV_BREAKING_FORMULA = 'BATTJES_JANSSEN_78' and is Optional
|-
|-
|WV_ENABLE_INFRAGRAVITY || STRING || 'OFF'<br>'ON' ||
|WV_ROLLER_EFFECT || STRING || '''"OFF"'''<br>"25_PERCENT"<br>"50_PERCENT"<br>"75_PERCENT"<br>"100_PERCENT" || Percent effect of wave roller.  Applied to cells with spacing <= 10m.
|-
|-
|WV_ENABLE_MUDDY_BED    || STRING || 'ON'<br>'OFF' || The kinematic viscosity is specified in '<project>.mud' in units of <math>m^2/sec</math>
|WV_ENABLE_INFRAGRAVITY || STRING || '''"OFF"'''<br>"ON" ||
|-
|-
|WV_ENABLE_NONLINEAR_WAVES || STRING || 'OFF'<br>'ON' ||
|WV_ENABLE_MUDDY_BED    || STRING || '''"ON"'''<br>"OFF" || The kinematic viscosity is specified in '<project>.mud' in units of <math>m^2/sec</math>
|-
|-
|WV_ENABLE_ROLLER || STRING || 'OFF'<br>'ON' ||
|WV_ENABLE_NONLINEAR_WAVES || STRING || '''"OFF"'''<br>"ON" ||
|-
|-
|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' || Winds are specified in '<project>.wind' in units of <math>m/sec</math>
|WV_ENABLE_WIND || STRING || '''"ON"'''<br>"OFF"<br>"ON-LIMIT_WAVE_INFLATION" || Winds are specified in '<project>.wind' in units of <math>m/sec</math><br><br>Limited wave inflation option for winds >= 50m/sec
|-
|-
|WV_BREAKING_OUTPUT || STRING || 'OFF' or 'NONE'<br>'BREAKING_INDICES'<br>'DISSIPATION_VALUES' ||
|WV_BREAKING_OUTPUT || STRING || '''"OFF"'''<br>"BREAKING_INDICES"<br>"DISSIPATION_VALUES" ||
|-
|-
|WV_RAD_STRESS_OUTPUT || STRING || 'OFF' or 'NONE'<br>'RAD_STRESS_FILE'<br>'STRESS_SETUP_FILES' ||
|WV_RAD_STRESS_OUTPUT || STRING || '''"OFF"'''<br>"RAD_STRESS_FILE"<br>"STRESS_SETUP_FILES" ||
|-
|-
|WV_OUTPUT_XMDF || STRING || 'OFF'<br>'ON' ||
|WV_OUTPUT_XMDF || STRING || '''"OFF"'''<br>"ON" ||
|-
|-
|END_PARAMETERS || [NONE] || [NONE] || Always the last card in the file and never has an option value.
|END_PARAMETERS || [NONE] || [NONE] || Always the last card in the file and never has an option value.

Latest revision as of 16:13, 1 November 2022

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).

Option that is Bolded is the default.


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"
Spectral input file is '<project>.spec' (or .eng).

WV_MATRIX_SOLVER STRING "GAUSS-SEIDEL"
"ADI"
WV_CURRENT_TYPE STRING "OFF"
"MULTIPLE"
"SINGLE"
Current values will be in '<project>.cur' file.
WV_BOUNDARY_NESTING STRING "OFF"
"AVERAGE_SPECTRA"
"INVERSE_DISTANCE"
WV_BOTTOM_FRICTION STRING "OFF"
"CONSTANT_DARCY_WEISBACH"
"VARIABLE_DARCY_WEISBACH"
"CONSTANT_MANNINGS"
"VARIABLE_MANNINGS"
If CONSTANT, use WV_BOTTOM_FRICTION_COEFF card also

If VARIABLE, values will be in '<project>.fric' file.
WV_FWD_REFLECTION STRING "OFF"
"CONSTANT"
"VARIABLE"
If CONSTANT, use WV_FWD_REFLECTION_COEFF card also

If VARIABLE, values will be in '<project>.fref' file.
WV_BWD_REFLECTION STRING "OFF"
"CONSTANT"
"VARIABLE"
If CONSTANT, use WV_BWD_REFLECTION_COEFF card also

If VARIABLE, values will be in '<project>.bref' file.
WV_WETTING_DRYING STRING "ON"
"OFF"
"ON_WITH_SEA-SWELL_FILES"
WV_DIFFRACTION_INTENSITY REAL #.### Range 0.0 <= [value] <= 4.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_LIMIT_OBSERVATION_OUTPUT STRING "OFF"
"ON"
ON turns off all output for observation cells except information in SELHT file.
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 #.## Only used if WV_FWD_REFLECTION is a 'CONST' type

Range 0.0 <= [value] <= 1.0
WV_BWD_REFLECTION_COEFF REAL #.## Only used if WV_BWD_REFLECTION is a 'CONST' type

Range 0.0 <= [value] <= 1.0
WV_BREAKING_FORMULA STRING "EXT_GODA"
"EXT_MICHE"
"BATTJES_JANSSEN_78"
"CHAWLA_KIRBY"
"BATTJES_JANSSEN_07"
"MICHE_ORIGINAL"
"LIFTING_BREAKING"
WV_SET_GAMMA_BJ78 REAL #.## Range 0.4 <= [value] <= 0.8

Only works with WV_BREAKING_FORMULA = 'BATTJES_JANSSEN_78' and is Optional
WV_ROLLER_EFFECT STRING "OFF"
"25_PERCENT"
"50_PERCENT"
"75_PERCENT"
"100_PERCENT"
Percent effect of wave roller. Applied to cells with spacing <= 10m.
WV_ENABLE_INFRAGRAVITY STRING "OFF"
"ON"
WV_ENABLE_MUDDY_BED STRING "ON"
"OFF"
The kinematic viscosity is specified in '<project>.mud' in units of
WV_ENABLE_NONLINEAR_WAVES STRING "OFF"
"ON"
WV_ENABLE_RUNUP STRING "OFF"
"REL_TO_ABS_DATUM"
"REL_TO_UPDATED_MWL"
WV_ENABLE_WIND STRING "ON"
"OFF"
"ON-LIMIT_WAVE_INFLATION"
Winds are specified in '<project>.wind' in units of

Limited wave inflation option for winds >= 50m/sec
WV_BREAKING_OUTPUT STRING "OFF"
"BREAKING_INDICES"
"DISSIPATION_VALUES"
WV_RAD_STRESS_OUTPUT STRING "OFF"
"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.



Go Back to Model Parameters