model/src/set_defaults.F

C $Header: /u/gcmpack/MITgcm/model/src/set_defaults.F,v 1.48 2003/06/05 16:03:05 adcroft Exp $
C $Name:  $

#include "CPP_OPTIONS.h"

CBOP
C     !ROUTINE: SET_DEFAULTS
C     !INTERFACE:
      SUBROUTINE SET_DEFAULTS(
     O   viscArDefault, diffKrTDefault, diffKrSDefault,
     O   hFacMinDrDefault, delRdefault, rkFacDefault,
     I   myThid )

C     !DESCRIPTION: \bv
C     *==========================================================*
C     | SUBROUTINE SET_DEFAULTS                                   
C     | o Routine to set model "parameters"                       
C     *==========================================================*
C     | Notes:                                                    
C     | ======                                                    
C     | The present version of this routine is a place-holder.    
C     | A production version needs to handle parameters from an   
C     | external file and possibly reading in some initial field  
C     | values.                                                   
C     *==========================================================*
C     \ev

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

C     !INPUT/OUTPUT PARAMETERS:
C     === Routine arguments ===
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     === 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 = .TRUE.
      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--   Set default "physical" parameters
      DO K =1,Nr
       tRef(K) = 30.D0 - FLOAT( K )
Cml       sRef(K) = 35.D0
      ENDDO
      gravitySign         = 1.D0
      gravity             = 9.81D0
      rhoNil              = 999.8D0
      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
      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
      viscA4              = 0.D11
      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.
      tr1Stepping         = .FALSE.
      metricTerms         = .TRUE.
      useNHMTerms         = .TRUE.
      implicitDiffusion   = .FALSE.
      implicitViscosity   = .FALSE.
      nonHydrostatic      = .FALSE.
      quasiHydrostatic    = .FALSE.
      globalFiles         = .FALSE.
      useSingleCpuIO      = .FALSE.
      allowFreezing       = .FALSE.
      ivdc_kappa          = 0.D0
      groundAtK1          = .FALSE.
      bottomDragLinear    = 0.
      bottomDragQuadratic = 0.
      usePickupBeforeC35    = .FALSE.
      debugMode             = .FALSE.
      readPickupWithTracer  = .FALSE.
      writePickupWithTracer = .FALSE.
      tempAdvScheme       = 2
      saltAdvScheme       = 2
      tracerAdvScheme     = 2
      multiDimAdvection   = .TRUE.
      useCDscheme         = .FALSE.
      useEnergyConservingCoriolis = .FALSE.
      useJamartWetPoints  = .FALSE.

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
      integr_GeoPot = 2
      selectFindRoSurf = 0

C--   Elliptic solver parameters
      cg2dMaxIters       = 150
      cg2dTargetResidual = 1.D-7
      cg2dTargetResWunit = -1.
      cg2dChkResFreq     = 1
      cg2dpcOffDFac      = 0.51D0
      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
      dumpFreq          = deltaT*0
      diagFreq          = deltaT*0
      monitorFreq       = -1.
      taveFreq          = deltaT*0
      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.

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

C
      RETURN
      END
