View source for CMS:CardList:Flow

You do not have permission to edit this page, for the following reason:
The action you have requested is limited to users in the group: CIRP.
You can view and copy the source of this page.
UNDER CONSTRUCTION

= General =

{| class="prettytable" cellpadding="1" border="1"
! 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
|}


{| class="prettytable" cellpadding="1" border="1"
! Cardname !! Value(s) !! Information
|-
|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"|
'''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"|
'''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 =

{| 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"|
'''Transport'''
|-
||CALC_SALINITY   ||        ON <nowiki>|</nowiki> OFF
|-
||CALC_SEDIMENT_TRANSPORT ||  ON <nowiki>|</nowiki> OFF
|-
||WATER_DENSITY        ||    #       ||      a real number - units in kg/m^3
|-
||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"|
'''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 ==

{| class="prettytable" cellpadding="1" border="1"
! Cardname !! Value(s) !! Information
|-
|colspan="3" align="left"|
'''Output Times List'''
|- style="background:firebrick; color:white"
||TIME_SERIES_i      ||      #  (###)  ||    i - is replaced by integer from 0 to 4 -- THIS CARD HAS BEEN REPLACED IN SMS 11
|- style="background:firebrick; color:white"
||                     || ||                  # is integer - number of total times in list
|- style="background:firebrick; color:white"
||                          || ||             ### is a series of real numbers which denote discrete output times
|- style="background:firebrick; color:white"
||                               || ||        each TIME_SERIES_# can be applied to different solution datasets
|- style="background:yellowgreen"
||TIME_LIST_i        ||      # (bb ii ee)||  i - is replaced by integer from 0 to 4  -- THIS CARD IS NEW IN SMS 11
|- style="background:yellowgreen"
||                   || ||                    # is integer - number of bb,ii,ee series
|- style="background:yellowgreen"
||                   || ||                    bb is a real number denoting the beginning time of new interval in list
|- style="background:yellowgreen"
||                   || ||                    ii is a real number denoting the new interval in the list
|- style="background:yellowgreen"
||                   || ||                    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 ==

{| class="prettytable" cellpadding="1" border="1"
! Cardname !! Value(s) !! Information
|-
|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"|
'''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"|
'''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) =
{| class="prettytable" cellpadding="1" border="1"
! Cardname !! Value(s) !! Information
|-
|colspan="3" align="left"|
'''Steering'''
|-
||CMS-WAVE_SIM_FILE   ||        <file>.sim 
|-
||STEERING_INTERVAL   ||        #  || a real number - units in hours
|}

= Numerical Methods =
{| class="prettytable" cellpadding="1" border="1"
! Cardname !! Value(s) !! Information
|-
|colspan="3" align="left"|
'''Implicit Solution Scheme'''
|-
||MATRIX_SOLVER   || GMRES <nowiki>|</nowiki> BICGSTAB <nowiki>|</nowiki> GAUSS-SEIDEL <nowiki>|</nowiki>GAUSS-SEIDEL-SOR
|-
||ADVECTION_SCHEME   ||  NONE <nowiki>|</nowiki> HYBRID <nowiki>|</nowiki> EXPONENTIAL <nowiki>|</nowiki> HLPA 
|}

----
[[CMS#Documentation_Portal | Documentation Portal]]
Return to CMS:CardList:Flow.
Retrieved from "https://cirpwiki.info/wiki/CMS:CardList:Flow"
View source for CMS:CardList:Flow

Navigation menu

Search
