Difference between revisions of "Variables"
From WikiROMS
Jump to navigationJump to searchLine 3: | Line 3: | ||
is built to facilitate printing. Each variable has a unique anchor tag to facilitate | is built to facilitate printing. Each variable has a unique anchor tag to facilitate | ||
linking from any wikipage. | linking from any wikipage. | ||
<!-- The automatic table of contents is disabled here to allow a simplified table --> | <!-- The automatic table of contents is disabled here to allow a simplified table --> | ||
__NOTOC__ | __NOTOC__ | ||
Line 37: | Line 39: | ||
==<span class="alphabet">A</span>== | ==<span class="alphabet">A</span>== | ||
;<span id="Akt_bak"></span>Akt_bak | |||
:Background vertical mixing coefficient. | |||
:'''dimension =''' '''Akt_bak'''([[#MT|MT]],[[#Ngrids|Ngrids]]) | |||
:'''units =''' meters<sup>2</sup> second<sup>-1</sup> | |||
:'''option = ''' [[Options#BIOLOGY|BIOLOGY]], [[Options#SEDIMENT|SEDIMENT]] | |||
:'''routine =''' [[mod_mixing.F]], [[mod_scalars.F]] | |||
:'''keywords =''' AKT_BAK, MUD_AKT_BAK, SAND_AKT_BAK | |||
:'''input =''' [[biology.in]], [[sediment.in]] | |||
==<span class="alphabet">B</span>== | ==<span class="alphabet">B</span>== | ||
==<span class="alphabet">C</span>== | ==<span class="alphabet">C</span>== | ||
;<span id="Csed"></span>Csed | |||
:Sediment concentration used in analytical initial conditions. It is used to initialize full 3D cohesive and non-cohesive constant (homogeneous) concentrations of sediment. | |||
:'''dimension =''' '''Csed'''([[#NST|NST]],[[#Ngrids|Ngrids]]) | |||
:'''units =''' kilograms meter<sup>-3</sup> | |||
:'''option = ''' [[Options#SEDIMENT|SEDIMENT]] | |||
:'''routine =''' [[mod_sediment.F]] | |||
:'''keywords =''' MUD_CSED, SAND_CSED | |||
:'''input =''' [[sediment.in]] | |||
==<span class="alphabet">D</span>== | ==<span class="alphabet">D</span>== | ||
<section begin=dstart /> | <section begin=dstart />;<span id="dstart"></span>[[dstart]] | ||
:Time stamp assigned to model initialization (days). Usually a Calendar linear coordinate, like modified Julian Day. | :Time stamp assigned to model initialization (days). Usually a Calendar linear coordinate, like modified Julian Day. | ||
:'''option =''' | :'''option =''' | ||
Line 52: | Line 72: | ||
;<span id="dt"></span>dt | ;<span id="dt"></span>dt | ||
:Time-Step size in seconds. If 3D configuration, dt is the size of the baroclinic time-step. If only 2D configuration, dt is the size of the barotropic time-step. | :Time-Step size in seconds. If 3D configuration, dt is the size of the baroclinic time-step. If only 2D configuration, dt is the size of the barotropic time-step. [[#Ngrids|Ngrids]] values are expected. | ||
:'''dimension =''' '''dt'''([[#Ngrids|Ngrids]]) | :'''dimension =''' '''dt'''([[#Ngrids|Ngrids]]) | ||
:'''option =''' | :'''option =''' | ||
Line 59: | Line 79: | ||
:'''input =''' [[ocean.in]] | :'''input =''' [[ocean.in]] | ||
;<span id="Dwave"></span> | ;<span id="Dwave"></span>Dwave | ||
:wind-induced wave direction. Direction the waves are coming from; measured clockwise from geographic North. (nautical convention). | :wind-induced wave direction. Direction the waves are coming from; measured clockwise from geographic North. (nautical convention). | ||
:'''dimension =''' '''Dwave'''([[#LBi|LBi]]:[[#UBi|UBi]],[[#LBj|LBj]]:[[#UBj|UBj]]) | :'''dimension =''' '''Dwave'''([[#LBi|LBi]]:[[#UBi|UBi]],[[#LBj|LBj]]:[[#UBj|UBj]]) | ||
Line 69: | Line 89: | ||
==<span class="alphabet">E</span>== | ==<span class="alphabet">E</span>== | ||
;<span id="Erate"></span>Erate | |||
:Surface erosion rate for cohesive and non-cohesive sediment. | |||
:'''dimension =''' '''Erate'''([[#NST|NST]],[[#Ngrids|Ngrids]]) | |||
:'''units =''' kilograms meter<sup>-2</sup> second<sup>-1</sup> | |||
:'''option = ''' [[Options#SEDIMENT|SEDIMENT]] | |||
:'''routine =''' [[mod_sediment.F]] | |||
:'''keywords =''' MUD_ERATE, SAND_ERATE | |||
:'''input =''' [[sediment.in]] | |||
;<span id="ERstr"></span>ERstr | ;<span id="ERstr"></span>ERstr | ||
Line 85: | Line 114: | ||
==<span class="alphabet">F</span>== | ==<span class="alphabet">F</span>== | ||
;<span id="Fcoor"></span>Fcoor | |||
:Initial horizontal location ([[#Fx0|Fx0]] and [[#Fy0|Fy0]]) coordinate type. If <span class="blue">Fcoor</span> = 0 then rho grid points are used. If <span class="blue">Fcoor</span> = 1 then location is given in latitude and longitude. <span class="blue">Fcoor</span> is column '''C''' in the [[POS]] specification at the end of the [[floats.in]] file. | |||
:'''option =''' [[FLOATS]] | |||
:'''routine =''' [[inp_par.F]] | |||
:'''input =''' [[floats.in]] | |||
;<span id="Fcount"></span>Fcount | |||
:Number of floats to be released at the specified ([[#Fx0|Fx0]],[[#Fy0|Fy0]],[[#Fz0|Fz0]]) location. It must be equal or greater than one. If <span class="blue">Fcount</span> is greater than one, a cluster distribution of floats centered at ([[#Fx0|Fx0]],[[#Fy0|Fy0]],[[#Fz0|Fz0]]) is activated. The total number of floats trajectories to compute must add up to [[#Nfloats|NFLOATS]]. <span class="blue">Fcount</span> is column '''N''' in the [[POS]] specification at the end of the [[floats.in]] file. | |||
:'''option =''' [[FLOATS]] | |||
:'''routine =''' [[inp_par.F]] | |||
:'''input =''' [[floats.in]] | |||
;<span id="Fdt"></span>Fdt | |||
:Float cluster release time interval in days. This is only used if [[#Fcount|Fcount]] is greater than 1. If <span class="blue">Fdt</span> gt; 0 a cluster of floats will be deployed from ([[#Fx0|Fx0]],[[#Fy0|Fy0]],[[#Fz0|Fz0]]) at <span class="blue">Fdt</span> intervals until [[#Fcount|Fcount]] floats are released. If <span class="blue">Fdt</span> = 0 [[#Fcount|Fcount]] floats will be deployed simultaneously with a distribution centered at ([[#Fx0|Fx0]],[[#Fy0|Fy0]],[[#Fz0|Fz0]]) and defined by ([[#Fdx|Fdx]],[[#Fdy|Fdy]],[[#Fdz|Fdz]]). This value must be of type real (i.e. 5.d0). | |||
:'''option =''' [[FLOATS]] | |||
:'''routine =''' [[inp_par.F]] | |||
:'''input =''' [[floats.in]] | |||
;<span id="Fdx"></span>Fdx | |||
:Cluster x-distribution parameter. This is only used if [[#Fcount|Fcount]] is greater than '''1''' and [[#Fdt|Fdt]] = 0. This value must be of type real (''i.e.'' 5.d0). | |||
:'''option =''' [[FLOATS]] | |||
:'''routine =''' [[inp_par.F]] | |||
:'''input =''' [[floats.in]] | |||
;<span id="Fdy"></span>Fdy | |||
:Cluster y-distribution parameter. This is only used if [[#Fcount|Fcount]] is greater than '''1''' and [[#Fdt|Fdt]] = 0. This value must be of type real (''i.e.'' 5.d0). | |||
:'''option =''' [[FLOATS]] | |||
:'''routine =''' [[inp_par.F]] | |||
:'''input =''' [[floats.in]] | |||
;<span id="Fdz"></span>Fdz | |||
:Cluster z-distribution parameter. This is only used if [[#Fcount|Fcount]] is greater than '''1''' and [[#Fdt|Fdt]] = 0. This value must be of type real (''i.e.'' 5.d0). | |||
:'''option =''' [[FLOATS]] | |||
:'''routine =''' [[inp_par.F]] | |||
:'''input =''' [[floats.in]] | |||
;<span id="FLTname"></span>FLTname | ;<span id="FLTname"></span>FLTname | ||
:Output floats data file name. | :Output floats data file name. [[#Ngrids|Ngrids]] values are expected. | ||
:'''dimension =''' '''FLTname'''([[#Ngrids|Ngrids]]) | :'''dimension =''' '''FLTname'''([[#Ngrids|Ngrids]]) | ||
:'''option =''' | :'''option =''' | ||
Line 102: | Line 167: | ||
;<span id="frrec"></span>frrec | ;<span id="frrec"></span>frrec | ||
:Flag to indicate re-start from a previous solution. For new solutions (not a model restart) use <span class="blue">frrec</span>=0. In a re-start solution, <span class="blue">frrec</span> is the time index in the floats NetCDF file assigned for initialization. If <span class="blue">frrec</span> is negative (say <span class="blue">frrec</span>=-1), the floats will re-start from the most recent time record. That is, the initialization record is assigned internally. | :Flag to indicate re-start from a previous solution. [[#Ngrids|Ngrids]] values are expected. For new solutions (not a model restart) use <span class="blue">frrec</span> = 0. In a re-start solution, <span class="blue">frrec</span> is the time index in the floats NetCDF file assigned for initialization. If <span class="blue">frrec</span> is negative (say <span class="blue">frrec</span> = -1), the floats will re-start from the most recent time record. That is, the initialization record is assigned internally. | ||
:'''dimension =''' '''frrec'''([[#Ngrids|Ngrids]]) | :'''dimension =''' '''frrec'''([[#Ngrids|Ngrids]]) | ||
:'''option = ''' [[Options#FLOATS|FLOATS]] | :'''option = ''' [[Options#FLOATS|FLOATS]] | ||
:'''routine =''' [[mod_scalars.F]] | :'''routine =''' [[mod_scalars.F]] | ||
:'''keyword =''' FRREC | :'''keyword =''' FRREC | ||
:'''input =''' [[floats.in]] | |||
;<span id="Ft0"></span>Ft0 | |||
:Time, in days, of float release after model initialization. This value must be of type real (i.e. 0.d0). | |||
:'''option =''' [[FLOATS]] | |||
:'''routine =''' [[inp_par.F]] | |||
:'''input =''' [[floats.in]] | |||
;<span id="Ftype"></span>Ftype | |||
:Float trajectory type. If <span class="blue">Ftype</span> = 1, float(s) will be neutral density 3D Lagrangian particles. If <span class="blue">Ftype</span> = 2, float(s) will be isobaric (constant depth) particles. | |||
:'''option =''' [[FLOATS]] | |||
:'''routine =''' [[inp_par.F]] | |||
:'''input =''' [[floats.in]] | |||
;<span id="Fx0"></span>Fx0 | |||
:Initial float(s) x-location in grid units or longitude depending on the value of [[#Fcoor|Fcoor]]. This value must be of type real (''i.e.'' 5.d0). | |||
:'''option =''' [[FLOATS]] | |||
:'''routine =''' [[inp_par.F]] | |||
:'''input =''' [[floats.in]] | |||
;<span id="Fy0"></span>Fy0 | |||
:Initial float(s) y-location in grid units or longitude depending on the value of [[#Fcoor|Fcoor]]. This value must be of type real (''i.e.'' 5.d0). | |||
:'''option =''' [[FLOATS]] | |||
:'''routine =''' [[inp_par.F]] | |||
:'''input =''' [[floats.in]] | |||
;<span id="Fz0"></span>Fz0 | |||
:Initial float(s) z-location in vertical levels or depth. If <span class="blue">Fz0</span> is less than or equal to zero then <span class="blue">Fz0</span> is the initial depth in meters. If <span class="blue">Fz0</span> is greater than 0 and less than [[#N|N(ng)]] the initial position is relative to the W grid (0 is the bottom and N is the surface). This value must be of type real (''i.e.'' -45.d0). | |||
:'''option =''' [[FLOATS]] | |||
:'''routine =''' [[inp_par.F]] | |||
:'''input =''' [[floats.in]] | :'''input =''' [[floats.in]] | ||
Line 122: | Line 217: | ||
;<span id="HISname"></span>HISname | ;<span id="HISname"></span>HISname | ||
:Output history data file name. | :Output history data file name. [[#Ngrids|Ngrids]] values are expected. | ||
:'''dimension =''' '''HISname'''([[#Ngrids|Ngrids]]) | :'''dimension =''' '''HISname'''([[#Ngrids|Ngrids]]) | ||
:'''option =''' | :'''option =''' | ||
Line 129: | Line 224: | ||
:'''input =''' [[ocean.in]] | :'''input =''' [[ocean.in]] | ||
;<span id="Hz"></span> | ;<span id="Hz"></span>Hz | ||
:Vertical level thicknesses, <math>\,H_z\,(\xi,\eta,s)</math>. | :Vertical level thicknesses, <math>\,H_z\,(\xi,\eta,s)</math>. | ||
:'''dimension =''' '''Hz'''([[#LBi|LBi]]:[[#UBi|UBi]],[[#LBj|LBj]]:[[#UBj|UBj]],[[#N|N(ng)]]) | :'''dimension =''' '''Hz'''([[#LBi|LBi]]:[[#UBi|UBi]],[[#LBj|LBj]]:[[#UBj|UBj]],[[#N|N(ng)]]) | ||
Line 142: | Line 237: | ||
==<span class="alphabet">I</span>== | ==<span class="alphabet">I</span>== | ||
;<span id="Iend"></span> | ;<span id="Iend"></span>Iend | ||
:Non-overlapping upper bound tile index in the '''i'''-direction. Its value depends on the tile rank (sub-domain partition). | :Non-overlapping upper bound tile index in the '''i'''-direction. Its value depends on the tile rank (sub-domain partition). | ||
:'''routine =''' [[tile.h]], [[get_tile.F]] | :'''routine =''' [[tile.h]], [[get_tile.F]] | ||
;<span id="Istr"></span> | ;<span id="Istr"></span>Istr | ||
:Non-overlapping lower bound tile index in the '''i'''-direction. Its value depends on the tile rank (sub-domain partition). | :Non-overlapping lower bound tile index in the '''i'''-direction. Its value depends on the tile rank (sub-domain partition). | ||
:'''routine =''' [[tile.h]], [[get_tile.F]] | :'''routine =''' [[tile.h]], [[get_tile.F]] | ||
;<span id="idbio"></span> | ;<span id="idbio"></span>idbio | ||
:Identification indexes for biological tracer variables, [[#t|t]](:,:,:,:,idbio(:)). | :Identification indexes for biological tracer variables, [[#t|t]](:,:,:,:,idbio(:)). | ||
:'''dimension =''' '''idbio'''([[#NBT|NBT]]) | :'''dimension =''' '''idbio'''([[#NBT|NBT]]) | ||
Line 156: | Line 251: | ||
:'''routine =''' [[mod_scalars.F]] | :'''routine =''' [[mod_scalars.F]] | ||
;<span id="idsed"></span> | ;<span id="idsed"></span>idsed | ||
:Identification indexes for biological tracer variables, [[#t|t]](:,:,:,:,idsed(:)). | :Identification indexes for biological tracer variables, [[#t|t]](:,:,:,:,idsed(:)). | ||
:'''dimension =''' '''idsed'''([[#NST|NST]]) | :'''dimension =''' '''idsed'''([[#NST|NST]]) | ||
Line 162: | Line 257: | ||
:'''routine =''' [[mod_scalars.F]] | :'''routine =''' [[mod_scalars.F]] | ||
;<span id="inert"></span> | ;<span id="inert"></span>inert | ||
:Identification indexes for inert tracer variables, [[#t|t]](:,:,:,:,inert(:)). | :Identification indexes for inert tracer variables, [[#t|t]](:,:,:,:,inert(:)). | ||
:'''dimension =''' '''inert'''([[#NPT|NPT]]) | :'''dimension =''' '''inert'''([[#NPT|NPT]]) | ||
Line 168: | Line 263: | ||
:'''routine =''' [[mod_scalars.F]] | :'''routine =''' [[mod_scalars.F]] | ||
;<span id="isalt"></span> | ;<span id="isalt"></span>isalt | ||
:Tracer identification index for salinity, [[#t|t]](:,:,:,:,isalt). | :Tracer identification index for salinity, [[#t|t]](:,:,:,:,isalt). | ||
:'''routine =''' [[mod_scalars.F]] | :'''routine =''' [[mod_scalars.F]] | ||
;<span id="itemp"></span> | ;<span id="itemp"></span>itemp | ||
:Tracer identification index for potential temperature, [[#t|t]](:,:,:,:,itemp). | :Tracer identification index for potential temperature, [[#t|t]](:,:,:,:,itemp). | ||
:'''routine =''' [[mod_scalars.F]] | :'''routine =''' [[mod_scalars.F]] | ||
Line 178: | Line 273: | ||
==<span class="alphabet">J</span>== | ==<span class="alphabet">J</span>== | ||
;<span id="Jend"></span> | ;<span id="Jend"></span>Jend | ||
:Non-overlapping upper bound tile index in the '''j'''-direction. Its value depends on the tile rank (sub-domain partition). | :Non-overlapping upper bound tile index in the '''j'''-direction. Its value depends on the tile rank (sub-domain partition). | ||
:'''routine =''' [[tile.h]], [[get_tile.F]] | :'''routine =''' [[tile.h]], [[get_tile.F]] | ||
;<span id="Jstr"></span> | ;<span id="Jstr"></span>Jstr | ||
:Non-overlapping lower bound tile index in the '''j'''-direction. Its value depends on the tile rank (sub-domain partition). | :Non-overlapping lower bound tile index in the '''j'''-direction. Its value depends on the tile rank (sub-domain partition). | ||
:'''routine =''' [[tile.h]], [[get_tile.F]] | :'''routine =''' [[tile.h]], [[get_tile.F]] | ||
<section begin=Jwtype />;<span id="Jwtype"></span>[[Jwtype]] | |||
:Jerlov water type: an integer value from 1 to 5. | |||
:'''option = ''' | |||
:'''routine =''' [[mod_mixing.F]] | |||
:'''keyword =''' WTYPE | |||
:'''input =''' [[ocean.in]]<section end=Jwtype /> | |||
==<span class="alphabet">K</span>== | ==<span class="alphabet">K</span>== | ||
Line 190: | Line 292: | ||
==<span class="alphabet">L</span>== | ==<span class="alphabet">L</span>== | ||
;<span id="LBi"></span> | ;<span id="LBi"></span>LBi | ||
:Array lower bound dimension in the '''i'''-direction. In serial and shared-memory applications its value is | :Array lower bound dimension in the '''i'''-direction. In serial and shared-memory applications its value is <span class="blue">LBi</span> = -2 for East-West periodic grids or <span class="blue">LBi</span> = 0 for non-periodic grids . In distributed-memory its value is a function of the tile partition, <span class="blue">LBi</span> = [[#Istr|Istr]] - [[#NghostPoints|NghostPoints]]. | ||
:'''option =''' [[Options#LOWER_BOUND_I | LOWER_BOUND_I]] | :'''option =''' [[Options#LOWER_BOUND_I | LOWER_BOUND_I]] | ||
:'''routine =''' [[get_bounds.F]], [[get_tile.F]] | :'''routine =''' [[get_bounds.F]], [[get_tile.F]] | ||
;<span id="LBj"></span> | ;<span id="LBj"></span>LBj | ||
:Array lower bound dimension in the '''j'''-direction. In serial and shared-memory applications its value is | :Array lower bound dimension in the '''j'''-direction. In serial and shared-memory applications its value is <span class="blue">LBj</span> = -2 for North-South periodic grids or <span class="blue">LBj</span> = 0 for non-periodic grids . In distributed-memory its value is a function of the tile partition, <span class="blue">LBj</span> = [[#Jstr|Jstr]] - [[#NghostPoints|NghostPoints]]. | ||
:'''option =''' [[Options#LOWER_BOUND_J | LOWER_BOUND_J]] | :'''option =''' [[Options#LOWER_BOUND_J | LOWER_BOUND_J]] | ||
:'''routine =''' [[get_bounds.F]], [[get_tile.F]] | :'''routine =''' [[get_bounds.F]], [[get_tile.F]] | ||
;<span id="LcycleRST"></span>LcycleRST | |||
:Logical switch(s) (T/F) used to recycle time records in output re-start file. [[#Ngrids|Ngrids]] values are expected. If TRUE, only the latest two re-start time records are maintained. If FALSE, all re-start fields are saved every [[#nRST|nRST]] time-steps without recycling. The re-start fields are written at all levels in double precision unless the [[Options#RST_SINGLE|RST_SINGLE]] [[C_Preprocessor|CPP option]] is activated. | |||
:'''dimension =''' '''LcycleRST'''([[#Ngrids|Ngrids]]) | |||
:'''option =''' [[Options#PERFECT_RESTART|PERFECT_RESTART]], [[Options#RST_SINGLE|RST_SINGLE]] | |||
:'''routine =''' [[mod_scalars.F]] | |||
:'''keyword =''' LcycleRST | |||
:'''input =''' [[ocean.in]] | |||
;<span id="LcycleTLM"></span>LcycleTLM | |||
:Logical switch(s) (T/F) used to recycle time records in output tangent linear file. [[#Ngrids|Ngrids]] values are expected. If TRUE, only the latest two re-start time records are maintained. If FALSE, all tangent linear fields are saved every [[#nTLM|nTLM]] time-steps without recycling. | |||
:'''dimension =''' '''LcycleTLM'''([[#Ngrids|Ngrids]]) | |||
:'''option =''' | |||
:'''routine =''' [[mod_scalars.F]] | |||
:'''keyword =''' LcycleTLM | |||
:'''input =''' [[ocean.in]] | |||
;<span id="ldefout"></span>ldefout | |||
:Logical switch(s) (T/F) used to create new output files when initializing from a re-start file, |[[#nrrec|nrrec]]| > 0. [[#Ngrids|Ngrids]] values are expected. If TRUE and applicable, a new history, average, diagnostic and station files are created during the initialization stage. If FALSE and applicable, data is appended to existing history, average, diagnostic and station files. See also parameters [[#ndefHIS|ndefHIS]], [[#ndefAVG|ndefAVG]] and [[#ndefDIA|ndefDIA]]. | |||
:'''dimension =''' '''ldefout'''([[#Ngrids|Ngrids]]) | |||
:'''option =''' [[Options#PERFECT_RESTART|PERFECT_RESTART]] | |||
:'''routine =''' [[mod_scalars.F]] | |||
:'''keyword =''' LcycleRST | |||
:'''input =''' [[ocean.in]] | |||
;<span id="Lfloats"></span>Lfloats | ;<span id="Lfloats"></span>Lfloats | ||
: | :Logical switch(s) (T/F) used to control the computation of floats trajectories within nested and/or multiple connected grids. [[#Ngrids|Ngrids]] values are expected. By default this switch is set to TRUE in [[mod_scalars.F]] for all grids when the [[C Preprocessor|CPP option]] [[Options#FLOATS|FLOATS]] is activated. The '''user''' can control which grids to process by turning on/off this switch. | ||
:'''dimension =''' '''Lfloats'''([[#Ngrids|Ngrids]]) | :'''dimension =''' '''Lfloats'''([[#Ngrids|Ngrids]]) | ||
:'''option =''' [[Options#FLOATS|FLOATS]] | :'''option =''' [[Options#FLOATS|FLOATS]] | ||
Line 216: | Line 342: | ||
;<span id="Lsediment"></span>Lsediment | ;<span id="Lsediment"></span>Lsediment | ||
: | :Logical switch(s) (T/F) used to control sediment model computation within nested and/or multiple connected grids. [[#Ngrids|Ngrids]] values are expected. By default this switch is set to TRUE in [[mod_scalars.F]] for all grids when the [[C Preprocessor|CPP option]] [[Options#SEDIMENT|SEDIMENT]] is activated. The '''user''' can control which grids to process by turning on/off this switch. | ||
:'''dimension =''' '''Lsediment'''([[#Ngrids|Ngrids]]) | :'''dimension =''' '''Lsediment'''([[#Ngrids|Ngrids]]) | ||
:'''option =''' [[Options#SEDIMENT|SEDIMENT]] | :'''option =''' [[Options#SEDIMENT|SEDIMENT]] | ||
Line 224: | Line 350: | ||
;<span id="Lstations"></span>Lstations | ;<span id="Lstations"></span>Lstations | ||
: | :Logical switch(s) (T/F) used to control the writing of station data within nested and/or multiple connected grids. [[#Ngrids|Ngrids]] values are expected. By default this switch is set to TRUE in [[mod_scalars.F]] for all grids when the [[C Preprocessor|CPP option]] [[Options#STATIONS|STATIONS]] is activated. The '''user''' can control which grids to process by turning on/off this switch. | ||
:'''dimension =''' '''Lstations'''([[#Ngrids|Ngrids]]) | :'''dimension =''' '''Lstations'''([[#Ngrids|Ngrids]]) | ||
:'''option =''' [[Options#STATIONS|STATIONS]] | :'''option =''' [[Options#STATIONS|STATIONS]] | ||
Line 239: | Line 365: | ||
:'''keyword =''' Mm | :'''keyword =''' Mm | ||
:'''input =''' [[ocean.in]] | :'''input =''' [[ocean.in]] | ||
;<span id="morph_fac"></span>morph_fac | |||
:Morphological scale factor for cohesive and non-cohesive sediment. | |||
:'''dimension =''' '''morph_fac'''([[#NST|NST]],[[#Ngrids|Ngrids]]) | |||
:'''option = ''' [[Options#SEDIMENT|SEDIMENT]] | |||
:'''routine =''' [[mod_sediment.F]] | |||
:'''keywords =''' MUD_MORPH_FAC, SAND_MORPH_FAC | |||
:'''input =''' [[sediment.in]] | |||
;<span id="MyAppCPP"></span>MyAppCPP | ;<span id="MyAppCPP"></span>MyAppCPP | ||
Line 248: | Line 382: | ||
;<span id="N"></span>N | ;<span id="N"></span>N | ||
:Number of vertical levels for each nested grid. | :Number of vertical levels for each nested grid. [[#Ngrids|Ngrids]] values are expected. | ||
:'''dimension =''' '''N'''([[#Ngrids|Ngrids]]) | :'''dimension =''' '''N'''([[#Ngrids|Ngrids]]) | ||
:'''routine =''' [[mod_param.F]] | :'''routine =''' [[mod_param.F]] | ||
Line 254: | Line 388: | ||
:'''input =''' [[ocean.in]] | :'''input =''' [[ocean.in]] | ||
;<span id="NAT"></span> | ;<span id="NAT"></span>NAT | ||
:Number of active tracer-type variables. Usually, it has a value of two for potential temperature and salinty. | :Number of active tracer-type variables. Usually, it has a value of two for potential temperature and salinty. | ||
:'''option =''' [[Options#SOLVE3D | SOLVE3D]] | :'''option =''' [[Options#SOLVE3D | SOLVE3D]] | ||
:'''routine =''' [[mod_param.F]] | :'''routine =''' [[mod_param.F]] | ||
:'''keyword =''' NAT | :'''keyword =''' NAT | ||
:'''input =''' [[ocean.in]] | |||
;<span id="nAVG"></span>nAVG | |||
:Number of time-steps between writing time-averaged data into averages file. Averaged date is written for all fields. [[#Ngrids|Ngrids]] values are expected. | |||
:'''dimension =''' '''nAVG'''([[#Ngrids|Ngrids]]) | |||
:'''routine =''' [[mod_scalars.F]] | |||
:'''keyword =''' NAVG | |||
:'''input =''' [[ocean.in]] | :'''input =''' [[ocean.in]] | ||
Line 267: | Line 408: | ||
:'''input =''' [[ocean.in]] | :'''input =''' [[ocean.in]] | ||
;<span id="NBT"></span> | ;<span id="NBT"></span>NBT | ||
:Number of biological tracer-type variables. | :Number of biological tracer-type variables. | ||
:'''option =''' [[Options#BIOLOGY | BIOLOGY]] | :'''option =''' [[Options#BIOLOGY | BIOLOGY]] | ||
Line 276: | Line 417: | ||
;<span id="NCS"></span>NCS | ;<span id="NCS"></span>NCS | ||
:Number of cohesive (mud) sediment tracer-type variables. | :Number of cohesive (mud) sediment tracer-type variables. | ||
:'''option =''' [[Options#SEDIMENT | SEDIMENT]] | :'''option =''' [[Options#SEDIMENT|SEDIMENT]] | ||
:'''routine =''' [[mod_param.F]] | :'''routine =''' [[mod_param.F]] | ||
:'''keyword =''' NCS | :'''keyword =''' NCS | ||
:'''input =''' [[ocean.in]] | |||
<section begin=NCV />;<span id="NCV"></span>[[Eigenproblem Parameters|NCV]] | |||
:Number of eigenvectors to compute for the Lanczos/Arnoldi problem. <span class="blue">NCV</span> must be greater than [[#NEV|NEV]]. | |||
:'''option =''' | |||
:'''routine =''' [[mod_storage.F]] | |||
:'''keyword =''' NCV | |||
:'''input =''' [[ocean.in]]<section end=NCV /> | |||
;<span id="ndefAVG"></span>ndefAVG | |||
:Number of time-steps between the creation of new average file. If <span class="blue">ndefAVG</span> = 0, the model will only process one average file. This feature is useful for long simulations when average files get too large; it creates a new file every <span class="blue">ndefAVG</span> time-steps. [[#Ngrids|Ngrids]] values are expected. | |||
:'''dimension =''' '''ndefAVG'''([[#Ngrids|Ngrids]]) | |||
:'''routine =''' [[mod_scalars.F]] | |||
:'''keyword =''' NDEFAVG | |||
:'''input =''' [[ocean.in]] | |||
;<span id="ndefDIA"></span>ndefDIA | |||
:Number of time-steps between the creation of new time-averaged diagnostics file. If <span class="blue">ndefDIA</span> = 0, the model will only process one diagnostics file. This feature is useful for long simulations when diagnostics files get too large; it creates a new file every <span class="blue">ndefDIA</span> time-steps. [[#Ngrids|Ngrids]] values are expected. | |||
:'''dimension =''' '''ndefDIA'''([[#Ngrids|Ngrids]]) | |||
:'''routine =''' [[mod_scalars.F]] | |||
:'''keyword =''' NDEFDIA | |||
:'''input =''' [[ocean.in]] | |||
;<span id="ndefHIS"></span>ndefHIS | |||
:Number of time-steps between the creation of new history file. If <span class="blue">ndefHIS</span> = 0, the model will only process one history file. This feature is useful for long simulations when history files get too large; it creates a new file every <span class="blue">ndefHIS</span> time-steps. [[#Ngrids|Ngrids]] values are expected. | |||
:'''dimension =''' '''ndefHIS'''([[#Ngrids|Ngrids]]) | |||
:'''routine =''' [[mod_scalars.F]] | |||
:'''keyword =''' NDEFHIS | |||
:'''input =''' [[ocean.in]] | |||
;<span id="nDIA"></span>nDIA | |||
:Number of time-steps between writing time-averaged diagnostics data into diagnostics file. Averaged date is written for all fields. [[#Ngrids|Ngrids]] values are expected. | |||
:'''dimension =''' '''nDIA'''([[#Ngrids|Ngrids]]) | |||
:'''routine =''' [[mod_scalars.F]] | |||
:'''keyword =''' NDIA | |||
:'''input =''' [[ocean.in]] | :'''input =''' [[ocean.in]] | ||
;<span id="ndtfast"></span>ndtfast | ;<span id="ndtfast"></span>ndtfast | ||
:Number of barotropic time-steps between each baroclinic time step. If only 2D configuration, | :Number of barotropic time-steps between each baroclinic time step. If only 2D configuration, <span class="blue">ndtfast</span> should be unity since there is no need to split time-stepping. | ||
:'''option =''' | :'''option =''' | ||
:'''routine =''' [[mod_scalars.F]] | :'''routine =''' [[mod_scalars.F]] | ||
:'''keyword =''' NDTFAST | :'''keyword =''' NDTFAST | ||
:'''input =''' [[ocean.in]] | |||
<section begin=NEV />;<span id="NEV"></span>[[Eigenproblem Parameters|NEV]] | |||
:Number of eigenvalues to compute for the Lanczos/Arnoldi problem. Notice that the model memory requirement increases substantially as '''NEV''' increases. The GST requires '''NEV'''+1 copies of the model state vector. The memory requirements are decreased in distributed-memory applications. | |||
:'''option =''' | |||
:'''routine =''' [[mod_storage.F]] | |||
:'''keyword =''' NEV | |||
:'''input =''' [[ocean.in]]<section end=NEV /> | |||
;<span id="nFLT"></span>nFLT | |||
:Number of time-steps between writing data into floats file ([[#FLTname|FLTname]]). [[#Ngrids|Ngrids]] values are expected. | |||
:'''dimension =''' '''nFLT'''([[#Ngrids|Ngrids]]) | |||
:'''option =''' [[Options#FLOATS|FLOATS]] | |||
:'''routine =''' [[mod_scalars.F]] | |||
:'''keyword =''' NFLT | |||
:'''input =''' [[ocean.in]] | :'''input =''' [[ocean.in]] | ||
;<span id="Nfloats"></span>Nfloats | ;<span id="Nfloats"></span>Nfloats | ||
:Number of floats to release in each nested grid. Value(s) are used to dynamically allocate the arrays in [[ | :Number of floats to release in each nested grid. Value(s) are used to dynamically allocate the arrays in the [[Floats]] array structure. [[#Ngrids|Ngrids]] values are expected. | ||
:'''dimension =''' '''Nfloats'''([[#Ngrids|Ngrids]]) | :'''dimension =''' '''Nfloats'''([[#Ngrids|Ngrids]]) | ||
:'''option =''' [[Options#FLOATS|FLOATS]] | :'''option =''' [[Options#FLOATS|FLOATS]] | ||
Line 296: | Line 487: | ||
:'''input =''' [[floats.in]] | :'''input =''' [[floats.in]] | ||
;<span id="NghostPoints"></span> | ;<span id="NghostPoints"></span>NghostPoints | ||
:Number of ghost points in the halo region used in distributed-memory configurations. | :Number of ghost points in the halo region used in distributed-memory configurations. | ||
:'''option =''' [[Options#GHOST_POINTS | GHOST_POINTS]] | :'''option =''' [[Options#GHOST_POINTS | GHOST_POINTS]] | ||
:'''routine =''' [[mod_param.F]] | :'''routine =''' [[mod_param.F]] | ||
;<span id="Ngrids"></span> | ;<span id="Ngrids"></span>Ngrids | ||
:Number of nested and/or multiple connected grids to solve. | :Number of nested and/or multiple connected grids to solve. | ||
:'''routine =''' [[mod_param.F]] | :'''routine =''' [[mod_param.F]] | ||
;<span id="nHIS"></span>nHIS | |||
:Number of time-steps between writing fields into history file. [[#Ngrids|Ngrids]] values are expected. | |||
:'''dimension =''' '''nHIS'''([[#Ngrids|Ngrids]]) | |||
:'''routine =''' [[mod_scalars.F]] | |||
:'''keyword =''' NHIS | |||
:'''input =''' [[ocean.in]] | |||
;<span id="ninfo"></span>ninfo | |||
:Number of time-steps between printing of single line information to standard output. It also determines the interval between the computation of global energy diagnostics. [[#Ngrids|Ngrids]] values are expected. | |||
:'''dimension =''' '''ninfo'''([[#Ngrids|Ngrids]]) | |||
:'''option =''' | |||
:'''routine =''' [[mod_scalars.F]] | |||
:'''keyword =''' NINFO | |||
:'''input =''' [[ocean.in]] | |||
;<span id="Ninner"></span>Ninner | ;<span id="Ninner"></span>Ninner | ||
Line 312: | Line 518: | ||
:'''input =''' [[ocean.in]] | :'''input =''' [[ocean.in]] | ||
;<span id="Nintervals"></span>[[Nintervals]] | <section begin=Nintervals />;<span id="Nintervals"></span>[[Nintervals]] | ||
:Number of time interval divisions for stochastic optimals computations. It must be a multiple of [[#ntimes| | :Number of time interval divisions for stochastic optimals computations. It must be a multiple of [[#ntimes|ntimes]]. | ||
:'''option =''' | :'''option =''' | ||
:'''routine =''' [[mod_scalars.F]] | :'''routine =''' [[mod_scalars.F]] | ||
:'''keyword =''' Nintervals | :'''keyword =''' Nintervals | ||
:'''input =''' [[ocean.in]] | :'''input =''' [[ocean.in]]<section end=Nintervals /> | ||
;<span id="NNS"></span> | ;<span id="NNS"></span>NNS | ||
:Number of non-cohesive (sand) sediment tracer-type variables. | :Number of non-cohesive (sand) sediment tracer-type variables. | ||
:'''option =''' [[Options#SEDIMENT | SEDIMENT]] | :'''option =''' [[Options#SEDIMENT | SEDIMENT]] | ||
Line 333: | Line 539: | ||
:'''input =''' [[ocean.in]] | :'''input =''' [[ocean.in]] | ||
;<span id="NPT"></span> | ;<span id="NPT"></span>NPT | ||
:Number of inert tracer-type variables. Currently, an inert passive tracer is one that it is only advected and diffused. Other processes are ignored. These tracers include, for example, dyes, pollutants, oil spills, etc. | :Number of inert tracer-type variables. Currently, an inert passive tracer is one that it is only advected and diffused. Other processes are ignored. These tracers include, for example, dyes, pollutants, oil spills, etc. | ||
:'''option =''' [[Options#T_PASSIVE | T_PASSIVE]] | :'''option =''' [[Options#T_PASSIVE | T_PASSIVE]] | ||
Line 340: | Line 546: | ||
:'''input =''' [[ocean.in]] | :'''input =''' [[ocean.in]] | ||
;<span id=" | ;<span id="nrrec"></span>nrrec | ||
:Switch(s) to indicate re-start from a previous solution. [[#Ngrids|Ngrids]] values are expected. Use <span class="blue">nrrec</span> = 0 for new solutions. In a re-start solution, <span class="blue">nrrec</span> is the time index of the re-start NetCDF file assigned for initialization. If <span class="blue">nrrec</span> is negative (say <span class="blue">nrrec</span> = -1), the model will re-start from the most recent time record. That is, the initialization record is assigned internally. Notice that it is also possible to re-start from a history or time-averaged NetCDF file. If a history or time-averaged NetCDF file is used for re-start, it must contain all the necessary primitive variables at all levels. | |||
:'''dimension =''' '''nrrec'''([[#Ngrids|Ngrids]]) | |||
:'''option =''' [[Options#PERFECT_RESTART|PERFECT_RESTART]] | |||
:'''routine =''' [[mod_scalars.F]] | |||
:'''keyword =''' NRREC | |||
:'''input =''' [[ocean.in]] | |||
;<span id="nRST"></span>nRST | |||
:Number of time-steps between writing of re-start fields. [[#Ngrids|Ngrids]] values are expected. | |||
:'''dimension =''' '''nRST'''([[#Ngrids|Ngrids]]) | |||
:'''option =''' [[Options#PERFECT_RESTART|PERFECT_RESTART]] | |||
:'''routine =''' [[mod_scalars.F]] | |||
:'''keyword =''' NRST | |||
:'''input =''' [[ocean.in]] | |||
;<span id="NST"></span>NST | |||
:Number of sediment tracer-type variables, NST=[[#NCS|NCS]]+[[#NCS|NNS]]. | :Number of sediment tracer-type variables, NST=[[#NCS|NCS]]+[[#NCS|NNS]]. | ||
:'''option =''' [[Options#SEDIMENT | SEDIMENT]] | :'''option =''' [[Options#SEDIMENT | SEDIMENT]] | ||
:'''routine =''' [[mod_param.F]] | :'''routine =''' [[mod_param.F]] | ||
;<span id="nSTA"></span>nSTA | |||
:Number of time-steps between writing data into stations file. Station data is written at all levels. [[#Ngrids|Ngrids]] values are expected. | |||
:'''dimension =''' '''nSTA'''([[#Ngrids|Ngrids]]) | |||
:'''option =''' [[Options#STATIONS|STATIONS]] | |||
:'''routine =''' [[mod_scalars.F]] | |||
:'''keyword =''' NSTA | |||
:'''input =''' [[ocean.in]] | |||
;<span id="Nstation"></span>Nstation | ;<span id="Nstation"></span>Nstation | ||
Line 353: | Line 583: | ||
:'''input =''' [[stations.in]] | :'''input =''' [[stations.in]] | ||
;<span id="NT"></span> | ;<span id="NT"></span>NT | ||
:Total number of tracer-type variables for each nested grid. Currently, NT=[[#NAT|NAT]]+[[#NPT|NPT]]+[[#NST|NST]]+[[#NBT|NBT]]. | :Total number of tracer-type variables for each nested grid. Currently, NT=[[#NAT|NAT]]+[[#NPT|NPT]]+[[#NST|NST]]+[[#NBT|NBT]]. | ||
:'''dimension =''' '''NT'''([[#Ngrids|Ngrids]]) | :'''dimension =''' '''NT'''([[#Ngrids|Ngrids]]) | ||
Line 360: | Line 590: | ||
:'''input =''' [[ocean.in]] (derived from [[#NAT|NAT]]+[[#NPT|NPT]]+[[#NST|NST]]+[[#NBT|NBT]]) | :'''input =''' [[ocean.in]] (derived from [[#NAT|NAT]]+[[#NPT|NPT]]+[[#NST|NST]]+[[#NBT|NBT]]) | ||
;<span id="NtileI"></span>[[NtileI]] | <section begin=NtileI />;<span id="NtileI"></span>[[NtileI]] | ||
:Number of domain partitions in the I-direction (ξ-coordinate). It must be equal to or greater than one. | :Number of domain partitions in the I-direction (ξ-coordinate). It must be equal to or greater than one. [[#Ngrids|Ngrids]] values are expected. | ||
:'''dimension =''' '''NtileI'''([[#Ngrids|Ngrids]]) | :'''dimension =''' '''NtileI'''([[#Ngrids|Ngrids]]) | ||
:'''option =''' | :'''option =''' | ||
:'''routine =''' [[mod_param.F]] | :'''routine =''' [[mod_param.F]] | ||
:'''keyword =''' NtileI | :'''keyword =''' NtileI | ||
:'''input =''' [[ocean.in]] | :'''input =''' [[ocean.in]]<section end=NtileI /> | ||
;<span id="NtileJ"></span>[[NtileJ]] | <section begin=NtileJ />;<span id="NtileJ"></span>[[NtileJ]] | ||
:Number of domain partitions in the J-direction (η-coordinate). It must be equal to or greater than one. | :Number of domain partitions in the J-direction (η-coordinate). It must be equal to or greater than one. [[#Ngrids|Ngrids]] values are expected. | ||
:'''dimension =''' '''NtileJ'''([[#Ngrids|Ngrids]]) | :'''dimension =''' '''NtileJ'''([[#Ngrids|Ngrids]]) | ||
:'''option =''' | :'''option =''' | ||
:'''routine =''' [[mod_param.F]] | :'''routine =''' [[mod_param.F]] | ||
:'''keyword =''' NtileJ | :'''keyword =''' NtileJ | ||
:'''input =''' [[ocean.in]] | :'''input =''' [[ocean.in]]<section end=NtileJ /> | ||
<section begin=ntimes />;<span id="ntimes"></span> | <section begin=ntimes />;<span id="ntimes"></span>[[ntimes]] | ||
:Total number time-steps in current run. If 3D configuration, ntimes is the total of baroclinic time-steps. If only 2D configuration, ntimes is the total of barotropic time-steps. | :Total number time-steps in current run. If 3D configuration, ntimes is the total of baroclinic time-steps. If only 2D configuration, ntimes is the total of barotropic time-steps. | ||
:'''option =''' | :'''option =''' | ||
Line 383: | Line 613: | ||
:'''input =''' [[ocean.in]]<section end=ntimes /> | :'''input =''' [[ocean.in]]<section end=ntimes /> | ||
;<span id=" | ;<span id="ntsAVG"></span>ntsAVG | ||
:Starting time-step for the accumulation of output time-averaged data. [[#Ngrids|Ngrids]] values are expected. | |||
:'''dimension =''' '''ntsAVG'''([[#Ngrids|Ngrids]]) | |||
:'''routine =''' [[mod_scalars.F]] | |||
:'''keyword =''' NTSAVG | |||
:'''input =''' [[ocean.in]] | |||
;<span id="ntsDIA"></span>ntsDIA | |||
:Starting time-step for the accumulation of output time-averaged diagnostics data. [[#Ngrids|Ngrids]] values are expected. | |||
:'''dimension =''' '''ntsDIA'''([[#Ngrids|Ngrids]]) | |||
:'''routine =''' [[mod_scalars.F]] | |||
:'''keyword =''' NTSDIA | |||
:'''input =''' [[ocean.in]] | |||
;<span id="NV"></span>NV | |||
:Maximum number of variables in information arrays. Currently, 500. | :Maximum number of variables in information arrays. Currently, 500. | ||
:'''option =''' | :'''option =''' | ||
Line 392: | Line 636: | ||
==<span class="alphabet">P</span>== | ==<span class="alphabet">P</span>== | ||
;<span id="pros"></span>poros | |||
:Porosity for cohesive and non-cohesive sediment. | |||
:'''dimension =''' '''poros'''([[#NST|NST]],[[#Ngrids|Ngrids]]) | |||
:'''option = ''' [[Options#SEDIMENT|SEDIMENT]] | |||
:'''routine =''' [[mod_ocean.F]], [[mod_sediment.F]] | |||
:'''keywords =''' MUD_POROS, SAND_POROS | |||
:'''input =''' [[sediment.in]] | |||
==<span class="alphabet">Q</span>== | ==<span class="alphabet">Q</span>== | ||
Line 397: | Line 649: | ||
==<span class="alphabet">R</span>== | ==<span class="alphabet">R</span>== | ||
;<span id="rho"></span> | ;<span id="rho"></span>rho | ||
:''In situ'' density anomaly computed as a function of potential temperature, salinity, and depth. | :''In situ'' density anomaly computed as a function of potential temperature, salinity, and depth. | ||
::<math>\,\sigma(\xi,\eta,s) = \rho(\xi,\eta,s) - 1000</math>. | ::<math>\,\sigma(\xi,\eta,s) = \rho(\xi,\eta,s) - 1000</math>. | ||
Line 411: | Line 663: | ||
==<span class="alphabet">S</span>== | ==<span class="alphabet">S</span>== | ||
;<span id="Sd50"></span>Sd50 | |||
:Median grain diameter for cohesive and non-cohesive sediment. | |||
:'''dimension =''' '''Sd50'''([[#NST|NST]],[[#Ngrids|Ngrids]]) | |||
:'''units =''' millimeters | |||
:'''option = ''' [[Options#SEDIMENT|SEDIMENT]] | |||
:'''routine =''' [[mod_ncparam.F]], [[mod_ocean.F]], [[mod_sediment.F]] | |||
:'''keywords =''' MUD_SD50, SAND_SD50 | |||
:'''input =''' [[sediment.in]] | |||
<section begin=Sout />;<span id="Sout"></span>[[Sout]] | <section begin=Sout />;<span id="Sout"></span>[[Sout]] | ||
Line 426: | Line 687: | ||
:'''keyword =''' SPOSNAM | :'''keyword =''' SPOSNAM | ||
:'''input =''' [[ocean.in]] | :'''input =''' [[ocean.in]] | ||
;<span id="Srho"></span>Srho | |||
:Sediment grain density for cohesive and non-cohesive sediment. | |||
:'''dimension =''' '''Srho'''([[#NST|NST]],[[#Ngrids|Ngrids]]) | |||
:'''units =''' kilograms meter<sup>-3</sup> | |||
:'''option = ''' [[Options#SEDIMENT|SEDIMENT]] | |||
:'''routine =''' [[mod_sediment.F]] | |||
:'''keywords =''' MUD_SRHO, SAND_SRHO | |||
:'''input =''' [[sediment.in]] | |||
;<span id="STAname"></span>STAname | ;<span id="STAname"></span>STAname | ||
:Output station data file name. | :Output station data file name. [[#Ngrids|Ngrids]] values are expected. | ||
:'''dimension =''' '''STAname'''([[#Ngrids|Ngrids]]) | :'''dimension =''' '''STAname'''([[#Ngrids|Ngrids]]) | ||
:'''option = ''' | :'''option = ''' | ||
Line 437: | Line 707: | ||
==<span class="alphabet">T</span>== | ==<span class="alphabet">T</span>== | ||
;<span id="t"></span> | ;<span id="t"></span>t | ||
:Tracer-type variables, <math>\,T(\xi,\eta,s,t,itrc)</math>. | :Tracer-type variables, <math>\,T(\xi,\eta,s,t,itrc)</math>. | ||
:'''dimension =''' '''t'''([[#LBi|LBi]]:[[#UBi|UBi]],[[#LBj|LBj]]:[[#UBj|UBj]],[[#N|N(ng)]],3,[[#NT|NT(ng)]]) | :'''dimension =''' '''t'''([[#LBi|LBi]]:[[#UBi|UBi]],[[#LBj|LBj]]:[[#UBj|UBj]],[[#N|N(ng)]],3,[[#NT|NT(ng)]]) | ||
Line 481: | Line 751: | ||
|- | |- | ||
|} | |} | ||
;<span id="tau_cd"></span>tau_cd | |||
:Kinematic critical shear for deposition of cohesive and non-cohesive sediment. This is ignored for cohesive sediment. | |||
:'''dimension =''' '''tau_cd'''([[#NST|NST]],[[#Ngrids|Ngrids]]) | |||
:'''units =''' Newton meter<sup>-2</sup> | |||
:'''option = ''' [[Options#SEDIMENT|SEDIMENT]] | |||
:'''routine =''' [[mod_sediment.F]] | |||
:'''keywords =''' MUD_TAU_CD, SAND_TAU_CD | |||
:'''input =''' [[sediment.in]] | |||
;<span id="tau_ce"></span>tau_ce | |||
:Kinematic critical shear for erosion of cohesive and non-cohesive sediment. | |||
:'''dimension =''' '''tau_ce'''([[#NST|NST]],[[#Ngrids|Ngrids]]) | |||
:'''units =''' Newton meter<sup>-2</sup> | |||
:'''option = ''' [[Options#SEDIMENT|SEDIMENT]] | |||
:'''routine =''' [[mod_sediment.F]] | |||
:'''keywords =''' MUD_TAU_CE, SAND_TAU_CE | |||
:'''input =''' [[sediment.in]] | |||
<section begin=tide_start />;<span id="tide_start"></span>[[tide_start]] | <section begin=tide_start />;<span id="tide_start"></span>[[tide_start]] | ||
Line 500: | Line 788: | ||
:'''keyword =''' TITLE | :'''keyword =''' TITLE | ||
:'''input =''' [[ocean.in]] | :'''input =''' [[ocean.in]] | ||
;<span id="tnu2"></span>tnu2 | |||
:Lateral harmonic constant mixing coefficient for tracer type variables. If variable horizontal diffusion is activated, <span class="blue">tnu2</span> is the mixing coefficient for the largest grid-cell in the domain. | |||
:'''dimension =''' '''tnu2'''([[#MT|MT]],[[#Ngrids|Ngrids]]) | |||
:'''units =''' meter<sup>2</sup> second<sup>-1</sup> | |||
:'''option = ''' [[Options#SEDIMENT|SEDIMENT]], [[Options#BIOLOGY|BIOLOGY]] | |||
:'''routine =''' [[mod_mixing.F]], [[mod_scalars.F]] | |||
:'''keywords =''' MUD_TNU2, SAND_TNU2, TNU2 | |||
:'''input =''' [[biology.in]], [[sediment.in]] | |||
;<span id="tnu4"></span>tnu4 | |||
:Square root lateral biharmonic constant mixing coefficient for tracer type variables. If variable horizontal diffusion is activated, <span class="blue">tnu4</span> is the mixing coefficient for the largest grid-cell in the domain. | |||
:'''dimension =''' '''tnu4'''([[#MT|MT]],[[#Ngrids|Ngrids]]) | |||
:'''units =''' meter<sup>4</sup> second<sup>-1</sup> | |||
:'''option = ''' [[Options#SEDIMENT|SEDIMENT]], [[Options#BIOLOGY|BIOLOGY]] | |||
:'''routine =''' [[mod_mixing.F]], [[mod_scalars.F]] | |||
:'''keywords =''' MUD_TNU4, SAND_TNU4, TNU4 | |||
:'''input =''' [[biology.in]], [[sediment.in]] | |||
;<span id="Tnudg"></span>Tnudg | |||
:Inverse time-scale for nudging tracers at open boundaries and sponge areas. | |||
:'''dimension =''' '''Tnudg'''([[#MT|MT]],[[#Ngrids|Ngrids]]) | |||
:'''option = ''' [[Options#SEDIMENT|SEDIMENT]], [[Options#BIOLOGY|BIOLOGY]] | |||
:'''routine =''' [[mod_scalars.F]] | |||
:'''keywords =''' MUD_TNUDG, SAND_TNUDG, TNUDG | |||
:'''input =''' [[biology.in]], [[sediment.in]] | |||
==<span class="alphabet">U</span>== | ==<span class="alphabet">U</span>== | ||
;<span id="UBi"></span> | ;<span id="UBi"></span>UBi | ||
:Array upper bound dimension in the '''i'''-direction. In serial and shared-memory applications its value is govern by the value of UPPER_BOUND_I. In distributed-memory its value is a function of the tile partition, '''UBi'''=[[#Iend|Iend]]+[[#NghostPoints|NghostPoints]]. | :Array upper bound dimension in the '''i'''-direction. In serial and shared-memory applications its value is govern by the value of UPPER_BOUND_I. In distributed-memory its value is a function of the tile partition, '''UBi'''=[[#Iend|Iend]]+[[#NghostPoints|NghostPoints]]. | ||
:'''option =''' [[Options#UPPER_BOUND_I | UPPER_BOUND_I]] | :'''option =''' [[Options#UPPER_BOUND_I | UPPER_BOUND_I]] | ||
:'''routine =''' [[get_bounds.F]], [[get_tile.F]] | :'''routine =''' [[get_bounds.F]], [[get_tile.F]] | ||
;<span id="UBj"></span> | ;<span id="UBj"></span>UBj | ||
:Array upper bound dimension in the '''j'''-direction. In serial and shared-memory applications its value is govern by the value of UPPER_BOUND_J. In distributed-memory its value is a function of the tile partition, '''UBj'''=[[#Jend|Jend]]+[[#NghostPoints|NghostPoints]]. | :Array upper bound dimension in the '''j'''-direction. In serial and shared-memory applications its value is govern by the value of UPPER_BOUND_J. In distributed-memory its value is a function of the tile partition, '''UBj'''=[[#Jend|Jend]]+[[#NghostPoints|NghostPoints]]. | ||
:'''option =''' [[Options#UPPER_BOUND_J | UPPER_BOUND_J]] | :'''option =''' [[Options#UPPER_BOUND_J | UPPER_BOUND_J]] | ||
:'''routine =''' [[get_bounds.F]], [[get_tile.F]] | :'''routine =''' [[get_bounds.F]], [[get_tile.F]] | ||
;<span id="u"></span> | ;<span id="u"></span>u | ||
:Total momentum component in the ξ-direction, <math>\,u(\xi,\eta,s,t)</math>. | :Total momentum component in the ξ-direction, <math>\,u(\xi,\eta,s,t)</math>. | ||
:'''dimension =''' '''u'''([[#LBi|LBi]]:[[#UBi|UBi]],[[#LBj|LBj]]:[[#UBj|UBj]],[[#N|N(ng)]],2) | :'''dimension =''' '''u'''([[#LBi|LBi]]:[[#UBi|UBi]],[[#LBj|LBj]]:[[#UBj|UBj]],[[#N|N(ng)]],2) | ||
Line 524: | Line 838: | ||
:'''routine =''' [[step3d_uv.F]] | :'''routine =''' [[step3d_uv.F]] | ||
;<span id="ubar"></span> | ;<span id="ubar"></span>ubar | ||
:Vertically-integrated momentum component in the ξ-direction, <math>\bar u(\xi,\eta,t)</math>. | :Vertically-integrated momentum component in the ξ-direction, <math>\bar u(\xi,\eta,t)</math>. | ||
::<math>\bar u = \frac{1}{D} \int_{-h}^{\zeta} u\,H_z\,dz</math> | ::<math>\bar u = \frac{1}{D} \int_{-h}^{\zeta} u\,H_z\,dz</math> | ||
Line 537: | Line 851: | ||
==<span class="alphabet">V</span>== | ==<span class="alphabet">V</span>== | ||
;<span id="v"></span> | ;<span id="v"></span>v | ||
:3D momentum component in the η-direction, <math>\,v(\xi,\eta,s,t)</math>. | :3D momentum component in the η-direction, <math>\,v(\xi,\eta,s,t)</math>. | ||
:'''dimension =''' '''v'''([[#LBi|LBi]]:[[#UBi|UBi]],[[#LBj|LBj]]:[[#UBj|UBj]],[[#N|N(ng)]],2) | :'''dimension =''' '''v'''([[#LBi|LBi]]:[[#UBi|UBi]],[[#LBj|LBj]]:[[#UBj|UBj]],[[#N|N(ng)]],2) | ||
Line 566: | Line 880: | ||
==<span class="alphabet">W</span>== | ==<span class="alphabet">W</span>== | ||
;<span id="W"></span> | ;<span id="W"></span>W | ||
:Terrain-following, vertical velocity component, <math>\,\Omega(\xi,\eta,s)\,Hz/mn</math>. | :Terrain-following, vertical velocity component, <math>\,\Omega(\xi,\eta,s)\,Hz/mn</math>. | ||
:'''dimension =''' '''W'''([[#LBi|LBi]]:[[#UBi|UBi]],[[#LBj|LBj]]:[[#UBj|UBj]],[[#N|0:N(ng)]]) | :'''dimension =''' '''W'''([[#LBi|LBi]]:[[#UBi|UBi]],[[#LBj|LBj]]:[[#UBj|UBj]],[[#N|0:N(ng)]]) | ||
Line 578: | Line 892: | ||
:'''routine =''' [[omega.F]] | :'''routine =''' [[omega.F]] | ||
;<span id="Wsed"></span>Wsed | |||
:Particle settling velocity for cohesive and non-cohesive sediment. | |||
:'''option = ''' | :'''dimension =''' '''Wsed'''([[#NST|NST]],[[#Ngrids|Ngrids]]) | ||
:'''routine =''' [[ | :'''option = ''' [[Options#SEDIMENT|SEDIMENT]] | ||
:''' | :'''routine =''' [[mod_ncparam.F]], [[mod_ocean.F]], [[mod_sediment.F]] | ||
:'''input =''' [[ | :'''keywords =''' MUD_WSED, SAND_WSED | ||
:'''input =''' [[sediment.in]] | |||
;<span id="wvel"></span> | ;<span id="wvel"></span>wvel | ||
:True vertical velocity component, <math>\,w(\xi,\eta,s)</math>. It is computed only for output purposes. | :True vertical velocity component, <math>\,w(\xi,\eta,s)</math>. It is computed only for output purposes. | ||
:'''dimension =''' '''wvel'''([[#LBi|LBi]]:[[#UBi|UBi]],[[#LBj|LBj]]:[[#UBj|UBj]],[[#N|0:N(ng)]]) | :'''dimension =''' '''wvel'''([[#LBi|LBi]]:[[#UBi|UBi]],[[#LBj|LBj]]:[[#UBj|UBj]],[[#N|0:N(ng)]]) | ||
Line 601: | Line 916: | ||
==<span class="alphabet">Z</span>== | ==<span class="alphabet">Z</span>== | ||
;<span id="zeta"></span> | ;<span id="zeta"></span>zeta | ||
:Free-surface, <math>\,\zeta(\xi,\eta,t)</math>. | :Free-surface, <math>\,\zeta(\xi,\eta,t)</math>. | ||
:'''dimension =''' '''zeta'''([[#LBi|LBi]]:[[#UBi|UBi]],[[#LBj|LBj]]:[[#UBj|UBj]],3) | :'''dimension =''' '''zeta'''([[#LBi|LBi]]:[[#UBi|UBi]],[[#LBj|LBj]]:[[#UBj|UBj]],3) | ||
Line 611: | Line 926: | ||
:'''routine =''' [[step2d.F]] | :'''routine =''' [[step2d.F]] | ||
;<span id="z_r"></span> | ;<span id="z_r"></span>z_r | ||
:Actual depths of variables at ρ-points, <math>\,Z_r(\xi,\eta,s)</math>. | :Actual depths of variables at ρ-points, <math>\,Z_r(\xi,\eta,s)</math>. | ||
:'''dimension =''' '''z_r'''([[#LBi|LBi]]:[[#UBi|UBi]],[[#LBj|LBj]]:[[#UBj|UBj]],[[#N|N(ng)]]) | :'''dimension =''' '''z_r'''([[#LBi|LBi]]:[[#UBi|UBi]],[[#LBj|LBj]]:[[#UBj|UBj]],[[#N|N(ng)]]) | ||
Line 621: | Line 936: | ||
:'''routine =''' [[set_depths.F]] | :'''routine =''' [[set_depths.F]] | ||
;<span id="z_w"></span> | ;<span id="z_w"></span>z_w | ||
:Actual depths of variables at w-points, <math>\,Z_w(\xi,\eta,s)</math>. | :Actual depths of variables at w-points, <math>\,Z_w(\xi,\eta,s)</math>. | ||
:'''dimension =''' '''z_w'''([[#LBi|LBi]]:[[#UBi|UBi]],[[#LBj|LBj]]:[[#UBj|UBj]],[[#N|0:N(ng)]]) | :'''dimension =''' '''z_w'''([[#LBi|LBi]]:[[#UBi|UBi]],[[#LBj|LBj]]:[[#UBj|UBj]],[[#N|0:N(ng)]]) |
Revision as of 20:02, 16 April 2008
Variables
This wikipage includes all ROMS global variables in alphabetic order. A single long page is built to facilitate printing. Each variable has a unique anchor tag to facilitate linking from any wikipage.
Contents | |||||||||||||||||||||||||
A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z |
A
- Akt_bak
- Background vertical mixing coefficient.
- dimension = Akt_bak(MT,Ngrids)
- units = meters2 second-1
- option = BIOLOGY, SEDIMENT
- routine = mod_mixing.F, mod_scalars.F
- keywords = AKT_BAK, MUD_AKT_BAK, SAND_AKT_BAK
- input = biology.in, sediment.in
B
C
- Csed
- Sediment concentration used in analytical initial conditions. It is used to initialize full 3D cohesive and non-cohesive constant (homogeneous) concentrations of sediment.
- dimension = Csed(NST,Ngrids)
- units = kilograms meter-3
- option = SEDIMENT
- routine = mod_sediment.F
- keywords = MUD_CSED, SAND_CSED
- input = sediment.in
D
- dstart
- Time stamp assigned to model initialization (days). Usually a Calendar linear coordinate, like modified Julian Day.
- option =
- routine = mod_scalars.F
- keyword = DSTART
- input = ocean.in
- dt
- Time-Step size in seconds. If 3D configuration, dt is the size of the baroclinic time-step. If only 2D configuration, dt is the size of the barotropic time-step. Ngrids values are expected.
- dimension = dt(Ngrids)
- option =
- routine = mod_scalars.F
- keyword = DT
- input = ocean.in
- Dwave
- wind-induced wave direction. Direction the waves are coming from; measured clockwise from geographic North. (nautical convention).
- dimension = Dwave(LBi:UBi,LBj:UBj)
- pointer = FORCES(ng)%Dwave
- units = degrees
- grid = rho-points
- option =
- routine = ssw_bbl.h, mb_bbl.h, sg_bbl.h, ana_wwave.h, radiation_stress.F
E
- Erate
- Surface erosion rate for cohesive and non-cohesive sediment.
- dimension = Erate(NST,Ngrids)
- units = kilograms meter-2 second-1
- option = SEDIMENT
- routine = mod_sediment.F
- keywords = MUD_ERATE, SAND_ERATE
- input = sediment.in
- ERstr
- Starting ensemble run (perturbation or iteration) number.
- option =
- routine = mod_scalars.F
- keyword = ERstr
- input = ocean.in
- ERend
- Ending ensemble run (perturbation or iteration) number.
- option =
- routine = mod_scalars.F
- keyword = ERend
- input = ocean.in
F
- Fcoor
- Initial horizontal location (Fx0 and Fy0) coordinate type. If Fcoor = 0 then rho grid points are used. If Fcoor = 1 then location is given in latitude and longitude. Fcoor is column C in the POS specification at the end of the floats.in file.
- option = FLOATS
- routine = inp_par.F
- input = floats.in
- Fcount
- Number of floats to be released at the specified (Fx0,Fy0,Fz0) location. It must be equal or greater than one. If Fcount is greater than one, a cluster distribution of floats centered at (Fx0,Fy0,Fz0) is activated. The total number of floats trajectories to compute must add up to NFLOATS. Fcount is column N in the POS specification at the end of the floats.in file.
- option = FLOATS
- routine = inp_par.F
- input = floats.in
- Fdt
- Float cluster release time interval in days. This is only used if Fcount is greater than 1. If Fdt gt; 0 a cluster of floats will be deployed from (Fx0,Fy0,Fz0) at Fdt intervals until Fcount floats are released. If Fdt = 0 Fcount floats will be deployed simultaneously with a distribution centered at (Fx0,Fy0,Fz0) and defined by (Fdx,Fdy,Fdz). This value must be of type real (i.e. 5.d0).
- option = FLOATS
- routine = inp_par.F
- input = floats.in
- Fdx
- Cluster x-distribution parameter. This is only used if Fcount is greater than 1 and Fdt = 0. This value must be of type real (i.e. 5.d0).
- option = FLOATS
- routine = inp_par.F
- input = floats.in
- Fdy
- Cluster y-distribution parameter. This is only used if Fcount is greater than 1 and Fdt = 0. This value must be of type real (i.e. 5.d0).
- option = FLOATS
- routine = inp_par.F
- input = floats.in
- Fdz
- Cluster z-distribution parameter. This is only used if Fcount is greater than 1 and Fdt = 0. This value must be of type real (i.e. 5.d0).
- option = FLOATS
- routine = inp_par.F
- input = floats.in
- FLTname
- Output floats data file name. Ngrids values are expected.
- dimension = FLTname(Ngrids)
- option =
- routine = mod_iounits.F
- keyword = FLTNAME
- input = ocean.in
- fposnam
- Input initial floats positions file name (floats.in).
- option = FLOATS
- routine = mod_iounits.F
- keyword = FPOSNAM
- input = ocean.in
- frrec
- Flag to indicate re-start from a previous solution. Ngrids values are expected. For new solutions (not a model restart) use frrec = 0. In a re-start solution, frrec is the time index in the floats NetCDF file assigned for initialization. If frrec is negative (say frrec = -1), the floats will re-start from the most recent time record. That is, the initialization record is assigned internally.
- dimension = frrec(Ngrids)
- option = FLOATS
- routine = mod_scalars.F
- keyword = FRREC
- input = floats.in
- Ft0
- Time, in days, of float release after model initialization. This value must be of type real (i.e. 0.d0).
- option = FLOATS
- routine = inp_par.F
- input = floats.in
- Ftype
- Float trajectory type. If Ftype = 1, float(s) will be neutral density 3D Lagrangian particles. If Ftype = 2, float(s) will be isobaric (constant depth) particles.
- option = FLOATS
- routine = inp_par.F
- input = floats.in
- Fx0
- Initial float(s) x-location in grid units or longitude depending on the value of Fcoor. This value must be of type real (i.e. 5.d0).
- option = FLOATS
- routine = inp_par.F
- input = floats.in
- Fy0
- Initial float(s) y-location in grid units or longitude depending on the value of Fcoor. This value must be of type real (i.e. 5.d0).
- option = FLOATS
- routine = inp_par.F
- input = floats.in
- Fz0
- Initial float(s) z-location in vertical levels or depth. If Fz0 is less than or equal to zero then Fz0 is the initial depth in meters. If Fz0 is greater than 0 and less than N(ng) the initial position is relative to the W grid (0 is the bottom and N is the surface). This value must be of type real (i.e. -45.d0).
- option = FLOATS
- routine = inp_par.F
- input = floats.in
G
H
- Hout
- Set of switches that determine what fields are written to the history output file (HISname).
- dimension = Hout(NV,Ngrids)
- option =
- routine = mod_ncparam.F
- keyword = Hout
- input = ocean.in
- HISname
- Output history data file name. Ngrids values are expected.
- dimension = HISname(Ngrids)
- option =
- routine = mod_iounits.F
- keyword = HISNAME
- input = ocean.in
- Hz
- Vertical level thicknesses, .
- dimension = Hz(LBi:UBi,LBj:UBj,N(ng))
- pointer = GRID(ng)%Hz
- tangent = tl_Hz
- adjoint = ad_Hz
- units = meter
- grid = ρ-points
- option = SOLVE3D
- routine = set_depths.F
I
- Iend
- Non-overlapping upper bound tile index in the i-direction. Its value depends on the tile rank (sub-domain partition).
- routine = tile.h, get_tile.F
- Istr
- Non-overlapping lower bound tile index in the i-direction. Its value depends on the tile rank (sub-domain partition).
- routine = tile.h, get_tile.F
- idbio
- Identification indexes for biological tracer variables, t(:,:,:,:,idbio(:)).
- dimension = idbio(NBT)
- option = BIOLOGY
- routine = mod_scalars.F
- idsed
- Identification indexes for biological tracer variables, t(:,:,:,:,idsed(:)).
- dimension = idsed(NST)
- option = SEDIMENT
- routine = mod_scalars.F
- inert
- Identification indexes for inert tracer variables, t(:,:,:,:,inert(:)).
- dimension = inert(NPT)
- option = T_PASSIVE
- routine = mod_scalars.F
- isalt
- Tracer identification index for salinity, t(:,:,:,:,isalt).
- routine = mod_scalars.F
- itemp
- Tracer identification index for potential temperature, t(:,:,:,:,itemp).
- routine = mod_scalars.F
J
- Jend
- Non-overlapping upper bound tile index in the j-direction. Its value depends on the tile rank (sub-domain partition).
- routine = tile.h, get_tile.F
- Jstr
- Non-overlapping lower bound tile index in the j-direction. Its value depends on the tile rank (sub-domain partition).
- routine = tile.h, get_tile.F
- Jwtype
- Jerlov water type: an integer value from 1 to 5.
- option =
- routine = mod_mixing.F
- keyword = WTYPE
- input = ocean.in
K
L
- LBi
- Array lower bound dimension in the i-direction. In serial and shared-memory applications its value is LBi = -2 for East-West periodic grids or LBi = 0 for non-periodic grids . In distributed-memory its value is a function of the tile partition, LBi = Istr - NghostPoints.
- option = LOWER_BOUND_I
- routine = get_bounds.F, get_tile.F
- LBj
- Array lower bound dimension in the j-direction. In serial and shared-memory applications its value is LBj = -2 for North-South periodic grids or LBj = 0 for non-periodic grids . In distributed-memory its value is a function of the tile partition, LBj = Jstr - NghostPoints.
- option = LOWER_BOUND_J
- routine = get_bounds.F, get_tile.F
- LcycleRST
- Logical switch(s) (T/F) used to recycle time records in output re-start file. Ngrids values are expected. If TRUE, only the latest two re-start time records are maintained. If FALSE, all re-start fields are saved every nRST time-steps without recycling. The re-start fields are written at all levels in double precision unless the RST_SINGLE CPP option is activated.
- dimension = LcycleRST(Ngrids)
- option = PERFECT_RESTART, RST_SINGLE
- routine = mod_scalars.F
- keyword = LcycleRST
- input = ocean.in
- LcycleTLM
- Logical switch(s) (T/F) used to recycle time records in output tangent linear file. Ngrids values are expected. If TRUE, only the latest two re-start time records are maintained. If FALSE, all tangent linear fields are saved every nTLM time-steps without recycling.
- dimension = LcycleTLM(Ngrids)
- option =
- routine = mod_scalars.F
- keyword = LcycleTLM
- input = ocean.in
- ldefout
- Logical switch(s) (T/F) used to create new output files when initializing from a re-start file, |nrrec| > 0. Ngrids values are expected. If TRUE and applicable, a new history, average, diagnostic and station files are created during the initialization stage. If FALSE and applicable, data is appended to existing history, average, diagnostic and station files. See also parameters ndefHIS, ndefAVG and ndefDIA.
- dimension = ldefout(Ngrids)
- option = PERFECT_RESTART
- routine = mod_scalars.F
- keyword = LcycleRST
- input = ocean.in
- Lfloats
- Logical switch(s) (T/F) used to control the computation of floats trajectories within nested and/or multiple connected grids. Ngrids values are expected. By default this switch is set to TRUE in mod_scalars.F for all grids when the CPP option FLOATS is activated. The user can control which grids to process by turning on/off this switch.
- dimension = Lfloats(Ngrids)
- option = FLOATS
- routine = mod_scalars.F
- keyword = Lfloats
- input = floats.in
- Lm
- Number of interior grid points in the ξ-direction. Ngrids values are expected.
- dimension = Lm(Ngrids)
- routine = mod_param.F
- keyword = Lm
- input = ocean.in
- Lsediment
- Logical switch(s) (T/F) used to control sediment model computation within nested and/or multiple connected grids. Ngrids values are expected. By default this switch is set to TRUE in mod_scalars.F for all grids when the CPP option SEDIMENT is activated. The user can control which grids to process by turning on/off this switch.
- dimension = Lsediment(Ngrids)
- option = SEDIMENT
- routine = mod_scalars.F
- keyword = Lsediment
- input = sediment.in
- Lstations
- Logical switch(s) (T/F) used to control the writing of station data within nested and/or multiple connected grids. Ngrids values are expected. By default this switch is set to TRUE in mod_scalars.F for all grids when the CPP option STATIONS is activated. The user can control which grids to process by turning on/off this switch.
- dimension = Lstations(Ngrids)
- option = STATIONS
- routine = mod_scalars.F
- keyword = Lstations
- input = stations.in
M
- Mm
- Number of interior grid points in the η-direction. Ngrids values are expected.
- dimension = Mm(Ngrids)
- routine = mod_param.F
- keyword = Mm
- input = ocean.in
- morph_fac
- Morphological scale factor for cohesive and non-cohesive sediment.
- dimension = morph_fac(NST,Ngrids)
- option = SEDIMENT
- routine = mod_sediment.F
- keywords = MUD_MORPH_FAC, SAND_MORPH_FAC
- input = sediment.in
- MyAppCPP
- C-preprocessing flag to define the specific configuration. In versions up to 2.3 this flag was one of the predefined model applications that headed the cppdefs.h file. You must make the value of MyAppCPP consistent with variable ROMS_APPLICATION in the build script or makefile if you are not using build.sh or build.bash. ROMS converts the ROMS_APPLICATION variable to lowercase to determine the name of the file to include.
- keyword = MyAppCPP
- input = ocean.in
N
- N
- Number of vertical levels for each nested grid. Ngrids values are expected.
- dimension = N(Ngrids)
- routine = mod_param.F
- keyword = N
- input = ocean.in
- NAT
- Number of active tracer-type variables. Usually, it has a value of two for potential temperature and salinty.
- option = SOLVE3D
- routine = mod_param.F
- keyword = NAT
- input = ocean.in
- nAVG
- Number of time-steps between writing time-averaged data into averages file. Averaged date is written for all fields. Ngrids values are expected.
- dimension = nAVG(Ngrids)
- routine = mod_scalars.F
- keyword = NAVG
- input = ocean.in
- Nbed
- Number of sediment bed layers.
- routine = mod_param.F
- keyword = Nbed
- input = ocean.in
- NBT
- Number of biological tracer-type variables.
- option = BIOLOGY
- routine = mod_param.F
- keyword = NBT
- input = biology.in
- NCS
- Number of cohesive (mud) sediment tracer-type variables.
- option = SEDIMENT
- routine = mod_param.F
- keyword = NCS
- input = ocean.in
- NCV
- Number of eigenvectors to compute for the Lanczos/Arnoldi problem. NCV must be greater than NEV.
- option =
- routine = mod_storage.F
- keyword = NCV
- input = ocean.in
- ndefAVG
- Number of time-steps between the creation of new average file. If ndefAVG = 0, the model will only process one average file. This feature is useful for long simulations when average files get too large; it creates a new file every ndefAVG time-steps. Ngrids values are expected.
- dimension = ndefAVG(Ngrids)
- routine = mod_scalars.F
- keyword = NDEFAVG
- input = ocean.in
- ndefDIA
- Number of time-steps between the creation of new time-averaged diagnostics file. If ndefDIA = 0, the model will only process one diagnostics file. This feature is useful for long simulations when diagnostics files get too large; it creates a new file every ndefDIA time-steps. Ngrids values are expected.
- dimension = ndefDIA(Ngrids)
- routine = mod_scalars.F
- keyword = NDEFDIA
- input = ocean.in
- ndefHIS
- Number of time-steps between the creation of new history file. If ndefHIS = 0, the model will only process one history file. This feature is useful for long simulations when history files get too large; it creates a new file every ndefHIS time-steps. Ngrids values are expected.
- dimension = ndefHIS(Ngrids)
- routine = mod_scalars.F
- keyword = NDEFHIS
- input = ocean.in
- nDIA
- Number of time-steps between writing time-averaged diagnostics data into diagnostics file. Averaged date is written for all fields. Ngrids values are expected.
- dimension = nDIA(Ngrids)
- routine = mod_scalars.F
- keyword = NDIA
- input = ocean.in
- ndtfast
- Number of barotropic time-steps between each baroclinic time step. If only 2D configuration, ndtfast should be unity since there is no need to split time-stepping.
- option =
- routine = mod_scalars.F
- keyword = NDTFAST
- input = ocean.in
- NEV
- Number of eigenvalues to compute for the Lanczos/Arnoldi problem. Notice that the model memory requirement increases substantially as NEV increases. The GST requires NEV+1 copies of the model state vector. The memory requirements are decreased in distributed-memory applications.
- option =
- routine = mod_storage.F
- keyword = NEV
- input = ocean.in
- nFLT
- Number of time-steps between writing data into floats file (FLTname). Ngrids values are expected.
- dimension = nFLT(Ngrids)
- option = FLOATS
- routine = mod_scalars.F
- keyword = NFLT
- input = ocean.in
- Nfloats
- Number of floats to release in each nested grid. Value(s) are used to dynamically allocate the arrays in the Floats array structure. Ngrids values are expected.
- dimension = Nfloats(Ngrids)
- option = FLOATS
- routine = mod_floats.F init_param.F
- keyword = NFLOATS
- input = floats.in
- NghostPoints
- Number of ghost points in the halo region used in distributed-memory configurations.
- option = GHOST_POINTS
- routine = mod_param.F
- Ngrids
- Number of nested and/or multiple connected grids to solve.
- routine = mod_param.F
- nHIS
- Number of time-steps between writing fields into history file. Ngrids values are expected.
- dimension = nHIS(Ngrids)
- routine = mod_scalars.F
- keyword = NHIS
- input = ocean.in
- ninfo
- Number of time-steps between printing of single line information to standard output. It also determines the interval between the computation of global energy diagnostics. Ngrids values are expected.
- dimension = ninfo(Ngrids)
- option =
- routine = mod_scalars.F
- keyword = NINFO
- input = ocean.in
- Ninner
- Maximum number of 4DVAR inner loop iterations.
- option =
- routine = mod_scalars.F
- keyword = Ninner
- input = ocean.in
- Nintervals
- Number of time interval divisions for stochastic optimals computations. It must be a multiple of ntimes.
- option =
- routine = mod_scalars.F
- keyword = Nintervals
- input = ocean.in
- NNS
- Number of non-cohesive (sand) sediment tracer-type variables.
- option = SEDIMENT
- routine = mod_param.F
- keyword = NNS
- input = ocean.in
- Nouter
- Maximum number of 4DVAR outer loop iterations.
- option =
- routine = mod_scalars.F
- keyword = Nouter
- input = ocean.in
- NPT
- Number of inert tracer-type variables. Currently, an inert passive tracer is one that it is only advected and diffused. Other processes are ignored. These tracers include, for example, dyes, pollutants, oil spills, etc.
- option = T_PASSIVE
- routine = mod_param.F
- keyword = NPT
- input = ocean.in
- nrrec
- Switch(s) to indicate re-start from a previous solution. Ngrids values are expected. Use nrrec = 0 for new solutions. In a re-start solution, nrrec is the time index of the re-start NetCDF file assigned for initialization. If nrrec is negative (say nrrec = -1), the model will re-start from the most recent time record. That is, the initialization record is assigned internally. Notice that it is also possible to re-start from a history or time-averaged NetCDF file. If a history or time-averaged NetCDF file is used for re-start, it must contain all the necessary primitive variables at all levels.
- dimension = nrrec(Ngrids)
- option = PERFECT_RESTART
- routine = mod_scalars.F
- keyword = NRREC
- input = ocean.in
- nRST
- Number of time-steps between writing of re-start fields. Ngrids values are expected.
- dimension = nRST(Ngrids)
- option = PERFECT_RESTART
- routine = mod_scalars.F
- keyword = NRST
- input = ocean.in
- NST
- Number of sediment tracer-type variables, NST=NCS+NNS.
- option = SEDIMENT
- routine = mod_param.F
- nSTA
- Number of time-steps between writing data into stations file. Station data is written at all levels. Ngrids values are expected.
- dimension = nSTA(Ngrids)
- option = STATIONS
- routine = mod_scalars.F
- keyword = NSTA
- input = ocean.in
- Nstation
- Number of stations to process in each nested grid. Value(s) are used to dynamically allocate the station arrays. Ngrids values are expected.
- dimension = Nstation(Ngrids)
- option = STATIONS
- routine = mod_param.F
- keyword = NSTATION
- input = stations.in
- NT
- Total number of tracer-type variables for each nested grid. Currently, NT=NAT+NPT+NST+NBT.
- dimension = NT(Ngrids)
- option = SOLVE3D
- routine = mod_param.F
- input = ocean.in (derived from NAT+NPT+NST+NBT)
- NtileI
- Number of domain partitions in the I-direction (ξ-coordinate). It must be equal to or greater than one. Ngrids values are expected.
- dimension = NtileI(Ngrids)
- option =
- routine = mod_param.F
- keyword = NtileI
- input = ocean.in
- NtileJ
- Number of domain partitions in the J-direction (η-coordinate). It must be equal to or greater than one. Ngrids values are expected.
- dimension = NtileJ(Ngrids)
- option =
- routine = mod_param.F
- keyword = NtileJ
- input = ocean.in
- ntimes
- Total number time-steps in current run. If 3D configuration, ntimes is the total of baroclinic time-steps. If only 2D configuration, ntimes is the total of barotropic time-steps.
- option =
- routine = mod_scalars.F
- keyword = NTIMES
- input = ocean.in
- ntsAVG
- Starting time-step for the accumulation of output time-averaged data. Ngrids values are expected.
- dimension = ntsAVG(Ngrids)
- routine = mod_scalars.F
- keyword = NTSAVG
- input = ocean.in
- ntsDIA
- Starting time-step for the accumulation of output time-averaged diagnostics data. Ngrids values are expected.
- dimension = ntsDIA(Ngrids)
- routine = mod_scalars.F
- keyword = NTSDIA
- input = ocean.in
- NV
- Maximum number of variables in information arrays. Currently, 500.
- option =
- routine = mod_ncparam.F
- input = ocean.in
O
P
- poros
- Porosity for cohesive and non-cohesive sediment.
- dimension = poros(NST,Ngrids)
- option = SEDIMENT
- routine = mod_ocean.F, mod_sediment.F
- keywords = MUD_POROS, SAND_POROS
- input = sediment.in
Q
R
- rho
- In situ density anomaly computed as a function of potential temperature, salinity, and depth.
- .
- dimension = rho(LBi:UBi,LBj:UBj,N(ng))
- pointer = OCEAN(ng)%rho
- tangent = tl_rho
- adjoint = ad_rho
- units = kilogram meter-3
- grid = ρ-points
- option = SOLVE3D, NONLIN_EOS
- routine = rho_eos.F
- It can computed using a linear or nonlinear equation of state. The nonlinear equation of state is based on Jackett and McDougall (1992) polynomial expressions.
S
- Sd50
- Median grain diameter for cohesive and non-cohesive sediment.
- dimension = Sd50(NST,Ngrids)
- units = millimeters
- option = SEDIMENT
- routine = mod_ncparam.F, mod_ocean.F, mod_sediment.F
- keywords = MUD_SD50, SAND_SD50
- input = sediment.in
- Sout
- Set of switches that determine what fields are written to the stations output file (STAname).
- dimension = Sout(NV,Ngrids)
- option = STATIONS
- routine = mod_ncparam.F
- keyword = Sout
- input = stations.in
- sposnam
- Input initial stations positions (stations.in) file name.
- option = STATIONS
- routine = mod_iounits.F
- keyword = SPOSNAM
- input = ocean.in
- Srho
- Sediment grain density for cohesive and non-cohesive sediment.
- dimension = Srho(NST,Ngrids)
- units = kilograms meter-3
- option = SEDIMENT
- routine = mod_sediment.F
- keywords = MUD_SRHO, SAND_SRHO
- input = sediment.in
- STAname
- Output station data file name. Ngrids values are expected.
- dimension = STAname(Ngrids)
- option =
- routine = mod_iounits.F
- keyword = STANAME
- input = ocean.in
T
- t
- Tracer-type variables, .
- dimension = t(LBi:UBi,LBj:UBj,N(ng),3,NT(ng))
- pointer = OCEAN(ng)%t
- tangent = tl_t
- adjoint = ad_t
- grid = ρ-points
- option = SOLVE3D
- routine = step3d_t.F
- This array contains all the tracer fields. They are classified as active (potential temperature, salinity), inert (dyes, pollutants, oil spills, etc), passive (sediment, biology). There is a index identifier for each tracer field (see table below). Notice that salinity does not have physical units. Usually PSU is used to indicate that the practical salinity scale was used to determine conductivity.
Index | Field | Units | CPP |
---|---|---|---|
itemp | Potential temperature | Celsius | SOLVE3D |
isalt | Salinity | None | SALINITY |
inert(1:NPT) | NPT inert tracers | kilogram meter-3 | T_PASSIVE |
idsed(1:NST) | NST sediment tracers | kilogram meter-3 | SEDIMENT |
idbio(1:NBT) | NBT biology tracers | millimole meter-3 | BIOLOGY |
- tau_cd
- Kinematic critical shear for deposition of cohesive and non-cohesive sediment. This is ignored for cohesive sediment.
- dimension = tau_cd(NST,Ngrids)
- units = Newton meter-2
- option = SEDIMENT
- routine = mod_sediment.F
- keywords = MUD_TAU_CD, SAND_TAU_CD
- input = sediment.in
- tau_ce
- Kinematic critical shear for erosion of cohesive and non-cohesive sediment.
- dimension = tau_ce(NST,Ngrids)
- units = Newton meter-2
- option = SEDIMENT
- routine = mod_sediment.F
- keywords = MUD_TAU_CE, SAND_TAU_CE
- input = sediment.in
- tide_start
- Reference time origin for tidal forcing (days). This is the time used when processing input tidal model data. It is needed in routine set_tides.F to compute the correct phase lag with respect ROMS/TOMS initialization time.
- option =
- routine = mod_scalars.F
- keyword = TIDE_START
- input = ocean.in
- time_ref
- Reference time (yyyymmdd.f) used to compute relative time: elapsed time interval since reference-time.
- option =
- routine = mod_scalars.F
- keyword = TIME_REF
- input = ocean.in
- title
- Title of model run.
- keyword = TITLE
- input = ocean.in
- tnu2
- Lateral harmonic constant mixing coefficient for tracer type variables. If variable horizontal diffusion is activated, tnu2 is the mixing coefficient for the largest grid-cell in the domain.
- dimension = tnu2(MT,Ngrids)
- units = meter2 second-1
- option = SEDIMENT, BIOLOGY
- routine = mod_mixing.F, mod_scalars.F
- keywords = MUD_TNU2, SAND_TNU2, TNU2
- input = biology.in, sediment.in
- tnu4
- Square root lateral biharmonic constant mixing coefficient for tracer type variables. If variable horizontal diffusion is activated, tnu4 is the mixing coefficient for the largest grid-cell in the domain.
- dimension = tnu4(MT,Ngrids)
- units = meter4 second-1
- option = SEDIMENT, BIOLOGY
- routine = mod_mixing.F, mod_scalars.F
- keywords = MUD_TNU4, SAND_TNU4, TNU4
- input = biology.in, sediment.in
- Tnudg
- Inverse time-scale for nudging tracers at open boundaries and sponge areas.
- dimension = Tnudg(MT,Ngrids)
- option = SEDIMENT, BIOLOGY
- routine = mod_scalars.F
- keywords = MUD_TNUDG, SAND_TNUDG, TNUDG
- input = biology.in, sediment.in
U
- UBi
- Array upper bound dimension in the i-direction. In serial and shared-memory applications its value is govern by the value of UPPER_BOUND_I. In distributed-memory its value is a function of the tile partition, UBi=Iend+NghostPoints.
- option = UPPER_BOUND_I
- routine = get_bounds.F, get_tile.F
- UBj
- Array upper bound dimension in the j-direction. In serial and shared-memory applications its value is govern by the value of UPPER_BOUND_J. In distributed-memory its value is a function of the tile partition, UBj=Jend+NghostPoints.
- option = UPPER_BOUND_J
- routine = get_bounds.F, get_tile.F
- u
- Total momentum component in the ξ-direction, .
- dimension = u(LBi:UBi,LBj:UBj,N(ng),2)
- pointer = OCEAN(ng)%u
- tangent = tl_u
- adjoint = ad_u
- units = meter second-1
- grid = u-points
- option = SOLVE3D
- routine = step3d_uv.F
- ubar
- Vertically-integrated momentum component in the ξ-direction, .
- dimension = ubar(LBi:UBi,LBj:UBj,3)
- pointer = OCEAN(ng)%ubar
- tangent = tl_ubar
- adjoint = ad_ubar
- units = meter second-1
- grid = u-points
- routine = step2d.F
V
- v
- 3D momentum component in the η-direction, .
- dimension = v(LBi:UBi,LBj:UBj,N(ng),2)
- pointer = OCEAN(ng)%v
- tangent = tl_u
- adjoint = ad_u
- units = meter second-1
- grid = v-points
- option = SOLVE3D
- routine = step3d_uv.F
- varname
- Input variable information file name. This file needs to be processed first so all information arrays can be initialized properly. The default file is at ROMS/External/varinfo.dat.
- keyword = VARNAME
- input = ocean.in
- vbar
- Vertically-integrated momentum component in the η-direction, .
- dimension = vbar(LBi:UBi,LBj:UBj,3)
- pointer = OCEAN(ng)%vbar
- tangent = tl_vbar
- adjoint = ad_vbar
- units = meter second-1
- grid = v-points
- routine = step2d.F
W
- W
- Terrain-following, vertical velocity component, .
- dimension = W(LBi:UBi,LBj:UBj,0:N(ng))
- pointer = OCEAN(ng)%W
- tangent = tl_W
- adjoint = ad_W
- units = meter3 second-1
- sign = positive downwards (downwelling), negative upwards (upwelling)
- grid = w-points
- option = SOLVE3D
- routine = omega.F
- Wsed
- Particle settling velocity for cohesive and non-cohesive sediment.
- dimension = Wsed(NST,Ngrids)
- option = SEDIMENT
- routine = mod_ncparam.F, mod_ocean.F, mod_sediment.F
- keywords = MUD_WSED, SAND_WSED
- input = sediment.in
- wvel
- True vertical velocity component, . It is computed only for output purposes.
- dimension = wvel(LBi:UBi,LBj:UBj,0:N(ng))
- pointer = OCEAN(ng)%wvel
- units = meter second-1
- sign = positive downwards (downwelling), negative upwards (upwelling
- grid = w-points
- option = SOLVE3D
- routine = wvelocity.F
X
Y
Z
- zeta
- Free-surface, .
- dimension = zeta(LBi:UBi,LBj:UBj,3)
- pointer = OCEAN(ng)%zeta
- tangent = tl_zeta
- adjoint = ad_zeta
- units = meter
- grid = ρ-points
- routine = step2d.F