model/src/set_defaults.F

C $Header: /u/gcmpack/MITgcm/model/src/set_defaults.F,v 1.37 2002/08/07 16:55:52 mlosch 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 )
      ENDDO
      gravitySign         = 1.D0
      gravity             = 9.81D0
      rhoNil              = 999.8D0
      f0                  = 1.D-4
      beta                = 1.D-11
      omega               = 2.D0 * PI / ( 3600.D0 * 24.D0 )
      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.
      implicitDiffusion   = .FALSE.
      implicitViscosity   = .FALSE.
      nonHydrostatic      = .FALSE.
      globalFiles         = .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.
      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             = 1.D0
      hFacSup             = 1.D0
      useRealFreshWaterFlux = .FALSE.
      temp_EvPrRn = UNSET_RL
      salt_EvPrRn = 0.
      trac_EvPrRn = UNSET_RL

C--   Atmospheric physical parameters (e.g.: EOS)
      atm_po =  1.D5
      atm_cp =  1004.D0
      atm_kappa = 2.D0 / 7.D0
      Integr_GeoPot = 2

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)
      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
      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.37 2002/08/07 16:55:52 mlosch 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	ENDDO
87	gravitySign = 1.D0
88	gravity = 9.81D0
89	rhoNil = 999.8D0
90	f0 = 1.D-4
91	beta = 1.D-11
92	omega = 2.D0 * PI / ( 3600.D0 * 24.D0 )
93	viscAh = 0.D3
94	viscAstrain = 0.D3
95	viscAtension = 0.D3
96	diffKhT = 0.D3
97	diffKhS = 0.D3
98	viscArDefault = 0.D-3
99	no_slip_sides = .TRUE.
100	no_slip_bottom = .TRUE.
101	diffKrTDefault = 0.D-3
102	diffKrSDefault = 0.D-3
103	viscA4 = 0.D11
104	diffK4T = 0.D11
105	diffK4S = 0.D11
106	cosPower = 0.
107	HeatCapacity_Cp = 3994.D0
108	Cml tAlpha = 2.D-4
109	Cml sBeta = 7.4D-4
110	eosType = 'LINEAR'
111	buoyancyRelation = 'OCEANIC'
112	hFacMin = 1.D0
113	hFacMinDrDefault = 0.D0
114	staggerTimeStep = .FALSE.
115	momViscosity = .TRUE.
116	momAdvection = .TRUE.
117	momForcing = .TRUE.
118	useCoriolis = .TRUE.
119	momPressureForcing = .TRUE.
120	momStepping = .TRUE.
121	vectorInvariantMomentum = .FALSE.
122	tempStepping = .TRUE.
123	tempAdvection = .TRUE.
124	tempForcing = .TRUE.
125	saltStepping = .TRUE.
126	saltAdvection = .TRUE.
127	saltForcing = .TRUE.
128	tr1Stepping = .FALSE.
129	metricTerms = .TRUE.
130	implicitDiffusion = .FALSE.
131	implicitViscosity = .FALSE.
132	nonHydrostatic = .FALSE.
133	globalFiles = .FALSE.
134	allowFreezing = .FALSE.
135	ivdc_kappa = 0.D0
136	groundAtK1 = .FALSE.
137	bottomDragLinear = 0.
138	bottomDragQuadratic = 0.
139	usePickupBeforeC35 = .FALSE.
140	debugMode = .FALSE.
141	readPickupWithTracer = .FALSE.
142	writePickupWithTracer = .FALSE.
143	tempAdvScheme = 2
144	saltAdvScheme = 2
145	tracerAdvScheme = 2
146	multiDimAdvection = .TRUE.
147	useEnergyConservingCoriolis = .FALSE.
148	useJamartWetPoints = .FALSE.
149
150	C-- Set (free)surface-related parameters
151	implicitFreeSurface = .TRUE.
152	rigidLid = .FALSE.
153	implicSurfPress = 1.D0
154	implicDiv2DFlow = 1.D0
155	exactConserv = .FALSE.
156	uniformLin_PhiSurf = .TRUE.
157	nonlinFreeSurf = 0
158	hFacInf = 1.D0
159	hFacSup = 1.D0
160	useRealFreshWaterFlux = .FALSE.
161	temp_EvPrRn = UNSET_RL
162	salt_EvPrRn = 0.
163	trac_EvPrRn = UNSET_RL
164
165	C-- Atmospheric physical parameters (e.g.: EOS)
166	atm_po = 1.D5
167	atm_cp = 1004.D0
168	atm_kappa = 2.D0 / 7.D0
169	Integr_GeoPot = 2
170
171	C-- Elliptic solver parameters
172	cg2dMaxIters = 150
173	cg2dTargetResidual = 1.D-7
174	cg2dTargetResWunit = -1.
175	cg2dChkResFreq = 1
176	cg2dpcOffDFac = 0.51D0
177	cg3dMaxIters = 150
178	cg3dTargetResidual = 1.D-7
179	cg3dChkResFreq = 1
180
181	C-- Time stepping parameters
182	deltaT = 0.
183	nIter0 = 0
184	startTime = deltaT*float(nIter0)
185	nTimeSteps = 0
186	nEndIter = nIter0+nTimeSteps
187	endTime = deltaT*float(nEndIter)
188	forcing_In_AB = .TRUE.
189	abEps = 0.01
190	pchkPtFreq = deltaT*0
191	chkPtFreq = deltaT*0
192	dumpFreq = deltaT*0
193	diagFreq = deltaT*0
194	monitorFreq = -1.
195	taveFreq = deltaT*0
196	writeStatePrec = precFloat64
197	writeBinaryPrec = precFloat32
198	readBinaryPrec = precFloat32
199	nCheckLev = 1
200	checkPtSuff(1) = 'ckptA'
201	checkPtSuff(2) = 'ckptB'
202	cAdjFreq = 0.D0
203	tauCD = 0.D0
204	tauThetaClimRelax = 0.D0
205	tauSaltClimRelax = 0.D0
206	tauTr1ClimRelax = 0.D0
207	periodicExternalForcing = .FALSE.
208	externForcingPeriod = 0.
209	externForcingCycle = 0.
210
211	C-- Input files
212	bathyFile = ' '
213	topoFile = ' '
214	hydrogSaltFile = ' '
215	hydrogThetaFile = ' '
216	zonalWindFile = ' '
217	meridWindFile = ' '
218	thetaClimFile = ' '
219	saltClimFile = ' '
220	EmPmRfile = ' '
221	surfQfile = ' '
222	surfQswfile = ' '
223	uVelInitFile = ' '
224	vVelInitFile = ' '
225	pSurfInitFile = ' '
226	dQdTFile = ' '
227	ploadFile = ' '
228
229	C
230	RETURN
231	END
232