OpenAD/code_shallow_openad3/set_defaults.F

C $Header: /u/gcmpack/MITgcm_contrib/heimbach/OpenAD/code_shallow_openad3/set_defaults.F,v 1.1 2006/08/01 15:44:29 utke Exp $
C $Name:  $

#include "CPP_OPTIONS.h"

C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C     !ROUTINE: SET_DEFAULTS
C     !INTERFACE:
      SUBROUTINE SET_DEFAULTS(
     O   viscArDefault, diffKrTDefault, diffKrSDefault,
     O   hFacMinDrDefault, delRdefault, rkFacDefault,
     I   myThid )

C     !DESCRIPTION:
C     Routine to set model "parameter defaults".

C     !USES:
      IMPLICIT NONE
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
Cml#include "EOS.h"
#include "GRID.h"

C     !INPUT/OUTPUT PARAMETERS:
C     myThid - Number of this instance of INI_PARMS
      INTEGER myThid
      _RL viscArDefault
      _RL diffKrTDefault
      _RL diffKrSDefault
      _RL hFacMinDrDefault
      _RL delRDefault(Nr)
      _RS rkFacDefault

C     !LOCAL VARIABLES:
C     K, I, J - Loop counters
      INTEGER K, I, J
CEOP

C--   Grid parameters
C     Vertical gridding
      rkFacDefault        = 1. _d 0
      horiVertRatio       = 1. _d 0
      Ro_SeaLevel         = 0.
      DO k=1,Nr
       delRdefault(k)     = 0.
      ENDDO
      DO k=1,Nr+1
       delRc(k)           = UNSET_RL
      ENDDO

C     Horizontal gridding
      delXFile            = ' '
      delYFile            = ' '
      horizGridFile       = ' '
C     In cartesian coords distances are in metres
      usingCartesianGrid  = .FALSE.
      DO i=1,Nx
       delX(i)            = UNSET_RL
      ENDDO
      DO j=1,Ny
       delY(j)            = UNSET_RL
      ENDDO
C     In spherical polar distances are in degrees
      usingSphericalPolarGrid = .FALSE.
      phiMin              = 0.0
      thetaMin            = 0.
      rSphere             = 6370. _d 3
C     General curvilinear coordinate system
      usingCurvilinearGrid= .FALSE.
C     General cylindrical coordinate system
      usingCylindricalGrid= .FALSE.
C     Coriolis map:
      useConstantF        = .FALSE.
      useBetaPlaneF       = .FALSE.
      useSphereF          = .FALSE.


C--   Set default "physical" parameters
      nh_Am2              = 1. _d 0
      gravity             = 9.81 _d 0
      rhoNil              = 999.8 _d 0
C-- jmc : the default is to set rhoConstFresh to rhoConst (=rhoNil by default)
C         (so that the default produces same results as before)
c     rhoConstFresh       = 999.8 _d 0
      f0                  = 1. _d -4
      beta                = 1. _d -11
C-    Earth rotation period is 86400*365.25/366.25 (use to be 1.day)
      rotationPeriod      = 86164. _d 0
      viscAh              = 0. _d 3
      viscAhGrid          = 0. _d 0
      viscAhGridMin       = 0. _d 0
      viscAhGridMax       = 1. _d 21
      viscAhMax%v         = 1. _d 21
      viscAhReMax         = 0. _d 0
      viscC2leith         = 0. _d 0
      viscC2leithD        = 0. _d 0
      viscC2smag          = 0. _d 0
      diffKhT             = 0. _d 3
      diffKhS             = 0. _d 3
      viscArDefault       = 0. _d -3
      no_slip_sides       = .TRUE.
      no_slip_bottom      = .TRUE.
      sideDragFactor      = 2. _d 0
      bottomDragLinear    = 0.
      bottomDragQuadratic = 0.
      diffKrTDefault      = 0. _d -3
      diffKrSDefault      = 0. _d -3
      diffKrBL79surf      = 0. _d 0
      diffKrBL79deep      = 0. _d 0
      diffKrBL79scl       = 200. _d 0
      diffKrBL79Ho        = -2000. _d 0
      viscA4              = 0. _d 11
      viscA4Grid          = 0. _d 0
      viscA4GridMax       = 1. _d 21
      viscA4GridMin       = 0. _d 0
      viscA4Max%v         = 1. _d 21
      viscA4ReMax         = 0. _d 0
      viscC4leith         = 0. _d 0
      viscC4leithD        = 0. _d 0
      viscC4smag          = 0. _d 0
      diffK4T             = 0. _d 11
      diffK4S             = 0. _d 11
      cosPower            = 0.
      HeatCapacity_Cp     = 3994. _d 0
