/[MITgcm]/MITgcm/doc/tag-index
ViewVC logotype

Diff of /MITgcm/doc/tag-index

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

revision 1.1675 by heimbach, Mon Jun 25 19:25:41 2012 UTC revision 1.2077 by gforget, Mon Oct 6 12:05:00 2014 UTC
# Line 4  $Name$ Line 4  $Name$
4      Notes on tags used in MITgcmUV      Notes on tags used in MITgcmUV
5      ==============================      ==============================
6    
7    o pkg/ecco: increase modularity and improve logic
8      - ecco_toolbox.F (new) : basic operations that are often used
9         (for now, ecco_toolbox.F simply contains function ecco_zero).
10      - cost_gencal.F (new) : determine filnames and records.
11      - cost_gendif.F (new) : compute masked model-data difference.
12      - cost_genread.F : use ecco_zero to initialize field to 0s.
13      - cost_generic.F : use spzeroloc rather than hard-coded -9999,
14        and exploit the above functions leading to more compact code.
15      - ecco_check.F, ecco_readparms.F : bring logic up to date (using_tpj,
16        using_ers, using_gfo, using_mdt is now only defined within gencost)
17    o pkg/ecco: extend generic cost capabilities
18      - pkg/ecco : added 3D gencost (ALLOW_GENCOST3D), added gencost
19        capabilities via gencost_preproc, gencost_posproc, gencost_nrecperiod,
20        gencost_outputlevel, gencost_scalefile arguments to cost_generic
21      - pkg/ecco/cost_genread.F (new) : interface between cost_generic
22        and active_read, making room for gencost_preproc to take effect.
23        Added preproc code ('climmon ') to replace GENERIC_BAR_MONTH.
24      - pkg/ecco/cost_generic.F :
25        compute and store misfit maks*(model-data) in localdif that is
26        then used in cost and for output, output misfit if outlev.GT.0
27      - pkg/ecco/cost_averagesfields.F : depend on gencost_barskip
28        rather gencost_barfile for deciding whether to write barfile
29      - pkg/ecco/ecco_cost_driver.F : extract call to cost_profiles from cost_hyd
30      - pkg/ecco/ecco_cost_init_fixed.F : extract gencost weights from
31        ecco_cost_weights, re-activate ecco_summary, determine gencost_barskip
32      - pkg/ecco/ecco_summary.F : report gencost variables
33      - pkg/ecco/cost_gencost_customize.F : treat case of scatterometer costs
34    o pkg/sea/SEAICE_OPTIONS.h : add ALLOW_COST_ICE, ALLOW_SEAICE_COST_SMR_AREA
35    o pkg/ecco: internal re-organization
36      - resolve un-necessary dependancies within pkg/ecco and to pkg/ctrl
37        (rm includes of optim.h and ctrl.h, replace optimcycle with eccoiter,
38        mv relevant variables definition from ecco_cost.h to ecco.h,
39        make sure gencost routines only include ecco.h)
40      - throughout : add missing CCP switches, rm unused variables,
41        and rm un-necessary CPP switches
42      - throughout gencost routines : replace modelstartdate with
43        gencost_startdate when needed
44      - cost_bp_read.F : use arguments, instead of common blocs
45        so that it can be used also by (new) cost_gencost_bpv4.F
46      - ecco_init_varia.F : initialize RHOsumGlob_0, VOLsumGlob_0
47      - ecco_phys.F : compute etanFull
48      - ecco_readparms.F : rename using_topex as using_tpj, add
49        bpv4-grace to gencost list, initialize added parameters
50      - ecco_summary.F : include SIZE.h needed for augmented ecco.h
51    
52    checkpoint65e (2014/09/28)
53    o pkg/obcs:
54      - replaced the just-added CPP options with run-time variables
55        (see pkg/obcs/OBCS_PARAMS.h for details)
56    o pkg/obcs:
57      - add additional CPP options for sponge boundary layers
58        (see pkg/obcs/OBCS_OPTIONS.h for details)
59    o pkg/atm_phys:
60      - implement simple (obliquity only, assuming circular planet orbit)
61        seasonal cycle for incoming insolation ; used when run-time parameter
62        "select_incSW" is set to 1 ; by default (=0), uses old unchanged formula.
63    o pkg/exf, pkg/ecco, pkg/ctrl:
64      - add ctrlUseGen and .NOT.ctrlUseGen exclusive brackets
65      - activate gentim2d for xx_atemp,xx_aqh,xx_swdown,xx_lwdown,xx_precip
66      - implement gentim2d for xx_tauu, xx_tauv
67    o pkg/ctrl, pkg/ecco :
68      - fix and complement the generic controls implementation
69    o pkg/exf/exf_getclim.F, exf_getffields.F, exf_getsurfacefluxes.F,
70        pkg/shelfice/shelfice_thermodynamics.F,
71        verification/hs94.1x64x5/code_ad/ctrl_map_gentim2d.F,
72        verification/hs94.1x64x5/code_oad/ctrl_map_gentim2d.F :
73      - add weight in CTRL_GET_GEN calls
74    o pkg/ctrl :
75      - ctrl_get_gen.F : add weight as input parameter, and apply
76        it directly rather than using smooth_correl2Dw (to be retired).
77      - ctrl_map_gentim2d.F : add wgentim2d in CTRL_GET_GEN call
78    o pkg/ctrl :
79      - introduce run time switch ctrlUseGen (in ctrl.h, ctrl_check.F,
80        ctrl_init_variables.F, ctrl_readparms.F, ctrl_summary.F)
81      - re-activate ctrl_summary (call in ctrl_init.F)
82    o pkg/ctrl/ctrl_cost_gen.F :
83      - fix CCP brackets, remove un-necessary myiter, mytime
84    o pkg/ecco, pkg/ctrl :
85      - remove cost_genctrl.F (now pkg/ctrl/ctrl_cost_driver.F)
86      - remove cost_forcing_gen.F (now pkg/ctrl/ctrl_cost_gen2d.F)
87      - add ctrl_cost_driver.F (replaces pkg/ecco/cost_genctrl.F)
88      - add ctrl_cost_gen2d.F (replaces pkg/ecco/cost_forcing_gen.F)
89    
90    checkpoint65d (2014/09/15)
91    o pkg/ctrl/CTRL_GENARR.h, ctrl_readparms.F :
92      - add xx_genarr2d_bounds,xx_genarr3d_bounds,
93        xx_genarr2d_numsmooth, xx_genarr3d_numsmooth
94    o pkg/ctrl/ctrl_map_ini_genarr.F :
95      - remove compilation failure
96      - replace hard coded example
97      - use ctrl_map_ini_gen2D, 3D
98    o pkg/ctrl/ctrl_pack.F, ctrl_unpack.F :
99      - on/off switch based upon xx_genarr2d_weight,3d
100    o src/packages_init_variables.F :
101      - regroup pkg/estimation calls
102      - remove CTRL_MAP_INI, CTRL_MAP_INI_ECCO
103        (moved to ctrl_init_variables)
104    o cost/cost_init_varia.F :
105      - remove ecco_cost_init_varia
106        (moved to ecco_init_varia)
107    o ctrl/ctrl_init_variables.F :
108      - add CTRL_MAP_INI, CTRL_MAP_INI_ECCO
109      - add CTRL_MAP_INI_GENARR, SEAICE_CTRL_MAP_INI
110    o ctrl/ctrl_map_ini.F :
111      - remove ctrl_map_ini_genarr, seaice_ctrl_map_ini
112        (moved to ctrl_init_variables)
113    o ctrl/ctrl_map_ini_ecco.F :
114      - remove ECCO_PHYS (mv to ecco_init_varia)
115      - remove seaice_ctrl_map_ini (mv to ctrl_init_variables)
116    o ecco/ecco_ad_diff.list :
117      - add ecco_init_varia.f
118    o ecco/ecco_init_varia.F
119      - new routine
120    o pkg/streamice:
121      - move call to STREAMICE_INITIALIZE_PETSC from the_model_main.F
122        to streamice_init_fixed.F ; fix setting of STREAMICEisOn.
123      - from model/src, only call pkg/streamice routines if useStreamIce is TRUE.
124    o pkg/generic_advdiff:
125      - fix bug causing negatives in GAD_SMOLARKIEWICZ_HACK, introduced 8/8/2014.
126    o pkg/exf:
127      - exf_getffields.F : add xxg_atemp, xxg_aqh, xxg_swdown, xxg_lwdown,
128         xxg_precip capability
129      - exf_wind.F : no need for ALLOW_WSPEED_CONTROL cpp switch
130    o pkg/ctrl:
131      - ctrl_pack.F, ctrl_unpack.F : omit (un)packing of undefined xx_gentim2d
132    o model/src/load_fields_driver.F :
133      - move call to CTRL_MAP_GENTIM2D ahead of BULKF_FIELDS_LOAD, EXF_GETFORCING
134        so xx_gentim2d can be applied to e.g. exf fields in a timely manner.
135    o OpenAD verification experiments:
136      - Include explicitly AUTODIFF_OPTIONS.h, COST_OPTIONS.h, and CTRL_OPTIONS.h
137        in src files (to enable to skip the ECCO_CPPOPTIONS.h);
138        for now, only in pkgs used in OpenAD verification experiments.
139      - Change all except one (halfpipe_streamice) OpenAD experiments to use pkg
140        specific option file (AUTODIFF_OPTIONS.h, COST_OPTIONS.h & CTRL_OPTIONS.h)
141        instead of using ECCO_CPPOPTIONS.h (with all relevant options in it).
142        This applies to both TAF (*/code_ad/) and OpenAD (*/code_oad/) tests.
143    o OpenAD verification tests:
144      - finish removing ALLOW_AUTODIFF_OPENAD (replaced by ALLOW_OPENAD);
145      - finish replacing ALLOW_AUTODIFF_TAMC by ALLOW_AUTODIFF (except for
146        tape/storage which are specific to TAF/TAMC) in pkgs used in OpenAD exp.
147      - leave ALLOW_AUTODIFF_TAMC undef in OpenAD verification tests (*/code_oad/)
148        and remove local copy of "tamc.h" (needed only if ALLOW_AUTODIFF_TAMC).
149    o model/src & generic_advdiff:
150      - change hard-coded loop-range in S/R APPLY_FORCING_T/S to set T & S
151        forcing over 0:sNx+1, 0:sNy=1 (instead of just 1:sNx,1:sNy): Model
152        dynamics requires valid tracer forcing only over tile interior but, for
153        some diagnostics, may need to extend it over 1 point in tile halo region.
154      - in gad_calc_rhs.F, update calls to gmredi_x/ytransport to get valid
155        tendency over i,j_Min,Max range. This allows to simplfy i,j_Min,Max
156        setting in temp/salt/ptracer_integrate.F
157    o pkg/dic:
158      - multiply tracer tendencies by maskInC (if ussing OBCS) before updating
159        gchem tracers: this allows to skip the 2nd call to OBCS_APPLY_PTRACER
160        in gchem_forcing_sep.F
161    o pkg/autodiff & obcs:
162      - add storage of current OB values for U & V (was already done for T & S).
163    
164    checkpoint65c (2014/08/30)
165    o pkg/dic:
166      - take out of dic_atmos.F the initialisation part (corresponding to istate=0)
167        and move it to new S/R DIC_INI_ATMOS ; also simplify the dependencies for
168        AD compilers (but still a Pb with multi-threading and Ajoint dependencies).
169    o verification:
170      - new experiment testing OBCS and DIC pkgs, using params & output from
171        tutorial_global_oce_biogeo but limited to a sub-domain around Drake
172        passage: take OBCS from the last year of a 2 yrs simulation and initial
173        conditions from t=1.yr while keeping the same forcing.
174    o model/src:
175      - when allowFreezing=T, only reset below freezing initial Temp to Tfreezing
176        (at any k) if checkIniTemp is not set to FALSE (default checkIniTemp=T).
177    o pkg/diagnostics (Stats-Diags):
178      - re-write S/R DIAGSTATS_CALC (more similar to TARGET_NEC_SX part) to:
179        a) refine region where stats are computed, excluding where arrhFac=0 ;
180        b) fix missing interior mask (use with OBCS) in 3-D fields statistics;
181        c) extend regional stats over the region edges (for U or V pt location).
182    o pkg/gchem:
183      - add a (2nd) call to OBCS_APPLY_PTRACER in gchem_forcing_sep.F (needed since
184        pkg/dic is currently changing/updating ptracers values beyond the OB).
185    o verification (hs94):
186      - convert Held & Suarez external_forcing.F (from hs94.cs, with Sigma-coords
187        bits) to apply_forcing.F and undef USE_OLD_EXTERNAL_FORCING in experiments
188        hs94.cs-32x32x5 and tutorial_held_suarez_cs ; also use the same version of
189        apply_forcing.F in 2D hs94 (fwd, ad & oad) but keep LatLon hs94 unchanged.
190    o pkg/ptracers:
191      - implement Adams-Bashforth on pTracers (instead of on tracer tendency),
192        switched on by setting PTRACERS_doAB_onGpTr=F (default set to doAB_onGtGs)
193      - change exp4 secondary test (input.nlfs) to test AB on T & S & pTracer
194        with AB-2 code (so that it get tested).
195    o model/src:
196      - allow to apply Adams-Bashforth on Temp & Salt (instead of on gT,gS)
197        with AB-2 code (previously only available with AB-3 code).
198        Also move the code (call to ADAMS_BASHFORTH S/R) form thermodynamics.F
199        to temp/salt_integrate.F (since the 2nd part of gt/sNm1 update is done
200        there, by calling CYCLE_AB_TRACER).
201    o pkg/generic_advdiff:
202      - change Tracer argument (drop bi,bj indices) in S/R GAD_CALC_RHS,
203        GAD_C2_ADV_R, GAD_U3_ADV_R, GAD_C4_ADV_R, GAD_DIFF_R, GAD_BIHARM_R
204        + also in GMREDI_X/Y/RTRANSPORT ; and update corresponding calls in
205        S/R temp/salt/ptracers_integrate.F
206    o model/src & pkg/ptracers:
207      - remove common block variables gT,gS (in DYNVARS.h), except when
208         USE_OLD_EXTERNAL_FORCING is defined; update TAF storage accordingly.
209      - remove common block variable gPtr.
210    o model/src & pkgs:
211      - change gTracer (and/or tracer) argument (drop bi,bj indices) in S/R
212         ADAMS_BASHFORTH(2&3), CYCLE_(AB_)TRACER, FREESURF_RESCALE_G,
213         IMPLDIFF, SOLVE_TRIDIAGONAL & _PENTADIAGONAL, GAD_SOM_ADVECT,
214         GAD_ADVECTION, GAD_CALC_RHS, GAD_IMPLICIT_R, TIMEAVE_CUMUL_DIF_1T
215      + change accordingly all calling S/R.
216      - use local temperature/salinity/ptracer tendency array (without bi,bj)
217        in S/R temp/salt/ptracers_integrate.F
218    o pkg/seaice:
219      - move computation of stress contributions to rhsU/V in s/r seaice_lsr
220        to separate s/r seaice_lsr_rhsu/v in order to be able to re-use code
221      - make u/vIceC local variables if SEAICE_CGRID is defined only to be used
222        in seaice_lsr
223      - seaice_lsr.F: make local 4D arrays UXX, VYY, etc 2D
224        in s/r seaice_lsr_calc_coeffs
225    o pkg/mdsio:
226      - in MDS_READ/WRITE_FIELD, stop if file-name (+prefix) is too long
227        (e.g., > MAX_LEN_MBUF -90 ) or, in INI_MODEL_IO, if mdsioLocalDir is
228        too long (e.g., > MAX_LEN_FNAM/2 )
229    
230    checkpoint65b (2014/08/12)
231    o pkg/matrix:
232      - pass, as argument, updated tracer field to S/R MATRIX_STORE_TENDENCY_EXP
233    o model/src:
234      - fix initialisation of geothermalFile; compile geothermal-flux code in
235        natl_box verification experiment.
236    o model/src & pkg/down_slope:
237      - push the k loop inside S/R TIMESTEP_TRACER (now called outside the k loop).
238      - in dwnslp_apply.F, update tracer tendency instead of the future tracer
239        field and call S/R DWNSLP_APPLY before TIMESTEP_TRACER; this affects
240        results at machine truncation level: update output of experiments
241        global_ocean.90x40x15.dwnslp (FWD) and lab_sea.noseaicedyn (AD).
242    o pkg/diagnostics (Stats-Diags):
243      - do not cumulate the full volume when DIAGNOSTICS_FILL is
244        called with bibjFlg < 0 (no increment of the counter for 2D/3D diag);
245        This fix the mean statistics when DIAGNOSTICS_FILL is called multiple
246        times (but Min,Max and StD are still wrong).
247    o model/src:
248      - add geothermal flux forcing: read in ini_forcing.F as time-constant
249        field "geothermalFlux" applied in S/R APPLY_FORCING_T (apply_forcing.F)
250    o model/src:
251      - move CYCLE_TRACER calls from tracers_correction_step.F to temp/salt/ptracer
252        _integrate.F so that, when leaving S/R THERMODYANMICS, theta,salt and pTrac
253        arrays are already updated while adjustments (filters, conv.adjustment) are
254        still applied later, in S/R TRACERS_CORRECTION_STEP.
255    o model/src:
256      - store in common bloc array "rhoInSitu" the virtual potential temperature
257        anomaly that is used to compute geopotential: this make the atmos code
258        more similar to ocean code which already uses rhoInSitu in calc_phi_hyd.F
259    o pkg/seaice/seaice_lsr.F
260      - rename integer variable ilcall to ipass (that's what it is called
261        in the residual diagnostics
262      - change time stepping for NPSEUDOTIMESTEP > 2 (does not change the
263        default) for improved non-linear convergence of the first few steps
264      - adjust a few comments and add new ones to explain some of the store
265        directives
266    o pkg/generic_advdiff (& ptracers):
267      - re-work the code to check for valid advection scheme and for minimum
268        size of overlap (now stored in local common bloc in gad_advscheme.F)
269    o pkg/seaice: another attempt to make the adjoint work for sea ice dynamics
270      - re-initialize more variables in seaice_lsr: u/vIceC, u/vIceNm1
271      - add an auxilliary variable "bet" and fix store directives and keys in
272        seaice_lsr_tridiagu/v, this seems to do the trick (i.e. more or
273        less exact gradients in my tests); but there are still
274        recomputation warning (although gradients are sort of OK), when
275        SEAICE_LSR_VECTORIZE is not defined, so this flag and
276        SEAICE_LSR_VECTORIZE_ZEBRA are recommended for efficiency.
277      - update verification experiments lab_sea.
278      - change some comments in S/R seaice_calc_viscosities
279    o model/src:
280      - if staggerTimeStep=T, always apply exchange to velocity field in
281        do_stagger_fields_exchanges.F instead of in do_fields_blocking_exchanges.F
282        (independent of using multi-dim advection or not); no effect on FWD run
283        but affects AD results (at machine truncation level): update output of
284        experiment 1D_ocean_ice_column (ad: 12 digits), hs94.1x64x5 (ad,oad: 13.d)
285        and isomip (oad: 12.d).
286    o pkg/generic_advdiff:
287      - stop if doAB_onGtGs is set to FALSE but ignored
288      - refine warning related to stability of tracer time-stepping
289        regarding internal wave dynamics.
290      - setting of AdamsBashforth_T,S when doAB_onGtGs=F: remove condition
291        on staggerTimeStep & implicitIntGravWave (will now get a warning
292        if potentially unstable).
293    o pkg/kl10:
294      - add new pkg "kl10" for mixing due to internal wave breaking, from
295        http://www.sciencedirect.com/science/article/pii/S1463500310000144
296        (contribution from Jody Klymak), tested in verification experiment
297        verification/internal_wave/input.kl10/
298    o isomip experiment:
299      - test pkg/shelfice with Non-Lin Free-Surf in one of the FWD set-up
300        (input.htd) and update the output.
301    o cd_code experiments:
302      - use default cd_code options (#undef CD_CODE_NO_AB_MOMENTUM &
303        #undef CD_CODE_NO_AB_CORIOLIS) in experiments: cfc_example (fwd)
304        global_ocean.90x40x15 (ad & oad) and OpenAD (ad & oad) and
305        update the corresponding output.
306    o pkg/seaice:
307      - reduce the number of include files and store directives in
308        S/R seaice_lsr_tridiagu/v
309      - change the order of loops in one case in S/R seaice_lsr_tridiagv
310        (only for SEAICE_VECTORIZE_LSR_ZEBRA defined), which allows me to
311        get rid off one store directive (a TAF bug?)
312      - add one more instance of ifdef SEAICE_VECTORIZE_LSR_ZEBRA in
313        S/R seaice_lsr_tridiagv to change the loop range for consistency
314      - remove ilcall, m from parameter list of S/R seaice_lsr_tridiagu/v
315      - fix a bug that affects the JFNK solver: replace sNx/y by i/jMax in
316        S/R seaice_lsr_tridiagu/v (requires update of
317        offline_exf_seaice/input.dyn_jfnk)
318    
319    checkpoint65a (2014/07/27)
320    o model/src:
321      - Non-Lin Free-Surf in p/z coords: allows hFacW,S to be larger than
322        surrounding hFacC=1 @ edge of a step with different kSurfC on either side
323        (topo in p-coords, ice-shelf in z-coords); update output of experiments
324        tutorial_global_oce_in_p and isomip (both AD and OpenAD output).
325    o model/src:
326      - collect momentum forcing tendency into local 2-D array (passed as argument
327        to apply_forcing S/R); this simplifies mom. Forcing diagnostics and CD_CODE
328        parts in timestep.F (without CD_CODE_NO_AB_MOMENTUM defined = the default);
329        affects results at machine truncation level (e.g., if using OBCS_SPONGE).
330      - collect T & S forcing tendency into local 2-D array (passed as argument to
331        apply_forcing S/R); add 3-D diagnostics for temp & salt forcing tendency.
332        affects results at machine truncation level (e.g., ocean: if using
333        SHORTWAVE_HEATING ; atmos: if using FrictionHeating or (atm_Rq<>0) moist
334        correction due to vertical advection).
335      - update output of experiments: fizhi-cs-32x32x40 (13 digits),
336        global_ocean.cs32x15 (fwd: icedyn, seaice, thsice, all 3 @ 11d; adm & tml:
337        seaice_dynmix & thsice, fwd grd @ 3 & 8), hs94.1x64x5 (ad grd @ 13),
338        obcs_ctrl (ad & fwd grd @ 12 & 7).
339    o pkg/ptracers & diagnostics:
340      - use ptracers (short) name (instead of long one) to make ptracers diagnostics
341        title (to avoid some unexpected truncation); sort out ptracers diags units.
342      - collect ptracer forcing tendency into local 2-D array (passed as argument
343        to apply_forcing S/R); add 3-D diagnostics for ptracers forcing tendency.
344    
345    checkpoint65 (2014/07/18)
346    o pkg/fizhi:
347      - add parenthesis around fizhi tendencies in fizhi_tendency_apply.F: this
348        affects results at machine truncation level. Update output of experiments
349        fizhi-cs-32x32x40 (12 digits for cg2d) & fizhi-cs-aqualev20 (13 digits).
350    o pkg/seaice: more clean up
351      - rename TAF common block tapes to be more consistent and remove
352        unnecessary duplicates
353      - add store directives to remove more recomputations, but use smaller
354        tapes (and adjust keys) when SEAICE_LSR_ADJOINT_ITER is undefined.
355        The idea behind this flag is to reduce the memory footprint when the
356        adjoint of the LSR is not required. As of now, defining the flag
357        SEAICE_LSR_ADJOINT_ITER increases 4 common block tapes for 2D field by
358        a factor of SOLV_MAX_FIXED (=500 by default in SEAICE_SIZE.h).
359        For experiment offline_exf_seaice, this means on a linux box with gfortran
360        nearly a factor of 10 (but keep in mind there is mostly seaice code in
361        this experiment):
362        > size mitgcmuv_ad
363        text    data        bss     dec        hex  
364        5100659 1216  220458952  225560827  d71c8fb
365        5339425 1200 1868783272 1874123897 6fb4dc79 (SEAICE_LSR_ADJOINT_ITER)
366        but only a moderate increase of 36% for global_ocean.cs32x15:
367        text    data        bss     dec        hex
368        6695027 1648 1014578664 1021275339 3cdf6ccb
369        6695203 1648 1382505320 1389202171 52cd8afb (SEAICE_LSR_ADJOINT_ITER)
370      - note: there are still recomputations in global_ocean.cs32x15 and
371        offline_exf_seaice and the gradient agreement changes (gets a
372        little worse) for global_ocean.cs32x15 (-> update output_adm.seaice.txt)
373      - in general, the AD gradients still are wrong
374    o OpenAD
375      - clean up code_oad/ directories somewhat by moving files
376        dontCompile, dontTransform, keepOriginal to OAD_support/
377    o model/src:
378      - using MOM fluxform and Non-Lin Free-Surf with momDissip_In_AB=F
379        (not currently tested): add dissipation terms before NLFS rescaling of
380        tendencies (previously done after).
381    o pkg/diagnostics:
382      - write stats-diags in ascii file with more digits (same as in monitor).
383    o pkg/down_slope:
384      - drop the bi,bj dimension of argument recip_hFac in S/R DWNSLP_APPLY; with
385        NLFS (not tested), use new recip_hFac value in order to conserve tracer.
386    o model/src:
387      - new file "apply_forcing.F" containing all the code previously in
388        external_forcing.F, but with new argument list: pass, as new argument,
389        the current level tendency array to update (instead of a direct update
390        of the common bloc array). Change the corresponding calls.
391      - add CPP option USE_OLD_EXTERNAL_FORCING (default is undef) to use
392        EXTERNAL_FORCING_U,V,T,S subroutines (for backward compatibility).
393    o pkg/seaice/seaice_lsr, a little bit of clean up
394      - rearrange some code blocks, so that now all calculations for
395        setting up the right-hand-sides done within one single block
396        (I find that easier to read and understand)
397      - rearrange freedrift-code to reduce the number of ifdefs
398      - adjust some indentations and comments
399    
400    checkpoint64z (2014/07/10)
401    o model/src and several pkgs:
402      - change argument list of all S/R called from external_forcing.F and
403        called from ptracers_forcing.F (renamed to ptracers_apply_forcing.F)
404        to pass, as argument, the current level tendency array to update
405        (instead of a direct update of the common bloc array).
406      - change also (in the same way) argument list of PTRACERS_APPLY_FORCING;
407      - rename taueddy_external_forcing.f to taueddy_tendency_apply.F
408    o pkg/seaice/seaice_lsr.F
409      - always initialize local arrays in seaice_lsr_tridiagu/v
410      - add more local tapes to seaice_lsr_tridiagu/v
411      - move storing u/vice(:,:,bi,bj) out of seaice_lsr_tridiagu/v, but
412        keep it in bi/bj loop; this seems to be essential
413      - gradients are still wrong but only by 4-7 orders of magnitude
414        instead of 15 orders of magnitude, lab_sea improves a little
415    o pkg/seaice
416      - (pkg/autodiff) remove storing/restoring of seaiceMaskU/V that
417        generates unnecessary code in seaice_lsr_ad
418      - add more store directives in seaice_lsr to avoid unnecessary code
419        in seaice_lsr_ad
420      - exclude some residual computations in seaice_lsr when
421        ALLOW_AUTODIFF_TAMC is defined in order to avoid unnecessary code
422        in seaice_lsr_ad
423      - add more storing, a new tape (model/src/the_main_loop.F) and
424        another key for SEAICE_LSR_VECTORIZE_ZEBRA (the local keys ilockey
425        and klockey should be checked by a specialist)
426      - modify ( define SEAICE_VECTORIZE_LSR and SEAICE_LSR_ADJOINT_ITER )
427        and update lab_sea after previous changes in pkg/seaice below
428    o pkg/autodiff:
429      - introduce useSmoothCorrel2DinAdMode, SEAICEapproxLevInAd, and
430        viscFacInAd : run time parameters allowing for adjoint switches
431        note : logic for useSmoothCorrel2DinAdMode is in ctrl_readparms.F
432    o pkg/ecco:
433      - introduce cost_gencost_boxmean.F that computes a box mean
434        temperature (for use in adjoint sensitivity studies).
435    o model/src/set_defaults.F : initialize viscFacAdj to 1.
436    o pkg/mom_common/mom_calc_visc.F:
437      - ifdef ALLOW_AUTODIFF then include viscFacAdj factor.
438    o pkg/seaice/seaice_summary.F:
439      - statement for SEAICEadjMODE now in autodiff_readparms.F
440    o pkg/seaice:
441      - remove some store directives and add new ones in an effort to get
442        finally rid off the recomputation warnings. This is successful
443        when SEAICE_VECTORIZE_LSR ***and*** SEAICE_LSR_ADJOINT_ITER are
444        defined (i.e. no extensive recomputation warnings left), but there
445        are still too many recomputations on the solver iteration level
446      - define SEAICE_VECTORISZE_LSR in offline_exf_seaice/code_ad/SEAICE_OPTIONS.h
447      - move definition of MPSEUDOTIMESTEPS into TAMC-block in
448        SEAICE_SIZE.h
449      - add a store directive in S/R seaice_calc_viscosities
450    o pkg/seaice (ITD code):
451      - fix definition of Hlimit for multi-threaded case
452      - use double precision arithmetic to compute Hlimit: this affects results;
453        update output of experiment seaice_itd.
454    o replace content of verification/seaice_itd
455      - instead of a 1D column use the configuration of offline_exf_seaice
456        to test the ice thickness distribution code with ridging
457      - this is a first shot at this experiment
458      - change of some defaults of ridging parameters SEAICEhStar (from
459        100 to 25) and SEAICEmuRidging (from 5 to 3) in seaice_readparms.F
460        and lot of new comments.
461    
462    checkpoint64y (2014/06/20)
463    o pkg/seaice/seaice_reg_ridge.F:
464      - modify the regularization of very small volumes of ice; only check
465        total volume HEFF, and do not apply correction to individual ice
466        classes because that leads to funny patterns in the heat and fw-fluxes
467        into the ocean. Adjust seaice_itd/results/output.txt
468      - replace nITD by SEAICE_multDim in loop-ranges
469    o pkg/exf:
470      - add code to process the case field period = -12. with UV interpolation.
471      - move debug print (formerly active when exf_verbose=T) from EXF_getFFieldRec
472        into S/R that calls it (i.e., exf_set_gen.F, exf_set_uv.F & obcs_exf_load.F)
473    o verification/global_with_exf:
474      - switch all fields period to -12. (was previously untested) in input/data.exf
475        (but keep secondary test ".yearly" unchanged); update the reference output.
476    o pkg/cal:
477      - new calendar type "noLeapYear" for 365 days calendar without any leap year.
478    o pkg/exf:
479      - new integer parameter "exf_debugLev" (default set to main model debugLevel)
480        to replace logical switch "exf_verbose"
481      - report in STDOUT when loading a new record (if exf_debugLev >= 3)
482    o pkg/sbo:
483      - update from Katherine Quinn: evaluate mass directly from density and SSH
484        (budget using Finite Volume method) instead of from bottom pressure.
485      - allow testreport to collect few selected SBO output ; tested in exp.
486        global_ocean.90x40x15 (after updating the results, to include SBO output).
487      - fix some multi-threading issues (in output part).
488    o model/src & most packages:
489      - always call {PKG}_READPARMS even if corresponding use{PKG}=F;
490      - in {PKG}_READPARMS, in case use{PKG}=F: add a call to new S/R
491        PACKAGES_UNUSED_MSG to print a weak warning when parameter file
492        "data.{pkg}" exist ; and leave the S/R (return) just after.
493      - more standard LAND pkg interface (land_init_fixed.F, land_check.F).
494        + call LAND_READPARMS from packages_readparms.F
495    o pkg/seaice:
496      - remove code that resets useThSice in S/R seaice_readparms and
497        replace it by a warning in S/R seaice_check
498      - remove parameter MULTDIM, replace with nITD and runtime
499        parameter SEAICE_multDim (still hard-wired to nITD if
500        SEAICE_ITD is defined)
501    
502    checkpoint64x (2014/05/24)
503    o verification/lab_sea:
504      - update adjoint and TLM output following changes to pkg/salt_plume
505      - un-do the update after putting back local recip_Cp in few places.
506    o pkg/salt_plume: modifications by An Nguyen:
507      - add capability to do brine rejection (salt-plume) as function of
508        volume+tracers (instead of only salinity tracer).
509      - conserve volume by exchanging volume from each kLev to above to
510        accommodate in-coming brine volume
511      - store surface and klev exchanged fraction + volume in 4 new 3-d arrays
512      - switch KPP surf buoyancy due to brine forcing to 3-d
513        (3 more 3-d arrays, 2 for SPforcing[T,S], 1 for boplume)
514      - add salt_plume_volfrac, salt_plume_apply, salt_plume_tendency_apply_t
515      - unrelatedly, also add ad-hoc capability to vary salt_plume scheme
516        in East/West Arctic.
517    o pkg/sbo:
518      - incorporate modifications from Katherine Quinn to enable the use of sbo
519        pkg in ECCO-v4 set-up ; remove SBO-TimeAve output ; add monitor-like
520        output for future testreport verification (unfinished).
521    o pkg/atm_phys:
522      - change diagnostics (AtPh_Trf & AtPh_Qrf) of DARGAN_BETTSMILLER S/R:
523        skip the reseting of t_ref & q_ref to initial t & q ; this preserve the
524        output of S/R CAPECALCNEW (Parcel temp & q) for diagnostics.
525    o pkg/seaice
526      seaice_calc_ice_strength.F: modify expression to avoid divisions
527        (affects truncation)
528      seaice_do_ridging.F: clean up the insectarium
529      - fix a bug that was compensated by areaScaling (-> remove areaScaling code)
530      - added SEAICEsnowFracRidge to redistributed snow (2nd bug)
531      - set closing/openingRate to zero where no extra iteration is need (3rd bug)
532      - add some debugging information and error messages (warnings)
533    o model/src: modifications relatd to atmosphere p*:
534      - Switch to more accurate p* coordinate slope term (calc_grad_phi_hyd.F)
535      - With p* or Sigma-P, use constant reference Pot.Temp (thetaConst) instead
536        of vertical profile tRef in geopotential background and anomaly.
537      - Acount for true p* correction in theta <-> T conversion in pkg/aim_v23
538        and pkg/atm_phys.
539      - Update FWD output of experiments: aim.5l_cs (x2), fizhi-cs-32x32x40,
540        fizhi-cs-aqualev20, fizhi-gridalt-hs, tutorial_held_suarez_cs, cpl_aim+ocn.
541    o pkg/seaice: fix a bug in seaice_prepare_ridging.F, forgot a sqrt
542    o pkg/ptracers: compute ptracer source/sink due to linear free surface.
543        not used right now, but can be used in BGC packages to fix conservation.
544    o pkg/dic, pkg/gchem: move tracer_meanarea to gchem, so it can be used by
545        other packages too.
546    o pkg/seaice/seaice_calc_ice_strength.F: replace SEAICE_rhoSnow by
547        SEAICE_rhoIce in the Rothrock (1975)-type strength calculations (bug fix)
548    o model/src:
549      - since we have several heat capacity (even in model/src), define "recip_Cp"
550        as local variable (no longer in common block) to avoid any confusion.
551      - add thetaConst in PARAMS.h (to be used with pStar or sigma-P coords).
552    o pkg/exf:
553      - from Jeff Scott: add option (#define EXF_CALC_ATMRHO) to calculate local
554        air density as function of air Temp, Humidity and atm pressure.
555    
556    checkpoint64w (2014/05/02)
557    o verification:
558      - update output_adm.txt files for experiment global_ocean.cs32x15 (seaice &
559        seaice_dynmix) and lab_sea (primary test & noseaicedyn): moving/changing
560        code from seaice_growth.F & seaice_advdiff.F to new ridging routines
561        seaice_reg_ridge.F seaice_do_ridging.F affects AD gradient
562        (down to 8-7 matching digits for global_ocean and 5-6 for lab_sea).
563    o model/src: for atmosphere in p* coords:
564      - store factor rStarFacC**atm_kappa (= pStarFacK) in common block
565      - implement more accurate p* coordinate slope term (in calc_grad_phi_hyd.F),
566        but not yet activated.
567    o pkg/seaice: fix restart problem for ITD with new ice strength parameterisation:
568      - move computation of opnWtrFrac = 1-AREA to before computing ice strength
569      - this changes the results (but not for any verification experiment, because
570        none tests this), but avoids having an extra field in the restart files
571    o pkg/seaice: remove global variable TICE (not needed)
572      - replace by TICES or local variable where necessary (cost_seaice_test,
573        seaice_diagnostics_state)
574      - move copying TICE to TICES from seaice_check_pickup to seaice_read_pickup
575      - use specific read/write routines for reading and writing individual leves
576        of a multilevel field
577    o pkg/ctrl & model/inc:
578      - move additional anomaly fields of control vars (related to options:
579         ALLOW_KAPGM_CONTROL, ALLOW_KAPREDI_CONTROL and ALLOW_BOTTOMDRAG_CONTROL)
580        from DYNVARS.h into new header file: CTRL_FIELDS.h
581    o pkg/seaice: some small modifications to the ridging code
582      - make fw2ObyRidge a global variable and add the freshwater flux to
583        seaice_growth
584      - pass actual thickness from seaice_prepare_ridging, so that it is
585        computed only in one place and compute it in the same way as in
586        seaice_growth
587      - initialise more fields in seaice_do_ridging that where cause floating
588        point exceptions over land
589    o pkg/seaice: preparations for ridging code and first real ridging code
590      - move most of "PART 1" of S/R seaice_growth into a new and separate
591        S/R seaice_reg_ridge that will both regularize the state variable after
592        advection call the actual ridging routine;
593      - requires to make 5 fields global fields: d_HEFFbyNEG,d_HSNWbyNEG,
594        d_AREAbyRLX,d_HEFFbyRLX,saltFluxAdjust;
595      - remove ridging code from seaice_advdiff
596      - clean up remaining part 1 of seaice_growth in an attempt to make it
597        more readable (this is probably subjective)
598      - call seaice_itd_redist once in the initialisation phase to have the initial
599        conditions in the correct category
600      - finally: add new ridging routine for ITD code
601    
602    checkpoint64v (2014/04/11)
603    o pkg/ecco:
604      - add runtime parameters mdt[start,end]date[1,2]
605      - rename variable "tpmean" as "mdt" and "topexmeanfile" as "mdtdatfile"
606    o pkg/seaice:
607      - make deltaC a global variable, so that it can be used in ridging code
608      - first step towards ridging: introduce new routines that compute
609        ice strength based on ridging parameters
610      - add diagnostic for HSNOWITD
611      - add opnWtrFrac as a global variable (required for ridging scheme)
612    o pkg/salt_plume + pkg/seaice/seaice_growth.F
613      - add SALT_PLUME_IN_LEADS flag to activate pkg/salt_plume only when ice
614        AREA exceeds a threshold (code contributed by I.Fenty in 2011)
615    o verification/hs94.1x64x5:
616      - leave ALLOW_AUTODIFF_TAMC undefined in code_oad/AUTODIFF_OPTIONS.h
617      - do not use ECCO_CPPOPTIONS.h anymore for TAF & OpenAD Adjoint tests.
618    o autodiff:
619      - Start to include explicitly AUTODIFF_OPTIONS.h, COST_OPTIONS.h,
620        and CTRL_OPTIONS.h in src files (to enable to skip the ECCO_CPPOPTIONS.h)
621        For now, only in pkgs used in verification/hs94.1x64x5.
622      - Replace ALLOW_AUTODIFF_TAMC by ALLOW_AUTODIFF (except for tape/storage
623        which are specific to TAF/TAMC).
624      - Replace ALLOW_AUTODIFF_OPENAD by ALLOW_OPENAD:
625        since ALLOW_OPENAD is defined in PACKAGES_CONFIG.h (any time pkg/openad
626        is compiled), this simplifies/reduces which *_OPTIONS.h file to include.
627      - OpenAD: change Makefile to generate the appropriate AD_CONFIG.h when
628        building mitgcmuv_ad (make adAll).
629    o pkg/ecco:
630      - cost_gencost_seaicev4.F:
631         reformulate proxy cost as function of sst and local param SEAICE_freeze
632         change cost names from siv4-[sst,vol] to siv4-[deconc,exconc]
633      - add stop statement if old names siv4-[sst,vol] are used
634      - add snapshots + cost reports for atmospheric longwave
635      - remove factor 0.1 in front of wtau[u,v]
636      - replace never used flag ALLOW_TMI_COST_CONTRIBUTION with
637         ALLOW_TMI_SST_COST_CONTRIBUTION
638    o pkg/atm_phys:
639      - add some diagnostics for Short-wave and for convection S/R.
640    o pkg/seaice/seaice_growth:
641      - fix a bug in the lateral melt parameterization for SEAICE_ITD
642        in seaice_growth; tempFrz needs to be computed inside the i/j-loop
643      - rearrange loop order for better vector code in the same code block
644      - rewrite the floeDiameter formula to have fewer divisions
645      -  (miraculously) none of this changes the results of seaice_itd
646    o pkg/smooth:
647      - move param smooth2Ddiffnbt to pkg/ecco
648    o pkg/salt_plume:
649      - salt_plume_frac.F:
650         clean up local param names
651         reformulate (1-frac) to frac; original 1-frac was based on swfrac code
652    o pkg/rw:
653      - add RS version of S/R READ_MFLDS_LEV.
654    o pkg/streamice:
655      - fix the restart test by writing/reading pickup_streamice files.
656    o pkg/seaice:
657      - refine checks for jfnk-related parameters
658      - comment out if statement with SEAICEuseIMEX parameter as long as there
659        is no IMEX code to avoid confusion and surprises
660    
661    checkpoint64u (2014/03/07)
662    o verification/MLAdjust:
663      - rename secondary test suffix:
664         1.leith  -> A4FlxF  + switch to flux-form & add side-drag
665         0.leithD -> AhFlxF  + switch to flux-form
666         0.smag   -> AhVrDv  (use Vorticity-Div. visc form) + add side-drag
667         0.leith  -> AhStTn  (use Strain-Tension visc form) + add side-drag
668    o pkg/mom_vecinv:
669      - remove unused arguments from S/R MOM_VI_HDISSIP & MOM_HDISSIP (as it used
670        to be before mom_calc_visc.F)
671      - skip the call to MOM_CALC_TENSION & MOM_CALC_STRAIN if not needed.
672      - add 2nd copy of vort3 & strain that knows about lateral BC (free/no slip):
673        this is simpler for the adjoint and for diagnostics.
674    o model/src + pkg/momentum:
675      - add input files for  2-D additional Western and Southern cell-edge wall
676         (e.g., to add "thin-wall" where it is =1).
677      - fix sideDrag option for thin-walls with Non-Lin Free-Surf
678        using 2nd hFacZ that is computed from initial (fix domain) hFac
679      - known limitations of thin wall implementation: not yet coded for sigma
680        coords; not working with CD-scheme neither.
681    o pkg/seaice:
682      - rename recently introduced parameters from (wrong name) AB to
683        BDF (backward difference time discretisation)
684      - retire runtime parameters SEAICEuseAB2, SEAICE_abEps
685    o tools/adjoint_options:
686      - remove setting of "OPENAD=true" (now set by command line "genmake2 -oad")
687    
688    checkpoint64t (2014/02/01)
689    o pkg/ecco
690      - add compile flag ALLOW_GENCOST_TIMEVARY_WEIGHT in ECCO_OPTIONS.h and
691        runtime logical flag gencost_timevaryweight to read daily sea-ice sigma
692      - replace hard-coded record number and period which only work for monthly
693        with read-in runtime param that works for other periods (month,day,year)
694    o pkg/thsice
695      - corrected store directive fixes thsice adjoint gradient checks
696    o genmake2 & testreport:
697      - add genmake2 option "-oad" to generate a Makefile for OpenAD built and
698        in this case, use tools/adjoint_options/adjoint_oad as default AD optfile.
699        Update testreport accordingly. No need to set "export OPENAD=true"
700        in adjoint_options/adjoint_oad anymore (will be removed later).
701    o pkg/shelfice:
702      - put T & S shelfice forcing into model surfaceForcing_T,_S (for now,
703        only if SHELFICEboundaryLayer=F); Change model/src/external_forcing.F
704        so that surface forcing applies to k=kSurf if using pkg/shelfice.
705    o pkg/ctrl, pkg/grdchk, pkg/ecco:
706      - Changes to make GENARR more modular (i.e. invisible if not used)
707    o model/src/temp_integrate.F and salt_integrate.F
708      - re-include store directives that were removed on Dec 27th.
709    o model/src/external_forcing_surf.F
710      - add storage directives for EmPmR and PmEpR to avoid recomputation of
711        seaice_model in the adjoint that is problematic when seaice_model is
712        turned off in the adjoint. The resolved issue dated back to July when
713        EXTERNAL_FORCING_SURF call was moved.
714        Update global_ocean.cs32x15/*/output_adm.seaice_dynmix.txt accordingly.
715    o pkg/exf/exf_check.F
716      - fix a small bug again (originally found by Wentao Liu, now found again)
717      - streamline error output
718    o pkg/streamice and aim_v23:
719      - replace a few "_EXCH_XY_RL (" with "_EXCH_XY_RL(", so that
720        Apple's /usr/bin/cpp knows what to do:
721        Apple LLVM version 5.0 (clang-500.2.79) (based on LLVM 3.3svn)
722        Target: x86_64-apple-darwin13.0.0
723    
724    checkpoint64s (2014/01/05)
725    o tools/adjoint_options:
726      - switch to fastopt.net TAF server (instead of default fastopt.de) for
727        AD optfiles adjoint_diva & adjoint_f95 (similar to adjoint_default).
728    o model/src:
729      - remove some unnecessary TAF storage directives in forward_step.F and
730        in dynamics.F (note: not always removed by TAF, e.g., double storage
731        of kappaRU,kappaRV in former version of dynamics.F).
732    o model/src & pkg/ptracers:
733      - call directly GAD_IMPLICIT_R & IMPLDIFF + DWNSLP_APPLY from temp_integrate.F
734        salt_integrate.F and ptracers_integrate.F (instead of from thermodynamics.F)
735        and remove ptracers_dwnslp_apply.F & ptracers_implicit.F
736      - call MATRIX_STORE_TENDENCY_EXP for each tracer (in ptracers_integrate.F)
737      - add fZon & fMer as output argument of S/R GAD_CALC_RHS.
738      - update TAF AD-output of experiments global_ocean.90x40x15 (13 for AD-grad).
739    o useSingleCpuInput separates single-CPU input from single-CPU output;
740        for now only implemented for in exf_interp_read.F
741    o verification/advect_xy:
742      - fix missing EXCH call in local version of ini_salt.F and update output.
743    o momentum diagnostics:
744      - fix which deltaT is used in Total-Tendency diagnostics.
745      - fix typo in diagnostics for momentum tendency from AB.
746    o pkg/seaice/seaice_lsr.F: fix an initialisation bug for the
747        SEAICE_VECTORIZE_LSR_ZEBRA option that lead to NaNs on a NEC-SX8
748    
749    checkpoint64r (2013/12/08)
750    o verification/*/results:
751      - Update reference output of experiments that were passing with just 13 digits
752         (make it easier to detect future changes in results)
753    o model/src & pkg/ptracers:
754      - move calls to GAD_ADVECTION (Multi-Dim advection) from thermodynamics.F to
755        inside temp_integrate.F and salt_integrate.F and from ptracers_advection.F
756        to inside ptracers_integrate.F ; remove ptracers_advection.F
757    o coupling interface pkgs:
758        [atm_compon_interf, ocn_compon_interf & atm_ocn_coupler]
759      - change the config check to test the agreement of Ocean Depth
760        with ATM land/sea mask (instead of ATM orography);
761      - send to coupler the number of coupler time-steps to do for this run:
762        this allows to check for consistency and don't need anymore to be
763        specified in parameter file "data";
764      in coupler:
765      - check consistency of RunOff map versus Ocean Depth and ATM land/sea mask.
766      - improve report to log-file of config setting (pass log-file unit to few S/R)
767    o pkg/compon_communic:
768      - add coupling send/receive for non-tiled integer vector;
769      - add S/R to check and stop if any proc has an error (similar to
770        eesupp/src/stop_if_error.F but single thread and across Comm_World).
771    o pkg/exch2:
772      - in exch2*_get_rx[1,2]: use new list "W2_tileIndex" to replace search
773        through list of all tiles my proc owns.
774    o model/src:
775      - AUTODIFF only: in calc_adv_flow.F, recompute rTransKp (instead of copying
776        from rTrans) to simplify dependencies (no need to store rTrans anymore in
777        calling S/R); this affects AD results at machine truncation level:
778        update AD-output (TAF) of experiments: 1D_ocean_ice_column,
779        bottom_ctrl_5x5 & obcs_ctrl (12 digits for AD grad, same FWD grad).
780    o tools/build_options:
781      - simplify Warnings options (-ieee & -devel cases) in linux_amd64_gfortran
782    o coupling interface pkgs:
783        [compon_communic, atm_compon_interf & ocn_compon_interf]
784      - move declaration of local array "ibuf" out of header file "CPLR_SIG.h"
785        to each S/R that needs it; remove un-used variables.
786      - change component tile registration (cpl_register.F in both compon_interf
787        and mitcomponent_tile_register.F) to pass the full list of tiles
788        information (including bi,bj) in 1 vector (instead of in a bi,bj matrix).
789      - with pkg/exch2: adopt the same convention used for I/O to define mapping
790        towards coupler global array (unless W2_useE2ioLayOut=F):
791         a) can now use different tiling between atm & ocn comp.
792         b) no needs to modify the run-Off map when changing tiling (was needed
793            even if using the same tiling between atm & ocn).
794         c) will allow to run with blank-tiles in 1 component (e.g., for ocean
795            full land tiles); not yet tested.
796      - check for valid mapping from comp. tile to coupler global array
797      - improve report of tile registration results to log file.
798    o pkg/exch2:
799      - in eesupp/src/eeboot.F: move call to W2_EEBOOT before Coupler
800        tile-registration (CPL_REGISTER);
801      - activate (un-comment) definition and setting of "W2_tileIndex" list to
802        store the local bi,bj indices of each tile;
803      - also print bi,bj in local report to log file;
804      - fix pkg/debug/debug_cs_corner_uv.F for the case nSy > 1 (left from
805        Jun 2009 modif of pkg/exch2).
806    o testing on baudelaire:
807      - run 2 tests at a time: no significant slow down (since enough cpu) and
808        get the full set of test done earlier
809      - switch the ifort test to "-devel" ; run the OpenAD test everyday.
810    o model/src/thermodynamics.F and routines called from it:
811      - pkg/gmredi: gmredi_residual_flow.F (replacing gmredi_calc_uvflow.F &
812        gmredi_calc_wflow.F) to update eulerian velocity (input) into residual
813        velocity (outp) by adding bolus velocity.
814      - model/src: calc_adv_flow.F (replacing calc_common_factors.F) to compute
815        mass transport from velocity + lateral grid cell area
816      - rename calc_gt.F to temp_integrate.F (includes call to TIMESTEP_TRACER)
817      - rename calc_gs.F to salt_integrate.F (includes call to TIMESTEP_TRACER)
818     in thermodynamics.F
819      - remove k from thermodynamics.F and move it to temp_integrate.F
820        salt_integrate.F and ptracers_integrate.F (now done inside the tracer
821        loop).
822      - compute locally (in thermodynamics.F) 3-D velocity field that is used to
823        advect tracers; pass it as argument to GAD_ADVECTION, GAD_SOM_ADVECT,
824        PTRACERS_ADVECTION, TEMP_INTEGRATE, SALT_INTEGRATE, PTRACERS_INTEGRATE,
825        GAD_IMPLICIT_R and PTRACERS_IMPLICIT
826      - update AD-output (TAF & OAD) of experiments: 1D_ocean_ice_column,
827        global_ocean.90x40x15, tutorial_global_oce_biogeo and
828        tutorial_tracer_adjsens (+ TLM output).
829    o tools/OAD_support and (verification/*/) code_oad:
830      - OAD_support/cb2mGetModules.csh: add PACKAGES_CONFIG.h in header file to
831        module conversion ; remove unneeded CPP_EEOPTIONS.h.
832      - code_oad/CPP_OPTIONS.h: remove PACKAGES_CONFIG.h and use a more standard
833        version (closer to model/inc/CPP_OPTIONS.h).
834    o model/src:
835      - remove parameter "useOldFreezing" from PARAMS.h and push it to the
836        retired list of parameters (routine FREEZE has been replace by surface
837        freezing (10.yrs ago) and by pkg/frazil (interior freezing).
838    o pkg/gmredi:
839      - add option (GM_CALC_TRANSP_FROM_VEL) to compute transport directly from
840        velocity (same scheme but affects machine truncation) for GM_AdvForm.
841      - update output of FWD experiments: front_relax.bvp,
842        global_ocean.90x40x15.dwnslp, global_ocean.cs32x15 and ideal_2D_oce.
843    
844    checkpoint64q (2013/11/17)
845    o verification:
846      - generate new output on baudelaire (gfortran, -ieee) for OpenAD experiments
847        tutorial_global_oce_biogeo and global_ocean.90x40x15.
848      - generate new output (growth & melt) for seaice_itd experiment after
849        updating the input pickup_seaice files (previously wrong).
850    o pkg/cost:
851      - define a "final cost function" for each tile, and use GLOBAL_SUM_TILE_RL
852        (instead of _GLOBAL_SUM_RL) to get the final cost from all procs & threads:
853        o this fixes global-sum value if multi-threads (since GLOBAL_SUM_RL
854          cannot be applied to var in common block).
855        o allows to get results independent of tile-per-proc setting (if using
856          slower GLOBAL_SUM_SEND_RECV option).
857      - update accordingly: seaice_cost_final.F, shelfice_cost_final.F,
858        thsice_cost_final.F and ecco_cost_final.F (this one affects lab_sea
859        forward gradients: update output).
860      - update */code_oad/externalDummies.F by adding dummy GLOBAL_SUM_TILE_RL
861        S/R and, for most exp., also comment out GLOBAL_SUM_R8.
862    o pkg/mom_common:
863      - move to pkg/mom_common and model/src (previously in tutorial_deep_convection
864        code) 2nd version of isotropic 3-D Smagorinsky code interface: strain and
865        viscosity are locally declared in dynmics.F and pass as argument to CALC_GW;
866        ensure that all field value that are used are set.
867    o tutorial_deep_convection (smag3d):
868      - add missing scaling in mom_calc_smag_3d.F;
869      - set smag3D_coeff in input.smag3d such that results do not change.
870    o pkg/dic:
871      - change dic_cost.F to compute cost on each tile first and then apply
872        GLOBAL_SUM_TILE_RL: this affects forward gradient of AD experiments
873        tutorial_dic_adjoffline & tutorial_global_oce_biogeo; update output.
874      - remove kLev argument and use GLOBAL_SUM_TILE_RL in tracer_meanarea.
875    o eesupp/src & pkg/mdsio:
876      - remove gather/scatter_vector.F (from eesupp) and mdsio_read/writevector.F
877        (from pkg/mdsio) since they are no longer used for tape IO.
878      - move simple C subroutine "setdir.c" from pkg/compon_communic to eesupp/src
879        (+ keep a copy in pkg/atm_ocn_coupler).
880    o verification/isomip:
881      - split domain in 8 squared tiles (instead of just 2) for FWD, AD & OAD tests.
882    o tools/build_options:
883      - optfile linux_amd64_ifort11, fast (no ieee) case:
884        to get a working restart for all experiments, add "-fp-model source"
885        to FOPTIM (also remove "-opt-streaming-stores auto" <- this is the default).
886    
887    checkpoint64p (2013/10/20)
888    o pkg/autodiff:
889      - adread_adwrite.F: when type and length do not match ALLOW_AUTODIFF_WHTAPEIO
890        criteria, return to simple (default) tape IO format.
891    o pkg/mdsio (+ eesupp/src):
892      - rewrite/simplify tape-IO S/R (new S/R MDS_READ/WRITE_TAPE replace
893        previous MDSREAD/WRITEVECTOR) with 2 array argument from each type (R4/R8);
894      - fix globalFile and singleCpuIO options using simpler global mapping.
895      - new pairs of scatter/gather vector S/R (one for each type, generated from
896        template) corresponding to simpler global mapping.
897      - adread_write.F: switch to new S/R (but leave old calls commented) and write
898        to globalFile when parameter globalFiles is set to True.
899      - switch on useSingleCpuIO in AD experiments: global_ocean.90x40x15 & isomip.
900    o pkg/autodiff:
901      - adread_adwrite.F: add a hack for RS arrays (when RS=real*4);
902        with ALLOW_AUTODIFF_WHTAPEIO defined, since corresponding (real*4) is
903        missing, just add a STOP if array type do not match.
904    o pkg/exf:
905      - to allow to use seaice-fraction from pkg/exf in other pkgs than pkg/seaice:
906         rename CPP option EXF_ALLOW_SEAICE_RELAX to EXF_SEAICE_FRACTION
907         and rename array obsSIce to exf_iceFraction.
908    o tutorial_deep_convection:
909      - add 1rst version of isotropic 3-D Smagorinsky code (from Louis-Philippe),
910        for now all in this exp. code dir.
911      - add secondary test using Smag-3D viscosity (keep very low backgroud visc for
912        testing) and flux-limter advection scheme for Temp. (no explicit diffusion).
913    o eesupp/src:
914      - added SINGLE_DISK_IO option because reading of parameter files on
915        very large number of processors did not work with existing set-up
916    
917    checkpoint64o (2013/09/25)
918    o pkg/atm_phys & atm_compon_interf:
919      - allows for coupling of gray-atmosphere (atm_phys) with ocean.
920    o tools/build_options:
921      - switch from "-fPIC" to "-mcmodel=medium" in optfiles: linux_amd64_gfortran
922        & linux_amd64_ifort11 and in linux_amd64_g77 & linux_amd64_open64 also
923        remove CPP setting (was identical to genmake2 default).
924    o pkg/gmredi & model/src: Some updating and work done on the residual model.
925      - created new file model/src/calc_eddy_stress.F to calculate the eddy stress.
926      - fixed up the calculation of the eddy stress and how it is added to the
927        external forcing via taueddy_external_forcing.F
928      - at the moment, it is very experimental and only works with the variable eddy
929        diffusivity calculated in gmredi_k3d.F
930    o pkg/seaice/seaice_check.F: add a check to catch the case of specifying
931        lw/swfluxfile instead of lw/swdownfile in data.exf together with pkg/seaice
932    o testreport (& tools/do_tst_2+2):
933      - for MPI test, set default COMMAND to 'mpirun -v -np TR_NPROC ./{executable}'
934    o tools/build_options: linux_amd64_gfortran & linux_amd64_ifort11:
935      - remove CPP='cpp -traditional -P' (this is genmake2 default)
936      - add switch (for big setups) to use 'medium' memory-model (but leave it
937        commented out for now). Note: needed with FC 19 to compile big setups.
938    o pkg/atm_compon_interf:
939      - regroup per field origin (model & pkgs) the coupling storage routines
940         (which accumalate in time each coupling field)
941      - move bi,bj loops inside atm_store_my_data.F and store also wind-stress;
942        update accordingly + simplify aim_do_physics.F
943    
944    checkpoint64n (2013/08/26)
945    o pkg/bbl:
946      - update formulation to reduce dispersion of tracer properties in bbl
947      - replaced horizontal and vertical transport parameters with velocities
948      - changes results for verification/global_with_exf.yearly
949    o verification/halfpipe_streamice:
950      - change to matrix construction; update both Fwd & AD output.
951    o verification/tutorial_tracer_adjsens:
952      - OpenAD test: switch to vector-invariant momentum since fluxform with
953        rStar causes problems with OpenAD; update output.
954    o tools:
955      - genmake2: define a common prefix for all temp-file names ; move them
956        to local /tmp disk (but would be easy to move them back);
957      - xmakedepend: apply the same switch for temp-files.
958    o pkg/offline:
959      - changes for use with rStar (NLFS): assume that we continue to provide
960        UVELMASS/hFacW_ini & VVELMASS/hFacS_ini (hFacWi,S_ini as written in grid
961        output files) and apply r* scaling at each time-step (function of the time
962        varying Eta field); use normal pickup files (needed for restart with NLFS).
963    o adjoint with OpenAD:
964      - move OpenAD-specific files from verification/OpenAD/code_oad_all to a new
965        package openad.  This package has to be compiled for all runs with OpenAD
966        instead of specifying code_oad_all as a modification directory.
967      - link the fortran templates from tools/OAD_support to the build directory
968        for preprocessing to avoid conflicts between different setups compiled
969        simultaneously and simplify cleanup.
970    o pkg/exf:
971      - in exf_getforcing.F: comment out most of the EXCH calls (fields used by
972        main model or other pkgs are exchanged in EXF_MAPFIELDS).
973    o model/src:
974      - do_stagger_fields_exchanges.F: skip EXCH calls when using pkg/offline
975        (similar to do_fields_blocking_exchanges.F).
976    o tools/genmake2:
977      - remove TAF output src code just before calling staf (when not doing a fresh
978        built, will stop if things go wrong with staf).
979      - fix target "adobj" (left from TAF version-2 transition)
980    o pkg/diagnostics:
981      - add a parameter to track the status of pkg/diagnostics activation;
982        this replace/extend the use of logical param "settingDiags" (to check
983        when adding diag to the list) to also check any DIAGNOSTICS_[]FILL* call.
984        New S/R to print error message and stop when pkgStatus is not right.
985      - to try: add a warning when "data.diagnostics" exist but useDiagnostics=F.
986    
987    checkpoint64m (2013/08/13)
988    o model/inc:
989      - move FCORI_MACROS.h from PARAMS(_MACROS).h to GRID_MACROS.h (left from
990        8 yrs ago modif when Coriolis arrays were moved from PARAMS.h to GRID.h)
991    o pkg/kpp & aim_v23:
992      - only call DIAGNOSTICS_FILL when useDiagnostics=TRUE.
993    o pkg/seaice:
994      - restore (last time on 2011/12/24) ability to compile pkg/seaice with
995        undefined pkg/exf ALLOW_ATM_TEMP or ALLOW_RUNOFF CPP-options.
996      - only call DIAGNOSTICS_FILL when useDiagnostics=TRUE.
997    o eesupp/src:
998      - fix check for overlap-size argument (myOLn.GT.MAX_OLY_EXCH)
999        in exch1_rx[_ad].template (thanks to Francois Lefeuvre report).
1000    o switch to TAF version-2:
1001      - add flow directives to "freeze" naming convention for ad-routines that
1002        are used in I/O routines of adjoint state and associated common blocks
1003        that are used in adcommon.h (backward compatible with version-1)
1004      - update all ad-optfiles (in tools/adjoint_options + few local to some
1005        verification exp) to switch to latest TAF version (currently 2.5.5);
1006        merge "*_mpi" adoptfiles into the corresponding non-mpi (but commented
1007        out except for diva).
1008      - the major change with TAF version-2 is that both the differentiated
1009        routines and the forward routines (new) are returned as part of the TAF
1010        output source code. Update genmake2 accordingly.
1011      - new output for AD experiment tutorial_global_oce_biogeo (better AD gradient
1012        with version-2 when compared to TLM or FWD gradient); other experiments
1013        output show minor changes (machine truncation level); update the few AD &
1014        TLM output with 12 matching digits only (some prior to version-2 switch).
1015    
1016    checkpoint64l (2013/08/05)
1017    o model/src:
1018      - in dynamics.F, skip the call to CALC_VISCOSITY if momViscosity=F
1019      - main_do_loop.F: no longer includes additional (AUTODIFF) header files
1020        when using TAF but only if using OpenAD.
1021    o pkg/mom_common+fluxform+vecinv:
1022      - always set horiz. viscosity arrays to background value before calling
1023        MOM_CALC_VISC (in MOM_FLUXFORM & MOM_VECINV) and call S/R MOM_CALC_VISC
1024        only when using variable horiz. viscosity (useVariableVisc=T);
1025      - simplify mom_vecinv.F (only 1 block for momViscosity).
1026    o pkg/mom_common: variable horiz. viscosity in NH code
1027      - move horiz-viscosity 3-D arrays viscAh_W & viscA4_W (used in calc_gw.F)
1028        from model/inc/NH_VARS.h to pkg/mom_common/MOM_VISC.h
1029      - store in common block (in MOM_VISC.h) logical parameters: useHarmonicVisc,
1030        useBiharmonicVisc & useVariableVisc.
1031      - fix old bug (already in 1rst implementation of variable horizontal viscosity
1032        in calc_gw.F, version 1.27, 2006/06/20):
1033        horizontal bi-harmonic viscosity in gW was missing when wiscA4W=0
1034        even if variable bi-harmonic viscosity (e.g., viscA4Grid) was non-zero.
1035      - change background horiz viscosity in vertical momentum (gW) to always be
1036        viscAhW,viscA4W (instead of switching to viscAhD, viscA4D when using
1037        any type of variable viscosity, e.g., viscAh/4Grid)
1038      - change default value of viscAhW,viscA4W to viscAhD,viscA4D (instead of
1039        viscAh,viscA4) which default to viscAh,viscA4 :  this avoid missing
1040        horiz. viscosity in W eq when just setting viscAhD/Z,viscA4D/Z (since
1041        default viscAh,viscA4 is zero).
1042    o model/src:
1043      - extend length of drC & recip_drC from Nr to Nr+1.
1044    o Divided Adjoint (DIVA) with MPI:
1045      - genmake2: do not create local ./mpi_headers dir when no file to copy into.
1046      - remove option ALLOW_DIVIDED_ADJOINT_MPI (replaced by ALLOW_DIVIDED_ADJOINT
1047        and ALLOW_USE_MPI) from model/src code and from ECCO_CPPOPTIONS.h.
1048    
1049    checkpoint64k (2013/07/23)
1050    o tools/OAD_support:
1051      - avoid the need for file "oadtempflile" in insertTemplateDir.bash
1052        and remove it from genmake2.
1053    o tools/build_options:
1054      - remove MPI_HEADER_FILES_INC setting (no longer used) and comment out
1055        MPI_HEADER_FILES list (let genmake2 find the missing headers)
1056    o verification/halfpipe_streamice:
1057      - change to driving stress formulation; update both Fwd & AD output.
1058    o tools/genmake2 and Divided Adjoint with MPI:
1059      - remove default setting of MPIINCLUDEDIR from $MPIHOME (always been broken);
1060      - only create local ./mpi_headers dir if using MPI and MPIINCLUDEDIR is set;
1061      - add new variable (LOCAL_MPI_HEADERS, replace MPI_HEADER_FILES_INC) in
1062        Makefile, which is set by genmake2, and check which mpi-headers are needed.
1063        Note: need to update adjoint_options/adjoint_diva_mpi accordingly.
1064      - update target "CLEAN" (to also remove ./mpi_headers/ dir).
1065    o testreport:
1066      - changes for Divided Adjoint Run: when file "run_ADM_DIVA" is present,
1067        perform additional runs (number of additional runs is "add_DIVA_runs" taken
1068        from file run_ADM_DIVA ; should match "nchklev_3" in file "code_ad/tamc.h").
1069    o verification/lab_sea (AD test):
1070      - change to test Divided Adjoint Run in this set-up (both standard AD test
1071        and 2 secondary AD test: noseaice + noseaicedyn); drop the evp AD test.
1072    o pkg atm_ & ocn_compon_interf:
1073      - remove cpl_earlyExpImpCall=F option (was mainly a hack added for the old
1074        staggerTimeStep implementation) and disable (retired) corresponding
1075        parameter.
1076    o pkg/offline:
1077      - comment out unused field-array: ICEM, ConvectCount, hflx[01], icem[01];
1078      - add S/R OFFLINE_CHECK to print offline parameter summary
1079        and stop if loading a file that is not used;
1080      - enable to calculate GMRedi tensor, KPP mixing and convective index
1081        when the corresponding file(s) is/are not specified (but pkg is used).
1082      - comment out resetting of monitorFreq (to endTime) since it still useful
1083        for monitoring CFL numbers and checking offline fields.
1084    o OpenAD:
1085      - do not define OAD_DEBUG (in tools/adjoint_options/adjoint_oad) to get
1086        smaller standard output) and generate new (smaller) output (on baudelaire
1087        using gfortran with -ieee) for exp. tutorial_tracer_adjsens
1088    o model/src:
1089      - call EXTERNAL_FORCING_SURF outside bi,bj loops (in do_oceanic_phys.F),
1090        (where external_forcing_adjust was called) and change list of arguments;
1091      - merge external_forcing_adjust.F into external_forcing_surf.F
1092      - put surface relaxation of SST & SSS in new S/R (forcing_surf_relax.F)
1093        which also contains balancing surface relaxation (ALLOW_BALANCE_RELAX,
1094        previously in file "balance_relax.F", now removed); remove corresponding
1095        arrays in FFIELDS.h.
1096      - EXTERNAL_FORCING_SURF is now called when using pkg/offline; implement
1097        a hack for getting back surfaceForcingS (loaded from file) when using
1098        ALLOW_OLD_VIRTUALFLUX (pkg/dic, in DIC_OPTIONS.h) in offline set-up.
1099      - update output of AD test experiment global_ocean.cs32x15.seaice_dynmix
1100        (was getting only 11 digits for AD-grad, due to different truncation
1101         error in AD code).
1102    
1103    checkpoint64j (2013/07/04)
1104    o pkg/offline:
1105      - to enable the use of other features with pkg offline (e.g., obcs),
1106        also call S/R DO_OCEANIC_PHYS in offline run - more modifs to come.
1107      - comment out "allowFreezing" (now active) in 2 offline testing exp.
1108    o pkg/exf ALLOW_RUNOFTEMP
1109      - fix sign and make compatible with temp_EvPrRn .NE. UNSET_RL
1110      - ahdded RUNOFTEMP test to verification/global_ocean.cs32x15/input.seaice
1111      - changes verification/global_ocean.cs32x15/results/output.seaice.txt
1112    o pkg/atm_phys:
1113      - allows to add some damping on uVel,vVel (strength only function of k).
1114    o verification, ad-tests:
1115      - reduce length of the simulation for AD test: global_ocean.cs32x15.seaice,
1116        global_ocean_ebm and offline_exf_seaice.thsice.
1117    o verification/halfpipe_streamice:
1118      - found a bug in s/r pkg/streamice/streamice_advect_thickness which caused
1119        flux input boundary conditions to be ignored; a fix for this bug changed
1120        verification results for forward test.
1121      - add adjoint test.
1122    o pkg/ptracers:
1123      - allow to restart without SOM pickup (resetting SOM to zero).
1124    o pkg/gmredi:
1125      - New parameterisation for the calculation of K and (GM_PsiX,GM_PsiY) added.
1126      - It uses mixing length theory and suppression by steering level effects to
1127        calculate a diffusivity used in the Redi tensor (see Bates et al., submitted
1128        to JPO, for more details).
1129      - It also uses the diffusivity to calculate an eddy induced streamfunction
1130        based on a PV closure (rather than a buoyancy closure as in GM).
1131      - New files added to pkg/gmredi:
1132        gmredi_k3d.F calculates the diffusivity for the Redi tensor and the eddy
1133          induced overturning streamfunction (called from gmredi_calc_tensor)
1134        gmredi_calc_eigs.F calculates the eigenvalues and eigenvectors required
1135          for use in gmredi_k3d
1136        gmredi_calc_urms.F calculates the the rms eddy velocity used to calculate
1137          the eddy diffusivity
1138    
1139    checkpoint64i (2013/06/18)
1140    o pkg/cheapaml:
1141      - take src files from MITgcm_contrib/verification_other/offline_cheapaml/code
1142        that enable the use of seaice (pkg/thsice thermo & pkg/seaice dynamics)
1143        with pkg/cheapaml.
1144    o utils/python: add subpackage for cubed sphere function, first example is
1145        simple cs.pcol to plot 2D fields on a map
1146    o pkg/streamice:
1147      - This is a new package in MITgcm, which solves dynamic equations for ice
1148         sheets and ice streams
1149      - At the moment it is independent of atmosphere/ocean dynamics, or any
1150        other physical packages in MITgcm, even ShelfIce (although it is anticipat-
1151        ed that this will change)
1152      - There is a new verification exercise that tests it, halfpipe_streamice,
1153        evolves a 40x80 km ice stream/ice shelf (at coarse resolution) in a
1154        rectangular embayment
1155      - halfpipe_streamice is forward-only for now, will have TAF test soon
1156      - for questions, email dgoldber@mit.edu
1157    o pkg/thsice:
1158      - fix filling of snow-precip diagnostic (SIsnwPrc) (left from the removing
1159        of snowPrc from common bloc, on May 2nd, thsice_step_fwd.F revision 1.40);
1160      - remove diagnostics 'SI_FrcFx' ( now identical to 'SI_Fract' with new
1161         call sequence: ice-Thermo(thsice),ice-Dyn,ice-Advect );
1162      - allow precip from pkg/cheapaml to make snow over seaice.
1163    o pkg/cfc:
1164      - move in separated header file (CFC_ATMOS.h) time-serie arrays of Atmos CFC
1165      - remove atmos CFC 2-D arrays from common bloc (now local variables)
1166      - change some hard-coded constant to run time parameter for reading and
1167        and interpolating atmospheric CFC ; keep same default as previously.
1168      - more flexible reading of Atmos CFC (number of records no longer hard-coded)
1169      - put arguments in standard order: myTime, myIter, myThid
1170      - use standard S/R GET_PERIODIC_INTERVAL for time interpolation of
1171        atmospheric CFC ; fix for the case myIter < PTRACERS_iter0.
1172      - fix calculation of surf tendencys for partial-cell and/or Non-Lin Free-Surf
1173      - new routine to print summary of CFC params and check for consistency.
1174    o pkg/seaice: add uice/vice to the parameter list of s/r seaice_advdiff,
1175      similar to thsice_advdiff.
1176      Note that for the B-grid case the routine parameters uc/vc are overwritten.
1177    o pkg/cfc:
1178      - change time interpolation for atmospheric CFC-11 (now same as for CFC-12);
1179        update output (CFC-11) of experiment cfc_example and tutorial_cfc_offline.
1180      - fix interpolation of atmphspheric CFC between Sorthern and Northern
1181        hemisphere value.
1182    o pkg/seaice:
1183      - allow to use seaice dynamics without pkg/exf (e.g., using pkg/cheapaml)
1184    o pkg/seaice: add Adams-Bashforth2 time discretization for ice dynamics;
1185                  so far only for JFNK-solver, turn on with SEAICEuseAB2 = .TRUE.
1186      - requires an additional time level that is stored in the pickup
1187      - you can start with AB2 from a pickup without this time level with
1188        pickupStrictlyMatch = .false.
1189    
1190    checkpoint64h (2013/05/26)
1191    o pkg/cheapaml:
1192      - replace one ()**.5 with SQRT + use temp var "cdu = tau/Du" (coare3_flux);
1193        affect machine truncation (but exp cheapAML_box still pass with 13 digits).
1194      - consistent treatment of uWind,vWind location: assume everywhere in
1195        pkg/cheapaml that they are on C-grid (@ uVel,vVel location)
1196        (Note: was already the case for Tair,Qair advection);
1197        add option (INCONSISTENT_WIND_LOCATION) to recover old results.
1198      - compute diabatic forcing only in the interior (excluding overlap regions)
1199      - fill in array "Qsw" (for short-wave heating);
1200      - add diagnostic for precip ; fill-in diagnostics for cheapAML state vars
1201        before any update (consistent with MITgcm state var diagnostics);
1202      - cheapaml_fields_load.F & cheapaml_init_varia.F : only fill outer edges if
1203        non periodic ; + adjusted for uWind,vWind (C-grid).
1204    o pkg/seaice:
1205      - remove dependence of pkg/seaice versus pkg/exf (file: pkg/pkg_depend) and
1206        add explicitly pkg/exf in experiments that currently use pkg/seaice.
1207      - allows to compile pkg/seaice without pkg/exf.
1208    o tools/OAD_support:
1209      - use a local copy (ourRWCPinBd) to ensure index ourRWCP stays within bounds
1210        of array "ourStepOf" in function rvNextAction (revolve.F90).
1211    o pkg/aim_compon_interf renamed to pkg/atm_compon_interf
1212      - change pkg name (to be used with other atmospheric physics pkg)
1213        but by-pass CVS when making the new pkg so that we keep the CVS history.
1214    o pkg/offline:
1215      - call OFFLINE_FIELDS_LOAD from pkg/offline/offline_init_varia.F
1216        (previously called from pkg/dic_surfforcing_init.F)
1217    o model/src:
1218      - re-order sequence of calls within packages_init_variables.F, using
1219        standard order, except for:
1220         DIAGNOSTICS_INIT_VARIA and OFFLINE_INIT_VARIA (called @ the top),
1221         CTRL_MAP_INI and OBCS_INIT_VARIABLES (called @ the bottom)
1222    o new pkg: atm_phys
1223      - add entry point and source code (previously in contrib
1224          verification_other/atm_gray/code_gray/) for new pkg "atm_phys"
1225        (atmospheric physics pkg from P. O'Gorman and T. Schneider, JCl, 2008).
1226      - re-order sequence of calls within packages_readparms.F,
1227         packages_init_fixed.F and packages_write_pickup.F
1228        (but skip packages_init_variables.F because of TAF issues).
1229      - update contrib/*/atm_gray/ experiment.
1230    o pkg/seaice (ITD code):
1231      - simplify and fix the writing of pickup-files for ITD case
1232    o pkg/seaice (ITD code):
1233      - introduce floe size dependent lateral melt for ITD case;
1234      - cleaning (avoid division by zero, change to f77 syntax, remove tabs)
1235      - update seaice_itd experiment main output.
1236    o pkg/thsice:
1237      - remove snowPrc from common block THSICE_FLUX, in THSICE_VARS.h and
1238        declared it locally (without bi,bj) in thsice_main.F & aim_do_physics.F;
1239        changed accordingly pkg/atm2d.
1240    
1241    checkpoint64g (2013/05/01)
1242    o pkg/exf ALLOW_RUNOFTEMP
1243      - if defined,  river and glacier runoff temperature can be read-in from
1244        runoftempfile; runoftempfile needs to have same format as runofffile
1245    o pkg/thsice (& pkg/bulk_force):
1246      - In case Energy-Reference-Level (ERL) is used (temp_EvPrRn=0), account
1247        for energy content of Precip + RunOff & Evap (like with pkg/exf).
1248      - change computation domain to always be the interior (without overlap).
1249      - fix bug (wrong overlap) when using EXF and stressReduction > 0.
1250    o verification/tutorial_global_oce_biogeo:
1251      - add preliminary OpenAD setup (still has problems)
1252    o pkg/seaice:
1253      - turn some parameters for choosing the convergence criterion of
1254        the inexact Newton method (JFNK) into runtime parameters for convenience
1255      - clean up seaice_calc_viscosities.F: remove/retire two options for
1256        SEAICetaZmethod (1,2), introduce area weighting for method 3; this changes
1257        the results of lab_sea/input because a division has been replaced by
1258        a multiplication with the reciprocal (sumNorm)
1259      - modify offline_exf_seaice/input.dyn_jfnk/data.seaice to improve
1260        convergence of solver (changes results, of course), and to test some
1261        new features
1262    o model/src:
1263      - remove unused (since Aug 2006) S/R SET_WRITE_GLOBAL_PICKUP and its call.
1264      - remove unused forcing field "dQdT" and associated parameter "dQdTFile".
1265      - move forcing adjustment (balancing surface forcing) in specific S/R
1266        where might also be applied exchanges (if needed) to forcing arrays.
1267    o pkg/shelfice:
1268      - allow to specify the Ice-Shelf mass per unit area (instead of
1269        shelficeLoadAnomaly) and do the conversion from one to the other
1270      - move loading from file of shelficeLoadAnomaly from SHELFICE_INIT_VARIA
1271        to SHELFICE_INIT_FIXED: (a) avoid some TAF recompution issues and
1272        (b) will be loaded in time (before calling INI_PRESSURE) in case it is
1273        needed in phi0surf for initial pressure calculation when useDynP_inEos_Zc
1274      - update isomip experiment forward output (get machine truncation error
1275        from conversion shelficeLoadAnomaly -> shelficeMass -> shelficeLoadAnomaly)
1276    o verification/offline_exf_seaice:
1277      revise data.seaice in input.thermo and input_ad and update results accordingly
1278        HO = 0.2, SEAICE_areaLossFormula = 2,
1279        SEAICE_growMeltByConv = .TRUE.,
1280        SEAICE_doOpenWaterMelt = .TRUE.,
1281      Improve consistency with input.thsice and fix the spurious 500m ice corners
1282    o verification/global_ocean.cs32x15:
1283      - set Energy Reference Level to liq. water @ 0 degC: temp_EvPrRn=0.,
1284        in icedyn (thsice+seaice-dyn) test and update output.
1285    o verification/offline_exf_seaice:
1286      - adjust list of tested variables (with testreport) and update
1287        standard test output with better slection of monitored fields.
1288    o pkg/cd_code:
1289      - swtich off Adams-Bashforth on the 1rst iteration. Update output of
1290        experiment lab_sea.hb87
1291    o tools/genmake2:
1292      - change default makedepend from the system default to tools/xmakedepend:
1293        When no makedepend is specified, select tools/xmakedepend it the test pass,
1294        otherwise select the system default (if exist and pass the test) or
1295        try to build cyrus-makedepend ; stop if none of the 3 works.
1296    o pkg/exf & pkg/thsice:
1297      - In case Energy-Reference-Level (ERL) is used (temp_EvPrRn=0), account
1298        for energy content of Precip + RunOff & Evap. Assumes:
1299       1) Rain has same temp as Air.
1300       2) Snow has no heat capacity (consistent with seaice & thsice pkgs)
1301       3) Run-Off comes at the temp of surface water (with same Cp)
1302       4) Evap over ocean is released to the Atmos @ surf-temp (=SST); should be
1303        put directly into Latent Heat flux & should use water-vapor heat capacity.
1304       5) Evap over snow/seaice (pkg/thsice) assumes constant Lf+Lv (consistent
1305        with snow having no Cp) => water vapor is released to Atmos @ 0^oC (=ERL).
1306    o pkg/seaice: simplify the use of CPP flags in JFNK-related files
1307        (compile when SEAICE_ALLOW_JFNK is defined)
1308    o pkg/thsice:
1309      - fix oceanic flux diagnostics & timeave (left from new sequence of calls
1310        implementation): move THSICE_AVE call after the advection (called directly
1311        from thsice_do_advect.F).
1312    o verification/global_ocean.90x40x15 and OpenAD:
1313      New experiment for OpenAD is identical to the one in input_ad except that
1314        multiDimAdvection=.FALSE.,
1315      There is still an issue with this.
1316    o pkg/thsice:
1317      - account for ice velocity (ocean relative velocity) in turbulent heat flux
1318        at the base of the ice; update output of global_ocean.cs32x15 (icedyn)
1319        and offline_exf_seaice (main test).
1320    
1321    checkpoint64f (2013/03/31)
1322    o verification/OpenAD:
1323      - new (smaller, without OAD_DEBUG) output_oadm.txt generated using gfortran.
1324    o verification/isomip, pkg/shelfice and OpenAD:
1325      - add OpenAD setup to this exp and make shelfice package work with OpenAD
1326    o verification/tutorial_global_oce_biogeo:
1327      - update AD and TLM output after turning off ALLOW_FE (in DIC_OPTIONS.h)
1328    o verification/offline_exf_seaice:
1329      - replace adjoint experiment (now similar to fwd input.thermo/ setup).
1330    o verification/tutorial_tracer_adjsens, pkg/ptracers and OpenAD:
1331      - add OpenAD setup to this exp and make ptracers package work with OpenAD
1332    o pkg/seaice/seaice_evp.F:
1333       mask the asymmetric contribution of the ice-ocean stress (when
1334       the turningAngle is non-zero) over open water to avoid stripes
1335       in the EVP-solutions after many EVP-substeps. This does not change
1336       the verification experiment (because turningAngle=0 in that experiment),
1337       but will affect other EVP solutions with turningAngle.ne.0
1338    o verification, AD & TLM output:
1339      - new TAF version 2.3.10 (previously 2.3.8) add more parenthesis in multiple
1340        additions and multiplications which affect results at machine truncation
1341        level. Update few AD output (1D_ocean_ice_column, bottom_ctrl_5x5,
1342        lab_sea.noseaicedyn & offline_exf_seaice) and TLM output
1343        (1D_ocean_ice_column & tutorial_tracer_adjsens.som81) which had only 12
1344        digits of matching.
1345    o pkg/seaice:
1346       modify lsr-algorithm so that it vectorizes AND converges by using a
1347       "zebra" method: split vector loop into two with step size 2; this
1348       solves a general convergence problem for the JFNK solver on a vector
1349       computer. It has the potential to even improve convergence for
1350       non-vector machines, but it does change the results so it is turned
1351       off by default. To turn on define CPP-flags SEAICE_VECTORIZE_LSR and
1352       SEAICE_VECTORIZE_LSR_ZEBRA in SEAICE_OPTIONS.h
1353    
1354    checkpoint64e (2013/03/05)
1355    o pkg/ecco and several verification experiments:
1356       Remove special versions of the_model_main.F, the_main_loop.F, forward_step.F
1357       from ecco package, and revert to unified routine in model/src/
1358       Adjust verification experiments accordingly, especially gloal_oce_llc90
1359       Should conclude long-standing work by Gael to reconsile the_main_loop with
1360       ECCO and will enable OpenAD's revolve loop in ECCO setup.
1361    o pkg/generic_advdiff:
1362      - implement compressible flow method for multi-dim advection (similar to
1363        gad_som_advect.F); add new option "GAD_MULTIDIM_COMPRESSIBLE" (since
1364        TAF generates many recomputations) to use it; no yet coded with implicit
1365        vertical advection.
1366      - change experiment advect_cs (new output) and advect_xy (same output)
1367        to test compressible flow multi-dim advection.
1368    o pkg/generic_advdiff:
1369      - fix SOM advection for unusual cases (linear Free-Surf in r*, other
1370        cases where linear Free-Surf is not @ k=1, e.g., useShelfIce)
1371    o pkg/seaice:
1372      - fix bug in the no-slip implementation in seaice_calc_strainrates.F, this
1373        bug affects two verification experiments (lab_sea and lab_sea.hb87),
1374        recover old (wrong) results by setting noSlipFac = 2. in
1375        seaice_calc_strainrates.F;
1376      - add another averaging method for etaZ (etaZmethod=3), a mix of 2 and 0
1377      - add runtime parameter SEAICE_JFNKepsilon for that finite difference
1378        gradient in the Jacobian times vector operation (s/r seaice_jacvec)
1379      - fix line search in seaice_jfnk.F (s/r seaice_jfnk_update)
1380    o pkg/seaice: reorganize seaice_lsr.F to be able to reuse more code:
1381      - new subroutines seaice_lsr_tridiagu/v
1382      - introduce loop bounds i/jmin/max to be able to use a restricted
1383        additive Schwarz method, but not used for now.
1384      - rename SEAICE_CALC_LSR_COEFFS into SEAICE_LSR_CALC_COEFFS
1385      - use new subroutines seaice_lsr_tridiagu/v in s/r seaice_preconditioner
1386    o OpenAD support
1387       Reorganize S/R call for overall time-stepping loop to facilitate
1388       OpenAD revolve loop replacement
1389       (new S/R main_do_loop.F)
1390    o model/src:
1391      - add 3-D array 3rd dimension to argument list of S/R ADAMS_BASHFORTH2/3;
1392      - pkg/cheapaml: remove local S/R ADAMS2d and use instead standard S/R
1393        ADAMS_BASHFORTH2.
1394    o pkg/cheapaml:
1395      - add new parameter (default=F, same as before) to disable full domain
1396        (including land) periodicity in X & Y dir.
1397      - new S/R CHEAPAML_COPY_EDGES to copy relaxation field into edges of
1398        prognostics field ; merge the 2 S/R cycle_2d_tracer and timestep_2d_tracer
1399        into single S/R CHEAPAML_TIMESTEP.
1400    
1401    checkpoint64d (2013/02/17)
1402    o pkg/monitor (angular momentum):
1403      - do not add Eta contribution to the total AM if using rigid-lid;
1404      - correct for Adams-Bashforth in zonal-wind part (instead of in AM_eta).
1405      - horizontal discretisation: compute Zonal wind contribution separately for
1406        each component (instead of from cell centered averaged) and use the 4
1407        grid-cell corner averaged value of Omega*(R*cos_Phi)^2 in AM_eta part.
1408      - Check that AM is conserved with linear dynamics (momAdvection=F and linear
1409        FreeSurf) if using vectorInvariant momentum.
1410    o model/src (horizontal grid):
1411      - move initialisation of all horizontal grid arrays to null value
1412        from specific horizontal grid S/R to main S/R INI_GRID;
1413      - add 2 new arrays to project model C-grid velocity on to zonal direction
1414        (similar to AngleCosC & -AngleSinC but at U and V point location) and
1415        compute them in S/R CALC_GRID_ANGLES.
1416    o pkg/seaice: replace a hard coded parameter by a runtime parameter
1417        SEAICE_JFNK_tolIter
1418    o pkg/seaice: introduce a restricted additive Schwarz (RAS) method in
1419        preconditioner for JFNK (run LSR into the overlaps as far as possible,
1420        i.e OLx/y-2, but overwrite the solution in the overlaps)
1421      - extend loop range in seaice_calc_viscosity
1422      - add new parameters SEAICE_OLx/y (default = OLx/y-2)
1423      - add flexible loop ranges to seaice_preconditioner, seaice_calc_lsr_coeffs
1424      - slightly modify loops in tridiagonal solver lsr-preconditioner
1425      - by default remove the extra exchange in seaice_preconditioner with a
1426        replacement of an undocumented CPP flag by SEAICE_PRECOND_EXTRA_EXCHANGE
1427      - modify offline_exf_seaice so that old results without RAS are reproduced
1428        for output.dyn_jfnk.txt
1429      in seaice_fgmres.F (unrelated to RAS)
1430      - add a cpp-flag option for a re-ordered mapping (potentially more
1431        efficient), but because this changes the results, turn it off by
1432        default
1433      - replace the save statement by local common blocks
1434    o utils/matlab:
1435      - fix tile-offset in rdmnc.m when output was produced using EXCH2.
1436      - update cs_grid/bk_line scripts to use load_grid.m (in utils/matlab)
1437        instead of local script "load_cs.m".
1438    o pkg/seaice:
1439      - fix a serious bug in seaice_fgmres.F, s/r seaice_scalprod, connected
1440        to the scalarProductMetric and the unrolling. By chance this does not
1441        change the verification experiment, because of the particular domain
1442        decomposition
1443    o pkg/diagnostics:
1444      - change default missing_value from UNSET_RL to -999.
1445    o pkg/layers: improve vectorization of layers_fluxcalc.F
1446      - step 1: split loops, make TatU/V 2D arrays. This alone reduces the cpu
1447        time spent in this routine by more than a factor of 3 on an NEC-SX8
1448      - step 2: replace search algorithm by a bisection algorithm found in
1449        Press et al. Numerical Recipes in Fortran. This algorithm can be
1450        vectorized and finds the correct bin in approx. log2(Nlayers) steps.
1451        For now, use this algorithm only for TARGET_NEC_SX defined.
1452      - moved the search algorithm into a separate subroutine, that is kept
1453        within the same file for automatic inlining.
1454      - modified catching potential errors
1455    o pkg/ecco:
1456      - add compile switches ALLOW_SHALLOW_ALTIMETRY and ALLOW_HIGHLAT_ALTIMETRY.
1457    o model/src, pkg/autodiff, pkg/ctrl, pkg/grdchk :
1458      - modifications for ALLOW_GENTIM2D_CONTROL
1459      -- forward_step.F, the_main_loop.F : pass options and arrays for adjoint tapes.
1460      -- load_fields_driver.F : add call to CTRL_MAP_GENTIM2D( myTime, myIter, myThid )
1461      -- add xx_gentim2d0/1 in ctrl_ad_check_lev1_dir.h checkpoint_lev1_directives.h etc
1462      -- use ctrl_swapffields.F (new) instead of exf_SwapFFields.F in ctrl_get_gen.F
1463    o model/src:
1464      - account for moist thermodynamics in (dry) potential temperature equation;
1465        update results of experiments: aim.5l_cs (x2), fizhi-cs (std + aqualev)
1466        and cpl_aim+ocn.
1467      - also switch to standard compiler (gfortran, was using ifort previously)
1468        for fizhi-cs experiments reference output.
1469    o pkg/ctrl:
1470      - 1st step toward generic time-varying control variable (2D) via CPP option
1471        ALLOW_GENTIM2D_CONTROL
1472      - note new namelist ctrl_nml_genarr in data.ctrl
1473    o verification/global_ocean.cs32x15:
1474      - switch off OLD_THSICE_CALL_SEQUENCE (both forward and AD code) to use new
1475        thsice calling sequence and update "output.icedyn.txt" output file.
1476    o pkg/ptracers:
1477      - from Ryan A.: code to allow to restart a tracer at regular time interval
1478        specifying a reset frequency and a reset-phase (for each tracers).
1479    o pkg/thsice:
1480      - implement new sequence of calls for thsice+seaice:
1481          previously:   ice-Dyn,ice-Advect,ice-Thermo(thsice)
1482          new sequence: ice-Thermo(thsice),ice-Dyn,ice-Advect
1483      - allows (with temporary CPP option "#define OLD_THSICE_CALL_SEQUENCE"
1484        in CPP_OPTIONS.h) to recover old sequence;
1485      - update diagnostics for Intermediate State thsice diagnostics: now filled
1486        just before advection (instead of just after advection in old sequence);
1487      - update output of experiment offline_exf_seaice (standard test);
1488      - in global_ocean.cs32x15 exp., postpone output.icedyn.txt update
1489        by setting #define OLD_THSICE_CALL_SEQUENCE in CPP_OPTIONS.h
1490    o pkg/aim_v23:
1491      - use tiled array for aim_CO2 and surface wind speed for export to coupler;
1492      - use standard pkg/mdsio routines to read & write CO2 pickup file;
1493      - in-line S/R AIM_AIM2DYN_EXCHANGES in aim_do_physics.F;
1494      - Implement new sequence of calls for seaice advection (with thsice and
1495        seaice diffusion): do ice advection after ice-Thermodynamic (previously
1496        was done before); change aim_do_physics.F (split the bi,bj loops block);
1497      - use same CPP option (OLD_THSICE_CALL_SEQUENCE) to recover old sequence;
1498    o pkg/thsice:
1499      - add a missing EXCH of sIceLoad in thsice_main.F (ocean set-up) for the case
1500        where just seaice diffusion is used without seaice-dynamics.
1501    
1502    checkpoint64c (2013/01/18)
1503    o pkg/seaice:
1504      - add a parameter JFNKres_tFac that can replace JFNKres_t
1505        (= JFNKres_tFac*JFNKresidual before JFNK solver)
1506      - add a line search option to the JFNK solver
1507      - move update of u/vIce and computation of initial residual into a separate
1508        routine (same file); makes the code a little easier to read (?)
1509      - the line search requires computation of the residual and for some reason
1510        I cannot do the update of u/vIce at the beginning of the Newton loop
1511        without changing the results, so we move computation of the new residual
1512        also to the end of the Newton loop, even without the line search
1513    o pkg/mdsio:
1514      - write missing value (corresponding to undefined array value) to meta files;
1515        skip this if missing value is one (UNSET_RL would be a better value for the
1516        case of undefined missing value but it's current the default missing-value);
1517        Also update mdsio_read_meta.F (reading timeInterval & missing-value).
1518    o pkg/exf & thsice:
1519      - for diagnostics purpose, fill-up and update Qsw array (+ fill the
1520        diagnostics) even when SHORTWAVE_HEATING is #undef;
1521    o verification/cfc_example:
1522      - turn on pkg/layers with pkg/diagnostics (to test pkg/layers and to
1523        illustrate how to use it).
1524    o verification/offline_exf_seaice:
1525      in input: add SEAICErestoreUnderIce=.TRUE., and reduce size of forcing
1526        files to only one time-record.
1527      in input.thermo: narrow the 2 bands of low initial ice-concentration near
1528        N & S edges; switch on SEAICErestoreUnderIce=T; use pkg/diagnostics for
1529        snapshot output; same mcPheePiston value as in thsice with
1530        surf-current=0.2m/s.
1531      in input.thsice: similar set-up as in input.thermo (channel with same seaice
1532        initial conditions).
1533    o verification/cfc_example:
1534      - update file "data" with more standard choice (default rotationPeriod,
1535        exactConserv=T, reduce ivdc_kappa to 10, remove multiDimAdvection=F,
1536        set deltaTFreeSurf to deltaTtracer) and update the output.
1537    o pkg/layers:
1538      - fix bolus part so that it compiles with #undef GM_BOLUS_ADVEC;
1539      - ensure that "layers_bolus" is switched to False when useGMRedi=False.
1540    o verification/offline_exf_seaice:
1541      - set all {field}period to zero for constant-in-time forcing (not tested
1542        anywhere else).
1543    o verification/offline_exf_seaice:
1544      - dyn_lsr  : use pkg/seaice S/R (instead of pkg/thsice) to advect sea-ice;
1545      - dyn_jfnk : use pkg/thsice S/R (instead of pkg/seaice) to advect sea-ice.
1546    o model/src:
1547      - implement Finite-Volume method for (hydrostatic) presure gradient
1548        from S.-J. Lin (QJRMS 1997), for atmosphere using sigma-coordinate.
1549    o pkg/seaice: implement EVP* by Lemieux et al. (2012).
1550      - In order to be compatible with the default EVP code, this requires changing
1551        the EVP code around a little; and because any small change immediately
1552        breaks the lab_sea.hb87 verification experiment, the reference output is
1553        updated two times (each time the remaining aggrement was only 2 digits):
1554        - after replacing 1/dt by 1*recip_dt with a precomputed recip_dt
1555        - after replacing 1/(1+0.5*dt/tau) by a/(a+1), with a=2*tau/dt
1556        The adjoint test lab_sea.evp also needed to be updated.
1557      - Turn on EVP* by setting SEAICE_deltaTevp as before, and setting
1558        SEAICEuseEVPstar=.true.; for EVP* SEAICE_deltaTevp does not need to be
1559        a factor of SEAICE_deltaTdyn, and you can set the number of EVP steps
1560        explicitly with SEAICEnEVPstarSteps (thereby overriding the default of
1561        INT(SEAICE_deltaTdyn/SEAICE_deltaTevp)). Controlling EVP* is deliberately
1562        kept obscure, because I need to test it a little more.
1563    o pkg/cheapaml:
1564      - fix few incorrect type (_RL/_RS) in subroutine calls.
1565    o pkg/seaice:
1566      - new S/R SEAICE_MAP_RS2VEC (similar to SEAICE_MAP2VEC) to map _RS arrays
1567        to _RL vector; this fixes JFNK code when compiling with "-use_r4" option.
1568    o model/src:
1569      - add a warning if using select_rStar=2 with nonlinFreeSurf <> 4;
1570        change (in input_ad*/data) select_rStar from 2 to 1 for AD verification
1571        experiments global_ocean.cs32x15 & tutorial_tracer_adjsens (+ update output)
1572    o pkg/cheapaml:
1573      - replace "273.1 _d 0" by celsius2K in pkg/cheapaml/cheapaml.F and
1574        update output of experiment cheapAML_box.
1575      - store in CHEAPAML.h coeffs ssq[0:2] for saturation specific humidity,
1576        and set them only in one place (cheapaml_readparms.F).
1577      - replace "273.16 _d 0" by celsius2K & replace "3.14159 _d 0" by constant "PI"
1578      - remove re-setting of main-model parameter "celsius2K" (in cheapaml_readparms)
1579        and re-setting of cheapAML params "lath" & "p0" (in cheapaml_init_varia).
1580    o model/src/the_main_loop.F:
1581      - fix revision 129 : need both ALLOW_ECCO and ALLOW_ECCO_EVOLUTION.
1582    o pkg/seaice:
1583      - remove legacy branch code.
1584      - retire SEAICE_GROWTH_LEGACY and SEAICE_CAP_HEFF accordingly.
1585    o verification/*/code*/SEAICE_OPTIONS.h:
1586      - remove documentation for retired CPP flags (SEAICE_GROWTH_LEGACY,
1587        SEAICE_CAP_HEFF).
1588    o pkg/cheapaml:
1589      - use standard routine (S/R GET_PERIODIC_INTERVAL) to decide when it is time
1590        to load new forcing fields.
1591      - add missing "_d 0" where it's needed; + some editing (improve indentation).
1592      - remove switch to "-r8" compiler option (no longer needed) in verification
1593        cheapAML_box, keep same output (small trucation error differences).
1594    o verification/offline_exf_seaice:
1595      - add thermodynamics only test.
1596    o verification/cheapAML_box:
1597      - split the domain in 8 (2x4) tiles; add MPI and multi-threaded test;
1598        keep same output (same 14 digits for cg2d).
1599      - switch on "-r8" compiler option (some numerical values are missing
1600        the "_d 0") and update output (only 6 digits for cg2d were preserved).
1601    
1602    checkpoint64b (2012/12/24)
1603    o pkg/cheapaml:
1604      - remove un-used variables (Qnet,EmPmR) from pickup files.
1605      - store tendency of advected variables into cheapaml pickup file
1606        and fix the AB-2 restart.
1607    o verification/offline_exf_seaice and lab_sea adjoint:
1608      - switch to new code (#undef SEAICE_GROWTH_LEGACY).
1609      - switch to 4 time steps in offline, consistent with lab_sea.
1610      - match parameters from SEAICE_GROWTH_LEGACY branch in data.seaice.
1611      - update results after change of experiment seaice.
1612    o pkg/seaice:
1613      - remove option SEAICE_MULTICATEGORY; has been replaced with run-time
1614        parameter SEAICE_multDim. Issue a warning if SEAICE_MULTICATEGORY is
1615        still defined since SEAICE_multDim needs to be set to MULTDIM value (from
1616        SEAICE_SIZE.h) to recover previous #define SEAICE_MULTICATEGORY default.
1617    o model/src:
1618      - add run-time parameter to select CG2D solver minimum-residual solution
1619        (in case of a poor convergence).
1620    o pkg/seaice/seaice_lsr.F
1621      - move calculation of matrix coefficients into new
1622        S/R SEAICE_CALC_LSR_COEFFS; for now this routine remains in the same
1623        file; the main purpose of this change is to be able to reuse the code
1624        in S/R SEAICE_PRECONDITIONER
1625      - modify the computation of the residual so that the mass of sea-ice
1626        is not used twice; this simplifies the calculations, but since
1627        the residual is never used except when LSR_mixIniGuess.ge.4---and this is
1628        not tested in testreport---this does not affect the testreport results.
1629    o verification/seaice_obcs:
1630      - disable SEAICE_GROWTH_LEGACY; reset input files to match those of
1631        verification/lab_sea/input.salt_plume; changes results/output.txt*
1632    o model/src:
1633      - adapt quasi-hydrostatic formulation to work with p or p* coordinate.
1634    o pkg/seaice:
1635      - improve description of parameters in seaice_fgmres.F and start
1636        cleaning up the code
1637      - change name of SCALPROD to SEAICE_SCALPROD and modify meaning of
1638        second argument
1639      - add a metric based on grid cell area to SEAICE_SCALPROD; update
1640        results of offline_exf_seaice.dyn_jfnk
1641      - compute initial residual norm in seaice_jfnk based on SEAICE_SCALPROD
1642    o pkg/aim_v23:
1643      - fix an other bug in dissipation heating (grid-cell area was missing).
1644    o model/src + pkg/seaice:
1645      - add global (multi-tile) linear solver for pair of tri-diagonal system
1646        along X and Y lines, respectively for U and V component.
1647        Note: 1) MPI and cube-exchange not yet coded.
1648            2) probably not accurate for poorly conditioned / large size problem.
1649      - add option for SEAICE_LSR to use global (multi-tile) tri-diagonal solver;
1650        default: not compiled and not used.
1651    o pkg/seaice:
1652      - first attempt at a multi-threaded fgmres solver for the JFNK solver:
1653        introduce bi/bj loops and use global_sum_tile_rl instead of
1654        mpi_allreduce in seaice_fgmres.F
1655      - improve diagnostics output for fgmres solver (seaice_fgmres.F)
1656      - replace a few unnecessary goto statements by if-blocks  (seaice_fgmres.F)
1657      - add a verification experiment for JFNK in offline_exf_seaice
1658    o verification:
1659      - change (for now, only fwd test) offline_exf_seaice experiment:
1660        use a re-entrant channel with idealized coastline (trapezoidal shape)
1661        at southern boundary to explore seaice dynamics and thermodynamics
1662        with simple forcing. Main set-up has dynamics+thermo and SST relaxation;
1663        secondary test (input.thsice) use thermodynamics only with SST relaxation.
1664      - add seaice-dynamics only secondary test using LSR and pkg/thsice advection.
1665    o pkg/exf:
1666      - disable "sstExtrapol" when Nr=1
1667    o verification:
1668      - add new experiment "cheapAML_box" (simple 1 layer set-up from Bruno Deremble)
1669        to test pkg/cheapaml.
1670    o pkg/aim_v23 & pkg/shap_filt:
1671      - fix dissipation heating (erroneous gravity multiplication factor).
1672    o pkg/seaice:
1673      - remove unused field pressPre from jfnk solver
1674      - rename two subroutines in seaice_preconditioner.F
1675    o eesupp/src:
1676       - S/R MDSFINDUNIT avoids reserved unit numbers (scrUnit1, eeDataUnit ...)
1677    o pkg/seaice/seaice_preconditioner.F: fix preconditioner once again
1678       - remove wrong parts of the rhs and the lhs (were in there
1679         because I did not understand the concept of this preconditioner)
1680       - add an exchange between u- and v-sweep. This increases communication
1681         by a factor of two but improves the convergence of jfnk. Ideally,
1682         one would like the u- and v-sweep to be independent. So far within
1683         undocumented ifdefs
1684       - reorganize the extra computations for printing the residuals
1685    o tools/genmake2:
1686      - comment out the "mpif.h" include in NetCDF test programm (for MPI built)
1687        since it's not necessary (and was preventing to use MNC in some cases).
1688    
1689    checkpoint64a (2012/11/16)
1690    o pkg/autodiff:
1691      - improve pkg-internal logical parameter switch (inAd/inFwd mode) so that
1692        autodiff_readparms.F no longer depends on calling order (within
1693        packages_readparms.F) and no longer requires to include ${PKG}_PARMS.h):
1694        rename param turnFreeDriftInAdMode to SEAICEuseFREEDRIFTswitchInAd
1695        and change param SEAICEuseDYNAMICSinAdMode to SEAICEuseDYNAMICSswitchInAd.
1696    o pkg/obcs:
1697      - adding tidal velocity forcing capability to obcs
1698        for usage example, see verification/seaice_obcs/input.tides
1699    o pkg/seaice:
1700      - turn the LSR-relaxation parameters WFAU/V into runtime parameters
1701        SEAICE_LSRrelaxU/V
1702      - introduce runtime parameter SEAICEetaZmethod (=0 by default)
1703    o pkg/aim_v23:
1704      - implement heating from friction (bottom friction and stratospheric drag).
1705    o pkg/shap_filt:
1706      - fix diagnostic "SHAP_dKE" (was 2 time smaller); implement heating from
1707        dissipation but only for Shap_funct=2, active when addFrictionHeating=T.
1708    o model/src:
1709      - move AddMass common block from DYNVARS.h to FFIELDS.h; allow to read-in
1710        time-constant addMass field from file (addMassFile);
1711      - support for heating due to friction (and Kinetic Energy dissipation):
1712        add option, run-time switch and 3-D field array + support code ; each pkg
1713        or S/R can add heating contribution (if there is a sink of KE); the sum is
1714        accounted for as a Temperature tendency term (EXTERNAL_FORCING_T).
1715    o pkg/seaice:
1716      - complete merge of ITD code into seaice_growth.F
1717        from MITgcm_contrib/torge/itd/code/
1718        no verification so far, but Torge Martin tested
1719        "1-D test case and Beaufort set up;
1720        deliver okay results after 1 model year."
1721      - complete merge of SEAICE_SIZE.h into all relevant routines
1722      - move computation of eta at Z-points into calc_viscosities
1723        + introduce global field etaZ
1724        + add different methods for computing etaZ, for now the old
1725          method (simple averages of eta to Z-points) is hardwired
1726        + replace etaMeanZ by etaZ in seaice_lsr, seaice_calc_residual,
1727          seaice_preconditioner
1728      - simplify computations for SEAICE_ZETA_SMOOTHREG
1729      - seaice_preconditioner:
1730        + replace one remaining press by pressLoc (mistake)
1731        + adjust printing of residuals
1732      - improve I/O of diagnostics of JFNK in seaice_jfnk.F:
1733        + add (SEAICE.h) and rename some counters (initiliased in
1734          seaice_init_fixed.F)
1735        + add _BEGIN/END_MASTER (myThid)  around print statements
1736        + print total number of iterations and failures over SEAICE_monFreq
1737          interval to STDOUT
1738      - move control over output-messages by fgmres to seaice_jfnk to save
1739        some operations
1740      - move resetting initial guess for fgmres outside of seaice_fgmres_driver
1741        in order to make restarts with sol .ne. zero (fgmres with restarts)
1742        (seaice_jfnk.F, seaice_fgmres.F)
1743      - seaice_calc_l/rhs.F: replace maskW/S by maskInW/S; this fixes
1744        a serious convergence problem when open boundaries are involved
1745    o pkg/ggl90: fix computation of control volumes for the case of
1746      ALLOW_GGL90_HORIZDIFF (probably not used very often): move control volumes
1747      up half a grid cell from C-centered to W-centered (pointed out by C. Eden)
1748    o pkg/seaice: simplify seaice_evp by avoiding use of extra fields u/vIceC
1749    o pkg/autodiff
1750      - Add inAdMode switch for SEAICEuseDYNAMICS:
1751        SEAICEuseDYNAMICSinAdMode
1752        (extend logic in ADAUTODIFF_INADMODE_SET)
1753    o pkg/seaice
1754      - Step 1 of merging ice-thickness distribution (ITD) code from
1755        MITgcm_contrib/torge/itd/ (author: Torge Martin)
1756        The code implements concept laid out in Thorndike et al. (1975);
1757        code is enabled via CPP flag SEAICE_ITD
1758        nITD (in SEAICE_SIZE.h) defines number of ice thickness categories;
1759        code is not complete yet!!
1760      - SEAICE_SIZE.h now included in almost all seaice routines
1761    o verification (using seaice):
1762      - switch back seaice-dynamics (+ lower SOLV_MAX_ITERS) in ADM exp.
1763        global_ocean.cs32x15.seaice ; update results.
1764      - compile B-grid dynamics in FW test exp 1D_ocean_ice_column ;
1765      - compile C-grid dynamics with #define SEAICE_ALLOW_JFNK in FW test exp
1766        offline_exf_seaice (previously compiling B-grid).
1767    o pkg/exf:
1768      - fix some STOP conditions in exf_check.F (from Aug 28, modifs did not allow
1769        to specify neither just 1 comp of wind or wind-stress, nor no surface momentum
1770        forcing): just replace CPP option ALLOW_ATM_WIND with run-time param useAtmWind.
1771    o pkg/layers (adjust changes from Sept 19):
1772      - do snap-shot output and fill diagnostics from inside iLa loop (layers_calc.F)
1773        this allows to remove "layers_maxNum" dimension from all layers arrays.
1774    o pkg/layers (adjust changes from Sept 19):
1775      - remove ALLOW_LAYERS_OUTPUT ; fix snap-shot and time-ave output ;
1776      - snap-shot extended to all type of layers (not just the 1rst type);
1777      - remove layers variables when corresponding CPP option is undef.
1778    o pkg/layers:
1779      - rename pkg/layers variable and add new output (layer exist & un-weighted
1780        velocity in layer)
1781    o pkg/seaice:
1782      - simplify (?) ocean-drag coefficent computations by using
1783        the same routine in all three solvers (saves some code lines)
1784      - remove global fields DRAGA and DRAGS from C-grid code and
1785        declare them locally in lsr.F (the only place where they are
1786        still used)
1787      - update AD output of lab_sea.evp (very sensitive anyway).
1788    o pkg/seaice: add Jacobian-free Newton Krylov solver for ice dynamics
1789      (Lemieux et al. 2010, 2012). Turn on with the usual SEAICE_ALLOW_JFNK
1790      and SEAICEuseJFNK=.true. A few things to note:
1791      - involves a FGMRES, that is parallel but very inefficient,
1792        because of many scalar products (global sums) in the Gram-Schmidt
1793        orthogonalization method. Needs to be replaced. Original code
1794        from J.-F. Lemieux
1795      - preconditioner for FGMRES is a stripped down version of LSOR
1796      - SOLV_MAX_ITERS is now used for LSOR as a solver and as a
1797        preconditioner. For the preconditioner, the default is set to 10.
1798      - Jacobian times vector is computed with finite differences
1799      - marginally related to JFNK-solver: add a smooth regularization for
1800        zeta with tanh that will improve convergence (Lemieux and Tremblay,
1801        2009) for any implicit solver (not implemented for EVP because EVP
1802        does not need this regularization in the first place). Define
1803        SEAICE_ZETA_SMOOTHREG in SEAICE_OPTIONS.h to use.
1804    o eesupp/src:
1805      - check in genmake2 that intrinsic S/R flush is available.
1806      - add S/R to flush IO unit (if intrinsic S/R flush is available)
1807      - flush standard & error msg unit before MPI termination
1808      - if debugMode, flush IO unit after printing msg
1809    o pkg/ctrl:
1810      - ctrl_unpack.F, ALLOW_GENARR3D_CONTROL code: fix missing argument in call
1811        to ctrl_set_unpack_xyz.
1812    
1813    checkpoint64 (2012/10/09)
1814    o pkg/shelfice
1815      - in mom_fluxform.F, mom_vecinv.F:
1816        CALL SHELFICE_V_DRAG(bi,bj,k,vFld,KE,KappaRU,vF,myThid)
1817        Bug fix KappaRU -> KappaRV
1818        does not change verification/isomip but may change other setups
1819        (presumably constant KappaRU=KappaRV)
1820      - fix diagnostics SHIU/Vdrag (thanks to Tom Millgate)
1821    o pkg/obcs:
1822      - fixed some indexing bugs in obcs_seaice_sponge.F
1823      - added obcs relaxation subroutines for HSALT and HSNOW
1824      - changes verification/seaice_obcs/results/obcs_seaice_sponge.F
1825    o pkg/seaice:
1826      - add "multicategory" parameterization for snow in analogy to ice,
1827        default is off for now.
1828    o pkg/obcs:
1829      - added obcs_seaice_sponge.F for obcs relaxation of seaice variables;
1830        see verification/seaice_obcs/input.seaiceSponge for example application.
1831      - remove local commom bloc "OBCS_GLOBAL" in obcs_readparms.F and do all the OB
1832        index setting by master-thread. This fix multi-threads Pb in previous modifs.
1833    o pkg/layers :
1834      - add diagnostics to pkg/layers
1835      - move the meat of pkg/layers from layers_calc.F to layers_fluxcalc.F
1836        (from R.Tulloch). Layers_calc.F now calls layers_fluxcalc.F accordingly.
1837    o pkg/generic_advdiff/gad_implicit_r.F :
1838      - fix ADVr diagnostics in case of both implicit vertical advection and diffusion.
1839    o pkg/seaice/seaice_growth.F:
1840      - fix SItflux diagnostics in virtual salt flux + balanceEmpmr case.
1841    o pkg/obcs:
1842      - change default setting of OBCS_UVICE_OLD from defined to undef;
1843      - use new parameter OB_indexNone for null index value (instead of hard-coded 0)
1844        in all pkg/obcs code and in other pkgs; remove k loop in obcs_check_depths.F;
1845      - pass OB_indexNone as (new) argument to S/R CTRL_MASK_SET_[X,Y]Z;
1846      - change OB null index value (OB_indexNone) to -99 ; this fix the problem
1847        with Southern & Western OB at a tile edge (at least in a simple set-up).
1848    o pkg/obcs:
1849      - change settings of OB index in case OB coincides with tile edge (shared by
1850        2 tiles), so that common OB location is registered by both tiles (instead of
1851        only 1). However, for Southern and Western OB, index value = 0 is not
1852        recognized as valid OB index (=default null value) and needs to be fixed.
1853      - modify accordingly OBCS_BALANCE_FLOW and OBCS_MONITOR (avoid double counting)
1854      - new parameter "OB_indexNone" for null index value (for now, still zero)
1855        to replace hard-coded null index value of zero.
1856    o pkg/exch2:
1857      - improve W2_USE_E2_SAFEMODE (faster) and W2_E2_DEBUG_ON:
1858        always check buffer-size (but outside the loop); move checking for valid
1859        index from W2_USE_E2_SAFEMODE to W2_E2_DEBUG_ON; in W2_E2_DEBUG_ON,
1860        print each tile and point connection only if |W2_printMsg|>= 2 and 3.
1861    o pkg/ctrl (pack & unpack):
1862      - in ctrl_pack.F & ctrl_unpack.F, use the same local file-name variable
1863        (locally defined) for different variables (+ remove the variable-specific
1864        file name in CTRL_GENARR.h). For now, only implemented for GENARR2/3D_CONTROL
1865        (to be extended to other local file names in ctrl.h).
1866    o pkg/flt:
1867      - add a FLT_Iter0 option (similar to PTRACERS_Iter0).
1868    o pkg/mdsio:
1869      - fix missing STOP in mdsio_readvec_loc.F (case ioUnit=0) when file is missing
1870    o tools/genmake2:
1871      - add similar dependences for target EXE_AD & EXE_FTL as we have for EXECUTABLE
1872        (added by Alistair in version 1.51 for building without make depend);
1873      - remove Header files list (H_SRC_FILES) from the dependence of targets
1874         ad_input_code.f & ftl_input_code.f (not clear why it was added in the first
1875        place in version 1.23): this save going through staf when unrelated header
1876        file has been modified.
1877       Note: for an intermediate target (e.g., ad_input_code.f or adtaf) without
1878        "make depend" step, still need to do "make links" before "make adtaf".
1879    o eesupp/src (+ few pkg src files) & genmake2:
1880      - finish to remove ALWAYS_USE_MPI in source code that TAF does not see;
1881      - no longer set ALWAYS_USE_MPI in Makefile (was done by genmake2).
1882      - improve genmake2 checking for ALLOW_${PKG} in CPP_OPTIONS.h files (distinguish
1883         upper/lower case ; account for space between "#" and undef/define)
1884    o pkg/flt (with exch2):
1885      - cleaning: fix so that it compiles; move remaining MPI calls out of flt_exch2.F;
1886      - simplify threads synchronisation; fix (many issues) multi-threaded with MPI.
1887    
1888    checkpoint63s (2012/09/05)
1889    o pkg/ecco:
1890      - remove #ifdef ALLOW_SMOOTH_CORREL3D brackets.
1891      - add more relevant #ifdef ALLOW_SMOOTH ones.
1892      - sort out useAtmWind, useSMOOTH, ctrlSmoothCorrel2D.
1893    o pkg/ctrl:
1894      - CTRL_OPTIONS.h : document CPPs related to smoothing; ALLOW_SMOOTH_CORREL2D/3D,
1895        ALLOW_CTRL_SMOOTH, ALLOW_SMOOTH_CTRL2D, ALLOW_SMOOTH_CTRL3D.
1896      - ctrl.h : document run time params doInitXX, doMainPack, doMainUnpack, doPackDiag,
1897        doSinglePrecTapelev (audodiff param!), ctrlSmoothCorrel2D (new) and
1898        ctrlSmoothCorrel3D (new).
1899        The added ctrlSmoothCorrel2D/3D replace the old ALLOW_SMOOTH_CORREL2D/3D CPP.
1900      - ctrl_readparms.F : initialise ctrlSmoothCorrel2D/3D and read from namelist.
1901      - ctrl_init.F ctrl_pack.F ctrl_unpack.F : switch off ustress/vstress
1902        controls when useAtmWind, and vice versa.
1903      - ctrl_map_ini_ecco.F : UVEL0, VVEL0, edtaux, edtauy cannot be smoothed as tracers.
1904      - ctrl_get_gen.F : replace #ifdef ALLOW_SMOOTH_CORREL2D with
1905          #ifdef ALLOW_SMOOTH, IF ctrlSmoothCorrel2D, IF useSMOOTH.
1906      - ctrl_map_ini_gen.F : replace #ifdef ALLOW_SMOOTH_CORREL3D with
1907          #ifdef ALLOW_SMOOTH, IF ctrlSmoothCorrel3D, IF useSMOOTH.
1908      - ctrl_set_pack_xy[z].F, ctrl_set_unpack_xy[z].F:
1909        replace ALLOW_SMOOTH_CORREL2D/3D brackets with ctrlSmoothCorrel2D/3D.
1910    o pkg/smooth:
1911      - remove un-necessary includes.
1912      - remove ALLOW_SMOOTH*D and ALLOW_SMOOTH_CORREL*D brakets.
1913        Those CPP options were never defined, and not necessary.
1914    o model/src:
1915      - fix CPP brackets in ini_mixing.F (GM_background_K belongs to gmredi).
1916      - standard treatment of useSMOOTH.
1917    o pkg/autodiff:
1918      - add LOGICAL useGGL90inAdMode, useGGL90inFwdMode, useSALT_PLUMEinAdMode,
1919        useSALT_PLUMEInFwdMode allowing to switch off ggl90 and salt_plume adjoint.
1920    o pkg/exch2:
1921      - add "if usingMPI" where it was missing (in exch2_rx?_cube*.template)
1922        + start to remove ALWAYS_USE_MPI in source code that TAF does not see.
1923      - make new S/R W2_MAP_PROCS out of w2_eeboot.F to setup exch2 CommonFlag
1924        and tiles to process mapping.
1925      - re-arrange 3 header files (W2_EXCH2_PARAMS.h, _BUFFER.h & _TOPOLOGY.h)
1926        moving /EXCH2_FILLVAL_RX/ & /W2_EXCH2_COMMFLAG/ to W2_EXCH2_TOPOLOGY.h;
1927        rename "exch2_tProc" to "W2_tileProc" and move seting of e2FillValue_RX
1928        from w2_eeboot.F to w2_readparms.F.
1929    o eesupp/src:
1930      - set exchNeedsMemsync & exchUsesBarrier according to "usingMPI" (instead of
1931        ALWAYS_USE_MPI) + moved from ini_communication_patterns.F to eeset_parms.F;
1932        also move setting of exchCollectStatistics from exch_init.F to eeset_parms.F
1933      - in eedie.F and all_proc_die.F, always call MPI_FINALIZE when ALLOW_USE_MPI
1934        is defined (remove condition on usingMPI) to match cases where MPI_INIT
1935        has been called.
1936      - fix bug I put in previous modif of exch_sm_3d_rx.template (not much used);
1937      - change default (non-MPI) value of myPid (from 1 to 0) to match MPI settings
1938        (so that on 1 proc, get same myPid independently of usingMPI)
1939      - add a stop if multi-procs but usingMPI=F ; stop also if usingMPI=T and
1940        useCubedSphereExchange with EXCH-1 (safer).
1941      - add "if usingMPI" where it was missing (+ start to remove ALWAYS_USE_MPI).
1942    o pkg/ggl90:
1943      - fix bug in filling corner mask array "mskCor" (FILL_CS_CORNER_TR_RL call)
1944        used in ALLOW_GGL90_SMOOTH code.
1945    o pkg/flt:
1946      - fix typo in FLT_WITHOUT_Y_PERIODICITY (the effect was to ignore stopping
1947        floats at the Southern end of the domain).
1948    o eesupp/inc:
1949      - add a list of CPP-options which can be set by Makefile (DEF_IN_MAKEFILE.h);
1950        but not used (and not to be used) anywhere, just for documentation.
1951    o pkg/autodiff, exf, ptracers & seaice (AD & TL output):
1952      - comment out the very nasty "writeBinaryPrec = writeStatePrec" line, since:
1953        a) can damage previously written records in any other multi-record files.
1954        b) if needed, can easily do it cleanly, by calling S/R WRITE_REC_3D_RL/S.
1955    o tools/genmake2:
1956      - define variable MAKE within Makefile and use it in place of 'make';
1957      - update AD_CONFIG.h (if needed) before building any of the executable
1958        (forward, adjoint or tangent-lin); this involves a 2nd invocation of make;
1959        and add the usual #ifndef/#define AD_CONFIG_H in AD_CONFIG.h;
1960      - always print usual warning comment 'this file is automatically generated'
1961        from script convert_cpp_cmd2defines (+ remove this warning from genmake2).
1962    o pkg/cheapaml:
1963      - updated to correspond to the code used in accepted paper (Nico Wienders).
1964    o pkg/exf:
1965        added run time switch useAtmWind to replace ALLOW_ATM_WIND cpp switch.
1966        ALLOW_ATM_WIND now just sets the useAtmWind default (see exf_readparms.F)
1967        and force defines ALLOW_BULKFORMULAE (EXF_OPTIONS.h).
1968    o pkg/exf, autodiff, ctrl, ecco and seaice:
1969        remove ALLOW_ATM_WIND brackets, or replace them with useAtmWind ones.
1970    o pkg/ctrl, ecco:
1971        allow to compile both ALLOW_U/VSTRESS_CONTROL and ALLOW_U/VWIND_CONTROL.
1972        Depending on useAtmWind, one is inactive, and the other is active (see
1973        exf_getffields.F/exf_getsurfacefluxes.F).
1974    o tools/genmake2:
1975      - improve error msg when failing in 2nd test of check_for_broken_Ff
1976      - fix option '-makefile' short-name (-mf according to genmake2 -help)
1977      - source local config file "genmake_local" just after processing the genmake2
1978        command arguments (previously done before processing arg).
1979    o pkg/grdchk:
1980      - add a call to TURNOFF_MODEL_IO for Tangent-Linear run (in this case, call
1981        to this routine from cost_final has been dropped in g_cost_final)
1982      - improve printed information (more explicit msg, no longer using "print *,"
1983         fix fcpertminus printed value).
1984    o model/src:
1985      - move call to COST_INIT_VARIA out of packages_init_variables.F directly
1986        into initialise_varia.F (just after calling PACKAGES_INIT_VARIABLES):
1987        this prevents getting cost-funct reset in adinitialise_varia recomputations.
1988    o pkg/dic:
1989      - move initialisation of "freefe" array from from dic_biotic_forcing.F to
1990        fe_chem.F: this prevents TAF from dropping this initialisation in TLM code.
1991    o pkg/grdchk:
1992      - grdchk_main.F : added CALL GLOBAL_SUM_INT( ierr , myThid )
1993      - grdchk_getadxx.F etc. : omit I/O if ierr.EQ.0
1994    o pkg/autodiff/ctrl/grdchk :
1995      - attempt to sort out what works and what does not,
1996        with regard to I/O, and to warn/stop accordingly.
1997    o pkg/grdchk:
1998      - attempt to fix grdchk in the case of useSingleCpuIO.
1999      - "if ( myProcId .EQ. grdchkwhichproc .AND. ierr .EQ. 0 )"
2000       statements were moved from grdchk_main.F and into
2001       grdchk_getadxx.F grdchk_getxx.F grdchk_setxx.F.
2002      - a global sum is applied to record numbers icvrec/layer
2003       out of grdchk_loc so that they be passed to I/O routines.
2004    o pkg/smooth:
2005      - fix recomputation that appeared with nlfs : use smooth_recip_hFacC,
2006        smooth_hFacW, smooth_hFacS (copied at init_fixed) in 3d case.
2007    o verification/testreport:
2008      - add option '-tlm' for Tangent-Linear test (-adm,-oad,-tlm are all exclusive);
2009      - can also use compressed (gzip) reference output file;
2010      - change format (in pkg/grdchk) of TLM output (+ add forward gradient)
2011        to be easier to collect by testreport.
2012      - update existing TLM output (half out-of-date by more than 3 yrs).
2013      - report NETCDF & LAPACK settings (from genmake2) in output dir.
2014      - report run-time in each individual summary (previously only for AD test);
2015        for TLM test, add also TAF version.
2016      - add daily TLM test on (old) aces cluster + weekly test on baudelaire.
2017    
2018    checkpoint63r (2012/08/15)
2019    o tools/genmake2:
2020      - fix Makefile for target ftlall (+ update files to clean after make ftlall)
2021    o pkg/ecco/ecco_cost_final.F :
2022      - fix fc print statements (to stdout and costfunction0000) so
2023        that the printed value is always after the global sum.
2024    o pkg/seaice/seaice_dynsolver.F :
2025      - fix ice strength assymptote at SEAICE_area_max<1
2026        (no change for the standard case of SEAICE_area_max=1)
2027    o some cleaning:
2028      - pkg source files: ensure that all *.F files from each pkg included the
2029        corresponding ${PKG}_OPTIONS.h file (except stand-alone src file which
2030        only includes CPP_EEOPTIONS.h); fix S/R CTRL_SMOOTH ; update AD experiment
2031        code_ad/*.F src files; add new option-file in pkg/admtlm + corresponding
2032        includes;
2033      - model/src: add PACKAGES_CONFIG.h wherever ALLOW_AUTODIFF[_TAMC] is used.
2034      - ALLOW_DIFFKR_CONTROL: add a stop in S/R CTRL_CHECK in case ALLOW_3D_DIFFKR
2035        is undef; also define /DYNVARS_DIFFKR/ common block in DYNVARS.h when
2036        ALLOW_DIFFKR_CONTROL is defined, to allow to compile and reach this stop.
2037      - update option-file CPP_OPTIONS.h of all AD experiments:
2038        * no longer include PACKAGES_CONFIG.h ;
2039        * includes ECCO_CPPOPTIONS.h if PACKAGES_CONFIG.h has been included ;
2040        * def/undef ALLOW_3D_DIFFKR independently of ALLOW_DIFFKR_CONTROL (before
2041          including ECCO_CPPOPTIONS.h).
2042    o pkg/cost, pkg/ctrl, pkg/ecco option-file:
2043      - clean-up and split content of old pkg/ecco/ECCO_CPPOPTIONS.h file into
2044        separated pkg option-file (done according to old doc from ECCO_CPPOPTIONS.h,
2045        not necessary accurate).
2046      - add a template for option-file ECCO_CPPOPTIONS.h, mostly empty, in
2047        pkg/autodiff, i.e., the 1rst pkg to compile for adjoint built, with lines to
2048        deliberately break compilation (a remainder that it needs to be customized)
2049      - in pkg/ecco, includes ECCO_OPTIONS.h instead of COST_OPTIONS.h
2050      - rename COST_CPPOPTIONS.h to COST_OPTIONS.h
2051      - rename CTRL_CPPOPTIONS.h to CTRL_OPTIONS.h
2052    o tools/genamke2:
2053      - check for lapack.
2054    o pkg/cost and pkg/ecco : attempt to sort out some of the limiting intricacies.
2055      - pkg/cost.cost_final.F : allow for use of pkg/ecco and pkg/cost cost functions
2056        jointly. The exclusive ifdefs were removed, to add costs terms (when defined)
2057        from both packages.
2058      - the fc global sum in pkg/ecco/ecco_cost_final.F was removed accordingly.
2059      - for objf_atl we use either the pkg/ecco or the pkg/cost term depending on CPPs.
2060      - pkg/ecco and model/src : add CPP brackets around pkg/cost and pkg/ctrl includes
2061        of "CTRL_SIZE.h" "ctrl.h" "ctrl_dummy.h" "optim.h" / "cost.h" accordingly.
2062    o pkg/cost : add comments to explain special and/or untested setups.
2063    o pkg/exf:
2064      - use EXF_OPTIONS.h to set pkg/exf options except if done in ECCO_CPPOPTIONS.h
2065        (previously, ALLOW_AUTODIFF_TAMC was controling this switch).
2066    o verification/*/code_ad:
2067      mimimal cleaning of AD experiments ECCO_CPPOPTIONS.h option-file:
2068      - reccord when this file is included (define ECCO_CPPOPTIONS_H)
2069      - remove the most obvious obsolete features (e.g., #define ALLOW_COST not
2070        allowed since Oct 2003 in any option-file except in PACKAGES_CONFIG.h)
2071    o pkg/seaice :
2072      - added possibility to change ice strength/PRESS0 relationship to
2073        HEFF, according to the following run time parameters
2074        SEAICEpresPow0 :: HEFF exponent for ice strength below SEAICEpresH0 (integer, >0)
2075        SEAICEpresPow1 :: HEFF exponent for ice strength above SEAICEpresH0 (integer, >0)
2076        SEAICEpresH0   :: HEFF threshold for ice strength            (m)
2077    o pkg/ggl90 :
2078      - added run time flag mxlSurfFlag to include the code that ensure
2079        mixing between first and second level (previously included as a comment)
2080    o verification/1D_ocean_ice_column/input_ad/data.autodiff :
2081      - add test of newly added dumpAdByRec=T option where
2082        we write all records to one file per variable.
2083    o verification/global_ocean.cs32x15/code_ad/CPP_OPTIONS.h :
2084      - switch to #define ALLOW_BALANCE_RELAX and ALLOW_BALANCE_FLUXES
2085        to check that this code is ok with taf and compiles in adjoint.
2086    o pkg/autodiff :
2087      - added run time param dumpAdByRec : ad dump format switch.
2088        If true then write all records to one file per variable.
2089        Else write one file per record (remains the default).
2090      - revise seaice_ad_dump.F and exf_adjoint_snapshots_ad.F accordingly.
2091    o pkg/seaice:
2092     - Added SEAICEuseTILT run time switch : if set to
2093       false then omit the tilt term in seaice dynamics.
2094     - Fix free drift calculation.
2095    o pkg/shelfice:
2096      When initializing SHELFICEDragQuadratic, set default to be
2097      consistent with shiCdrag in case SHELFICEuseGammaFrict is used,
2098      but retain option to set it independently
2099      (inconsistenty spotted by Veronique Dansereau)
2100    o eesupp/inc:
2101      - in EEPARAMS.h, add real-type constant for some frequently used simple number
2102         (0,1,2,1/2), with name explicitly referring to RS/RL type.
2103    o model/src:
2104      - move balancing of relaxation terms to new S/R balance_relax.F.
2105    o pkg/autodiff:
2106      re-write active I/O high-level (control) S/R:
2107      - rename  S/R ACTIVE_READ/WRITE_RL to ACTIVE_READ/WRITE_3D_RL
2108      - add 1 more argument (useCurrentDir) to replace the "_LOC" 2nd set of S/R.
2109      - use standard pkg/mdsio I/O routines (MDS_READ/WRITE_SEC_XZ/YZ  and
2110        MDS_READ/WRITE_FIELD); change loops to multi-threads.
2111      - update and merge active_file_control_slice.flow into active_file_control.flow
2112      - update the calls in lower level S/R (active_file.F, active_file_g.F and
2113        active_file_ad.F) keeping the argument list and function unchanged.
2114      - also update lower-level "_LOC" version (call same S/R with "useCurrentDir
2115        =.TRUE.") and remove high-level (control) _loc version (not called anymore).
2116      - new low-level active I/O routines, one for each type (RL/RS), for active var
2117        of various (XY,XZ,YZ) shape and level number (arguments: arrShape, myNr);
2118        fix ctrl_init_wet.F & ecco_cost_weights.F by calling the new S/R with the
2119        right type.
2120    o autodiff and RS=real*4:
2121      - call the right type (_RS instead of _RL) of S/R in few output S/R (pkg/exf
2122        ad-monitor and snapshots); disable arrType='RS' in mdsio_gl*.F ;
2123      - change argument type of 3-D mask argument to _RS to match type in the call
2124        (in seaice_cost*.F, ctrl_*_gen.F and *ctrl_bound.F); to be continued.
2125    o pkg/thsice:
2126      - re-anable balanceEmPmR when useSEAICE=T with useThSIce=T.
2127      - option to correct ocean fresh-water flux for imbalance of Atmos+Land
2128        fresh-water flux: uniform correction or proportional to local precip.
2129    o pkg/ctrl:
2130      - new header file CTRL_SIZE.h for parameters maxCtrlArr2D, maxCtrlArr3D
2131      - redefine CPP option ALLOW_BOTTOMDRAG_CONTROL to
2132                            ALLOW_BOTTOMDRAG_CONTROL_NONGENERIC
2133      - verification/hs94.1x64x5/ tests ALLOW_GENARR{2D,3D}_CONTROL
2134    
2135    checkpoint63q (2012/07/30)
2136    o pkg/autodiff:
2137      note about monitor and snap-shot of ad-variables:
2138      a) need to apply ADEXCH before monitor or output of ad-vars to include
2139       overlap contributions (was done for adjDump but missing for monitor).
2140      b) since ADEXCH implies adding overlap values to interior array, machine
2141       truncation error is expected when adding an ADEXCH call in the middle of
2142       the time-stepping (although mathematically identical).
2143      modifs:
2144      - fix some incorrect type (RL/RS, UV/scalar) in ADEXCH calls and ad-vars
2145        declaration (adEddyPsiX,adEddyPsiY in adcommon.h).
2146      - add new run-time params (dumpAdVarExch & mon_AdVarExch) to select how  to
2147        apply ADEXCH before monitor or snap-shot of ad-variables:
2148           =0 : no ADEXCH ; =1 : do ADEXCH ; =2 : apply ADEXCH on a local copy.
2149      - implement new method (copy+adexch) for snap-shot and monitor of main model
2150        ad-vars (initially not used by default -> output unchanged).
2151      - change default (set to 2) to use new method and update few output_adm.txt
2152        with accurate ad-monitor (global_ocean.90x40x15, tutorial_global_oce_biogeo
2153        and both tutorial_tracer_adjsens tests).
2154      - switch 2 global_ocean.cs32x15 AD-tests to AB-2 (seaice_dynmix & thsice)
2155        and turn off momDissip_In_AB in the 2 other (needed for stable AB-3).
2156    o pkg/ctrl:
2157      enable the use of a variable number (maxCtrlArr2D, maxCtrlArr3D) of
2158      generic control variables via
2159      #define ALLOW_GENARR2D_CONTROL and/or #define ALLOW_GENARR3D_CONTROL
2160      Only required customization should be S/R ctrl_map_ini_genarr.F
2161      (routine in repository contains example)
2162    o pkg/exf:
2163      - fix and refine checking of surface-relaxation setting when using EXF
2164    o verification (adjoint exp):
2165      - reduce length of simulation by half for experiment global_ocean.cs32x15
2166        (std, seaice & seaice_dynmix) and exp tutorial_dic_adjoffline; update output.
2167    o pkg/mom_common (mom_u/v_bottomdrag), pkg/shelfice (shelfice_u/v_drag)
2168      - replace if statements KE.ne.0 with KE.gt.0 to avoid sqrt of negative numbers
2169        of KE that can occur with aggressive optimization
2170      + put quadratic bottom drag calculation in separated loops (only done if
2171        using bottomDragQuadratic)
2172    o model/src: CG2D_NSA
2173      - clean-up:  stop if cg2dNormaliseRHS=T and AUTODIFF
2174         and replace GLOBAL_SUM calls with GLOBAL_SUM_TILE.
2175      - in test-exp that uses CG2D_NSA (bottom_ctrl & tutorial_tracer_adjsens),
2176         change cg2d residual target to be expressed in Wunits (=> do not normalise
2177         RHS ; this fix global_max Pb with TAF); update output.
2178    o verification/tutorial_tracer_adjsens:
2179       improve parameter consistency (and get rid of warnings):
2180       - use deltaTFreeSurf=deltaTtracer (better with NonLin FreeSurf);
2181       - switch Temp Adv Scheme from 81 to 80 (no limiter since theta < 0 is physical)
2182       - use staggerTimeStep (for stability) in som81; use default rotation period.
2183    o pkg/exch2:
2184      - with empty facet: fix compact-format (W2_mapIO=1) definition (was previously
2185        reset to 0 = 1 long line in X)
2186    o pkg/mdsio:
2187      - fix reading of dimensions from meta file for large-size domain
2188    o model/src:
2189      - fix saltIsActiveTr setting for IdealGas eosType (eosType is 6 character long);
2190      - to refine CS-grid check, add logical flag "hasWetCSCorners": true if using
2191        Cubed-Sphere Exch with CS-corners inside the domain;
2192        make new S/R INI_GLOBAL_DOMAIN from code in ini_linear_phisurf.F to calculate
2193        globalArea and to set hasWetCSCorners.
2194      - add warning if usingCurvilinearGrid and momAdvection in flux-form (missing
2195        metric terms); stop if hasWetCSCorners=T and momAdvection in flux-form.
2196      - re-activate the stop if useCDscheme and hasWetCSCorners=T (previously if
2197        useCDscheme and useCubedSphereExchange).
2198    o pkg/seaice/seaice_growth.F :
2199      - compute the SEAICE_DISABLE_HEATCONSFIX term accordingly
2200        for the (.NOT.useRealFreshWaterFlux).OR.(nonlinFreeSurf.EQ.0)
2201        when the previous code was not correct.
2202      - in all cases diagnoze the boundary condition mismatch to SIaaflux
2203      - in the case of useRealFreshWaterFlux.AND.(nonlinFreeSurf.GT.0) add
2204        that term to QNET (essentially to set the melt/freeze water to 0degC).
2205        when SEAICEheatConsFix is true, so that the ocean+ice budget heat is closed.
2206    o verification/global_ocean.cs32x15/input.seaice :
2207      - add SEAICEheatConsFix in data.seaice, ensuring closed ocean+ice heat budget.
2208      - add diagnostics (commented out) for budget test using my matlab codes (gcmfaces).
2209      - update results (output.seaice.txt) accordingly.
2210    o verification/lab_sea/input/data.seaice :
2211      - remove SEAICEheatConsFix, which is now be tested
2212        in global_ocean.cs32x15. The presently coded fix
2213        is only consistent with real fresh water + nlfs.
2214      - update results (output.txt) accordingly.
2215    o pkg/salt_plume: added diagnotic for salt tendency (oceSPtnd).
2216    o AD_CONFIG.h file:
2217      - in genmake2: remove "#undef ALLOW_ECCO_OPTIMIZATION" from AD_CONFIG.h;
2218      - remove #include "AD_CONFIG.h" from all included OPTIONS files and
2219        add it explicitly in each fortran src file where it is needed.
2220        motivation: header file AD_CONFIG.h is generated/modified after "make depend"
2221        thus introducing potentially wrong dependency; therefore, better to include
2222        it only where it's really needed, and after any other included OPTIONS file
2223        (less tempting to bring conditional includes according to ALLOW_ADJOINT_RUN
2224        or ALLOW_TANGENTLINEAR_RUN).
2225    
2226    checkpoint63p (2012/07/06)
2227    o pkg/autodiff:
2228      - rename S/R INI_AUTODIFF to AUTODIFF_INIT_VARIA ;
2229      - create new header file "AUTODIFF_PARAMS.h" for pkg/autodiff parameters
2230        which are now read from new parameter file "data.autodiff" (inAdExact
2231        previously in "data", use{KPP/GMRedi/SEAICE}inAdMode previously in data.pkg)
2232      - add file "data.autodiff" in all verification/*/input_ad/ directories.
2233      - add run-time parameter to turn On/Off SEAICEuseFREEDRIFT in adjoint/forward
2234        mode (used in global_ocean.cs32x15.seaice_dynmix test exp.)
2235    o verification/tutorial_tracer_adjsens/
2236      - add extra sub-verification which uses "SOM" advection scheme
2237        (2nd Order-Moment Advection Scheme, Prather Limiter) with
2238          #define GAD_ALLOW_TS_SOM_ADV in GAD_OPTIONS.h
2239        and in data:
2240          multiDimAdvection=.TRUE.,
2241          tempAdvScheme=81,
2242          saltAdvScheme=81,
2243    o model/src:
2244      - introduce ALLOW_BALANCE_RELAX which allow the removal
2245       of the global mean of relaxation terms by setting
2246       balanceThetaClimRelax and balanceSaltClimRelax
2247      - disable balanceEmPmR and balanceQnet in the case when useSeaice.
2248       This case is now treated appropriately in seaice_growth.F
2249    o pkg/seaice:
2250      - do balanceEmPmR and balanceQnet based on the net fluxes
2251        (SItflux) that enter the ocean+ice system rather than QNET
2252        and EMPMR. Works best in real fresh water.
2253      - SIatmFW, SIatmQnet, and SItflux computations had to be moved
2254        out of the diagnotics bloc, and stored in global arrays.
2255    
2256    checkpoint63o (2012/06/29)
2257    o vertical mixing schemes:
2258      - remove unused S/R CALC_BUOYANCY (left from branch-atmos merging)
2259      - replace computation of density (in Function STATE1, opps_calc.F) by a call
2260        to S/R FIND_RHO_SCALAR
2261      - pass sigmaR to S/R PP81_CALC, MY82_CALC (but not yet used) and to GGL90_CALC
2262        and use it for N^2 calculation in ggl90_calc.F (save 2 density computations);
2263        affects output (vermix.ggl90) at truncation level.
2264    o testreport:
2265      - change adjustment of SIZE.h for mpi+mth testing: preserve enough tiles
2266        (nSx,nSy) for the number of threads (from eedata.mth)
2267    o model/src:
2268      - remove 2nd set of calls at the top of initialise_varia.F (Adjoint part)
2269        related to Non_Lin Free-Surf or Bottom-Control (but not longer necessary).
2270  o verification/tutorial_tracer_adjsens/  o verification/tutorial_tracer_adjsens/
2271    - compile with ALLOW_CG2D_NSA    - compile with ALLOW_CG2D_NSA
2272    - run with nonlinFreeSurf=3    - run with nonlinFreeSurf=3

Legend:
Removed from v.1.1675  
changed lines
  Added in v.1.2077

  ViewVC Help
Powered by ViewVC 1.1.22