/[MITgcm]/MITgcm/model/inc/PARAMS.h
ViewVC logotype

Diff of /MITgcm/model/inc/PARAMS.h

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.234 by jmc, Tue Dec 8 00:29:32 2009 UTC revision 1.263 by gforget, Sat Jun 30 01:23:05 2012 UTC
# Line 33  C     pickupSuff      :: force to start Line 33  C     pickupSuff      :: force to start
33  C                        and read pickup files with this suffix (max 10 Char.)  C                        and read pickup files with this suffix (max 10 Char.)
34  C     mdsioLocalDir   :: read-write tiled file from/to this directory name  C     mdsioLocalDir   :: read-write tiled file from/to this directory name
35  C                        (+ 4 digits Processor-Rank) instead of current dir.  C                        (+ 4 digits Processor-Rank) instead of current dir.
36    C     adTapeDir       :: read-write checkpointing tape files from/to this
37    C                        directory name instead of current dir. Conflicts
38    C                        mdsioLocalDir, so only one of the two can be set.
39    C                        In contrast to mdsioLocalDir, if specified adTapeDir
40    C                        must exist before the model starts.
41  C     tRefFile      :: File containing reference Potential Temperat.  tRef (1.D)  C     tRefFile      :: File containing reference Potential Temperat.  tRef (1.D)
42  C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)  C     sRefFile      :: File containing reference salinity/spec.humid. sRef (1.D)
43  C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)  C     rhoRefFile    :: File containing reference density profile rhoRef (1.D)
44  C     delRFile      :: File containing vertical grid spacing delR  (1.D array)  C     delRFile      :: File containing vertical grid spacing delR  (1.D array)
45  C     delRcFile     :: File containing vertical grid spacing delRc (1.D array)  C     delRcFile     :: File containing vertical grid spacing delRc (1.D array)
46    C     hybSigmFile   :: File containing hybrid-sigma vertical coord. coeff. (2x 1.D)
47  C     delXFile      :: File containing X-spacing grid definition (1.D array)  C     delXFile      :: File containing X-spacing grid definition (1.D array)
48  C     delYFile      :: File containing Y-spacing grid definition (1.D array)  C     delYFile      :: File containing Y-spacing grid definition (1.D array)
49  C     horizGridFile :: File containing horizontal-grid definition  C     horizGridFile :: File containing horizontal-grid definition
# Line 51  C                        for potential t Line 57  C                        for potential t
57  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)  C     hydrogSaltFile  :: File containing initial hydrographic data (3-D)
58  C                        for salinity.  C                        for salinity.
59  C     diffKrFile      :: File containing 3D specification of vertical diffusivity  C     diffKrFile      :: File containing 3D specification of vertical diffusivity
60    C     viscAhDfile     :: File containing 3D specification of horizontal viscosity
61    C     viscAhZfile     :: File containing 3D specification of horizontal viscosity
62    C     viscA4Dfile     :: File containing 3D specification of horizontal viscosity
63    C     viscA4Zfile     :: File containing 3D specification of horizontal viscosity
64  C     zonalWindFile   :: File containing zonal wind data  C     zonalWindFile   :: File containing zonal wind data
65  C     meridWindFile   :: File containing meridional wind data  C     meridWindFile   :: File containing meridional wind data
66  C     thetaClimFile   :: File containing surface theta climataology used  C     thetaClimFile   :: File containing surface theta climataology used
67  C                       in relaxation term -lambda(theta-theta*)  C                        in relaxation term -lambda(theta-theta*)
68  C     saltClimFile    :: File containing surface salt climataology used  C     saltClimFile    :: File containing surface salt climataology used
69  C                       in relaxation term -lambda(salt-salt*)  C                        in relaxation term -lambda(salt-salt*)
70  C     surfQfile       :: File containing surface heat flux, excluding SW  C     surfQfile       :: File containing surface heat flux, excluding SW
71  C                        (old version, kept for backward compatibility)  C                        (old version, kept for backward compatibility)
72  C     surfQnetFile    :: File containing surface net heat flux  C     surfQnetFile    :: File containing surface net heat flux
# Line 73  C     eddyPsiYFile    :: File containing Line 83  C     eddyPsiYFile    :: File containing
83  C     the_run_name    :: string identifying the name of the model "run"  C     the_run_name    :: string identifying the name of the model "run"
84        COMMON /PARM_C/        COMMON /PARM_C/
85       &                buoyancyRelation, eosType,       &                buoyancyRelation, eosType,
86       &                pickupSuff, mdsioLocalDir,       &                pickupSuff, mdsioLocalDir, adTapeDir,
87       &                tRefFile, sRefFile, rhoRefFile,       &                tRefFile, sRefFile, rhoRefFile,
88       &                delRFile, delRcFile,       &                delRFile, delRcFile, hybSigmFile,
89       &                delXFile, delYFile, horizGridFile,       &                delXFile, delYFile, horizGridFile,
90       &                bathyFile, topoFile,       &                bathyFile, topoFile,
91         &                viscAhDfile, viscAhZfile,
92         &                viscA4Dfile, viscA4Zfile,
93       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,       &                hydrogThetaFile, hydrogSaltFile, diffKrFile,
94       &                zonalWindFile, meridWindFile, thetaClimFile,       &                zonalWindFile, meridWindFile, thetaClimFile,
95       &                saltClimFile,       &                saltClimFile,
# Line 92  C     the_run_name    :: string identify Line 104  C     the_run_name    :: string identify
104        CHARACTER*(6)  eosType        CHARACTER*(6)  eosType
105        CHARACTER*(10) pickupSuff        CHARACTER*(10) pickupSuff
106        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir        CHARACTER*(MAX_LEN_FNAM) mdsioLocalDir
107          CHARACTER*(MAX_LEN_FNAM) adTapeDir
108        CHARACTER*(MAX_LEN_FNAM) tRefFile        CHARACTER*(MAX_LEN_FNAM) tRefFile
109        CHARACTER*(MAX_LEN_FNAM) sRefFile        CHARACTER*(MAX_LEN_FNAM) sRefFile
110        CHARACTER*(MAX_LEN_FNAM) rhoRefFile        CHARACTER*(MAX_LEN_FNAM) rhoRefFile
111        CHARACTER*(MAX_LEN_FNAM) delRFile        CHARACTER*(MAX_LEN_FNAM) delRFile
112        CHARACTER*(MAX_LEN_FNAM) delRcFile        CHARACTER*(MAX_LEN_FNAM) delRcFile
113          CHARACTER*(MAX_LEN_FNAM) hybSigmFile
114        CHARACTER*(MAX_LEN_FNAM) delXFile        CHARACTER*(MAX_LEN_FNAM) delXFile
115        CHARACTER*(MAX_LEN_FNAM) delYFile        CHARACTER*(MAX_LEN_FNAM) delYFile
116        CHARACTER*(MAX_LEN_FNAM) horizGridFile        CHARACTER*(MAX_LEN_FNAM) horizGridFile
117        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile        CHARACTER*(MAX_LEN_FNAM) bathyFile, topoFile
118        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile        CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile, hydrogSaltFile
119        CHARACTER*(MAX_LEN_FNAM) diffKrFile        CHARACTER*(MAX_LEN_FNAM) diffKrFile
120          CHARACTER*(MAX_LEN_FNAM) viscAhDfile
121          CHARACTER*(MAX_LEN_FNAM) viscAhZfile
122          CHARACTER*(MAX_LEN_FNAM) viscA4Dfile
123          CHARACTER*(MAX_LEN_FNAM) viscA4Zfile
124        CHARACTER*(MAX_LEN_FNAM) zonalWindFile        CHARACTER*(MAX_LEN_FNAM) zonalWindFile
125        CHARACTER*(MAX_LEN_FNAM) meridWindFile        CHARACTER*(MAX_LEN_FNAM) meridWindFile
126        CHARACTER*(MAX_LEN_FNAM) thetaClimFile        CHARACTER*(MAX_LEN_FNAM) thetaClimFile
# Line 125  C     the_run_name    :: string identify Line 143  C     the_run_name    :: string identify
143    
144  C--   COMMON /PARM_I/ Integer valued parameters used by the model.  C--   COMMON /PARM_I/ Integer valued parameters used by the model.
145  C     cg2dMaxIters        :: Maximum number of iterations in the  C     cg2dMaxIters        :: Maximum number of iterations in the
146  C                           two-dimensional con. grad solver.  C                            two-dimensional con. grad solver.
147  C     cg2dChkResFreq      :: Frequency with which to check residual  C     cg2dChkResFreq      :: Frequency with which to check residual
148  C                           in con. grad solver.  C                            in con. grad solver.
149  C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner  C     cg2dPreCondFreq     :: Frequency for updating cg2d preconditioner
150  C                            (non-linear free-surf.)  C                            (non-linear free-surf.)
151  C     cg3dMaxIters        :: Maximum number of iterations in the  C     cg3dMaxIters        :: Maximum number of iterations in the
152  C                           three-dimensional con. grad solver.  C                            three-dimensional con. grad solver.
153  C     cg3dChkResFreq      :: Frequency with which to check residual  C     cg3dChkResFreq      :: Frequency with which to check residual
154  C                           in con. grad solver.  C                            in con. grad solver.
155    C     printResidualFreq   :: Frequency for printing residual in CG iterations
156  C     nIter0              :: Start time-step number of for this run  C     nIter0              :: Start time-step number of for this run
157  C     nTimeSteps          :: Number of timesteps to execute  C     nTimeSteps          :: Number of timesteps to execute
158  C     writeStatePrec      :: Precision used for writing model state.  C     writeStatePrec      :: Precision used for writing model state.
159  C     writeBinaryPrec     :: Precision used for writing binary files  C     writeBinaryPrec     :: Precision used for writing binary files
160  C     readBinaryPrec      :: Precision used for reading binary files  C     readBinaryPrec      :: Precision used for reading binary files
161    C     selectCoriMap       :: select setting of Coriolis parameter map:
162    C                           =0 f-Plane (Constant Coriolis, = f0)
163    C                           =1 Beta-Plane Coriolis (= f0 + beta.y)
164    C                           =2 Spherical Coriolis (= 2.omega.sin(phi))
165    C                           =3 Read Coriolis 2-d fields from files.
166    C     selectSigmaCoord    :: option related to sigma vertical coordinate
167  C     nonlinFreeSurf      :: option related to non-linear free surface  C     nonlinFreeSurf      :: option related to non-linear free surface
168  C                           =0 Linear free surface ; >0 Non-linear  C                           =0 Linear free surface ; >0 Non-linear
169  C     select_rStar        :: option related to r* vertical coordinate  C     select_rStar        :: option related to r* vertical coordinate
# Line 149  C     selectAddFluid      :: option to a Line 174  C     selectAddFluid      :: option to a
174  C                            (3-D generalisation of oceanic real-fresh water flux)  C                            (3-D generalisation of oceanic real-fresh water flux)
175  C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)  C                           =0 off ; =1 add fluid ; =-1 virtual flux (no mass added)
176  C     momForcingOutAB     :: =1: take momentum forcing contribution  C     momForcingOutAB     :: =1: take momentum forcing contribution
177  C                           out of (=0: in) Adams-Bashforth time stepping.  C                            out of (=0: in) Adams-Bashforth time stepping.
178  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution  C     tracForcingOutAB    :: =1: take tracer (Temp,Salt,pTracers) forcing contribution
179  C                           out of (=0: in) Adams-Bashforth time stepping.  C                            out of (=0: in) Adams-Bashforth time stepping.
180  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector  C     tempAdvScheme       :: Temp. Horiz.Advection scheme selector
181  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector  C     tempVertAdvScheme   :: Temp. Vert. Advection scheme selector
182  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector  C     saltAdvScheme       :: Salt. Horiz.advection scheme selector
# Line 160  C     selectKEscheme      :: Kinetic Ene Line 185  C     selectKEscheme      :: Kinetic Ene
185  C     selectVortScheme    :: Scheme selector for Vorticity term (Vector Inv.)  C     selectVortScheme    :: Scheme selector for Vorticity term (Vector Inv.)
186  C     monitorSelect       :: select group of variables to monitor  C     monitorSelect       :: select group of variables to monitor
187  C                            =1 : dynvars ; =2 : + vort ; =3 : + surface  C                            =1 : dynvars ; =2 : + vort ; =3 : + surface
188  C     debugLevel          :: debug level selector: higher -> more writing  C-    debugLevel          :: controls printing of algorithm intermediate results
189    C                            and statistics ; higher -> more writing
190    
191        COMMON /PARM_I/        COMMON /PARM_I/
192       &        cg2dMaxIters,       &        cg2dMaxIters, cg2dChkResFreq, cg2dPreCondFreq,
193       &        cg2dChkResFreq, cg2dPreCondFreq,       &        cg3dMaxIters, cg3dChkResFreq,
194       &        cg3dMaxIters,       &        printResidualFreq,
      &        cg3dChkResFreq,  
