/[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.36 by mlosch, Wed Jul 31 16:38:31 2002 UTC revision 1.172 by gforget, Sat Jun 28 22:34:16 2014 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  #include "GRID.h"  #ifdef ALLOW_EXCH2
25    # 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
57    C-    vertical profile
58          tRefFile            = ' '
59          sRefFile            = ' '
60          rhoRefFile          = ' '
61          thetaConst          = UNSET_RL
62          DO k=1,Nr
63           tRef(k)            = UNSET_RL
64           sRef(k)            = UNSET_RL
65        ENDDO        ENDDO
66    
67  C     Horizontal gridding  C-    Horizontal gridding
68  C     In cartesian coords distances are in metres        delXFile            = ' '
69        usingCartesianGrid = .TRUE.        delYFile            = ' '
70        DO i=1,Nx        horizGridFile       = ' '
71         delX(i) = UNSET_RL        deepAtmosphere      = .FALSE.
72          xgOrigin            = UNSET_RL
73          ygOrigin            = UNSET_RL
74          DO i=1,grid_maxNx
75           delX(i)            = UNSET_RL
76        ENDDO        ENDDO
77        DO j=1,Ny        DO j=1,grid_maxNy
78         delY(j) = UNSET_RL         delY(j)            = UNSET_RL
79        ENDDO        ENDDO
80    C     In cartesian coords distances are in metres
81          usingCartesianGrid  = .FALSE.
82  C     In spherical polar distances are in degrees  C     In spherical polar distances are in degrees
83        usingSphericalPolarGrid = .FALSE.        usingSphericalPolarGrid = .FALSE.
84        phiMin               = 0.0        rSphere             = UNSET_RL
       thetaMin             = 0.  
       rSphere              = 6370. * 1.D3  
85  C     General curvilinear coordinate system  C     General curvilinear coordinate system
86        usingCurvilinearGrid = .FALSE.        usingCurvilinearGrid= .FALSE.
87          radius_fromHorizGrid= UNSET_RL
88          hasWetCSCorners     = .FALSE.
89    C     General cylindrical coordinate system
90          usingCylindricalGrid= .FALSE.
91    C     Coriolis map:
92          selectCoriMap       = -1
93          use3dCoriolis       = .TRUE.
94    C     grid rotation
95          rotateGrid          = .FALSE.
96          phiEuler            = 0. _d 0
97          thetaEuler          = 0. _d 0
98          psiEuler            = 0. _d 0
99    
100  C--   Set default "physical" parameters  C--   Set default "physical" parameters
101        DO K =1,Nr        nh_Am2              = 1. _d 0
102         tRef(K) = 30.D0 - FLOAT( K )        gravity             = 9.81 _d 0
103        ENDDO        gBaro               = UNSET_RL
104        gravity             = 9.81D0        rhoNil              = 999.8 _d 0
105        rhoNil              = 999.8D0        rhoConst            = UNSET_RL
106        f0                  = 1.D-4  C-- jmc : the default is to set rhoConstFresh to rhoConst (=rhoNil by default)
107        beta                = 1.D-11  C         (so that the default produces same results as before)
108        omega               = 2.D0 * PI / ( 3600.D0 * 24.D0 )  c     rhoConstFresh       = 999.8 _d 0
109        viscAh              = 0.D3        rhoConstFresh       = UNSET_RL
110        viscAstrain         = 0.D3        convertFW2Salt      = UNSET_RL
111        viscAtension        = 0.D3        f0                  = 1. _d -4
112        diffKhT             = 0.D3        beta                = 1. _d -11
113        diffKhS             = 0.D3        fPrime              = 0. _d 0
114        viscArDefault       = 0.D-3  C-    Earth rotation period is 86400*365.25/366.25 (use to be 1.day)
115          rotationPeriod      = 86164. _d 0
116          omega               = UNSET_RL
117    C-    viscosity and diffusivity default value:
118          viscAh              = 0. _d 3
119          smag3D_coeff        = 1. _d -2
120          viscAhGrid          = 0. _d 0
121          viscAhGridMin       = 0. _d 0
122          viscAhGridMax       = 1. _d 21
123          viscAhMax           = 1. _d 21
124          viscAhReMax         = 0. _d 0
125          viscC2leith         = 0. _d 0
126          viscC2leithD        = 0. _d 0
127          viscC2smag          = 0. _d 0
128          viscArDefault       = 0. _d -3
129          viscFacAdj          = 1. _d 0
130        no_slip_sides       = .TRUE.        no_slip_sides       = .TRUE.
131        no_slip_bottom      = .TRUE.        no_slip_bottom      = .TRUE.
132        diffKrTDefault      = 0.D-3        sideDragFactor      = 2. _d 0
133        diffKrSDefault      = 0.D-3        bottomDragLinear    = 0.
134        viscA4              = 0.D11        bottomDragQuadratic = 0.
135        diffK4T             = 0.D11        viscA4              = 0. _d 11
136        diffK4S             = 0.D11        viscA4Grid          = 0. _d 0
137          viscA4GridMax       = 1. _d 21
138          viscA4GridMin       = 0. _d 0
139          viscA4Max           = 1. _d 21
140          viscA4ReMax         = 0. _d 0
141          viscC4leith         = 0. _d 0
142          viscC4leithD        = 0. _d 0
143          viscC4smag          = 0. _d 0
144          DO k=1,Nr
145           viscArNr(k)        = UNSET_RL
146          ENDDO
147        cosPower            = 0.        cosPower            = 0.
148        HeatCapacity_Cp     = 3994.D0        diffKhT             = 0. _d 3
149        tAlpha              = 2.D-4        diffKhS             = 0. _d 3
150        sBeta               = 7.4D-4        diffK4T             = 0. _d 11
151          diffK4S             = 0. _d 11
152          diffKrTDefault      = 0. _d -3
153          diffKrSDefault      = 0. _d -3
154          diffKrBL79surf      = 0. _d 0
155          diffKrBL79deep      = 0. _d 0
156          diffKrBL79scl       = 200. _d 0
157          diffKrBL79Ho        = -2000. _d 0
158          BL79LatVary         = 30.
159          diffKrBLEQsurf      = UNSET_RL
160          diffKrBLEQdeep      = UNSET_RL
161          diffKrBLEQscl       = UNSET_RL
162          diffKrBLEQHo        = UNSET_RL
163          DO k=1,Nr
164           diffKrNrT(k)       = UNSET_RL
165           diffKrNrS(k)       = UNSET_RL
166           diffKr4T(k)        = 0.
167           diffKr4S(k)        = 0.
168          ENDDO
169          HeatCapacity_Cp     = 3994. _d 0
170        eosType             = 'LINEAR'        eosType             = 'LINEAR'
171        buoyancyRelation    = 'OCEANIC'        buoyancyRelation    = 'OCEANIC'
172        hFacMin             = 1.D0        smoothAbsFuncRange  = 0. _d 0
173        hFacMinDrDefault    = 0.D0        hFacMin             = 1. _d 0
174          hFacMinDrDefault    = 0. _d 0
175          implicitIntGravWave = .FALSE.
176        staggerTimeStep     = .FALSE.        staggerTimeStep     = .FALSE.
177          doResetHFactors     = .FALSE.
178        momViscosity        = .TRUE.        momViscosity        = .TRUE.
179        momAdvection        = .TRUE.        momAdvection        = .TRUE.
180        momForcing          = .TRUE.        momForcing          = .TRUE.
# Line 123  C--   Set default "physical" parameters Line 188  C--   Set default "physical" parameters
188        saltStepping        = .TRUE.        saltStepping        = .TRUE.
189        saltAdvection       = .TRUE.        saltAdvection       = .TRUE.
190        saltForcing         = .TRUE.        saltForcing         = .TRUE.
191        tr1Stepping         = .FALSE.        addFrictionHeating  = .FALSE.
192        metricTerms         = .TRUE.        metricTerms         = .TRUE.
193          useNHMTerms         = .FALSE.
194          useSmag3D           = .FALSE.
195          useFullLeith        = .FALSE.
196          useAreaViscLength   = .FALSE.
197          useStrainTensionVisc= .FALSE.
198        implicitDiffusion   = .FALSE.        implicitDiffusion   = .FALSE.
199        implicitViscosity   = .FALSE.        implicitViscosity   = .FALSE.
200          momImplVertAdv      = .FALSE.
201          tempImplVertAdv     = .FALSE.
202          saltImplVertAdv     = .FALSE.
203        nonHydrostatic      = .FALSE.        nonHydrostatic      = .FALSE.
204          quasiHydrostatic    = .FALSE.
205        globalFiles         = .FALSE.        globalFiles         = .FALSE.
206          useSingleCpuIO      = .FALSE.
207          useSingleCpuInput   = .FALSE.
208        allowFreezing       = .FALSE.        allowFreezing       = .FALSE.
209        ivdc_kappa          = 0.D0        ivdc_kappa          = 0. _d 0
210        groundAtK1          = .FALSE.        hMixCriteria        = -.8 _d 0
211        bottomDragLinear    = 0.        dRhoSmall           = 1. _d -6
212        bottomDragQuadratic = 0.        hMixSmooth          = 0. _d 0
213        usePickupBeforeC35    = .FALSE.        usePickupBeforeC54    = .FALSE.
       debugMode             = .FALSE.  
       readPickupWithTracer  = .FALSE.  
       writePickupWithTracer = .FALSE.  
214        tempAdvScheme       = 2        tempAdvScheme       = 2
215        saltAdvScheme       = 2        saltAdvScheme       = 2
       tracerAdvScheme     = 2  
216        multiDimAdvection   = .TRUE.        multiDimAdvection   = .TRUE.
217          useMultiDimAdvec    = .FALSE.
218          useCDscheme         = .FALSE.
219        useEnergyConservingCoriolis = .FALSE.        useEnergyConservingCoriolis = .FALSE.
220        useJamartWetPoints  = .FALSE.        useJamartWetPoints  = .FALSE.
221          useJamartMomAdv     = .FALSE.
222          selectVortScheme    = UNSET_I
223          upwindVorticity     = .FALSE.
224          highOrderVorticity  = .FALSE.
225          useAbsVorticity     = .FALSE.
226          upwindShear         = .FALSE.
227          selectKEscheme      = 0
228          IF ( debugMode ) THEN
229            debugLevel        = debLevD
230          ELSE
231            debugLevel        = debLevB
232    #ifdef ALLOW_AUTODIFF
233            debugLevel        = debLevA
234    #endif
235          ENDIF
236    
237  C--   Set (free)surface-related parameters  C--   Set (free)surface-related parameters
238        implicitFreeSurface = .TRUE.        implicitFreeSurface = .FALSE.
239        rigidLid            = .FALSE.        rigidLid            = .FALSE.
240        implicSurfPress     = 1.D0        implicSurfPress     = 1. _d 0
241        implicDiv2DFlow     = 1.D0        implicDiv2Dflow     = 1. _d 0
242        exactConserv        = .FALSE.        exactConserv        = .FALSE.
243          linFSConserveTr     = .FALSE.
244        uniformLin_PhiSurf  = .TRUE.        uniformLin_PhiSurf  = .TRUE.
245        nonlinFreeSurf      = 0        nonlinFreeSurf      = 0
246        hFacInf             = 1.D0        hFacInf             = 0.2 _d 0
247        hFacSup             = 1.D0        hFacSup             = 2.0 _d 0
248          select_rStar        = 0
249          selectNHfreeSurf    = 0
250          selectAddFluid      = 0
251        useRealFreshWaterFlux = .FALSE.        useRealFreshWaterFlux = .FALSE.
252        temp_EvPrRn = UNSET_RL        temp_EvPrRn = UNSET_RL
253        salt_EvPrRn = 0.        salt_EvPrRn = 0.
254        trac_EvPrRn = UNSET_RL        temp_addMass = UNSET_RL
255          salt_addMass = UNSET_RL
256          balanceEmPmR        = .FALSE.
257          balanceQnet         = .FALSE.
258          balancePrintMean    = .FALSE.
259          balanceThetaClimRelax = .FALSE.
260          balanceSaltClimRelax  = .FALSE.
261    
262  C--   Atmospheric physical parameters (e.g.: EOS)  C--   Atmospheric physical parameters (e.g.: EOS)
263        atm_po =  1.D5        celsius2K = 273.15 _d 0
264        atm_cp =  1004.D0        atm_Po =  1. _d 5
265        atm_kappa = 2.D0 / 7.D0        atm_Cp = 1004. _d 0
266        Integr_GeoPot = 2        atm_Rd = UNSET_RL
267          atm_kappa = 2. _d 0 / 7. _d 0
268          atm_Rq = 0. _d 0
269          integr_GeoPot = 2
270          selectFindRoSurf = 0
271    
272  C--   Elliptic solver parameters  C--   Elliptic solver parameters
273        cg2dMaxIters       = 150        cg2dMaxIters       = 150
274        cg2dTargetResidual = 1.D-7        cg2dTargetResidual = 1. _d -7
275        cg2dTargetResWunit = -1.        cg2dTargetResWunit = -1.
276        cg2dChkResFreq     = 1        cg2dChkResFreq     = 1
277        cg2dpcOffDFac      = 0.51D0        cg2dUseMinResSol   = UNSET_I
278          cg2dpcOffDFac      = 0.51 _d 0
279          cg2dPreCondFreq    = 1
280        cg3dMaxIters       = 150        cg3dMaxIters       = 150
281        cg3dTargetResidual = 1.D-7        cg3dTargetResidual = 1. _d -7
282        cg3dChkResFreq     = 1        cg3dChkResFreq     = 1
283          useSRCGSolver      = .FALSE.
284    
285  C--   Time stepping parameters  C--   Time stepping parameters
286        deltaT            = 0.        deltaT            = 0. _d 0
287        nIter0            = 0        deltaTMom         = 0. _d 0
288        startTime         = deltaT*float(nIter0)        deltaTFreeSurf    = 0. _d 0
289          DO k=1,Nr
290            dTtracerLev(k)  = 0. _d 0
291          ENDDO
292          baseTime          = 0. _d 0
293          nIter0            = -1
294          startTime         = UNSET_RL
295          pickupSuff        = ' '
296          pickupStrictlyMatch = .TRUE.
297        nTimeSteps        = 0        nTimeSteps        = 0
298        nEndIter          = nIter0+nTimeSteps        nEndIter          = 0
299        endTime           = deltaT*float(nEndIter)        endTime           = 0. _d 0
300        forcing_In_AB     = .TRUE.        momForcingOutAB   = UNSET_I
301        abEps             = 0.01        tracForcingOutAB  = UNSET_I
302        pchkPtFreq        = deltaT*0        momDissip_In_AB   = .TRUE.
303          doAB_onGtGs       = .TRUE.
304          abEps             = 0.01 _d 0
305    #ifdef ALLOW_ADAMSBASHFORTH_3
306          alph_AB           = 0.5 _d 0
307          beta_AB           = 5. _d 0 / 12. _d 0
308          startFromPickupAB2= .FALSE.
309    #else
310          alph_AB           = UNSET_RL
311          beta_AB           = UNSET_RL
312          startFromPickupAB2= .TRUE.
313    #endif
314          pChkPtFreq        = deltaT*0
315        chkPtFreq         = deltaT*0        chkPtFreq         = deltaT*0
316          outputTypesInclusive = .FALSE.
317          pickup_read_mdsio = .TRUE.
318          pickup_write_mdsio= .TRUE.
319          pickup_write_immed= .FALSE.
320          writePickupAtEnd  = .TRUE.
321        dumpFreq          = deltaT*0        dumpFreq          = deltaT*0
322          adjDumpFreq       = deltaT*0
323        diagFreq          = deltaT*0        diagFreq          = deltaT*0
324          dumpInitAndLast   = .TRUE.
325          snapshot_mdsio    = .TRUE.
326        monitorFreq       = -1.        monitorFreq       = -1.
327          adjMonitorFreq    = 0.
328          monitorSelect     = UNSET_I
329          monitor_stdio     = .TRUE.
330        taveFreq          = deltaT*0        taveFreq          = deltaT*0
331          timeave_mdsio     = .TRUE.
332          tave_lastIter     = 0.5 _d 0
333        writeStatePrec    = precFloat64        writeStatePrec    = precFloat64
334        writeBinaryPrec   = precFloat32        writeBinaryPrec   = precFloat32
335        readBinaryPrec    = precFloat32        readBinaryPrec    = precFloat32
336        nCheckLev         = 1        cAdjFreq          =  0. _d 0
337        checkPtSuff(1)    = 'ckptA'        tauCD             =  0. _d 0
338        checkPtSuff(2)    = 'ckptB'        tauThetaClimRelax =  0. _d 0
339        cAdjFreq          =  0.D0        tauSaltClimRelax  =  0. _d 0
       tauCD             =  0.D0  
       tauThetaClimRelax =  0.D0  
       tauSaltClimRelax  =  0.D0  
       tauTr1ClimRelax   =  0.D0  
340        periodicExternalForcing = .FALSE.        periodicExternalForcing = .FALSE.
341        externForcingPeriod     = 0.        externForcingPeriod     = 0.
342        externForcingCycle      = 0.        externForcingCycle      = 0.
343          tCylIn             = 0.
344          tCylOut            = 20.
345    
346  C--   Input files  C--   Input files
347        bathyFile       = ' '        bathyFile       = ' '
348        topoFile        = ' '        topoFile        = ' '
349          addWwallFile    = ' '
350          addSwallFile    = ' '
351        hydrogSaltFile  = ' '        hydrogSaltFile  = ' '
352        hydrogThetaFile = ' '        hydrogThetaFile = ' '
353          maskIniTemp     = .TRUE.
354          maskIniSalt     = .TRUE.
355          checkIniTemp    = .TRUE.
356          checkIniSalt    = .TRUE.
357          diffKrFile      = ' '
358          viscAhDfile     = ' '
359          viscAhZfile     = ' '
360          viscA4Dfile     = ' '
361          viscA4Zfile     = ' '
362        zonalWindFile   = ' '        zonalWindFile   = ' '
363        meridWindFile   = ' '        meridWindFile   = ' '
364        thetaClimFile   = ' '        thetaClimFile   = ' '
365        saltClimFile    = ' '        saltClimFile    = ' '
366        EmPmRfile       = ' '        EmPmRfile       = ' '
367          saltFluxFile    = ' '
368        surfQfile       = ' '        surfQfile       = ' '
369        surfQswfile     = ' '        surfQnetFile    = ' '
370          surfQswFile     = ' '
371        uVelInitFile    = ' '        uVelInitFile    = ' '
372        vVelInitFile    = ' '        vVelInitFile    = ' '
373        pSurfInitFile   = ' '        pSurfInitFile   = ' '
374        dQdTFile        = ' '        pLoadFile       = ' '
375        ploadFile       = ' '        addMassFile     = ' '
376          eddyPsiXFile    = ' '
377          eddyPsiYFile    = ' '
378          lambdaThetaFile = ' '
379          lambdaSaltFile  = ' '
380          mdsioLocalDir   = ' '
381          adTapeDir       = ' '
382          the_run_name    = ' '
383    
 C  
384        RETURN        RETURN
385        END        END
   

Legend:
Removed from v.1.36  
changed lines
  Added in v.1.172

  ViewVC Help
Powered by ViewVC 1.1.22