| 4 |
C | PARAMS.h | |
C | PARAMS.h | |
| 5 |
C | o Header file defining model "parameters". | |
C | o Header file defining model "parameters". | |
| 6 |
C |==========================================================| |
C |==========================================================| |
| 7 |
C | The values from the model's standard input file are | |
C | The values from the model standard input file are | |
| 8 |
C | stored into the variables held here. Notes describing | |
C | stored into the variables held here. Notes describing | |
| 9 |
C | the parameters can also be found here. | |
C | the parameters can also be found here. | |
| 10 |
C \==========================================================/ |
C \==========================================================/ |
| 11 |
|
|
| 12 |
|
C Macros for special grid options |
| 13 |
|
#include "PARAMS_MACROS.h" |
| 14 |
|
|
| 15 |
C-- Contants |
C-- Contants |
|
C nOBands - No. of offline data time bands |
|
|
INTEGER nOBands |
|
|
PARAMETER ( nOBands = 12 ) |
|
| 16 |
C Useful physical values |
C Useful physical values |
| 17 |
Real*8 PI |
Real*8 PI |
| 18 |
PARAMETER ( PI = 3.14159265358979323844D0 ) |
PARAMETER ( PI = 3.14159265358979323844D0 ) |
| 19 |
Real*8 deg2rad |
Real*8 deg2rad |
| 20 |
PARAMETER ( deg2rad = 2.D0*PI/360.D0 ) |
PARAMETER ( deg2rad = 2.D0*PI/360.D0 ) |
| 21 |
|
|
| 22 |
|
C Symbolic values |
| 23 |
|
C precXXXX - Used to indicate what precision to use for |
| 24 |
|
C dumping model state. |
| 25 |
|
INTEGER precFloat32 |
| 26 |
|
PARAMETER ( precFloat32 = 32 ) |
| 27 |
|
INTEGER precFloat64 |
| 28 |
|
PARAMETER ( precFloat64 = 64 ) |
| 29 |
|
C UNSET_xxx - Used to indicate variables that have not been given a value |
| 30 |
|
Real*8 UNSET_FLOAT8 |
| 31 |
|
PARAMETER ( UNSET_FLOAT8 = 1.234567D5 ) |
| 32 |
|
Real*4 UNSET_FLOAT4 |
| 33 |
|
PARAMETER ( UNSET_FLOAT4 = 1.234567E5 ) |
| 34 |
|
_RL UNSET_RL |
| 35 |
|
PARAMETER ( UNSET_RL = 1.234567D5 ) |
| 36 |
|
_RS UNSET_RS |
| 37 |
|
PARAMETER ( UNSET_RS = 1.234567E5 ) |
| 38 |
|
INTEGER UNSET_I |
| 39 |
|
PARAMETER ( UNSET_I = 123456789 ) |
| 40 |
|
|
| 41 |
|
C Checkpoint data |
| 42 |
|
INTEGER maxNoChkptLev |
| 43 |
|
PARAMETER ( maxNoChkptLev = 2 ) |
| 44 |
|
|
| 45 |
C-- COMMON /PARM_C/ Character valued parameters used by the model. |
C-- COMMON /PARM_C/ Character valued parameters used by the model. |
| 46 |
C oBandId - Offline dataset identifiers for different periods. |
C checkPtSuff - List of checkpoint file suffices |
| 47 |
COMMON /PARM_C/ oBandId |
C bathyFile - File containing bathymetry. If not defined bathymetry |
| 48 |
CHARACTER*3 oBandId(nOBands) |
C is taken from inline function. |
| 49 |
|
C hydrogThetaFile - File containing initial hydrographic data for potential |
| 50 |
|
C temperature. |
| 51 |
|
C hydrogSaltFile - File containing initial hydrographic data for salinity. |
| 52 |
|
C zonalWindFile - File containing zonal wind data |
| 53 |
|
C meridWindFile - File containing meridional wind data |
| 54 |
|
C thetaClimFile - File containing theta climataology used |
| 55 |
|
C in relaxation term -lambda(theta-theta*) |
| 56 |
|
C saltClimFile - File containing salt climataology used |
| 57 |
|
C in relaxation term -lambda(salt-salt*) |
| 58 |
|
C surfQfile - File containing surface heat flux |
| 59 |
|
C EmPmRfile - File containing surface fresh water flux |
| 60 |
|
C buoyancyRelation - Flag used to indicate which relation to use to |
| 61 |
|
C get buoyancy. |
| 62 |
|
COMMON /PARM_C/ checkPtSuff, |
| 63 |
|
& bathyFile, hydrogThetaFile, hydrogSaltFile, |
| 64 |
|
& zonalWindFile, meridWindFile, thetaClimFile, |
| 65 |
|
& saltClimFile, buoyancyRelation, |
| 66 |
|
& EmPmRfile,surfQfile |
| 67 |
|
CHARACTER*(5) checkPtSuff(maxNoChkptLev) |
| 68 |
|
CHARACTER*(MAX_LEN_FNAM) bathyFile |
| 69 |
|
CHARACTER*(MAX_LEN_FNAM) hydrogThetaFile |
| 70 |
|
CHARACTER*(MAX_LEN_FNAM) hydrogSaltFile |
| 71 |
|
CHARACTER*(MAX_LEN_FNAM) zonalWindFile |
| 72 |
|
CHARACTER*(MAX_LEN_FNAM) meridWindFile |
| 73 |
|
CHARACTER*(MAX_LEN_FNAM) thetaClimFile |
| 74 |
|
CHARACTER*(MAX_LEN_FNAM) saltClimFile |
| 75 |
|
CHARACTER*(MAX_LEN_FNAM) surfQfile |
| 76 |
|
CHARACTER*(MAX_LEN_FNAM) EmPmRfile |
| 77 |
|
CHARACTER*(MAX_LEN_FNAM) buoyancyRelation |
| 78 |
|
|
| 79 |
C-- COMMON /PARM_I/ Integer valued parameters used by the model. |
C-- COMMON /PARM_I/ Integer valued parameters used by the model. |
| 80 |
C cg2dMaxIters - Maximum number of iterations in the |
C cg2dMaxIters - Maximum number of iterations in the |
| 81 |
C two-dimensional con. grad solver. |
C two-dimensional con. grad solver. |
| 82 |
C cg2dChkResFreq - Frequency with which to check residual |
C cg2dChkResFreq - Frequency with which to check residual |
| 83 |
C in con. grad solver. |
C in con. grad solver. |
| 84 |
|
C cg3dMaxIters - Maximum number of iterations in the |
| 85 |
|
C three-dimensional con. grad solver. |
| 86 |
|
C cg3dChkResFreq - Frequency with which to check residual |
| 87 |
|
C in con. grad solver. |
| 88 |
C nIter0 - Start time-step number of for this run |
C nIter0 - Start time-step number of for this run |
| 89 |
C nTimeSteps - Number of timesteps to execute |
C nTimeSteps - Number of timesteps to execute |
| 90 |
C numStepsPerPickup - For offline setup. Frequency of pickup |
C numStepsPerPickup - For offline setup. Frequency of pickup |
| 91 |
C of flow fields. |
C of flow fields. |
| 92 |
|
C writeStatePrec - Precision used for writing model state. |
| 93 |
|
C writeBinaryPrec - Precision used for writing binary files |
| 94 |
|
C readBinaryPrec - Precision used for reading binary files |
| 95 |
|
C nCheckLev - Holds current checkpoint level |
| 96 |
|
C nShap - "Order" of shapiro filter to apply to |
| 97 |
|
C model prognositic fields. |
| 98 |
|
C nShap == 1 => del2 |
| 99 |
|
C nShap == 2 => del4 |
| 100 |
|
C nShap == 3 => del6 |
| 101 |
|
C etc... |
| 102 |
|
|
| 103 |
COMMON /PARM_I/ |
COMMON /PARM_I/ |
| 104 |
& cg2dMaxIters, |
& cg2dMaxIters, |
| 105 |
& cg2dChkResFreq, |
& cg2dChkResFreq, |
| 106 |
& nIter0, nTimeSteps, |
& cg3dMaxIters, |
| 107 |
& numStepsPerPickup |
& cg3dChkResFreq, |
| 108 |
|
& nIter0, nTimeSteps, nEndIter, |
| 109 |
|
& numStepsPerPickup, |
| 110 |
|
& writeStatePrec, nCheckLev, |
| 111 |
|
& writeBinaryPrec, readBinaryPrec, |
| 112 |
|
& nShap |
| 113 |
INTEGER cg2dMaxIters |
INTEGER cg2dMaxIters |
| 114 |
INTEGER cg2dChkResFreq |
INTEGER cg2dChkResFreq |
| 115 |
|
INTEGER cg3dMaxIters |
| 116 |
|
INTEGER cg3dChkResFreq |
| 117 |
INTEGER nIter0 |
INTEGER nIter0 |
| 118 |
INTEGER nTimeSteps |
INTEGER nTimeSteps |
| 119 |
|
INTEGER nEndIter |
| 120 |
INTEGER numStepsPerPickup |
INTEGER numStepsPerPickup |
| 121 |
|
INTEGER writeStatePrec |
| 122 |
|
INTEGER writeBinaryPrec |
| 123 |
|
INTEGER readBinaryPrec |
| 124 |
|
INTEGER nCheckLev |
| 125 |
|
INTEGER nShap |
| 126 |
|
|
| 127 |
C-- COMMON /PARM_L/ Logical valued parameters used by the model. |
C-- COMMON /PARM_L/ Logical valued parameters used by the model. |
| 128 |
C usingCartesianGrid - If TRUE grid generation will be in a cartesian |
C usingCartesianGrid - If TRUE grid generation will be in a cartesian |
| 129 |
C coordinate frame. |
C coordinate frame. |
| 130 |
C usingSphericalPolarGrid - If TRUE grid generation will be in a |
C usingSphericalPolarGrid - If TRUE grid generation will be in a |
| 131 |
C spherical polar frame. |
C spherical polar frame. |
| 132 |
|
C no_slip_sides - Impose "no-slip" at lateral boundaries. |
| 133 |
|
C no_slip_bottom- Impose "no-slip" at bottom boundary. |
| 134 |
C momViscosity - Flag which turns momentum friction terms on and off. |
C momViscosity - Flag which turns momentum friction terms on and off. |
| 135 |
C momAdvection - Flag which turns advection of momentum on and off. |
C momAdvection - Flag which turns advection of momentum on and off. |
| 136 |
C momForcing - Flag which turns external forcing of momentum on |
C momForcing - Flag which turns external forcing of momentum on |
| 137 |
C and off. |
C and off. |
| 138 |
|
C momPressureForcing - Flag which turns pressure term in momentum equation |
| 139 |
|
C on and off. |
| 140 |
|
C metricTerms - Flag which turns metric terms on or off. |
| 141 |
|
C usingSphericalPolarMTerms - If TRUE use spherical polar metric terms. |
| 142 |
C useCoriolis - Flag which turns the coriolis terms on and off. |
C useCoriolis - Flag which turns the coriolis terms on and off. |
| 143 |
C tempDiffusion - Flag which turns diffusion of temperature on |
C tempDiffusion - Flag which turns diffusion of temperature on |
| 144 |
C and off. |
C and off. |
| 152 |
C and off. |
C and off. |
| 153 |
C saltForcing - Flag which turns external forcing of salinit on |
C saltForcing - Flag which turns external forcing of salinit on |
| 154 |
C and off. |
C and off. |
| 155 |
|
C implicitFreeSurface - Set to true to use implcit free surface |
| 156 |
|
C rigidLid - Set to true to use rigid lid |
| 157 |
|
C momStepping - Turns momentum equation time-stepping off |
| 158 |
|
C tempStepping - Turns temperature equation time-stepping off |
| 159 |
|
C saltStepping - Turns salinity equation time-stepping off |
| 160 |
|
C useConstantF - Coriolis parameter set to f0 |
| 161 |
|
C useBetaPlaneF - Coriolis parameter set to f0 + beta.y |
| 162 |
|
C useSphereF - Coriolis parameter set to 2.omega.sin(phi) |
| 163 |
|
C implicitDiffusion - Turns implicit vertical diffusion on |
| 164 |
|
C implicitViscosity - Turns implicit vertical viscosity on |
| 165 |
|
C doThetaClimRelax - Set true if relaxation to temperature |
| 166 |
|
C climatology is required. |
| 167 |
|
C doSaltClimRelax - Set true if relaxation to salinity |
| 168 |
|
C climatology is required. |
| 169 |
|
C periodicExternalForcing - Set true if forcing is time-dependant |
| 170 |
|
C usingPCoords - Set to indicate that we are working in pressure |
| 171 |
|
C coords. |
| 172 |
|
C usingZCoords - Set to indicate that we are working in height |
| 173 |
|
C coords. |
| 174 |
|
C openBoundaries - Using open-boundaries |
| 175 |
|
C nonHydrostatic - Using non-hydrostatic terms |
| 176 |
|
C globalFiles - Selects between "global" and "tiled" files |
| 177 |
|
C allowFreezing - Allows water to freeze and form ice |
| 178 |
COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid, |
COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid, |
| 179 |
& momViscosity, momAdvection, momForcing, useCoriolis, |
& no_slip_sides,no_slip_bottom, |
| 180 |
& tempDiffusion, tempAdvection, tempForcing, |
& momViscosity, momAdvection, momForcing, useCoriolis, |
| 181 |
& saltDiffusion, saltAdvection, saltForcing |
& momPressureForcing,tempDiffusion, tempAdvection, tempForcing, |
| 182 |
|
& saltDiffusion, saltAdvection, saltForcing, |
| 183 |
|
& implicitFreeSurface, rigidLid, |
| 184 |
|
& momStepping, tempStepping, saltStepping, |
| 185 |
|
& metricTerms, usingSphericalPolarMTerms, |
| 186 |
|
& useConstantF, useBetaPlaneF, useSphereF, |
| 187 |
|
& implicitDiffusion, implicitViscosity, |
| 188 |
|
& doThetaClimRelax, doSaltClimRelax, |
| 189 |
|
& periodicExternalForcing, usingPCoords, usingZCoords, |
| 190 |
|
& openBoundaries, nonHydrostatic, globalFiles, |
| 191 |
|
& allowFreezing |
| 192 |
LOGICAL usingCartesianGrid |
LOGICAL usingCartesianGrid |
| 193 |
LOGICAL usingSphericalPolarGrid |
LOGICAL usingSphericalPolarGrid |
| 194 |
|
LOGICAL usingSphericalPolarMTerms |
| 195 |
|
LOGICAL no_slip_sides |
| 196 |
|
LOGICAL no_slip_bottom |
| 197 |
LOGICAL momViscosity |
LOGICAL momViscosity |
| 198 |
LOGICAL momAdvection |
LOGICAL momAdvection |
| 199 |
LOGICAL momForcing |
LOGICAL momForcing |
| 200 |
|
LOGICAL momPressureForcing |
| 201 |
LOGICAL useCoriolis |
LOGICAL useCoriolis |
| 202 |
LOGICAL tempDiffusion |
LOGICAL tempDiffusion |
| 203 |
LOGICAL tempAdvection |
LOGICAL tempAdvection |
| 205 |
LOGICAL saltDiffusion |
LOGICAL saltDiffusion |
| 206 |
LOGICAL saltAdvection |
LOGICAL saltAdvection |
| 207 |
LOGICAL saltForcing |
LOGICAL saltForcing |
| 208 |
|
LOGICAL implicitFreeSurface |
| 209 |
|
LOGICAL rigidLid |
| 210 |
|
LOGICAL momStepping |
| 211 |
|
LOGICAL tempStepping |
| 212 |
|
LOGICAL saltStepping |
| 213 |
|
LOGICAL metricTerms |
| 214 |
|
LOGICAL useConstantF |
| 215 |
|
LOGICAL useBetaPlaneF |
| 216 |
|
LOGICAL useSphereF |
| 217 |
|
LOGICAL implicitDiffusion |
| 218 |
|
LOGICAL implicitViscosity |
| 219 |
|
LOGICAL doThetaClimRelax |
| 220 |
|
LOGICAL doSaltClimRelax |
| 221 |
|
LOGICAL periodicExternalForcing |
| 222 |
|
LOGICAL usingPCoords |
| 223 |
|
LOGICAL usingZCoords |
| 224 |
|
LOGICAL openBoundaries |
| 225 |
|
LOGICAL nonHydrostatic |
| 226 |
|
LOGICAL globalFiles |
| 227 |
|
LOGICAL allowFreezing |
| 228 |
|
|
| 229 |
C-- COMMON /PARM_R/ "Real" valued parameters used by the model. |
C-- COMMON /PARM_R/ "Real" valued parameters used by the model. |
| 230 |
C cg2dTargetResidual |
C cg2dTargetResidual |
| 231 |
C - Target residual for cg2d solver. |
C - Target residual for cg2d solver. |
| 232 |
C delZ - Vertical grid spacing ( m ) - delZ is the distance |
C cg3dTargetResidual |
| 233 |
C between "w" surfaces. |
C - Target residual for cg3d solver. |
| 234 |
|
C cg2dpcOffDFac - Averaging weight for preconditioner off-diagonal. |
| 235 |
|
C Note. 20th May 1998 |
| 236 |
|
C I made a weird discovery! In the model paper we argue |
| 237 |
|
C for the form of the preconditioner used here ( see |
| 238 |
|
C A Finite-volume, Incompressible Navier-Stokes Model |
| 239 |
|
C ...., Marshall et. al ). The algebra gives a simple |
| 240 |
|
C 0.5 factor for the averaging of ac and aCw to get a |
| 241 |
|
C symmettric pre-conditioner. By using a factor of 0.51 |
| 242 |
|
C i.e. scaling the off-diagonal terms in the |
| 243 |
|
C preconditioner down slightly I managed to get the |
| 244 |
|
C number of iterations for convergence in a test case to |
| 245 |
|
C drop form 192 -> 134! Need to investigate this further! |
| 246 |
|
C For now I have introduced a parameter cg2dpcOffDFac which |
| 247 |
|
C defaults to 0.51 but can be set at runtime. |
| 248 |
|
C delP - Vertical grid spacing ( Pa ). |
| 249 |
|
C delZ - Vertical grid spacing ( m ). |
| 250 |
|
C delR - Vertical grid spacing ( units of r ). |
| 251 |
C delX - Separation between cell faces (m) or (deg), depending |
C delX - Separation between cell faces (m) or (deg), depending |
| 252 |
C delY on input flags. |
C delY on input flags. |
| 253 |
C gravity - Accel. due to gravity ( m/s^2 ) |
C gravity - Accel. due to gravity ( m/s^2 ) |
| 254 |
|
C recip_gravity and its inverse |
| 255 |
|
C gBaro - Accel. due to gravity used in barotropic equation ( m/s^2 ) |
| 256 |
C ronil - Reference density |
C ronil - Reference density |
| 257 |
|
C rhoConst - Vertically constant reference density |
| 258 |
C startTime - Start time for model ( s ) |
C startTime - Start time for model ( s ) |
| 259 |
C phiMin - Latitude of southern most cell face. |
C phiMin - Latitude of southern most cell face. |
| 260 |
C thetaMin - Longitude of western most cell face (this |
C thetaMin - Longitude of western most cell face (this |
| 261 |
C is an "inert" parameter but it is included |
C is an "inert" parameter but it is included |
| 262 |
C to make geographical references simple.) |
C to make geographical references simple.) |
| 263 |
C rSphere - Radius of sphere for a spherical polar grid ( m ). |
C rSphere - Radius of sphere for a spherical polar grid ( m ). |
| 264 |
|
C recip_RSphere - Reciprocal radius of sphere ( m ). |
| 265 |
C f0 - Reference coriolis parameter ( 1/s ) |
C f0 - Reference coriolis parameter ( 1/s ) |
| 266 |
C ( Southern edge f for beta plane ) |
C ( Southern edge f for beta plane ) |
| 267 |
C beta - df/dy ( s^-1.m^-1 ) |
C beta - df/dy ( s^-1.m^-1 ) |
| 268 |
|
C omega - Angular velocity ( rad/s ) |
| 269 |
C viscAh - Eddy viscosity coeff. for mixing of |
C viscAh - Eddy viscosity coeff. for mixing of |
| 270 |
C momentum laterally ( m^2/s ) |
C momentum laterally ( m^2/s ) |
| 271 |
C viscAz - Eddy viscosity coeff. for mixing of |
C viscAz - Eddy viscosity coeff. for mixing of |
| 272 |
C momentum vertically ( m^2/s ) |
C momentum vertically ( m^2/s ) |
| 273 |
|
C viscAp - Eddy viscosity coeff. for mixing of |
| 274 |
|
C momentum vertically ( Pa^2/s ) |
| 275 |
|
C viscAr - Eddy viscosity coeff. for mixing of |
| 276 |
|
C momentum vertically ( units of r^2/s ) |
| 277 |
C viscA4 - Biharmonic viscosity coeff. for mixing of |
C viscA4 - Biharmonic viscosity coeff. for mixing of |
| 278 |
C momentum laterally ( m^4/s ) |
C momentum laterally ( m^4/s ) |
| 279 |
C diffKhT - Laplacian diffusion coeff. for mixing of |
C diffKhT - Laplacian diffusion coeff. for mixing of |
| 280 |
C heat laterally ( m^2/s ) |
C heat laterally ( m^2/s ) |
| 281 |
C diffKzT - Laplacian diffusion coeff. for mixing of |
C diffKzT - Laplacian diffusion coeff. for mixing of |
| 282 |
C heat vertically ( m^2/s ) |
C heat vertically ( m^2/s ) |
| 283 |
|
C diffKpT - Laplacian diffusion coeff. for mixing of |
| 284 |
|
C heat vertically ( Pa^2/s ) |
| 285 |
|
C diffKrT - Laplacian diffusion coeff. for mixing of |
| 286 |
|
C heat vertically ( units of r^2/s ) |
| 287 |
C diffK4T - Biharmonic diffusion coeff. for mixing of |
C diffK4T - Biharmonic diffusion coeff. for mixing of |
| 288 |
C heat laterally ( m^4/s ) |
C heat laterally ( m^4/s ) |
| 289 |
C diffKhS - Laplacian diffusion coeff. for mixing of |
C diffKhS - Laplacian diffusion coeff. for mixing of |
| 290 |
C salt laterally ( m^2/s ) |
C salt laterally ( m^2/s ) |
| 291 |
C diffKzS - Laplacian diffusion coeff. for mixing of |
C diffKzS - Laplacian diffusion coeff. for mixing of |
| 292 |
C salt vertically ( m^2/s ) |
C salt vertically ( m^2/s ) |
| 293 |
|
C diffKpS - Laplacian diffusion coeff. for mixing of |
| 294 |
|
C salt vertically ( Pa^2/s ) |
| 295 |
|
C diffKrS - Laplacian diffusion coeff. for mixing of |
| 296 |
|
C salt vertically ( units of r^2/s ) |
| 297 |
C diffK4S - Biharmonic diffusion coeff. for mixing of |
C diffK4S - Biharmonic diffusion coeff. for mixing of |
| 298 |
C salt laterally ( m^4/s ) |
C salt laterally ( m^4/s ) |
| 299 |
C deltaT - Default timestep ( s ) |
C deltaT - Default timestep ( s ) |
| 300 |
|
C deltaTClock - Timestep used as model "clock". This determines the |
| 301 |
|
C IO frequencies and is used in tagging output. It can |
| 302 |
|
C be totally different to the dynamical time. Typically |
| 303 |
|
C it will be the deep-water timestep for accelerated runs. |
| 304 |
|
C Frequency of checkpointing and dumping of the model state |
| 305 |
|
C are referenced to this clock. ( s ) |
| 306 |
C deltaTMom - Timestep for momemtum equations ( s ) |
C deltaTMom - Timestep for momemtum equations ( s ) |
| 307 |
C deltaTtracer - Timestep for tracer equations ( s ) |
C deltaTtracer - Timestep for tracer equations ( s ) |
| 308 |
C tauCD - CD scheme coupling timescale ( 1/s ) |
C freesurfFac - Parameter to turn implicit free surface term on or off |
| 309 |
C rCD - CD scheme normalised coupling parameter ( 0-1 ) |
C freesurfac = 1. uses implicit free surface |
| 310 |
C GMmaxslope - max. slope allowed in GM/Redi tensor |
C freesurfac = 0. uses rigid lid |
| 311 |
C GMlength - Length to use in Visbeck et al. formula for K |
C hFacMin - Minimum fraction size of a cell (affects hFacC etc...) |
| 312 |
C GMalpha - alpha to use in Visbeck et al. formula for K |
C hFacMinDz - Minimum dimesional size of a cell (affects hFacC etc..., m) |
| 313 |
C GMdepth - Depth over which to integrate Richardson # (Visbeck et al.) |
C hFacMinDp - Minimum dimesional size of a cell (affects hFacC etc..., Pa) |
| 314 |
C GMbackground - background value of GM/Redi coefficient |
C hFacMinDr - Minimum dimesional size of a cell (affects hFacC etc..., units of r) |
| 315 |
C startTime - Starting time for this integration ( s ). |
C tauCD - CD scheme coupling timescale ( 1/s ) |
| 316 |
C endTime - Ending time for this integration ( s ). |
C rCD - CD scheme normalised coupling parameter ( 0-1 ) |
| 317 |
C chkPtFreq - Frequency of check pointing ( s ). |
C GMmaxslope - max. slope allowed in GM/Redi tensor |
| 318 |
C dumpFreq - Frequency with which model state is written to |
C GMlength - Length to use in Visbeck et al. formula for K (m) |
| 319 |
C post-processing files ( s ). |
C GMalpha - alpha to use in Visbeck et al. formula for K |
| 320 |
COMMON /PARM_R/ cg2dTargetResidual, delZ, delX, delY, deltaT, |
C GMdepth - Depth over which to integrate Richardson # (Visbeck et al.) |
| 321 |
& deltaTmom, deltaTtracer, abeps, startTime, phiMin, thetaMin, |
C GMkbackground - background value of GM/Redi diffusion coefficient ( m^2/s ) |
| 322 |
& rSphere, f0, fCori, beta, viscAh, viscAz, viscA4, diffKhT, diffKzT, |
C GMmaxval - max. value of KapGM allowed in GM/Redi scheme ( m^2/s ) |
| 323 |
& diffK4T, diffKhS, diffKzS, diffK4S, delT, tauCD, rCD, |
C startTime - Starting time for this integration ( s ). |
| 324 |
& GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground, |
C endTime - Ending time for this integration ( s ). |
| 325 |
& gravity, rhonil, tRef, sRef, |
C chkPtFreq - Frequency of rolling check pointing ( s ). |
| 326 |
& endTime, chkPtFreq, dumpFreq |
C pChkPtFreq - Frequency of permanent check pointing ( s ). |
| 327 |
|
C dumpFreq - Frequency with which model state is written to |
| 328 |
|
C post-processing files ( s ). |
| 329 |
|
C afFacMom - Advection of momentum term tracer parameter |
| 330 |
|
C vfFacMom - Momentum viscosity tracer parameter |
| 331 |
|
C pfFacMom - Momentum pressure forcing tracer parameter |
| 332 |
|
C cfFacMom - Coriolis term tracer parameter |
| 333 |
|
C foFacMom - Momentum forcing tracer parameter |
| 334 |
|
C mtFacMom - Metric terms tracer parameter |
| 335 |
|
C cosPower - Power of cosine of latitude to multiply viscosity |
| 336 |
|
C cAdjFreq - Frequency of convective adjustment |
| 337 |
|
C |
| 338 |
|
C taveFreq - Frequency with which time-averaged model state is written to |
| 339 |
|
C post-processing files ( s ). |
| 340 |
|
C tauThetaClimRelax - Relaxation to climatology time scale ( s ). |
| 341 |
|
C lambdaThetaClimRelax - Inverse time scale for relaxation ( 1/s ). |
| 342 |
|
C tauSaltClimRelax - Relaxation to climatology time scale ( s ). |
| 343 |
|
C lambdaSaltClimRelax - Inverse time scale for relaxation ( 1/s ). |
| 344 |
|
C externForcingPeriod - Is the period of which forcing varies (eg. 1 month) |
| 345 |
|
C externForcingCycle - Is the repeat time of the forcing (eg. 1 year) |
| 346 |
|
C (note: externForcingCycle must be an integer |
| 347 |
|
C number times externForcingPeriod) |
| 348 |
|
C horiVertRatio - Ratio on units in vertical to units in horizontal. |
| 349 |
|
C recip_horiVertRatio ( 1 if horiz in m and vertical in m ). |
| 350 |
|
C ( g*rho if horiz in m and vertical in Pa ). |
| 351 |
|
C latFFTFiltLo - Low latitude for FFT filtering of latitude |
| 352 |
|
C circles ( see filter*.F ) |
| 353 |
|
COMMON /PARM_R/ cg2dTargetResidual, cg2dpcOffDFac, |
| 354 |
|
& cg3dTargetResidual, |
| 355 |
|
& delP, delZ, delR, delX, delY, |
| 356 |
|
& deltaT,deltaTmom, deltaTtracer, deltaTClock,abeps, startTime, |
| 357 |
|
& phiMin, thetaMin, rSphere, recip_RSphere, f0, fCori, beta, |
| 358 |
|
& viscAh, viscAz, viscA4, viscAr, |
| 359 |
|
& diffKhT, diffKzT, diffK4T, diffKrT, |
| 360 |
|
& diffKhS, diffKzS, diffK4S, diffKrS, |
| 361 |
|
& delT, tauCD, rCD, freeSurfFac, hFacMin, hFacMinDz, |
| 362 |
|
& GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground,GMmaxval, |
| 363 |
|
& gravity, recip_Gravity, gBaro, rhonil, recip_rhonil, |
| 364 |
|
& recip_rhoConst, rhoConst, tRef, sRef, |
| 365 |
|
& endTime, chkPtFreq, pchkPtFreq, dumpFreq, taveFreq, |
| 366 |
|
& afFacMom, vfFacMom, pfFacMom, cfFacMom, foFacMom, mtFacMom, |
| 367 |
|
& cosPower, |
| 368 |
|
& cAdjFreq, omega, tauThetaClimRelax, lambdaThetaClimRelax, |
| 369 |
|
& tauSaltClimRelax, lambdaSaltClimRelax, |
| 370 |
|
& externForcingCycle, externForcingPeriod, |
| 371 |
|
& viscAp, diffKpT, diffKpS, hFacMinDr, hFacMinDp, |
| 372 |
|
& theta_S, specVol_S, horiVertRatio, recip_horiVertRatio, |
| 373 |
|
& latFFTFiltLo, ivdc_kappa |
| 374 |
|
|
| 375 |
_RL cg2dTargetResidual |
_RL cg2dTargetResidual |
| 376 |
_RL delZ(Nz) |
_RL cg3dTargetResidual |
| 377 |
|
_RL cg2dpcOffDFac |
| 378 |
|
_RL delZ(Nr) |
| 379 |
|
_RL delP(Nr) |
| 380 |
|
_RL delR(Nr) |
| 381 |
_RL delX(Nx) |
_RL delX(Nx) |
| 382 |
_RL delY(Ny) |
_RL delY(Ny) |
| 383 |
_RL deltaT |
_RL deltaT |
| 384 |
|
_RL deltaTClock |
| 385 |
_RL deltaTmom |
_RL deltaTmom |
| 386 |
_RL deltaTtracer |
_RL deltaTtracer |
| 387 |
_RL abeps |
_RL abeps |
| 388 |
_RL phiMin |
_RL phiMin |
| 389 |
_RL thetaMin |
_RL thetaMin |
| 390 |
_RL rSphere |
_RL rSphere |
| 391 |
|
_RL recip_RSphere |
| 392 |
_RL f0 |
_RL f0 |
| 393 |
|
_RL freeSurfFac |
| 394 |
|
_RL hFacMin |
| 395 |
|
_RL hFacMinDz |
| 396 |
|
_RL hFacMinDp |
| 397 |
|
_RL hFacMinDr |
| 398 |
_RL beta |
_RL beta |
| 399 |
_RL viscAh |
_RL viscAh |
| 400 |
_RL viscAz |
_RL viscAz |
| 401 |
|
_RL viscAp |
| 402 |
|
_RL viscAr |
| 403 |
_RL viscA4 |
_RL viscA4 |
| 404 |
_RL diffKhT |
_RL diffKhT |
| 405 |
|
_RL diffKrT |
| 406 |
_RL diffKzT |
_RL diffKzT |
| 407 |
|
_RL diffKpT |
| 408 |
_RL diffK4T |
_RL diffK4T |
| 409 |
_RL diffKhS |
_RL diffKhS |
| 410 |
|
_RL diffKrS |
| 411 |
_RL diffKzS |
_RL diffKzS |
| 412 |
|
_RL diffKpS |
| 413 |
_RL diffK4S |
_RL diffK4S |
| 414 |
_RL delt |
_RL delt |
| 415 |
_RL tauCD |
_RL tauCD |
| 419 |
_RL GMalpha |
_RL GMalpha |
| 420 |
_RL GMdepth |
_RL GMdepth |
| 421 |
_RL GMkbackground |
_RL GMkbackground |
| 422 |
|
_RL GMmaxval |
| 423 |
_RL gravity |
_RL gravity |
| 424 |
|
_RL recip_gravity |
| 425 |
|
_RL gBaro |
| 426 |
_RL rhonil |
_RL rhonil |
| 427 |
_RL tRef(Nz) |
_RL recip_rhonil |
| 428 |
_RL sRef(Nz) |
_RL rhoConst |
| 429 |
_RL Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) |
_RL recip_rhoConst |
| 430 |
|
_RL specVol_S(Nr) |
| 431 |
|
_RL tRef(Nr) |
| 432 |
|
_RL theta_S(Nr) |
| 433 |
|
_RL sRef(Nr) |
| 434 |
|
_RS Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) |
| 435 |
_RL startTime |
_RL startTime |
| 436 |
_RL endTime |
_RL endTime |
| 437 |
_RL chkPtFreq |
_RL chkPtFreq |
| 438 |
|
_RL pChkPtFreq |
| 439 |
_RL dumpFreq |
_RL dumpFreq |
| 440 |
|
_RL taveFreq |
| 441 |
|
_RL afFacMom |
| 442 |
|
_RL vfFacMom |
| 443 |
|
_RL pfFacMom |
| 444 |
|
_RL cfFacMom |
| 445 |
|
_RL foFacMom |
| 446 |
|
_RL mTFacMom |
| 447 |
|
_RL cosPower |
| 448 |
|
_RL cAdjFreq |
| 449 |
|
_RL omega |
| 450 |
|
_RL tauThetaClimRelax |
| 451 |
|
_RL lambdaThetaClimRelax |
| 452 |
|
_RL tauSaltClimRelax |
| 453 |
|
_RL lambdaSaltClimRelax |
| 454 |
|
_RL externForcingCycle |
| 455 |
|
_RL externForcingPeriod |
| 456 |
|
_RL horiVertRatio |
| 457 |
|
_RL recip_horiVertRatio |
| 458 |
|
_RL latFFTFiltLo |
| 459 |
|
_RL ivdc_kappa |
| 460 |
|
|
| 461 |
COMMON /PARM_A/ HeatCapacity_Cp, |
COMMON /PARM_A/ HeatCapacity_Cp,recip_Cp, |
| 462 |
& Lamba_theta |
& Lamba_theta |
| 463 |
_RL HeatCapacity_Cp |
_RL HeatCapacity_Cp |
| 464 |
_RL Lamba_theta |
_RL Lamba_theta |
| 465 |
|
_RL recip_Cp |
| 466 |
|
|
| 467 |
C Equation of State (polynomial coeffients) |
C Equation of State (polynomial coeffients) |
| 468 |
COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS |
COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS |
| 469 |
_RL eosC(Nz+1,9),eosSig0(Nz+1),eosRefT(Nz+1),eosRefS(Nz+1) |
_RL eosC(9,Nr+1),eosSig0(Nr+1),eosRefT(Nr+1),eosRefS(Nr+1) |
| 470 |
C Linear equation of state |
C Linear equation of state |
| 471 |
C tAlpha - Linear EOS thermal expansion coefficient ( 1/degree ). |
C tAlpha - Linear EOS thermal expansion coefficient ( 1/degree ). |
| 472 |
C sBeta - Linear EOS haline contraction coefficient. |
C sBeta - Linear EOS haline contraction coefficient. |
| 473 |
COMMON /PARM_EOS_LIN/ tAlpha,sBeta |
COMMON /PARM_EOS_LIN/ tAlpha,sBeta,eosType |
| 474 |
_RL tAlpha |
_RL tAlpha |
| 475 |
_RL sBeta |
_RL sBeta |
| 476 |
|
character*(6) eosType |
| 477 |
|
|
| 478 |
|
C These are input arrays (of integers) that contain the *absolute* |
| 479 |
|
C computational index of an open-boundary (OB) point. |
| 480 |
|
C A zero (0) element means there is no corresponding OB in that column/row. |
| 481 |
|
C The computational coordinate refers to "tracer" cells. |
| 482 |
|
C For a northern/southern OB, the OB V point is to the south/north. |
| 483 |
|
C For an eastern/western OB, the OB U point is to the west/east. |
| 484 |
|
C eg. |
| 485 |
|
C OB_Jnorth(3)=34 means that: |
| 486 |
|
C T( 3 ,34) is a an OB point |
| 487 |
|
C U(3:4,34) is a an OB point |
| 488 |
|
C V( 4 ,34) is a an OB point |
| 489 |
|
C while |
| 490 |
|
C OB_Jsouth(3)=1 means that: |
| 491 |
|
C T( 3 ,1) is a an OB point |
| 492 |
|
C U(3:4,1) is a an OB point |
| 493 |
|
C V( 4 ,2) is a an OB point |
| 494 |
|
C |
| 495 |
|
C For convenience, negative values for Jnorth/Ieast refer to |
| 496 |
|
C points relative to the Northern/Eastern edges of the model |
| 497 |
|
C eg. OB_Jnorth(3)=-1 means that the point (3,Ny-1) is a northern O-B. |
| 498 |
|
C |
| 499 |
|
COMMON /PARM_OB/ |
| 500 |
|
& OB_Jnorth,OB_Jsouth,OB_Ieast,OB_Iwest |
| 501 |
|
INTEGER OB_Jnorth(Nx) |
| 502 |
|
INTEGER OB_Jsouth(Nx) |
| 503 |
|
INTEGER OB_Ieast(Ny) |
| 504 |
|
INTEGER OB_Iwest(Ny) |
Parent Directory
| 
Revision Log
| 
Revision Graph
| 
Patch