195       &        nIter0, nTimeSteps, nEndIter,       &        nIter0, nTimeSteps, nEndIter,
196       &        writeStatePrec,       &        writeStatePrec,
197       &        writeBinaryPrec, readBinaryPrec,       &        writeBinaryPrec, readBinaryPrec,
198         &        selectCoriMap,
199         &        selectSigmaCoord,
200       &        nonlinFreeSurf, select_rStar,       &        nonlinFreeSurf, select_rStar,
201       &        selectNHfreeSurf,       &        selectNHfreeSurf,
202       &        selectAddFluid,       &        selectAddFluid,
# Line 183  C     debugLevel          :: debug level Line 210  C     debugLevel          :: debug level
210        INTEGER cg2dPreCondFreq        INTEGER cg2dPreCondFreq
211        INTEGER cg3dMaxIters        INTEGER cg3dMaxIters
212        INTEGER cg3dChkResFreq        INTEGER cg3dChkResFreq
213          INTEGER printResidualFreq
214        INTEGER nIter0        INTEGER nIter0
215        INTEGER nTimeSteps        INTEGER nTimeSteps
216        INTEGER nEndIter        INTEGER nEndIter
217        INTEGER writeStatePrec        INTEGER writeStatePrec
218        INTEGER writeBinaryPrec        INTEGER writeBinaryPrec
219        INTEGER readBinaryPrec        INTEGER readBinaryPrec
220          INTEGER selectCoriMap
221          INTEGER selectSigmaCoord
222        INTEGER nonlinFreeSurf        INTEGER nonlinFreeSurf
223        INTEGER select_rStar        INTEGER select_rStar
224        INTEGER selectNHfreeSurf        INTEGER selectNHfreeSurf
# Line 204  C     debugLevel          :: debug level Line 234  C     debugLevel          :: debug level
234  C--   COMMON /PARM_L/ Logical valued parameters used by the model.  C--   COMMON /PARM_L/ Logical valued parameters used by the model.
235  C- Coordinate + Grid params:  C- Coordinate + Grid params:
236  C     fluidIsAir       :: Set to indicate that the fluid major constituent  C     fluidIsAir       :: Set to indicate that the fluid major constituent
237  C                        is air  C                         is air
238  C     fluidIsWater     :: Set to indicate that the fluid major constituent  C     fluidIsWater     :: Set to indicate that the fluid major constituent
239  C                        is water  C                         is water
240  C     usingPCoords     :: Set to indicate that we are working in a pressure  C     usingPCoords     :: Set to indicate that we are working in a pressure
241  C                        type coordinate (p or p*).  C                         type coordinate (p or p*).
242  C     usingZCoords     :: Set to indicate that we are working in a height  C     usingZCoords     :: Set to indicate that we are working in a height
243  C                        type coordinate (z or z*)  C                         type coordinate (z or z*)
244  C     useDynP_inEos_Zc :: use the dynamical pressure in EOS (with Z-coord.)  C     useDynP_inEos_Zc   :: use the dynamical pressure in EOS (with Z-coord.)
245  C                         this requires specific code for restart & exchange  C                           this requires specific code for restart & exchange
246  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian  C     usingCartesianGrid :: If TRUE grid generation will be in a cartesian
247  C                          coordinate frame.  C                           coordinate frame.
248  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a  C     usingSphericalPolarGrid :: If TRUE grid generation will be in a
249  C                               spherical polar frame.  C                                spherical polar frame.
250  C     rotateGrid      :: rotate grid coordinates to geographical coordinates  C     rotateGrid      :: rotate grid coordinates to geographical coordinates
251  C                        according to Euler angles phiEuler, thetaEuler, psiEuler  C                        according to Euler angles phiEuler, thetaEuler, psiEuler
252  C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)  C     usingCurvilinearGrid :: If TRUE, use a curvilinear grid (to be provided)
# Line 242  C     metricTerms   :: Flag which turns Line 272  C     metricTerms   :: Flag which turns
272  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.  C     useNHMTerms   :: If TRUE use non-hydrostatic metric terms.
273  C     useCoriolis   :: Flag which turns the coriolis terms on and off.  C     useCoriolis   :: Flag which turns the coriolis terms on and off.
274  C     use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off  C     use3dCoriolis :: Turns the 3-D coriolis terms (in Omega.cos Phi) on - off
 C     useConstantF  :: Coriolis parameter set to f0  
 C     useBetaPlaneF :: Coriolis parameter set to f0 + beta.y  
 C     useSphereF    :: Coriolis parameter set to 2.omega.sin(phi)  