Cml      tAlpha              = 2. _d -4
Cml      sBeta               = 7.4 _d -4
      eosType             = 'LINEAR'
      buoyancyRelation    = 'OCEANIC'
      hFacMin%v           = 1. _d 0
      hFacMinDrDefault    = 0. _d 0
      implicitIntGravWave = .FALSE.
      staggerTimeStep     = .FALSE.
      momViscosity        = .TRUE.
      momAdvection        = .TRUE.
      momForcing          = .TRUE.
      useCoriolis         = .TRUE.
      momPressureForcing  = .TRUE.
      momStepping         = .TRUE.
      vectorInvariantMomentum = .FALSE.
      tempStepping        = .TRUE.
      tempAdvection       = .TRUE.
      tempForcing         = .TRUE.
      saltStepping        = .TRUE.
      saltAdvection       = .TRUE.
      saltForcing         = .TRUE.
      metricTerms         = .TRUE.
      useNHMTerms         = .FALSE.
      useFullLeith        = .FALSE.
      useAreaViscLength   = .FALSE.
      useStrainTensionVisc= .FALSE.
      implicitDiffusion   = .FALSE.
      implicitViscosity   = .FALSE.
      momImplVertAdv      = .FALSE.
      tempImplVertAdv     = .FALSE.
      saltImplVertAdv     = .FALSE.
      nonHydrostatic      = .FALSE.
      quasiHydrostatic    = .FALSE.
      globalFiles         = .FALSE.
      useSingleCpuIO      = .FALSE.
      allowFreezing       = .FALSE.
      useOldFreezing      = .FALSE.
      ivdc_kappa          = 0. _d 0
      usePickupBeforeC35    = .FALSE.
      usePickupBeforeC54    = .FALSE.
      debugMode             = .FALSE.
      tempAdvScheme       = 2
      saltAdvScheme       = 2
      multiDimAdvection   = .TRUE.
      useCDscheme         = .FALSE.
      useEnergyConservingCoriolis = .FALSE.
      useJamartWetPoints  = .FALSE.
      useJamartMomAdv     = .FALSE.
      SadournyCoriolis    = .FALSE.
      upwindVorticity     = .FALSE.
      highOrderVorticity  = .FALSE.
      useAbsVorticity     = .FALSE.
      upwindShear         = .FALSE.
      selectKEscheme      = 0
      debugLevel          = debLevA
      inAdMode            = .FALSE.
      inAdExact           = .TRUE.

C--   Set (free)surface-related parameters
      implicitFreeSurface = .FALSE.
      rigidLid            = .FALSE.
      implicSurfPress     = 1. _d 0
      implicDiv2DFlow     = 1. _d 0
      exactConserv        = .FALSE.
      uniformLin_PhiSurf  = .TRUE.
      nonlinFreeSurf      = 0
      hFacInf             = 0.2 _d 0
      hFacSup             = 2.0 _d 0
      select_rStar        = 0
      useRealFreshWaterFlux = .FALSE.
      temp_EvPrRn = UNSET_RL
      salt_EvPrRn = 0.
      balanceEmPmR        = .FALSE.
      balanceQnet         = .FALSE.
      balancePrintMean    = .FALSE.

C--   Atmospheric physical parameters (e.g.: EOS)
      celsius2K = 273.16 _d 0
      atm_Po =  1. _d 5
      atm_Cp = 1004. _d 0
      atm_Rd = UNSET_RL
      atm_kappa = 2. _d 0 / 7. _d 0
      atm_Rq = 0. _d 0
      integr_GeoPot = 2
      selectFindRoSurf = 0

