model/src/set_defaults.F

C $Header: /u/gcmpack/MITgcm/model/src/set_defaults.F,v 1.75 2004/11/02 23:57:29 dimitri 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
      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.
      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.
      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	C $Header: /u/gcmpack/MITgcm/model/src/set_defaults.F,v 1.75 2004/11/02 23:57:29 dimitri Exp $
2	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.D0
44	horiVertRatio = 1.D0
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	C In cartesian coords distances are in metres
55	usingCartesianGrid = .FALSE.
56	DO i=1,Nx
57	delX(i) = UNSET_RL
58	ENDDO
59	DO j=1,Ny
60	delY(j) = UNSET_RL
61	ENDDO
62	C In spherical polar distances are in degrees
63	usingSphericalPolarGrid = .FALSE.
64	phiMin = 0.0
65	thetaMin = 0.
66	rSphere = 6370. * 1.D3
67	C General curvilinear coordinate system
68	usingCurvilinearGrid = .FALSE.
69	C General cylindrical coordinate system
70	usingCylindricalGrid = .FALSE.
71
72
73	C-- Set default "physical" parameters
74	DO K =1,Nr
75	tRef(K) = 30.D0 - FLOAT( K )
76	Cml sRef(K) = 35.D0
77	ENDDO
78	gravity = 9.81D0
79	rhoNil = 999.8D0
80	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	f0 = 1.D-4
84	beta = 1.D-11
85	C- Always use 1 day in the past but should be 86164 (=86400*365.25/366.25)
86	rotationPeriod = 86400. _d 0
87	viscAh = 0.D3
88	viscAhGrid = 0.D0
89	viscAhMax = 1.D21
90	viscC2leith = 0.D0
91	viscAstrain = 0.D3
92	viscAtension = 0.D3
93	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	diffKrBL79surf = 0.D0
101	diffKrBL79deep = 0.D0
102	diffKrBL79scl = 200.D0
103	diffKrBL79Ho = -2000.D0
104	viscA4 = 0.D11
105	viscA4Grid = 0.D0
106	viscA4GridMax = 0.D0
107	viscA4GridMin = 0.D0
108	viscA4Max = 1.D21
109	viscC4leith = 0.D0
110	diffK4T = 0.D11
111	diffK4S = 0.D11
112	cosPower = 0.
113	HeatCapacity_Cp = 3994.D0
114	Cml tAlpha = 2.D-4
115	Cml sBeta = 7.4D-4
116	eosType = 'LINEAR'
117	buoyancyRelation = 'OCEANIC'
118	hFacMin = 1.D0
119	hFacMinDrDefault = 0.D0
120	staggerTimeStep = .FALSE.
121	momViscosity = .TRUE.
122	momAdvection = .TRUE.
123	momForcing = .TRUE.
124	useCoriolis = .TRUE.
125	momPressureForcing = .TRUE.
126	momStepping = .TRUE.
127	vectorInvariantMomentum = .FALSE.
128	tempStepping = .TRUE.
129	tempAdvection = .TRUE.
130	tempForcing = .TRUE.
131	saltStepping = .TRUE.
132	saltAdvection = .TRUE.
133	saltForcing = .TRUE.
134	metricTerms = .TRUE.
135	useNHMTerms = .FALSE.
136	implicitDiffusion = .FALSE.
137	implicitViscosity = .FALSE.
138	momImplVertAdv = .FALSE.
139	tempImplVertAdv = .FALSE.
140	saltImplVertAdv = .FALSE.
141	nonHydrostatic = .FALSE.
142	quasiHydrostatic = .FALSE.
143	globalFiles = .FALSE.
144	useSingleCpuIO = .FALSE.
145	allowFreezing = .FALSE.
146	useOldFreezing = .FALSE.
147	ivdc_kappa = 0.D0
148	groundAtK1 = .FALSE.
149	bottomDragLinear = 0.
150	bottomDragQuadratic = 0.
151	usePickupBeforeC35 = .FALSE.
152	usePickupBeforeC54 = .FALSE.
153	debugMode = .FALSE.
154	readPickupWithTracer = .FALSE.
155	writePickupWithTracer = .FALSE.
156	tempAdvScheme = 2
157	saltAdvScheme = 2
158	multiDimAdvection = .TRUE.
159	useCDscheme = .FALSE.
160	useEnergyConservingCoriolis = .FALSE.
161	useJamartWetPoints = .FALSE.
162	useJamartMomAdv = .FALSE.
163	SadournyCoriolis = .FALSE.
164	upwindVorticity = .FALSE.
165	highOrderVorticity = .FALSE.
166	useAbsVorticity = .FALSE.
167	debugLevel = debLevA
168
169	C-- Set (free)surface-related parameters
170	implicitFreeSurface = .TRUE.
171	rigidLid = .FALSE.
172	implicSurfPress = 1.D0
173	implicDiv2DFlow = 1.D0
174	exactConserv = .FALSE.
175	uniformLin_PhiSurf = .TRUE.
176	nonlinFreeSurf = 0
177	hFacInf = 0.2 _d 0
178	hFacSup = 2.0 _d 0
179	select_rStar = 0
180	useRealFreshWaterFlux = .FALSE.
181	temp_EvPrRn = UNSET_RL
182	salt_EvPrRn = 0.
183
184	C-- Atmospheric physical parameters (e.g.: EOS)
185	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	atm_Rq = 0. _d 0
191	integr_GeoPot = 2
192	selectFindRoSurf = 0
193
194	C-- Elliptic solver parameters
195	cg2dMaxIters = 150
196	cg2dTargetResidual = 1.D-7
197	cg2dTargetResWunit = -1.
198	cg2dChkResFreq = 1
199	cg2dpcOffDFac = 0.51D0
200	cg2dPreCondFreq = 1
201	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	pickupSuff = ' '
210	nTimeSteps = 0
211	nEndIter = nIter0+nTimeSteps
212	endTime = deltaT*float(nEndIter)
213	forcing_In_AB = .TRUE.
214	abEps = 0.01
215	pchkPtFreq = deltaT*0
216	chkPtFreq = deltaT*0
217	outputTypesInclusive = .FALSE.
218	pickup_read_mdsio = .TRUE.
219	pickup_write_mdsio= .TRUE.
220	pickup_write_immed= .FALSE.
221	dumpFreq = deltaT*0
222	adjDumpFreq = deltaT*0
223	diagFreq = deltaT*0
224	snapshot_mdsio = .TRUE.
225	monitorFreq = -1.
226	monitor_stdio = .TRUE.
227	taveFreq = deltaT*0
228	timeave_mdsio = .TRUE.
229	tave_lastIter = 0.5 _d 0
230	writeStatePrec = precFloat64
231	writeBinaryPrec = precFloat32
232	readBinaryPrec = precFloat32
233	nCheckLev = 1
234	checkPtSuff(1) = 'ckptA'
235	checkPtSuff(2) = 'ckptB'
236	cAdjFreq = 0.D0
237	tauCD = 0.D0
238	tauThetaClimRelax = 0.D0
239	tauSaltClimRelax = 0.D0
240	tauTr1ClimRelax = 0.D0
241	periodicExternalForcing = .FALSE.
242	externForcingPeriod = 0.
243	externForcingCycle = 0.
244	tCyl = 0.
245
246	C-- Input files
247	bathyFile = ' '
248	topoFile = ' '
249	hydrogSaltFile = ' '
250	hydrogThetaFile = ' '
251	zonalWindFile = ' '
252	meridWindFile = ' '
253	thetaClimFile = ' '
254	saltClimFile = ' '
255	EmPmRfile = ' '
256	surfQfile = ' '
257	surfQnetFile = ' '
258	surfQswFile = ' '
259	uVelInitFile = ' '
260	vVelInitFile = ' '
261	pSurfInitFile = ' '
262	dQdTFile = ' '
263	ploadFile = ' '
264	mdsioLocalDir = ' '
265
266	C
267	RETURN
268	END