1 |
C $Header: /u/gcmpack/models/MITgcmUV/model/inc/PARAMS.h,v 1.5 1998/04/30 13:25:01 adcroft Exp $ |
2 |
C |
3 |
C /==========================================================\ |
4 |
C | PARAMS.h | |
5 |
C | o Header file defining model "parameters". | |
6 |
C |==========================================================| |
7 |
C | The values from the model's standard input file are | |
8 |
C | stored into the variables held here. Notes describing | |
9 |
C | the parameters can also be found here. | |
10 |
C \==========================================================/ |
11 |
|
12 |
C-- Contants |
13 |
C nOBands - No. of offline data time bands |
14 |
INTEGER nOBands |
15 |
PARAMETER ( nOBands = 12 ) |
16 |
C Useful physical values |
17 |
Real*8 PI |
18 |
PARAMETER ( PI = 3.14159265358979323844D0 ) |
19 |
Real*8 deg2rad |
20 |
PARAMETER ( deg2rad = 2.D0*PI/360.D0 ) |
21 |
|
22 |
C-- COMMON /PARM_C/ Character valued parameters used by the model. |
23 |
C oBandId - Offline dataset identifiers for different periods. |
24 |
COMMON /PARM_C/ oBandId |
25 |
CHARACTER*3 oBandId(nOBands) |
26 |
C-- COMMON /PARM_I/ Integer valued parameters used by the model. |
27 |
C cg2dMaxIters - Maximum number of iterations in the |
28 |
C two-dimensional con. grad solver. |
29 |
C cg2dChkResFreq - Frequency with which to check residual |
30 |
C in con. grad solver. |
31 |
C nIter0 - Start time-step number of for this run |
32 |
C nTimeSteps - Number of timesteps to execute |
33 |
C numStepsPerPickup - For offline setup. Frequency of pickup |
34 |
C of flow fields. |
35 |
COMMON /PARM_I/ |
36 |
& cg2dMaxIters, |
37 |
& cg2dChkResFreq, |
38 |
& nIter0, nTimeSteps, |
39 |
& numStepsPerPickup |
40 |
INTEGER cg2dMaxIters |
41 |
INTEGER cg2dChkResFreq |
42 |
INTEGER nIter0 |
43 |
INTEGER nTimeSteps |
44 |
INTEGER numStepsPerPickup |
45 |
|
46 |
C-- COMMON /PARM_L/ Logical valued parameters used by the model. |
47 |
C usingCartesianGrid - If TRUE grid generation will be in a cartesian |
48 |
C coordinate frame. |
49 |
C usingSphericalPolarGrid - If TRUE grid generation will be in a |
50 |
C spherical polar frame. |
51 |
C momViscosity - Flag which turns momentum friction terms on and off. |
52 |
C momAdvection - Flag which turns advection of momentum on and off. |
53 |
C momForcing - Flag which turns external forcing of momentum on |
54 |
C and off. |
55 |
C useCoriolis - Flag which turns the coriolis terms on and off. |
56 |
C tempDiffusion - Flag which turns diffusion of temperature on |
57 |
C and off. |
58 |
C tempAdvection - Flag which turns advection of temperature on |
59 |
C and off. |
60 |
C tempForcing - Flag which turns external forcing of temperature on |
61 |
C and off. |
62 |
C saltDiffusion - Flag which turns diffusion of salinit on |
63 |
C and off. |
64 |
C saltAdvection - Flag which turns advection of salinit on |
65 |
C and off. |
66 |
C saltForcing - Flag which turns external forcing of salinit on |
67 |
C and off. |
68 |
COMMON /PARM_L/ usingCartesianGrid, usingSphericalPolarGrid, |
69 |
& momViscosity, momAdvection, momForcing, useCoriolis, |
70 |
& tempDiffusion, tempAdvection, tempForcing, |
71 |
& saltDiffusion, saltAdvection, saltForcing |
72 |
LOGICAL usingCartesianGrid |
73 |
LOGICAL usingSphericalPolarGrid |
74 |
LOGICAL momViscosity |
75 |
LOGICAL momAdvection |
76 |
LOGICAL momForcing |
77 |
LOGICAL useCoriolis |
78 |
LOGICAL tempDiffusion |
79 |
LOGICAL tempAdvection |
80 |
LOGICAL tempForcing |
81 |
LOGICAL saltDiffusion |
82 |
LOGICAL saltAdvection |
83 |
LOGICAL saltForcing |
84 |
|
85 |
C-- COMMON /PARM_R/ "Real" valued parameters used by the model. |
86 |
C cg2dTargetResidual |
87 |
C - Target residual for cg2d solver. |
88 |
C delZ - Vertical grid spacing ( m ) - delZ is the distance |
89 |
C between "w" surfaces. |
90 |
C delX - Separation between cell faces (m) or (deg), depending |
91 |
C delY on input flags. |
92 |
C gravity - Accel. due to gravity ( m/s^2 ) |
93 |
C ronil - Reference density |
94 |
C startTime - Start time for model ( s ) |
95 |
C phiMin - Latitude of southern most cell face. |
96 |
C thetaMin - Longitude of western most cell face (this |
97 |
C is an "inert" parameter but it is included |
98 |
C to make geographical references simple.) |
99 |
C rSphere - Radius of sphere for a spherical polar grid ( m ). |
100 |
C f0 - Reference coriolis parameter ( 1/s ) |
101 |
C ( Southern edge f for beta plane ) |
102 |
C beta - df/dy ( s^-1.m^-1 ) |
103 |
C viscAh - Eddy viscosity coeff. for mixing of |
104 |
C momentum laterally ( m^2/s ) |
105 |
C viscAz - Eddy viscosity coeff. for mixing of |
106 |
C momentum vertically ( m^2/s ) |
107 |
C viscA4 - Biharmonic viscosity coeff. for mixing of |
108 |
C momentum laterally ( m^4/s ) |
109 |
C diffKhT - Laplacian diffusion coeff. for mixing of |
110 |
C heat laterally ( m^2/s ) |
111 |
C diffKzT - Laplacian diffusion coeff. for mixing of |
112 |
C heat vertically ( m^2/s ) |
113 |
C diffK4T - Biharmonic diffusion coeff. for mixing of |
114 |
C heat laterally ( m^4/s ) |
115 |
C diffKhS - Laplacian diffusion coeff. for mixing of |
116 |
C salt laterally ( m^2/s ) |
117 |
C diffKzS - Laplacian diffusion coeff. for mixing of |
118 |
C salt vertically ( m^2/s ) |
119 |
C diffK4S - Biharmonic diffusion coeff. for mixing of |
120 |
C salt laterally ( m^4/s ) |
121 |
C deltaT - Default timestep ( s ) |
122 |
C deltaTMom - Timestep for momemtum equations ( s ) |
123 |
C deltaTtracer - Timestep for tracer equations ( s ) |
124 |
C tauCD - CD scheme coupling timescale ( 1/s ) |
125 |
C rCD - CD scheme normalised coupling parameter ( 0-1 ) |
126 |
C GMmaxslope - max. slope allowed in GM/Redi tensor |
127 |
C GMlength - Length to use in Visbeck et al. formula for K |
128 |
C GMalpha - alpha to use in Visbeck et al. formula for K |
129 |
C GMdepth - Depth over which to integrate Richardson # (Visbeck et al.) |
130 |
C GMbackground - background value of GM/Redi coefficient |
131 |
C startTime - Starting time for this integration ( s ). |
132 |
C endTime - Ending time for this integration ( s ). |
133 |
C chkPtFreq - Frequency of check pointing ( s ). |
134 |
C dumpFreq - Frequency with which model state is written to |
135 |
C post-processing files ( s ). |
136 |
COMMON /PARM_R/ cg2dTargetResidual, delZ, delX, delY, deltaT, |
137 |
& deltaTmom, deltaTtracer, abeps, startTime, phiMin, thetaMin, |
138 |
& rSphere, f0, fCori, beta, viscAh, viscAz, viscA4, diffKhT, diffKzT, |
139 |
& diffK4T, diffKhS, diffKzS, diffK4S, delT, tauCD, rCD, |
140 |
& GMmaxslope,GMlength,GMalpha,GMdepth,GMkbackground, |
141 |
& gravity, rhonil, tRef, sRef, |
142 |
& endTime, chkPtFreq, dumpFreq |
143 |
_RL cg2dTargetResidual |
144 |
_RL delZ(Nz) |
145 |
_RL delX(Nx) |
146 |
_RL delY(Ny) |
147 |
_RL deltaT |
148 |
_RL deltaTmom |
149 |
_RL deltaTtracer |
150 |
_RL abeps |
151 |
_RL phiMin |
152 |
_RL thetaMin |
153 |
_RL rSphere |
154 |
_RL f0 |
155 |
_RL beta |
156 |
_RL viscAh |
157 |
_RL viscAz |
158 |
_RL viscA4 |
159 |
_RL diffKhT |
160 |
_RL diffKzT |
161 |
_RL diffK4T |
162 |
_RL diffKhS |
163 |
_RL diffKzS |
164 |
_RL diffK4S |
165 |
_RL delt |
166 |
_RL tauCD |
167 |
_RL rCD |
168 |
_RL GMmaxslope |
169 |
_RL GMlength |
170 |
_RL GMalpha |
171 |
_RL GMdepth |
172 |
_RL GMkbackground |
173 |
_RL gravity |
174 |
_RL rhonil |
175 |
_RL tRef(Nz) |
176 |
_RL sRef(Nz) |
177 |
_RL Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) |
178 |
_RL startTime |
179 |
_RL endTime |
180 |
_RL chkPtFreq |
181 |
_RL dumpFreq |
182 |
|
183 |
COMMON /PARM_A/ HeatCapacity_Cp, |
184 |
& Lamba_theta |
185 |
_RL HeatCapacity_Cp |
186 |
_RL Lamba_theta |
187 |
|
188 |
C Equation of State (polynomial coeffients) |
189 |
COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS |
190 |
_RL eosC(Nz+1,9),eosSig0(Nz+1),eosRefT(Nz+1),eosRefS(Nz+1) |
191 |
C Linear equation of state |
192 |
C tAlpha - Linear EOS thermal expansion coefficient ( 1/degree ). |
193 |
C sBeta - Linear EOS haline contraction coefficient. |
194 |
COMMON /PARM_EOS_LIN/ tAlpha,sBeta |
195 |
_RL tAlpha |
196 |
_RL sBeta |