/[MITgcm]/MITgcm/model/src/set_defaults.F
ViewVC logotype

Diff of /MITgcm/model/src/set_defaults.F

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

revision 1.52 by jmc, Wed Oct 15 22:55:51 2003 UTC revision 1.166 by jmc, Mon Apr 22 02:34:27 2013 UTC
# Line 1  Line 1 
1  C $Header$  C $Header$
2  C $Name$  C $Name$
3    
4    #include "PACKAGES_CONFIG.h"
5  #include "CPP_OPTIONS.h"  #include "CPP_OPTIONS.h"
6    
7    C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
8  CBOP  CBOP
9  C     !ROUTINE: SET_DEFAULTS  C     !ROUTINE: SET_DEFAULTS
10  C     !INTERFACE:  C     !INTERFACE:
11        SUBROUTINE SET_DEFAULTS(        SUBROUTINE SET_DEFAULTS(
12       O   viscArDefault, diffKrTDefault, diffKrSDefault,       O   viscArDefault, diffKrTDefault, diffKrSDefault,
13       O   hFacMinDrDefault, delRdefault, rkFacDefault,       O   hFacMinDrDefault, delRdefault,
14       I   myThid )       I   myThid )
15    
16  C     !DESCRIPTION: \bv  C     !DESCRIPTION:
17  C     *==========================================================*  C     Routine to set model "parameter defaults".
 C     | SUBROUTINE SET_DEFAULTS                                    
 C     | o Routine to set model "parameters"                        
 C     *==========================================================*  
 C     | Notes:                                                      
 C     | ======                                                      
 C     | The present version of this routine is a place-holder.      
 C     | A production version needs to handle parameters from an    
 C     | external file and possibly reading in some initial field    
 C     | values.                                                    
 C     *==========================================================*  
 C     \ev  
18    
19  C     !USES:  C     !USES:
20        IMPLICIT NONE        IMPLICIT NONE
 C     === Global variables ===  
21  #include "SIZE.h"  #include "SIZE.h"
22  #include "EEPARAMS.h"  #include "EEPARAMS.h"
23  #include "PARAMS.h"  #include "PARAMS.h"
24  Cml#include "EOS.h"  #ifdef ALLOW_EXCH2
25  #include "GRID.h"  # include "W2_EXCH2_SIZE.h"
26    #endif /* ALLOW_EXCH2 */
27    #include "SET_GRID.h"
28    
29  C     !INPUT/OUTPUT PARAMETERS:  C     !INPUT/OUTPUT PARAMETERS:
30  C     === Routine arguments ===  C     myThid :: my Thread Id. Number
 C     myThid - Number of this instance of INI_PARMS  
31        INTEGER myThid        INTEGER myThid
32        _RL viscArDefault        _RL viscArDefault
33        _RL diffKrTDefault        _RL diffKrTDefault
34        _RL diffKrSDefault        _RL diffKrSDefault
35        _RL hFacMinDrDefault        _RL hFacMinDrDefault
36        _RL delRDefault(Nr)        _RL delRDefault(Nr)
       _RS rkFacDefault  
37    
38  C     !LOCAL VARIABLES:  C     !LOCAL VARIABLES:
39  C     === Local variables ===  C     i, j, k :: Loop counters
40  C     K, I, J - Loop counters        INTEGER i, j, k
       INTEGER K, I, J  