275  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.  C     useCDscheme   :: use CD-scheme to calculate Coriolis terms.
276  C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)  C     vectorInvariantMomentum :: use Vector-Invariant form (mom_vecinv package)
277  C                                (default = F = use mom_fluxform package)  C                                (default = F = use mom_fluxform package)
# Line 255  C     highOrderVorticity :: use 3rd/4th Line 282  C     highOrderVorticity :: use 3rd/4th
282  C     useAbsVorticity :: work with f+zeta in Coriolis terms  C     useAbsVorticity :: work with f+zeta in Coriolis terms
283  C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)  C     upwindShear        :: use 1rst order upwind interp. (V.I., vertical advection)
284  C     momStepping    :: Turns momentum equation time-stepping off  C     momStepping    :: Turns momentum equation time-stepping off
285    C     calc_wVelocity :: Turns of vertical velocity calculation off
286  C- Temp. & Salt params:  C- Temp. & Salt params:
287  C     tempStepping   :: Turns temperature equation time-stepping off  C     tempStepping   :: Turns temperature equation time-stepping off
288  C     saltStepping   :: Turns salinity equation time-stepping off  C     saltStepping   :: Turns salinity equation time-stepping off
289  C     tempAdvection  :: Flag which turns advection of temperature on and off.  C     tempAdvection  :: Flag which turns advection of temperature on and off.
290    C     tempVertDiff4  :: use vertical bi-harmonic diffusion for temperature
291  C     tempIsActiveTr :: Pot.Temp. is a dynamically active tracer  C     tempIsActiveTr :: Pot.Temp. is a dynamically active tracer
292  C     tempForcing    :: Flag which turns external forcing of temperature on  C     tempForcing    :: Flag which turns external forcing of temperature on
293  C                       and off.  C                       and off.
294  C     saltAdvection  :: Flag which turns advection of salinity on and off.  C     saltAdvection  :: Flag which turns advection of salinity on and off.
295    C     saltVertDiff4  :: use vertical bi-harmonic diffusion for salinity
296  C     saltIsActiveTr :: Salinity  is a dynamically active tracer  C     saltIsActiveTr :: Salinity  is a dynamically active tracer
297  C     saltForcing    :: Flag which turns external forcing of salinity on  C     saltForcing    :: Flag which turns external forcing of salinity on
298  C                       and off.  C                       and off.
# Line 270  C     maskIniTemp    :: apply mask to in Line 300  C     maskIniTemp    :: apply mask to in
300  C     maskIniSalt    :: apply mask to initial salinity  C     maskIniSalt    :: apply mask to initial salinity
301  C     checkIniTemp   :: check for points with identically zero initial Pot.Temp.  C     checkIniTemp   :: check for points with identically zero initial Pot.Temp.
302  C     checkIniSalt   :: check for points with identically zero initial salinity  C     checkIniSalt   :: check for points with identically zero initial salinity
 C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux  
 C                         as a real Fresh Water (=> changes the Sea Level)  
 C                         if F, converts P+R-E to salt flux (no SL effect)  
