CMS:CardList:Flow: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
(25 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{DISPLAYTITLE:CMS Card List (Flow)}} | |||
<!----------List of Cards used in CMS and Dataset Units----------> | |||
{| style="width:100%; border:solid 0px; background:none;" | |||
|style="width:100%; text-align:left; white-space:nowrap; color:#000;"| | |||
<div style="font-size:162%; border:none; margin:0; padding:0.2em 0.4em; color:#000;">List of Cards used in CMS and Dataset Units</div> | |||
|} | |||
__TOC__ | |||
=Card List= | |||
==General== | |||
{| class="prettytable" cellpadding="1" border="1" | {| class="prettytable" cellpadding="1" border="1" | ||
! Cardname !! Value(s) !! Information | ! Cardname !! Value(s) !! Information | ||
|- | |- | ||
| | || CMS_VERSION || <file>_grid.h5 || Version of CMS Card File | ||
|- | |- | ||
||GRID_FILE || <file>_grid.h5 || | || GRID_FILE || <file>_grid.h5 || CMS-Flow XMDF Grid File | ||
|- | |- | ||
||PARAMS_FILE || <file>_mp.h5 || | || PARAMS_FILE || <file>_mp.h5 || CMS-Flow Model Parameters File | ||
|} | |||
{| class="prettytable" cellpadding="1" border="1" | |||
! Cardname !! Value(s) !! Information | |||
|- | |- | ||
|colspan="3" align="left"| | |colspan="3" align="left"| | ||
''' | '''General Parameters''' | ||
|- | |- | ||
|| | ||USE_ADVECTION_TERMS || ON <nowiki>|</nowiki> OFF || | ||
|- | |||
||USE_MIXING_TERMS || ON <nowiki>|</nowiki> OFF|| | |||
|- | |- | ||
|| | ||USE_WALL_FRICTION_TERMS || ON <nowiki>|</nowiki> OFF|| | ||
|- | |- | ||
|| | ||DRYING_DEPTH || # || a real number - units in meters | ||
|- | |- | ||
|| | ||SIMULATION_LABEL || 'xxx' || string of characters | ||
|- | |- | ||
|| | ||2D_MODE || ON <nowiki>|</nowiki> OFF || | ||
|- | |- | ||
|| | ||NUM_THREADS || # || an integer number | ||
|} | |||
==Geospatial== | |||
{| class="prettytable" cellpadding="1" border="1" | |||
! Cardname !! Value(s) !! Information | |||
|- | |- | ||
|colspan="3" align="left"| | |colspan="3" align="left"| | ||
''' | '''Grid Geometry''' | ||
|- | |||
||GRID_FILE || <file>_grid.h5 || CMS-Flow XMDF Grid File | |||
|- | |- | ||
|| | ||BATHYMETRY_DATASET || %GRID_FILE% <path to 'Depth' dataset>|| | ||
|- | |- | ||
|| | ||GRID_ANGLE || float units || Units optional. Default units are degrees. | ||
|- | |- | ||
|| | ||GRID_ORIGIN_X || float units || Grid origin in x-direction. Units optional. Default units are degrees. | ||
|- | |- | ||
|| | ||GRID_ORIGIN_Y || float units || Grid origin in y-direction. Units optional. Default units are degrees. | ||
|- | |- | ||
|| | ||CELL_LATITUDES || %PARAMS_FILE% <path to 'Lats' dataset> || | ||
|- | |- | ||
|| | ||GRID_CELL_TYPES || <path to 'CellTypes' dataset>|| | ||
|- | |- | ||
|| | ||GRID_MODIFICATION_NUMBER || integeger || an integer number used by the CMS to keep track of changes to the grid | ||
|} | |||
== Timing == | |||
{| class="prettytable" cellpadding="1" border="1" | |||
! Cardname !! Value(s) !! Information | |||
|- | |- | ||
|colspan="3" align="left"| | |colspan="3" align="left"| | ||
Line 55: | Line 82: | ||
|- | |- | ||
||DURATION_RAMP || # || a real number - units in hours | ||DURATION_RAMP || # || a real number - units in hours | ||
|} | |||
== Eddy Viscosity == | |||
== Friction == | |||
{| class="prettytable" cellpadding="1" border="1" | |||
! Cardname !! Value(s) !! Information | |||
|- | |||
|colspan="3" align="left"| | |||
'''Bottom Friction''' | |||
|- | |||
||MANNINGS_N_DATASET || %GRID_FILE% <path to dataset>|| | |||
|- | |||
||MANNINGS_N_CONSTANT || # || a real number | |||
|- | |||
||ROUGHNESS_DATASET || %GRID_FILE% <path to dataset>|| | |||
|- | |||
||ROUGHNESS_CONSTANT || # || a real number | |||
|- | |||
||BOTTOM_FRICTION_DATASET || %GRID_FILE% <path to dataset>|| | |||
|- | |||
||BED_SLOPE_FRICTION_FACTOR || ON <nowiki>|</nowiki> OFF || | |||
|- | |||
||WAVE-CURRENT_MEAN_STRESS || W09 <nowiki>|</nowiki> DATA2 <nowiki>|</nowiki>DATA13 <nowiki>|</nowiki> HT91 <nowiki>|</nowiki> F84 || | |||
|} | |||
{| class="prettytable" cellpadding="1" border="1" | |||
! Cardname !! Value(s) !! Information | |||
|- | |- | ||
|colspan="3" align="left"| | |colspan="3" align="left"| | ||
Line 66: | Line 123: | ||
|- | |- | ||
||WATER_TEMPERATURE || # || a real number - units in degrees celcius | ||WATER_TEMPERATURE || # || a real number - units in degrees celcius | ||
|} | |||
== Wind/Atmospheric Pressure == | |||
{| class="prettytable" cellpadding="1" border="1" | |||
! Cardname !! Value(s) !! Information | |||
|- | |||
|colspan="3" align="left"| | |||
'''Wind''' | |||
|- | |||
||ANEMOMETER_HEIGHT || # || a real number - units in meters above mean water level | |||
|- | |||
||WIND_INPUT_CURVE || %PARAMS_FILE% <path to dataset> | |||
|} | |||
== Output == | |||
=== Observation Cells === | |||
{| class="prettytable" cellpadding="1" border="1" | |||
! Cardname !! Value(s) !! Information | |||
|- | |- | ||
|colspan="3" align="left"| | |colspan="3" align="left"| | ||
Line 75: | Line 150: | ||
|- | |- | ||
||Q_TRANS_RATE_INCREMENT || # || an integer number - units in seconds | ||Q_TRANS_RATE_INCREMENT || # || an integer number - units in seconds | ||
| | |} | ||
| | |||
=== Save Points === | |||
=== Output Times List === | |||
{| class="prettytable" cellpadding="1" border="1" | |||
! Cardname !! Value(s) !! Information | |||
|- | |- | ||
|colspan="3" align="left"| | |colspan="3" align="left"| | ||
Line 102: | Line 170: | ||
|| || || each TIME_SERIES_# can be applied to different solution datasets | || || || each TIME_SERIES_# can be applied to different solution datasets | ||
|- style="background:yellowgreen" | |- style="background:yellowgreen" | ||
||TIME_LIST_i || # (bb ii | ||TIME_LIST_i || # (bb ee ii)|| i - is replaced by integer from 0 to 4 -- THIS CARD IS NEW IN SMS 11 | ||
|- style="background:yellowgreen" | |||
|| || || # is integer - number of bb,ee,ii series | |||
|- style="background:yellowgreen" | |- style="background:yellowgreen" | ||
|| || || | || || || bb is a real number denoting the beginning time of new range in list | ||
|- style="background:yellowgreen" | |- style="background:yellowgreen" | ||
|| || || | || || || ee is a real number denoting the ending time of the new range in list | ||
|- style="background:yellowgreen" | |- style="background:yellowgreen" | ||
|| || || ii is a real number denoting the new interval in the list | || || || ii is a real number denoting the new interval in the list | ||
|- | |- | ||
||WSE_OUT_TIMES_LIST || # || an integer number | ||WSE_OUT_TIMES_LIST || # || an integer number | ||
Line 127: | Line 195: | ||
|- | |- | ||
||BED_SHEAR_STRESS_OUT_TIMES_LIST || # || an integer number | ||BED_SHEAR_STRESS_OUT_TIMES_LIST || # || an integer number | ||
|} | |||
== Boundary Conditions == | |||
=== Boundary Cellstrings === | |||
{| class="prettytable" cellpadding="1" border="1" | |||
! Cardname !! Value(s) !! Information | |||
|- | |- | ||
|colspan="3" align="left"| | |colspan="3" align="left"| | ||
''' | '''Cellstrings''' | ||
|- | |- | ||
|| | ||TIDAL_CELLSTRING || %PARAMS_FILE% <path to cellstring> | ||
|- | |- | ||
|| | ||QDRIVER_CELLSTRING || %PARAMS_FILE% <path to cellstring> | ||
|- | |- | ||
| | ||HDRIVER_CELLSTRING || %PARAMS_FILE% <path to cellstring> | ||
|- | |- | ||
|| | ||MHDRIVER_CELLSTRING || %PARAMS_FILE% <path to cellstring> | ||
|- | |- | ||
|| | ||CROSS-SHORE_CELLSTRING || %PARAMS_FILE% <path to cellstring> | ||
|} | |||
=== Tidal Constituents === | |||
{| class="prettytable" cellpadding="1" border="1" | |||
! Cardname !! Value(s) !! Information | |||
|- | |- | ||
|| | |colspan="3" align="left"| | ||
'''Tidal Constituents''' | |||
|- | |- | ||
|| | ||TIDAL_CONSTITUENTS_BEGIN || || denotes beginning of a list of constituents, one per line | ||
|- | |- | ||
|| | ||TIDAL_CONSTITUENT_xx || # # || tidal constituent - xx replaced with component name - such as M2 | ||
|- | |- | ||
|| | || || || first number is a real number denoting amplitude - units in meters | ||
|- | |- | ||
|| | || || || second number is a real number denoting phase - units in degrees | ||
|- | |- | ||
| | || || || CARD can be repeated up to 37 times without duplication of component name. | ||
|- | |- | ||
|| | ||TIDAL_CONSTITUENTS_END || || denotes end of the constituent list | ||
|} | |||
== Sediment Transport == | |||
=== General Sediment Transport === | |||
{| class="prettytable" cellpadding="1" border="1" | |||
! Cardname !! Value(s) !! Information | |||
|- | |- | ||
|| | |colspan="3" align="left"| | ||
'''General Sediment Transport''' | |||
|- | |- | ||
|| | ||CALC_SEDIMENT_TRANSPORT || ON <nowiki>|</nowiki> OFF | ||
| | |} | ||
| | === Hard Bottom === | ||
| | |||
{| class="prettytable" cellpadding="1" border="1" | |||
! Cardname !! Value(s) !! Information | |||
|- | |- | ||
|colspan="3" align="left"| | |colspan="3" align="left"| | ||
''' | '''User-defined cell-specific datasets''' | ||
|- | |- | ||
|| | ||HARDBOTTOM_DATASET || %GRID_FILE% <path to dataset>|| | ||
|} | |||
|| | |||
{| class="prettytable" cellpadding="1" border="1" | |||
! Cardname !! Value(s) !! Information | |||
|- | |- | ||
|colspan="3" align="left"| | |colspan="3" align="left"| | ||
Line 186: | Line 278: | ||
|- | |- | ||
||GLBL_CONC_CAPAC_OUTPUT || <path to dataset> | ||GLBL_CONC_CAPAC_OUTPUT || <path to dataset> | ||
|} | |||
== Coupling Between Flow and Waves (Steering) == | |||
{| class="prettytable" cellpadding="1" border="1" | |||
! Cardname !! Value(s) !! Information | |||
|- | |- | ||
|colspan="3" align="left"| | |colspan="3" align="left"| | ||
''' | '''Steering''' | ||
|- | |- | ||
||CMS-WAVE_SIM_FILE || <file>.sim | ||CMS-WAVE_SIM_FILE || <file>.sim | ||
|- | |- | ||
||STEERING_INTERVAL || # || a real number - units in hours | ||STEERING_INTERVAL || # || a real number - units in hours | ||
|} | |||
== Numerical Methods == | |||
{| class="prettytable" cellpadding="1" border="1" | |||
! Cardname !! Value(s) !! Information | |||
|- | |- | ||
|colspan="3" align="left"| | |colspan="3" align="left"| | ||
Line 201: | Line 303: | ||
||ADVECTION_SCHEME || NONE <nowiki>|</nowiki> HYBRID <nowiki>|</nowiki> EXPONENTIAL <nowiki>|</nowiki> HLPA | ||ADVECTION_SCHEME || NONE <nowiki>|</nowiki> HYBRID <nowiki>|</nowiki> EXPONENTIAL <nowiki>|</nowiki> HLPA | ||
|} | |} | ||
= Dataset Units = | |||
This list is up to date as of February 2016 and is applicable to CMS versions 4.1 and above. | |||
{| class="prettytable" cellpadding="1" border="3" | |||
! Dataset !! Default Units written to output file | |||
|- | |||
| Water Surface Elevation | |||
|align="center" | <math> m </math> | |||
|- | |||
| Current Magnitude | |||
|align="center" | <math> m/s </math> | |||
|- | |||
| Current Velocity | |||
|align="center" | <math> m/s </math> | |||
|- | |||
| Eddy Viscosity | |||
|align="center" | <math> m^2/s </math> | |||
|- | |||
| Sediment Concentration | |||
|align="center" | <math> kg/ m^3 </math> | |||
|- | |||
| Sediment Capacity | |||
|align="center" | <math> kg/ m^3 </math> | |||
|- | |||
| Total Sediment Transport | |||
|align="center" | <math> kg/m/s </math> | |||
|- | |||
| Fraction Suspended | |||
|align="center" | <math> -- </math> | |||
|- | |||
| Morphology Depth | |||
|align="center" | <math> m </math> | |||
|- | |||
| Morphology Change | |||
|align="center" | <math> m </math> | |||
|- | |||
| Salinity | |||
|align="center" | <math> ppt </math> | |||
|- | |||
| Wave Height | |||
|align="center" | <math> m </math> | |||
|- | |||
| Wave Height <Vector> | |||
|align="center" | <math> m </math> | |||
|- | |||
| Wave Period | |||
|align="center" | <math> s </math> | |||
|- | |||
| Wave Dissipation | |||
|align="center" | <math> m^2/s^2 </math> | |||
|- | |||
| Wave Breaking Index | |||
|align="center" | <math> -- </math> | |||
|- | |||
| Wave Radiation Stress | |||
|align="center" | <math> N/m^2 </math> | |||
|- | |||
| Wind Velocity | |||
|align="center" | <math> m/s </math> | |||
|- | |||
| Wind Magnitude | |||
|align="center" | <math> m/s </math> | |||
|- | |||
| Wind Stress | |||
|align="center" | <math> N/ m^2 </math> | |||
|- | |||
| Wind Stress Magnitude | |||
|align="center" | <math> N/ m^2 </math> | |||
|- | |||
| Grain Sizes (D50, D90, etc) | |||
|align="center" | <math> mm </math> | |||
|} | |||
---- | ---- | ||
[[CMS#Documentation_Portal | Documentation Portal]] | [[CMS#Documentation_Portal | Documentation Portal]] |
Latest revision as of 20:54, 25 August 2020
List of Cards used in CMS and Dataset Units
|
Card List
General
Cardname | Value(s) | Information |
---|---|---|
CMS_VERSION | <file>_grid.h5 | Version of CMS Card File |
GRID_FILE | <file>_grid.h5 | CMS-Flow XMDF Grid File |
PARAMS_FILE | <file>_mp.h5 | CMS-Flow Model Parameters File |
Cardname | Value(s) | Information |
---|---|---|
General Parameters | ||
USE_ADVECTION_TERMS | ON | OFF | |
USE_MIXING_TERMS | ON | OFF | |
USE_WALL_FRICTION_TERMS | ON | OFF | |
DRYING_DEPTH | # | a real number - units in meters |
SIMULATION_LABEL | 'xxx' | string of characters |
2D_MODE | ON | OFF | |
NUM_THREADS | # | an integer number |
Geospatial
Cardname | Value(s) | Information |
---|---|---|
Grid Geometry | ||
GRID_FILE | <file>_grid.h5 | CMS-Flow XMDF Grid File |
BATHYMETRY_DATASET | %GRID_FILE% <path to 'Depth' dataset> | |
GRID_ANGLE | float units | Units optional. Default units are degrees. |
GRID_ORIGIN_X | float units | Grid origin in x-direction. Units optional. Default units are degrees. |
GRID_ORIGIN_Y | float units | Grid origin in y-direction. Units optional. Default units are degrees. |
CELL_LATITUDES | %PARAMS_FILE% <path to 'Lats' dataset> | |
GRID_CELL_TYPES | <path to 'CellTypes' dataset> | |
GRID_MODIFICATION_NUMBER | integeger | an integer number used by the CMS to keep track of changes to the grid |
Timing
Cardname | Value(s) | Information |
---|---|---|
Timing | ||
HYDRO_TIMESTEP | # | a real number - units in seconds |
STARTING_JDATE | ##### | a 5-digit integer number representing YY and MMM |
STARTING_JDATE_HOUR | # | an integer number representing the starting hour. |
DURATION_RUN | # | a real number - units in hours |
DURATION_RAMP | # | a real number - units in hours |
Eddy Viscosity
Friction
Cardname | Value(s) | Information |
---|---|---|
Bottom Friction | ||
MANNINGS_N_DATASET | %GRID_FILE% <path to dataset> | |
MANNINGS_N_CONSTANT | # | a real number |
ROUGHNESS_DATASET | %GRID_FILE% <path to dataset> | |
ROUGHNESS_CONSTANT | # | a real number |
BOTTOM_FRICTION_DATASET | %GRID_FILE% <path to dataset> | |
BED_SLOPE_FRICTION_FACTOR | ON | OFF | |
WAVE-CURRENT_MEAN_STRESS | W09 | DATA2 |DATA13 | HT91 | F84 |
Cardname | Value(s) | Information |
---|---|---|
Transport | ||
CALC_SALINITY | ON | OFF | |
CALC_SEDIMENT_TRANSPORT | ON | OFF | |
WATER_DENSITY | # | a real number - units in kg/m^3 |
WATER_TEMPERATURE | # | a real number - units in degrees celcius |
Wind/Atmospheric Pressure
Cardname | Value(s) | Information |
---|---|---|
Wind | ||
ANEMOMETER_HEIGHT | # | a real number - units in meters above mean water level |
WIND_INPUT_CURVE | %PARAMS_FILE% <path to dataset> |
Output
Observation Cells
Cardname | Value(s) | Information |
---|---|---|
Observation Cells | ||
TIME_SERIES_INCREMENT | # | an integer number - units in seconds |
FLOW_RATE_INCREMENT | # | an integer number - units in seconds |
Q_TRANS_RATE_INCREMENT | # | an integer number - units in seconds |
Save Points
Output Times List
Cardname | Value(s) | Information |
---|---|---|
Output Times List | ||
TIME_SERIES_i | # (###) | i - is replaced by integer from 0 to 4 -- THIS CARD HAS BEEN REPLACED IN SMS 11 |
# is integer - number of total times in list | ||
### is a series of real numbers which denote discrete output times | ||
each TIME_SERIES_# can be applied to different solution datasets | ||
TIME_LIST_i | # (bb ee ii) | i - is replaced by integer from 0 to 4 -- THIS CARD IS NEW IN SMS 11 |
# is integer - number of bb,ee,ii series | ||
bb is a real number denoting the beginning time of new range in list | ||
ee is a real number denoting the ending time of the new range in list | ||
ii is a real number denoting the new interval in the list | ||
WSE_OUT_TIMES_LIST | # | an integer number |
VEL_OUT_TIMES_LIST | # | an integer number |
MORPH_OUT_TIMES_LIST | # | an integer number |
TRANS_OUT_TIMES_LIST | # | an integer number |
WAVES_OUT_TIMES_LIST | # | an integer number |
EDDY_VISCOSITY_OUT_TIMES_LIST | # | an integer number |
VISC_OUT_TIMES_LIST | # | an integer number |
BED_SHEAR_STRESS_OUT_TIMES_LIST | # | an integer number |
Boundary Conditions
Boundary Cellstrings
Cardname | Value(s) | Information |
---|---|---|
Cellstrings | ||
TIDAL_CELLSTRING | %PARAMS_FILE% <path to cellstring> | |
QDRIVER_CELLSTRING | %PARAMS_FILE% <path to cellstring> | |
HDRIVER_CELLSTRING | %PARAMS_FILE% <path to cellstring> | |
MHDRIVER_CELLSTRING | %PARAMS_FILE% <path to cellstring> | |
CROSS-SHORE_CELLSTRING | %PARAMS_FILE% <path to cellstring> |
Tidal Constituents
Cardname | Value(s) | Information |
---|---|---|
Tidal Constituents | ||
TIDAL_CONSTITUENTS_BEGIN | denotes beginning of a list of constituents, one per line | |
TIDAL_CONSTITUENT_xx | # # | tidal constituent - xx replaced with component name - such as M2 |
first number is a real number denoting amplitude - units in meters | ||
second number is a real number denoting phase - units in degrees | ||
CARD can be repeated up to 37 times without duplication of component name. | ||
TIDAL_CONSTITUENTS_END | denotes end of the constituent list |
Sediment Transport
General Sediment Transport
Cardname | Value(s) | Information |
---|---|---|
General Sediment Transport | ||
CALC_SEDIMENT_TRANSPORT | ON | OFF |
Hard Bottom
Cardname | Value(s) | Information |
---|---|---|
User-defined cell-specific datasets | ||
HARDBOTTOM_DATASET | %GRID_FILE% <path to dataset> |
Cardname | Value(s) | Information |
---|---|---|
Output | ||
GLOBAL_VELOCITY_OUTPUT | <file>_sol.h5 <path to dataset> | |
GLOBAL_WATER_LEVEL_OUTPUT | <file>_sol.h5 <path to dataset> | |
GLOBAL_MORPHOLOGY_OUTPUT | <file>_sol.h5 <path to dataset> | |
GLOBAL_TRANS_RATE_OUTPUT | <file>_sol.h5 <path to dataset> | |
GLBL_CONCENTRATION_OUTPUT | <path to dataset> | |
GLBL_CONC_CAPAC_OUTPUT | <path to dataset> |
Coupling Between Flow and Waves (Steering)
Cardname | Value(s) | Information |
---|---|---|
Steering | ||
CMS-WAVE_SIM_FILE | <file>.sim | |
STEERING_INTERVAL | # | a real number - units in hours |
Numerical Methods
Cardname | Value(s) | Information |
---|---|---|
Implicit Solution Scheme | ||
MATRIX_SOLVER | GMRES | BICGSTAB | GAUSS-SEIDEL |GAUSS-SEIDEL-SOR | |
ADVECTION_SCHEME | NONE | HYBRID | EXPONENTIAL | HLPA |
Dataset Units
This list is up to date as of February 2016 and is applicable to CMS versions 4.1 and above.
Dataset | Default Units written to output file |
---|---|
Water Surface Elevation | |
Current Magnitude | |
Current Velocity | |
Eddy Viscosity | |
Sediment Concentration | |
Sediment Capacity | |
Total Sediment Transport | |
Fraction Suspended | |
Morphology Depth | |
Morphology Change | |
Salinity | |
Wave Height | |
Wave Height <Vector> | |
Wave Period | |
Wave Dissipation | |
Wave Breaking Index | |
Wave Radiation Stress | |
Wind Velocity | |
Wind Magnitude | |
Wind Stress | |
Wind Stress Magnitude | |
Grain Sizes (D50, D90, etc) |