CMS:CardList:Flow: Difference between revisions

From CIRPwiki
Jump to navigation Jump to search
mNo edit summary
Line 311: Line 311:
||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 =  
= Dataset Units =  
Line 316: Line 318:
! Dataset !! Default Units written to output file
! Dataset !! Default Units written to output file
|-
|-
|Water Surface Elevation  
|&nbsp;Water Surface Elevation  


|align="center" | <math> m </math>
|align="center" | <math> m </math>
|-
|-
|Current Magnitude  
|&nbsp;Current Magnitude  


|align="center" | <math> m/s </math>
|align="center" | <math> m/s </math>
Line 326: Line 328:
|-
|-


|Current Velocity  
|&nbsp;Current Velocity  


|align="center" | <math> m/s </math>
|align="center" | <math> m/s </math>
Line 332: Line 334:
|-
|-


|Eddy Viscosity  
|&nbsp;Eddy Viscosity  


|align="center" | <math> m^2/s </math>
|align="center" | <math> m^2/s </math>
Line 338: Line 340:
|-
|-


|Sediment Concentration  
|&nbsp;Sediment Concentration  


|align="center" | <math> kg/(m^3) </math>
|align="center" | <math> kg/(m^3) </math>
Line 344: Line 346:
|-
|-


|Sediment Capacity  
|&nbsp;Sediment Capacity  


|align="center" | <math> kg/(m^3) </math>
|align="center" | <math> kg/(m^3) </math>
Line 350: Line 352:
|-
|-


|Total Sediment Transport  
|&nbsp;Total Sediment Transport  


|align="center" | <math> kg/m/s </math>
|align="center" | <math> kg/m/s </math>
Line 356: Line 358:
|-
|-


|Fraction Suspended  
|&nbsp;Fraction Suspended  


|align="center" | <math> 'none' </math>
|align="center" | <math> 'none' </math>
Line 362: Line 364:
|-
|-


|Morphology Depth  
|&nbsp;Morphology Depth  


|align="center" | <math> m </math>
|align="center" | <math> m </math>
Line 368: Line 370:
|-
|-


|Morphology Change  
|&nbsp;Morphology Change  


|align="center" | <math> m </math>
|align="center" | <math> m </math>
Line 374: Line 376:
|-
|-


|Salinity  
|&nbsp;Salinity  


|align="center" | <math> ppt </math>
|align="center" | <math> ppt </math>
Line 380: Line 382:
|-
|-


|Wave Height  
|&nbsp;Wave Height  


|align="center" | <math> m </math>
|align="center" | <math> m </math>
Line 386: Line 388:
|-
|-


|Wave Period  
|&nbsp;Wave Period  


|align="center" | <math> s </math>
|align="center" | <math> s </math>
Line 392: Line 394:
|-
|-


|Wave <Vector>  
|&nbsp;Wave <Vector>  


|align="center" | <math> m </math>
|align="center" | <math> m </math>
Line 398: Line 400:
|-
|-


|Wave Dissipation  
|&nbsp;Wave Dissipation  


|align="center" | <math> 'none' </math>
|align="center" | <math> 'none' </math>
Line 404: Line 406:
|-
|-


|Wave Breaking Index  
|&nbsp;Wave Breaking Index  


|align="center" | <math> 'none' </math>
|align="center" | <math> 'none' </math>
Line 410: Line 412:
|-
|-


|Wave Radiation Stress  
|&nbsp;Wave Radiation Stress  


|align="center" | <math> 'none' </math>
|align="center" | <math> 'none' </math>
Line 416: Line 418:
|-
|-


|Wind Velocity  
|&nbsp;Wind Velocity  


|align="center" | <math> m/s </math>
|align="center" | <math> m/s </math>
Line 422: Line 424:
|-
|-


|Wind Magnitude  
|&nbsp;Wind Magnitude  


|align="center" | <math> m/s </math>
|align="center" | <math> m/s </math>
Line 428: Line 430:
|-
|-


|Wind Stress  
|&nbsp;Wind Stress  


|align="center" | <math> N/(m^2) </math>
|align="center" | <math> N/(m^2) </math>
Line 434: Line 436:
|-
|-


|Wind Stress Magnitude  
|&nbsp;Wind Stress Magnitude  


|align="center" | <math> N/(m^2) </math>
|align="center" | <math> N/(m^2) </math>
Line 440: Line 442:
|-
|-


|Grain Sizes (D50, D90, etc)&nbsp;  
|&nbsp;Grain Sizes (D50, D90, etc)&nbsp;  


|align="center" | <math> mm </math>
|align="center" | <math> mm </math>

Revision as of 16:42, 25 February 2016

__NOTITLE__

List of Cards used in CMS and Dataset Units

UNDER CONSTRUCTION

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 ii ee) i - is replaced by integer from 0 to 4 -- THIS CARD IS NEW IN SMS 11
# is integer - number of bb,ii,ee series
bb is a real number denoting the beginning time of new interval in list
ii is a real number denoting the new interval in the list
ee is a real number denoting the ending time of the new interval in 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

Dataset Default Units written to output file
 Water Surface Elevation m
 Current Magnitude m/s
 Current Velocity m/s
 Eddy Viscosity m2/s
 Sediment Concentration kg/(m3)
 Sediment Capacity kg/(m3)
 Total Sediment Transport kg/m/s
 Fraction Suspended none
 Morphology Depth m
 Morphology Change m
 Salinity ppt
 Wave Height m
 Wave Period s
 Wave <Vector> m
 Wave Dissipation none
 Wave Breaking Index none
 Wave Radiation Stress none
 Wind Velocity m/s
 Wind Magnitude m/s
 Wind Stress N/(m2)
 Wind Stress Magnitude N/(m2)
 Grain Sizes (D50, D90, etc)  mm



Documentation Portal