303  C- Pressure solver related parameters (PARM02)  C- Pressure solver related parameters (PARM02)
304  C     useSRCGSolver  :: Set to true to use conjugate gradient  C     useSRCGSolver  :: Set to true to use conjugate gradient
305  C                       solver with single reduction (only one call of  C                       solver with single reduction (only one call of
306  C                       s/r mpi_allreduce), default is false  C                       s/r mpi_allreduce), default is false
307  C- Time-stepping params:  C- Time-stepping & free-surface params:
308  C     rigidLid            :: Set to true to use rigid lid  C     rigidLid            :: Set to true to use rigid lid
309  C     implicitFreeSurface :: Set to true to use implicit free surface  C     implicitFreeSurface :: Set to true to use implicit free surface
310    C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the
311    C                            linear relation Phi_surf = Bo_surf*eta
312    C     uniformFreeSurfLev  :: TRUE if free-surface level-index is uniform (=1)
313  C     exactConserv        :: Set to true to conserve exactly the total Volume  C     exactConserv        :: Set to true to conserve exactly the total Volume
314  C     linFSConserveTr     :: Set to true to correct source/sink of tracer  C     linFSConserveTr     :: Set to true to correct source/sink of tracer
315  C                            at the surface due to Linear Free Surface  C                            at the surface due to Linear Free Surface
316  C     uniformLin_PhiSurf  :: Set to true to use a uniform Bo_surf in the  C     useRealFreshWaterFlux :: if True (=Natural BCS), treats P+R-E flux
317  C                            linear relation Phi_surf = Bo_surf*eta  C                         as a real Fresh Water (=> changes the Sea Level)
318    C                         if F, converts P+R-E to salt flux (no SL effect)
319  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm  C     quasiHydrostatic :: Using non-hydrostatic terms in hydrostatic algorithm
320  C     nonHydrostatic   :: Using non-hydrostatic algorithm  C     nonHydrostatic   :: Using non-hydrostatic algorithm
321  C     use3Dsolver      :: set to true to use 3-D pressure solver  C     use3Dsolver      :: set to true to use 3-D pressure solver
322  C     implicitIntGravWave :: treat Internal Gravity Wave implicitly  C     implicitIntGravWave :: treat Internal Gravity Wave implicitly
323  C     staggerTimeStep   :: enable a Stagger time stepping U,V (& W) then T,S  C     staggerTimeStep   :: enable a Stagger time stepping U,V (& W) then T,S
324    C     doResetHFactors   :: Do reset thickness factors @ beginning of each time-step
325  C     implicitDiffusion :: Turns implicit vertical diffusion on  C     implicitDiffusion :: Turns implicit vertical diffusion on
326  C     implicitViscosity :: Turns implicit vertical viscosity on  C     implicitViscosity :: Turns implicit vertical viscosity on
327  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature  C     tempImplVertAdv :: Turns on implicit vertical advection for Temperature
# Line 309  C     doThetaClimRelax :: Set true if re Line 341  C     doThetaClimRelax :: Set true if re
341  C                        climatology is required.  C                        climatology is required.
342  C     doSaltClimRelax  :: Set true if relaxation to salinity  C     doSaltClimRelax  :: Set true if relaxation to salinity
343  C                        climatology is required.  C                        climatology is required.
344    C     balanceThetaClimRelax :: substract global mean effect at every time step
345    C     balanceSaltClimRelax :: substract global mean effect at every time step
346  C     allowFreezing  :: Allows surface water to freeze and form ice  C     allowFreezing  :: Allows surface water to freeze and form ice
347  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)  C     useOldFreezing :: use the old version (before checkpoint52a_pre, 2003-11-12)
348  C     periodicExternalForcing :: Set true if forcing is time-dependant  C     periodicExternalForcing :: Set true if forcing is time-dependant
349  C- I/O parameters -  C- I/O parameters -
350  C     globalFiles    :: Selects between "global" and "tiled" files  C     globalFiles    :: Selects between "global" and "tiled" files.
351  C     useSingleCpuIO :: On SGI platforms, option globalFiles is either  C                       On some platforms with MPI, option globalFiles is either
352  C                       slow (f77) or does not work (f90).  When  C                       slow or does not work. Use useSingleCpuIO instead.
353  C                       useSingleCpuIO is set, mdsio_writefield.F  C     useSingleCpuIO :: moved to EEPARAMS.h
 C                       outputs from master mpi process only.  
354  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match  C     pickupStrictlyMatch :: check and stop if pickup-file do not stricly match
355  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup  C     startFromPickupAB2 :: with AB-3 code, start from an AB-2 pickup
356  C     usePickupBeforeC54 :: start from old-pickup files, generated with code from  C     usePickupBeforeC54 :: start from old-pickup files, generated with code from
# Line 331  C     snapshot_mdsio     :: use mdsio fo Line 364  C     snapshot_mdsio     :: use mdsio fo
364  C     monitor_stdio      :: use stdio for monitor output  C     monitor_stdio      :: use stdio for monitor output
365  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)  C     dumpInitAndLast :: dumps model state to files at Initial (nIter0)
366  C                        & Last iteration, in addition multiple of dumpFreq iter.  C                        & Last iteration, in addition multiple of dumpFreq iter.
367    C     printDomain     :: controls printing of domain fields (bathy, hFac ...).
368    
369        COMMON /PARM_L/        COMMON /PARM_L/
370       & fluidIsAir, fluidIsWater,       & fluidIsAir, fluidIsWater,
# Line 343  C                        & Last iteratio Line 377  C                        & Last iteratio
377       & momViscosity, momAdvection, momForcing,       & momViscosity, momAdvection, momForcing,
378       & momPressureForcing, metricTerms, useNHMTerms,       & momPressureForcing, metricTerms, useNHMTerms,
379       & useCoriolis, use3dCoriolis,       & useCoriolis, use3dCoriolis,
      & useConstantF, useBetaPlaneF, useSphereF,  
380       & useCDscheme, vectorInvariantMomentum,       & useCDscheme, vectorInvariantMomentum,
381       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,       & useEnergyConservingCoriolis, useJamartWetPoints, useJamartMomAdv,
382       & upwindVorticity, highOrderVorticity,       & upwindVorticity, highOrderVorticity,
383       & useAbsVorticity, upwindShear,       & useAbsVorticity, upwindShear,
384       & momStepping, tempStepping, saltStepping,       & momStepping, calc_wVelocity, tempStepping, saltStepping,
385       & tempAdvection, tempIsActiveTr, tempForcing,       & tempAdvection, tempVertDiff4, tempIsActiveTr, tempForcing,
386       & saltAdvection, saltIsActiveTr, saltForcing,       & saltAdvection, saltVertDiff4, saltIsActiveTr, saltForcing,
387       & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,       & maskIniTemp, maskIniSalt, checkIniTemp, checkIniSalt,
388       & useRealFreshWaterFlux,       & useSRCGSolver,
389       & rigidLid, implicitFreeSurface, exactConserv, linFSConserveTr,       & rigidLid, implicitFreeSurface,
390       & uniformLin_PhiSurf,       & uniformLin_PhiSurf, uniformFreeSurfLev,
391       & quasiHydrostatic, nonHydrostatic,       & exactConserv, linFSConserveTr, useRealFreshWaterFlux,
392       & use3Dsolver, implicitIntGravWave, staggerTimeStep,       & quasiHydrostatic, nonHydrostatic, use3Dsolver,
393         & implicitIntGravWave, staggerTimeStep, doResetHFactors,
394       & implicitDiffusion, implicitViscosity,       & implicitDiffusion, implicitViscosity,
395       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,       & tempImplVertAdv, saltImplVertAdv, momImplVertAdv,
396       & multiDimAdvection, useMultiDimAdvec,       & multiDimAdvection, useMultiDimAdvec,
397       & momDissip_In_AB, doAB_onGtGs,       & momDissip_In_AB, doAB_onGtGs,
398       & balanceEmPmR, balanceQnet, balancePrintMean,       & balanceEmPmR, balanceQnet, balancePrintMean,
399         & balanceThetaClimRelax, balanceSaltClimRelax,
400       & doThetaClimRelax, doSaltClimRelax,       & doThetaClimRelax, doSaltClimRelax,
401       & allowFreezing, useOldFreezing,       & allowFreezing, useOldFreezing,
402       & periodicExternalForcing,       & periodicExternalForcing,
403       & globalFiles, useSingleCpuIO,       & globalFiles,
404       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,       & pickupStrictlyMatch, usePickupBeforeC54, startFromPickupAB2,
405       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,       & pickup_read_mdsio, pickup_write_mdsio, pickup_write_immed,
406       & writePickupAtEnd,       & writePickupAtEnd,
407       & timeave_mdsio, snapshot_mdsio, monitor_stdio,       & timeave_mdsio, snapshot_mdsio, monitor_stdio,
408       & outputTypesInclusive, dumpInitAndLast, debugMode,       & outputTypesInclusive, dumpInitAndLast,
409       & inAdMode, inAdTrue, inAdFalse, inAdExact,       & printDomain,
410       & useSRCGSolver       & inAdMode, inAdTrue, inAdFalse, inAdExact
411    
412        LOGICAL fluidIsAir        LOGICAL fluidIsAir
413        LOGICAL fluidIsWater        LOGICAL fluidIsWater
# Line 389  C                        & Last iteratio Line 424  C                        & Last iteratio
424        LOGICAL useNHMTerms        LOGICAL useNHMTerms
425        LOGICAL no_slip_sides        LOGICAL no_slip_sides
426        LOGICAL no_slip_bottom        LOGICAL no_slip_bottom
427          LOGICAL useFullLeith
428          LOGICAL useStrainTensionVisc
429          LOGICAL useAreaViscLength
430        LOGICAL momViscosity        LOGICAL momViscosity
431        LOGICAL momAdvection        LOGICAL momAdvection
432        LOGICAL momForcing        LOGICAL momForcing
# Line 396  C                        & Last iteratio Line 434  C                        & Last iteratio
434        LOGICAL useCoriolis        LOGICAL useCoriolis
435        LOGICAL vectorInvariantMomentum        LOGICAL vectorInvariantMomentum
436        LOGICAL tempAdvection        LOGICAL tempAdvection
437          LOGICAL tempVertDiff4
438        LOGICAL tempIsActiveTr        LOGICAL tempIsActiveTr
439        LOGICAL tempForcing        LOGICAL tempForcing
440        LOGICAL saltAdvection        LOGICAL saltAdvection
441          LOGICAL saltVertDiff4
442        LOGICAL saltIsActiveTr        LOGICAL saltIsActiveTr
443        LOGICAL saltForcing        LOGICAL saltForcing
444        LOGICAL maskIniTemp        LOGICAL maskIniTemp
445        LOGICAL maskIniSalt        LOGICAL maskIniSalt
446        LOGICAL checkIniTemp        LOGICAL checkIniTemp
447        LOGICAL checkIniSalt        LOGICAL checkIniSalt
448        LOGICAL useRealFreshWaterFlux        LOGICAL useSRCGSolver
       LOGICAL useFullLeith  
       LOGICAL useStrainTensionVisc  
       LOGICAL useAreaViscLength  
