| 1 |
C $Header: /u/gcmpack/models/MITgcmUV/model/src/ini_parms.F,v 1.9 1998/05/25 20:05:55 cnh Exp $ |
| 2 |
|
| 3 |
#include "CPP_EEOPTIONS.h" |
| 4 |
|
| 5 |
SUBROUTINE INI_PARMS( myThid ) |
| 6 |
C /==========================================================\ |
| 7 |
C | SUBROUTINE INI_PARMS | |
| 8 |
C | o Routine to set model "parameters" | |
| 9 |
C |==========================================================| |
| 10 |
C | Notes: | |
| 11 |
C | ====== | |
| 12 |
C | The present version of this routine is a place-holder. | |
| 13 |
C | A production version needs to handle parameters from an | |
| 14 |
C | external file and possibly reading in some initial field | |
| 15 |
C | values. | |
| 16 |
C \==========================================================/ |
| 17 |
|
| 18 |
C === Global variables === |
| 19 |
#include "SIZE.h" |
| 20 |
#include "EEPARAMS.h" |
| 21 |
#include "PARAMS.h" |
| 22 |
#include "CG2D.h" |
| 23 |
|
| 24 |
C === Routine arguments === |
| 25 |
C myThid - Number of this instance of INI_PARMS |
| 26 |
INTEGER myThid |
| 27 |
|
| 28 |
C === Local variables === |
| 29 |
C dxSpacing, dySpacing - Default spacing in X and Y. |
| 30 |
C Units are that of coordinate system |
| 31 |
C i.e. cartesian => metres |
| 32 |
C s. polar => degrees |
| 33 |
C goptCount - Used to count the nuber of grid options |
| 34 |
C (only one is allowed! ) |
| 35 |
C msgBuf - Informational/error meesage buffer |
| 36 |
C errIO - IO error flag |
| 37 |
C iUnit - Work variable for IO unit number |
| 38 |
C record - Work variable for IO buffer |
| 39 |
C K, I, J - Loop counters |
| 40 |
REAL dxSpacing |
| 41 |
REAL dySpacing |
| 42 |
CHARACTER*(MAX_LEN_MBUF) msgBuf |
| 43 |
CHARACTER*(MAX_LEN_PREC) record |
| 44 |
INTEGER goptCount |
| 45 |
INTEGER K, I, J, IL, iUnit |
| 46 |
INTEGER errIO |
| 47 |
INTEGER IFNBLNK |
| 48 |
EXTERNAL IFNBLNK |
| 49 |
INTEGER ILNBLNK |
| 50 |
EXTERNAL ILNBLNK |
| 51 |
|
| 52 |
C-- Continuous equation parameters |
| 53 |
NAMELIST /PARM01/ |
| 54 |
& gravity, gBaro, rhonil, tAlpha, sBeta, f0, beta, |
| 55 |
& viscAh, viscAz, viscA4, |
| 56 |
& diffKhT, diffKzT, diffK4T, |
| 57 |
& diffKhS, diffKzS, diffK4S, |
| 58 |
& GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground, |
| 59 |
& tRef, sRef, |
| 60 |
& momViscosity, momAdvection, momForcing, useCoriolis, |
| 61 |
& momPressureForcing, |
| 62 |
& tempDiffusion, tempAdvection, tempForcing, |
| 63 |
& saltDiffusion, saltAdvection, saltForcing, |
| 64 |
& implicitFreeSurface, rigidLid, freeSurfFac, |
| 65 |
& tempStepping, momStepping |
| 66 |
|
| 67 |
C-- Elliptic solver parameters |
| 68 |
NAMELIST /PARM02/ |
| 69 |
& cg2dMaxIters, cg2dChkResFreq, cg2dTargetResidual, cg2dpcOffDFac |
| 70 |
|
| 71 |
C-- Time stepping parammeters |
| 72 |
NAMELIST /PARM03/ |
| 73 |
& nIter0, nTimeSteps, deltaT, deltaTmom, deltaTtracer, abEps, tauCD, rCD, |
| 74 |
& startTime, endTime, chkPtFreq, dumpFreq, deltaTClock, pChkPtFreq, |
| 75 |
& cAdjFreq |
| 76 |
|
| 77 |
C-- Gridding parameters |
| 78 |
NAMELIST /PARM04/ |
| 79 |
& usingCartesianGrid, delZ, dxSpacing, dySpacing, delX, delY, |
| 80 |
& usingSphericalPolarGrid, phiMin, thetaMin, rSphere, |
| 81 |
& l, m, n |
| 82 |
|
| 83 |
C |
| 84 |
_BEGIN_MASTER(myThid) |
| 85 |
|
| 86 |
C-- Open the parameter file |
| 87 |
OPEN(UNIT=scrUnit1,STATUS='SCRATCH') |
| 88 |
OPEN(UNIT=scrUnit2,STATUS='SCRATCH') |
| 89 |
OPEN(UNIT=modelDataUnit,FILE='data',STATUS='OLD',err=1,IOSTAT=errIO) |
| 90 |
IF ( errIO .GE. 0 ) GOTO 2 |
| 91 |
1 CONTINUE |
| 92 |
WRITE(msgBuf,'(A)') |
| 93 |
& 'S/R INI_PARMS' |
| 94 |
CALL PRINT_ERROR( msgBuf , 1) |
| 95 |
WRITE(msgBuf,'(A)') |
| 96 |
& 'Unable to open model parameter' |
| 97 |
CALL PRINT_ERROR( msgBuf , 1) |
| 98 |
WRITE(msgBuf,'(A)') |
| 99 |
& 'file "data"' |
| 100 |
CALL PRINT_ERROR( msgBuf , 1) |
| 101 |
CALL MODELDATA_EXAMPLE( myThid ) |
| 102 |
STOP 'ABNORMAL END: S/R INI_PARMS' |
| 103 |
2 CONTINUE |
| 104 |
|
| 105 |
1000 CONTINUE |
| 106 |
READ(modelDataUnit,FMT='(A)',END=1001) RECORD |
| 107 |
IL = MAX(ILNBLNK(RECORD),1) |
| 108 |
IF ( RECORD(1:1) .NE. commentCharacter ) |
| 109 |
& WRITE(UNIT=scrUnit1,FMT='(A)') RECORD(:IL) |
| 110 |
WRITE(UNIT=scrUnit2,FMT='(A)') RECORD(:IL) |
| 111 |
GOTO 1000 |
| 112 |
1001 CONTINUE |
| 113 |
CLOSE(modelDataUnit) |
| 114 |
|
| 115 |
C-- Report contents of model parameter file |
| 116 |
WRITE(msgBuf,'(A)') |
| 117 |
&'// =======================================================' |
| 118 |
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1) |
| 119 |
WRITE(msgBuf,'(A)') '// Model parameter file "data"' |
| 120 |
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1) |
| 121 |
WRITE(msgBuf,'(A)') |
| 122 |
&'// =======================================================' |
| 123 |
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, |
| 124 |
& SQUEEZE_RIGHT , 1) |
| 125 |
iUnit = scrUnit2 |
| 126 |
REWIND(iUnit) |
| 127 |
2000 CONTINUE |
| 128 |
READ(UNIT=iUnit,FMT='(A)',END=2001) RECORD |
| 129 |
IL = MAX(ILNBLNK(RECORD),1) |
| 130 |
WRITE(msgBuf,'(A,A)') '>',RECORD(:IL) |
| 131 |
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, SQUEEZE_RIGHT , 1) |
| 132 |
GOTO 2000 |
| 133 |
2001 CONTINUE |
| 134 |
CLOSE(iUnit) |
| 135 |
WRITE(msgBuf,'(A)') ' ' |
| 136 |
CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, |
| 137 |
& SQUEEZE_RIGHT , 1) |
| 138 |
|
| 139 |
|
| 140 |
C-- Read settings from model parameter file "data". |
| 141 |
iUnit = scrUnit1 |
| 142 |
REWIND(iUnit) |
| 143 |
|
| 144 |
C-- Set default "physical" parameters |
| 145 |
DO K =1,Nz |
| 146 |
tRef(K) = 30.D0 - FLOAT(K) |
| 147 |
ENDDO |
| 148 |
gravity = 9.81 D0 |
| 149 |
gBaro = gravity |
| 150 |
rhoNil = 999.8 D0 |
| 151 |
tAlpha=2.d-4 |
| 152 |
sBeta=1.d-5 |
| 153 |
f0=1.D-4 |
| 154 |
beta = 1. _d -11 |
| 155 |
viscAh=1.d3 |
| 156 |
viscA4=0. |
| 157 |
viscAz=1.d-3 |
| 158 |
diffKhT=1.0d3 |
| 159 |
diffKzT=1.d-5 |
| 160 |
diffKhS=1.0d3 |
| 161 |
diffKzS=1.d-1 |
| 162 |
diffK4T=0. |
| 163 |
diffK4S=0. |
| 164 |
GMmaxslope=1.d-2 |
| 165 |
GMlength=200.d3 |
| 166 |
GMalpha=0. |
| 167 |
GMdepth=1000. |
| 168 |
GMkbackground=0. |
| 169 |
implicitFreeSurface = .TRUE. |
| 170 |
rigidLid = .FALSE. |
| 171 |
freeSurfFac = 1. _d 0 |
| 172 |
momViscosity = .TRUE. |
| 173 |
momAdvection = .TRUE. |
| 174 |
momForcing = .TRUE. |
| 175 |
useCoriolis = .TRUE. |
| 176 |
momPressureForcing = .TRUE. |
| 177 |
momStepping = .TRUE. |
| 178 |
tempStepping = .TRUE. |
| 179 |
READ(UNIT=iUnit,NML=PARM01,IOSTAT=errIO,err=3) |
| 180 |
IF ( errIO .GE. 0 ) GOTO 4 |
| 181 |
3 CONTINUE |
| 182 |
WRITE(msgBuf,'(A)') |
| 183 |
& 'S/R INI_PARMS' |
| 184 |
CALL PRINT_ERROR( msgBuf , 1) |
| 185 |
WRITE(msgBuf,'(A)') |
| 186 |
& 'Error reading numerical model ' |
| 187 |
CALL PRINT_ERROR( msgBuf , 1) |
| 188 |
WRITE(msgBuf,'(A)') |
| 189 |
& 'parameter file "data"' |
| 190 |
CALL PRINT_ERROR( msgBuf , 1) |
| 191 |
WRITE(msgBuf,'(A)') |
| 192 |
& 'Problem in namelist PARM01' |
| 193 |
CALL PRINT_ERROR( msgBuf , 1) |
| 194 |
CALL MODELDATA_EXAMPLE( myThid ) |
| 195 |
STOP 'ABNORMAL END: S/R INI_PARMS' |
| 196 |
4 CONTINUE |
| 197 |
IF ( implicitFreeSurface ) freeSurfFac = 1. _d 0 |
| 198 |
IF ( rigidLid ) freeSurfFac = 0. _d 0 |
| 199 |
IF ( momViscosity ) THEN |
| 200 |
vfFacMom = 1. _d 0 |
| 201 |
ELSE |
| 202 |
vfFacMom = 0. _d 0 |
| 203 |
ENDIF |
| 204 |
IF ( momAdvection ) THEN |
| 205 |
afFacMom = 1. _d 0 |
| 206 |
ELSE |
| 207 |
afFacMom = 0. _d 0 |
| 208 |
ENDIF |
| 209 |
IF ( momForcing ) THEN |
| 210 |
foFacMom = 1. _d 0 |
| 211 |
ELSE |
| 212 |
foFacMom = 0. _d 0 |
| 213 |
ENDIF |
| 214 |
IF ( useCoriolis ) THEN |
| 215 |
cfFacMom = 1. _d 0 |
| 216 |
ELSE |
| 217 |
cfFacMom = 0. _d 0 |
| 218 |
ENDIF |
| 219 |
IF ( momPressureForcing ) THEN |
| 220 |
pfFacMom = 1. _d 0 |
| 221 |
ELSE |
| 222 |
pfFacMom = 0. _d 0 |
| 223 |
ENDIF |
| 224 |
|
| 225 |
IF ( implicitFreeSurface .AND. rigidLid ) THEN |
| 226 |
WRITE(msgBuf,'(A)') |
| 227 |
& 'S/R INI_PARMS: Cannot select implicitFreeSurface and rigidLid.' |
| 228 |
CALL PRINT_ERROR( msgBuf , myThid) |
| 229 |
STOP 'ABNORMAL END: S/R INI_PARMS' |
| 230 |
ENDIF |
| 231 |
|
| 232 |
C-- Elliptic solver parameters |
| 233 |
cg2dMaxIters = 150 |
| 234 |
cg2dTargetResidual = 1. _d -7 |
| 235 |
cg2dChkResFreq = 1 |
| 236 |
cg2dpcOffDFac = 0.51 _d 0 |
| 237 |
READ(UNIT=iUnit,NML=PARM02,IOSTAT=errIO,err=5) |
| 238 |
IF ( errIO .GE. 0 ) GOTO 6 |
| 239 |
5 CONTINUE |
| 240 |
WRITE(msgBuf,'(A)') |
| 241 |
& 'S/R INI_PARMS' |
| 242 |
CALL PRINT_ERROR( msgBuf , 1) |
| 243 |
WRITE(msgBuf,'(A)') |
| 244 |
& 'Error reading numerical model ' |
| 245 |
CALL PRINT_ERROR( msgBuf , 1) |
| 246 |
WRITE(msgBuf,'(A)') |
| 247 |
& 'parameter file "data".' |
| 248 |
CALL PRINT_ERROR( msgBuf , 1) |
| 249 |
WRITE(msgBuf,'(A)') |
| 250 |
& 'Problem in namelist PARM02' |
| 251 |
CALL PRINT_ERROR( msgBuf , 1) |
| 252 |
CALL MODELDATA_EXAMPLE( myThid ) |
| 253 |
STOP 'ABNORMAL END: S/R INI_PARMS' |
| 254 |
6 CONTINUE |
| 255 |
|
| 256 |
C-- Time stepping parameters |
| 257 |
startTime = 0. |
| 258 |
nTimeSteps = 0 |
| 259 |
endTime = 0. |
| 260 |
nIter0 = 0 |
| 261 |
deltaT = 0. |
| 262 |
deltaTClock = 0. |
| 263 |
deltaTtracer = 0. |
| 264 |
deltaTMom = 0. |
| 265 |
abEps = 0.01 |
| 266 |
pchkPtFreq = 0. |
| 267 |
chkPtFreq = 3600.*25 |
| 268 |
dumpFreq = 3600.*100 |
| 269 |
writeStatePrec = precFloat32 |
| 270 |
nCheckLev = 1 |
| 271 |
checkPtSuff(1) = 'ckptA' |
| 272 |
checkPtSuff(2) = 'ckptB' |
| 273 |
cAdjFreq = -1. _d 0 |
| 274 |
READ(UNIT=iUnit,NML=PARM03,IOSTAT=errIO,err=7) |
| 275 |
IF ( errIO .GE. 0 ) GOTO 8 |
| 276 |
7 CONTINUE |
| 277 |
WRITE(msgBuf,'(A)') |
| 278 |
& 'S/R INI_PARMS' |
| 279 |
CALL PRINT_ERROR( msgBuf , 1) |
| 280 |
WRITE(msgBuf,'(A)') |
| 281 |
& 'Error reading numerical model ' |
| 282 |
CALL PRINT_ERROR( msgBuf , 1) |
| 283 |
WRITE(msgBuf,'(A)') |
| 284 |
& 'parameter file "data"' |
| 285 |
CALL PRINT_ERROR( msgBuf , 1) |
| 286 |
WRITE(msgBuf,'(A)') |
| 287 |
& 'Problem in namelist PARM03' |
| 288 |
CALL PRINT_ERROR( msgBuf , 1) |
| 289 |
CALL MODELDATA_EXAMPLE( myThid ) |
| 290 |
STOP 'ABNORMAL END: S/R INI_PARMS' |
| 291 |
8 CONTINUE |
| 292 |
C Process "timestepping" params |
| 293 |
C o Time step size |
| 294 |
IF ( deltaT .EQ. 0. ) deltaT = deltaTmom |
| 295 |
IF ( deltaT .EQ. 0. ) deltaT = deltaTtracer |
| 296 |
IF ( deltaTmom .EQ. 0. ) deltaTmom = deltaT |
| 297 |
IF ( deltaTtracer .EQ. 0. ) deltaTtracer = deltaT |
| 298 |
IF ( deltaTClock .EQ. 0. ) deltaTClock = deltaT |
| 299 |
C o Convection frequency |
| 300 |
IF ( cAdjFreq .LT. 0. ) THEN |
| 301 |
cAdjFreq = deltaTClock |
| 302 |
ENDIF |
| 303 |
C o Time step count |
| 304 |
IF ( endTime .NE. 0 ) THEN |
| 305 |
IF ( deltaTClock .NE. 0 ) nTimeSteps = |
| 306 |
& INT((endTime-startTime)/deltaTClock) |
| 307 |
ENDIF |
| 308 |
C o Finish time |
| 309 |
IF ( endTime .EQ. 0. ) endTime = FLOAT(nTimeSteps)*deltaTClock |
| 310 |
|
| 311 |
C-- Grid parameters |
| 312 |
C In cartesian coords distances are in metres |
| 313 |
usingCartesianGrid = .TRUE. |
| 314 |
DO K =1,Nz |
| 315 |
delZ(K) = 100. _d 0 |
| 316 |
ENDDO |
| 317 |
dxSpacing = 20. _d 0 * 1000. _d 0 |
| 318 |
dySpacing = 20. _d 0 * 1000. _d 0 |
| 319 |
DO i=1,Nx |
| 320 |
delX(i) = dxSpacing |
| 321 |
ENDDO |
| 322 |
DO j=1,Ny |
| 323 |
delY(j) = dySpacing |
| 324 |
ENDDO |
| 325 |
C In spherical polar distances are in degrees |
| 326 |
usingSphericalPolarGrid = .FALSE. |
| 327 |
IF ( usingSphericalPolarGrid ) THEN |
| 328 |
phiMin = -5.0 |
| 329 |
thetaMin = 0. |
| 330 |
dxSpacing = 1. |
| 331 |
dySpacing = 1. |
| 332 |
rSphere = 6370. * 1. _d 3 |
| 333 |
DO I=1,Nx |
| 334 |
delX(I) = dxSpacing |
| 335 |
ENDDO |
| 336 |
DO J=1,Ny |
| 337 |
delY(J) = dySpacing |
| 338 |
ENDDO |
| 339 |
ENDIF |
| 340 |
|
| 341 |
READ(UNIT=iUnit,NML=PARM04,IOSTAT=errIO,err=9) |
| 342 |
IF ( errIO .GE. 0 ) GOTO 10 |
| 343 |
9 CONTINUE |
| 344 |
WRITE(msgBuf,'(A)') |
| 345 |
& 'S/R INI_PARMS' |
| 346 |
CALL PRINT_ERROR( msgBuf , 1) |
| 347 |
WRITE(msgBuf,'(A)') |
| 348 |
& 'Error reading numerical model ' |
| 349 |
CALL PRINT_ERROR( msgBuf , 1) |
| 350 |
WRITE(msgBuf,'(A)') |
| 351 |
& 'parameter file "data"' |
| 352 |
CALL PRINT_ERROR( msgBuf , 1) |
| 353 |
WRITE(msgBuf,'(A)') |
| 354 |
& 'Problem in namelist PARM04' |
| 355 |
CALL PRINT_ERROR( msgBuf , 1) |
| 356 |
CALL MODELDATA_EXAMPLE( myThid ) |
| 357 |
STOP 'ABNORMAL END: S/R INI_PARMS' |
| 358 |
10 CONTINUE |
| 359 |
|
| 360 |
goptCount = 0 |
| 361 |
IF ( usingCartesianGrid ) goptCount = goptCount+1 |
| 362 |
IF ( usingSphericalPolarGrid ) goptCount = goptCount+1 |
| 363 |
IF ( goptCount .NE. 1 ) THEN |
| 364 |
WRITE(msgBuf,'(A)') |
| 365 |
& 'S/R INI_PARMS: More than one coordinate system requested' |
| 366 |
CALL PRINT_ERROR( msgBuf , myThid) |
| 367 |
STOP 'ABNORMAL END: S/R INI_PARMS' |
| 368 |
ENDIF |
| 369 |
|
| 370 |
_END_MASTER(myThid) |
| 371 |
|
| 372 |
C-- Everyone else must wait for the parameters to be loaded |
| 373 |
_BARRIER |
| 374 |
C |
| 375 |
|
| 376 |
RETURN |
| 377 |
END |
| 378 |
|
Parent Directory
| 
Revision Log
| 
Revision Graph