CMS:CardList:Flow: Difference between revisions

From CIRPwiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 6: Line 6:
! Cardname !! Value(s) !! Information
! Cardname !! Value(s) !! Information
|-
|-
|colspan="3" align="left"|'''Model Files'''
|colspan="3" align="left"|
'''Model Files'''  
|-
|-
||GRID_FILE  || <file>_grid.h5 ||  
||GRID_FILE  || <file>_grid.h5 ||  
Line 12: Line 13:
||PARAMS_FILE || <file>_mp.h5  ||
||PARAMS_FILE || <file>_mp.h5  ||
|-
|-
|colspan="3" align="left"|'''Grid Geometry''' ||
|colspan="3" align="left"|
'''Grid Geometry'''  
|-
|-
||BATHYMETRY_DATASET  || %GRID_FILE%  <path to 'Depth' dataset>||
||BATHYMETRY_DATASET  || %GRID_FILE%  <path to 'Depth' dataset>||
Line 26: Line 28:
||GRID_CELL_TYPES    || <path to 'CellTypes' dataset>||
||GRID_CELL_TYPES    || <path to 'CellTypes' dataset>||
|-
|-
|colspan="3" align="left"|'''General Parameters''' ||
|colspan="3" align="left"|
'''General Parameters'''  
|-
|-
||USE_ADVECTION_TERMS    || 'ON' or 'OFF'||
||USE_ADVECTION_TERMS    || 'ON' or 'OFF'||
Line 42: Line 45:
||NUM_THREADS        ||    #            ||  an integer number
||NUM_THREADS        ||    #            ||  an integer number
|-
|-
|colspan="3" align="left"|'''Timing'''||
|colspan="3" align="left"|
'''Timing'''
|-
|-
||HYDRO_TIMESTEP        ||  #      ||      a real number - units in seconds
||HYDRO_TIMESTEP        ||  #      ||      a real number - units in seconds
Line 54: Line 58:
||DURATION_RAMP        ||  #      ||      a real number - units in hours
||DURATION_RAMP        ||  #      ||      a real number - units in hours
|-
|-
|colspan="3" align="left"|'''Transport'''||
|colspan="3" align="left"|
'''Transport'''
|-
|-
||CALC_SALINITY  ||        'ON' or 'OFF'
||CALC_SALINITY  ||        'ON' or 'OFF'
Line 64: Line 69:
||WATER_TEMPERATURE    ||    #      ||      a real number - units in degrees celcius
||WATER_TEMPERATURE    ||    #      ||      a real number - units in degrees celcius
|-
|-
|colspan="3" align="left"|'''Observation Cells'''||
|colspan="3" align="left"|
'''Observation Cells'''
|-
|-
||TIME_SERIES_INCREMENT ||  #      ||      an integer number - units in seconds
||TIME_SERIES_INCREMENT ||  #      ||      an integer number - units in seconds
Line 72: Line 78:
||Q_TRANS_RATE_INCREMENT ||  #      ||      an integer number - units in seconds
||Q_TRANS_RATE_INCREMENT ||  #      ||      an integer number - units in seconds
|-
|-
|colspan="3" align="left"|'''Tidal Constituents'''||
|colspan="3" align="left"|
'''Tidal Constituents'''
|-
|-
||TIDAL_CONSTITUENTS_BEGIN  || ||            denotes beginning of a list of constituents, one per line
||TIDAL_CONSTITUENTS_BEGIN  || ||            denotes beginning of a list of constituents, one per line
Line 86: Line 93:
||TIDAL_CONSTITUENTS_END    || ||            denotes end of the constituent list
||TIDAL_CONSTITUENTS_END    || ||            denotes end of the constituent list
|-
|-
|colspan="3" align="left"|'''Output Times List'''||
|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
||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
||                    || ||                  # is integer - number of total times in list
|-
|- style="background:firebrick; color:white"
||                          || ||            ### is a series of real numbers which denote discrete output times
||                          || ||            ### 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
||                              || ||        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
||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
||                  || ||                    # 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
||                  || ||                    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
||                  || ||                    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
||                  || ||                    ee is a real number denoting the ending time of the new interval in list
|-
|-
Line 118: Line 126:
||EDDY_VISCOSITY_OUT_TIMES_LIST  ||  # ||  an integer number
||EDDY_VISCOSITY_OUT_TIMES_LIST  ||  # ||  an integer number
|-
|-
|colspan="3" align="left"|'''User-defined cell-specific datasets'''||
|colspan="3" align="left"|
'''User-defined cell-specific datasets'''
|-
|-
||HARDBOTTOM_DATASET    ||  %GRID_FILE% <path to dataset>||
||HARDBOTTOM_DATASET    ||  %GRID_FILE% <path to dataset>||
Line 130: Line 139:
||BOTTOM_FRICTION_DATASET || %GRID_FILE% <path to dataset>||
||BOTTOM_FRICTION_DATASET || %GRID_FILE% <path to dataset>||
|-
|-
|colspan="3" align="left"|'''Cellstrings'''||
|colspan="3" align="left"|
'''Cellstrings'''
|-
|-
||TIDAL_CELLSTRING  ||      %PARAMS_FILE% <path to cellstring>
||TIDAL_CELLSTRING  ||      %PARAMS_FILE% <path to cellstring>
Line 140: Line 150:
||MHDRIVER_CELLSTRING ||    %PARAMS_FILE% <path to cellstring>
||MHDRIVER_CELLSTRING ||    %PARAMS_FILE% <path to cellstring>
|-
|-
|colspan="3" align="left"|'''Wind/Wave'''||
|colspan="3" align="left"|
'''Wind/Wave'''
|-
|-
||ANEMOMETER_HEIGHT  ||    #  ||          a real number - units in meters above mean water level
||ANEMOMETER_HEIGHT  ||    #  ||          a real number - units in meters above mean water level
Line 146: Line 157:
||WIND_INPUT_CURVE    ||    %PARAMS_FILE% <path to dataset>
||WIND_INPUT_CURVE    ||    %PARAMS_FILE% <path to dataset>
|-
|-
|colspan="3" align="left"|'''Output'''||
|colspan="3" align="left"|
'''Output'''
|-
|-
||GLOBAL_VELOCITY_OUTPUT    ||  <file>_sol.h5 <path to dataset>
||GLOBAL_VELOCITY_OUTPUT    ||  <file>_sol.h5 <path to dataset>
Line 160: Line 172:
||GLBL_CONC_CAPAC_OUTPUT    ||  <path to dataset>
||GLBL_CONC_CAPAC_OUTPUT    ||  <path to dataset>
|-
|-
|colspan="3" align="left"|'''Inline Steering'''||
|colspan="3" align="left"|
'''Inline Steering'''
|-
|-
||CMS-WAVE_SIM_FILE  ||        <file>.sim  
||CMS-WAVE_SIM_FILE  ||        <file>.sim  

