model/src/set_defaults.F

C $Header: /u/gcmpack/MITgcm/model/src/set_defaults.F,v 1.34 2002/03/07 14:09:02 jmc 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"
#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
      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
      tAlpha              = 2.D-4
      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        = ' '

C
      RETURN
      END

1	jmc	1.35	C $Header: /u/gcmpack/MITgcm/model/src/set_defaults.F,v 1.34 2002/03/07 14:09:02 jmc Exp $
2	heimbach	1.18	C $Name: $
3	adcroft	1.1
4			#include "CPP_OPTIONS.h"
5
6	cnh	1.29	CBOP
7			C !ROUTINE: SET_DEFAULTS
8			C !INTERFACE:
9	adcroft	1.1	SUBROUTINE SET_DEFAULTS(
10			O viscArDefault, diffKrTDefault, diffKrSDefault,
11	adcroft	1.2	O hFacMinDrDefault, delRdefault, rkFacDefault,
12	adcroft	1.1	I myThid )
13	cnh	1.29
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	adcroft	1.1	IMPLICIT NONE
30			C === Global variables ===
31			#include "SIZE.h"
32			#include "EEPARAMS.h"
33			#include "PARAMS.h"
34			#include "GRID.h"
35
36	cnh	1.29	C !INPUT/OUTPUT PARAMETERS:
37	adcroft	1.1	C === Routine arguments ===
38			C myThid - Number of this instance of INI_PARMS
39			INTEGER myThid
40			_RL viscArDefault
41			_RL diffKrTDefault
42			_RL diffKrSDefault
43			_RL hFacMinDrDefault
44			_RL delRDefault(Nr)
45	adcroft	1.2	_RS rkFacDefault
46	adcroft	1.1
47	cnh	1.29	C !LOCAL VARIABLES:
48	adcroft	1.1	C === Local variables ===
49			C K, I, J - Loop counters
50			INTEGER K, I, J
51	cnh	1.29	CEOP
52	adcroft	1.1
53			C-- Grid parameters
54			C Vertical gridding
55	adcroft	1.2	rkFacDefault = 1.D0
56			horiVertRatio = 1.D0
57	adcroft	1.12	Ro_SeaLevel = 0.
58	adcroft	1.1	DO k=1,Nr
59	adcroft	1.2	delRdefault(k) = 0.
60	jmc	1.34	ENDDO
61			DO k=1,Nr+1
62			delRc(k) = UNSET_RL
63	adcroft	1.1	ENDDO
64
65			C Horizontal gridding
66			C In cartesian coords distances are in metres
67			usingCartesianGrid = .TRUE.
68			DO i=1,Nx
69	adcroft	1.8	delX(i) = UNSET_RL
70	adcroft	1.1	ENDDO
71			DO j=1,Ny
72	adcroft	1.8	delY(j) = UNSET_RL
73	adcroft	1.1	ENDDO
74			C In spherical polar distances are in degrees
75			usingSphericalPolarGrid = .FALSE.
76	adcroft	1.2	phiMin = 0.0
77			thetaMin = 0.
78			rSphere = 6370. * 1.D3
79	adcroft	1.19	C General curvilinear coordinate system
80			usingCurvilinearGrid = .FALSE.
81	adcroft	1.1
82			C-- Set default "physical" parameters
83			DO K =1,Nr
84			tRef(K) = 30.D0 - FLOAT( K )
85			ENDDO
86	adcroft	1.2	gravity = 9.81D0
87			rhoNil = 999.8D0
88			f0 = 1.D-4
89			beta = 1.D-11
90	adcroft	1.19	omega = 2.D0 * PI / ( 3600.D0 * 24.D0 )
91	adcroft	1.2	viscAh = 0.D3
92	adcroft	1.27	viscAstrain = 0.D3
93			viscAtension = 0.D3
94	adcroft	1.2	diffKhT = 0.D3
95			diffKhS = 0.D3
96			viscArDefault = 0.D-3
97			no_slip_sides = .TRUE.
98			no_slip_bottom = .TRUE.
99			diffKrTDefault = 0.D-3
100			diffKrSDefault = 0.D-3
101			viscA4 = 0.D11
102			diffK4T = 0.D11
103			diffK4S = 0.D11
104	adcroft	1.4	cosPower = 0.
105	adcroft	1.2	HeatCapacity_Cp = 3994.D0
106			tAlpha = 2.D-4
107			sBeta = 7.4D-4
108			eosType = 'LINEAR'
109	adcroft	1.1	buoyancyRelation = 'OCEANIC'
110			hFacMin = 1.D0
111			hFacMinDrDefault = 0.D0
112	adcroft	1.12	staggerTimeStep = .FALSE.
113	adcroft	1.1	momViscosity = .TRUE.
114			momAdvection = .TRUE.
115			momForcing = .TRUE.
116			useCoriolis = .TRUE.
117			momPressureForcing = .TRUE.
118			momStepping = .TRUE.
119	adcroft	1.25	vectorInvariantMomentum = .FALSE.
120	adcroft	1.1	tempStepping = .TRUE.
121	jmc	1.35	tempAdvection = .TRUE.
122			tempForcing = .TRUE.
123	adcroft	1.1	saltStepping = .TRUE.
124	jmc	1.35	saltAdvection = .TRUE.
125			saltForcing = .TRUE.
126	heimbach	1.23	tr1Stepping = .FALSE.
127	jmc	1.16	metricTerms = .TRUE.
128	adcroft	1.1	implicitDiffusion = .FALSE.
129	adcroft	1.5	implicitViscosity = .FALSE.
130	adcroft	1.2	nonHydrostatic = .FALSE.
131	adcroft	1.3	globalFiles = .FALSE.
132			allowFreezing = .FALSE.
133	adcroft	1.6	ivdc_kappa = 0.D0
134	adcroft	1.12	groundAtK1 = .FALSE.
135			bottomDragLinear = 0.
136			bottomDragQuadratic = 0.
137	heimbach	1.23	usePickupBeforeC35 = .FALSE.
138			debugMode = .FALSE.
139			readPickupWithTracer = .FALSE.
140			writePickupWithTracer = .FALSE.
141	adcroft	1.24	tempAdvScheme = 2
142			saltAdvScheme = 2
143			tracerAdvScheme = 2
144	adcroft	1.28	multiDimAdvection = .TRUE.
145	adcroft	1.30	useEnergyConservingCoriolis = .FALSE.
146	adcroft	1.31	useJamartWetPoints = .FALSE.
147	jmc	1.33
148			C-- Set (free)surface-related parameters
149			implicitFreeSurface = .TRUE.
150			rigidLid = .FALSE.
151			implicSurfPress = 1.D0
152			implicDiv2DFlow = 1.D0
153			exactConserv = .FALSE.
154			uniformLin_PhiSurf = .TRUE.
155			nonlinFreeSurf = 0
156			hFacInf = 1.D0
157			hFacSup = 1.D0
158			useRealFreshWaterFlux = .FALSE.
159			temp_EvPrRn = UNSET_RL
160			salt_EvPrRn = 0.
161			trac_EvPrRn = UNSET_RL
162	adcroft	1.1
163	jmc	1.22	C-- Atmospheric physical parameters (e.g.: EOS)
164			atm_po = 1.D5
165			atm_cp = 1004.D0
166			atm_kappa = 2.D0 / 7.D0
167			Integr_GeoPot = 2
168
169	adcroft	1.1	C-- Elliptic solver parameters
170			cg2dMaxIters = 150
171			cg2dTargetResidual = 1.D-7
172	adcroft	1.19	cg2dTargetResWunit = -1.
173	adcroft	1.1	cg2dChkResFreq = 1
174	adcroft	1.2	cg2dpcOffDFac = 0.51D0
175	adcroft	1.1	cg3dMaxIters = 150
176			cg3dTargetResidual = 1.D-7
177			cg3dChkResFreq = 1
178
179			C-- Time stepping parameters
180			deltaT = 0.
181			nIter0 = 0
182			startTime = deltaT*float(nIter0)
183	adcroft	1.2	nTimeSteps = 0
184	adcroft	1.6	nEndIter = nIter0+nTimeSteps
185			endTime = deltaT*float(nEndIter)
186	jmc	1.35	forcing_In_AB = .TRUE.
187	adcroft	1.1	abEps = 0.01
188			pchkPtFreq = deltaT*0
189			chkPtFreq = deltaT*0
190	adcroft	1.2	dumpFreq = deltaT*0
191	adcroft	1.26	diagFreq = deltaT*0
192	adcroft	1.20	monitorFreq = -1.
193	adcroft	1.1	taveFreq = deltaT*0
194			writeStatePrec = precFloat64
195			writeBinaryPrec = precFloat32
196			readBinaryPrec = precFloat32
197			nCheckLev = 1
198			checkPtSuff(1) = 'ckptA'
199			checkPtSuff(2) = 'ckptB'
200	adcroft	1.6	cAdjFreq = 0.D0
201	adcroft	1.1	tauCD = 0.D0
202			tauThetaClimRelax = 0.D0
203			tauSaltClimRelax = 0.D0
204	heimbach	1.23	tauTr1ClimRelax = 0.D0
205	adcroft	1.1	periodicExternalForcing = .FALSE.
206			externForcingPeriod = 0.
207			externForcingCycle = 0.
208
209			C-- Input files
210			bathyFile = ' '
211	jmc	1.22	topoFile = ' '
212	adcroft	1.1	hydrogSaltFile = ' '
213			hydrogThetaFile = ' '
214			zonalWindFile = ' '
215			meridWindFile = ' '
216			thetaClimFile = ' '
217			saltClimFile = ' '
218	adcroft	1.2	EmPmRfile = ' '
219			surfQfile = ' '
220	heimbach	1.11	surfQswfile = ' '
221	adcroft	1.7	uVelInitFile = ' '
222			vVelInitFile = ' '
223	adcroft	1.9	pSurfInitFile = ' '
224	heimbach	1.17	dQdTFile = ' '
225	adcroft	1.1
226			C
227			RETURN
228			END
229