CMS:CardList:Flow: Difference between revisions

From CIRPwiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
__NOTITLE__
__NOTITLE__
<big>List of Cards used in CMS and Dataset Units</big>
<!--------------------------------Banner across top of page------------------------------>
{|style="width:100%; border-spacing:8px; border:1px solid #ccc"
|style="width:40%; color:#000"|
 
<!----------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>
|}


UNDER CONSTRUCTION
UNDER CONSTRUCTION


= General =
__TOC__
= Card List=
== General ==


{| class="prettytable" cellpadding="1" border="1"
{| class="prettytable" cellpadding="1" border="1"
Line 38: Line 48:
|}
|}


= Geospatial =
== Geospatial ==
{| class="prettytable" cellpadding="1" border="1"
{| class="prettytable" cellpadding="1" border="1"
! Cardname !! Value(s) !! Information
! Cardname !! Value(s) !! Information
Line 64: Line 74:




= Timing =
== Timing ==
{| class="prettytable" cellpadding="1" border="1"
{| class="prettytable" cellpadding="1" border="1"
! Cardname !! Value(s) !! Information
! Cardname !! Value(s) !! Information
Line 82: Line 92:
|}
|}


= Eddy Viscosity =
== Eddy Viscosity ==


= Friction =
== Friction ==


{| class="prettytable" cellpadding="1" border="1"
{| class="prettytable" cellpadding="1" border="1"
Line 123: Line 133:
|}
|}


= Wind/Atmospheric Pressure =
== Wind/Atmospheric Pressure ==
{| class="prettytable" cellpadding="1" border="1"
{| class="prettytable" cellpadding="1" border="1"
! Cardname !! Value(s) !! Information
! Cardname !! Value(s) !! Information
Line 135: Line 145:
|}
|}


= Output =
== Output ==
== Observation Cells ==
=== Observation Cells ===
{| class="prettytable" cellpadding="1" border="1"
{| class="prettytable" cellpadding="1" border="1"
! Cardname !! Value(s) !! Information
! Cardname !! Value(s) !! Information
Line 150: Line 160:
|}
|}


== Save Points ==
=== Save Points ===


== Output Times List ==
=== Output Times List ===


{| class="prettytable" cellpadding="1" border="1"
{| class="prettytable" cellpadding="1" border="1"
Line 195: Line 205:
|}
|}


= Boundary Conditions =
== Boundary Conditions ==
== Boundary Cellstrings ==
=== Boundary Cellstrings ===


{| class="prettytable" cellpadding="1" border="1"
{| class="prettytable" cellpadding="1" border="1"
Line 216: Line 226:




== Tidal Constituents ==
=== Tidal Constituents ===
{| class="prettytable" cellpadding="1" border="1"
{| class="prettytable" cellpadding="1" border="1"
! Cardname !! Value(s) !! Information
! Cardname !! Value(s) !! Information
Line 236: Line 246:
|}
|}


= Sediment Transport =
== Sediment Transport ==
== General Sediment Transport ==
=== General Sediment Transport ===
{| class="prettytable" cellpadding="1" border="1"
{| class="prettytable" cellpadding="1" border="1"
! Cardname !! Value(s) !! Information
! Cardname !! Value(s) !! Information
Line 247: Line 257:
|}
|}


== Hard Bottom ==
=== Hard Bottom ===


{| class="prettytable" cellpadding="1" border="1"
{| class="prettytable" cellpadding="1" border="1"
Line 278: Line 288:
|}
|}


= Coupling Between Flow and Waves (Steering) =
== Coupling Between Flow and Waves (Steering) ==
{| class="prettytable" cellpadding="1" border="1"
{| class="prettytable" cellpadding="1" border="1"
! Cardname !! Value(s) !! Information
! Cardname !! Value(s) !! Information
Line 290: Line 300:
|}
|}


= Numerical Methods =
== Numerical Methods ==
{| class="prettytable" cellpadding="1" border="1"
{| class="prettytable" cellpadding="1" border="1"
! Cardname !! Value(s) !! Information
! Cardname !! Value(s) !! Information
Line 300: Line 310:
|-
|-
||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 =
{| class="prettytable" cellpadding="1" border="1"
! Dataset !! Default Units written to output file
|-
|}
|}


----
----
[[CMS#Documentation_Portal | Documentation Portal]]
[[CMS#Documentation_Portal | Documentation Portal]]

Revision as of 16:04, 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

Documentation Portal

Retrieved from "https://cirpwiki.info/index.php?title=CMS:CardList:Flow&oldid=12280"