1 |
adcroft |
1.5 |
C $Header: /u/gcmpack/models/MITgcmUV/model/inc/PARAMS.h,v 1.4 1998/04/27 04:24:22 cnh Exp $ |
2 |
cnh |
1.1 |
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 |
cnh |
1.3 |
C delZ - Vertical grid spacing ( m ) - delZ is the distance |
89 |
cnh |
1.1 |
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 |
cnh |
1.3 |
C startTime - Start time for model ( s ) |
95 |
cnh |
1.1 |
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 |
cnh |
1.3 |
C rSphere - Radius of sphere for a spherical polar grid ( m ). |
100 |
cnh |
1.1 |
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 |
cnh |
1.3 |
C deltaT - Default timestep ( s ) |
122 |
|
|
C deltaTMom - Timestep for momemtum equations ( s ) |
123 |
|
|
C deltaTtracer - Timestep for tracer equations ( s ) |
124 |
cnh |
1.1 |
C tauCD - CD scheme coupling timescale ( 1/s ) |
125 |
|
|
C rCD - CD scheme normalised coupling parameter ( 0-1 ) |
126 |
|
|
C startTime - Starting time for this integration ( s ). |
127 |
|
|
C endTime - Ending time for this integration ( s ). |
128 |
|
|
C chkPtFreq - Frequency of check pointing ( s ). |
129 |
|
|
C dumpFreq - Frequency with which model state is written to |
130 |
|
|
C post-processing files ( s ). |
131 |
cnh |
1.3 |
COMMON /PARM_R/ cg2dTargetResidual, delZ, delX, delY, deltaT, |
132 |
|
|
& deltaTmom, deltaTtracer, abeps, startTime, phiMin, thetaMin, |
133 |
|
|
& rSphere, f0, fCori, beta, viscAh, viscAz, viscA4, diffKhT, diffKzT, |
134 |
|
|
& diffK4T, diffKhS, diffKzS, diffK4S, delT, tauCD, rCD, |
135 |
adcroft |
1.5 |
& gravity, rhonil, tRef, sRef, |
136 |
cnh |
1.1 |
& endTime, chkPtFreq, dumpFreq |
137 |
|
|
REAL cg2dTargetResidual |
138 |
|
|
REAL delZ(Nz) |
139 |
|
|
REAL delX(Nx) |
140 |
|
|
REAL delY(Ny) |
141 |
cnh |
1.3 |
REAL deltaT |
142 |
cnh |
1.1 |
REAL deltaTmom |
143 |
|
|
REAL deltaTtracer |
144 |
|
|
REAL abeps |
145 |
|
|
REAL phiMin |
146 |
|
|
REAL thetaMin |
147 |
|
|
REAL rSphere |
148 |
|
|
REAL f0 |
149 |
|
|
_RL beta |
150 |
|
|
REAL viscAh |
151 |
|
|
REAL viscAz |
152 |
|
|
REAL viscA4 |
153 |
|
|
REAL diffKhT |
154 |
|
|
REAL diffKzT |
155 |
|
|
REAL diffK4T |
156 |
|
|
REAL diffKhS |
157 |
|
|
REAL diffKzS |
158 |
|
|
REAL diffK4S |
159 |
|
|
REAL delt |
160 |
|
|
REAL tauCD |
161 |
|
|
REAL rCD |
162 |
|
|
REAL gravity |
163 |
|
|
REAL rhonil |
164 |
|
|
REAL tRef(Nz) |
165 |
|
|
REAL sRef(Nz) |
166 |
|
|
real Fcori(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy) |
167 |
|
|
REAL startTime |
168 |
|
|
REAL endTime |
169 |
|
|
REAL chkPtFreq |
170 |
|
|
REAL dumpFreq |
171 |
|
|
COMMON /PARM_A/ HeatCapacity_Cp, |
172 |
|
|
& Lamba_theta |
173 |
|
|
REAL HeatCapacity_Cp |
174 |
|
|
REAL Lamba_theta |
175 |
adcroft |
1.5 |
|
176 |
|
|
C Equation of State (polynomial coeffients) |
177 |
|
|
COMMON /PARM_EOS_NL/ eosC,eosSig0,eosRefT,eosRefS |
178 |
|
|
REAL eosC(Nz+1,9),eosSig0(Nz+1),eosRefT(Nz+1),eosRefS(Nz+1) |
179 |
|
|
C Linear equation of state |
180 |
|
|
C tAlpha - Linear EOS thermal expansion coefficient ( 1/degree ). |
181 |
|
|
C sBeta - Linear EOS haline contraction coefficient. |
182 |
|
|
COMMON /PARM_EOS_LIN/ tAlpha,sBeta |
183 |
|
|
REAL tAlpha |
184 |
|
|
REAL sBeta |