Latest revision as of 20:54, 25 August 2020

List of Cards used in CMS and Dataset Units

Card List

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

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

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

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>

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

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

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>

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

Cardname	Value(s)	Information
General Sediment Transport
CALC_SEDIMENT_TRANSPORT	ON \| OFF

Cardname	Value(s)	Information
User-defined cell-specific datasets
HARDBOTTOM_DATASET	%GRID_FILE% <path to dataset>

Cardname	Value(s)	Information
Implicit Solution Scheme
MATRIX_SOLVER	GMRES \| BICGSTAB \| GAUSS-SEIDEL \|GAUSS-SEIDEL-SOR
ADVECTION_SCHEME	NONE \| HYBRID \| EXPONENTIAL \| HLPA

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	$m$
Current Magnitude	$m/s$
Current Velocity	$m/s$
Eddy Viscosity	$m^{2}/s$
Sediment Concentration	$kg/m^{3}$
Sediment Capacity	$kg/m^{3}$
Total Sediment Transport	$kg/m/s$
Fraction Suspended	$--$
Morphology Depth	$m$
Morphology Change	$m$
Salinity	$ppt$
Wave Height	$m$
Wave Height <Vector>	$m$
Wave Period	$s$
Wave Dissipation	$m^{2}/s^{2}$
Wave Breaking Index	$--$
Wave Radiation Stress	$N/m^{2}$
Wind Velocity	$m/s$
Wind Magnitude	$m/s$
Wind Stress	$N/m^{2}$
Wind Stress Magnitude	$N/m^{2}$
Grain Sizes (D50, D90, etc)	$mm$