1	C $Header: /u/gcmpack/MITgcm/model/src/set_defaults.F,v 1.48 2003/06/05 16:03:05 adcroft Exp $
2	C $Name: $
3
4	#include "CPP_OPTIONS.h"
5
6	CBOP
7	C !ROUTINE: SET_DEFAULTS
8	C !INTERFACE:
9	SUBROUTINE SET_DEFAULTS(
10	O viscArDefault, diffKrTDefault, diffKrSDefault,
11	O hFacMinDrDefault, delRdefault, rkFacDefault,
12	I myThid )
13
14	C !DESCRIPTION: \bv
15	C ==========================================================
16	C \| SUBROUTINE SET_DEFAULTS
17	C \| o Routine to set model "parameters"
18	C ==========================================================
19	C \| Notes:
20	C \| ======
21	C \| The present version of this routine is a place-holder.
22	C \| A production version needs to handle parameters from an
23	C \| external file and possibly reading in some initial field
24	C \| values.
25	C ==========================================================
26	C \ev
27
28	C !USES:
29	IMPLICIT NONE
30	C === Global variables ===
31	#include "SIZE.h"
32	#include "EEPARAMS.h"
33	#include "PARAMS.h"
34	Cml#include "EOS.h"
35	#include "GRID.h"
36
37	C !INPUT/OUTPUT PARAMETERS:
38	C === Routine arguments ===
39	C myThid - Number of this instance of INI_PARMS
40	INTEGER myThid
41	_RL viscArDefault
42	_RL diffKrTDefault
43	_RL diffKrSDefault
44	_RL hFacMinDrDefault
45	_RL delRDefault(Nr)
46	_RS rkFacDefault
47
48	C !LOCAL VARIABLES:
49	C === Local variables ===
50	C K, I, J - Loop counters
51	INTEGER K, I, J
52	CEOP
53
54	C-- Grid parameters
55	C Vertical gridding
56	rkFacDefault = 1.D0
57	horiVertRatio = 1.D0
58	Ro_SeaLevel = 0.
59	DO k=1,Nr
60	delRdefault(k) = 0.
61	ENDDO
62	DO k=1,Nr+1
63	delRc(k) = UNSET_RL
64	ENDDO
65
66	C Horizontal gridding
67	C In cartesian coords distances are in metres
68	usingCartesianGrid = .TRUE.
69	DO i=1,Nx
70	delX(i) = UNSET_RL
71	ENDDO
72	DO j=1,Ny
73	delY(j) = UNSET_RL
74	ENDDO
75	C In spherical polar distances are in degrees
76	usingSphericalPolarGrid = .FALSE.
77	phiMin = 0.0
78	thetaMin = 0.
79	rSphere = 6370. * 1.D3
80	C General curvilinear coordinate system
81	usingCurvilinearGrid = .FALSE.
82
83	C-- Set default "physical" parameters
84	DO K =1,Nr
85	tRef(K) = 30.D0 - FLOAT( K )
86	Cml sRef(K) = 35.D0
87	ENDDO
88	gravitySign = 1.D0
89	gravity = 9.81D0
90	rhoNil = 999.8D0
91	rhoConstFresh = 999.8D0
92	f0 = 1.D-4
93	beta = 1.D-11
94	C- Always use 1 day in the past but should be 86164 (=86400*365.25/366.25)
95	rotationPeriod = 86400. _d 0
96	viscAh = 0.D3
97	viscAstrain = 0.D3
98	viscAtension = 0.D3
99	diffKhT = 0.D3
100	diffKhS = 0.D3
101	viscArDefault = 0.D-3
102	no_slip_sides = .TRUE.
103	no_slip_bottom = .TRUE.
104	diffKrTDefault = 0.D-3
105	diffKrSDefault = 0.D-3
106	viscA4 = 0.D11
107	diffK4T = 0.D11
108	diffK4S = 0.D11
109	cosPower = 0.
110	HeatCapacity_Cp = 3994.D0
111	Cml tAlpha = 2.D-4
112	Cml sBeta = 7.4D-4
113	eosType = 'LINEAR'
114	buoyancyRelation = 'OCEANIC'
115	hFacMin = 1.D0
116	hFacMinDrDefault = 0.D0
117	staggerTimeStep = .FALSE.
118	momViscosity = .TRUE.
119	momAdvection = .TRUE.
120	momForcing = .TRUE.
121	useCoriolis = .TRUE.
122	momPressureForcing = .TRUE.
123	momStepping = .TRUE.
124	vectorInvariantMomentum = .FALSE.
125	tempStepping = .TRUE.
126	tempAdvection = .TRUE.
127	tempForcing = .TRUE.
128	saltStepping = .TRUE.
129	saltAdvection = .TRUE.
130	saltForcing = .TRUE.
131	tr1Stepping = .FALSE.
132	metricTerms = .TRUE.
133	useNHMTerms = .TRUE.
134	implicitDiffusion = .FALSE.
135	implicitViscosity = .FALSE.
136	nonHydrostatic = .FALSE.
137	quasiHydrostatic = .FALSE.
138	globalFiles = .FALSE.
139	useSingleCpuIO = .FALSE.
140	allowFreezing = .FALSE.
141	ivdc_kappa = 0.D0
142	groundAtK1 = .FALSE.
143	bottomDragLinear = 0.
144	bottomDragQuadratic = 0.
145	usePickupBeforeC35 = .FALSE.
146	debugMode = .FALSE.
147	readPickupWithTracer = .FALSE.
148	writePickupWithTracer = .FALSE.
149	tempAdvScheme = 2
150	saltAdvScheme = 2
151	tracerAdvScheme = 2
152	multiDimAdvection = .TRUE.
153	useCDscheme = .FALSE.
154	useEnergyConservingCoriolis = .FALSE.
155	useJamartWetPoints = .FALSE.
156
157	C-- Set (free)surface-related parameters
158	implicitFreeSurface = .TRUE.
159	rigidLid = .FALSE.
160	implicSurfPress = 1.D0
161	implicDiv2DFlow = 1.D0
162	exactConserv = .FALSE.
163	uniformLin_PhiSurf = .TRUE.
164	nonlinFreeSurf = 0
165	hFacInf = 0.2 _d 0
166	hFacSup = 2.0 _d 0
167	select_rStar = 0
168	useRealFreshWaterFlux = .FALSE.
169	temp_EvPrRn = UNSET_RL
170	salt_EvPrRn = 0.
171	trac_EvPrRn = UNSET_RL
172
173	C-- Atmospheric physical parameters (e.g.: EOS)
174	celsius2K = 273.16 _d 0
175	atm_Po = 1. _d 5
176	atm_Cp = 1004. _d 0
177	atm_Rd = UNSET_RL
178	atm_kappa = 2. _d 0 / 7. _d 0
179	integr_GeoPot = 2
180	selectFindRoSurf = 0
181
182	C-- Elliptic solver parameters
183	cg2dMaxIters = 150
184	cg2dTargetResidual = 1.D-7
185	cg2dTargetResWunit = -1.
186	cg2dChkResFreq = 1
187	cg2dpcOffDFac = 0.51D0
188	cg3dMaxIters = 150
189	cg3dTargetResidual = 1.D-7
190	cg3dChkResFreq = 1
191
192	C-- Time stepping parameters
193	deltaT = 0.
194	nIter0 = 0
195	startTime = deltaT*float(nIter0)
196	pickupSuff = ' '
197	nTimeSteps = 0
198	nEndIter = nIter0+nTimeSteps
199	endTime = deltaT*float(nEndIter)
200	forcing_In_AB = .TRUE.
201	abEps = 0.01
202	pchkPtFreq = deltaT*0
203	chkPtFreq = deltaT*0
204	dumpFreq = deltaT*0
205	diagFreq = deltaT*0
206	monitorFreq = -1.
207	taveFreq = deltaT*0
208	tave_lastIter = 0.5 _d 0
209	writeStatePrec = precFloat64
210	writeBinaryPrec = precFloat32
211	readBinaryPrec = precFloat32
212	nCheckLev = 1
213	checkPtSuff(1) = 'ckptA'
214	checkPtSuff(2) = 'ckptB'
215	cAdjFreq = 0.D0
216	tauCD = 0.D0
217	tauThetaClimRelax = 0.D0
218	tauSaltClimRelax = 0.D0
219	tauTr1ClimRelax = 0.D0
220	periodicExternalForcing = .FALSE.
221	externForcingPeriod = 0.
222	externForcingCycle = 0.
223
224	C-- Input files
225	bathyFile = ' '
226	topoFile = ' '
227	hydrogSaltFile = ' '
228	hydrogThetaFile = ' '
229	zonalWindFile = ' '
230	meridWindFile = ' '
231	thetaClimFile = ' '
232	saltClimFile = ' '
233	EmPmRfile = ' '
234	surfQfile = ' '
235	surfQswfile = ' '
236	uVelInitFile = ' '
237	vVelInitFile = ' '
238	pSurfInitFile = ' '
239	dQdTFile = ' '
240	ploadFile = ' '
241
242	C
243	RETURN
244	END