449        LOGICAL rigidLid        LOGICAL rigidLid
450        LOGICAL implicitFreeSurface        LOGICAL implicitFreeSurface
451          LOGICAL uniformLin_PhiSurf
452          LOGICAL uniformFreeSurfLev
453        LOGICAL exactConserv        LOGICAL exactConserv
454        LOGICAL linFSConserveTr        LOGICAL linFSConserveTr
455        LOGICAL uniformLin_PhiSurf        LOGICAL useRealFreshWaterFlux
456        LOGICAL quasiHydrostatic        LOGICAL quasiHydrostatic
457        LOGICAL nonHydrostatic        LOGICAL nonHydrostatic
458        LOGICAL use3Dsolver        LOGICAL use3Dsolver
459        LOGICAL implicitIntGravWave        LOGICAL implicitIntGravWave
460        LOGICAL staggerTimeStep        LOGICAL staggerTimeStep
461          LOGICAL doResetHFactors
462        LOGICAL momStepping        LOGICAL momStepping
463          LOGICAL calc_wVelocity
464        LOGICAL tempStepping        LOGICAL tempStepping
465        LOGICAL saltStepping        LOGICAL saltStepping
466        LOGICAL metricTerms        LOGICAL metricTerms
       LOGICAL useConstantF  
       LOGICAL useBetaPlaneF  
       LOGICAL useSphereF  
467        LOGICAL use3dCoriolis        LOGICAL use3dCoriolis
468        LOGICAL useCDscheme        LOGICAL useCDscheme
469        LOGICAL useEnergyConservingCoriolis        LOGICAL useEnergyConservingCoriolis
# Line 449  C                        & Last iteratio Line 487  C                        & Last iteratio
487        LOGICAL balancePrintMean        LOGICAL balancePrintMean
488        LOGICAL doThetaClimRelax        LOGICAL doThetaClimRelax
489        LOGICAL doSaltClimRelax        LOGICAL doSaltClimRelax
490          LOGICAL balanceThetaClimRelax
491          LOGICAL balanceSaltClimRelax
492        LOGICAL allowFreezing        LOGICAL allowFreezing
493        LOGICAL useOldFreezing        LOGICAL useOldFreezing
494        LOGICAL periodicExternalForcing        LOGICAL periodicExternalForcing
495        LOGICAL globalFiles        LOGICAL globalFiles
       LOGICAL useSingleCpuIO  
496        LOGICAL pickupStrictlyMatch        LOGICAL pickupStrictlyMatch
497        LOGICAL usePickupBeforeC54        LOGICAL usePickupBeforeC54
498        LOGICAL startFromPickupAB2        LOGICAL startFromPickupAB2
# Line 462  C                        & Last iteratio Line 501  C                        & Last iteratio
501        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio        LOGICAL timeave_mdsio, snapshot_mdsio, monitor_stdio
502        LOGICAL outputTypesInclusive        LOGICAL outputTypesInclusive
503        LOGICAL dumpInitAndLast        LOGICAL dumpInitAndLast
504        LOGICAL debugMode        LOGICAL printDomain
505        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact        LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
       LOGICAL useSRCGSolver  
506    
507  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.  C--   COMMON /PARM_R/ "Real" valued parameters used by the model.
508  C     cg2dTargetResidual  C     cg2dTargetResidual
# Line 490  C           defaults to 0.51 but can be Line 528  C           defaults to 0.51 but can be
528  C     delR      :: Vertical grid spacing ( units of r ).  C     delR      :: Vertical grid spacing ( units of r ).
529  C     delRc     :: Vertical grid spacing between cell centers (r unit).  C     delRc     :: Vertical grid spacing between cell centers (r unit).
530  C     delX      :: Separation between cell faces (m) or (deg), depending  C     delX      :: Separation between cell faces (m) or (deg), depending
531  C     delY        on input flags.  C     delY         on input flags. Note: moved to header file SET_GRID.h
532    C     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western
533    C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"
534    C                :: parameter but it makes geographical references simple.)
535    C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern
536    C                :: most face (Lat-Lon grid).
537  C     gravity   :: Accel. due to gravity ( m/s^2 )  C     gravity   :: Accel. due to gravity ( m/s^2 )
538  C     recip_gravity and its inverse  C     recip_gravity and its inverse
539  C     gBaro     :: Accel. due to gravity used in barotropic equation ( m/s^2 )  C     gBaro     :: Accel. due to gravity used in barotropic equation ( m/s^2 )
540  C     rhoNil    :: Reference density for the linear equation of state  C     rhoNil    :: Reference density for the linear equation of state
541  C     rhoConst  :: Vertically constant reference density  C     rhoConst  :: Vertically constant reference density (Boussinesq)
542  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center  C     rhoFacC   :: normalized (by rhoConst) reference density at cell-Center
543  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace  C     rhoFacF   :: normalized (by rhoConst) reference density at cell-interFace
544  C     rhoConstFresh :: Constant reference density for fresh water (rain)  C     rhoConstFresh :: Constant reference density for fresh water (rain)
# Line 503  C     rho1Ref   :: reference vertical pr Line 546  C     rho1Ref   :: reference vertical pr
546  C     tRef      :: reference vertical profile for potential temperature  C     tRef      :: reference vertical profile for potential temperature
547  C     sRef      :: reference vertical profile for salinity/specific humidity  C     sRef      :: reference vertical profile for salinity/specific humidity
548  C     phiRef    :: reference potential (pressure/rho, geopotential) profile  C     phiRef    :: reference potential (pressure/rho, geopotential) profile
549  C     dBdrRef   :: vertical gradient of reference boyancy  [(m/s/r)^2)]:  C     dBdrRef   :: vertical gradient of reference buoyancy  [(m/s/r)^2]:
550  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]  C               :: z-coord: = N^2_ref = Brunt-Vaissala frequency [s^-2]
551  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]  C               :: p-coord: = -(d.alpha/dp)_ref          [(m^2.s/kg)^2]
552  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),  C     rVel2wUnit :: units conversion factor (Non-Hydrostatic code),
# Line 520  C     rUnit2mass :: units conversion fac Line 563  C     rUnit2mass :: units conversion fac
563  C                :: from vertical r-coordinate unit to mass per unit area [kg/m2].  C                :: from vertical r-coordinate unit to mass per unit area [kg/m2].
564  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;  C                :: z-coord: = rhoConst  ( [m] * rho = [kg/m2] ) ;
565  C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;  C                :: p-coord: = 1/gravity ( [Pa] /  g = [kg/m2] ) ;
 C     xgOrigin   :: Origin of the X-axis (Cartesian Grid) / Longitude of Western  
 C                :: most cell face (Lat-Lon grid) (Note: this is an "inert"  
 C                :: parameter but it makes geographical references simple.)  
 C     ygOrigin   :: Origin of the Y-axis (Cartesian Grid) / Latitude of Southern  
 C                :: most face (Lat-Lon grid).  