Revision as of 14:15, 4 June 2010


UNDER CONSTRUCTION

Cardname Value(s) Information

Model Files

GRID_FILE <file>_grid.h5
PARAMS_FILE <file>_mp.h5

Grid Geometry

BATHYMETRY_DATASET %GRID_FILE% <path to 'Depth' dataset>
GRID_ANGLE # a real number - units in degrees
GRID_ORIGIN_X # a real number - units in meters
GRID_ORIGIN_Y # a real number - units in meters
CELL_LATITUDES %PARAMS_FILE% <path to 'Lats' dataset>
GRID_CELL_TYPES <path to 'CellTypes' dataset>

General Parameters

USE_ADVECTION_TERMS 'ON' or 'OFF'
USE_MIXING_TERMS 'ON' or 'OFF'
USE_WALL_FRICTION_TERMS 'ON' or 'OFF'
DRYING_DEPTH # a real number - units in meters
SIMULATION_LABEL 'xxx' string of characters
2D_MODE 'ON' or 'OFF'
NUM_THREADS # an integer number

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

Transport

CALC_SALINITY 'ON' or 'OFF'
CALC_SEDIMENT_TRANSPORT 'ON' or 'OFF'
WATER_DENSITY # a real number - units in kg/m^3
WATER_TEMPERATURE # a real number - units in degrees celcius

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

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

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

User-defined cell-specific datasets

HARDBOTTOM_DATASET %GRID_FILE% <path to dataset>
D50_DATASET %GRID_FILE% <path to dataset>
MANNINGS_N_DATASET %GRID_FILE% <path to dataset>
ROUGHNESS_DATASET %GRID_FILE% <path to dataset>
BOTTOM_FRICTION_DATASET %GRID_FILE% <path to dataset>

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>

Wind/Wave

ANEMOMETER_HEIGHT # a real number - units in meters above mean water level
WIND_INPUT_CURVE %PARAMS_FILE% <path to dataset>

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>

Inline Steering

CMS-WAVE_SIM_FILE <file>.sim
STEERING_INTERVAL ## of hours
Retrieved from "https://cirpwiki.info/index.php?title=CMS:CardList:Flow&oldid=2111"