model/src/set_defaults.F

C $Header: /u/gcmpack/models/MITgcmUV/model/src/set_defaults.F,v 1.24 2001/08/15 15:51:46 adcroft Exp $
C $Name:  $

#include "CPP_OPTIONS.h"

      SUBROUTINE SET_DEFAULTS(
     O   viscArDefault, diffKrTDefault, diffKrSDefault,
     O   hFacMinDrDefault, delRdefault, rkFacDefault,
     I   myThid )
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     \==========================================================/
      IMPLICIT NONE

C     === Global variables ===
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "GRID.h"

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     K, I, J - Loop counters
      INTEGER K, I, J

C--   Grid parameters
C     Vertical gridding
      rkFacDefault         = 1.D0
      horiVertRatio        = 1.D0
      Ro_SeaLevel = 0.
      DO k=1,Nr
       delRdefault(k) = 0.
      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
      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'
      implicitFreeSurface = .TRUE.
      rigidLid            = .FALSE.
      implicSurfPress     = 1.D0
      implicDiv2DFlow     = 1.D0
      hFacMin             = 1.D0
      hFacMinDrDefault    = 0.D0
      exactConserv        = .FALSE.
      uniformLin_PhiSurf  = .TRUE.
      nonlinFreeSurf      = 0
      hFacInf             = 1.D0
      hFacSup             = 1.D0
      staggerTimeStep     = .FALSE.
      momViscosity        = .TRUE.
      momAdvection        = .TRUE.
      momForcing          = .TRUE.
      useCoriolis         = .TRUE.
      momPressureForcing  = .TRUE.
      momStepping         = .TRUE.
      vectorInvariantMomentum = .FALSE.
      tempStepping        = .TRUE.
      saltStepping        = .TRUE.
      tr1Stepping         = .FALSE.
      metricTerms         = .TRUE.
      implicitDiffusion   = .FALSE.
      implicitViscosity   = .FALSE.
      nonHydrostatic      = .FALSE.
      globalFiles         = .FALSE.
      allowFreezing       = .FALSE.
      ivdc_kappa          = 0.D0
      groundAtK1          = .FALSE.
      zonal_filt_lat      = 90.
      zonal_filt_sinpow   = 2
      zonal_filt_cospow   = 2
      bottomDragLinear    = 0.
      bottomDragQuadratic = 0.
      usePickupBeforeC35    = .FALSE.
      debugMode             = .FALSE.
      readPickupWithTracer  = .FALSE.
      writePickupWithTracer = .FALSE.
      tempAdvScheme       = 2
      saltAdvScheme       = 2
      tracerAdvScheme     = 2

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)
      abEps             = 0.01
      pchkPtFreq        = deltaT*0
      chkPtFreq         = deltaT*0
      dumpFreq          = 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	adcroft	1.25	C $Header: /u/gcmpack/models/MITgcmUV/model/src/set_defaults.F,v 1.24 2001/08/15 15:51:46 adcroft Exp $
