model/src/set_defaults.F

C $Header: /u/gcmpack/MITgcm/model/src/set_defaults.F,v 1.72 2004/09/17 22:57:12 heimbach 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--   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
      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
      tracerAdvScheme     = 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.
      trac_EvPrRn = UNSET_RL

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.
      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
      pickup_read_mdsio = .TRUE.
      pickup_write_mdsio= .TRUE.
      pickup_write_immed= .FALSE.
      pickup_write_ioinc= .FALSE.
      dumpFreq          = deltaT*0
      adjDumpFreq       = deltaT*0
      diagFreq          = deltaT*0
      snapshot_mdsio    = .TRUE.
      snapshot_ioinc    = .FALSE.
      monitorFreq       = -1.
      monitor_stdio     = .TRUE.
      monitor_ioinc     = .FALSE.
      taveFreq          = deltaT*0
      timeave_mdsio     = .TRUE.
      timeave_ioinc     = .FALSE.
      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.
      tCyl              = 0.

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

C
      RETURN
      END
1	edhill	1.73	C $Header: /u/gcmpack/MITgcm/model/src/set_defaults.F,v 1.72 2004/09/17 22:57:12 heimbach 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
72	adcroft	1.1
73			C-- Set default "physical" parameters
74			DO K =1,Nr
75			tRef(K) = 30.D0 - FLOAT( K )
76	mlosch	1.39	Cml sRef(K) = 35.D0
77	adcroft	1.1	ENDDO
78	adcroft	1.2	gravity = 9.81D0
79			rhoNil = 999.8D0
80	jmc	1.55	C-- jmc : the default is to set rhoConstFresh to rhoConst (=rhoNil by default)
81			C (so that the default produces same results as before)
82			c rhoConstFresh = 999.8D0
83	adcroft	1.2	f0 = 1.D-4
84			beta = 1.D-11
85	jmc	1.46	C- Always use 1 day in the past but should be 86164 (=86400*365.25/366.25)
86			rotationPeriod = 86400. _d 0
87	adcroft	1.2	viscAh = 0.D3
88	adcroft	1.58	viscAhGrid = 0.D0
89			viscAhMax = 1.D21
90	adcroft	1.60	viscC2leith = 0.D0
91	adcroft	1.27	viscAstrain = 0.D3
92			viscAtension = 0.D3
93	adcroft	1.2	diffKhT = 0.D3
94			diffKhS = 0.D3
95			viscArDefault = 0.D-3
96			no_slip_sides = .TRUE.
97			no_slip_bottom = .TRUE.
98			diffKrTDefault = 0.D-3
99			diffKrSDefault = 0.D-3
100	adcroft	1.62	diffKrBL79surf = 0.D0
101			diffKrBL79deep = 0.D0
102			diffKrBL79scl = 200.D0
103			diffKrBL79Ho = -2000.D0
104	adcroft	1.2	viscA4 = 0.D11
105	adcroft	1.58	viscA4Grid = 0.D0
106			viscA4Max = 1.D21
107	adcroft	1.60	viscC4leith = 0.D0
108	adcroft	1.2	diffK4T = 0.D11
109			diffK4S = 0.D11
110	adcroft	1.4	cosPower = 0.
111	adcroft	1.2	HeatCapacity_Cp = 3994.D0
112	mlosch	1.37	Cml tAlpha = 2.D-4
113			Cml sBeta = 7.4D-4
114	adcroft	1.2	eosType = 'LINEAR'
115	adcroft	1.1	buoyancyRelation = 'OCEANIC'
116			hFacMin = 1.D0
117			hFacMinDrDefault = 0.D0
118	adcroft	1.12	staggerTimeStep = .FALSE.
119	adcroft	1.1	momViscosity = .TRUE.
120			momAdvection = .TRUE.
121			momForcing = .TRUE.
122			useCoriolis = .TRUE.
123			momPressureForcing = .TRUE.
124			momStepping = .TRUE.
125	adcroft	1.25	vectorInvariantMomentum = .FALSE.
126	adcroft	1.1	tempStepping = .TRUE.
127	jmc	1.35	tempAdvection = .TRUE.
128			tempForcing = .TRUE.
129	adcroft	1.1	saltStepping = .TRUE.
130	jmc	1.35	saltAdvection = .TRUE.
131			saltForcing = .TRUE.
132	jmc	1.16	metricTerms = .TRUE.
133	jmc	1.53	useNHMTerms = .FALSE.
134	adcroft	1.1	implicitDiffusion = .FALSE.
135	adcroft	1.5	implicitViscosity = .FALSE.
136	jmc	1.57	momImplVertAdv = .FALSE.
137			tempImplVertAdv = .FALSE.
138			saltImplVertAdv = .FALSE.
139	adcroft	1.2	nonHydrostatic = .FALSE.
140	adcroft	1.42	quasiHydrostatic = .FALSE.
141	adcroft	1.3	globalFiles = .FALSE.
142	dimitri	1.45	useSingleCpuIO = .FALSE.
143	adcroft	1.3	allowFreezing = .FALSE.
144	jmc	1.54	useOldFreezing = .FALSE.
145	adcroft	1.6	ivdc_kappa = 0.D0
146	adcroft	1.12	groundAtK1 = .FALSE.
147			bottomDragLinear = 0.
148			bottomDragQuadratic = 0.
149	heimbach	1.23	usePickupBeforeC35 = .FALSE.
150	jmc	1.65	usePickupBeforeC54 = .FALSE.
151	heimbach	1.23	debugMode = .FALSE.
152			readPickupWithTracer = .FALSE.
153			writePickupWithTracer = .FALSE.
154	adcroft	1.24	tempAdvScheme = 2
155			saltAdvScheme = 2
156			tracerAdvScheme = 2
157	adcroft	1.28	multiDimAdvection = .TRUE.
158	jmc	1.47	useCDscheme = .FALSE.
159	adcroft	1.30	useEnergyConservingCoriolis = .FALSE.
160	adcroft	1.31	useJamartWetPoints = .FALSE.
161	adcroft	1.63	useJamartMomAdv = .FALSE.
162	adcroft	1.61	SadournyCoriolis = .FALSE.
163			upwindVorticity = .FALSE.
164			highOrderVorticity = .FALSE.
165			useAbsVorticity = .FALSE.
166	heimbach	1.50	debugLevel = debLevA
167	jmc	1.33
168			C-- Set (free)surface-related parameters
169			implicitFreeSurface = .TRUE.
170			rigidLid = .FALSE.
171			implicSurfPress = 1.D0
172			implicDiv2DFlow = 1.D0
173			exactConserv = .FALSE.
174			uniformLin_PhiSurf = .TRUE.
175			nonlinFreeSurf = 0
176	jmc	1.46	hFacInf = 0.2 _d 0
177			hFacSup = 2.0 _d 0
178	jmc	1.44	select_rStar = 0
179	jmc	1.33	useRealFreshWaterFlux = .FALSE.
180			temp_EvPrRn = UNSET_RL
181			salt_EvPrRn = 0.
182			trac_EvPrRn = UNSET_RL
183	adcroft	1.1
184	jmc	1.22	C-- Atmospheric physical parameters (e.g.: EOS)
185	jmc	1.49	celsius2K = 273.16 _d 0
186			atm_Po = 1. _d 5
187			atm_Cp = 1004. _d 0
188			atm_Rd = UNSET_RL
189			atm_kappa = 2. _d 0 / 7. _d 0
190	jmc	1.51	atm_Rq = 0. _d 0
191	jmc	1.43	integr_GeoPot = 2
192			selectFindRoSurf = 0
193	jmc	1.22
194	adcroft	1.1	C-- Elliptic solver parameters
195			cg2dMaxIters = 150
196			cg2dTargetResidual = 1.D-7
197	adcroft	1.19	cg2dTargetResWunit = -1.
198	adcroft	1.1	cg2dChkResFreq = 1
199	adcroft	1.2	cg2dpcOffDFac = 0.51D0
200	jmc	1.66	cg2dPreCondFreq = 1
201	adcroft	1.1	cg3dMaxIters = 150
202			cg3dTargetResidual = 1.D-7
203			cg3dChkResFreq = 1
204
205			C-- Time stepping parameters
206			deltaT = 0.
207			nIter0 = 0
208			startTime = deltaT*float(nIter0)
209	adcroft	1.48	pickupSuff = ' '
210	adcroft	1.2	nTimeSteps = 0
211	adcroft	1.6	nEndIter = nIter0+nTimeSteps
212			endTime = deltaT*float(nEndIter)
213	jmc	1.35	forcing_In_AB = .TRUE.
214	adcroft	1.1	abEps = 0.01
215			pchkPtFreq = deltaT*0
216			chkPtFreq = deltaT*0
217	edhill	1.70	pickup_read_mdsio = .TRUE.
218			pickup_write_mdsio= .TRUE.
219			pickup_write_immed= .FALSE.
220	edhill	1.73	pickup_write_ioinc= .FALSE.
221	adcroft	1.2	dumpFreq = deltaT*0
222	heimbach	1.59	adjDumpFreq = deltaT*0
223	adcroft	1.26	diagFreq = deltaT*0
224	edhill	1.70	snapshot_mdsio = .TRUE.
225	edhill	1.73	snapshot_ioinc = .FALSE.
226	adcroft	1.20	monitorFreq = -1.
227	edhill	1.71	monitor_stdio = .TRUE.
228	edhill	1.73	monitor_ioinc = .FALSE.
229	adcroft	1.1	taveFreq = deltaT*0
230	edhill	1.70	timeave_mdsio = .TRUE.
231	edhill	1.73	timeave_ioinc = .FALSE.
232	jmc	1.40	tave_lastIter = 0.5 _d 0
233	adcroft	1.1	writeStatePrec = precFloat64
234			writeBinaryPrec = precFloat32
235			readBinaryPrec = precFloat32
236			nCheckLev = 1
237			checkPtSuff(1) = 'ckptA'
238			checkPtSuff(2) = 'ckptB'
239	adcroft	1.6	cAdjFreq = 0.D0
240	adcroft	1.1	tauCD = 0.D0
241			tauThetaClimRelax = 0.D0
242			tauSaltClimRelax = 0.D0
243	heimbach	1.23	tauTr1ClimRelax = 0.D0
244	adcroft	1.1	periodicExternalForcing = .FALSE.
245			externForcingPeriod = 0.
246			externForcingCycle = 0.
247	afe	1.64	tCyl = 0.
248
249	adcroft	1.1	C-- Input files
250			bathyFile = ' '
251	jmc	1.22	topoFile = ' '
252	adcroft	1.1	hydrogSaltFile = ' '
253			hydrogThetaFile = ' '
254			zonalWindFile = ' '
255			meridWindFile = ' '
256			thetaClimFile = ' '
257			saltClimFile = ' '
258	adcroft	1.2	EmPmRfile = ' '
259			surfQfile = ' '
260	jmc	1.67	surfQnetFile = ' '
261			surfQswFile = ' '
262	adcroft	1.7	uVelInitFile = ' '
263			vVelInitFile = ' '
264	adcroft	1.9	pSurfInitFile = ' '
265	heimbach	1.17	dQdTFile = ' '
266	mlosch	1.36	ploadFile = ' '
267	heimbach	1.50	mdsioLocalDir = ' '
268	adcroft	1.1
269			C
270			RETURN
271			END