566  C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).  C     rSphere    :: Radius of sphere for a spherical polar grid ( m ).
567  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).  C     recip_rSphere  :: Reciprocal radius of sphere ( m ).
568    C     radius_fromHorizGrid :: sphere Radius of input horiz. grid (Curvilinear Grid)
569  C     f0         :: Reference coriolis parameter ( 1/s )  C     f0         :: Reference coriolis parameter ( 1/s )
570  C                   ( Southern edge f for beta plane )  C                   ( Southern edge f for beta plane )
571  C     beta       :: df/dy ( s^-1.m^-1 )  C     beta       :: df/dy ( s^-1.m^-1 )
572    C     fPrime     :: Second Coriolis parameter ( 1/s ), related to Y-component
573    C                   of rotation (reference value = 2.Omega.Cos(Phi))
574  C     omega      :: Angular velocity ( rad/s )  C     omega      :: Angular velocity ( rad/s )
575  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)  C     rotationPeriod :: Rotation period (s) (= 2.pi/omega)
576  C     viscArNr   :: vertical profile of Eddy viscosity coeff.  C     viscArNr   :: vertical profile of Eddy viscosity coeff.
# Line 576  C     viscA4GridMax:: maximum and minimu Line 617  C     viscA4GridMax:: maximum and minimu
617  C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity  C     viscA4GridMin::  in terms of non-dimensional grid-size dependent viscosity
618  C     diffKhT   :: Laplacian diffusion coeff. for mixing of  C     diffKhT   :: Laplacian diffusion coeff. for mixing of
619  C                 heat laterally ( m^2/s )  C                 heat laterally ( m^2/s )
 C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.  
 C                 for mixing of heat vertically ( units of r^2/s )  
620  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of  C     diffK4T   :: Biharmonic diffusion coeff. for mixing of
621  C                 heat laterally ( m^4/s )  C                 heat laterally ( m^4/s )
622    C     diffKrNrT :: vertical profile of Laplacian diffusion coeff.
623    C                 for mixing of heat vertically ( units of r^2/s )
624    C     diffKr4T  :: vertical profile of Biharmonic diffusion coeff.
625    C                 for mixing of heat vertically ( units of r^4/s )
626  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of  C     diffKhS  ::  Laplacian diffusion coeff. for mixing of
627  C                 salt laterally ( m^2/s )  C                 salt laterally ( m^2/s )
 C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.  
 C                 for mixing of salt vertically ( units of r^2/s ),  