41  CEOP  CEOP
42    
43  C--   Grid parameters  C--   Grid parameters
44  C     Vertical gridding  C-    Vertical gridding
45        rkFacDefault         = 1.D0        delRFile            = ' '
46        horiVertRatio        = 1.D0        delRcFile           = ' '
47        Ro_SeaLevel = 0.        hybSigmFile         = ' '
48          Ro_SeaLevel         = 0.
49          rSigmaBnd           = UNSET_RL
50          selectSigmaCoord    = 0
51        DO k=1,Nr        DO k=1,Nr
52         delRdefault(k) = 0.         delRdefault(k)     = 0.
53        ENDDO        ENDDO
54        DO k=1,Nr+1        DO k=1,Nr+1
55         delRc(k) = UNSET_RL         delRc(k)           = UNSET_RL
56        ENDDO        ENDDO
57    C-    vertical profile
58  C     Horizontal gridding        tRefFile            = ' '
59  C     In cartesian coords distances are in metres        sRefFile            = ' '
60        usingCartesianGrid = .TRUE.        rhoRefFile          = ' '
61        DO i=1,Nx  
62         delX(i) = UNSET_RL  C-    Horizontal gridding
63          delXFile            = ' '
64          delYFile            = ' '
65          horizGridFile       = ' '
66          deepAtmosphere      = .FALSE.
67          xgOrigin            = UNSET_RL
68          ygOrigin            = UNSET_RL
69          DO i=1,grid_maxNx
70           delX(i)            = UNSET_RL
71        ENDDO        ENDDO
72        DO j=1,Ny        DO j=1,grid_maxNy
73         delY(j) = UNSET_RL         delY(j)            = UNSET_RL
74        ENDDO        ENDDO
75    C     In cartesian coords distances are in metres
76          usingCartesianGrid  = .FALSE.
77  C     In spherical polar distances are in degrees  C     In spherical polar distances are in degrees
78        usingSphericalPolarGrid = .FALSE.        usingSphericalPolarGrid = .FALSE.
79        phiMin               = 0.0        rSphere             = UNSET_RL
       thetaMin             = 0.  
       rSphere              = 6370. * 1.D3  