2	heimbach	1.18	C $Name: $
3	adcroft	1.1
4			#include "CPP_OPTIONS.h"
5
6			SUBROUTINE SET_DEFAULTS(
7			O viscArDefault, diffKrTDefault, diffKrSDefault,
8	adcroft	1.2	O hFacMinDrDefault, delRdefault, rkFacDefault,
9	adcroft	1.1	I myThid )
10			C /==========================================================\
11			C \| SUBROUTINE SET_DEFAULTS \|
12			C \| o Routine to set model "parameters" \|
13			C \|==========================================================\|
14			C \| Notes: \|
15			C \| ====== \|
16			C \| The present version of this routine is a place-holder. \|
17			C \| A production version needs to handle parameters from an \|
18			C \| external file and possibly reading in some initial field \|
19			C \| values. \|
20			C \==========================================================/
21			IMPLICIT NONE
22
23			C === Global variables ===
24			#include "SIZE.h"
25			#include "EEPARAMS.h"
26			#include "PARAMS.h"
27			#include "GRID.h"
28
29			C === Routine arguments ===
30			C myThid - Number of this instance of INI_PARMS
31			INTEGER myThid
32			_RL viscArDefault
33			_RL diffKrTDefault
34			_RL diffKrSDefault
35			_RL hFacMinDrDefault
36			_RL delRDefault(Nr)
37	adcroft	1.2	_RS rkFacDefault
38	adcroft	1.1
39			C === Local variables ===
40			C K, I, J - Loop counters
41			INTEGER K, I, J
42
43			C-- Grid parameters
44			C Vertical gridding
45	adcroft	1.2	rkFacDefault = 1.D0
46			horiVertRatio = 1.D0
47	adcroft	1.12	Ro_SeaLevel = 0.
48	adcroft	1.1	DO k=1,Nr
49	adcroft	1.2	delRdefault(k) = 0.
50	adcroft	1.1	ENDDO
51
52			C Horizontal gridding
53			C In cartesian coords distances are in metres
54			usingCartesianGrid = .TRUE.
55			DO i=1,Nx
56	adcroft	1.8	delX(i) = UNSET_RL
57	adcroft	1.1	ENDDO
58			DO j=1,Ny
59	adcroft	1.8	delY(j) = UNSET_RL
60	adcroft	1.1	ENDDO
61			C In spherical polar distances are in degrees
62			usingSphericalPolarGrid = .FALSE.
63	adcroft	1.2	phiMin = 0.0
64			thetaMin = 0.
65			rSphere = 6370. * 1.D3
66	adcroft	1.19	C General curvilinear coordinate system
67			usingCurvilinearGrid = .FALSE.
68	adcroft	1.1
69			C-- Set default "physical" parameters
70			DO K =1,Nr
71			tRef(K) = 30.D0 - FLOAT( K )
72			ENDDO
73	adcroft	1.2	gravity = 9.81D0
74			rhoNil = 999.8D0
75			f0 = 1.D-4
76			beta = 1.D-11
77	adcroft	1.19	omega = 2.D0 * PI / ( 3600.D0 * 24.D0 )
78	adcroft	1.2	viscAh = 0.D3
79			diffKhT = 0.D3
80			diffKhS = 0.D3
81			viscArDefault = 0.D-3
82			no_slip_sides = .TRUE.
83			no_slip_bottom = .TRUE.
84			diffKrTDefault = 0.D-3
85			diffKrSDefault = 0.D-3
86			viscA4 = 0.D11
87			diffK4T = 0.D11
88			diffK4S = 0.D11
89	adcroft	1.4	cosPower = 0.
90	adcroft	1.2	HeatCapacity_Cp = 3994.D0
91			tAlpha = 2.D-4
92			sBeta = 7.4D-4
93			eosType = 'LINEAR'
94	adcroft	1.1	buoyancyRelation = 'OCEANIC'
95			implicitFreeSurface = .TRUE.
96			rigidLid = .FALSE.
97	jmc	1.15	implicSurfPress = 1.D0
98			implicDiv2DFlow = 1.D0
99	adcroft	1.1	hFacMin = 1.D0
100			hFacMinDrDefault = 0.D0
101	adcroft	1.19	exactConserv = .FALSE.
102	jmc	1.22	uniformLin_PhiSurf = .TRUE.
103			nonlinFreeSurf = 0
104	adcroft	1.19	hFacInf = 1.D0
105			hFacSup = 1.D0
106	adcroft	1.12	staggerTimeStep = .FALSE.
107	adcroft	1.1	momViscosity = .TRUE.
108			momAdvection = .TRUE.
109			momForcing = .TRUE.
110			useCoriolis = .TRUE.
111			momPressureForcing = .TRUE.
112			momStepping = .TRUE.
113	adcroft	1.25	vectorInvariantMomentum = .FALSE.
114	adcroft	1.1	tempStepping = .TRUE.
115			saltStepping = .TRUE.
116	heimbach	1.23	tr1Stepping = .FALSE.
117	jmc	1.16	metricTerms = .TRUE.
118	adcroft	1.1	implicitDiffusion = .FALSE.
119	adcroft	1.5	implicitViscosity = .FALSE.
120	adcroft	1.2	nonHydrostatic = .FALSE.
121	adcroft	1.3	globalFiles = .FALSE.
122			allowFreezing = .FALSE.
123	adcroft	1.6	ivdc_kappa = 0.D0
124	adcroft	1.12	groundAtK1 = .FALSE.
125			zonal_filt_lat = 90.
126			zonal_filt_sinpow = 2
127	adcroft	1.14	zonal_filt_cospow = 2
128	adcroft	1.12	bottomDragLinear = 0.
129			bottomDragQuadratic = 0.
130	heimbach	1.23	usePickupBeforeC35 = .FALSE.
131			debugMode = .FALSE.
132			readPickupWithTracer = .FALSE.
133			writePickupWithTracer = .FALSE.
134	adcroft	1.24	tempAdvScheme = 2
135			saltAdvScheme = 2
136			tracerAdvScheme = 2
137	adcroft	1.1
138	jmc	1.22	C-- Atmospheric physical parameters (e.g.: EOS)
139			atm_po = 1.D5
140			atm_cp = 1004.D0
141			atm_kappa = 2.D0 / 7.D0
142			Integr_GeoPot = 2
143
144	adcroft	1.1	C-- Elliptic solver parameters
145			cg2dMaxIters = 150
146			cg2dTargetResidual = 1.D-7
147	adcroft	1.19	cg2dTargetResWunit = -1.
148	adcroft	1.1	cg2dChkResFreq = 1
149	adcroft	1.2	cg2dpcOffDFac = 0.51D0
150	adcroft	1.1	cg3dMaxIters = 150
151			cg3dTargetResidual = 1.D-7
152			cg3dChkResFreq = 1
153
154			C-- Time stepping parameters
155			deltaT = 0.
156			nIter0 = 0
157			startTime = deltaT*float(nIter0)
158	adcroft	1.2	nTimeSteps = 0
159	adcroft	1.6	nEndIter = nIter0+nTimeSteps
160			endTime = deltaT*float(nEndIter)
161	adcroft	1.1	abEps = 0.01
162			pchkPtFreq = deltaT*0
163			chkPtFreq = deltaT*0
164	adcroft	1.2	dumpFreq = deltaT*0
165	adcroft	1.20	monitorFreq = -1.
166	adcroft	1.1	taveFreq = deltaT*0
167			writeStatePrec = precFloat64
168			writeBinaryPrec = precFloat32
169			readBinaryPrec = precFloat32
170			nCheckLev = 1
171			checkPtSuff(1) = 'ckptA'
172			checkPtSuff(2) = 'ckptB'
173	adcroft	1.6	cAdjFreq = 0.D0
174	adcroft	1.1	tauCD = 0.D0
175			tauThetaClimRelax = 0.D0
176			tauSaltClimRelax = 0.D0
177	heimbach	1.23	tauTr1ClimRelax = 0.D0
178	adcroft	1.1	periodicExternalForcing = .FALSE.
179			externForcingPeriod = 0.
180			externForcingCycle = 0.
181
182			C-- Input files
183			bathyFile = ' '
184	jmc	1.22	topoFile = ' '
185	adcroft	1.1	hydrogSaltFile = ' '
186			hydrogThetaFile = ' '
187			zonalWindFile = ' '
188			meridWindFile = ' '
189			thetaClimFile = ' '
190			saltClimFile = ' '
191	adcroft	1.2	EmPmRfile = ' '
192			surfQfile = ' '
193	heimbach	1.11	surfQswfile = ' '
194	adcroft	1.7	uVelInitFile = ' '
195			vVelInitFile = ' '
196	adcroft	1.9	pSurfInitFile = ' '
197	heimbach	1.17	dQdTFile = ' '
198	adcroft	1.1
199			C
200			RETURN
201			END
202