C--   Elliptic solver parameters
      cg2dMaxIters       = 150
      cg2dTargetResidual = 1. _d -7
      cg2dTargetResWunit = -1.
      cg2dChkResFreq     = 1
      cg2dpcOffDFac      = 0.51 _d 0
      cg2dPreCondFreq    = 1
      cg3dMaxIters       = 150
      cg3dTargetResidual = 1. _d -7
      cg3dChkResFreq     = 1

C--   Time stepping parameters
      deltaT            = 0. _d 0
      deltaTmom         = 0. _d 0
      deltaTfreesurf    = 0. _d 0
      DO k=1,Nr
        dTtracerLev(k)  = 0. _d 0
      ENDDO
      baseTime          = 0. _d 0
      nIter0            = 0
      startTime         = deltaT*float(nIter0)
      pickupSuff        = ' '
      nTimeSteps        = 0
      nEndIter          = nIter0+nTimeSteps
      endTime           = deltaT*float(nEndIter)
      momForcingOutAB   = UNSET_I
      tracForcingOutAB  = UNSET_I
      momDissip_In_AB   = .TRUE.
      doAB_onGtGs       = .TRUE.
      abEps             = 0.01 _d 0
#ifdef ALLOW_ADAMSBASHFORTH_3
      alph_AB           = 0.5 _d 0
      beta_AB           = 5. _d 0 / 12. _d 0
      startFromPickupAB2= .FALSE.
#else
      alph_AB           = UNSET_RL
      beta_AB           = UNSET_RL
      startFromPickupAB2= .TRUE.
#endif
      pChkPtFreq        = deltaT*0
      chkPtFreq         = deltaT*0
      outputTypesInclusive = .FALSE.
      pickup_read_mdsio = .TRUE.
      pickup_write_mdsio= .TRUE.
      pickup_write_immed= .FALSE.
      dumpFreq          = deltaT*0
      adjDumpFreq       = deltaT*0
      diagFreq          = deltaT*0
      dumpInitAndLast   = .TRUE.
      snapshot_mdsio    = .TRUE.
      monitorFreq       = -1.
      adjMonitorFreq    = 0.
      monitor_stdio     = .TRUE.
      taveFreq          = deltaT*0
      timeave_mdsio     = .TRUE.
      tave_lastIter     = 0.5 _d 0
      writeStatePrec    = precFloat64
      writeBinaryPrec   = precFloat32
      readBinaryPrec    = precFloat32
      nCheckLev         = 1
      checkPtSuff(1)    = 'ckptA'
      checkPtSuff(2)    = 'ckptB'
      cAdjFreq          =  0. _d 0
      tauCD             =  0. _d 0
      tauThetaClimRelax =  0. _d 0
      tauSaltClimRelax  =  0. _d 0
      tauTr1ClimRelax   =  0. _d 0
      periodicExternalForcing = .FALSE.
      externForcingPeriod     = 0.
      externForcingCycle      = 0.
      tCylIn             = 0.
      tCylOut            = 20.
      calendarDumps     = .FALSE.

C--   Input files
      bathyFile       = ' '
      topoFile        = ' '
      shelfIceFile    = ' '
      hydrogSaltFile  = ' '
      hydrogThetaFile = ' '
      zonalWindFile   = ' '
      meridWindFile   = ' '
      thetaClimFile   = ' '
      saltClimFile    = ' '
      EmPmRfile       = ' '
      saltFluxFile    = ' '
      surfQfile       = ' '
      surfQnetFile    = ' '
      surfQswFile     = ' '
      uVelInitFile    = ' '
      vVelInitFile    = ' '
      pSurfInitFile   = ' '
      dQdTFile        = ' '
      ploadFile       = ' '
      eddyTauxFile    = ' '
      eddyTauyFile    = ' '
      lambdaThetaFile = ' '
      lambdaSaltFile  = ' '
      mdsioLocalDir   = ' '

      RETURN
      END