80  C     General curvilinear coordinate system  C     General curvilinear coordinate system
81        usingCurvilinearGrid = .FALSE.        usingCurvilinearGrid= .FALSE.
82          radius_fromHorizGrid= UNSET_RL
83          hasWetCSCorners     = .FALSE.
84    C     General cylindrical coordinate system
85          usingCylindricalGrid= .FALSE.
86    C     Coriolis map:
87          selectCoriMap       = -1
88          use3dCoriolis       = .TRUE.
89    C     grid rotation
90          rotateGrid          = .FALSE.
91          phiEuler            = 0. _d 0
92          thetaEuler          = 0. _d 0
93          psiEuler            = 0. _d 0
94    
95  C--   Set default "physical" parameters  C--   Set default "physical" parameters
96        DO K =1,Nr        nh_Am2              = 1. _d 0
97         tRef(K) = 30.D0 - FLOAT( K )        gravity             = 9.81 _d 0
98  Cml       sRef(K) = 35.D0        rhoNil              = 999.8 _d 0
99        ENDDO  C-- jmc : the default is to set rhoConstFresh to rhoConst (=rhoNil by default)
100        gravity             = 9.81D0  C         (so that the default produces same results as before)
101        rhoNil              = 999.8D0  c     rhoConstFresh       = 999.8 _d 0
102        rhoConstFresh       = 999.8D0        f0                  = 1. _d -4
103        f0                  = 1.D-4        beta                = 1. _d -11
104        beta                = 1.D-11        fPrime              = 0. _d 0
105  C-    Always use 1 day in the past but should be 86164 (=86400*365.25/366.25)  C-    Earth rotation period is 86400*365.25/366.25 (use to be 1.day)
106        rotationPeriod      = 86400. _d 0        rotationPeriod      = 86164. _d 0
107        viscAh              = 0.D3  C-    viscosity and diffusivity default value:
108        viscAstrain         = 0.D3        viscAh              = 0. _d 3
109        viscAtension        = 0.D3        viscAhGrid          = 0. _d 0
110        diffKhT             = 0.D3        viscAhGridMin       = 0. _d 0
111        diffKhS             = 0.D3        viscAhGridMax       = 1. _d 21
112        viscArDefault       = 0.D-3        viscAhMax           = 1. _d 21
113          viscAhReMax         = 0. _d 0
114          viscC2leith         = 0. _d 0
115          viscC2leithD        = 0. _d 0
116          viscC2smag          = 0. _d 0
117          viscArDefault       = 0. _d -3
118        no_slip_sides       = .TRUE.        no_slip_sides       = .TRUE.
119        no_slip_bottom      = .TRUE.        no_slip_bottom      = .TRUE.
120        diffKrTDefault      = 0.D-3        sideDragFactor      = 2. _d 0
121        diffKrSDefault      = 0.D-3        bottomDragLinear    = 0.
122        viscA4              = 0.D11        bottomDragQuadratic = 0.
123        diffK4T             = 0.D11        viscA4              = 0. _d 11
124        diffK4S             = 0.D11        viscA4Grid          = 0. _d 0
125          viscA4GridMax       = 1. _d 21
126          viscA4GridMin       = 0. _d 0
127          viscA4Max           = 1. _d 21
128          viscA4ReMax         = 0. _d 0
129          viscC4leith         = 0. _d 0
130          viscC4leithD        = 0. _d 0
131          viscC4smag          = 0. _d 0
132          DO k=1,Nr
133           viscArNr(k)        = UNSET_RL
134          ENDDO
135        cosPower            = 0.        cosPower            = 0.
136        HeatCapacity_Cp     = 3994.D0        diffKhT             = 0. _d 3
137  Cml      tAlpha              = 2.D-4        diffKhS             = 0. _d 3
138  Cml      sBeta               = 7.4D-4        diffK4T             = 0. _d 11
139          diffK4S             = 0. _d 11
140          diffKrTDefault      = 0. _d -3
141          diffKrSDefault      = 0. _d -3
142          diffKrBL79surf      = 0. _d 0
143          diffKrBL79deep      = 0. _d 0
144          diffKrBL79scl       = 200. _d 0
145          diffKrBL79Ho        = -2000. _d 0
146          BL79LatVary         = 30.
147          diffKrBLEQsurf      = UNSET_RL
148          diffKrBLEQdeep      = UNSET_RL
149          diffKrBLEQscl       = UNSET_RL
150          diffKrBLEQHo        = UNSET_RL
151          DO k=1,Nr
152           diffKrNrT(k)       = UNSET_RL
153           diffKrNrS(k)       = UNSET_RL
154           diffKr4T(k)        = 0.
155           diffKr4S(k)        = 0.
156          ENDDO
157          HeatCapacity_Cp     = 3994. _d 0
158    Cml      tAlpha              = 2. _d -4
159    Cml      sBeta               = 7.4 _d -4
160        eosType             = 'LINEAR'        eosType             = 'LINEAR'
161        buoyancyRelation    = 'OCEANIC'        buoyancyRelation    = 'OCEANIC'
162        hFacMin             = 1.D0        smoothAbsFuncRange  = 0. _d 0
163        hFacMinDrDefault    = 0.D0        hFacMin             = 1. _d 0
164          hFacMinDrDefault    = 0. _d 0
165          implicitIntGravWave = .FALSE.
166        staggerTimeStep     = .FALSE.        staggerTimeStep     = .FALSE.
167          doResetHFactors     = .FALSE.
168        momViscosity        = .TRUE.        momViscosity        = .TRUE.
169        momAdvection        = .TRUE.        momAdvection        = .TRUE.
170        momForcing          = .TRUE.        momForcing          = .TRUE.
# Line 127  Cml      sBeta               = 7.4D-4 Line 178  Cml      sBeta               = 7.4D-4
178        saltStepping        = .TRUE.        saltStepping        = .TRUE.
179        saltAdvection       = .TRUE.        saltAdvection       = .TRUE.
180        saltForcing         = .TRUE.        saltForcing         = .TRUE.
181        tr1Stepping         = .FALSE.        addFrictionHeating  = .FALSE.
182        metricTerms         = .TRUE.        metricTerms         = .TRUE.
183        useNHMTerms         = .TRUE.        useNHMTerms         = .FALSE.
184          useFullLeith        = .FALSE.
185          useAreaViscLength   = .FALSE.
186          useStrainTensionVisc= .FALSE.
187        implicitDiffusion   = .FALSE.        implicitDiffusion   = .FALSE.
188        implicitViscosity   = .FALSE.        implicitViscosity   = .FALSE.
189          momImplVertAdv      = .FALSE.
190          tempImplVertAdv     = .FALSE.
191          saltImplVertAdv     = .FALSE.
192        nonHydrostatic      = .FALSE.        nonHydrostatic      = .FALSE.
193        quasiHydrostatic    = .FALSE.        quasiHydrostatic    = .FALSE.
194        globalFiles         = .FALSE.        globalFiles         = .FALSE.
195        useSingleCpuIO      = .FALSE.        useSingleCpuIO      = .FALSE.
196        allowFreezing       = .FALSE.        allowFreezing       = .FALSE.
197        ivdc_kappa          = 0.D0        useOldFreezing      = .FALSE.
198        groundAtK1          = .FALSE.        ivdc_kappa          = 0. _d 0
199        bottomDragLinear    = 0.        hMixCriteria        = -.8 _d 0
200        bottomDragQuadratic = 0.        dRhoSmall           = 1. _d -6
201        usePickupBeforeC35    = .FALSE.        hMixSmooth          = 0. _d 0
202        debugMode             = .FALSE.        usePickupBeforeC54    = .FALSE.
       readPickupWithTracer  = .FALSE.  
       writePickupWithTracer = .FALSE.  