628  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of  C     diffK4S   :: Biharmonic diffusion coeff. for mixing of
629  C                 salt laterally ( m^4/s )  C                 salt laterally ( m^4/s )
630    C     diffKrNrS :: vertical profile of Laplacian diffusion coeff.
631    C                 for mixing of salt vertically ( units of r^2/s ),
632    C     diffKr4S  :: vertical profile of Biharmonic diffusion coeff.
633    C                 for mixing of salt vertically ( units of r^4/s )
634  C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979  C     diffKrBL79surf :: T/S surface diffusivity (m^2/s) Bryan and Lewis, 1979
635  C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979  C     diffKrBL79deep :: T/S deep diffusivity (m^2/s) Bryan and Lewis, 1979
636  C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979  C     diffKrBL79scl  :: depth scale for arctan fn (m) Bryan and Lewis, 1979
# Line 606  C                    are referenced to t Line 651  C                    are referenced to t
651  C     deltaTMom    :: Timestep for momemtum equations ( s )  C     deltaTMom    :: Timestep for momemtum equations ( s )
652  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k  C     dTtracerLev  :: Timestep for tracer equations ( s ), function of level k
653  C     deltaTfreesurf :: Timestep for free-surface equation ( s )  C     deltaTfreesurf :: Timestep for free-surface equation ( s )
654  C     freesurfFac  :: Parameter to turn implicit free surface term on or off  C     freeSurfFac  :: Parameter to turn implicit free surface term on or off
655  C                    freesurfac = 1. uses implicit free surface  C                     freeSurFac = 1. uses implicit free surface
656  C                    freesurfac = 0. uses rigid lid  C                     freeSurFac = 0. uses rigid lid
657  C     abEps        :: Adams-Bashforth-2 stabilizing weight  C     abEps        :: Adams-Bashforth-2 stabilizing weight
658  C     alph_AB      :: Adams-Bashforth-3 primary factor  C     alph_AB      :: Adams-Bashforth-3 primary factor
659  C     beta_AB      :: Adams-Bashforth-3 secondary factor  C     beta_AB      :: Adams-Bashforth-3 secondary factor
# Line 633  C     endTime       :: Ending time for t Line 678  C     endTime       :: Ending time for t
678  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).  C     chkPtFreq     :: Frequency of rolling check pointing ( s ).
679  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).  C     pChkPtFreq    :: Frequency of permanent check pointing ( s ).
680  C     dumpFreq      :: Frequency with which model state is written to  C     dumpFreq      :: Frequency with which model state is written to
681  C                     post-processing files ( s ).  C                      post-processing files ( s ).
682  C     diagFreq      :: Frequency with which model writes diagnostic output  C     diagFreq      :: Frequency with which model writes diagnostic output
683  C                     of intermediate quantities.  C                      of intermediate quantities.
684  C     afFacMom      :: Advection of momentum term tracer parameter  C     afFacMom      :: Advection of momentum term tracer parameter
685  C     vfFacMom      :: Momentum viscosity tracer parameter  C     vfFacMom      :: Momentum viscosity tracer parameter
686  C     pfFacMom      :: Momentum pressure forcing tracer parameter  C     pfFacMom      :: Momentum pressure forcing tracer parameter
# Line 662  C     convertFW2Salt :: salinity, used t Line 707  C     convertFW2Salt :: salinity, used t
707  C                       (use model surface (local) value if set to -1)  C                       (use model surface (local) value if set to -1)
708  C     temp_EvPrRn :: temperature of Rain & Evap.  C     temp_EvPrRn :: temperature of Rain & Evap.
709  C     salt_EvPrRn :: salinity of Rain & Evap.  C     salt_EvPrRn :: salinity of Rain & Evap.
710    C     temp_addMass :: temperature of addMass array
711    C     salt_addMass :: salinity of addMass array
712  C        (notes: a) tracer content of Rain/Evap only used if both  C        (notes: a) tracer content of Rain/Evap only used if both
713  C                     NonLin_FrSurf & useRealFreshWater are set.  C                     NonLin_FrSurf & useRealFreshWater are set.
714  C                b) use model surface (local) value if set to UNSET_RL)  C                b) use model surface (local) value if set to UNSET_RL)
# Line 671  C     hMixSmooth  :: Smoothing parameter Line 718  C     hMixSmooth  :: Smoothing parameter
718  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]  C     ivdc_kappa  :: implicit vertical diffusivity for convection [m^2/s]
719  C     Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as  C     Ro_SeaLevel :: standard position of Sea-Level in "R" coordinate, used as
720  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)  C                    starting value (k=1) for vertical coordinate (rf(1)=Ro_SeaLevel)
721    C     rSigmaBnd   :: vertical position (in r-unit) of r/sigma transition (Hybrid-Sigma)
722  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)  C     sideDragFactor     :: side-drag scaling factor (used only if no_slip_sides)
723  C                           (default=2: full drag ; =1: gives half-slip BC)  C                           (default=2: full drag ; =1: gives half-slip BC)
724  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)  C     bottomDragLinear    :: Linear    bottom-drag coefficient (units of [r]/s)
# Line 686  C     thetaEuler    :: Euler angle, rota Line 734  C     thetaEuler    :: Euler angle, rota
734  C     psiEuler      :: Euler angle, rotation about new z-axis  C     psiEuler      :: Euler angle, rotation about new z-axis
735        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,        COMMON /PARM_R/ cg2dTargetResidual, cg2dTargetResWunit,
736       & cg2dpcOffDFac, cg3dTargetResidual,       & cg2dpcOffDFac, cg3dTargetResidual,
737       & delR, delRc, delX, delY,       & delR, delRc, xgOrigin, ygOrigin,
738       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,       & deltaT, deltaTmom, dTtracerLev, deltaTfreesurf, deltaTClock,
739       & abEps, alph_AB, beta_AB,       & abEps, alph_AB, beta_AB,
740       & xgOrigin, ygOrigin, rSphere, recip_RSphere, f0, beta,       & rSphere, recip_rSphere, radius_fromHorizGrid,
741       & viscAh, viscAhW, viscAhMax,       & f0, beta, fPrime, omega, rotationPeriod,
742         & viscFacAdj, viscAh, viscAhW, viscAhMax,
743       & viscAhGrid, viscAhGridMax, viscAhGridMin,       & viscAhGrid, viscAhGridMax, viscAhGridMin,
744       & viscC2leith, viscC2leithD,       & viscC2leith, viscC2leithD,
745       & viscC2smag, viscC4smag,       & viscC2smag, viscC4smag,
# Line 699  C     psiEuler      :: Euler angle, rota Line 748  C     psiEuler      :: Euler angle, rota
748       & viscA4Grid, viscA4GridMax, viscA4GridMin,       & viscA4Grid, viscA4GridMax, viscA4GridMin,
749       & viscAhReMax, viscA4ReMax,       & viscAhReMax, viscA4ReMax,
750       & viscC4leith, viscC4leithD, viscArNr,       & viscC4leith, viscC4leithD, viscArNr,
751       & diffKhT, diffK4T, diffKrNrT,       & diffKhT, diffK4T, diffKrNrT, diffKr4T,
752       & diffKhS, diffK4S, diffKrNrS,       & diffKhS, diffK4S, diffKrNrS, diffKr4S,
753       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,       & diffKrBL79surf, diffKrBL79deep, diffKrBL79scl, diffKrBL79Ho,
754       & BL79LatVary,       & BL79LatVary,
755       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,       & diffKrBLEQsurf, diffKrBLEQdeep, diffKrBLEQscl, diffKrBLEQHo,
# Line 708  C     psiEuler      :: Euler angle, rota Line 757  C     psiEuler      :: Euler angle, rota
757       & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,       & freeSurfFac, implicSurfPress, implicDiv2Dflow, implicitNHPress,
758       & hFacMin, hFacMinDz, hFacInf, hFacSup,       & hFacMin, hFacMinDz, hFacInf, hFacSup,
759       & gravity, recip_gravity, gBaro,       & gravity, recip_gravity, gBaro,
760       & rhonil, recip_rhonil, rhoConst, recip_rhoConst,       & rhoNil, rhoConst, recip_rhoConst,
761       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,       & rhoFacC, recip_rhoFacC, rhoFacF, recip_rhoFacF,
762       & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,       & rhoConstFresh, rho1Ref, tRef, sRef, phiRef, dBdrRef,
763       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,       & rVel2wUnit, wUnit2rVel, mass2rUnit, rUnit2mass,
# Line 716  C     psiEuler      :: Euler angle, rota Line 765  C     psiEuler      :: Euler angle, rota
765       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,       & chkPtFreq, pChkPtFreq, dumpFreq, adjDumpFreq,
766       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,       & diagFreq, taveFreq, tave_lastIter, monitorFreq, adjMonitorFreq,
767       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,       & afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom,
768       & cosPower, cAdjFreq, omega, rotationPeriod,       & cosPower, cAdjFreq,
769       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,       & tauThetaClimRelax, tauSaltClimRelax, latBandClimRelax,
770       & externForcingCycle, externForcingPeriod,       & externForcingCycle, externForcingPeriod,
771       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,       & convertFW2Salt, temp_EvPrRn, salt_EvPrRn,
772       & hFacMinDr, hFacMinDp,       & temp_addMass, salt_addMass, hFacMinDr, hFacMinDp,
773       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth, Ro_SeaLevel,       & ivdc_kappa, hMixCriteria, dRhoSmall, hMixSmooth,
774         & Ro_SeaLevel, rSigmaBnd,
775       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,       & sideDragFactor, bottomDragLinear, bottomDragQuadratic, nh_Am2,
776       & smoothAbsFuncRange,       & smoothAbsFuncRange,
777       & tCylIn, tCylOut,       & tCylIn, tCylOut,
# Line 733  C     psiEuler      :: Euler angle, rota Line 783  C     psiEuler      :: Euler angle, rota
783        _RL cg2dpcOffDFac        _RL cg2dpcOffDFac
784        _RL delR(Nr)        _RL delR(Nr)
785        _RL delRc(Nr+1)        _RL delRc(Nr+1)
786        _RL delX(Nx)        _RL xgOrigin
787        _RL delY(Ny)        _RL ygOrigin
788        _RL deltaT        _RL deltaT
789        _RL deltaTClock        _RL deltaTClock
790        _RL deltaTmom        _RL deltaTmom
791        _RL dTtracerLev(Nr)        _RL dTtracerLev(Nr)
792        _RL deltaTfreesurf        _RL deltaTfreesurf
793        _RL abEps, alph_AB, beta_AB        _RL abEps, alph_AB, beta_AB
       _RL xgOrigin  
       _RL ygOrigin  
794        _RL rSphere        _RL rSphere
795        _RL recip_rSphere        _RL recip_rSphere
796          _RL radius_fromHorizGrid
797        _RL f0        _RL f0
798          _RL beta
799          _RL fPrime
800          _RL omega
801          _RL rotationPeriod
802        _RL freeSurfFac        _RL freeSurfFac
803        _RL implicSurfPress        _RL implicSurfPress
804        _RL implicDiv2Dflow        _RL implicDiv2Dflow
# Line 756  C     psiEuler      :: Euler angle, rota Line 809  C     psiEuler      :: Euler angle, rota
809        _RL hFacMinDr        _RL hFacMinDr
810        _RL hFacInf        _RL hFacInf
811        _RL hFacSup        _RL hFacSup
       _RL beta  
