model/src/set_defaults.F

C $Header: /u/gcmpack/MITgcm/model/src/set_defaults.F,v 1.81 2005/01/11 20:49:24 afe 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.D0
      horiVertRatio        = 1.D0
      Ro_SeaLevel = 0.
      DO k=1,Nr
       delRdefault(k) = 0.
      ENDDO
      DO k=1,Nr+1
       delRc(k) = UNSET_RL
      ENDDO

C     Horizontal gridding
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. * 1.D3
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
      DO K =1,Nr
       tRef(K) = 30.D0 - FLOAT( K )
Cml       sRef(K) = 35.D0
      ENDDO
      gravity             = 9.81D0
      rhoNil              = 999.8D0
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.8D0
      f0                  = 1.D-4
      beta                = 1.D-11
C-    Always use 1 day in the past but should be 86164 (=86400*365.25/366.25)
      rotationPeriod      = 86400. _d 0
      viscAh              = 0.D3
      viscAhGrid          = 0.D0
      viscAhMax           = 1.D21
      viscC2leith         = 0.D0
      viscAstrain         = 0.D3
      viscAtension        = 0.D3
      diffKhT             = 0.D3
      diffKhS             = 0.D3
      viscArDefault       = 0.D-3
      no_slip_sides       = .TRUE.
      no_slip_bottom      = .TRUE.
      diffKrTDefault      = 0.D-3
      diffKrSDefault      = 0.D-3
      diffKrBL79surf      = 0.D0
      diffKrBL79deep      = 0.D0
      diffKrBL79scl       = 200.D0
      diffKrBL79Ho        = -2000.D0
      viscA4              = 0.D11
      viscA4Grid          = 0.D0
      viscA4GridMax       = 0.D0
      viscA4GridMin       = 0.D0
      viscA4Max           = 1.D21
      viscC4leith         = 0.D0
      diffK4T             = 0.D11
      diffK4S             = 0.D11
      cosPower            = 0.
      HeatCapacity_Cp     = 3994.D0
Cml      tAlpha              = 2.D-4
Cml      sBeta               = 7.4D-4
      eosType             = 'LINEAR'
      buoyancyRelation    = 'OCEANIC'
      hFacMin             = 1.D0
      hFacMinDrDefault    = 0.D0
      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.
      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.D0
      groundAtK1          = .FALSE.
      bottomDragLinear    = 0.
      bottomDragQuadratic = 0.
      usePickupBeforeC35    = .FALSE.
      usePickupBeforeC54    = .FALSE.
      debugMode             = .FALSE.
      readPickupWithTracer  = .FALSE.
      writePickupWithTracer = .FALSE.
      tempAdvScheme       = 2
      saltAdvScheme       = 2
      multiDimAdvection   = .TRUE.
      useCDscheme         = .FALSE.
      useEnergyConservingCoriolis = .FALSE.
      useJamartWetPoints  = .FALSE.
      useJamartMomAdv     = .FALSE.
      SadournyCoriolis    = .FALSE.
      upwindVorticity     = .FALSE.
      highOrderVorticity  = .FALSE.
      useAbsVorticity     = .FALSE.
      debugLevel          = debLevA

C--   Set (free)surface-related parameters
      implicitFreeSurface = .TRUE.
      rigidLid            = .FALSE.
      implicSurfPress     = 1.D0
      implicDiv2DFlow     = 1.D0
      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.

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.51D0
      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
      nIter0            = 0
      startTime         = deltaT*float(nIter0)
      pickupSuff        = ' '
      nTimeSteps        = 0
      nEndIter          = nIter0+nTimeSteps
      endTime           = deltaT*float(nEndIter)
      forcing_In_AB     = .TRUE.
      abEps             = 0.01
      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
      snapshot_mdsio    = .TRUE.
      monitorFreq       = -1.
      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.D0
      tauCD             =  0.D0
      tauThetaClimRelax =  0.D0
      tauSaltClimRelax  =  0.D0
      tauTr1ClimRelax   =  0.D0
      periodicExternalForcing = .FALSE.
      externForcingPeriod     = 0.
      externForcingCycle      = 0.
      tCylIn             = 0.
      tCylOut            = 20.

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

C
      RETURN
      END
