/[MITgcm]/MITgcm/pkg/ecco/ecco.h
ViewVC logotype

Annotation of /MITgcm/pkg/ecco/ecco.h

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.23 - (hide annotations) (download)
Fri Jan 20 20:55:55 2017 UTC (7 years, 5 months ago) by gforget
Branch: MAIN
CVS Tags: checkpoint66e, checkpoint66d
Changes since 1.22: +4 -2 lines
File MIME type: text/plain
- add passive tracer cost functions to gencost: m_ptracer and m_boxmean_ptracer

1 gforget 1.23 C $Header: /u/gcmpack/MITgcm/pkg/ecco/ecco.h,v 1.22 2016/09/21 12:55:31 gforget Exp $
2 jmc 1.2 C $Name: $
3 heimbach 1.1
4     c ==================================================================
5     c HEADER ECCO
6     c ==================================================================
7     c
8     c o Header for the ECCO project.
9     c
10     c started: Christian Eckert eckert@mit.edu 23-Feb-1999
11     c
12     c changed: Christian Eckert eckert@mit.edu
13     c
14     c
15     c ==================================================================
16     c HEADER ECCO
17     c ==================================================================
18    
19     c Version of the release and versions of used packages:
20     c =====================================================
21     c
22     c eccoVersion - ecco release version.
23     c usesCalendarVersion - version of the calendar that has to
24     c be used.
25     c usesExternalForcingVersion - version of the external forcing that
26     c has to be used.
27     c usesAdjointSupportVersion - version of the adjoint support routines
28     c that have to be used.
29     c usesOptimizationVersion - version of the oof-line optimization
30     c that has to be used.
31    
32     character*(5) eccoVersion
33     character*(5) eccoUsesCalVersion
34     character*(5) eccoUsesExfVersion
35     character*(5) eccoUsesAdsuppVersion
36     character*(5) eccoUsesOptimVersion
37    
38     parameter( eccoVersion = '0.1.0' )
39     parameter( eccoUsesCalVersion = '0.1.4' )
40     parameter( eccoUsesExfVersion = '0.1.1' )
41     parameter( eccoUsesAdsuppVersion = '0.1.0' )
42     parameter( eccoUsesOptimVersion = '2.1.0' )
43    
44    
45     c Experiment name:
46     c ================
47    
48     common /ecco_c/
49     & expId
50     character*(10) expId
51    
52    
53     c Integration information:
54     c ========================
55     c
56     c nyears - number of calendar years that are affected by the
57     c current integration.
58    
59     common /ecco_i/
60     & nyears, nmonths, ndays, numsteps,
61 gforget 1.3 & eccoiter, ecco_prevcall
62 heimbach 1.1 integer nyears
63     integer nmonths
64     integer ndays
65     integer numsteps
66 gforget 1.3 integer eccoiter
67     integer ecco_prevcall
68    
69     c Averaging counters:
70     c ===================
71     c
72     c sum1day - counter for the daily averaging
73     c sum1mon - counter for the monthly averaging
74     c dayrec - number of averaged surface pressure records.
75     c monrec - number of averaged theta and salinity records.
76    
77     common /average_i/
78     & sum1day,sum1mon,sum1year,
79     & dayrec,monrec,yearrec
80     integer sum1day
81     integer sum1mon
82     integer sum1year
83     integer dayrec
84     integer monrec
85     integer yearrec
86    
87     c Flags used in the model-data comparison:
88     c ========================================
89     c
90     c using_ers - flag that indicates the use of ERS data
91    
92     common /ecco_cost_data_flags/
93     & using_mdt,
94     & using_tpj,
95     & using_topex,
96     & using_ers,
97     & using_gfo,
98     & using_cost_altim,
99     & using_cost_bp,
100     & using_cost_sst,
101     & using_cost_scat,
102     & using_cost_seaice
103 atn 1.16 & ,using_cost_transp
104 gforget 1.3 logical using_mdt
105     logical using_tpj
106     logical using_topex
107     logical using_ers
108     logical using_gfo
109     logical using_cost_altim
110     logical using_cost_bp
111     logical using_cost_sst
112     logical using_cost_scat
113     logical using_cost_seaice
114 atn 1.16 logical using_cost_transp
115 gforget 1.3
116     c Record counters relevant for the cost function evaluation.
117     c ==========================================================
118     c
119     c nyearsrec - number of yearly records that will be generated by
120     c the current model integration.
121     c nmonsrec - number of monthly records that will be generated by
122     c the current model integration.
123     c ndaysrec - number of daily records that will be generated by
124     c the current model integration.
125 heimbach 1.1
126 gforget 1.3 common /ecco_i/
127     & nyearsrec,
128     & nmonsrec,
129     & ndaysrec
130     integer nyearsrec
131     integer nmonsrec
132     integer ndaysrec
133    
134     common /ecco_r/
135 gforget 1.10 & m_eta,m_UE,m_VN,
136 atn 1.14 & msktrVolW,msktrVolS,
137 gforget 1.18 & trVol, trHeat, trSalt,
138 gforget 1.8 & VOLsumGlob_0, VOLsumGlob,
139     & RHOsumGlob_0, RHOsumGlob,
140 gforget 1.20 & frame, cosphi, eccoVol_0
141 gforget 1.3 _RL VOLsumGlob_0, VOLsumGlob, RHOsumGlob_0, RHOsumGlob
142 gforget 1.8 _RL frame (1-olx:snx+olx,1-oly:sny+oly )
143     _RL cosphi (1-olx:snx+olx,1-oly:sny+oly, nsx,nsy)
144 gforget 1.10 _RL m_eta(1-olx:snx+olx,1-oly:sny+oly, nsx,nsy)
145     _RL m_UE (1-olx:snx+olx,1-oly:sny+oly,nr,nsx,nsy)
146     _RL m_VN (1-olx:snx+olx,1-oly:sny+oly,nr,nsx,nsy)
147 atn 1.15 _RL msktrVolW (1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
148     _RL msktrVolS (1-OLx:sNx+OLx,1-OLy:sNy+OLy, nSx,nSy)
149 atn 1.14 _RL trVol(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
150     _RL trHeat(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
151     _RL trSalt(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
152 gforget 1.20 _RL eccoVol_0(1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
153 gforget 1.3
154     c file precision and field type
155     common /prec_type_cost/
156     & cost_iprec,
157     & cost_yftype
158    
159     integer cost_iprec
160     character*(2) cost_yftype
161    
162     c Number of User Cost terms:
163     c =============================
164     INTEGER NUSERCOST
165     PARAMETER ( NUSERCOST=10 )
166    
167     c Number of Generic Cost terms:
168     c =============================
169     INTEGER NGENCOST
170     PARAMETER ( NGENCOST=20 )
171    
172 gforget 1.4 INTEGER NGENCOST3D
173     #ifdef ALLOW_GENCOST3D
174 gforget 1.9 PARAMETER ( NGENCOST3D=4 )
175 gforget 1.4 #else
176     PARAMETER ( NGENCOST3D=0 )
177     #endif
178    
179 gforget 1.7 INTEGER NGENPPROC
180     PARAMETER ( NGENPPROC=10 )
181    
182    
183     c empty pre/post-processing :
184     c =========================
185     common /ecco_nogencost_c/
186     & no_preproc,
187     & no_preproc_c,
188     & no_posproc,
189 gforget 1.11 & no_posproc_c,
190 gforget 1.12 & clim_preproc,
191     & anom_preproc
192 gforget 1.7 character*(MAX_LEN_FNAM) no_preproc(NGENPPROC)
193     character*(MAX_LEN_FNAM) no_preproc_c(NGENPPROC)
194     character*(MAX_LEN_FNAM) no_posproc(NGENPPROC)
195     character*(MAX_LEN_FNAM) no_posproc_c(NGENPPROC)
196 gforget 1.11 character*(MAX_LEN_FNAM) clim_preproc(NGENPPROC)
197 gforget 1.12 character*(MAX_LEN_FNAM) anom_preproc(NGENPPROC)
198 gforget 1.7
199     common /ecco_nogencost_r/
200     & no_preproc_r, no_posproc_r
201     _RL no_preproc_r(NGENPPROC)
202     _RL no_posproc_r(NGENPPROC)
203    
204     common /ecco_nogencost_i/
205 gforget 1.11 & no_preproc_i, no_posproc_i, clim_preproc_i
206 gforget 1.7 integer no_preproc_i(NGENPPROC)
207     integer no_posproc_i(NGENPPROC)
208 gforget 1.11 integer clim_preproc_i(NGENPPROC)
209 gforget 1.7
210     c gencost common blocs:
211     c =====================
212    
213 gforget 1.3 #ifdef ALLOW_GENCOST_CONTRIBUTION
214     c objf_gencost - gencost user defined contribution
215     common /ecco_gencost_ctrl/
216     & gencost_dummy
217     _RL gencost_dummy(NGENCOST)
218    
219     common /ecco_gencost_r_1/
220 gforget 1.19 & objf_gencost, num_gencost, mult_gencost, gencost_storefld,
221 gforget 1.3 & gencost_barfld, gencost_modfld, gencost_weight,
222 gforget 1.18 & gencost_mskCsurf, gencost_mskWsurf, gencost_mskSsurf,
223 gforget 1.21 & gencost_mskVertical,
224 gforget 1.4 #ifdef ALLOW_GENCOST3D
225     & gencost_bar3d, gencost_mod3d, gencost_wei3d,
226     #endif
227 gforget 1.7 & gencost_spmin, gencost_spmax, gencost_spzero,
228     & gencost_period, gencost_preproc_r, gencost_posproc_r
229    
230 gforget 1.3 _RL objf_gencost(nsx,nsy,NGENCOST)
231     _RL num_gencost(nsx,nsy,NGENCOST)
232     _RL mult_gencost(NGENCOST)
233     _RL gencost_spmin(NGENCOST)
234     _RL gencost_spmax(NGENCOST)
235     _RL gencost_spzero(NGENCOST)
236 gforget 1.7 _RL gencost_period(NGENCOST)
237 gforget 1.19 _RL gencost_storefld(1-olx:snx+olx,1-oly:sny+oly,
238     & nsx,nsy,NGENCOST)
239 gforget 1.3 _RL gencost_barfld(1-olx:snx+olx,1-oly:sny+oly,
240     & nsx,nsy,NGENCOST)
241     _RL gencost_modfld(1-olx:snx+olx,1-oly:sny+oly,
242     & nsx,nsy,NGENCOST)
243     _RL gencost_weight(1-olx:snx+olx,1-oly:sny+oly,
244     & nsx,nsy,NGENCOST)
245 gforget 1.18 _RL gencost_mskCsurf(1-olx:snx+olx,1-oly:sny+oly,
246     & nsx,nsy,NGENCOST)
247     _RL gencost_mskWsurf(1-olx:snx+olx,1-oly:sny+oly,
248     & nsx,nsy,NGENCOST)
249     _RL gencost_mskSsurf(1-olx:snx+olx,1-oly:sny+oly,
250     & nsx,nsy,NGENCOST)
251 gforget 1.21 _RL gencost_mskVertical(nr,NGENCOST)
252 gforget 1.4 #ifdef ALLOW_GENCOST3D
253     _RL gencost_bar3d(1-olx:snx+olx,1-oly:sny+oly,
254     & nr,nsx,nsy,NGENCOST3D)
255     _RL gencost_mod3d(1-olx:snx+olx,1-oly:sny+oly,
256     & nr,nsx,nsy,NGENCOST3D)
257     _RL gencost_wei3d(1-olx:snx+olx,1-oly:sny+oly,
258     & nr,nsx,nsy,NGENCOST3D)
259     #endif
260 gforget 1.7 _RL gencost_preproc_r(NGENPPROC,NGENCOST)
261     _RL gencost_posproc_r(NGENPPROC,NGENCOST)
262 gforget 1.3
263     common /ecco_gencost_i_1/
264 gforget 1.5 & gencost_nrec, gencost_nrecperiod,
265     & gencost_flag, gencost_outputlevel,
266 gforget 1.3 & gencost_startdate1, gencost_startdate2,
267     & gencost_enddate1, gencost_enddate2,
268 gforget 1.4 & gencost_startdate, gencost_enddate,
269 gforget 1.7 & gencost_pointer3d, gencost_smooth2Ddiffnbt,
270 gforget 1.23 & gencost_preproc_i, gencost_posproc_i,
271     & gencost_itracer
272 gforget 1.3
273     integer gencost_nrec(NGENCOST)
274 gforget 1.5 integer gencost_nrecperiod(NGENCOST)
275 gforget 1.3 integer gencost_flag(NGENCOST)
276 gforget 1.5 integer gencost_outputlevel(NGENCOST)
277 gforget 1.3 integer gencost_startdate1(NGENCOST)
278     integer gencost_startdate2(NGENCOST)
279     integer gencost_startdate(4,NGENCOST)
280     integer gencost_enddate1(NGENCOST)
281     integer gencost_enddate2(NGENCOST)
282     integer gencost_enddate(4,NGENCOST)
283 gforget 1.4 integer gencost_pointer3d(NGENCOST)
284 gforget 1.3 integer gencost_smooth2Ddiffnbt(NGENCOST)
285 gforget 1.7 integer gencost_preproc_i(NGENPPROC,NGENCOST)
286     integer gencost_posproc_i(NGENPPROC,NGENCOST)
287 gforget 1.23 integer gencost_itracer(NGENCOST)
288 gforget 1.3
289     common /ecco_gencost_l_1/
290 gforget 1.6 & gencost_timevaryweight, gencost_barskip,
291 gforget 1.4 & using_gencost, gencost_is3d
292 gforget 1.3 LOGICAL using_gencost(NGENCOST)
293 gforget 1.4 LOGICAL gencost_is3d(NGENCOST)
294 gforget 1.3 LOGICAL gencost_timevaryweight(NGENCOST)
295 gforget 1.6 LOGICAL gencost_barskip(NGENCOST)
296 gforget 1.3
297     common /ecco_gencost_c/
298     & gencost_name,
299     & gencost_scalefile,
300     & gencost_errfile,
301     & gencost_datafile,
302     & gencost_barfile,
303     & gencost_avgperiod,
304 gforget 1.4 & gencost_preproc,
305 gforget 1.7 & gencost_preproc_c,
306 gforget 1.5 & gencost_posproc,
307 gforget 1.7 & gencost_posproc_c,
308 gforget 1.3 & gencost_mask
309     character*(MAX_LEN_FNAM) gencost_name(NGENCOST)
310     character*(MAX_LEN_FNAM) gencost_scalefile(NGENCOST)
311     character*(MAX_LEN_FNAM) gencost_errfile(NGENCOST)
312     character*(MAX_LEN_FNAM) gencost_datafile(NGENCOST)
313     character*(MAX_LEN_FNAM) gencost_barfile(NGENCOST)
314     character*(5) gencost_avgperiod(NGENCOST)
315 gforget 1.7 character*(MAX_LEN_FNAM) gencost_preproc(NGENPPROC,NGENCOST)
316     character*(MAX_LEN_FNAM) gencost_posproc_c(NGENPPROC,NGENCOST)
317     character*(MAX_LEN_FNAM) gencost_posproc(NGENPPROC,NGENCOST)
318     character*(MAX_LEN_FNAM) gencost_preproc_c(NGENPPROC,NGENCOST)
319 gforget 1.22 character*(MAX_LEN_FNAM) gencost_mask(NGENCOST)
320 gforget 1.3
321     #endif /* ALLOW_GENCOST_CONTRIBUTION */
322 heimbach 1.1
323     c ==================================================================
324     c END OF HEADER ECCO
325     c ==================================================================
326    
327    

  ViewVC Help
Powered by ViewVC 1.1.22