1	utke	1.2	C $Header: /u/gcmpack/MITgcm_contrib/heimbach/OpenAD/code_shallow_openad3/set_defaults.F,v 1.1 2006/08/01 15:44:29 utke Exp $
2	utke	1.1	C $Name: $
3
4			#include "CPP_OPTIONS.h"
5
6			C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
7			CBOP
8			C !ROUTINE: SET_DEFAULTS
9			C !INTERFACE:
10			SUBROUTINE SET_DEFAULTS(
11			O viscArDefault, diffKrTDefault, diffKrSDefault,
12			O hFacMinDrDefault, delRdefault, rkFacDefault,
13			I myThid )
14
15			C !DESCRIPTION:
16			C Routine to set model "parameter defaults".
17
18			C !USES:
19			IMPLICIT NONE
20			#include "SIZE.h"
21			#include "EEPARAMS.h"
22			#include "PARAMS.h"
23			Cml#include "EOS.h"
24			#include "GRID.h"
25
26			C !INPUT/OUTPUT PARAMETERS:
27			C myThid - Number of this instance of INI_PARMS
28			INTEGER myThid
29			_RL viscArDefault
30			_RL diffKrTDefault
31			_RL diffKrSDefault
32			_RL hFacMinDrDefault
33			_RL delRDefault(Nr)
34			_RS rkFacDefault
35
36			C !LOCAL VARIABLES:
37			C K, I, J - Loop counters
38			INTEGER K, I, J
39			CEOP
40
41			C-- Grid parameters
42			C Vertical gridding
43			rkFacDefault = 1. _d 0
44			horiVertRatio = 1. _d 0
45			Ro_SeaLevel = 0.
46			DO k=1,Nr
47			delRdefault(k) = 0.
48			ENDDO
49			DO k=1,Nr+1
50			delRc(k) = UNSET_RL
51			ENDDO
52
53			C Horizontal gridding
54			delXFile = ' '
55			delYFile = ' '
56			horizGridFile = ' '
57			C In cartesian coords distances are in metres
58			usingCartesianGrid = .FALSE.
59			DO i=1,Nx
60			delX(i) = UNSET_RL
61			ENDDO
62			DO j=1,Ny
63			delY(j) = UNSET_RL
64			ENDDO
65			C In spherical polar distances are in degrees
66			usingSphericalPolarGrid = .FALSE.
67			phiMin = 0.0
68			thetaMin = 0.
69			rSphere = 6370. _d 3
70			C General curvilinear coordinate system
71			usingCurvilinearGrid= .FALSE.
72			C General cylindrical coordinate system
73			usingCylindricalGrid= .FALSE.
74			C Coriolis map:
75			useConstantF = .FALSE.
76			useBetaPlaneF = .FALSE.
77			useSphereF = .FALSE.
78
79
80			C-- Set default "physical" parameters
81			nh_Am2 = 1. _d 0
82			gravity = 9.81 _d 0
83			rhoNil = 999.8 _d 0
84			C-- jmc : the default is to set rhoConstFresh to rhoConst (=rhoNil by default)
85			C (so that the default produces same results as before)
86			c rhoConstFresh = 999.8 _d 0
87			f0 = 1. _d -4
88			beta = 1. _d -11
89			C- Earth rotation period is 86400*365.25/366.25 (use to be 1.day)
90			rotationPeriod = 86164. _d 0
91			viscAh = 0. _d 3
92			viscAhGrid = 0. _d 0
93			viscAhGridMin = 0. _d 0
94			viscAhGridMax = 1. _d 21
95			viscAhMax%v = 1. _d 21
96			viscAhReMax = 0. _d 0
97			viscC2leith = 0. _d 0
98			viscC2leithD = 0. _d 0
99			viscC2smag = 0. _d 0
100			diffKhT = 0. _d 3
101			diffKhS = 0. _d 3
102			viscArDefault = 0. _d -3
103			no_slip_sides = .TRUE.
104			no_slip_bottom = .TRUE.
105			sideDragFactor = 2. _d 0
106			bottomDragLinear = 0.
107			bottomDragQuadratic = 0.
108			diffKrTDefault = 0. _d -3
109			diffKrSDefault = 0. _d -3
110			diffKrBL79surf = 0. _d 0
111			diffKrBL79deep = 0. _d 0
112			diffKrBL79scl = 200. _d 0
113			diffKrBL79Ho = -2000. _d 0
114			viscA4 = 0. _d 11
115			viscA4Grid = 0. _d 0
116			viscA4GridMax = 1. _d 21
117			viscA4GridMin = 0. _d 0
118			viscA4Max%v = 1. _d 21
119			viscA4ReMax = 0. _d 0
120			viscC4leith = 0. _d 0
121			viscC4leithD = 0. _d 0
122			viscC4smag = 0. _d 0
123			diffK4T = 0. _d 11
124			diffK4S = 0. _d 11
125			cosPower = 0.
126			HeatCapacity_Cp = 3994. _d 0
127			Cml tAlpha = 2. _d -4
128			Cml sBeta = 7.4 _d -4
129			eosType = 'LINEAR'
130			buoyancyRelation = 'OCEANIC'
131			hFacMin%v = 1. _d 0
132			hFacMinDrDefault = 0. _d 0
133			implicitIntGravWave = .FALSE.
134			staggerTimeStep = .FALSE.
135			momViscosity = .TRUE.
136			momAdvection = .TRUE.
137			momForcing = .TRUE.
138			useCoriolis = .TRUE.
139			momPressureForcing = .TRUE.
140			momStepping = .TRUE.
141			vectorInvariantMomentum = .FALSE.
142			tempStepping = .TRUE.
143			tempAdvection = .TRUE.
144			tempForcing = .TRUE.
145			saltStepping = .TRUE.
146			saltAdvection = .TRUE.
147			saltForcing = .TRUE.
148			metricTerms = .TRUE.
149			useNHMTerms = .FALSE.
150			useFullLeith = .FALSE.
151			useAreaViscLength = .FALSE.
152			useStrainTensionVisc= .FALSE.
153			implicitDiffusion = .FALSE.
154			implicitViscosity = .FALSE.
155			momImplVertAdv = .FALSE.
156			tempImplVertAdv = .FALSE.
157			saltImplVertAdv = .FALSE.
158			nonHydrostatic = .FALSE.
159			quasiHydrostatic = .FALSE.
160			globalFiles = .FALSE.
161			useSingleCpuIO = .FALSE.
162			allowFreezing = .FALSE.
163			useOldFreezing = .FALSE.
164			ivdc_kappa = 0. _d 0
165			usePickupBeforeC35 = .FALSE.
166			usePickupBeforeC54 = .FALSE.
167			debugMode = .FALSE.
168			tempAdvScheme = 2
169			saltAdvScheme = 2
170			multiDimAdvection = .TRUE.
171			useCDscheme = .FALSE.
172			useEnergyConservingCoriolis = .FALSE.
173			useJamartWetPoints = .FALSE.
174			useJamartMomAdv = .FALSE.
175			SadournyCoriolis = .FALSE.
176			upwindVorticity = .FALSE.
177			highOrderVorticity = .FALSE.
178			useAbsVorticity = .FALSE.
179			upwindShear = .FALSE.
180			selectKEscheme = 0
181			debugLevel = debLevA
182			inAdMode = .FALSE.
183			inAdExact = .TRUE.
184
185			C-- Set (free)surface-related parameters
186			implicitFreeSurface = .FALSE.
187			rigidLid = .FALSE.
188			implicSurfPress = 1. _d 0
189			implicDiv2DFlow = 1. _d 0
190			exactConserv = .FALSE.
191			uniformLin_PhiSurf = .TRUE.
192			nonlinFreeSurf = 0
193			hFacInf = 0.2 _d 0
194			hFacSup = 2.0 _d 0
195			select_rStar = 0
196			useRealFreshWaterFlux = .FALSE.
197			temp_EvPrRn = UNSET_RL
198			salt_EvPrRn = 0.
199			balanceEmPmR = .FALSE.
200			balanceQnet = .FALSE.
201			balancePrintMean = .FALSE.
202
203			C-- Atmospheric physical parameters (e.g.: EOS)
204			celsius2K = 273.16 _d 0
205			atm_Po = 1. _d 5
206			atm_Cp = 1004. _d 0
207			atm_Rd = UNSET_RL
208			atm_kappa = 2. _d 0 / 7. _d 0
209			atm_Rq = 0. _d 0
210			integr_GeoPot = 2
211			selectFindRoSurf = 0
212
213			C-- Elliptic solver parameters
214			cg2dMaxIters = 150
215			cg2dTargetResidual = 1. _d -7
216			cg2dTargetResWunit = -1.
217			cg2dChkResFreq = 1
218			cg2dpcOffDFac = 0.51 _d 0
219			cg2dPreCondFreq = 1
220			cg3dMaxIters = 150
221			cg3dTargetResidual = 1. _d -7
222			cg3dChkResFreq = 1
223
224			C-- Time stepping parameters
225			deltaT = 0. _d 0
226			deltaTmom = 0. _d 0
227			deltaTfreesurf = 0. _d 0
228			DO k=1,Nr
229			dTtracerLev(k) = 0. _d 0
230			ENDDO
231			baseTime = 0. _d 0
232			nIter0 = 0
233			startTime = deltaT*float(nIter0)
234			pickupSuff = ' '
235			nTimeSteps = 0
236			nEndIter = nIter0+nTimeSteps
237			endTime = deltaT*float(nEndIter)
238			momForcingOutAB = UNSET_I
239			tracForcingOutAB = UNSET_I
240			momDissip_In_AB = .TRUE.
241			doAB_onGtGs = .TRUE.
242			abEps = 0.01 _d 0
243			#ifdef ALLOW_ADAMSBASHFORTH_3
244			alph_AB = 0.5 _d 0
245			beta_AB = 5. _d 0 / 12. _d 0
246			startFromPickupAB2= .FALSE.
247			#else
248			alph_AB = UNSET_RL
249			beta_AB = UNSET_RL
250			startFromPickupAB2= .TRUE.
251			#endif
252			pChkPtFreq = deltaT*0
253			chkPtFreq = deltaT*0
254			outputTypesInclusive = .FALSE.
255			pickup_read_mdsio = .TRUE.
256			pickup_write_mdsio= .TRUE.
257			pickup_write_immed= .FALSE.
258			dumpFreq = deltaT*0
259			adjDumpFreq = deltaT*0
260			diagFreq = deltaT*0
261			dumpInitAndLast = .TRUE.
262			snapshot_mdsio = .TRUE.
263			monitorFreq = -1.
264			adjMonitorFreq = 0.
265			monitor_stdio = .TRUE.
266			taveFreq = deltaT*0
267			timeave_mdsio = .TRUE.
268			tave_lastIter = 0.5 _d 0
269			writeStatePrec = precFloat64
270			writeBinaryPrec = precFloat32
271			readBinaryPrec = precFloat32
272			nCheckLev = 1
273			checkPtSuff(1) = 'ckptA'
274			checkPtSuff(2) = 'ckptB'
275			cAdjFreq = 0. _d 0
276			tauCD = 0. _d 0
277			tauThetaClimRelax = 0. _d 0
278			tauSaltClimRelax = 0. _d 0
279			tauTr1ClimRelax = 0. _d 0
280			periodicExternalForcing = .FALSE.
281			externForcingPeriod = 0.
282			externForcingCycle = 0.
283			tCylIn = 0.
284			tCylOut = 20.
285			calendarDumps = .FALSE.
286
287			C-- Input files
288			bathyFile = ' '
289			topoFile = ' '
290			shelfIceFile = ' '
291			hydrogSaltFile = ' '
292			hydrogThetaFile = ' '
293			zonalWindFile = ' '
294			meridWindFile = ' '
295			thetaClimFile = ' '
296			saltClimFile = ' '
297			EmPmRfile = ' '
298			saltFluxFile = ' '
299			surfQfile = ' '
300			surfQnetFile = ' '
301			surfQswFile = ' '
302			uVelInitFile = ' '
303			vVelInitFile = ' '
304			pSurfInitFile = ' '
305			dQdTFile = ' '
306			ploadFile = ' '
307			eddyTauxFile = ' '
308			eddyTauyFile = ' '
309			lambdaThetaFile = ' '
310			lambdaSaltFile = ' '
311			mdsioLocalDir = ' '
312
313			RETURN
314			END