812        _RL viscArNr(Nr)        _RL viscArNr(Nr)
813          _RL viscFacAdj
814        _RL viscAh        _RL viscAh
815        _RL viscAhW        _RL viscAhW
816        _RL viscAhD        _RL viscAhD
# Line 779  C     psiEuler      :: Euler angle, rota Line 832  C     psiEuler      :: Euler angle, rota
832        _RL viscC4leithD        _RL viscC4leithD
833        _RL viscC4smag        _RL viscC4smag
834        _RL diffKhT        _RL diffKhT
       _RL diffKrNrT(Nr)  
835        _RL diffK4T        _RL diffK4T
836          _RL diffKrNrT(Nr)
837          _RL diffKr4T(Nr)
838        _RL diffKhS        _RL diffKhS
       _RL diffKrNrS(Nr)  
839        _RL diffK4S        _RL diffK4S
840          _RL diffKrNrS(Nr)
841          _RL diffKr4S(Nr)
842        _RL diffKrBL79surf        _RL diffKrBL79surf
843        _RL diffKrBL79deep        _RL diffKrBL79deep
844        _RL diffKrBL79scl        _RL diffKrBL79scl
# Line 797  C     psiEuler      :: Euler angle, rota Line 852  C     psiEuler      :: Euler angle, rota
852        _RL gravity        _RL gravity
853        _RL recip_gravity        _RL recip_gravity
854        _RL gBaro        _RL gBaro
855        _RL rhonil,        recip_rhonil        _RL rhoNil
856        _RL rhoConst,      recip_rhoConst        _RL rhoConst,      recip_rhoConst
857        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)        _RL rhoFacC(Nr),   recip_rhoFacC(Nr)
858        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)        _RL rhoFacF(Nr+1), recip_rhoFacF(Nr+1)
# Line 829  C     psiEuler      :: Euler angle, rota Line 884  C     psiEuler      :: Euler angle, rota
884        _RL mtFacMom        _RL mtFacMom
885        _RL cosPower        _RL cosPower
886        _RL cAdjFreq        _RL cAdjFreq
       _RL omega  
       _RL rotationPeriod  
887        _RL tauThetaClimRelax        _RL tauThetaClimRelax
888        _RL tauSaltClimRelax        _RL tauSaltClimRelax
889        _RL latBandClimRelax        _RL latBandClimRelax
# Line 839  C     psiEuler      :: Euler angle, rota Line 892  C     psiEuler      :: Euler angle, rota
892        _RL convertFW2Salt        _RL convertFW2Salt
893        _RL temp_EvPrRn        _RL temp_EvPrRn
894        _RL salt_EvPrRn        _RL salt_EvPrRn
895          _RL temp_addMass
896          _RL salt_addMass
897        _RL ivdc_kappa        _RL ivdc_kappa
898        _RL hMixCriteria        _RL hMixCriteria
899        _RL dRhoSmall        _RL dRhoSmall
900        _RL hMixSmooth        _RL hMixSmooth
901        _RL Ro_SeaLevel        _RL Ro_SeaLevel
902          _RL rSigmaBnd
903        _RL sideDragFactor        _RL sideDragFactor
904        _RL bottomDragLinear        _RL bottomDragLinear
905        _RL bottomDragQuadratic        _RL bottomDragQuadratic
# Line 890  C Logical flags for selecting packages Line 946  C Logical flags for selecting packages
946        LOGICAL useKPP        LOGICAL useKPP
947        LOGICAL useGMRedi        LOGICAL useGMRedi
948        LOGICAL useDOWN_SLOPE        LOGICAL useDOWN_SLOPE
949          LOGICAL useBBL
950        LOGICAL useCAL        LOGICAL useCAL
951        LOGICAL useEXF        LOGICAL useEXF
952        LOGICAL useBulkForce        LOGICAL useBulkForce
# Line 897  C Logical flags for selecting packages Line 954  C Logical flags for selecting packages
954        LOGICAL useCheapAML        LOGICAL useCheapAML
955        LOGICAL useGrdchk        LOGICAL useGrdchk
956        LOGICAL useSMOOTH        LOGICAL useSMOOTH
957          LOGICAL usePROFILES
958        LOGICAL useECCO        LOGICAL useECCO
959        LOGICAL useSBO        LOGICAL useSBO
960        LOGICAL useFLT        LOGICAL useFLT
# Line 905  C Logical flags for selecting packages Line 963  C Logical flags for selecting packages
963        LOGICAL useRBCS        LOGICAL useRBCS
964        LOGICAL useOffLine        LOGICAL useOffLine
965        LOGICAL useMATRIX        LOGICAL useMATRIX
966          LOGICAL useFRAZIL
967        LOGICAL useSEAICE        LOGICAL useSEAICE
968        LOGICAL useSALT_PLUME        LOGICAL useSALT_PLUME
969        LOGICAL useShelfIce        LOGICAL useShelfIce
970          LOGICAL useStreamIce
971          LOGICAL useICEFRONT
972        LOGICAL useThSIce        LOGICAL useThSIce
973        LOGICAL useATM2d        LOGICAL useATM2d
974        LOGICAL useAIM        LOGICAL useAIM
# Line 924  C Logical flags for selecting packages Line 985  C Logical flags for selecting packages
985        COMMON /PARM_PACKAGES/        COMMON /PARM_PACKAGES/
986       &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,       &        useGAD, useOBCS, useSHAP_FILT, useZONAL_FILT,
987       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,       &        useOPPS, usePP81, useMY82, useGGL90, useKPP,
988       &        useGMRedi, useDOWN_SLOPE,       &        useGMRedi, useBBL, useDOWN_SLOPE,
989       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,       &        useCAL, useEXF, useBulkForce, useEBM, useCheapAML,
990       &        useGrdchk, useSMOOTH, useECCO, useSBO, useFLT,       &        useGrdchk,useSMOOTH,usePROFILES,useECCO,useSBO, useFLT,
991       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,       &        usePTRACERS, useGCHEM, useRBCS, useOffLine, useMATRIX,
992       &        useSEAICE, useSALT_PLUME, useShelfIce, useThSIce,       &        useFRAZIL, useSEAICE, useSALT_PLUME, useShelfIce,
993         &        useStreamIce, useICEFRONT, useThSIce,
994       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,       &        useATM2D, useAIM, useLand, useFizhi, useGridAlt,
995       &        useDiagnostics, useREGRID, useLayers, useMNC,       &        useDiagnostics, useREGRID, useLayers, useMNC,
996       &        useRunClock, useEMBED_FILES,       &        useRunClock, useEMBED_FILES,
997       &        useMYPACKAGE       &        useMYPACKAGE
998    
999    C     Logical flags for turning off parts of the code in adjoint mode
1000          LOGICAL useKPPinAdMode, useKPPinFwdMode
1001          LOGICAL useGMrediInAdMode, useGMrediInFwdMode
1002          LOGICAL useSEAICEinAdMode, useSEAICEinFwdMode
1003          COMMON /PARM_PACKAGES_ADJ/
1004         &       useKPPinAdMode, useKPPinFwdMode,
1005         &       useGMrediInAdMode, useGMrediInFwdMode,
1006         &       useSEAICEinAdMode, useSEAICEinFwdMode
1007    
1008  CEH3 ;;; Local Variables: ***  CEH3 ;;; Local Variables: ***
1009  CEH3 ;;; mode:fortran ***  CEH3 ;;; mode:fortran ***
1010  CEH3 ;;; End: ***  CEH3 ;;; End: ***
Legend:
Removed from v.1.234  
changed lines
  Added in v.1.263
  ViewVC Help
Powered by ViewVC 1.1.22