1	jmc	1.82	C $Header: /u/gcmpack/MITgcm/model/src/set_defaults.F,v 1.81 2005/01/11 20:49:24 afe Exp $
2	heimbach	1.18	C $Name: $
3	adcroft	1.1
4			#include "CPP_OPTIONS.h"
5
6	edhill	1.70	C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
7	cnh	1.29	CBOP
8			C !ROUTINE: SET_DEFAULTS
9			C !INTERFACE:
10	adcroft	1.1	SUBROUTINE SET_DEFAULTS(
11			O viscArDefault, diffKrTDefault, diffKrSDefault,
12	adcroft	1.2	O hFacMinDrDefault, delRdefault, rkFacDefault,
13	adcroft	1.1	I myThid )
14	cnh	1.29
15	edhill	1.70	C !DESCRIPTION:
16			C Routine to set model "parameter defaults".
17	cnh	1.29
18			C !USES:
19	adcroft	1.1	IMPLICIT NONE
20			#include "SIZE.h"
21			#include "EEPARAMS.h"
22			#include "PARAMS.h"
23	mlosch	1.37	Cml#include "EOS.h"
24	adcroft	1.1	#include "GRID.h"
25
26	cnh	1.29	C !INPUT/OUTPUT PARAMETERS:
27	adcroft	1.1	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	adcroft	1.2	_RS rkFacDefault
35	adcroft	1.1
36	cnh	1.29	C !LOCAL VARIABLES:
37	adcroft	1.1	C K, I, J - Loop counters
38			INTEGER K, I, J
39	cnh	1.29	CEOP
40	adcroft	1.1
41			C-- Grid parameters
42			C Vertical gridding
43	adcroft	1.2	rkFacDefault = 1.D0
44			horiVertRatio = 1.D0
45	adcroft	1.12	Ro_SeaLevel = 0.
46	adcroft	1.1	DO k=1,Nr
47	adcroft	1.2	delRdefault(k) = 0.
48	jmc	1.34	ENDDO
49			DO k=1,Nr+1
50			delRc(k) = UNSET_RL
51	adcroft	1.1	ENDDO
52
53			C Horizontal gridding
54			C In cartesian coords distances are in metres
55	jmc	1.56	usingCartesianGrid = .FALSE.
56	adcroft	1.1	DO i=1,Nx
57	adcroft	1.8	delX(i) = UNSET_RL
58	adcroft	1.1	ENDDO
59			DO j=1,Ny
60	adcroft	1.8	delY(j) = UNSET_RL
61	adcroft	1.1	ENDDO
62			C In spherical polar distances are in degrees
63			usingSphericalPolarGrid = .FALSE.
64	adcroft	1.2	phiMin = 0.0
65			thetaMin = 0.
66			rSphere = 6370. * 1.D3
67	adcroft	1.19	C General curvilinear coordinate system
68			usingCurvilinearGrid = .FALSE.
69	afe	1.64	C General cylindrical coordinate system
70			usingCylindricalGrid = .FALSE.
71	jmc	1.82	C Coriolis map:
72			useConstantF = .FALSE.
73			useBetaPlaneF = .FALSE.
74			useSphereF = .FALSE.
75	afe	1.64
76	adcroft	1.1
77			C-- Set default "physical" parameters
78			DO K =1,Nr
79			tRef(K) = 30.D0 - FLOAT( K )
80	mlosch	1.39	Cml sRef(K) = 35.D0
81	adcroft	1.1	ENDDO
82	adcroft	1.2	gravity = 9.81D0
83			rhoNil = 999.8D0
84	jmc	1.55	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.8D0
87	adcroft	1.2	f0 = 1.D-4
88			beta = 1.D-11
89	jmc	1.46	C- Always use 1 day in the past but should be 86164 (=86400*365.25/366.25)
90			rotationPeriod = 86400. _d 0
91	adcroft	1.2	viscAh = 0.D3
92	adcroft	1.58	viscAhGrid = 0.D0
93			viscAhMax = 1.D21
94	adcroft	1.60	viscC2leith = 0.D0
95	adcroft	1.27	viscAstrain = 0.D3
96			viscAtension = 0.D3
97	adcroft	1.2	diffKhT = 0.D3
98			diffKhS = 0.D3
99			viscArDefault = 0.D-3
100			no_slip_sides = .TRUE.
101			no_slip_bottom = .TRUE.
102			diffKrTDefault = 0.D-3
103			diffKrSDefault = 0.D-3
104	adcroft	1.62	diffKrBL79surf = 0.D0
105			diffKrBL79deep = 0.D0
106			diffKrBL79scl = 200.D0
107			diffKrBL79Ho = -2000.D0
108	adcroft	1.2	viscA4 = 0.D11
109	adcroft	1.58	viscA4Grid = 0.D0
110	dimitri	1.75	viscA4GridMax = 0.D0
111			viscA4GridMin = 0.D0
112	adcroft	1.58	viscA4Max = 1.D21
113	adcroft	1.60	viscC4leith = 0.D0
114	adcroft	1.2	diffK4T = 0.D11
115			diffK4S = 0.D11
116	adcroft	1.4	cosPower = 0.
117	adcroft	1.2	HeatCapacity_Cp = 3994.D0
118	mlosch	1.37	Cml tAlpha = 2.D-4
119			Cml sBeta = 7.4D-4
120	adcroft	1.2	eosType = 'LINEAR'
121	adcroft	1.1	buoyancyRelation = 'OCEANIC'
122			hFacMin = 1.D0
123			hFacMinDrDefault = 0.D0
124	adcroft	1.12	staggerTimeStep = .FALSE.
125	adcroft	1.1	momViscosity = .TRUE.
126			momAdvection = .TRUE.
127			momForcing = .TRUE.
128			useCoriolis = .TRUE.
129			momPressureForcing = .TRUE.
130			momStepping = .TRUE.
131	adcroft	1.25	vectorInvariantMomentum = .FALSE.
132	adcroft	1.1	tempStepping = .TRUE.
133	jmc	1.35	tempAdvection = .TRUE.
134			tempForcing = .TRUE.
135	adcroft	1.1	saltStepping = .TRUE.
136	jmc	1.35	saltAdvection = .TRUE.
137			saltForcing = .TRUE.
138	jmc	1.16	metricTerms = .TRUE.
139	jmc	1.53	useNHMTerms = .FALSE.
140	adcroft	1.1	implicitDiffusion = .FALSE.
141	adcroft	1.5	implicitViscosity = .FALSE.
142	jmc	1.57	momImplVertAdv = .FALSE.
143			tempImplVertAdv = .FALSE.
144			saltImplVertAdv = .FALSE.
145	adcroft	1.2	nonHydrostatic = .FALSE.
146	adcroft	1.42	quasiHydrostatic = .FALSE.
147	adcroft	1.3	globalFiles = .FALSE.
148	dimitri	1.45	useSingleCpuIO = .FALSE.
149	adcroft	1.3	allowFreezing = .FALSE.
150	jmc	1.54	useOldFreezing = .FALSE.
151	adcroft	1.6	ivdc_kappa = 0.D0
152	adcroft	1.12	groundAtK1 = .FALSE.
153			bottomDragLinear = 0.
154			bottomDragQuadratic = 0.
155	heimbach	1.23	usePickupBeforeC35 = .FALSE.
156	jmc	1.65	usePickupBeforeC54 = .FALSE.
157	heimbach	1.23	debugMode = .FALSE.
158			readPickupWithTracer = .FALSE.
159			writePickupWithTracer = .FALSE.
160	adcroft	1.24	tempAdvScheme = 2
161			saltAdvScheme = 2
162	adcroft	1.28	multiDimAdvection = .TRUE.
163	jmc	1.47	useCDscheme = .FALSE.
164	adcroft	1.30	useEnergyConservingCoriolis = .FALSE.
165	adcroft	1.31	useJamartWetPoints = .FALSE.
166	adcroft	1.63	useJamartMomAdv = .FALSE.
167	adcroft	1.61	SadournyCoriolis = .FALSE.
168			upwindVorticity = .FALSE.
169			highOrderVorticity = .FALSE.
170			useAbsVorticity = .FALSE.
171	jmc	1.79	debugLevel = debLevA
172	jmc	1.33
173			C-- Set (free)surface-related parameters
174			implicitFreeSurface = .TRUE.
175			rigidLid = .FALSE.
176			implicSurfPress = 1.D0
177			implicDiv2DFlow = 1.D0
178			exactConserv = .FALSE.
179			uniformLin_PhiSurf = .TRUE.
180			nonlinFreeSurf = 0
181	jmc	1.46	hFacInf = 0.2 _d 0
182			hFacSup = 2.0 _d 0
183	jmc	1.44	select_rStar = 0
184	jmc	1.33	useRealFreshWaterFlux = .FALSE.
185			temp_EvPrRn = UNSET_RL
186			salt_EvPrRn = 0.
187	adcroft	1.1
188	jmc	1.22	C-- Atmospheric physical parameters (e.g.: EOS)
189	jmc	1.49	celsius2K = 273.16 _d 0
190			atm_Po = 1. _d 5
191			atm_Cp = 1004. _d 0
192			atm_Rd = UNSET_RL
193			atm_kappa = 2. _d 0 / 7. _d 0
194	jmc	1.51	atm_Rq = 0. _d 0
195	jmc	1.43	integr_GeoPot = 2
196			selectFindRoSurf = 0
197	jmc	1.22
198	adcroft	1.1	C-- Elliptic solver parameters
199			cg2dMaxIters = 150
200			cg2dTargetResidual = 1.D-7
201	adcroft	1.19	cg2dTargetResWunit = -1.
202	adcroft	1.1	cg2dChkResFreq = 1
203	adcroft	1.2	cg2dpcOffDFac = 0.51D0
204	jmc	1.66	cg2dPreCondFreq = 1
205	adcroft	1.1	cg3dMaxIters = 150
206			cg3dTargetResidual = 1.D-7
207			cg3dChkResFreq = 1
208
209			C-- Time stepping parameters
210	jmc	1.77	deltaT = 0. _d 0
211			deltaTmom = 0. _d 0
212			deltaTfreesurf = 0. _d 0
213			DO k=1,Nr
214			dTtracerLev(k) = 0. _d 0
215			ENDDO
216	adcroft	1.1	nIter0 = 0
217			startTime = deltaT*float(nIter0)
218	adcroft	1.48	pickupSuff = ' '
219	adcroft	1.2	nTimeSteps = 0
220	adcroft	1.6	nEndIter = nIter0+nTimeSteps
221			endTime = deltaT*float(nEndIter)
222	jmc	1.35	forcing_In_AB = .TRUE.
223	adcroft	1.1	abEps = 0.01
224			pchkPtFreq = deltaT*0
225			chkPtFreq = deltaT*0
226	edhill	1.74	outputTypesInclusive = .FALSE.
227	edhill	1.70	pickup_read_mdsio = .TRUE.
228			pickup_write_mdsio= .TRUE.
229			pickup_write_immed= .FALSE.
230	adcroft	1.2	dumpFreq = deltaT*0
231	heimbach	1.59	adjDumpFreq = deltaT*0
232	adcroft	1.26	diagFreq = deltaT*0
233	edhill	1.70	snapshot_mdsio = .TRUE.
234	adcroft	1.20	monitorFreq = -1.
235	edhill	1.71	monitor_stdio = .TRUE.
236	adcroft	1.1	taveFreq = deltaT*0
237	edhill	1.70	timeave_mdsio = .TRUE.
238	jmc	1.40	tave_lastIter = 0.5 _d 0
239	adcroft	1.1	writeStatePrec = precFloat64
240			writeBinaryPrec = precFloat32
241			readBinaryPrec = precFloat32
242			nCheckLev = 1
243			checkPtSuff(1) = 'ckptA'
244			checkPtSuff(2) = 'ckptB'
245	adcroft	1.6	cAdjFreq = 0.D0
246	adcroft	1.1	tauCD = 0.D0
247			tauThetaClimRelax = 0.D0
248			tauSaltClimRelax = 0.D0
249	heimbach	1.23	tauTr1ClimRelax = 0.D0
250	adcroft	1.1	periodicExternalForcing = .FALSE.
251			externForcingPeriod = 0.
252			externForcingCycle = 0.
253	afe	1.81	tCylIn = 0.
254			tCylOut = 20.
255	afe	1.64
256	adcroft	1.1	C-- Input files
257			bathyFile = ' '
258	jmc	1.22	topoFile = ' '
259	adcroft	1.1	hydrogSaltFile = ' '
260			hydrogThetaFile = ' '
261			zonalWindFile = ' '
262			meridWindFile = ' '
263			thetaClimFile = ' '
264			saltClimFile = ' '
265	adcroft	1.2	EmPmRfile = ' '
266	jmc	1.80	saltFluxFile = ' '
267	adcroft	1.2	surfQfile = ' '
268	jmc	1.67	surfQnetFile = ' '
269			surfQswFile = ' '
270	adcroft	1.7	uVelInitFile = ' '
271			vVelInitFile = ' '
272	adcroft	1.9	pSurfInitFile = ' '
273	heimbach	1.17	dQdTFile = ' '
274	mlosch	1.36	ploadFile = ' '
275	heimbach	1.50	mdsioLocalDir = ' '
276	adcroft	1.1
277			C
278			RETURN
279			END