Difference between revisions of "stations.in"
From WikiROMS
Jump to navigationJump to searchm (Text replacement - "ocean.in" to "roms.in") (change visibility) |
|||
| (18 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
The <span class="red">stations.in</span> file sets the parameters and locations for stations output. The name of this file is set by the | <div class="title">Standard Input Script - <span class="red">stations.in</span></div> | ||
The <span class="red">stations.in</span> file sets the parameters and locations for stations output. The name of this file is set by the [[Variables#sposnam|SPOSNAM]] keyword in the [[roms.in]] file. This standard input ASCII file is organized in several sections as shown below, with links to more detailed explanation where required. | |||
{{note}} '''Notice:''' Detailed information about ROMS input script file syntax can be found [[Input Parameter Files|here]]. | {{note}} '''Notice:''' Detailed information about ROMS input script file syntax can be found [[Input Parameter Files|here]]. | ||
{{note}} '''Notice:''' A default <span class="red">stations.in</span> input script is provided in the '''User/External''' subdirectory. Also there are several stations input scripts in the '''ROMS/External''' subdirectory which are used in the distributed [[Test Cases|test cases]]. They are usually named <span class="red">stations_</span><span class="blue">app</span><span class="red">.in</span> where <span class="blue">app</span> is the lowercase of the test case [[Options| | {{note}} '''Notice:''' A default <span class="red">stations.in</span> input script is provided in the '''User/External''' subdirectory. Also there are several stations input scripts in the '''ROMS/External''' subdirectory which are used in the distributed [[Test Cases|test cases]]. They are usually named <span class="red">stations_</span><span class="blue">app</span><span class="red">.in</span> where <span class="blue">app</span> is the lowercase of the test case [[Options|CPP option]]. | ||
__TOC__ | |||
==Introduction== | ==Introduction== | ||
==Stations | This input file provides the positions of model station data to be extracted and written into [[STATIONS]] output NetCDF file. This file is used to monitor model fields at frequent time intervals. It is like putting a moored hydrographic station inside the model. It may be used to sample model at observation locations for inter-comparison analysis. It is also a good tool for debugging; a station can be put at a trouble spot to help find algorithm or set-up problems. It is like putting a print statement in the code to display the values of all variables at a particular location. | ||
==Stations Output Model Control Switches== | |||
*This switch is used to control the writing of stations data within nested and/or multiple connected grids, [1:[[Ngrids]]] values are expected. By default this switch is set to '''TRUE''' in | *This switch is used to control the writing of stations data within nested and/or multiple connected grids, [1:[[Ngrids]]] values are expected. By default this switch is set to '''TRUE''' in [[mod_scalars.F]] for all grids when the [[Options|CPP option]] [[STATIONS]] is activated. The '''user''' can control which grid to process by turning on/off this switch. | ||
:<div class="box"> [[Lstations]] == T</div> | :<div class="box"> [[Variables#Lstations|Lstations]] == T</div> | ||
*This set of switches determine what fields are written in the stations output file, [Sout(:,ng), ng=1, [[Ngrids]]]. Except for tracer type variables, [[Ngrids]] values are expected for all switches. | *This set of switches determine what fields are written in the stations output file, <nowiki>[</nowiki>[[Sout|Sout(:,ng)]], ng=1, [[Ngrids]]]. Except for tracer type variables, [[Ngrids]] values are expected for all switches. | ||
:<div class="box">[[ | :<div class="box">[[Sout|Sout(idUvel)]] == T ! u 3D U-velocity<br />[[Sout|Sout(idVvel)]] == T ! v 3D V-velocity<br />[[Sout|Sout(idu3dE)]] == F ! u_eastward 3D U-eastward at RHO-points<br />[[Sout|Sout(idv3dN)]] == F ! v_northward 3D V-nortward at RHO-points<br />[[Sout|Sout(idWvel)]] == T ! w 3D W-velocity<br />[[Sout|Sout(idOvel)]] == T ! omega 3D omega vertical velocity<br />[[Sout|Sout(idUbar)]] == T ! ubar 2D U-velocity<br />[[Sout|Sout(idVbar)]] == T ! vbar 2D V-velocity<br />[[Sout|Sout(idu2dE)]] == F ! u_eastward 2D U-eastward at RHO-points<br />[[Sout|Sout(idv2dN)]] == F ! v_northward 2D V-nortward at RHO-points<br />[[Sout|Sout(idFsur)]] == T ! zeta free-surface<br />[[Sout|Sout(idBath)]] == T ! bath time-dependent bathymetry<br /><br />[[Sout|Sout(idTvar)]] == T T ! temp, salt, ... all (NT) tracers<br /><br />[[Sout|Sout(idUsms)]] == T ! sustr surface U-stress<br />[[Sout|Sout(idVsms)]] == T ! svstr surface V-stress<br />[[Sout|Sout(idUbms)]] == T ! bustr bottom U-stress<br />[[Sout|Sout(idVbms)]] == T ! bvstr bottom V-stress<br /><br />[[Sout|Sout(idUbrs)]] == T ! bustrc bottom U-current stress<br />[[Sout|Sout(idVbrs)]] == T ! bvstrc bottom V-current stress<br />[[Sout|Sout(idUbws)]] == T ! bustrw bottom U-wave stress<br />[[Sout|Sout(idVbws)]] == T ! bvstrw bottom V-wave stress<br />[[Sout|Sout(idUbcs)]] == T ! bustrcwmax bottom max wave-current U-stress<br />[[Sout|Sout(idVbcs)]] == T ! bvstrcwmax bottom max wave-current V-stress<br /><br />[[Sout|Sout(idUbot)]] == T ! Ubot bed wave orbital U-velocity<br />[[Sout|Sout(idVbot)]] == T ! Vbot bed wave orbital V-velocity<br />[[Sout|Sout(idUbur)]] == T ! Ur bottom U-velocity above bed<br />[[Sout|Sout(idVbvr)]] == T ! Vr bottom V-velocity above bed<br /><br />[[Sout|Sout(idW2xx)]] == F ! Sxx_bar 2D radiation stress, Sxx component<br />[[Sout|Sout(idW2xy)]] == F ! Sxy_bar 2D radiation stress, Sxy component<br />[[Sout|Sout(idW2yy)]] == F ! Syy_bar 2D radiation stress, Syy component<br />[[Sout|Sout(idU2rs)]] == F ! Ubar_Rstress 2D radiation U-stress<br />[[Sout|Sout(idV2sr)]] == F ! Vbar_Rstress 2D radiation V-stress<br />[[Sout|Sout(idU2Sd)]] == F ! ubar_stokes 2D U-Stokes velocity<br />[[Sout|Sout(idV2Sd)]] == F ! vbar_stokes 2D V-Stokes velocity<br /><br />[[Sout|Sout(idW3xx)]] == F ! Sxx 3D radiation stress, Sxx component<br />[[Sout|Sout(idW3xy)]] == F ! Sxy 3D radiation stress, Sxy component<br />[[Sout|Sout(idW3yy)]] == F ! Syy 3D radiation stress, Syy component<br />[[Sout|Sout(idW3zx)]] == F ! Szx 3D radiation stress, Szx component<br />[[Sout|Sout(idW3zy)]] == F ! Szy 3D radiation stress, Szy component<br />[[Sout|Sout(idU3rs)]] == F ! u_Rstress 3D radiation U-stress<br />[[Sout|Sout(idV3sr)]] == F ! v_Rstress 3D radiation V-stress<br />[[Sout|Sout(idU3Sd)]] == F ! u_stokes 3D U-Stokes velocity<br />[[Sout|Sout(idV3Sd)]] == F ! v_stokes 3D V-Stokes velocity<br /><br />[[Sout|Sout(idWamp)]] == T ! Hwave wave height<br />[[Sout|Sout(idWlen)]] == T ! Lwave wave length<br />[[Sout|Sout(idWdir)]] == T ! Dwave wave direction<br />[[Sout|Sout(idWptp)]] == T ! Pwave_top wave surface period<br />[[Sout|Sout(idWpbt)]] == T ! Pwave_bot wave bottom period<br />[[Sout|Sout(idWorb)]] == T ! Ub_swan wave bottom orbital velocity<br />[[Sout|Sout(idWdis)]] == T ! Wave_dissip wave dissipation<br /><br />[[Sout|Sout(idPair)]] == F ! Pair surface air pressure<br />[[Sout|Sout(idUair)]] == F ! Uair surface U-wind component<br />[[Sout|Sout(idVair)]] == F ! Vair surface V-wind component<br /><br />[[Sout|Sout(idTsur)]] == F F ! shflux, ssflux surface net heat and salt flux<br />[[Sout|Sout(idLhea)]] == F ! latent latent heat flux<br />[[Sout|Sout(idShea)]] == F ! sensible sensible heat flux<br />[[Sout|Sout(idLrad)]] == F ! lwrad longwave radiation flux<br />[[Sout|Sout(idSrad)]] == F ! swrad shortwave radiation flux<br />[[Sout|Sout(idEmPf)]] == F ! EminusP E-P flux <br />[[Sout|Sout(idevap)]] == F ! evaporation evaporation rate<br />[[Sout|Sout(idrain)]] == F ! rain precipitation rate<br /><br />[[Sout|Sout(idDano)]] == F ! rho density anomaly<br />[[Sout|Sout(idVvis)]] == T ! AKv vertical viscosity<br />[[Sout|Sout(idTdif)]] == F ! AKt vertical T-diffusion<br />[[Sout|Sout(idSdif)]] == F ! AKs vertical Salinity diffusion<br />[[Sout|Sout(idHsbl)]] == T ! Hsbl depth of surface boundary layer<br />[[Sout|Sout(idHbbl)]] == T ! Hbbl depth of bottom boundary layer<br />[[Sout|Sout(idMtke)]] == T ! tke turbulent kinetic energy<br />[[Sout|Sout(idMtls)]] == T ! gls turbulent length scale</div> | ||
==Sediment Switches== | ==Sediment Switches== | ||
*This set of switches activate writing of exposed sediment layer properties into stations output file | *This set of switches activate writing of exposed sediment layer properties into stations output file. There are currently 16 properties for the exposed sediment layer.<div class="box" style="margin-left:7px;">[[Sout|Sout(isd50)]] == T ! grain_diameter mean grain diameter<br />[[Sout|Sout(idens)]] == T ! grain_density mean grain density<br />[[Sout|Sout(iwsed)]] == T ! settling_vel mean settling velocity<br />[[Sout|Sout(itauc)]] == T ! erosion_stress critical erosion stress<br />[[Sout|Sout(irlen)]] == T ! ripple_length ripple length<br />[[Sout|Sout(irhgt)]] == T ! ripple_height ripple height<br />[[Sout|Sout(ibwav)]] == T ! bed_wave_amp wave excursion amplitude<br />[[Sout|Sout(izdef)]] == T ! Zo_def default bottom roughness<br />[[Sout|Sout(izapp)]] == T ! Zo_app apparent bottom roughness<br />[[Sout|Sout(izNik)]] == T ! Zo_Nik Nikuradse bottom roughness<br />[[Sout|Sout(izbio)]] == T ! Zo_bio biological bottom roughness<br />[[Sout|Sout(izbfm)]] == T ! Zo_bedform bed form bottom roughness<br />[[Sout|Sout(izbld)]] == T ! Zo_bedload bed load bottom roughness<br />[[Sout|Sout(izwbl)]] == T ! Zo_wbl wave bottom roughness<br />[[Sout|Sout(iactv)]] == T ! active_layer_t... active layer thickness<br />[[Sout|Sout(ishgt)]] == T ! saltation saltation height</div> | ||
==Station Locations== | ==Station Locations== | ||
*Number of stations to process in each nested grid. [[Ngrids]] values are expected. These values are essential because the station arrays are dynamically allocated using these values. | *Number of stations to process in each nested grid. [[Ngrids]] values are expected. These values are essential because the station arrays are dynamically allocated using these values, [1:[[Ngrids]]] values are expected. | ||
:<div class="box"> [[Variables# | :<div class="box"> [[Variables#Nstation|NSTATION]] == 8</div> | ||
*Station locations for all grids in any desired order. The horizontal location for a particular station may be specified in terms of fractional (<span class="blue">I,J</span>) grid pairs (<span class="blue">FLAG</span>=0) or (<span class="blue">longitude,latitude</span>) grid pairs (<span class="blue">FLAG</span>=1). Here, <span class="blue">FLAG</span> is a special switch and may be used for multiple purposes. The <span class="blue">GRID</span> column indicates nested grid number to process. This value must be one in non-nested applications. The <span class="blue">COMMENT</span> section is ignored during reading and may be used to help documentation. These locations are used to interpolate model data before | *Station locations for all grids in any desired order. The horizontal location for a particular station may be specified in terms of fractional (<span class="blue">I,J</span>) grid pairs (<span class="blue">FLAG</span> = 0) or (<span class="blue">longitude,latitude</span>) grid pairs (<span class="blue">FLAG</span> = 1). Here, <span class="blue">FLAG</span> is a special switch and may be used for multiple purposes. The <span class="blue">GRID</span> column indicates nested grid number to process. This value must be one in non-nested applications. The <span class="blue">COMMENT</span> section is ignored during reading and may be used to help documentation. These locations are used to interpolate model data before writing to output stations file ([[Variables#STAname|STANAME]]). Since there is no decoding during the reading of the stations locations, the [[POS]] keyword must be the last one to process. That is, it should be at the end of the input specification. | ||
:<div class="box">[[ | :<div class="box">[[POS]] = GRID FLAG X-POS Y-POS COMMENT<br><br> 1 1 12.5416 44.8691 ! real position: 12.50673 44.86875<br> 1 1 14.26613 42.46277<br> 1 1 12.41580 44.36130<br> 1 1 13.7797 43.2927 ! real position: 13.75660 43.29690<br> 1 1 13.87950 43.3331<br> 1 1 12.46140 44.79600<br> 1 1 12.49320 44.76940<br> 1 1 12.85512 44.46100 ! 8 CP2</div> | ||
Latest revision as of 15:13, 17 July 2019
Standard Input Script - stations.in
The stations.in file sets the parameters and locations for stations output. The name of this file is set by the SPOSNAM keyword in the roms.in file. This standard input ASCII file is organized in several sections as shown below, with links to more detailed explanation where required.
Notice: Detailed information about ROMS input script file syntax can be found here.
Notice: A default stations.in input script is provided in the User/External subdirectory. Also there are several stations input scripts in the ROMS/External subdirectory which are used in the distributed test cases. They are usually named stations_app.in where app is the lowercase of the test case CPP option.
Introduction
This input file provides the positions of model station data to be extracted and written into STATIONS output NetCDF file. This file is used to monitor model fields at frequent time intervals. It is like putting a moored hydrographic station inside the model. It may be used to sample model at observation locations for inter-comparison analysis. It is also a good tool for debugging; a station can be put at a trouble spot to help find algorithm or set-up problems. It is like putting a print statement in the code to display the values of all variables at a particular location.
Stations Output Model Control Switches
- This switch is used to control the writing of stations data within nested and/or multiple connected grids, [1: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 grid to process by turning on/off this switch.
- Lstations == T
- This set of switches determine what fields are written in the stations output file, [Sout(:,ng), ng=1, Ngrids]. Except for tracer type variables, Ngrids values are expected for all switches.
- Sout(idUvel) == T ! u 3D U-velocity
Sout(idVvel) == T ! v 3D V-velocity
Sout(idu3dE) == F ! u_eastward 3D U-eastward at RHO-points
Sout(idv3dN) == F ! v_northward 3D V-nortward at RHO-points
Sout(idWvel) == T ! w 3D W-velocity
Sout(idOvel) == T ! omega 3D omega vertical velocity
Sout(idUbar) == T ! ubar 2D U-velocity
Sout(idVbar) == T ! vbar 2D V-velocity
Sout(idu2dE) == F ! u_eastward 2D U-eastward at RHO-points
Sout(idv2dN) == F ! v_northward 2D V-nortward at RHO-points
Sout(idFsur) == T ! zeta free-surface
Sout(idBath) == T ! bath time-dependent bathymetry
Sout(idTvar) == T T ! temp, salt, ... all (NT) tracers
Sout(idUsms) == T ! sustr surface U-stress
Sout(idVsms) == T ! svstr surface V-stress
Sout(idUbms) == T ! bustr bottom U-stress
Sout(idVbms) == T ! bvstr bottom V-stress
Sout(idUbrs) == T ! bustrc bottom U-current stress
Sout(idVbrs) == T ! bvstrc bottom V-current stress
Sout(idUbws) == T ! bustrw bottom U-wave stress
Sout(idVbws) == T ! bvstrw bottom V-wave stress
Sout(idUbcs) == T ! bustrcwmax bottom max wave-current U-stress
Sout(idVbcs) == T ! bvstrcwmax bottom max wave-current V-stress
Sout(idUbot) == T ! Ubot bed wave orbital U-velocity
Sout(idVbot) == T ! Vbot bed wave orbital V-velocity
Sout(idUbur) == T ! Ur bottom U-velocity above bed
Sout(idVbvr) == T ! Vr bottom V-velocity above bed
Sout(idW2xx) == F ! Sxx_bar 2D radiation stress, Sxx component
Sout(idW2xy) == F ! Sxy_bar 2D radiation stress, Sxy component
Sout(idW2yy) == F ! Syy_bar 2D radiation stress, Syy component
Sout(idU2rs) == F ! Ubar_Rstress 2D radiation U-stress
Sout(idV2sr) == F ! Vbar_Rstress 2D radiation V-stress
Sout(idU2Sd) == F ! ubar_stokes 2D U-Stokes velocity
Sout(idV2Sd) == F ! vbar_stokes 2D V-Stokes velocity
Sout(idW3xx) == F ! Sxx 3D radiation stress, Sxx component
Sout(idW3xy) == F ! Sxy 3D radiation stress, Sxy component
Sout(idW3yy) == F ! Syy 3D radiation stress, Syy component
Sout(idW3zx) == F ! Szx 3D radiation stress, Szx component
Sout(idW3zy) == F ! Szy 3D radiation stress, Szy component
Sout(idU3rs) == F ! u_Rstress 3D radiation U-stress
Sout(idV3sr) == F ! v_Rstress 3D radiation V-stress
Sout(idU3Sd) == F ! u_stokes 3D U-Stokes velocity
Sout(idV3Sd) == F ! v_stokes 3D V-Stokes velocity
Sout(idWamp) == T ! Hwave wave height
Sout(idWlen) == T ! Lwave wave length
Sout(idWdir) == T ! Dwave wave direction
Sout(idWptp) == T ! Pwave_top wave surface period
Sout(idWpbt) == T ! Pwave_bot wave bottom period
Sout(idWorb) == T ! Ub_swan wave bottom orbital velocity
Sout(idWdis) == T ! Wave_dissip wave dissipation
Sout(idPair) == F ! Pair surface air pressure
Sout(idUair) == F ! Uair surface U-wind component
Sout(idVair) == F ! Vair surface V-wind component
Sout(idTsur) == F F ! shflux, ssflux surface net heat and salt flux
Sout(idLhea) == F ! latent latent heat flux
Sout(idShea) == F ! sensible sensible heat flux
Sout(idLrad) == F ! lwrad longwave radiation flux
Sout(idSrad) == F ! swrad shortwave radiation flux
Sout(idEmPf) == F ! EminusP E-P flux
Sout(idevap) == F ! evaporation evaporation rate
Sout(idrain) == F ! rain precipitation rate
Sout(idDano) == F ! rho density anomaly
Sout(idVvis) == T ! AKv vertical viscosity
Sout(idTdif) == F ! AKt vertical T-diffusion
Sout(idSdif) == F ! AKs vertical Salinity diffusion
Sout(idHsbl) == T ! Hsbl depth of surface boundary layer
Sout(idHbbl) == T ! Hbbl depth of bottom boundary layer
Sout(idMtke) == T ! tke turbulent kinetic energy
Sout(idMtls) == T ! gls turbulent length scale
Sediment Switches
- This set of switches activate writing of exposed sediment layer properties into stations output file. There are currently 16 properties for the exposed sediment layer.Sout(isd50) == T ! grain_diameter mean grain diameter
Sout(idens) == T ! grain_density mean grain density
Sout(iwsed) == T ! settling_vel mean settling velocity
Sout(itauc) == T ! erosion_stress critical erosion stress
Sout(irlen) == T ! ripple_length ripple length
Sout(irhgt) == T ! ripple_height ripple height
Sout(ibwav) == T ! bed_wave_amp wave excursion amplitude
Sout(izdef) == T ! Zo_def default bottom roughness
Sout(izapp) == T ! Zo_app apparent bottom roughness
Sout(izNik) == T ! Zo_Nik Nikuradse bottom roughness
Sout(izbio) == T ! Zo_bio biological bottom roughness
Sout(izbfm) == T ! Zo_bedform bed form bottom roughness
Sout(izbld) == T ! Zo_bedload bed load bottom roughness
Sout(izwbl) == T ! Zo_wbl wave bottom roughness
Sout(iactv) == T ! active_layer_t... active layer thickness
Sout(ishgt) == T ! saltation saltation height
Station Locations
- Number of stations to process in each nested grid. Ngrids values are expected. These values are essential because the station arrays are dynamically allocated using these values, [1:Ngrids] values are expected.
- NSTATION == 8
- Station locations for all grids in any desired order. The horizontal location for a particular station may be specified in terms of fractional (I,J) grid pairs (FLAG = 0) or (longitude,latitude) grid pairs (FLAG = 1). Here, FLAG is a special switch and may be used for multiple purposes. The GRID column indicates nested grid number to process. This value must be one in non-nested applications. The COMMENT section is ignored during reading and may be used to help documentation. These locations are used to interpolate model data before writing to output stations file (STANAME). Since there is no decoding during the reading of the stations locations, the POS keyword must be the last one to process. That is, it should be at the end of the input specification.
- POS = GRID FLAG X-POS Y-POS COMMENT
1 1 12.5416 44.8691 ! real position: 12.50673 44.86875
1 1 14.26613 42.46277
1 1 12.41580 44.36130
1 1 13.7797 43.2927 ! real position: 13.75660 43.29690
1 1 13.87950 43.3331
1 1 12.46140 44.79600
1 1 12.49320 44.76940
1 1 12.85512 44.46100 ! 8 CP2