203        tempAdvScheme       = 2        tempAdvScheme       = 2
204        saltAdvScheme       = 2        saltAdvScheme       = 2
       tracerAdvScheme     = 2  
205        multiDimAdvection   = .TRUE.        multiDimAdvection   = .TRUE.
206          useMultiDimAdvec    = .FALSE.
207        useCDscheme         = .FALSE.        useCDscheme         = .FALSE.
208        useEnergyConservingCoriolis = .FALSE.        useEnergyConservingCoriolis = .FALSE.
209        useJamartWetPoints  = .FALSE.        useJamartWetPoints  = .FALSE.
210        debugLevel          = debLevA        useJamartMomAdv     = .FALSE.
211          selectVortScheme    = UNSET_I
212          upwindVorticity     = .FALSE.
213          highOrderVorticity  = .FALSE.
214          useAbsVorticity     = .FALSE.
215          upwindShear         = .FALSE.
216          selectKEscheme      = 0
217          IF ( debugMode ) THEN
218            debugLevel        = debLevD
219          ELSE
220            debugLevel        = debLevB
221    #ifdef ALLOW_AUTODIFF
222            debugLevel        = debLevA
223    #endif
224          ENDIF
225    
226  C--   Set (free)surface-related parameters  C--   Set (free)surface-related parameters
227        implicitFreeSurface = .TRUE.        implicitFreeSurface = .FALSE.
228        rigidLid            = .FALSE.        rigidLid            = .FALSE.
229        implicSurfPress     = 1.D0        implicSurfPress     = 1. _d 0
230        implicDiv2DFlow     = 1.D0        implicDiv2Dflow     = 1. _d 0
231        exactConserv        = .FALSE.        exactConserv        = .FALSE.
232          linFSConserveTr     = .FALSE.
233        uniformLin_PhiSurf  = .TRUE.        uniformLin_PhiSurf  = .TRUE.
234        nonlinFreeSurf      = 0        nonlinFreeSurf      = 0
235        hFacInf             = 0.2 _d 0        hFacInf             = 0.2 _d 0
236        hFacSup             = 2.0 _d 0        hFacSup             = 2.0 _d 0
237        select_rStar        = 0        select_rStar        = 0
238          selectNHfreeSurf    = 0
239          selectAddFluid      = 0
240        useRealFreshWaterFlux = .FALSE.        useRealFreshWaterFlux = .FALSE.
241        temp_EvPrRn = UNSET_RL        temp_EvPrRn = UNSET_RL
242        salt_EvPrRn = 0.        salt_EvPrRn = 0.
243        trac_EvPrRn = UNSET_RL        temp_addMass = UNSET_RL
244          salt_addMass = UNSET_RL
245          balanceEmPmR        = .FALSE.
246          balanceQnet         = .FALSE.
247          balancePrintMean    = .FALSE.
248          balanceThetaClimRelax = .FALSE.
249          balanceSaltClimRelax  = .FALSE.
250    
251  C--   Atmospheric physical parameters (e.g.: EOS)  C--   Atmospheric physical parameters (e.g.: EOS)
252        celsius2K = 273.16 _d 0        celsius2K = 273.15 _d 0
253        atm_Po =  1. _d 5        atm_Po =  1. _d 5
254        atm_Cp = 1004. _d 0        atm_Cp = 1004. _d 0
255        atm_Rd = UNSET_RL        atm_Rd = UNSET_RL
# Line 182  C--   Atmospheric physical parameters (e Line 260  C--   Atmospheric physical parameters (e
260    
261  C--   Elliptic solver parameters  C--   Elliptic solver parameters
262        cg2dMaxIters       = 150        cg2dMaxIters       = 150
263        cg2dTargetResidual = 1.D-7        cg2dTargetResidual = 1. _d -7
264        cg2dTargetResWunit = -1.        cg2dTargetResWunit = -1.
265        cg2dChkResFreq     = 1        cg2dChkResFreq     = 1
266        cg2dpcOffDFac      = 0.51D0        cg2dUseMinResSol   = UNSET_I
267          cg2dpcOffDFac      = 0.51 _d 0
268          cg2dPreCondFreq    = 1
269        cg3dMaxIters       = 150        cg3dMaxIters       = 150
270        cg3dTargetResidual = 1.D-7        cg3dTargetResidual = 1. _d -7
271        cg3dChkResFreq     = 1        cg3dChkResFreq     = 1
272          useSRCGSolver      = .FALSE.
273    
274  C--   Time stepping parameters  C--   Time stepping parameters
275        deltaT            = 0.        deltaT            = 0. _d 0
276        nIter0            = 0        deltaTMom         = 0. _d 0
277        startTime         = deltaT*float(nIter0)        deltaTFreeSurf    = 0. _d 0
278          DO k=1,Nr
279            dTtracerLev(k)  = 0. _d 0
280          ENDDO
281          baseTime          = 0. _d 0
282          nIter0            = -1
283          startTime         = UNSET_RL
284        pickupSuff        = ' '        pickupSuff        = ' '
285          pickupStrictlyMatch = .TRUE.
286        nTimeSteps        = 0        nTimeSteps        = 0
287        nEndIter          = nIter0+nTimeSteps        nEndIter          = 0
288        endTime           = deltaT*float(nEndIter)        endTime           = 0. _d 0
289        forcing_In_AB     = .TRUE.        momForcingOutAB   = UNSET_I
290        abEps             = 0.01        tracForcingOutAB  = UNSET_I
291        pchkPtFreq        = deltaT*0        momDissip_In_AB   = .TRUE.
292          doAB_onGtGs       = .TRUE.
293          abEps             = 0.01 _d 0
294    #ifdef ALLOW_ADAMSBASHFORTH_3
295          alph_AB           = 0.5 _d 0
296          beta_AB           = 5. _d 0 / 12. _d 0
297          startFromPickupAB2= .FALSE.
298    #else
299          alph_AB           = UNSET_RL
300          beta_AB           = UNSET_RL
301          startFromPickupAB2= .TRUE.
302    #endif
303          pChkPtFreq        = deltaT*0
304        chkPtFreq         = deltaT*0        chkPtFreq         = deltaT*0
305          outputTypesInclusive = .FALSE.
306          pickup_read_mdsio = .TRUE.
307          pickup_write_mdsio= .TRUE.
308          pickup_write_immed= .FALSE.
309          writePickupAtEnd  = .TRUE.
310        dumpFreq          = deltaT*0        dumpFreq          = deltaT*0
311          adjDumpFreq       = deltaT*0
312        diagFreq          = deltaT*0        diagFreq          = deltaT*0
313          dumpInitAndLast   = .TRUE.
314          snapshot_mdsio    = .TRUE.
315        monitorFreq       = -1.        monitorFreq       = -1.
316          adjMonitorFreq    = 0.
317          monitorSelect     = UNSET_I
318          monitor_stdio     = .TRUE.
319        taveFreq          = deltaT*0        taveFreq          = deltaT*0
320          timeave_mdsio     = .TRUE.
321        tave_lastIter     = 0.5 _d 0        tave_lastIter     = 0.5 _d 0
322        writeStatePrec    = precFloat64        writeStatePrec    = precFloat64
323        writeBinaryPrec   = precFloat32        writeBinaryPrec   = precFloat32
324        readBinaryPrec    = precFloat32        readBinaryPrec    = precFloat32
325        nCheckLev         = 1        cAdjFreq          =  0. _d 0
326        checkPtSuff(1)    = 'ckptA'        tauCD             =  0. _d 0
327        checkPtSuff(2)    = 'ckptB'        tauThetaClimRelax =  0. _d 0
328        cAdjFreq          =  0.D0        tauSaltClimRelax  =  0. _d 0
       tauCD             =  0.D0  
       tauThetaClimRelax =  0.D0  
       tauSaltClimRelax  =  0.D0  
       tauTr1ClimRelax   =  0.D0  
