OpenAD/code_shallow_openad/set_defaults.F

C $Header: /u/gcmpack/MITgcm_contrib/heimbach/OpenAD/code_shallow_openad/set_defaults.F,v 1.4 2007/01/08 21:40:40 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"
c#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
      delRFile            = ' '
      delRcFile           = ' '
      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-    vertical profile
      tRefFile            = ' '
      sRefFile            = ' '
      rhoRefFile          = ' '

C-    Horizontal gridding
      delXFile            = ' '
      delYFile            = ' '
      horizGridFile       = ' '
      deepAtmosphere      = .FALSE.
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          = .TRUE.
      use3dCoriolis       = .TRUE.

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.
      smoothAbsFuncRange  = 0. _d 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.
      linFSConserveTr     = .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.

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   = ' '
      the_run_name    = ' '

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