329        periodicExternalForcing = .FALSE.        periodicExternalForcing = .FALSE.
330        externForcingPeriod     = 0.        externForcingPeriod     = 0.
331        externForcingCycle      = 0.        externForcingCycle      = 0.
332          tCylIn             = 0.
333          tCylOut            = 20.
334    
335  C--   Input files  C--   Input files
336        bathyFile       = ' '        bathyFile       = ' '
337        topoFile        = ' '        topoFile        = ' '
338        hydrogSaltFile  = ' '        hydrogSaltFile  = ' '
339        hydrogThetaFile = ' '        hydrogThetaFile = ' '
340          maskIniTemp     = .TRUE.
341          maskIniSalt     = .TRUE.
342          checkIniTemp    = .TRUE.
343          checkIniSalt    = .TRUE.
344          diffKrFile      = ' '
345          viscAhDfile     = ' '
346          viscAhZfile     = ' '
347          viscA4Dfile     = ' '
348          viscA4Zfile     = ' '
349        zonalWindFile   = ' '        zonalWindFile   = ' '
350        meridWindFile   = ' '        meridWindFile   = ' '
351        thetaClimFile   = ' '        thetaClimFile   = ' '
352        saltClimFile    = ' '        saltClimFile    = ' '
353        EmPmRfile       = ' '        EmPmRfile       = ' '
354          saltFluxFile    = ' '
355        surfQfile       = ' '        surfQfile       = ' '
356        surfQswfile     = ' '        surfQnetFile    = ' '
357          surfQswFile     = ' '
358        uVelInitFile    = ' '        uVelInitFile    = ' '
359        vVelInitFile    = ' '        vVelInitFile    = ' '
360        pSurfInitFile   = ' '        pSurfInitFile   = ' '
361        dQdTFile        = ' '        pLoadFile       = ' '
362        ploadFile       = ' '        addMassFile     = ' '
363          eddyPsiXFile    = ' '
364          eddyPsiYFile    = ' '
365          lambdaThetaFile = ' '
366          lambdaSaltFile  = ' '
367        mdsioLocalDir   = ' '        mdsioLocalDir   = ' '
368          adTapeDir       = ' '
369          the_run_name    = ' '
370    
 C  
371        RETURN        RETURN
372        END        END

Legend:
Removed from v.1.52  
changed lines
  Added in v.1.166

  ViewVC Help
Powered by ViewVC 1.1.22