/[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.1295 by jmc, Sat Sep 11 21:39:13 2010 UTC revision 1.2072 by dimitri, Thu Sep 25 00:40:49 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/obcs:
8      - add additional compile-time options for sponge boundary layers
9        (see pkg/obcs/OBCS_OPTIONS.h for details)
10    o pkg/atm_phys:
11      - implement simple (obliquity only, assuming circular planet orbit)
12        seasonal cycle for incoming insolation ; used when run-time parameter
13        "select_incSW" is set to 1 ; by default (=0), uses old unchanged formula.
14    o pkg/exf, pkg/ecco, pkg/ctrl:
15        - add ctrlUseGen and .NOT.ctrlUseGen exclusive brackets
16        - activate gentim2d for xx_atemp,xx_aqh,xx_swdown,xx_lwdown,xx_precip
17        - implement gentim2d for xx_tauu, xx_tauv
18    o pkg/ctrl, pkg/ecco :
19        - fix and complement the generic controls implementation
20    o pkg/exf/exf_getclim.F, exf_getffields.F, exf_getsurfacefluxes.F,
21        pkg/shelfice/shelfice_thermodynamics.F,
22        verification/hs94.1x64x5/code_ad/ctrl_map_gentim2d.F,
23        verification/hs94.1x64x5/code_oad/ctrl_map_gentim2d.F :
24      - add weight in CTRL_GET_GEN calls
25    o pkg/ctrl :
26      - ctrl_get_gen.F : add weight as input parameter, and apply
27        it directly rather than using smooth_correl2Dw (to be retired).
28      - ctrl_map_gentim2d.F : add wgentim2d in CTRL_GET_GEN call
29    o pkg/ctrl :
30      - introduce run time switch ctrlUseGen (in ctrl.h, ctrl_check.F,
31        ctrl_init_variables.F, ctrl_readparms.F, ctrl_summary.F)
32      - re-activate ctrl_summary (call in ctrl_init.F)
33    o pkg/ctrl/ctrl_cost_gen.F :
34      - fix CCP brackets, remove un-necessary myiter, mytime
35    o pkg/ecco, pkg/ctrl :
36      - remove cost_genctrl.F (now pkg/ctrl/ctrl_cost_driver.F)
37      - remove cost_forcing_gen.F (now pkg/ctrl/ctrl_cost_gen2d.F)
38      - add ctrl_cost_driver.F (replaces pkg/ecco/cost_genctrl.F)
39      - add ctrl_cost_gen2d.F (replaces pkg/ecco/cost_forcing_gen.F)
40    
41    checkpoint65d (2014/09/15)
42    o pkg/ctrl/CTRL_GENARR.h, ctrl_readparms.F :
43      - add xx_genarr2d_bounds,xx_genarr3d_bounds,
44        xx_genarr2d_numsmooth, xx_genarr3d_numsmooth
45    o pkg/ctrl/ctrl_map_ini_genarr.F :
46      - remove compilation failure
47      - replace hard coded example
48      - use ctrl_map_ini_gen2D, 3D
49    o pkg/ctrl/ctrl_pack.F, ctrl_unpack.F :
50      - on/off switch based upon xx_genarr2d_weight,3d
51    o src/packages_init_variables.F :
52      - regroup pkg/estimation calls
53      - remove CTRL_MAP_INI, CTRL_MAP_INI_ECCO
54        (moved to ctrl_init_variables)
55    o cost/cost_init_varia.F :
56      - remove ecco_cost_init_varia
57        (moved to ecco_init_varia)
58    o ctrl/ctrl_init_variables.F :
59      - add CTRL_MAP_INI, CTRL_MAP_INI_ECCO
60      - add CTRL_MAP_INI_GENARR, SEAICE_CTRL_MAP_INI
61    o ctrl/ctrl_map_ini.F :
62      - remove ctrl_map_ini_genarr, seaice_ctrl_map_ini
63        (moved to ctrl_init_variables)
64    o ctrl/ctrl_map_ini_ecco.F :
65      - remove ECCO_PHYS (mv to ecco_init_varia)
66      - remove seaice_ctrl_map_ini (mv to ctrl_init_variables)
67    o ecco/ecco_ad_diff.list :
68      - add ecco_init_varia.f
69    o ecco/ecco_init_varia.F
70      - new routine
71    o pkg/streamice:
72      - move call to STREAMICE_INITIALIZE_PETSC from the_model_main.F
73        to streamice_init_fixed.F ; fix setting of STREAMICEisOn.
74      - from model/src, only call pkg/streamice routines if useStreamIce is TRUE.
75    o pkg/generic_advdiff:
76      - fix bug causing negatives in GAD_SMOLARKIEWICZ_HACK, introduced 8/8/2014.
77    o pkg/exf:
78      - exf_getffields.F : add xxg_atemp, xxg_aqh, xxg_swdown, xxg_lwdown,
79         xxg_precip capability
80      - exf_wind.F : no need for ALLOW_WSPEED_CONTROL cpp switch
81    o pkg/ctrl:
82      - ctrl_pack.F, ctrl_unpack.F : omit (un)packing of undefined xx_gentim2d
83    o model/src/load_fields_driver.F :
84      - move call to CTRL_MAP_GENTIM2D ahead of BULKF_FIELDS_LOAD, EXF_GETFORCING
85        so xx_gentim2d can be applied to e.g. exf fields in a timely manner.
86    o OpenAD verification experiments:
87      - Include explicitly AUTODIFF_OPTIONS.h, COST_OPTIONS.h, and CTRL_OPTIONS.h
88        in src files (to enable to skip the ECCO_CPPOPTIONS.h);
89        for now, only in pkgs used in OpenAD verification experiments.
90      - Change all except one (halfpipe_streamice) OpenAD experiments to use pkg
91        specific option file (AUTODIFF_OPTIONS.h, COST_OPTIONS.h & CTRL_OPTIONS.h)
92        instead of using ECCO_CPPOPTIONS.h (with all relevant options in it).
93        This applies to both TAF (*/code_ad/) and OpenAD (*/code_oad/) tests.
94    o OpenAD verification tests:
95      - finish removing ALLOW_AUTODIFF_OPENAD (replaced by ALLOW_OPENAD);
96      - finish replacing ALLOW_AUTODIFF_TAMC by ALLOW_AUTODIFF (except for
97        tape/storage which are specific to TAF/TAMC) in pkgs used in OpenAD exp.
98      - leave ALLOW_AUTODIFF_TAMC undef in OpenAD verification tests (*/code_oad/)
99        and remove local copy of "tamc.h" (needed only if ALLOW_AUTODIFF_TAMC).
100    o model/src & generic_advdiff:
101      - change hard-coded loop-range in S/R APPLY_FORCING_T/S to set T & S
102        forcing over 0:sNx+1, 0:sNy=1 (instead of just 1:sNx,1:sNy): Model
103        dynamics requires valid tracer forcing only over tile interior but, for
104        some diagnostics, may need to extend it over 1 point in tile halo region.
105      - in gad_calc_rhs.F, update calls to gmredi_x/ytransport to get valid
106        tendency over i,j_Min,Max range. This allows to simplfy i,j_Min,Max
107        setting in temp/salt/ptracer_integrate.F
108    o pkg/dic:
109      - multiply tracer tendencies by maskInC (if ussing OBCS) before updating
110        gchem tracers: this allows to skip the 2nd call to OBCS_APPLY_PTRACER
111        in gchem_forcing_sep.F
112    o pkg/autodiff & obcs:
113      - add storage of current OB values for U & V (was already done for T & S).
114    
115    checkpoint65c (2014/08/30)
116    o pkg/dic:
117      - take out of dic_atmos.F the initialisation part (corresponding to istate=0)
118        and move it to new S/R DIC_INI_ATMOS ; also simplify the dependencies for
119        AD compilers (but still a Pb with multi-threading and Ajoint dependencies).
120    o verification:
121      - new experiment testing OBCS and DIC pkgs, using params & output from
122        tutorial_global_oce_biogeo but limited to a sub-domain around Drake
123        passage: take OBCS from the last year of a 2 yrs simulation and initial
124        conditions from t=1.yr while keeping the same forcing.
125    o model/src:
126      - when allowFreezing=T, only reset below freezing initial Temp to Tfreezing
127        (at any k) if checkIniTemp is not set to FALSE (default checkIniTemp=T).
128    o pkg/diagnostics (Stats-Diags):
129      - re-write S/R DIAGSTATS_CALC (more similar to TARGET_NEC_SX part) to:
130        a) refine region where stats are computed, excluding where arrhFac=0 ;
131        b) fix missing interior mask (use with OBCS) in 3-D fields statistics;
132        c) extend regional stats over the region edges (for U or V pt location).
133    o pkg/gchem:
134      - add a (2nd) call to OBCS_APPLY_PTRACER in gchem_forcing_sep.F (needed since
135        pkg/dic is currently changing/updating ptracers values beyond the OB).
136    o verification (hs94):
137      - convert Held & Suarez external_forcing.F (from hs94.cs, with Sigma-coords
138        bits) to apply_forcing.F and undef USE_OLD_EXTERNAL_FORCING in experiments
139        hs94.cs-32x32x5 and tutorial_held_suarez_cs ; also use the same version of
140        apply_forcing.F in 2D hs94 (fwd, ad & oad) but keep LatLon hs94 unchanged.
141    o pkg/ptracers:
142      - implement Adams-Bashforth on pTracers (instead of on tracer tendency),
143        switched on by setting PTRACERS_doAB_onGpTr=F (default set to doAB_onGtGs)
144      - change exp4 secondary test (input.nlfs) to test AB on T & S & pTracer
145        with AB-2 code (so that it get tested).
146    o model/src:
147      - allow to apply Adams-Bashforth on Temp & Salt (instead of on gT,gS)
148        with AB-2 code (previously only available with AB-3 code).
149        Also move the code (call to ADAMS_BASHFORTH S/R) form thermodynamics.F
150        to temp/salt_integrate.F (since the 2nd part of gt/sNm1 update is done
151        there, by calling CYCLE_AB_TRACER).
152    o pkg/generic_advdiff:
153      - change Tracer argument (drop bi,bj indices) in S/R GAD_CALC_RHS,
154        GAD_C2_ADV_R, GAD_U3_ADV_R, GAD_C4_ADV_R, GAD_DIFF_R, GAD_BIHARM_R
155        + also in GMREDI_X/Y/RTRANSPORT ; and update corresponding calls in
156        S/R temp/salt/ptracers_integrate.F
157    o model/src & pkg/ptracers:
158      - remove common block variables gT,gS (in DYNVARS.h), except when
159         USE_OLD_EXTERNAL_FORCING is defined; update TAF storage accordingly.
160      - remove common block variable gPtr.
161    o model/src & pkgs:
162      - change gTracer (and/or tracer) argument (drop bi,bj indices) in S/R
163         ADAMS_BASHFORTH(2&3), CYCLE_(AB_)TRACER, FREESURF_RESCALE_G,
164         IMPLDIFF, SOLVE_TRIDIAGONAL & _PENTADIAGONAL, GAD_SOM_ADVECT,
165         GAD_ADVECTION, GAD_CALC_RHS, GAD_IMPLICIT_R, TIMEAVE_CUMUL_DIF_1T
166      + change accordingly all calling S/R.
167      - use local temperature/salinity/ptracer tendency array (without bi,bj)
168        in S/R temp/salt/ptracers_integrate.F
169    o pkg/seaice:
170      - move computation of stress contributions to rhsU/V in s/r seaice_lsr
171        to separate s/r seaice_lsr_rhsu/v in order to be able to re-use code
172      - make u/vIceC local variables if SEAICE_CGRID is defined only to be used
173        in seaice_lsr
174      - seaice_lsr.F: make local 4D arrays UXX, VYY, etc 2D
175        in s/r seaice_lsr_calc_coeffs
176    o pkg/mdsio:
177      - in MDS_READ/WRITE_FIELD, stop if file-name (+prefix) is too long
178        (e.g., > MAX_LEN_MBUF -90 ) or, in INI_MODEL_IO, if mdsioLocalDir is
179        too long (e.g., > MAX_LEN_FNAM/2 )
180    
181    checkpoint65b (2014/08/12)
182    o pkg/matrix:
183      - pass, as argument, updated tracer field to S/R MATRIX_STORE_TENDENCY_EXP
184    o model/src:
185      - fix initialisation of geothermalFile; compile geothermal-flux code in
186        natl_box verification experiment.
187    o model/src & pkg/down_slope:
188      - push the k loop inside S/R TIMESTEP_TRACER (now called outside the k loop).
189      - in dwnslp_apply.F, update tracer tendency instead of the future tracer
190        field and call S/R DWNSLP_APPLY before TIMESTEP_TRACER; this affects
191        results at machine truncation level: update output of experiments
192        global_ocean.90x40x15.dwnslp (FWD) and lab_sea.noseaicedyn (AD).
193    o pkg/diagnostics (Stats-Diags):
194      - do not cumulate the full volume when DIAGNOSTICS_FILL is
195        called with bibjFlg < 0 (no increment of the counter for 2D/3D diag);
196        This fix the mean statistics when DIAGNOSTICS_FILL is called multiple
197        times (but Min,Max and StD are still wrong).
198    o model/src:
199      - add geothermal flux forcing: read in ini_forcing.F as time-constant
200        field "geothermalFlux" applied in S/R APPLY_FORCING_T (apply_forcing.F)
201    o model/src:
202      - move CYCLE_TRACER calls from tracers_correction_step.F to temp/salt/ptracer
203        _integrate.F so that, when leaving S/R THERMODYANMICS, theta,salt and pTrac
204        arrays are already updated while adjustments (filters, conv.adjustment) are
205        still applied later, in S/R TRACERS_CORRECTION_STEP.
206    o model/src:
207      - store in common bloc array "rhoInSitu" the virtual potential temperature
208        anomaly that is used to compute geopotential: this make the atmos code
209        more similar to ocean code which already uses rhoInSitu in calc_phi_hyd.F
210    o pkg/seaice/seaice_lsr.F
211      - rename integer variable ilcall to ipass (that's what it is called
212        in the residual diagnostics
213      - change time stepping for NPSEUDOTIMESTEP > 2 (does not change the
214        default) for improved non-linear convergence of the first few steps
215      - adjust a few comments and add new ones to explain some of the store
216        directives
217    o pkg/generic_advdiff (& ptracers):
218      - re-work the code to check for valid advection scheme and for minimum
219        size of overlap (now stored in local common bloc in gad_advscheme.F)
220    o pkg/seaice: another attempt to make the adjoint work for sea ice dynamics
221      - re-initialize more variables in seaice_lsr: u/vIceC, u/vIceNm1
222      - add an auxilliary variable "bet" and fix store directives and keys in
223        seaice_lsr_tridiagu/v, this seems to do the trick (i.e. more or
224        less exact gradients in my tests); but there are still
225        recomputation warning (although gradients are sort of OK), when
226        SEAICE_LSR_VECTORIZE is not defined, so this flag and
227        SEAICE_LSR_VECTORIZE_ZEBRA are recommended for efficiency.
228      - update verification experiments lab_sea.
229      - change some comments in S/R seaice_calc_viscosities
230    o model/src:
231      - if staggerTimeStep=T, always apply exchange to velocity field in
232        do_stagger_fields_exchanges.F instead of in do_fields_blocking_exchanges.F
233        (independent of using multi-dim advection or not); no effect on FWD run
234        but affects AD results (at machine truncation level): update output of
235        experiment 1D_ocean_ice_column (ad: 12 digits), hs94.1x64x5 (ad,oad: 13.d)
236        and isomip (oad: 12.d).
237    o pkg/generic_advdiff:
238      - stop if doAB_onGtGs is set to FALSE but ignored
239      - refine warning related to stability of tracer time-stepping
240        regarding internal wave dynamics.
241      - setting of AdamsBashforth_T,S when doAB_onGtGs=F: remove condition
242        on staggerTimeStep & implicitIntGravWave (will now get a warning
243        if potentially unstable).
244    o pkg/kl10:
245      - add new pkg "kl10" for mixing due to internal wave breaking, from
246        http://www.sciencedirect.com/science/article/pii/S1463500310000144
247        (contribution from Jody Klymak), tested in verification experiment
248        verification/internal_wave/input.kl10/
249    o isomip experiment:
250      - test pkg/shelfice with Non-Lin Free-Surf in one of the FWD set-up
251        (input.htd) and update the output.
252    o cd_code experiments:
253      - use default cd_code options (#undef CD_CODE_NO_AB_MOMENTUM &
254        #undef CD_CODE_NO_AB_CORIOLIS) in experiments: cfc_example (fwd)
255        global_ocean.90x40x15 (ad & oad) and OpenAD (ad & oad) and
256        update the corresponding output.
257    o pkg/seaice:
258      - reduce the number of include files and store directives in
259        S/R seaice_lsr_tridiagu/v
260      - change the order of loops in one case in S/R seaice_lsr_tridiagv
261        (only for SEAICE_VECTORIZE_LSR_ZEBRA defined), which allows me to
262        get rid off one store directive (a TAF bug?)
263      - add one more instance of ifdef SEAICE_VECTORIZE_LSR_ZEBRA in
264        S/R seaice_lsr_tridiagv to change the loop range for consistency
265      - remove ilcall, m from parameter list of S/R seaice_lsr_tridiagu/v
266      - fix a bug that affects the JFNK solver: replace sNx/y by i/jMax in
267        S/R seaice_lsr_tridiagu/v (requires update of
268        offline_exf_seaice/input.dyn_jfnk)
269    
270    checkpoint65a (2014/07/27)
271    o model/src:
272      - Non-Lin Free-Surf in p/z coords: allows hFacW,S to be larger than
273        surrounding hFacC=1 @ edge of a step with different kSurfC on either side
274        (topo in p-coords, ice-shelf in z-coords); update output of experiments
275        tutorial_global_oce_in_p and isomip (both AD and OpenAD output).
276    o model/src:
277      - collect momentum forcing tendency into local 2-D array (passed as argument
278        to apply_forcing S/R); this simplifies mom. Forcing diagnostics and CD_CODE
279        parts in timestep.F (without CD_CODE_NO_AB_MOMENTUM defined = the default);
280        affects results at machine truncation level (e.g., if using OBCS_SPONGE).
281      - collect T & S forcing tendency into local 2-D array (passed as argument to
282        apply_forcing S/R); add 3-D diagnostics for temp & salt forcing tendency.
283        affects results at machine truncation level (e.g., ocean: if using
284        SHORTWAVE_HEATING ; atmos: if using FrictionHeating or (atm_Rq<>0) moist
285        correction due to vertical advection).
286      - update output of experiments: fizhi-cs-32x32x40 (13 digits),
287        global_ocean.cs32x15 (fwd: icedyn, seaice, thsice, all 3 @ 11d; adm & tml:
288        seaice_dynmix & thsice, fwd grd @ 3 & 8), hs94.1x64x5 (ad grd @ 13),
289        obcs_ctrl (ad & fwd grd @ 12 & 7).
290    o pkg/ptracers & diagnostics:
291      - use ptracers (short) name (instead of long one) to make ptracers diagnostics
292        title (to avoid some unexpected truncation); sort out ptracers diags units.
293      - collect ptracer forcing tendency into local 2-D array (passed as argument
294        to apply_forcing S/R); add 3-D diagnostics for ptracers forcing tendency.
295    
296    checkpoint65 (2014/07/18)
297    o pkg/fizhi:
298      - add parenthesis around fizhi tendencies in fizhi_tendency_apply.F: this
299        affects results at machine truncation level. Update output of experiments
300        fizhi-cs-32x32x40 (12 digits for cg2d) & fizhi-cs-aqualev20 (13 digits).
301    o pkg/seaice: more clean up
302      - rename TAF common block tapes to be more consistent and remove
303        unnecessary duplicates
304      - add store directives to remove more recomputations, but use smaller
305        tapes (and adjust keys) when SEAICE_LSR_ADJOINT_ITER is undefined.
306        The idea behind this flag is to reduce the memory footprint when the
307        adjoint of the LSR is not required. As of now, defining the flag
308        SEAICE_LSR_ADJOINT_ITER increases 4 common block tapes for 2D field by
309        a factor of SOLV_MAX_FIXED (=500 by default in SEAICE_SIZE.h).
310        For experiment offline_exf_seaice, this means on a linux box with gfortran
311        nearly a factor of 10 (but keep in mind there is mostly seaice code in
312        this experiment):
313        > size mitgcmuv_ad
314        text    data        bss     dec        hex  
315        5100659 1216  220458952  225560827  d71c8fb
316        5339425 1200 1868783272 1874123897 6fb4dc79 (SEAICE_LSR_ADJOINT_ITER)
317        but only a moderate increase of 36% for global_ocean.cs32x15:
318        text    data        bss     dec        hex
319        6695027 1648 1014578664 1021275339 3cdf6ccb
320        6695203 1648 1382505320 1389202171 52cd8afb (SEAICE_LSR_ADJOINT_ITER)
321      - note: there are still recomputations in global_ocean.cs32x15 and
322        offline_exf_seaice and the gradient agreement changes (gets a
323        little worse) for global_ocean.cs32x15 (-> update output_adm.seaice.txt)
324      - in general, the AD gradients still are wrong
325    o OpenAD
326      - clean up code_oad/ directories somewhat by moving files
327        dontCompile, dontTransform, keepOriginal to OAD_support/
328    o model/src:
329      - using MOM fluxform and Non-Lin Free-Surf with momDissip_In_AB=F
330        (not currently tested): add dissipation terms before NLFS rescaling of
331        tendencies (previously done after).
332    o pkg/diagnostics:
333      - write stats-diags in ascii file with more digits (same as in monitor).
334    o pkg/down_slope:
335      - drop the bi,bj dimension of argument recip_hFac in S/R DWNSLP_APPLY; with
336        NLFS (not tested), use new recip_hFac value in order to conserve tracer.
337    o model/src:
338      - new file "apply_forcing.F" containing all the code previously in
339        external_forcing.F, but with new argument list: pass, as new argument,
340        the current level tendency array to update (instead of a direct update
341        of the common bloc array). Change the corresponding calls.
342      - add CPP option USE_OLD_EXTERNAL_FORCING (default is undef) to use
343        EXTERNAL_FORCING_U,V,T,S subroutines (for backward compatibility).
344    o pkg/seaice/seaice_lsr, a little bit of clean up
345      - rearrange some code blocks, so that now all calculations for
346        setting up the right-hand-sides done within one single block
347        (I find that easier to read and understand)
348      - rearrange freedrift-code to reduce the number of ifdefs
349      - adjust some indentations and comments
350    
351    checkpoint64z (2014/07/10)
352    o model/src and several pkgs:
353      - change argument list of all S/R called from external_forcing.F and
354        called from ptracers_forcing.F (renamed to ptracers_apply_forcing.F)
355        to pass, as argument, the current level tendency array to update
356        (instead of a direct update of the common bloc array).
357      - change also (in the same way) argument list of PTRACERS_APPLY_FORCING;
358      - rename taueddy_external_forcing.f to taueddy_tendency_apply.F
359    o pkg/seaice/seaice_lsr.F
360      - always initialize local arrays in seaice_lsr_tridiagu/v
361      - add more local tapes to seaice_lsr_tridiagu/v
362      - move storing u/vice(:,:,bi,bj) out of seaice_lsr_tridiagu/v, but
363        keep it in bi/bj loop; this seems to be essential
364      - gradients are still wrong but only by 4-7 orders of magnitude
365        instead of 15 orders of magnitude, lab_sea improves a little
366    o pkg/seaice
367      - (pkg/autodiff) remove storing/restoring of seaiceMaskU/V that
368        generates unnecessary code in seaice_lsr_ad
369      - add more store directives in seaice_lsr to avoid unnecessary code
370        in seaice_lsr_ad
371      - exclude some residual computations in seaice_lsr when
372        ALLOW_AUTODIFF_TAMC is defined in order to avoid unnecessary code
373        in seaice_lsr_ad
374      - add more storing, a new tape (model/src/the_main_loop.F) and
375        another key for SEAICE_LSR_VECTORIZE_ZEBRA (the local keys ilockey
376        and klockey should be checked by a specialist)
377      - modify ( define SEAICE_VECTORIZE_LSR and SEAICE_LSR_ADJOINT_ITER )
378        and update lab_sea after previous changes in pkg/seaice below
379    o pkg/autodiff:
380      - introduce useSmoothCorrel2DinAdMode, SEAICEapproxLevInAd, and
381        viscFacInAd : run time parameters allowing for adjoint switches
382        note : logic for useSmoothCorrel2DinAdMode is in ctrl_readparms.F
383    o pkg/ecco:
384      - introduce cost_gencost_boxmean.F that computes a box mean
385        temperature (for use in adjoint sensitivity studies).
386    o model/src/set_defaults.F : initialize viscFacAdj to 1.
387    o pkg/mom_common/mom_calc_visc.F:
388      - ifdef ALLOW_AUTODIFF then include viscFacAdj factor.
389    o pkg/seaice/seaice_summary.F:
390      - statement for SEAICEadjMODE now in autodiff_readparms.F
391    o pkg/seaice:
392      - remove some store directives and add new ones in an effort to get
393        finally rid off the recomputation warnings. This is successful
394        when SEAICE_VECTORIZE_LSR ***and*** SEAICE_LSR_ADJOINT_ITER are
395        defined (i.e. no extensive recomputation warnings left), but there
396        are still too many recomputations on the solver iteration level
397      - define SEAICE_VECTORISZE_LSR in offline_exf_seaice/code_ad/SEAICE_OPTIONS.h
398      - move definition of MPSEUDOTIMESTEPS into TAMC-block in
399        SEAICE_SIZE.h
400      - add a store directive in S/R seaice_calc_viscosities
401    o pkg/seaice (ITD code):
402      - fix definition of Hlimit for multi-threaded case
403      - use double precision arithmetic to compute Hlimit: this affects results;
404        update output of experiment seaice_itd.
405    o replace content of verification/seaice_itd
406      - instead of a 1D column use the configuration of offline_exf_seaice
407        to test the ice thickness distribution code with ridging
408      - this is a first shot at this experiment
409      - change of some defaults of ridging parameters SEAICEhStar (from
410        100 to 25) and SEAICEmuRidging (from 5 to 3) in seaice_readparms.F
411        and lot of new comments.
412    
413    checkpoint64y (2014/06/20)
414    o pkg/seaice/seaice_reg_ridge.F:
415      - modify the regularization of very small volumes of ice; only check
416        total volume HEFF, and do not apply correction to individual ice
417        classes because that leads to funny patterns in the heat and fw-fluxes
418        into the ocean. Adjust seaice_itd/results/output.txt
419      - replace nITD by SEAICE_multDim in loop-ranges
420    o pkg/exf:
421      - add code to process the case field period = -12. with UV interpolation.
422      - move debug print (formerly active when exf_verbose=T) from EXF_getFFieldRec
423        into S/R that calls it (i.e., exf_set_gen.F, exf_set_uv.F & obcs_exf_load.F)
424    o verification/global_with_exf:
425      - switch all fields period to -12. (was previously untested) in input/data.exf
426        (but keep secondary test ".yearly" unchanged); update the reference output.
427    o pkg/cal:
428      - new calendar type "noLeapYear" for 365 days calendar without any leap year.
429    o pkg/exf:
430      - new integer parameter "exf_debugLev" (default set to main model debugLevel)
431        to replace logical switch "exf_verbose"
432      - report in STDOUT when loading a new record (if exf_debugLev >= 3)
433    o pkg/sbo:
434      - update from Katherine Quinn: evaluate mass directly from density and SSH
435        (budget using Finite Volume method) instead of from bottom pressure.
436      - allow testreport to collect few selected SBO output ; tested in exp.
437        global_ocean.90x40x15 (after updating the results, to include SBO output).
438      - fix some multi-threading issues (in output part).
439    o model/src & most packages:
440      - always call {PKG}_READPARMS even if corresponding use{PKG}=F;
441      - in {PKG}_READPARMS, in case use{PKG}=F: add a call to new S/R
442        PACKAGES_UNUSED_MSG to print a weak warning when parameter file
443        "data.{pkg}" exist ; and leave the S/R (return) just after.
444      - more standard LAND pkg interface (land_init_fixed.F, land_check.F).
445        + call LAND_READPARMS from packages_readparms.F
446    o pkg/seaice:
447      - remove code that resets useThSice in S/R seaice_readparms and
448        replace it by a warning in S/R seaice_check
449      - remove parameter MULTDIM, replace with nITD and runtime
450        parameter SEAICE_multDim (still hard-wired to nITD if
451        SEAICE_ITD is defined)
452    
453    checkpoint64x (2014/05/24)
454    o verification/lab_sea:
455      - update adjoint and TLM output following changes to pkg/salt_plume
456      - un-do the update after putting back local recip_Cp in few places.
457    o pkg/salt_plume: modifications by An Nguyen:
458      - add capability to do brine rejection (salt-plume) as function of
459        volume+tracers (instead of only salinity tracer).
460      - conserve volume by exchanging volume from each kLev to above to
461        accommodate in-coming brine volume
462      - store surface and klev exchanged fraction + volume in 4 new 3-d arrays
463      - switch KPP surf buoyancy due to brine forcing to 3-d
464        (3 more 3-d arrays, 2 for SPforcing[T,S], 1 for boplume)
465      - add salt_plume_volfrac, salt_plume_apply, salt_plume_tendency_apply_t
466      - unrelatedly, also add ad-hoc capability to vary salt_plume scheme
467        in East/West Arctic.
468    o pkg/sbo:
469      - incorporate modifications from Katherine Quinn to enable the use of sbo
470        pkg in ECCO-v4 set-up ; remove SBO-TimeAve output ; add monitor-like
471        output for future testreport verification (unfinished).
472    o pkg/atm_phys:
473      - change diagnostics (AtPh_Trf & AtPh_Qrf) of DARGAN_BETTSMILLER S/R:
474        skip the reseting of t_ref & q_ref to initial t & q ; this preserve the
475        output of S/R CAPECALCNEW (Parcel temp & q) for diagnostics.
476    o pkg/seaice
477      seaice_calc_ice_strength.F: modify expression to avoid divisions
478        (affects truncation)
479      seaice_do_ridging.F: clean up the insectarium
480      - fix a bug that was compensated by areaScaling (-> remove areaScaling code)
481      - added SEAICEsnowFracRidge to redistributed snow (2nd bug)
482      - set closing/openingRate to zero where no extra iteration is need (3rd bug)
483      - add some debugging information and error messages (warnings)
484    o model/src: modifications relatd to atmosphere p*:
485      - Switch to more accurate p* coordinate slope term (calc_grad_phi_hyd.F)
486      - With p* or Sigma-P, use constant reference Pot.Temp (thetaConst) instead
487        of vertical profile tRef in geopotential background and anomaly.
488      - Acount for true p* correction in theta <-> T conversion in pkg/aim_v23
489        and pkg/atm_phys.
490      - Update FWD output of experiments: aim.5l_cs (x2), fizhi-cs-32x32x40,
491        fizhi-cs-aqualev20, fizhi-gridalt-hs, tutorial_held_suarez_cs, cpl_aim+ocn.
492    o pkg/seaice: fix a bug in seaice_prepare_ridging.F, forgot a sqrt
493    o pkg/ptracers: compute ptracer source/sink due to linear free surface.
494        not used right now, but can be used in BGC packages to fix conservation.
495    o pkg/dic, pkg/gchem: move tracer_meanarea to gchem, so it can be used by
496        other packages too.
497    o pkg/seaice/seaice_calc_ice_strength.F: replace SEAICE_rhoSnow by
498        SEAICE_rhoIce in the Rothrock (1975)-type strength calculations (bug fix)
499    o model/src:
500      - since we have several heat capacity (even in model/src), define "recip_Cp"
501        as local variable (no longer in common block) to avoid any confusion.
502      - add thetaConst in PARAMS.h (to be used with pStar or sigma-P coords).
503    o pkg/exf:
504      - from Jeff Scott: add option (#define EXF_CALC_ATMRHO) to calculate local
505        air density as function of air Temp, Humidity and atm pressure.
506    
507    checkpoint64w (2014/05/02)
508    o verification:
509      - update output_adm.txt files for experiment global_ocean.cs32x15 (seaice &
510        seaice_dynmix) and lab_sea (primary test & noseaicedyn): moving/changing
511        code from seaice_growth.F & seaice_advdiff.F to new ridging routines
512        seaice_reg_ridge.F seaice_do_ridging.F affects AD gradient
513        (down to 8-7 matching digits for global_ocean and 5-6 for lab_sea).
514    o model/src: for atmosphere in p* coords:
515      - store factor rStarFacC**atm_kappa (= pStarFacK) in common block
516      - implement more accurate p* coordinate slope term (in calc_grad_phi_hyd.F),
517        but not yet activated.
518    o pkg/seaice: fix restart problem for ITD with new ice strength parameterisation:
519      - move computation of opnWtrFrac = 1-AREA to before computing ice strength
520      - this changes the results (but not for any verification experiment, because
521        none tests this), but avoids having an extra field in the restart files
522    o pkg/seaice: remove global variable TICE (not needed)
523      - replace by TICES or local variable where necessary (cost_seaice_test,
524        seaice_diagnostics_state)
525      - move copying TICE to TICES from seaice_check_pickup to seaice_read_pickup
526      - use specific read/write routines for reading and writing individual leves
527        of a multilevel field
528    o pkg/ctrl & model/inc:
529      - move additional anomaly fields of control vars (related to options:
530         ALLOW_KAPGM_CONTROL, ALLOW_KAPREDI_CONTROL and ALLOW_BOTTOMDRAG_CONTROL)
531        from DYNVARS.h into new header file: CTRL_FIELDS.h
532    o pkg/seaice: some small modifications to the ridging code
533      - make fw2ObyRidge a global variable and add the freshwater flux to
534        seaice_growth
535      - pass actual thickness from seaice_prepare_ridging, so that it is
536        computed only in one place and compute it in the same way as in
537        seaice_growth
538      - initialise more fields in seaice_do_ridging that where cause floating
539        point exceptions over land
540    o pkg/seaice: preparations for ridging code and first real ridging code
541      - move most of "PART 1" of S/R seaice_growth into a new and separate
542        S/R seaice_reg_ridge that will both regularize the state variable after
543        advection call the actual ridging routine;
544      - requires to make 5 fields global fields: d_HEFFbyNEG,d_HSNWbyNEG,
545        d_AREAbyRLX,d_HEFFbyRLX,saltFluxAdjust;
546      - remove ridging code from seaice_advdiff
547      - clean up remaining part 1 of seaice_growth in an attempt to make it
548        more readable (this is probably subjective)
549      - call seaice_itd_redist once in the initialisation phase to have the initial
550        conditions in the correct category
551      - finally: add new ridging routine for ITD code
552    
553    checkpoint64v (2014/04/11)
554    o pkg/ecco:
555      - add runtime parameters mdt[start,end]date[1,2]
556      - rename variable "tpmean" as "mdt" and "topexmeanfile" as "mdtdatfile"
557    o pkg/seaice:
558      - make deltaC a global variable, so that it can be used in ridging code
559      - first step towards ridging: introduce new routines that compute
560        ice strength based on ridging parameters
561      - add diagnostic for HSNOWITD
562      - add opnWtrFrac as a global variable (required for ridging scheme)
563    o pkg/salt_plume + pkg/seaice/seaice_growth.F
564      - add SALT_PLUME_IN_LEADS flag to activate pkg/salt_plume only when ice
565        AREA exceeds a threshold (code contributed by I.Fenty in 2011)
566    o verification/hs94.1x64x5:
567      - leave ALLOW_AUTODIFF_TAMC undefined in code_oad/AUTODIFF_OPTIONS.h
568      - do not use ECCO_CPPOPTIONS.h anymore for TAF & OpenAD Adjoint tests.
569    o autodiff:
570      - Start to include explicitly AUTODIFF_OPTIONS.h, COST_OPTIONS.h,
571        and CTRL_OPTIONS.h in src files (to enable to skip the ECCO_CPPOPTIONS.h)
572        For now, only in pkgs used in verification/hs94.1x64x5.
573      - Replace ALLOW_AUTODIFF_TAMC by ALLOW_AUTODIFF (except for tape/storage
574        which are specific to TAF/TAMC).
575      - Replace ALLOW_AUTODIFF_OPENAD by ALLOW_OPENAD:
576        since ALLOW_OPENAD is defined in PACKAGES_CONFIG.h (any time pkg/openad
577        is compiled), this simplifies/reduces which *_OPTIONS.h file to include.
578      - OpenAD: change Makefile to generate the appropriate AD_CONFIG.h when
579        building mitgcmuv_ad (make adAll).
580    o pkg/ecco:
581      - cost_gencost_seaicev4.F:
582         reformulate proxy cost as function of sst and local param SEAICE_freeze
583         change cost names from siv4-[sst,vol] to siv4-[deconc,exconc]
584      - add stop statement if old names siv4-[sst,vol] are used
585      - add snapshots + cost reports for atmospheric longwave
586      - remove factor 0.1 in front of wtau[u,v]
587      - replace never used flag ALLOW_TMI_COST_CONTRIBUTION with
588         ALLOW_TMI_SST_COST_CONTRIBUTION
589    o pkg/atm_phys:
590      - add some diagnostics for Short-wave and for convection S/R.
591    o pkg/seaice/seaice_growth:
592      - fix a bug in the lateral melt parameterization for SEAICE_ITD
593        in seaice_growth; tempFrz needs to be computed inside the i/j-loop
594      - rearrange loop order for better vector code in the same code block
595      - rewrite the floeDiameter formula to have fewer divisions
596      -  (miraculously) none of this changes the results of seaice_itd
597    o pkg/smooth:
598      - move param smooth2Ddiffnbt to pkg/ecco
599    o pkg/salt_plume:
600      - salt_plume_frac.F:
601         clean up local param names
602         reformulate (1-frac) to frac; original 1-frac was based on swfrac code
603    o pkg/rw:
604      - add RS version of S/R READ_MFLDS_LEV.
605    o pkg/streamice:
606      - fix the restart test by writing/reading pickup_streamice files.
607    o pkg/seaice:
608      - refine checks for jfnk-related parameters
609      - comment out if statement with SEAICEuseIMEX parameter as long as there
610        is no IMEX code to avoid confusion and surprises
611    
612    checkpoint64u (2014/03/07)
613    o verification/MLAdjust:
614      - rename secondary test suffix:
615         1.leith  -> A4FlxF  + switch to flux-form & add side-drag
616         0.leithD -> AhFlxF  + switch to flux-form
617         0.smag   -> AhVrDv  (use Vorticity-Div. visc form) + add side-drag
618         0.leith  -> AhStTn  (use Strain-Tension visc form) + add side-drag
619    o pkg/mom_vecinv:
620      - remove unused arguments from S/R MOM_VI_HDISSIP & MOM_HDISSIP (as it used
621        to be before mom_calc_visc.F)
622      - skip the call to MOM_CALC_TENSION & MOM_CALC_STRAIN if not needed.
623      - add 2nd copy of vort3 & strain that knows about lateral BC (free/no slip):
624        this is simpler for the adjoint and for diagnostics.
625    o model/src + pkg/momentum:
626      - add input files for  2-D additional Western and Southern cell-edge wall
627         (e.g., to add "thin-wall" where it is =1).
628      - fix sideDrag option for thin-walls with Non-Lin Free-Surf
629        using 2nd hFacZ that is computed from initial (fix domain) hFac
630      - known limitations of thin wall implementation: not yet coded for sigma
631        coords; not working with CD-scheme neither.
632    o pkg/seaice:
633      - rename recently introduced parameters from (wrong name) AB to
634        BDF (backward difference time discretisation)
635      - retire runtime parameters SEAICEuseAB2, SEAICE_abEps
636    o tools/adjoint_options:
637      - remove setting of "OPENAD=true" (now set by command line "genmake2 -oad")
638    
639    checkpoint64t (2014/02/01)
640    o pkg/ecco
641      - add compile flag ALLOW_GENCOST_TIMEVARY_WEIGHT in ECCO_OPTIONS.h and
642        runtime logical flag gencost_timevaryweight to read daily sea-ice sigma
643      - replace hard-coded record number and period which only work for monthly
644        with read-in runtime param that works for other periods (month,day,year)
645    o pkg/thsice
646      - corrected store directive fixes thsice adjoint gradient checks
647    o genmake2 & testreport:
648      - add genmake2 option "-oad" to generate a Makefile for OpenAD built and
649        in this case, use tools/adjoint_options/adjoint_oad as default AD optfile.
650        Update testreport accordingly. No need to set "export OPENAD=true"
651        in adjoint_options/adjoint_oad anymore (will be removed later).
652    o pkg/shelfice:
653      - put T & S shelfice forcing into model surfaceForcing_T,_S (for now,
654        only if SHELFICEboundaryLayer=F); Change model/src/external_forcing.F
655        so that surface forcing applies to k=kSurf if using pkg/shelfice.
656    o pkg/ctrl, pkg/grdchk, pkg/ecco:
657      - Changes to make GENARR more modular (i.e. invisible if not used)
658    o model/src/temp_integrate.F and salt_integrate.F
659      - re-include store directives that were removed on Dec 27th.
660    o model/src/external_forcing_surf.F
661      - add storage directives for EmPmR and PmEpR to avoid recomputation of
662        seaice_model in the adjoint that is problematic when seaice_model is
663        turned off in the adjoint. The resolved issue dated back to July when
664        EXTERNAL_FORCING_SURF call was moved.
665        Update global_ocean.cs32x15/*/output_adm.seaice_dynmix.txt accordingly.
666    o pkg/exf/exf_check.F
667      - fix a small bug again (originally found by Wentao Liu, now found again)
668      - streamline error output
669    o pkg/streamice and aim_v23:
670      - replace a few "_EXCH_XY_RL (" with "_EXCH_XY_RL(", so that
671        Apple's /usr/bin/cpp knows what to do:
672        Apple LLVM version 5.0 (clang-500.2.79) (based on LLVM 3.3svn)
673        Target: x86_64-apple-darwin13.0.0
674    
675    checkpoint64s (2014/01/05)
676    o tools/adjoint_options:
677      - switch to fastopt.net TAF server (instead of default fastopt.de) for
678        AD optfiles adjoint_diva & adjoint_f95 (similar to adjoint_default).
679    o model/src:
680      - remove some unnecessary TAF storage directives in forward_step.F and
681        in dynamics.F (note: not always removed by TAF, e.g., double storage
682        of kappaRU,kappaRV in former version of dynamics.F).
683    o model/src & pkg/ptracers:
684      - call directly GAD_IMPLICIT_R & IMPLDIFF + DWNSLP_APPLY from temp_integrate.F
685        salt_integrate.F and ptracers_integrate.F (instead of from thermodynamics.F)
686        and remove ptracers_dwnslp_apply.F & ptracers_implicit.F
687      - call MATRIX_STORE_TENDENCY_EXP for each tracer (in ptracers_integrate.F)
688      - add fZon & fMer as output argument of S/R GAD_CALC_RHS.
689      - update TAF AD-output of experiments global_ocean.90x40x15 (13 for AD-grad).
690    o useSingleCpuInput separates single-CPU input from single-CPU output;
691        for now only implemented for in exf_interp_read.F
692    o verification/advect_xy:
693      - fix missing EXCH call in local version of ini_salt.F and update output.
694    o momentum diagnostics:
695      - fix which deltaT is used in Total-Tendency diagnostics.
696      - fix typo in diagnostics for momentum tendency from AB.
697    o pkg/seaice/seaice_lsr.F: fix an initialisation bug for the
698        SEAICE_VECTORIZE_LSR_ZEBRA option that lead to NaNs on a NEC-SX8
699    
700    checkpoint64r (2013/12/08)
701    o verification/*/results:
702      - Update reference output of experiments that were passing with just 13 digits
703         (make it easier to detect future changes in results)
704    o model/src & pkg/ptracers:
705      - move calls to GAD_ADVECTION (Multi-Dim advection) from thermodynamics.F to
706        inside temp_integrate.F and salt_integrate.F and from ptracers_advection.F
707        to inside ptracers_integrate.F ; remove ptracers_advection.F
708    o coupling interface pkgs:
709        [atm_compon_interf, ocn_compon_interf & atm_ocn_coupler]
710      - change the config check to test the agreement of Ocean Depth
711        with ATM land/sea mask (instead of ATM orography);
712      - send to coupler the number of coupler time-steps to do for this run:
713        this allows to check for consistency and don't need anymore to be
714        specified in parameter file "data";
715      in coupler:
716      - check consistency of RunOff map versus Ocean Depth and ATM land/sea mask.
717      - improve report to log-file of config setting (pass log-file unit to few S/R)
718    o pkg/compon_communic:
719      - add coupling send/receive for non-tiled integer vector;
720      - add S/R to check and stop if any proc has an error (similar to
721        eesupp/src/stop_if_error.F but single thread and across Comm_World).
722    o pkg/exch2:
723      - in exch2*_get_rx[1,2]: use new list "W2_tileIndex" to replace search
724        through list of all tiles my proc owns.
725    o model/src:
726      - AUTODIFF only: in calc_adv_flow.F, recompute rTransKp (instead of copying
727        from rTrans) to simplify dependencies (no need to store rTrans anymore in
728        calling S/R); this affects AD results at machine truncation level:
729        update AD-output (TAF) of experiments: 1D_ocean_ice_column,
730        bottom_ctrl_5x5 & obcs_ctrl (12 digits for AD grad, same FWD grad).
731    o tools/build_options:
732      - simplify Warnings options (-ieee & -devel cases) in linux_amd64_gfortran
733    o coupling interface pkgs:
734        [compon_communic, atm_compon_interf & ocn_compon_interf]
735      - move declaration of local array "ibuf" out of header file "CPLR_SIG.h"
736        to each S/R that needs it; remove un-used variables.
737      - change component tile registration (cpl_register.F in both compon_interf
738        and mitcomponent_tile_register.F) to pass the full list of tiles
739        information (including bi,bj) in 1 vector (instead of in a bi,bj matrix).
740      - with pkg/exch2: adopt the same convention used for I/O to define mapping
741        towards coupler global array (unless W2_useE2ioLayOut=F):
742         a) can now use different tiling between atm & ocn comp.
743         b) no needs to modify the run-Off map when changing tiling (was needed
744            even if using the same tiling between atm & ocn).
745         c) will allow to run with blank-tiles in 1 component (e.g., for ocean
746            full land tiles); not yet tested.
747      - check for valid mapping from comp. tile to coupler global array
748      - improve report of tile registration results to log file.
749    o pkg/exch2:
750      - in eesupp/src/eeboot.F: move call to W2_EEBOOT before Coupler
751        tile-registration (CPL_REGISTER);
752      - activate (un-comment) definition and setting of "W2_tileIndex" list to
753        store the local bi,bj indices of each tile;
754      - also print bi,bj in local report to log file;
755      - fix pkg/debug/debug_cs_corner_uv.F for the case nSy > 1 (left from
756        Jun 2009 modif of pkg/exch2).
757    o testing on baudelaire:
758      - run 2 tests at a time: no significant slow down (since enough cpu) and
759        get the full set of test done earlier
760      - switch the ifort test to "-devel" ; run the OpenAD test everyday.
761    o model/src/thermodynamics.F and routines called from it:
762      - pkg/gmredi: gmredi_residual_flow.F (replacing gmredi_calc_uvflow.F &
763        gmredi_calc_wflow.F) to update eulerian velocity (input) into residual
764        velocity (outp) by adding bolus velocity.
765      - model/src: calc_adv_flow.F (replacing calc_common_factors.F) to compute
766        mass transport from velocity + lateral grid cell area
767      - rename calc_gt.F to temp_integrate.F (includes call to TIMESTEP_TRACER)
768      - rename calc_gs.F to salt_integrate.F (includes call to TIMESTEP_TRACER)
769     in thermodynamics.F
770      - remove k from thermodynamics.F and move it to temp_integrate.F
771        salt_integrate.F and ptracers_integrate.F (now done inside the tracer
772        loop).
773      - compute locally (in thermodynamics.F) 3-D velocity field that is used to
774        advect tracers; pass it as argument to GAD_ADVECTION, GAD_SOM_ADVECT,
775        PTRACERS_ADVECTION, TEMP_INTEGRATE, SALT_INTEGRATE, PTRACERS_INTEGRATE,
776        GAD_IMPLICIT_R and PTRACERS_IMPLICIT
777      - update AD-output (TAF & OAD) of experiments: 1D_ocean_ice_column,
778        global_ocean.90x40x15, tutorial_global_oce_biogeo and
779        tutorial_tracer_adjsens (+ TLM output).
780    o tools/OAD_support and (verification/*/) code_oad:
781      - OAD_support/cb2mGetModules.csh: add PACKAGES_CONFIG.h in header file to
782        module conversion ; remove unneeded CPP_EEOPTIONS.h.
783      - code_oad/CPP_OPTIONS.h: remove PACKAGES_CONFIG.h and use a more standard
784        version (closer to model/inc/CPP_OPTIONS.h).
785    o model/src:
786      - remove parameter "useOldFreezing" from PARAMS.h and push it to the
787        retired list of parameters (routine FREEZE has been replace by surface
788        freezing (10.yrs ago) and by pkg/frazil (interior freezing).
789    o pkg/gmredi:
790      - add option (GM_CALC_TRANSP_FROM_VEL) to compute transport directly from
791        velocity (same scheme but affects machine truncation) for GM_AdvForm.
792      - update output of FWD experiments: front_relax.bvp,
793        global_ocean.90x40x15.dwnslp, global_ocean.cs32x15 and ideal_2D_oce.
794    
795    checkpoint64q (2013/11/17)
796    o verification:
797      - generate new output on baudelaire (gfortran, -ieee) for OpenAD experiments
798        tutorial_global_oce_biogeo and global_ocean.90x40x15.
799      - generate new output (growth & melt) for seaice_itd experiment after
800        updating the input pickup_seaice files (previously wrong).
801    o pkg/cost:
802      - define a "final cost function" for each tile, and use GLOBAL_SUM_TILE_RL
803        (instead of _GLOBAL_SUM_RL) to get the final cost from all procs & threads:
804        o this fixes global-sum value if multi-threads (since GLOBAL_SUM_RL
805          cannot be applied to var in common block).
806        o allows to get results independent of tile-per-proc setting (if using
807          slower GLOBAL_SUM_SEND_RECV option).
808      - update accordingly: seaice_cost_final.F, shelfice_cost_final.F,
809        thsice_cost_final.F and ecco_cost_final.F (this one affects lab_sea
810        forward gradients: update output).
811      - update */code_oad/externalDummies.F by adding dummy GLOBAL_SUM_TILE_RL
812        S/R and, for most exp., also comment out GLOBAL_SUM_R8.
813    o pkg/mom_common:
814      - move to pkg/mom_common and model/src (previously in tutorial_deep_convection
815        code) 2nd version of isotropic 3-D Smagorinsky code interface: strain and
816        viscosity are locally declared in dynmics.F and pass as argument to CALC_GW;
817        ensure that all field value that are used are set.
818    o tutorial_deep_convection (smag3d):
819      - add missing scaling in mom_calc_smag_3d.F;
820      - set smag3D_coeff in input.smag3d such that results do not change.
821    o pkg/dic:
822      - change dic_cost.F to compute cost on each tile first and then apply
823        GLOBAL_SUM_TILE_RL: this affects forward gradient of AD experiments
824        tutorial_dic_adjoffline & tutorial_global_oce_biogeo; update output.
825      - remove kLev argument and use GLOBAL_SUM_TILE_RL in tracer_meanarea.
826    o eesupp/src & pkg/mdsio:
827      - remove gather/scatter_vector.F (from eesupp) and mdsio_read/writevector.F
828        (from pkg/mdsio) since they are no longer used for tape IO.
829      - move simple C subroutine "setdir.c" from pkg/compon_communic to eesupp/src
830        (+ keep a copy in pkg/atm_ocn_coupler).
831    o verification/isomip:
832      - split domain in 8 squared tiles (instead of just 2) for FWD, AD & OAD tests.
833    o tools/build_options:
834      - optfile linux_amd64_ifort11, fast (no ieee) case:
835        to get a working restart for all experiments, add "-fp-model source"
836        to FOPTIM (also remove "-opt-streaming-stores auto" <- this is the default).
837    
838    checkpoint64p (2013/10/20)
839    o pkg/autodiff:
840      - adread_adwrite.F: when type and length do not match ALLOW_AUTODIFF_WHTAPEIO
841        criteria, return to simple (default) tape IO format.
842    o pkg/mdsio (+ eesupp/src):
843      - rewrite/simplify tape-IO S/R (new S/R MDS_READ/WRITE_TAPE replace
844        previous MDSREAD/WRITEVECTOR) with 2 array argument from each type (R4/R8);
845      - fix globalFile and singleCpuIO options using simpler global mapping.
846      - new pairs of scatter/gather vector S/R (one for each type, generated from
847        template) corresponding to simpler global mapping.
848      - adread_write.F: switch to new S/R (but leave old calls commented) and write
849        to globalFile when parameter globalFiles is set to True.
850      - switch on useSingleCpuIO in AD experiments: global_ocean.90x40x15 & isomip.
851    o pkg/autodiff:
852      - adread_adwrite.F: add a hack for RS arrays (when RS=real*4);
853        with ALLOW_AUTODIFF_WHTAPEIO defined, since corresponding (real*4) is
854        missing, just add a STOP if array type do not match.
855    o pkg/exf:
856      - to allow to use seaice-fraction from pkg/exf in other pkgs than pkg/seaice:
857         rename CPP option EXF_ALLOW_SEAICE_RELAX to EXF_SEAICE_FRACTION
858         and rename array obsSIce to exf_iceFraction.
859    o tutorial_deep_convection:
860      - add 1rst version of isotropic 3-D Smagorinsky code (from Louis-Philippe),
861        for now all in this exp. code dir.
862      - add secondary test using Smag-3D viscosity (keep very low backgroud visc for
863        testing) and flux-limter advection scheme for Temp. (no explicit diffusion).
864    o eesupp/src:
865      - added SINGLE_DISK_IO option because reading of parameter files on
866        very large number of processors did not work with existing set-up
867    
868    checkpoint64o (2013/09/25)
869    o pkg/atm_phys & atm_compon_interf:
870      - allows for coupling of gray-atmosphere (atm_phys) with ocean.
871    o tools/build_options:
872      - switch from "-fPIC" to "-mcmodel=medium" in optfiles: linux_amd64_gfortran
873        & linux_amd64_ifort11 and in linux_amd64_g77 & linux_amd64_open64 also
874        remove CPP setting (was identical to genmake2 default).
875    o pkg/gmredi & model/src: Some updating and work done on the residual model.
876      - created new file model/src/calc_eddy_stress.F to calculate the eddy stress.
877      - fixed up the calculation of the eddy stress and how it is added to the
878        external forcing via taueddy_external_forcing.F
879      - at the moment, it is very experimental and only works with the variable eddy
880        diffusivity calculated in gmredi_k3d.F
881    o pkg/seaice/seaice_check.F: add a check to catch the case of specifying
882        lw/swfluxfile instead of lw/swdownfile in data.exf together with pkg/seaice
883    o testreport (& tools/do_tst_2+2):
884      - for MPI test, set default COMMAND to 'mpirun -v -np TR_NPROC ./{executable}'
885    o tools/build_options: linux_amd64_gfortran & linux_amd64_ifort11:
886      - remove CPP='cpp -traditional -P' (this is genmake2 default)
887      - add switch (for big setups) to use 'medium' memory-model (but leave it
888        commented out for now). Note: needed with FC 19 to compile big setups.
889    o pkg/atm_compon_interf:
890      - regroup per field origin (model & pkgs) the coupling storage routines
891         (which accumalate in time each coupling field)
892      - move bi,bj loops inside atm_store_my_data.F and store also wind-stress;
893        update accordingly + simplify aim_do_physics.F
894    
895    checkpoint64n (2013/08/26)
896    o pkg/bbl:
897      - update formulation to reduce dispersion of tracer properties in bbl
898      - replaced horizontal and vertical transport parameters with velocities
899      - changes results for verification/global_with_exf.yearly
900    o verification/halfpipe_streamice:
901      - change to matrix construction; update both Fwd & AD output.
902    o verification/tutorial_tracer_adjsens:
903      - OpenAD test: switch to vector-invariant momentum since fluxform with
904        rStar causes problems with OpenAD; update output.
905    o tools:
906      - genmake2: define a common prefix for all temp-file names ; move them
907        to local /tmp disk (but would be easy to move them back);
908      - xmakedepend: apply the same switch for temp-files.
909    o pkg/offline:
910      - changes for use with rStar (NLFS): assume that we continue to provide
911        UVELMASS/hFacW_ini & VVELMASS/hFacS_ini (hFacWi,S_ini as written in grid
912        output files) and apply r* scaling at each time-step (function of the time
913        varying Eta field); use normal pickup files (needed for restart with NLFS).
914    o adjoint with OpenAD:
915      - move OpenAD-specific files from verification/OpenAD/code_oad_all to a new
916        package openad.  This package has to be compiled for all runs with OpenAD
917        instead of specifying code_oad_all as a modification directory.
918      - link the fortran templates from tools/OAD_support to the build directory
919        for preprocessing to avoid conflicts between different setups compiled
920        simultaneously and simplify cleanup.
921    o pkg/exf:
922      - in exf_getforcing.F: comment out most of the EXCH calls (fields used by
923        main model or other pkgs are exchanged in EXF_MAPFIELDS).
924    o model/src:
925      - do_stagger_fields_exchanges.F: skip EXCH calls when using pkg/offline
926        (similar to do_fields_blocking_exchanges.F).
927    o tools/genmake2:
928      - remove TAF output src code just before calling staf (when not doing a fresh
929        built, will stop if things go wrong with staf).
930      - fix target "adobj" (left from TAF version-2 transition)
931    o pkg/diagnostics:
932      - add a parameter to track the status of pkg/diagnostics activation;
933        this replace/extend the use of logical param "settingDiags" (to check
934        when adding diag to the list) to also check any DIAGNOSTICS_[]FILL* call.
935        New S/R to print error message and stop when pkgStatus is not right.
936      - to try: add a warning when "data.diagnostics" exist but useDiagnostics=F.
937    
938    checkpoint64m (2013/08/13)
939    o model/inc:
940      - move FCORI_MACROS.h from PARAMS(_MACROS).h to GRID_MACROS.h (left from
941        8 yrs ago modif when Coriolis arrays were moved from PARAMS.h to GRID.h)
942    o pkg/kpp & aim_v23:
943      - only call DIAGNOSTICS_FILL when useDiagnostics=TRUE.
944    o pkg/seaice:
945      - restore (last time on 2011/12/24) ability to compile pkg/seaice with
946        undefined pkg/exf ALLOW_ATM_TEMP or ALLOW_RUNOFF CPP-options.
947      - only call DIAGNOSTICS_FILL when useDiagnostics=TRUE.
948    o eesupp/src:
949      - fix check for overlap-size argument (myOLn.GT.MAX_OLY_EXCH)
950        in exch1_rx[_ad].template (thanks to Francois Lefeuvre report).
951    o switch to TAF version-2:
952      - add flow directives to "freeze" naming convention for ad-routines that
953        are used in I/O routines of adjoint state and associated common blocks
954        that are used in adcommon.h (backward compatible with version-1)
955      - update all ad-optfiles (in tools/adjoint_options + few local to some
956        verification exp) to switch to latest TAF version (currently 2.5.5);
957        merge "*_mpi" adoptfiles into the corresponding non-mpi (but commented
958        out except for diva).
959      - the major change with TAF version-2 is that both the differentiated
960        routines and the forward routines (new) are returned as part of the TAF
961        output source code. Update genmake2 accordingly.
962      - new output for AD experiment tutorial_global_oce_biogeo (better AD gradient
963        with version-2 when compared to TLM or FWD gradient); other experiments
964        output show minor changes (machine truncation level); update the few AD &
965        TLM output with 12 matching digits only (some prior to version-2 switch).
966    
967    checkpoint64l (2013/08/05)
968    o model/src:
969      - in dynamics.F, skip the call to CALC_VISCOSITY if momViscosity=F
970      - main_do_loop.F: no longer includes additional (AUTODIFF) header files
971        when using TAF but only if using OpenAD.
972    o pkg/mom_common+fluxform+vecinv:
973      - always set horiz. viscosity arrays to background value before calling
974        MOM_CALC_VISC (in MOM_FLUXFORM & MOM_VECINV) and call S/R MOM_CALC_VISC
975        only when using variable horiz. viscosity (useVariableVisc=T);
976      - simplify mom_vecinv.F (only 1 block for momViscosity).
977    o pkg/mom_common: variable horiz. viscosity in NH code
978      - move horiz-viscosity 3-D arrays viscAh_W & viscA4_W (used in calc_gw.F)
979        from model/inc/NH_VARS.h to pkg/mom_common/MOM_VISC.h
980      - store in common block (in MOM_VISC.h) logical parameters: useHarmonicVisc,
981        useBiharmonicVisc & useVariableVisc.
982      - fix old bug (already in 1rst implementation of variable horizontal viscosity
983        in calc_gw.F, version 1.27, 2006/06/20):
984        horizontal bi-harmonic viscosity in gW was missing when wiscA4W=0
985        even if variable bi-harmonic viscosity (e.g., viscA4Grid) was non-zero.
986      - change background horiz viscosity in vertical momentum (gW) to always be
987        viscAhW,viscA4W (instead of switching to viscAhD, viscA4D when using
988        any type of variable viscosity, e.g., viscAh/4Grid)
989      - change default value of viscAhW,viscA4W to viscAhD,viscA4D (instead of
990        viscAh,viscA4) which default to viscAh,viscA4 :  this avoid missing
991        horiz. viscosity in W eq when just setting viscAhD/Z,viscA4D/Z (since
992        default viscAh,viscA4 is zero).
993    o model/src:
994      - extend length of drC & recip_drC from Nr to Nr+1.
995    o Divided Adjoint (DIVA) with MPI:
996      - genmake2: do not create local ./mpi_headers dir when no file to copy into.
997      - remove option ALLOW_DIVIDED_ADJOINT_MPI (replaced by ALLOW_DIVIDED_ADJOINT
998        and ALLOW_USE_MPI) from model/src code and from ECCO_CPPOPTIONS.h.
999    
1000    checkpoint64k (2013/07/23)
1001    o tools/OAD_support:
1002      - avoid the need for file "oadtempflile" in insertTemplateDir.bash
1003        and remove it from genmake2.
1004    o tools/build_options:
1005      - remove MPI_HEADER_FILES_INC setting (no longer used) and comment out
1006        MPI_HEADER_FILES list (let genmake2 find the missing headers)
1007    o verification/halfpipe_streamice:
1008      - change to driving stress formulation; update both Fwd & AD output.
1009    o tools/genmake2 and Divided Adjoint with MPI:
1010      - remove default setting of MPIINCLUDEDIR from $MPIHOME (always been broken);
1011      - only create local ./mpi_headers dir if using MPI and MPIINCLUDEDIR is set;
1012      - add new variable (LOCAL_MPI_HEADERS, replace MPI_HEADER_FILES_INC) in
1013        Makefile, which is set by genmake2, and check which mpi-headers are needed.
1014        Note: need to update adjoint_options/adjoint_diva_mpi accordingly.
1015      - update target "CLEAN" (to also remove ./mpi_headers/ dir).
1016    o testreport:
1017      - changes for Divided Adjoint Run: when file "run_ADM_DIVA" is present,
1018        perform additional runs (number of additional runs is "add_DIVA_runs" taken
1019        from file run_ADM_DIVA ; should match "nchklev_3" in file "code_ad/tamc.h").
1020    o verification/lab_sea (AD test):
1021      - change to test Divided Adjoint Run in this set-up (both standard AD test
1022        and 2 secondary AD test: noseaice + noseaicedyn); drop the evp AD test.
1023    o pkg atm_ & ocn_compon_interf:
1024      - remove cpl_earlyExpImpCall=F option (was mainly a hack added for the old
1025        staggerTimeStep implementation) and disable (retired) corresponding
1026        parameter.
1027    o pkg/offline:
1028      - comment out unused field-array: ICEM, ConvectCount, hflx[01], icem[01];
1029      - add S/R OFFLINE_CHECK to print offline parameter summary
1030        and stop if loading a file that is not used;
1031      - enable to calculate GMRedi tensor, KPP mixing and convective index
1032        when the corresponding file(s) is/are not specified (but pkg is used).
1033      - comment out resetting of monitorFreq (to endTime) since it still useful
1034        for monitoring CFL numbers and checking offline fields.
1035    o OpenAD:
1036      - do not define OAD_DEBUG (in tools/adjoint_options/adjoint_oad) to get
1037        smaller standard output) and generate new (smaller) output (on baudelaire
1038        using gfortran with -ieee) for exp. tutorial_tracer_adjsens
1039    o model/src:
1040      - call EXTERNAL_FORCING_SURF outside bi,bj loops (in do_oceanic_phys.F),
1041        (where external_forcing_adjust was called) and change list of arguments;
1042      - merge external_forcing_adjust.F into external_forcing_surf.F
1043      - put surface relaxation of SST & SSS in new S/R (forcing_surf_relax.F)
1044        which also contains balancing surface relaxation (ALLOW_BALANCE_RELAX,
1045        previously in file "balance_relax.F", now removed); remove corresponding
1046        arrays in FFIELDS.h.
1047      - EXTERNAL_FORCING_SURF is now called when using pkg/offline; implement
1048        a hack for getting back surfaceForcingS (loaded from file) when using
1049        ALLOW_OLD_VIRTUALFLUX (pkg/dic, in DIC_OPTIONS.h) in offline set-up.
1050      - update output of AD test experiment global_ocean.cs32x15.seaice_dynmix
1051        (was getting only 11 digits for AD-grad, due to different truncation
1052         error in AD code).
1053    
1054    checkpoint64j (2013/07/04)
1055    o pkg/offline:
1056      - to enable the use of other features with pkg offline (e.g., obcs),
1057        also call S/R DO_OCEANIC_PHYS in offline run - more modifs to come.
1058      - comment out "allowFreezing" (now active) in 2 offline testing exp.
1059    o pkg/exf ALLOW_RUNOFTEMP
1060      - fix sign and make compatible with temp_EvPrRn .NE. UNSET_RL
1061      - ahdded RUNOFTEMP test to verification/global_ocean.cs32x15/input.seaice
1062      - changes verification/global_ocean.cs32x15/results/output.seaice.txt
1063    o pkg/atm_phys:
1064      - allows to add some damping on uVel,vVel (strength only function of k).
1065    o verification, ad-tests:
1066      - reduce length of the simulation for AD test: global_ocean.cs32x15.seaice,
1067        global_ocean_ebm and offline_exf_seaice.thsice.
1068    o verification/halfpipe_streamice:
1069      - found a bug in s/r pkg/streamice/streamice_advect_thickness which caused
1070        flux input boundary conditions to be ignored; a fix for this bug changed
1071        verification results for forward test.
1072      - add adjoint test.
1073    o pkg/ptracers:
1074      - allow to restart without SOM pickup (resetting SOM to zero).
1075    o pkg/gmredi:
1076      - New parameterisation for the calculation of K and (GM_PsiX,GM_PsiY) added.
1077      - It uses mixing length theory and suppression by steering level effects to
1078        calculate a diffusivity used in the Redi tensor (see Bates et al., submitted
1079        to JPO, for more details).
1080      - It also uses the diffusivity to calculate an eddy induced streamfunction
1081        based on a PV closure (rather than a buoyancy closure as in GM).
1082      - New files added to pkg/gmredi:
1083        gmredi_k3d.F calculates the diffusivity for the Redi tensor and the eddy
1084          induced overturning streamfunction (called from gmredi_calc_tensor)
1085        gmredi_calc_eigs.F calculates the eigenvalues and eigenvectors required
1086          for use in gmredi_k3d
1087        gmredi_calc_urms.F calculates the the rms eddy velocity used to calculate
1088          the eddy diffusivity
1089    
1090    checkpoint64i (2013/06/18)
1091    o pkg/cheapaml:
1092      - take src files from MITgcm_contrib/verification_other/offline_cheapaml/code
1093        that enable the use of seaice (pkg/thsice thermo & pkg/seaice dynamics)
1094        with pkg/cheapaml.
1095    o utils/python: add subpackage for cubed sphere function, first example is
1096        simple cs.pcol to plot 2D fields on a map
1097    o pkg/streamice:
1098      - This is a new package in MITgcm, which solves dynamic equations for ice
1099         sheets and ice streams
1100      - At the moment it is independent of atmosphere/ocean dynamics, or any
1101        other physical packages in MITgcm, even ShelfIce (although it is anticipat-
1102        ed that this will change)
1103      - There is a new verification exercise that tests it, halfpipe_streamice,
1104        evolves a 40x80 km ice stream/ice shelf (at coarse resolution) in a
1105        rectangular embayment
1106      - halfpipe_streamice is forward-only for now, will have TAF test soon
1107      - for questions, email dgoldber@mit.edu
1108    o pkg/thsice:
1109      - fix filling of snow-precip diagnostic (SIsnwPrc) (left from the removing
1110        of snowPrc from common bloc, on May 2nd, thsice_step_fwd.F revision 1.40);
1111      - remove diagnostics 'SI_FrcFx' ( now identical to 'SI_Fract' with new
1112         call sequence: ice-Thermo(thsice),ice-Dyn,ice-Advect );
1113      - allow precip from pkg/cheapaml to make snow over seaice.
1114    o pkg/cfc:
1115      - move in separated header file (CFC_ATMOS.h) time-serie arrays of Atmos CFC
1116      - remove atmos CFC 2-D arrays from common bloc (now local variables)
1117      - change some hard-coded constant to run time parameter for reading and
1118        and interpolating atmospheric CFC ; keep same default as previously.
1119      - more flexible reading of Atmos CFC (number of records no longer hard-coded)
1120      - put arguments in standard order: myTime, myIter, myThid
1121      - use standard S/R GET_PERIODIC_INTERVAL for time interpolation of
1122        atmospheric CFC ; fix for the case myIter < PTRACERS_iter0.
1123      - fix calculation of surf tendencys for partial-cell and/or Non-Lin Free-Surf
1124      - new routine to print summary of CFC params and check for consistency.
1125    o pkg/seaice: add uice/vice to the parameter list of s/r seaice_advdiff,
1126      similar to thsice_advdiff.
1127      Note that for the B-grid case the routine parameters uc/vc are overwritten.
1128    o pkg/cfc:
1129      - change time interpolation for atmospheric CFC-11 (now same as for CFC-12);
1130        update output (CFC-11) of experiment cfc_example and tutorial_cfc_offline.
1131      - fix interpolation of atmphspheric CFC between Sorthern and Northern
1132        hemisphere value.
1133    o pkg/seaice:
1134      - allow to use seaice dynamics without pkg/exf (e.g., using pkg/cheapaml)
1135    o pkg/seaice: add Adams-Bashforth2 time discretization for ice dynamics;
1136                  so far only for JFNK-solver, turn on with SEAICEuseAB2 = .TRUE.
1137      - requires an additional time level that is stored in the pickup
1138      - you can start with AB2 from a pickup without this time level with
1139        pickupStrictlyMatch = .false.
1140    
1141    checkpoint64h (2013/05/26)
1142    o pkg/cheapaml:
1143      - replace one ()**.5 with SQRT + use temp var "cdu = tau/Du" (coare3_flux);
1144        affect machine truncation (but exp cheapAML_box still pass with 13 digits).
1145      - consistent treatment of uWind,vWind location: assume everywhere in
1146        pkg/cheapaml that they are on C-grid (@ uVel,vVel location)
1147        (Note: was already the case for Tair,Qair advection);
1148        add option (INCONSISTENT_WIND_LOCATION) to recover old results.
1149      - compute diabatic forcing only in the interior (excluding overlap regions)
1150      - fill in array "Qsw" (for short-wave heating);
1151      - add diagnostic for precip ; fill-in diagnostics for cheapAML state vars
1152        before any update (consistent with MITgcm state var diagnostics);
1153      - cheapaml_fields_load.F & cheapaml_init_varia.F : only fill outer edges if
1154        non periodic ; + adjusted for uWind,vWind (C-grid).
1155    o pkg/seaice:
1156      - remove dependence of pkg/seaice versus pkg/exf (file: pkg/pkg_depend) and
1157        add explicitly pkg/exf in experiments that currently use pkg/seaice.
1158      - allows to compile pkg/seaice without pkg/exf.
1159    o tools/OAD_support:
1160      - use a local copy (ourRWCPinBd) to ensure index ourRWCP stays within bounds
1161        of array "ourStepOf" in function rvNextAction (revolve.F90).
1162    o pkg/aim_compon_interf renamed to pkg/atm_compon_interf
1163      - change pkg name (to be used with other atmospheric physics pkg)
1164        but by-pass CVS when making the new pkg so that we keep the CVS history.
1165    o pkg/offline:
1166      - call OFFLINE_FIELDS_LOAD from pkg/offline/offline_init_varia.F
1167        (previously called from pkg/dic_surfforcing_init.F)
1168    o model/src:
1169      - re-order sequence of calls within packages_init_variables.F, using
1170        standard order, except for:
1171         DIAGNOSTICS_INIT_VARIA and OFFLINE_INIT_VARIA (called @ the top),
1172         CTRL_MAP_INI and OBCS_INIT_VARIABLES (called @ the bottom)
1173    o new pkg: atm_phys
1174      - add entry point and source code (previously in contrib
1175          verification_other/atm_gray/code_gray/) for new pkg "atm_phys"
1176        (atmospheric physics pkg from P. O'Gorman and T. Schneider, JCl, 2008).
1177      - re-order sequence of calls within packages_readparms.F,
1178         packages_init_fixed.F and packages_write_pickup.F
1179        (but skip packages_init_variables.F because of TAF issues).
1180      - update contrib/*/atm_gray/ experiment.
1181    o pkg/seaice (ITD code):
1182      - simplify and fix the writing of pickup-files for ITD case
1183    o pkg/seaice (ITD code):
1184      - introduce floe size dependent lateral melt for ITD case;
1185      - cleaning (avoid division by zero, change to f77 syntax, remove tabs)
1186      - update seaice_itd experiment main output.
1187    o pkg/thsice:
1188      - remove snowPrc from common block THSICE_FLUX, in THSICE_VARS.h and
1189        declared it locally (without bi,bj) in thsice_main.F & aim_do_physics.F;
1190        changed accordingly pkg/atm2d.
1191    
1192    checkpoint64g (2013/05/01)
1193    o pkg/exf ALLOW_RUNOFTEMP
1194      - if defined,  river and glacier runoff temperature can be read-in from
1195        runoftempfile; runoftempfile needs to have same format as runofffile
1196    o pkg/thsice (& pkg/bulk_force):
1197      - In case Energy-Reference-Level (ERL) is used (temp_EvPrRn=0), account
1198        for energy content of Precip + RunOff & Evap (like with pkg/exf).
1199      - change computation domain to always be the interior (without overlap).
1200      - fix bug (wrong overlap) when using EXF and stressReduction > 0.
1201    o verification/tutorial_global_oce_biogeo:
1202      - add preliminary OpenAD setup (still has problems)
1203    o pkg/seaice:
1204      - turn some parameters for choosing the convergence criterion of
1205        the inexact Newton method (JFNK) into runtime parameters for convenience
1206      - clean up seaice_calc_viscosities.F: remove/retire two options for
1207        SEAICetaZmethod (1,2), introduce area weighting for method 3; this changes
1208        the results of lab_sea/input because a division has been replaced by
1209        a multiplication with the reciprocal (sumNorm)
1210      - modify offline_exf_seaice/input.dyn_jfnk/data.seaice to improve
1211        convergence of solver (changes results, of course), and to test some
1212        new features
1213    o model/src:
1214      - remove unused (since Aug 2006) S/R SET_WRITE_GLOBAL_PICKUP and its call.
1215      - remove unused forcing field "dQdT" and associated parameter "dQdTFile".
1216      - move forcing adjustment (balancing surface forcing) in specific S/R
1217        where might also be applied exchanges (if needed) to forcing arrays.
1218    o pkg/shelfice:
1219      - allow to specify the Ice-Shelf mass per unit area (instead of
1220        shelficeLoadAnomaly) and do the conversion from one to the other
1221      - move loading from file of shelficeLoadAnomaly from SHELFICE_INIT_VARIA
1222        to SHELFICE_INIT_FIXED: (a) avoid some TAF recompution issues and
1223        (b) will be loaded in time (before calling INI_PRESSURE) in case it is
1224        needed in phi0surf for initial pressure calculation when useDynP_inEos_Zc
1225      - update isomip experiment forward output (get machine truncation error
1226        from conversion shelficeLoadAnomaly -> shelficeMass -> shelficeLoadAnomaly)
1227    o verification/offline_exf_seaice:
1228      revise data.seaice in input.thermo and input_ad and update results accordingly
1229        HO = 0.2, SEAICE_areaLossFormula = 2,
1230        SEAICE_growMeltByConv = .TRUE.,
1231        SEAICE_doOpenWaterMelt = .TRUE.,
1232      Improve consistency with input.thsice and fix the spurious 500m ice corners
1233    o verification/global_ocean.cs32x15:
1234      - set Energy Reference Level to liq. water @ 0 degC: temp_EvPrRn=0.,
1235        in icedyn (thsice+seaice-dyn) test and update output.
1236    o verification/offline_exf_seaice:
1237      - adjust list of tested variables (with testreport) and update
1238        standard test output with better slection of monitored fields.
1239    o pkg/cd_code:
1240      - swtich off Adams-Bashforth on the 1rst iteration. Update output of
1241        experiment lab_sea.hb87
1242    o tools/genmake2:
1243      - change default makedepend from the system default to tools/xmakedepend:
1244        When no makedepend is specified, select tools/xmakedepend it the test pass,
1245        otherwise select the system default (if exist and pass the test) or
1246        try to build cyrus-makedepend ; stop if none of the 3 works.
1247    o pkg/exf & pkg/thsice:
1248      - In case Energy-Reference-Level (ERL) is used (temp_EvPrRn=0), account
1249        for energy content of Precip + RunOff & Evap. Assumes:
1250       1) Rain has same temp as Air.
1251       2) Snow has no heat capacity (consistent with seaice & thsice pkgs)
1252       3) Run-Off comes at the temp of surface water (with same Cp)
1253       4) Evap over ocean is released to the Atmos @ surf-temp (=SST); should be
1254        put directly into Latent Heat flux & should use water-vapor heat capacity.
1255       5) Evap over snow/seaice (pkg/thsice) assumes constant Lf+Lv (consistent
1256        with snow having no Cp) => water vapor is released to Atmos @ 0^oC (=ERL).
1257    o pkg/seaice: simplify the use of CPP flags in JFNK-related files
1258        (compile when SEAICE_ALLOW_JFNK is defined)
1259    o pkg/thsice:
1260      - fix oceanic flux diagnostics & timeave (left from new sequence of calls
1261        implementation): move THSICE_AVE call after the advection (called directly
1262        from thsice_do_advect.F).
1263    o verification/global_ocean.90x40x15 and OpenAD:
1264      New experiment for OpenAD is identical to the one in input_ad except that
1265        multiDimAdvection=.FALSE.,
1266      There is still an issue with this.
1267    o pkg/thsice:
1268      - account for ice velocity (ocean relative velocity) in turbulent heat flux
1269        at the base of the ice; update output of global_ocean.cs32x15 (icedyn)
1270        and offline_exf_seaice (main test).
1271    
1272    checkpoint64f (2013/03/31)
1273    o verification/OpenAD:
1274      - new (smaller, without OAD_DEBUG) output_oadm.txt generated using gfortran.
1275    o verification/isomip, pkg/shelfice and OpenAD:
1276      - add OpenAD setup to this exp and make shelfice package work with OpenAD
1277    o verification/tutorial_global_oce_biogeo:
1278      - update AD and TLM output after turning off ALLOW_FE (in DIC_OPTIONS.h)
1279    o verification/offline_exf_seaice:
1280      - replace adjoint experiment (now similar to fwd input.thermo/ setup).
1281    o verification/tutorial_tracer_adjsens, pkg/ptracers and OpenAD:
1282      - add OpenAD setup to this exp and make ptracers package work with OpenAD
1283    o pkg/seaice/seaice_evp.F:
1284       mask the asymmetric contribution of the ice-ocean stress (when
1285       the turningAngle is non-zero) over open water to avoid stripes
1286       in the EVP-solutions after many EVP-substeps. This does not change
1287       the verification experiment (because turningAngle=0 in that experiment),
1288       but will affect other EVP solutions with turningAngle.ne.0
1289    o verification, AD & TLM output:
1290      - new TAF version 2.3.10 (previously 2.3.8) add more parenthesis in multiple
1291        additions and multiplications which affect results at machine truncation
1292        level. Update few AD output (1D_ocean_ice_column, bottom_ctrl_5x5,
1293        lab_sea.noseaicedyn & offline_exf_seaice) and TLM output
1294        (1D_ocean_ice_column & tutorial_tracer_adjsens.som81) which had only 12
1295        digits of matching.
1296    o pkg/seaice:
1297       modify lsr-algorithm so that it vectorizes AND converges by using a
1298       "zebra" method: split vector loop into two with step size 2; this
1299       solves a general convergence problem for the JFNK solver on a vector
1300       computer. It has the potential to even improve convergence for
1301       non-vector machines, but it does change the results so it is turned
1302       off by default. To turn on define CPP-flags SEAICE_VECTORIZE_LSR and
1303       SEAICE_VECTORIZE_LSR_ZEBRA in SEAICE_OPTIONS.h
1304    
1305    checkpoint64e (2013/03/05)
1306    o pkg/ecco and several verification experiments:
1307       Remove special versions of the_model_main.F, the_main_loop.F, forward_step.F
1308       from ecco package, and revert to unified routine in model/src/
1309       Adjust verification experiments accordingly, especially gloal_oce_llc90
1310       Should conclude long-standing work by Gael to reconsile the_main_loop with
1311       ECCO and will enable OpenAD's revolve loop in ECCO setup.
1312    o pkg/generic_advdiff:
1313      - implement compressible flow method for multi-dim advection (similar to
1314        gad_som_advect.F); add new option "GAD_MULTIDIM_COMPRESSIBLE" (since
1315        TAF generates many recomputations) to use it; no yet coded with implicit
1316        vertical advection.
1317      - change experiment advect_cs (new output) and advect_xy (same output)
1318        to test compressible flow multi-dim advection.
1319    o pkg/generic_advdiff:
1320      - fix SOM advection for unusual cases (linear Free-Surf in r*, other
1321        cases where linear Free-Surf is not @ k=1, e.g., useShelfIce)
1322    o pkg/seaice:
1323      - fix bug in the no-slip implementation in seaice_calc_strainrates.F, this
1324        bug affects two verification experiments (lab_sea and lab_sea.hb87),
1325        recover old (wrong) results by setting noSlipFac = 2. in
1326        seaice_calc_strainrates.F;
1327      - add another averaging method for etaZ (etaZmethod=3), a mix of 2 and 0
1328      - add runtime parameter SEAICE_JFNKepsilon for that finite difference
1329        gradient in the Jacobian times vector operation (s/r seaice_jacvec)
1330      - fix line search in seaice_jfnk.F (s/r seaice_jfnk_update)
1331    o pkg/seaice: reorganize seaice_lsr.F to be able to reuse more code:
1332      - new subroutines seaice_lsr_tridiagu/v
1333      - introduce loop bounds i/jmin/max to be able to use a restricted
1334        additive Schwarz method, but not used for now.
1335      - rename SEAICE_CALC_LSR_COEFFS into SEAICE_LSR_CALC_COEFFS
1336      - use new subroutines seaice_lsr_tridiagu/v in s/r seaice_preconditioner
1337    o OpenAD support
1338       Reorganize S/R call for overall time-stepping loop to facilitate
1339       OpenAD revolve loop replacement
1340       (new S/R main_do_loop.F)
1341    o model/src:
1342      - add 3-D array 3rd dimension to argument list of S/R ADAMS_BASHFORTH2/3;
1343      - pkg/cheapaml: remove local S/R ADAMS2d and use instead standard S/R
1344        ADAMS_BASHFORTH2.
1345    o pkg/cheapaml:
1346      - add new parameter (default=F, same as before) to disable full domain
1347        (including land) periodicity in X & Y dir.
1348      - new S/R CHEAPAML_COPY_EDGES to copy relaxation field into edges of
1349        prognostics field ; merge the 2 S/R cycle_2d_tracer and timestep_2d_tracer
1350        into single S/R CHEAPAML_TIMESTEP.
1351    
1352    checkpoint64d (2013/02/17)
1353    o pkg/monitor (angular momentum):
1354      - do not add Eta contribution to the total AM if using rigid-lid;
1355      - correct for Adams-Bashforth in zonal-wind part (instead of in AM_eta).
1356      - horizontal discretisation: compute Zonal wind contribution separately for
1357        each component (instead of from cell centered averaged) and use the 4
1358        grid-cell corner averaged value of Omega*(R*cos_Phi)^2 in AM_eta part.
1359      - Check that AM is conserved with linear dynamics (momAdvection=F and linear
1360        FreeSurf) if using vectorInvariant momentum.
1361    o model/src (horizontal grid):
1362      - move initialisation of all horizontal grid arrays to null value
1363        from specific horizontal grid S/R to main S/R INI_GRID;
1364      - add 2 new arrays to project model C-grid velocity on to zonal direction
1365        (similar to AngleCosC & -AngleSinC but at U and V point location) and
1366        compute them in S/R CALC_GRID_ANGLES.
1367    o pkg/seaice: replace a hard coded parameter by a runtime parameter
1368        SEAICE_JFNK_tolIter
1369    o pkg/seaice: introduce a restricted additive Schwarz (RAS) method in
1370        preconditioner for JFNK (run LSR into the overlaps as far as possible,
1371        i.e OLx/y-2, but overwrite the solution in the overlaps)
1372      - extend loop range in seaice_calc_viscosity
1373      - add new parameters SEAICE_OLx/y (default = OLx/y-2)
1374      - add flexible loop ranges to seaice_preconditioner, seaice_calc_lsr_coeffs
1375      - slightly modify loops in tridiagonal solver lsr-preconditioner
1376      - by default remove the extra exchange in seaice_preconditioner with a
1377        replacement of an undocumented CPP flag by SEAICE_PRECOND_EXTRA_EXCHANGE
1378      - modify offline_exf_seaice so that old results without RAS are reproduced
1379        for output.dyn_jfnk.txt
1380      in seaice_fgmres.F (unrelated to RAS)
1381      - add a cpp-flag option for a re-ordered mapping (potentially more
1382        efficient), but because this changes the results, turn it off by
1383        default
1384      - replace the save statement by local common blocks
1385    o utils/matlab:
1386      - fix tile-offset in rdmnc.m when output was produced using EXCH2.
1387      - update cs_grid/bk_line scripts to use load_grid.m (in utils/matlab)
1388        instead of local script "load_cs.m".
1389    o pkg/seaice:
1390      - fix a serious bug in seaice_fgmres.F, s/r seaice_scalprod, connected
1391        to the scalarProductMetric and the unrolling. By chance this does not
1392        change the verification experiment, because of the particular domain
1393        decomposition
1394    o pkg/diagnostics:
1395      - change default missing_value from UNSET_RL to -999.
1396    o pkg/layers: improve vectorization of layers_fluxcalc.F
1397      - step 1: split loops, make TatU/V 2D arrays. This alone reduces the cpu
1398        time spent in this routine by more than a factor of 3 on an NEC-SX8
1399      - step 2: replace search algorithm by a bisection algorithm found in
1400        Press et al. Numerical Recipes in Fortran. This algorithm can be
1401        vectorized and finds the correct bin in approx. log2(Nlayers) steps.
1402        For now, use this algorithm only for TARGET_NEC_SX defined.
1403      - moved the search algorithm into a separate subroutine, that is kept
1404        within the same file for automatic inlining.
1405      - modified catching potential errors
1406    o pkg/ecco:
1407      - add compile switches ALLOW_SHALLOW_ALTIMETRY and ALLOW_HIGHLAT_ALTIMETRY.
1408    o model/src, pkg/autodiff, pkg/ctrl, pkg/grdchk :
1409      - modifications for ALLOW_GENTIM2D_CONTROL
1410      -- forward_step.F, the_main_loop.F : pass options and arrays for adjoint tapes.
1411      -- load_fields_driver.F : add call to CTRL_MAP_GENTIM2D( myTime, myIter, myThid )
1412      -- add xx_gentim2d0/1 in ctrl_ad_check_lev1_dir.h checkpoint_lev1_directives.h etc
1413      -- use ctrl_swapffields.F (new) instead of exf_SwapFFields.F in ctrl_get_gen.F
1414    o model/src:
1415      - account for moist thermodynamics in (dry) potential temperature equation;
1416        update results of experiments: aim.5l_cs (x2), fizhi-cs (std + aqualev)
1417        and cpl_aim+ocn.
1418      - also switch to standard compiler (gfortran, was using ifort previously)
1419        for fizhi-cs experiments reference output.
1420    o pkg/ctrl:
1421      - 1st step toward generic time-varying control variable (2D) via CPP option
1422        ALLOW_GENTIM2D_CONTROL
1423      - note new namelist ctrl_nml_genarr in data.ctrl
1424    o verification/global_ocean.cs32x15:
1425      - switch off OLD_THSICE_CALL_SEQUENCE (both forward and AD code) to use new
1426        thsice calling sequence and update "output.icedyn.txt" output file.
1427    o pkg/ptracers:
1428      - from Ryan A.: code to allow to restart a tracer at regular time interval
1429        specifying a reset frequency and a reset-phase (for each tracers).
1430    o pkg/thsice:
1431      - implement new sequence of calls for thsice+seaice:
1432          previously:   ice-Dyn,ice-Advect,ice-Thermo(thsice)
1433          new sequence: ice-Thermo(thsice),ice-Dyn,ice-Advect
1434      - allows (with temporary CPP option "#define OLD_THSICE_CALL_SEQUENCE"
1435        in CPP_OPTIONS.h) to recover old sequence;
1436      - update diagnostics for Intermediate State thsice diagnostics: now filled
1437        just before advection (instead of just after advection in old sequence);
1438      - update output of experiment offline_exf_seaice (standard test);
1439      - in global_ocean.cs32x15 exp., postpone output.icedyn.txt update
1440        by setting #define OLD_THSICE_CALL_SEQUENCE in CPP_OPTIONS.h
1441    o pkg/aim_v23:
1442      - use tiled array for aim_CO2 and surface wind speed for export to coupler;
1443      - use standard pkg/mdsio routines to read & write CO2 pickup file;
1444      - in-line S/R AIM_AIM2DYN_EXCHANGES in aim_do_physics.F;
1445      - Implement new sequence of calls for seaice advection (with thsice and
1446        seaice diffusion): do ice advection after ice-Thermodynamic (previously
1447        was done before); change aim_do_physics.F (split the bi,bj loops block);
1448      - use same CPP option (OLD_THSICE_CALL_SEQUENCE) to recover old sequence;
1449    o pkg/thsice:
1450      - add a missing EXCH of sIceLoad in thsice_main.F (ocean set-up) for the case
1451        where just seaice diffusion is used without seaice-dynamics.
1452    
1453    checkpoint64c (2013/01/18)
1454    o pkg/seaice:
1455      - add a parameter JFNKres_tFac that can replace JFNKres_t
1456        (= JFNKres_tFac*JFNKresidual before JFNK solver)
1457      - add a line search option to the JFNK solver
1458      - move update of u/vIce and computation of initial residual into a separate
1459        routine (same file); makes the code a little easier to read (?)
1460      - the line search requires computation of the residual and for some reason
1461        I cannot do the update of u/vIce at the beginning of the Newton loop
1462        without changing the results, so we move computation of the new residual
1463        also to the end of the Newton loop, even without the line search
1464    o pkg/mdsio:
1465      - write missing value (corresponding to undefined array value) to meta files;
1466        skip this if missing value is one (UNSET_RL would be a better value for the
1467        case of undefined missing value but it's current the default missing-value);
1468        Also update mdsio_read_meta.F (reading timeInterval & missing-value).
1469    o pkg/exf & thsice:
1470      - for diagnostics purpose, fill-up and update Qsw array (+ fill the
1471        diagnostics) even when SHORTWAVE_HEATING is #undef;
1472    o verification/cfc_example:
1473      - turn on pkg/layers with pkg/diagnostics (to test pkg/layers and to
1474        illustrate how to use it).
1475    o verification/offline_exf_seaice:
1476      in input: add SEAICErestoreUnderIce=.TRUE., and reduce size of forcing
1477        files to only one time-record.
1478      in input.thermo: narrow the 2 bands of low initial ice-concentration near
1479        N & S edges; switch on SEAICErestoreUnderIce=T; use pkg/diagnostics for
1480        snapshot output; same mcPheePiston value as in thsice with
1481        surf-current=0.2m/s.
1482      in input.thsice: similar set-up as in input.thermo (channel with same seaice
1483        initial conditions).
1484    o verification/cfc_example:
1485      - update file "data" with more standard choice (default rotationPeriod,
1486        exactConserv=T, reduce ivdc_kappa to 10, remove multiDimAdvection=F,
1487        set deltaTFreeSurf to deltaTtracer) and update the output.
1488    o pkg/layers:
1489      - fix bolus part so that it compiles with #undef GM_BOLUS_ADVEC;
1490      - ensure that "layers_bolus" is switched to False when useGMRedi=False.
1491    o verification/offline_exf_seaice:
1492      - set all {field}period to zero for constant-in-time forcing (not tested
1493        anywhere else).
1494    o verification/offline_exf_seaice:
1495      - dyn_lsr  : use pkg/seaice S/R (instead of pkg/thsice) to advect sea-ice;
1496      - dyn_jfnk : use pkg/thsice S/R (instead of pkg/seaice) to advect sea-ice.
1497    o model/src:
1498      - implement Finite-Volume method for (hydrostatic) presure gradient
1499        from S.-J. Lin (QJRMS 1997), for atmosphere using sigma-coordinate.
1500    o pkg/seaice: implement EVP* by Lemieux et al. (2012).
1501      - In order to be compatible with the default EVP code, this requires changing
1502        the EVP code around a little; and because any small change immediately
1503        breaks the lab_sea.hb87 verification experiment, the reference output is
1504        updated two times (each time the remaining aggrement was only 2 digits):
1505        - after replacing 1/dt by 1*recip_dt with a precomputed recip_dt
1506        - after replacing 1/(1+0.5*dt/tau) by a/(a+1), with a=2*tau/dt
1507        The adjoint test lab_sea.evp also needed to be updated.
1508      - Turn on EVP* by setting SEAICE_deltaTevp as before, and setting
1509        SEAICEuseEVPstar=.true.; for EVP* SEAICE_deltaTevp does not need to be
1510        a factor of SEAICE_deltaTdyn, and you can set the number of EVP steps
1511        explicitly with SEAICEnEVPstarSteps (thereby overriding the default of
1512        INT(SEAICE_deltaTdyn/SEAICE_deltaTevp)). Controlling EVP* is deliberately
1513        kept obscure, because I need to test it a little more.
1514    o pkg/cheapaml:
1515      - fix few incorrect type (_RL/_RS) in subroutine calls.
1516    o pkg/seaice:
1517      - new S/R SEAICE_MAP_RS2VEC (similar to SEAICE_MAP2VEC) to map _RS arrays
1518        to _RL vector; this fixes JFNK code when compiling with "-use_r4" option.
1519    o model/src:
1520      - add a warning if using select_rStar=2 with nonlinFreeSurf <> 4;
1521        change (in input_ad*/data) select_rStar from 2 to 1 for AD verification
1522        experiments global_ocean.cs32x15 & tutorial_tracer_adjsens (+ update output)
1523    o pkg/cheapaml:
1524      - replace "273.1 _d 0" by celsius2K in pkg/cheapaml/cheapaml.F and
1525        update output of experiment cheapAML_box.
1526      - store in CHEAPAML.h coeffs ssq[0:2] for saturation specific humidity,
1527        and set them only in one place (cheapaml_readparms.F).
1528      - replace "273.16 _d 0" by celsius2K & replace "3.14159 _d 0" by constant "PI"
1529      - remove re-setting of main-model parameter "celsius2K" (in cheapaml_readparms)
1530        and re-setting of cheapAML params "lath" & "p0" (in cheapaml_init_varia).
1531    o model/src/the_main_loop.F:
1532      - fix revision 129 : need both ALLOW_ECCO and ALLOW_ECCO_EVOLUTION.
1533    o pkg/seaice:
1534      - remove legacy branch code.
1535      - retire SEAICE_GROWTH_LEGACY and SEAICE_CAP_HEFF accordingly.
1536    o verification/*/code*/SEAICE_OPTIONS.h:
1537      - remove documentation for retired CPP flags (SEAICE_GROWTH_LEGACY,
1538        SEAICE_CAP_HEFF).
1539    o pkg/cheapaml:
1540      - use standard routine (S/R GET_PERIODIC_INTERVAL) to decide when it is time
1541        to load new forcing fields.
1542      - add missing "_d 0" where it's needed; + some editing (improve indentation).
1543      - remove switch to "-r8" compiler option (no longer needed) in verification
1544        cheapAML_box, keep same output (small trucation error differences).
1545    o verification/offline_exf_seaice:
1546      - add thermodynamics only test.
1547    o verification/cheapAML_box:
1548      - split the domain in 8 (2x4) tiles; add MPI and multi-threaded test;
1549        keep same output (same 14 digits for cg2d).
1550      - switch on "-r8" compiler option (some numerical values are missing
1551        the "_d 0") and update output (only 6 digits for cg2d were preserved).
1552    
1553    checkpoint64b (2012/12/24)
1554    o pkg/cheapaml:
1555      - remove un-used variables (Qnet,EmPmR) from pickup files.
1556      - store tendency of advected variables into cheapaml pickup file
1557        and fix the AB-2 restart.
1558    o verification/offline_exf_seaice and lab_sea adjoint:
1559      - switch to new code (#undef SEAICE_GROWTH_LEGACY).
1560      - switch to 4 time steps in offline, consistent with lab_sea.
1561      - match parameters from SEAICE_GROWTH_LEGACY branch in data.seaice.
1562      - update results after change of experiment seaice.
1563    o pkg/seaice:
1564      - remove option SEAICE_MULTICATEGORY; has been replaced with run-time
1565        parameter SEAICE_multDim. Issue a warning if SEAICE_MULTICATEGORY is
1566        still defined since SEAICE_multDim needs to be set to MULTDIM value (from
1567        SEAICE_SIZE.h) to recover previous #define SEAICE_MULTICATEGORY default.
1568    o model/src:
1569      - add run-time parameter to select CG2D solver minimum-residual solution
1570        (in case of a poor convergence).
1571    o pkg/seaice/seaice_lsr.F
1572      - move calculation of matrix coefficients into new
1573        S/R SEAICE_CALC_LSR_COEFFS; for now this routine remains in the same
1574        file; the main purpose of this change is to be able to reuse the code
1575        in S/R SEAICE_PRECONDITIONER
1576      - modify the computation of the residual so that the mass of sea-ice
1577        is not used twice; this simplifies the calculations, but since
1578        the residual is never used except when LSR_mixIniGuess.ge.4---and this is
1579        not tested in testreport---this does not affect the testreport results.
1580    o verification/seaice_obcs:
1581      - disable SEAICE_GROWTH_LEGACY; reset input files to match those of
1582        verification/lab_sea/input.salt_plume; changes results/output.txt*
1583    o model/src:
1584      - adapt quasi-hydrostatic formulation to work with p or p* coordinate.
1585    o pkg/seaice:
1586      - improve description of parameters in seaice_fgmres.F and start
1587        cleaning up the code
1588      - change name of SCALPROD to SEAICE_SCALPROD and modify meaning of
1589        second argument
1590      - add a metric based on grid cell area to SEAICE_SCALPROD; update
1591        results of offline_exf_seaice.dyn_jfnk
1592      - compute initial residual norm in seaice_jfnk based on SEAICE_SCALPROD
1593    o pkg/aim_v23:
1594      - fix an other bug in dissipation heating (grid-cell area was missing).
1595    o model/src + pkg/seaice:
1596      - add global (multi-tile) linear solver for pair of tri-diagonal system
1597        along X and Y lines, respectively for U and V component.
1598        Note: 1) MPI and cube-exchange not yet coded.
1599            2) probably not accurate for poorly conditioned / large size problem.
1600      - add option for SEAICE_LSR to use global (multi-tile) tri-diagonal solver;
1601        default: not compiled and not used.
1602    o pkg/seaice:
1603      - first attempt at a multi-threaded fgmres solver for the JFNK solver:
1604        introduce bi/bj loops and use global_sum_tile_rl instead of
1605        mpi_allreduce in seaice_fgmres.F
1606      - improve diagnostics output for fgmres solver (seaice_fgmres.F)
1607      - replace a few unnecessary goto statements by if-blocks  (seaice_fgmres.F)
1608      - add a verification experiment for JFNK in offline_exf_seaice
1609    o verification:
1610      - change (for now, only fwd test) offline_exf_seaice experiment:
1611        use a re-entrant channel with idealized coastline (trapezoidal shape)
1612        at southern boundary to explore seaice dynamics and thermodynamics
1613        with simple forcing. Main set-up has dynamics+thermo and SST relaxation;
1614        secondary test (input.thsice) use thermodynamics only with SST relaxation.
1615      - add seaice-dynamics only secondary test using LSR and pkg/thsice advection.
1616    o pkg/exf:
1617      - disable "sstExtrapol" when Nr=1
1618    o verification:
1619      - add new experiment "cheapAML_box" (simple 1 layer set-up from Bruno Deremble)
1620        to test pkg/cheapaml.
1621    o pkg/aim_v23 & pkg/shap_filt:
1622      - fix dissipation heating (erroneous gravity multiplication factor).
1623    o pkg/seaice:
1624      - remove unused field pressPre from jfnk solver
1625      - rename two subroutines in seaice_preconditioner.F
1626    o eesupp/src:
1627       - S/R MDSFINDUNIT avoids reserved unit numbers (scrUnit1, eeDataUnit ...)
1628    o pkg/seaice/seaice_preconditioner.F: fix preconditioner once again
1629       - remove wrong parts of the rhs and the lhs (were in there
1630         because I did not understand the concept of this preconditioner)
1631       - add an exchange between u- and v-sweep. This increases communication
1632         by a factor of two but improves the convergence of jfnk. Ideally,
1633         one would like the u- and v-sweep to be independent. So far within
1634         undocumented ifdefs
1635       - reorganize the extra computations for printing the residuals
1636    o tools/genmake2:
1637      - comment out the "mpif.h" include in NetCDF test programm (for MPI built)
1638        since it's not necessary (and was preventing to use MNC in some cases).
1639    
1640    checkpoint64a (2012/11/16)
1641    o pkg/autodiff:
1642      - improve pkg-internal logical parameter switch (inAd/inFwd mode) so that
1643        autodiff_readparms.F no longer depends on calling order (within
1644        packages_readparms.F) and no longer requires to include ${PKG}_PARMS.h):
1645        rename param turnFreeDriftInAdMode to SEAICEuseFREEDRIFTswitchInAd
1646        and change param SEAICEuseDYNAMICSinAdMode to SEAICEuseDYNAMICSswitchInAd.
1647    o pkg/obcs:
1648      - adding tidal velocity forcing capability to obcs
1649        for usage example, see verification/seaice_obcs/input.tides
1650    o pkg/seaice:
1651      - turn the LSR-relaxation parameters WFAU/V into runtime parameters
1652        SEAICE_LSRrelaxU/V
1653      - introduce runtime parameter SEAICEetaZmethod (=0 by default)
1654    o pkg/aim_v23:
1655      - implement heating from friction (bottom friction and stratospheric drag).
1656    o pkg/shap_filt:
1657      - fix diagnostic "SHAP_dKE" (was 2 time smaller); implement heating from
1658        dissipation but only for Shap_funct=2, active when addFrictionHeating=T.
1659    o model/src:
1660      - move AddMass common block from DYNVARS.h to FFIELDS.h; allow to read-in
1661        time-constant addMass field from file (addMassFile);
1662      - support for heating due to friction (and Kinetic Energy dissipation):
1663        add option, run-time switch and 3-D field array + support code ; each pkg
1664        or S/R can add heating contribution (if there is a sink of KE); the sum is
1665        accounted for as a Temperature tendency term (EXTERNAL_FORCING_T).
1666    o pkg/seaice:
1667      - complete merge of ITD code into seaice_growth.F
1668        from MITgcm_contrib/torge/itd/code/
1669        no verification so far, but Torge Martin tested
1670        "1-D test case and Beaufort set up;
1671        deliver okay results after 1 model year."
1672      - complete merge of SEAICE_SIZE.h into all relevant routines
1673      - move computation of eta at Z-points into calc_viscosities
1674        + introduce global field etaZ
1675        + add different methods for computing etaZ, for now the old
1676          method (simple averages of eta to Z-points) is hardwired
1677        + replace etaMeanZ by etaZ in seaice_lsr, seaice_calc_residual,
1678          seaice_preconditioner
1679      - simplify computations for SEAICE_ZETA_SMOOTHREG
1680      - seaice_preconditioner:
1681        + replace one remaining press by pressLoc (mistake)
1682        + adjust printing of residuals
1683      - improve I/O of diagnostics of JFNK in seaice_jfnk.F:
1684        + add (SEAICE.h) and rename some counters (initiliased in
1685          seaice_init_fixed.F)
1686        + add _BEGIN/END_MASTER (myThid)  around print statements
1687        + print total number of iterations and failures over SEAICE_monFreq
1688          interval to STDOUT
1689      - move control over output-messages by fgmres to seaice_jfnk to save
1690        some operations
1691      - move resetting initial guess for fgmres outside of seaice_fgmres_driver
1692        in order to make restarts with sol .ne. zero (fgmres with restarts)
1693        (seaice_jfnk.F, seaice_fgmres.F)
1694      - seaice_calc_l/rhs.F: replace maskW/S by maskInW/S; this fixes
1695        a serious convergence problem when open boundaries are involved
1696    o pkg/ggl90: fix computation of control volumes for the case of
1697      ALLOW_GGL90_HORIZDIFF (probably not used very often): move control volumes
1698      up half a grid cell from C-centered to W-centered (pointed out by C. Eden)
1699    o pkg/seaice: simplify seaice_evp by avoiding use of extra fields u/vIceC
1700    o pkg/autodiff
1701      - Add inAdMode switch for SEAICEuseDYNAMICS:
1702        SEAICEuseDYNAMICSinAdMode
1703        (extend logic in ADAUTODIFF_INADMODE_SET)
1704    o pkg/seaice
1705      - Step 1 of merging ice-thickness distribution (ITD) code from
1706        MITgcm_contrib/torge/itd/ (author: Torge Martin)
1707        The code implements concept laid out in Thorndike et al. (1975);
1708        code is enabled via CPP flag SEAICE_ITD
1709        nITD (in SEAICE_SIZE.h) defines number of ice thickness categories;
1710        code is not complete yet!!
1711      - SEAICE_SIZE.h now included in almost all seaice routines
1712    o verification (using seaice):
1713      - switch back seaice-dynamics (+ lower SOLV_MAX_ITERS) in ADM exp.
1714        global_ocean.cs32x15.seaice ; update results.
1715      - compile B-grid dynamics in FW test exp 1D_ocean_ice_column ;
1716      - compile C-grid dynamics with #define SEAICE_ALLOW_JFNK in FW test exp
1717        offline_exf_seaice (previously compiling B-grid).
1718    o pkg/exf:
1719      - fix some STOP conditions in exf_check.F (from Aug 28, modifs did not allow
1720        to specify neither just 1 comp of wind or wind-stress, nor no surface momentum
1721        forcing): just replace CPP option ALLOW_ATM_WIND with run-time param useAtmWind.
1722    o pkg/layers (adjust changes from Sept 19):
1723      - do snap-shot output and fill diagnostics from inside iLa loop (layers_calc.F)
1724        this allows to remove "layers_maxNum" dimension from all layers arrays.
1725    o pkg/layers (adjust changes from Sept 19):
1726      - remove ALLOW_LAYERS_OUTPUT ; fix snap-shot and time-ave output ;
1727      - snap-shot extended to all type of layers (not just the 1rst type);
1728      - remove layers variables when corresponding CPP option is undef.
1729    o pkg/layers:
1730      - rename pkg/layers variable and add new output (layer exist & un-weighted
1731        velocity in layer)
1732    o pkg/seaice:
1733      - simplify (?) ocean-drag coefficent computations by using
1734        the same routine in all three solvers (saves some code lines)
1735      - remove global fields DRAGA and DRAGS from C-grid code and
1736        declare them locally in lsr.F (the only place where they are
1737        still used)
1738      - update AD output of lab_sea.evp (very sensitive anyway).
1739    o pkg/seaice: add Jacobian-free Newton Krylov solver for ice dynamics
1740      (Lemieux et al. 2010, 2012). Turn on with the usual SEAICE_ALLOW_JFNK
1741      and SEAICEuseJFNK=.true. A few things to note:
1742      - involves a FGMRES, that is parallel but very inefficient,
1743        because of many scalar products (global sums) in the Gram-Schmidt
1744        orthogonalization method. Needs to be replaced. Original code
1745        from J.-F. Lemieux
1746      - preconditioner for FGMRES is a stripped down version of LSOR
1747      - SOLV_MAX_ITERS is now used for LSOR as a solver and as a
1748        preconditioner. For the preconditioner, the default is set to 10.
1749      - Jacobian times vector is computed with finite differences
1750      - marginally related to JFNK-solver: add a smooth regularization for
1751        zeta with tanh that will improve convergence (Lemieux and Tremblay,
1752        2009) for any implicit solver (not implemented for EVP because EVP
1753        does not need this regularization in the first place). Define
1754        SEAICE_ZETA_SMOOTHREG in SEAICE_OPTIONS.h to use.
1755    o eesupp/src:
1756      - check in genmake2 that intrinsic S/R flush is available.
1757      - add S/R to flush IO unit (if intrinsic S/R flush is available)
1758      - flush standard & error msg unit before MPI termination
1759      - if debugMode, flush IO unit after printing msg
1760    o pkg/ctrl:
1761      - ctrl_unpack.F, ALLOW_GENARR3D_CONTROL code: fix missing argument in call
1762        to ctrl_set_unpack_xyz.
1763    
1764    checkpoint64 (2012/10/09)
1765    o pkg/shelfice
1766      - in mom_fluxform.F, mom_vecinv.F:
1767        CALL SHELFICE_V_DRAG(bi,bj,k,vFld,KE,KappaRU,vF,myThid)
1768        Bug fix KappaRU -> KappaRV
1769        does not change verification/isomip but may change other setups
1770        (presumably constant KappaRU=KappaRV)
1771      - fix diagnostics SHIU/Vdrag (thanks to Tom Millgate)
1772    o pkg/obcs:
1773      - fixed some indexing bugs in obcs_seaice_sponge.F
1774      - added obcs relaxation subroutines for HSALT and HSNOW
1775      - changes verification/seaice_obcs/results/obcs_seaice_sponge.F
1776    o pkg/seaice:
1777      - add "multicategory" parameterization for snow in analogy to ice,
1778        default is off for now.
1779    o pkg/obcs:
1780      - added obcs_seaice_sponge.F for obcs relaxation of seaice variables;
1781        see verification/seaice_obcs/input.seaiceSponge for example application.
1782      - remove local commom bloc "OBCS_GLOBAL" in obcs_readparms.F and do all the OB
1783        index setting by master-thread. This fix multi-threads Pb in previous modifs.
1784    o pkg/layers :
1785      - add diagnostics to pkg/layers
1786      - move the meat of pkg/layers from layers_calc.F to layers_fluxcalc.F
1787        (from R.Tulloch). Layers_calc.F now calls layers_fluxcalc.F accordingly.
1788    o pkg/generic_advdiff/gad_implicit_r.F :
1789      - fix ADVr diagnostics in case of both implicit vertical advection and diffusion.
1790    o pkg/seaice/seaice_growth.F:
1791      - fix SItflux diagnostics in virtual salt flux + balanceEmpmr case.
1792    o pkg/obcs:
1793      - change default setting of OBCS_UVICE_OLD from defined to undef;
1794      - use new parameter OB_indexNone for null index value (instead of hard-coded 0)
1795        in all pkg/obcs code and in other pkgs; remove k loop in obcs_check_depths.F;
1796      - pass OB_indexNone as (new) argument to S/R CTRL_MASK_SET_[X,Y]Z;
1797      - change OB null index value (OB_indexNone) to -99 ; this fix the problem
1798        with Southern & Western OB at a tile edge (at least in a simple set-up).
1799    o pkg/obcs:
1800      - change settings of OB index in case OB coincides with tile edge (shared by
1801        2 tiles), so that common OB location is registered by both tiles (instead of
1802        only 1). However, for Southern and Western OB, index value = 0 is not
1803        recognized as valid OB index (=default null value) and needs to be fixed.
1804      - modify accordingly OBCS_BALANCE_FLOW and OBCS_MONITOR (avoid double counting)
1805      - new parameter "OB_indexNone" for null index value (for now, still zero)
1806        to replace hard-coded null index value of zero.
1807    o pkg/exch2:
1808      - improve W2_USE_E2_SAFEMODE (faster) and W2_E2_DEBUG_ON:
1809        always check buffer-size (but outside the loop); move checking for valid
1810        index from W2_USE_E2_SAFEMODE to W2_E2_DEBUG_ON; in W2_E2_DEBUG_ON,
1811        print each tile and point connection only if |W2_printMsg|>= 2 and 3.
1812    o pkg/ctrl (pack & unpack):
1813      - in ctrl_pack.F & ctrl_unpack.F, use the same local file-name variable
1814        (locally defined) for different variables (+ remove the variable-specific
1815        file name in CTRL_GENARR.h). For now, only implemented for GENARR2/3D_CONTROL
1816        (to be extended to other local file names in ctrl.h).
1817    o pkg/flt:
1818      - add a FLT_Iter0 option (similar to PTRACERS_Iter0).
1819    o pkg/mdsio:
1820      - fix missing STOP in mdsio_readvec_loc.F (case ioUnit=0) when file is missing
1821    o tools/genmake2:
1822      - add similar dependences for target EXE_AD & EXE_FTL as we have for EXECUTABLE
1823        (added by Alistair in version 1.51 for building without make depend);
1824      - remove Header files list (H_SRC_FILES) from the dependence of targets
1825         ad_input_code.f & ftl_input_code.f (not clear why it was added in the first
1826        place in version 1.23): this save going through staf when unrelated header
1827        file has been modified.
1828       Note: for an intermediate target (e.g., ad_input_code.f or adtaf) without
1829        "make depend" step, still need to do "make links" before "make adtaf".
1830    o eesupp/src (+ few pkg src files) & genmake2:
1831      - finish to remove ALWAYS_USE_MPI in source code that TAF does not see;
1832      - no longer set ALWAYS_USE_MPI in Makefile (was done by genmake2).
1833      - improve genmake2 checking for ALLOW_${PKG} in CPP_OPTIONS.h files (distinguish
1834         upper/lower case ; account for space between "#" and undef/define)
1835    o pkg/flt (with exch2):
1836      - cleaning: fix so that it compiles; move remaining MPI calls out of flt_exch2.F;
1837      - simplify threads synchronisation; fix (many issues) multi-threaded with MPI.
1838    
1839    checkpoint63s (2012/09/05)
1840    o pkg/ecco:
1841      - remove #ifdef ALLOW_SMOOTH_CORREL3D brackets.
1842      - add more relevant #ifdef ALLOW_SMOOTH ones.
1843      - sort out useAtmWind, useSMOOTH, ctrlSmoothCorrel2D.
1844    o pkg/ctrl:
1845      - CTRL_OPTIONS.h : document CPPs related to smoothing; ALLOW_SMOOTH_CORREL2D/3D,
1846        ALLOW_CTRL_SMOOTH, ALLOW_SMOOTH_CTRL2D, ALLOW_SMOOTH_CTRL3D.
1847      - ctrl.h : document run time params doInitXX, doMainPack, doMainUnpack, doPackDiag,
1848        doSinglePrecTapelev (audodiff param!), ctrlSmoothCorrel2D (new) and
1849        ctrlSmoothCorrel3D (new).
1850        The added ctrlSmoothCorrel2D/3D replace the old ALLOW_SMOOTH_CORREL2D/3D CPP.
1851      - ctrl_readparms.F : initialise ctrlSmoothCorrel2D/3D and read from namelist.
1852      - ctrl_init.F ctrl_pack.F ctrl_unpack.F : switch off ustress/vstress
1853        controls when useAtmWind, and vice versa.
1854      - ctrl_map_ini_ecco.F : UVEL0, VVEL0, edtaux, edtauy cannot be smoothed as tracers.
1855      - ctrl_get_gen.F : replace #ifdef ALLOW_SMOOTH_CORREL2D with
1856          #ifdef ALLOW_SMOOTH, IF ctrlSmoothCorrel2D, IF useSMOOTH.
1857      - ctrl_map_ini_gen.F : replace #ifdef ALLOW_SMOOTH_CORREL3D with
1858          #ifdef ALLOW_SMOOTH, IF ctrlSmoothCorrel3D, IF useSMOOTH.
1859      - ctrl_set_pack_xy[z].F, ctrl_set_unpack_xy[z].F:
1860        replace ALLOW_SMOOTH_CORREL2D/3D brackets with ctrlSmoothCorrel2D/3D.
1861    o pkg/smooth:
1862      - remove un-necessary includes.
1863      - remove ALLOW_SMOOTH*D and ALLOW_SMOOTH_CORREL*D brakets.
1864        Those CPP options were never defined, and not necessary.
1865    o model/src:
1866      - fix CPP brackets in ini_mixing.F (GM_background_K belongs to gmredi).
1867      - standard treatment of useSMOOTH.
1868    o pkg/autodiff:
1869      - add LOGICAL useGGL90inAdMode, useGGL90inFwdMode, useSALT_PLUMEinAdMode,
1870        useSALT_PLUMEInFwdMode allowing to switch off ggl90 and salt_plume adjoint.
1871    o pkg/exch2:
1872      - add "if usingMPI" where it was missing (in exch2_rx?_cube*.template)
1873        + start to remove ALWAYS_USE_MPI in source code that TAF does not see.
1874      - make new S/R W2_MAP_PROCS out of w2_eeboot.F to setup exch2 CommonFlag
1875        and tiles to process mapping.
1876      - re-arrange 3 header files (W2_EXCH2_PARAMS.h, _BUFFER.h & _TOPOLOGY.h)
1877        moving /EXCH2_FILLVAL_RX/ & /W2_EXCH2_COMMFLAG/ to W2_EXCH2_TOPOLOGY.h;
1878        rename "exch2_tProc" to "W2_tileProc" and move seting of e2FillValue_RX
1879        from w2_eeboot.F to w2_readparms.F.
1880    o eesupp/src:
1881      - set exchNeedsMemsync & exchUsesBarrier according to "usingMPI" (instead of
1882        ALWAYS_USE_MPI) + moved from ini_communication_patterns.F to eeset_parms.F;
1883        also move setting of exchCollectStatistics from exch_init.F to eeset_parms.F
1884      - in eedie.F and all_proc_die.F, always call MPI_FINALIZE when ALLOW_USE_MPI
1885        is defined (remove condition on usingMPI) to match cases where MPI_INIT
1886        has been called.
1887      - fix bug I put in previous modif of exch_sm_3d_rx.template (not much used);
1888      - change default (non-MPI) value of myPid (from 1 to 0) to match MPI settings
1889        (so that on 1 proc, get same myPid independently of usingMPI)
1890      - add a stop if multi-procs but usingMPI=F ; stop also if usingMPI=T and
1891        useCubedSphereExchange with EXCH-1 (safer).
1892      - add "if usingMPI" where it was missing (+ start to remove ALWAYS_USE_MPI).
1893    o pkg/ggl90:
1894      - fix bug in filling corner mask array "mskCor" (FILL_CS_CORNER_TR_RL call)
1895        used in ALLOW_GGL90_SMOOTH code.
1896    o pkg/flt:
1897      - fix typo in FLT_WITHOUT_Y_PERIODICITY (the effect was to ignore stopping
1898        floats at the Southern end of the domain).
1899    o eesupp/inc:
1900      - add a list of CPP-options which can be set by Makefile (DEF_IN_MAKEFILE.h);
1901        but not used (and not to be used) anywhere, just for documentation.
1902    o pkg/autodiff, exf, ptracers & seaice (AD & TL output):
1903      - comment out the very nasty "writeBinaryPrec = writeStatePrec" line, since:
1904        a) can damage previously written records in any other multi-record files.
1905        b) if needed, can easily do it cleanly, by calling S/R WRITE_REC_3D_RL/S.
1906    o tools/genmake2:
1907      - define variable MAKE within Makefile and use it in place of 'make';
1908      - update AD_CONFIG.h (if needed) before building any of the executable
1909        (forward, adjoint or tangent-lin); this involves a 2nd invocation of make;
1910        and add the usual #ifndef/#define AD_CONFIG_H in AD_CONFIG.h;
1911      - always print usual warning comment 'this file is automatically generated'
1912        from script convert_cpp_cmd2defines (+ remove this warning from genmake2).
1913    o pkg/cheapaml:
1914      - updated to correspond to the code used in accepted paper (Nico Wienders).
1915    o pkg/exf:
1916        added run time switch useAtmWind to replace ALLOW_ATM_WIND cpp switch.
1917        ALLOW_ATM_WIND now just sets the useAtmWind default (see exf_readparms.F)
1918        and force defines ALLOW_BULKFORMULAE (EXF_OPTIONS.h).
1919    o pkg/exf, autodiff, ctrl, ecco and seaice:
1920        remove ALLOW_ATM_WIND brackets, or replace them with useAtmWind ones.
1921    o pkg/ctrl, ecco:
1922        allow to compile both ALLOW_U/VSTRESS_CONTROL and ALLOW_U/VWIND_CONTROL.
1923        Depending on useAtmWind, one is inactive, and the other is active (see
1924        exf_getffields.F/exf_getsurfacefluxes.F).
1925    o tools/genmake2:
1926      - improve error msg when failing in 2nd test of check_for_broken_Ff
1927      - fix option '-makefile' short-name (-mf according to genmake2 -help)
1928      - source local config file "genmake_local" just after processing the genmake2
1929        command arguments (previously done before processing arg).
1930    o pkg/grdchk:
1931      - add a call to TURNOFF_MODEL_IO for Tangent-Linear run (in this case, call
1932        to this routine from cost_final has been dropped in g_cost_final)
1933      - improve printed information (more explicit msg, no longer using "print *,"
1934         fix fcpertminus printed value).
1935    o model/src:
1936      - move call to COST_INIT_VARIA out of packages_init_variables.F directly
1937        into initialise_varia.F (just after calling PACKAGES_INIT_VARIABLES):
1938        this prevents getting cost-funct reset in adinitialise_varia recomputations.
1939    o pkg/dic:
1940      - move initialisation of "freefe" array from from dic_biotic_forcing.F to
1941        fe_chem.F: this prevents TAF from dropping this initialisation in TLM code.
1942    o pkg/grdchk:
1943      - grdchk_main.F : added CALL GLOBAL_SUM_INT( ierr , myThid )
1944      - grdchk_getadxx.F etc. : omit I/O if ierr.EQ.0
1945    o pkg/autodiff/ctrl/grdchk :
1946      - attempt to sort out what works and what does not,
1947        with regard to I/O, and to warn/stop accordingly.
1948    o pkg/grdchk:
1949      - attempt to fix grdchk in the case of useSingleCpuIO.
1950      - "if ( myProcId .EQ. grdchkwhichproc .AND. ierr .EQ. 0 )"
1951       statements were moved from grdchk_main.F and into
1952       grdchk_getadxx.F grdchk_getxx.F grdchk_setxx.F.
1953      - a global sum is applied to record numbers icvrec/layer
1954       out of grdchk_loc so that they be passed to I/O routines.
1955    o pkg/smooth:
1956      - fix recomputation that appeared with nlfs : use smooth_recip_hFacC,
1957        smooth_hFacW, smooth_hFacS (copied at init_fixed) in 3d case.
1958    o verification/testreport:
1959      - add option '-tlm' for Tangent-Linear test (-adm,-oad,-tlm are all exclusive);
1960      - can also use compressed (gzip) reference output file;
1961      - change format (in pkg/grdchk) of TLM output (+ add forward gradient)
1962        to be easier to collect by testreport.
1963      - update existing TLM output (half out-of-date by more than 3 yrs).
1964      - report NETCDF & LAPACK settings (from genmake2) in output dir.
1965      - report run-time in each individual summary (previously only for AD test);
1966        for TLM test, add also TAF version.
1967      - add daily TLM test on (old) aces cluster + weekly test on baudelaire.
1968    
1969    checkpoint63r (2012/08/15)
1970    o tools/genmake2:
1971      - fix Makefile for target ftlall (+ update files to clean after make ftlall)
1972    o pkg/ecco/ecco_cost_final.F :
1973      - fix fc print statements (to stdout and costfunction0000) so
1974        that the printed value is always after the global sum.
1975    o pkg/seaice/seaice_dynsolver.F :
1976      - fix ice strength assymptote at SEAICE_area_max<1
1977        (no change for the standard case of SEAICE_area_max=1)
1978    o some cleaning:
1979      - pkg source files: ensure that all *.F files from each pkg included the
1980        corresponding ${PKG}_OPTIONS.h file (except stand-alone src file which
1981        only includes CPP_EEOPTIONS.h); fix S/R CTRL_SMOOTH ; update AD experiment
1982        code_ad/*.F src files; add new option-file in pkg/admtlm + corresponding
1983        includes;
1984      - model/src: add PACKAGES_CONFIG.h wherever ALLOW_AUTODIFF[_TAMC] is used.
1985      - ALLOW_DIFFKR_CONTROL: add a stop in S/R CTRL_CHECK in case ALLOW_3D_DIFFKR
1986        is undef; also define /DYNVARS_DIFFKR/ common block in DYNVARS.h when
1987        ALLOW_DIFFKR_CONTROL is defined, to allow to compile and reach this stop.
1988      - update option-file CPP_OPTIONS.h of all AD experiments:
1989        * no longer include PACKAGES_CONFIG.h ;
1990        * includes ECCO_CPPOPTIONS.h if PACKAGES_CONFIG.h has been included ;
1991        * def/undef ALLOW_3D_DIFFKR independently of ALLOW_DIFFKR_CONTROL (before
1992          including ECCO_CPPOPTIONS.h).
1993    o pkg/cost, pkg/ctrl, pkg/ecco option-file:
1994      - clean-up and split content of old pkg/ecco/ECCO_CPPOPTIONS.h file into
1995        separated pkg option-file (done according to old doc from ECCO_CPPOPTIONS.h,
1996        not necessary accurate).
1997      - add a template for option-file ECCO_CPPOPTIONS.h, mostly empty, in
1998        pkg/autodiff, i.e., the 1rst pkg to compile for adjoint built, with lines to
1999        deliberately break compilation (a remainder that it needs to be customized)
2000      - in pkg/ecco, includes ECCO_OPTIONS.h instead of COST_OPTIONS.h
2001      - rename COST_CPPOPTIONS.h to COST_OPTIONS.h
2002      - rename CTRL_CPPOPTIONS.h to CTRL_OPTIONS.h
2003    o tools/genamke2:
2004      - check for lapack.
2005    o pkg/cost and pkg/ecco : attempt to sort out some of the limiting intricacies.
2006      - pkg/cost.cost_final.F : allow for use of pkg/ecco and pkg/cost cost functions
2007        jointly. The exclusive ifdefs were removed, to add costs terms (when defined)
2008        from both packages.
2009      - the fc global sum in pkg/ecco/ecco_cost_final.F was removed accordingly.
2010      - for objf_atl we use either the pkg/ecco or the pkg/cost term depending on CPPs.
2011      - pkg/ecco and model/src : add CPP brackets around pkg/cost and pkg/ctrl includes
2012        of "CTRL_SIZE.h" "ctrl.h" "ctrl_dummy.h" "optim.h" / "cost.h" accordingly.
2013    o pkg/cost : add comments to explain special and/or untested setups.
2014    o pkg/exf:
2015      - use EXF_OPTIONS.h to set pkg/exf options except if done in ECCO_CPPOPTIONS.h
2016        (previously, ALLOW_AUTODIFF_TAMC was controling this switch).
2017    o verification/*/code_ad:
2018      mimimal cleaning of AD experiments ECCO_CPPOPTIONS.h option-file:
2019      - reccord when this file is included (define ECCO_CPPOPTIONS_H)
2020      - remove the most obvious obsolete features (e.g., #define ALLOW_COST not
2021        allowed since Oct 2003 in any option-file except in PACKAGES_CONFIG.h)
2022    o pkg/seaice :
2023      - added possibility to change ice strength/PRESS0 relationship to
2024        HEFF, according to the following run time parameters
2025        SEAICEpresPow0 :: HEFF exponent for ice strength below SEAICEpresH0 (integer, >0)
2026        SEAICEpresPow1 :: HEFF exponent for ice strength above SEAICEpresH0 (integer, >0)
2027        SEAICEpresH0   :: HEFF threshold for ice strength            (m)
2028    o pkg/ggl90 :
2029      - added run time flag mxlSurfFlag to include the code that ensure
2030        mixing between first and second level (previously included as a comment)
2031    o verification/1D_ocean_ice_column/input_ad/data.autodiff :
2032      - add test of newly added dumpAdByRec=T option where
2033        we write all records to one file per variable.
2034    o verification/global_ocean.cs32x15/code_ad/CPP_OPTIONS.h :
2035      - switch to #define ALLOW_BALANCE_RELAX and ALLOW_BALANCE_FLUXES
2036        to check that this code is ok with taf and compiles in adjoint.
2037    o pkg/autodiff :
2038      - added run time param dumpAdByRec : ad dump format switch.
2039        If true then write all records to one file per variable.
2040        Else write one file per record (remains the default).
2041      - revise seaice_ad_dump.F and exf_adjoint_snapshots_ad.F accordingly.
2042    o pkg/seaice:
2043     - Added SEAICEuseTILT run time switch : if set to
2044       false then omit the tilt term in seaice dynamics.
2045     - Fix free drift calculation.
2046    o pkg/shelfice:
2047      When initializing SHELFICEDragQuadratic, set default to be
2048      consistent with shiCdrag in case SHELFICEuseGammaFrict is used,
2049      but retain option to set it independently
2050      (inconsistenty spotted by Veronique Dansereau)
2051    o eesupp/inc:
2052      - in EEPARAMS.h, add real-type constant for some frequently used simple number
2053         (0,1,2,1/2), with name explicitly referring to RS/RL type.
2054    o model/src:
2055      - move balancing of relaxation terms to new S/R balance_relax.F.
2056    o pkg/autodiff:
2057      re-write active I/O high-level (control) S/R:
2058      - rename  S/R ACTIVE_READ/WRITE_RL to ACTIVE_READ/WRITE_3D_RL
2059      - add 1 more argument (useCurrentDir) to replace the "_LOC" 2nd set of S/R.
2060      - use standard pkg/mdsio I/O routines (MDS_READ/WRITE_SEC_XZ/YZ  and
2061        MDS_READ/WRITE_FIELD); change loops to multi-threads.
2062      - update and merge active_file_control_slice.flow into active_file_control.flow
2063      - update the calls in lower level S/R (active_file.F, active_file_g.F and
2064        active_file_ad.F) keeping the argument list and function unchanged.
2065      - also update lower-level "_LOC" version (call same S/R with "useCurrentDir
2066        =.TRUE.") and remove high-level (control) _loc version (not called anymore).
2067      - new low-level active I/O routines, one for each type (RL/RS), for active var
2068        of various (XY,XZ,YZ) shape and level number (arguments: arrShape, myNr);
2069        fix ctrl_init_wet.F & ecco_cost_weights.F by calling the new S/R with the
2070        right type.
2071    o autodiff and RS=real*4:
2072      - call the right type (_RS instead of _RL) of S/R in few output S/R (pkg/exf
2073        ad-monitor and snapshots); disable arrType='RS' in mdsio_gl*.F ;
2074      - change argument type of 3-D mask argument to _RS to match type in the call
2075        (in seaice_cost*.F, ctrl_*_gen.F and *ctrl_bound.F); to be continued.
2076    o pkg/thsice:
2077      - re-anable balanceEmPmR when useSEAICE=T with useThSIce=T.
2078      - option to correct ocean fresh-water flux for imbalance of Atmos+Land
2079        fresh-water flux: uniform correction or proportional to local precip.
2080    o pkg/ctrl:
2081      - new header file CTRL_SIZE.h for parameters maxCtrlArr2D, maxCtrlArr3D
2082      - redefine CPP option ALLOW_BOTTOMDRAG_CONTROL to
2083                            ALLOW_BOTTOMDRAG_CONTROL_NONGENERIC
2084      - verification/hs94.1x64x5/ tests ALLOW_GENARR{2D,3D}_CONTROL
2085    
2086    checkpoint63q (2012/07/30)
2087    o pkg/autodiff:
2088      note about monitor and snap-shot of ad-variables:
2089      a) need to apply ADEXCH before monitor or output of ad-vars to include
2090       overlap contributions (was done for adjDump but missing for monitor).
2091      b) since ADEXCH implies adding overlap values to interior array, machine
2092       truncation error is expected when adding an ADEXCH call in the middle of
2093       the time-stepping (although mathematically identical).
2094      modifs:
2095      - fix some incorrect type (RL/RS, UV/scalar) in ADEXCH calls and ad-vars
2096        declaration (adEddyPsiX,adEddyPsiY in adcommon.h).
2097      - add new run-time params (dumpAdVarExch & mon_AdVarExch) to select how  to
2098        apply ADEXCH before monitor or snap-shot of ad-variables:
2099           =0 : no ADEXCH ; =1 : do ADEXCH ; =2 : apply ADEXCH on a local copy.
2100      - implement new method (copy+adexch) for snap-shot and monitor of main model
2101        ad-vars (initially not used by default -> output unchanged).
2102      - change default (set to 2) to use new method and update few output_adm.txt
2103        with accurate ad-monitor (global_ocean.90x40x15, tutorial_global_oce_biogeo
2104        and both tutorial_tracer_adjsens tests).
2105      - switch 2 global_ocean.cs32x15 AD-tests to AB-2 (seaice_dynmix & thsice)
2106        and turn off momDissip_In_AB in the 2 other (needed for stable AB-3).
2107    o pkg/ctrl:
2108      enable the use of a variable number (maxCtrlArr2D, maxCtrlArr3D) of
2109      generic control variables via
2110      #define ALLOW_GENARR2D_CONTROL and/or #define ALLOW_GENARR3D_CONTROL
2111      Only required customization should be S/R ctrl_map_ini_genarr.F
2112      (routine in repository contains example)
2113    o pkg/exf:
2114      - fix and refine checking of surface-relaxation setting when using EXF
2115    o verification (adjoint exp):
2116      - reduce length of simulation by half for experiment global_ocean.cs32x15
2117        (std, seaice & seaice_dynmix) and exp tutorial_dic_adjoffline; update output.
2118    o pkg/mom_common (mom_u/v_bottomdrag), pkg/shelfice (shelfice_u/v_drag)
2119      - replace if statements KE.ne.0 with KE.gt.0 to avoid sqrt of negative numbers
2120        of KE that can occur with aggressive optimization
2121      + put quadratic bottom drag calculation in separated loops (only done if
2122        using bottomDragQuadratic)
2123    o model/src: CG2D_NSA
2124      - clean-up:  stop if cg2dNormaliseRHS=T and AUTODIFF
2125         and replace GLOBAL_SUM calls with GLOBAL_SUM_TILE.
2126      - in test-exp that uses CG2D_NSA (bottom_ctrl & tutorial_tracer_adjsens),
2127         change cg2d residual target to be expressed in Wunits (=> do not normalise
2128         RHS ; this fix global_max Pb with TAF); update output.
2129    o verification/tutorial_tracer_adjsens:
2130       improve parameter consistency (and get rid of warnings):
2131       - use deltaTFreeSurf=deltaTtracer (better with NonLin FreeSurf);
2132       - switch Temp Adv Scheme from 81 to 80 (no limiter since theta < 0 is physical)
2133       - use staggerTimeStep (for stability) in som81; use default rotation period.
2134    o pkg/exch2:
2135      - with empty facet: fix compact-format (W2_mapIO=1) definition (was previously
2136        reset to 0 = 1 long line in X)
2137    o pkg/mdsio:
2138      - fix reading of dimensions from meta file for large-size domain
2139    o model/src:
2140      - fix saltIsActiveTr setting for IdealGas eosType (eosType is 6 character long);
2141      - to refine CS-grid check, add logical flag "hasWetCSCorners": true if using
2142        Cubed-Sphere Exch with CS-corners inside the domain;
2143        make new S/R INI_GLOBAL_DOMAIN from code in ini_linear_phisurf.F to calculate
2144        globalArea and to set hasWetCSCorners.
2145      - add warning if usingCurvilinearGrid and momAdvection in flux-form (missing
2146        metric terms); stop if hasWetCSCorners=T and momAdvection in flux-form.
2147      - re-activate the stop if useCDscheme and hasWetCSCorners=T (previously if
2148        useCDscheme and useCubedSphereExchange).
2149    o pkg/seaice/seaice_growth.F :
2150      - compute the SEAICE_DISABLE_HEATCONSFIX term accordingly
2151        for the (.NOT.useRealFreshWaterFlux).OR.(nonlinFreeSurf.EQ.0)
2152        when the previous code was not correct.
2153      - in all cases diagnoze the boundary condition mismatch to SIaaflux
2154      - in the case of useRealFreshWaterFlux.AND.(nonlinFreeSurf.GT.0) add
2155        that term to QNET (essentially to set the melt/freeze water to 0degC).
2156        when SEAICEheatConsFix is true, so that the ocean+ice budget heat is closed.
2157    o verification/global_ocean.cs32x15/input.seaice :
2158      - add SEAICEheatConsFix in data.seaice, ensuring closed ocean+ice heat budget.
2159      - add diagnostics (commented out) for budget test using my matlab codes (gcmfaces).
2160      - update results (output.seaice.txt) accordingly.
2161    o verification/lab_sea/input/data.seaice :
2162      - remove SEAICEheatConsFix, which is now be tested
2163        in global_ocean.cs32x15. The presently coded fix
2164        is only consistent with real fresh water + nlfs.
2165      - update results (output.txt) accordingly.
2166    o pkg/salt_plume: added diagnotic for salt tendency (oceSPtnd).
2167    o AD_CONFIG.h file:
2168      - in genmake2: remove "#undef ALLOW_ECCO_OPTIMIZATION" from AD_CONFIG.h;
2169      - remove #include "AD_CONFIG.h" from all included OPTIONS files and
2170        add it explicitly in each fortran src file where it is needed.
2171        motivation: header file AD_CONFIG.h is generated/modified after "make depend"
2172        thus introducing potentially wrong dependency; therefore, better to include
2173        it only where it's really needed, and after any other included OPTIONS file
2174        (less tempting to bring conditional includes according to ALLOW_ADJOINT_RUN
2175        or ALLOW_TANGENTLINEAR_RUN).
2176    
2177    checkpoint63p (2012/07/06)
2178    o pkg/autodiff:
2179      - rename S/R INI_AUTODIFF to AUTODIFF_INIT_VARIA ;
2180      - create new header file "AUTODIFF_PARAMS.h" for pkg/autodiff parameters
2181        which are now read from new parameter file "data.autodiff" (inAdExact
2182        previously in "data", use{KPP/GMRedi/SEAICE}inAdMode previously in data.pkg)
2183      - add file "data.autodiff" in all verification/*/input_ad/ directories.
2184      - add run-time parameter to turn On/Off SEAICEuseFREEDRIFT in adjoint/forward
2185        mode (used in global_ocean.cs32x15.seaice_dynmix test exp.)
2186    o verification/tutorial_tracer_adjsens/
2187      - add extra sub-verification which uses "SOM" advection scheme
2188        (2nd Order-Moment Advection Scheme, Prather Limiter) with
2189          #define GAD_ALLOW_TS_SOM_ADV in GAD_OPTIONS.h
2190        and in data:
2191          multiDimAdvection=.TRUE.,
2192          tempAdvScheme=81,
2193          saltAdvScheme=81,
2194    o model/src:
2195      - introduce ALLOW_BALANCE_RELAX which allow the removal
2196       of the global mean of relaxation terms by setting
2197       balanceThetaClimRelax and balanceSaltClimRelax
2198      - disable balanceEmPmR and balanceQnet in the case when useSeaice.
2199       This case is now treated appropriately in seaice_growth.F
2200    o pkg/seaice:
2201      - do balanceEmPmR and balanceQnet based on the net fluxes
2202        (SItflux) that enter the ocean+ice system rather than QNET
2203        and EMPMR. Works best in real fresh water.
2204      - SIatmFW, SIatmQnet, and SItflux computations had to be moved
2205        out of the diagnotics bloc, and stored in global arrays.
2206    
2207    checkpoint63o (2012/06/29)
2208    o vertical mixing schemes:
2209      - remove unused S/R CALC_BUOYANCY (left from branch-atmos merging)
2210      - replace computation of density (in Function STATE1, opps_calc.F) by a call
2211        to S/R FIND_RHO_SCALAR
2212      - pass sigmaR to S/R PP81_CALC, MY82_CALC (but not yet used) and to GGL90_CALC
2213        and use it for N^2 calculation in ggl90_calc.F (save 2 density computations);
2214        affects output (vermix.ggl90) at truncation level.
2215    o testreport:
2216      - change adjustment of SIZE.h for mpi+mth testing: preserve enough tiles
2217        (nSx,nSy) for the number of threads (from eedata.mth)
2218    o model/src:
2219      - remove 2nd set of calls at the top of initialise_varia.F (Adjoint part)
2220        related to Non_Lin Free-Surf or Bottom-Control (but not longer necessary).
2221    o verification/tutorial_tracer_adjsens/
2222      - compile with ALLOW_CG2D_NSA
2223      - run with nonlinFreeSurf=3
2224      - update reference output_adm.txt
2225    o tools/genmake2:
2226      - add "-DHAVE_NETCDF" to the DEFINES list when NetCDF is available ;
2227        refine usePROFILES switching off (only when NetCDF is not available).
2228    o verification (atmospheric set-up):
2229      - change eosType='IDEALGAS' to eosType='IDEALG' to match variable declaration
2230    o pkg/profiles : refine profiles and files handling.
2231    o model/src and pkg/ecco : introduce run-time switch usePROFILES.
2232    o model/src/the_main_loop.F, forward_step.F and pkg/exf/EXF_OPTIONS.h :
2233      - changes to use model/src/the_main_loop.F rather than the ecco version
2234        in ecco type adjoint runs.
2235    o model/src:
2236      - move computation of recip of grid distance & area from INI_MASKS_ETC to INI_GRID
2237      - move setting of h0Fac[C,W,S] from INI_LINEAR_PHISURF to INI_MASKS_ETC
2238      - update_masks_etc.F: rename SMOOTH*_R4,R8 function to the corresponding type (RS,RL)
2239    o model/src:
2240      - fix S/R UPDATE_CG2D for ALLOW_DEPTH_CONTROL case (was empty before);
2241        update output of test experiment bottom_ctrl_5x5.
2242    o pkg/generic_advdiff:
2243      - implement vertical bi-harmonic diffusion (for now, only for T & S and
2244        only explicitly).
2245    o verification/bottom_ctrl_5x5/
2246      update reference output (results changed quite some time ago,
2247      not sure when; but new reference results look ok in terms of grdchk)
2248    o verification/1D_ocean_ice_column/
2249      For verification purposes, the exact adjoint rather than an approx.
2250      should be used (e.g., to comare against F.D. or TLM).
2251      removed autodiff_inadmode*_ad.F routines in code_ad/
2252      Update results/ accordingly.
2253    o pkg/cal:
2254      - change cal_getdate.F so that output date is function of input time only
2255        (less ambiguous, not mixed up with input iteration number).
2256      - fix calendarDumps for non-zero phase-lag (S/R CAL_TIME2DUMP).
2257    o pkg/diagnostics:
2258      - implement calendarDumps also for stats-diags
2259      - implement calendarDumps also for snap-shot output (negative freq)
2260      - for now, ignores calendarDumps if non-zero phase-lag.
2261    
2262    checkpoint63n (2012/06/04)
2263    o model/src:
2264      - recompute rSurfW & S to ensure consistent column thickness (needed for rStar)
2265        between Sum_k(hFac*drF) and rSurf-rLow, for now only when using pkg/shelfice;
2266      - use h0FacC, W & S to compute hFac_surfC, W & S in calc_surf_dr.F (more
2267        similar to calc_r_star.F); update results of experiment internal_wave and
2268        tutorial_global_oce_in_p (affected @ truncation level).
2269    o pkg/shelfice:
2270      - add parameterisation of advective-diffusive flux into the ice shelf
2271        according to Holland and Jenkins (1999), eq.22-33, as suggested by Jan De Ryd
2272      - simply eps3/3a computation
2273    o eesupp:
2274     - add new CPP option (DISCONNECTED_TILES) to disconnect tiles (no exchange
2275       between tiles, just fill-in edges assuming locally periodic subdomain) and
2276       add corresponding exchange subroutines (EXCH0);
2277     - new CG-solver version (_EX0) for disconnected-tiles special case.
2278    o model/src (CG-solvers):
2279     - modify Single-Reduction version (CG2D_SR) in case cg2dMaxIters is reached
2280       (similar final residual output and max-Iter number as with standard version);
2281     - allows to store and use lowest-residual solution (standard & _SR versions);
2282     - cleaning up (remove old, commented out code, LETS_MAKE_JAM ...).
2283     - by default, also compile CG2D_SR version (define ALLOW_SRCG in CPP_OPTIONS.h)
2284    o eesup/src:
2285     - global_vec_sum.F cleaning: add a BARRIER ; update comments ; remove ndef
2286       ALWAYS_USE_MPI (no longer needed after fixing usingMPI settings - March 2012)
2287    o pkg/salt_plume added to lab_sea/input_ad.noseaicedyn
2288    
2289    checkpoint63m (2012/04/27)
2290    o pkg/shelfice:
2291     - account for partical cells in surface level below ice-shelf for hydrostatic
2292       pressure calculion (set uniformFreeSurfLev to F); update isomip experiments.
2293    o ad test experiments:
2294     - update and rename to "ad_optfile.local" local AD-optfile specific to a
2295       particular adjoint verification experiment (in verification/*/code_ad/)
2296    o pkg/seaice & pkg/exf:
2297     - Part two of ECCO-CLIVAR code merges.
2298       Completes merge of seaice area relax. code.
2299       Requires unified CPP option EXF_ALLOW_SEAICE_RELAX
2300       to be set in EXF_OPTIONS.h since this pkg controls its I/O
2301       (and avoids second CPP option in SEAICE_OPTIONS.h)
2302     - change default value of costIceStart & costIceEnd to a valid date.
2303     - add snowPrecip to HSNOW in seaice_growth
2304    o pkg/ptracers:
2305     - move ptracers summary and setup check into separated S/R ; add a check for
2306       valid PTRACERS_Iter0 value (error+stop or just warning).
2307    o pkg/cal (+ pkg/ecco):
2308     - avoid calling a S/R with 2 times the same arg (FWD: unless both are only used
2309       as input; and for AD, unless both are not differentiable (e.g., k index)).
2310    o model/src:
2311     - define internal flag "uniformFreeSurfLev" (=T when free-surface level-index
2312       is everywhere k=1) to speed-up some calculations (by pass kSurf reference);
2313       temporary set to usingZCoords value (to be changed to F when using shelfice).
2314     - hydrostatic pressure: implement partial cell near the surface also for
2315       Z-coordinates (for the case where uniformFreeSurfLev=F); replace test on
2316       usingZCoords with test on uniformFreeSurfLev where needed (in NonHyd code).
2317    o pkg/ctrl/ctrl_init.F:
2318     - add a formal parameter to s/r ctrl_init_rec to print
2319       xx_$(ctrl_valiable)_file for easier debugging
2320     - move call of cal_* routines into the if-block where they are really
2321       needed so that xx_$(ctrl_variable)_period can be 0 or -12 without having
2322       to specify a startdate
2323    o pkg/seaice:
2324     - update comments in SEAICE_OPTIONS.h (+ similar update of lab_sea/code and
2325       global_ocean.cs32x15/code versions).
2326     - turn on seaice Multi-category (in data.seaice, SEAICE_multDim=7) for
2327       verification experiment global_ocean.cs32x15.seaice and update results.
2328    o pkg/exf:
2329     - new S/R EXF_GETFIELD_START to return starting-time of a forcing field
2330       (according to useExfYearlyFields).
2331    o pkg/cal:
2332     - move calendar setting & summary (previously in cal_readparams.F) into new
2333       S/R CAL_INIT_FIXED to be called later in the initialisation process, once
2334       length of the simulation is set (after SET_PARMS call); This is an attempt
2335       to fix Pb when, e.g.: pkg/longstep, modifies the length of the run.
2336     - For safety: keep a record of pkg/cal parameter settings status
2337               to allow to STOP if one pkg/cal S/R is called too early.
2338     - add a stop in all basic pkg/cal subroutines if called before setting is done.
2339     - modify cal_getdate.F: stop when nothing was returned;
2340       if called with myIter=-1, simply retrun modelBaseDate (1,2 = startDate_1,_2);
2341       this allows to remove "cal.h" from seaice_read_parms.F & init_mnc_vars.F.
2342    
2343    checkpoint63l (2012/04/04)
2344    o pkg/bbl:
2345      - fix call to FIND_RHO_2D in bbl_calc_rho.F (case multi-tiles per proc);
2346        update global_with_exf output.yearly.txt file.
2347    o pkg/cal:
2348      - start to clean-up cal_set.F ; fix for the case where baseTime is non-zero.
2349      - remove 2 unsused and very short (1 line only) functions ;
2350      - remove unsused subroutines from AD-Diff list.
2351    o model/src:
2352      - start to implement clean wait to stop in initialization S/R (config_check.F,
2353         packages_check.F, ini_parms.F and pkg/obcs/obcs_check.F + pkg/mypackage)
2354    o folowing PRINT_MESSAGE changes:
2355      - remove reminder multiple print to the same file (STDOUT) when multi-threads.
2356    o pkg/bbl:
2357      - modification so it can work with z*
2358      - replace deltaT with dTtracerLev(k) for asynchronous time stepping
2359      - global_with_exf/input.yearly verification; changes output.yearly.txt
2360    o eesupp/src:
2361      - PRINT_MESSAGE: use OpenMP critical instruction (similar to PRINT_ERROR);
2362        writing to unit 0 (if unit=errorMessageUnit) extended to the case myThid=1
2363      - CHECK_THREADS: specific code if using OpenMP threading: improve checking of
2364        # of threads across processors (e.g., different env OMP_NUM_THREADS setting)
2365      - improve special preliminary call to EESET_PARMS (if eedata is read 2 times).
2366      - when using MPI, always set usingMPI=T ; set default accordingly and stop
2367        if not consistent.
2368      - ALL_PROC_DIE: add a BARRIER after MPI_FINALIZE call ; skip this when thread
2369        argument is zero (in case called within single-thread section).
2370    o pkg/fizhi:
2371        clean-up turbulence cold-start switch: decided in fizhi_init_vars.F, stored
2372        in common bloc (fizhi_coms.h) and then passed as argument up to S/R TURBIO.
2373    o pkg/exch2:
2374      - add argument "updateCorners" to S/R exch2_get_uv_bounds (enable to
2375        activate EXCH_IGNORE_CORNERS in vector EXCH S/R).
2376      - switch 1rst EXCH call to IGNORE_CORNERS (instead of UPDATE_CORNERS)
2377        but keep the 2nd with UPDATE_CORNERS: this prevents overwriting good data
2378        with bad ones coming from a not-yet-updated halo.
2379        This should fix the problem when sNx <> sNy and GCD(sNx,sNy) < 2*Olx.
2380    o pkg/frazil:
2381        move FrzForcT diag from frazil_diagnostics_state.F to frazil_calc_rhs.F
2382        http://mitgcm.org/pipermail/mitgcm-devel/2012-March/005384.html
2383    o model/src/config_check.F: add a check for OLx>sNx/OLy>sNy
2384    o verification/lab_sea
2385      * #undef SEAICE_EXCLUDE_FOR_EXACT_AD_TESTING
2386      * #define ALLOW_SST_CONTROL & ALLOW_SST_CONTROL
2387      * nTimeSteps 3 -> 4
2388      * changed reference output accordingly
2389    o pkg/ctrl:
2390      * fix ctrl_get_gen for xx_sst, xx_sss
2391    o pkg/fizhi:
2392      - fix 2 calls to S/R GRD2MSC (argument igrd) in update_earth_exports.F
2393        update results of exp. fizhi-cs-32x32x40 (fail with only 6 digits for cg2d)
2394      - by default, use new version of S/R GETPWHERE (#define TRY_NEW_GETPWHERE);
2395        fix few out-of-bounds indices in referencing vars (initialise igrd to 1);
2396        clean-up fizhi_turb.F (remove unused & uninitialised qdiaglsm array).
2397    o pkg/gmredi:
2398      - add diagnostic of Redi (main diagnonal) vertical diffusive flux of Temp
2399    o pkg/fizhi:
2400      - fix few initialisation and multi-tile Pb: aqualev & gridalt now pass the
2401        (old)aces open64 tuv test.
2402    o pkg/icefront: fix bug and reorder loop in icefront_init_varia.F
2403    o pkg/mom_vecinv:
2404      - fix 1 loop range in mom_vecinv.F to be like all the other loops which
2405        set/update gu,gv/Diss (fix Pb of uninitialised fVerUkp in admom_vecinv
2406        with non-lin free-surf).
2407    o model/src: move k-loop outside of i/j-loops when (re-)computing R_low
2408      in ini/update_masks_etc.F in order to avoid -O3 optimization problems with
2409      some compilers (gfortran 4.6.0 on MacOS)
2410    o momentum:
2411      - separate fVer?(:,:,kUp) & fVer?(:,:,kDown) in argument list of MOM_FLUXFORM
2412        & MOM_VECINV subroutines (to help TAF). This fixes Pb of uninitialised
2413        fVer?(kUp) in admom_fluxform with non-lin free-surf or bottom control.
2414    
2415    checkpoint63k (2012/03/17)
2416    o model/src:
2417       - selectAddFluid (ALLOW_ADDFLUID): add missing term in horizontal momentum
2418         flux-form (mom_fluxform.F) and vertical momentum (calc_gw.F) equations.
2419       - SOLVE_DIAGONAL: switch default to use adjoinable & vectorized version
2420         (#undef SOLVE_DIAGONAL_LOWMEMORY); update output of exp. front_relax.bvp.
2421    o model/src: solve_*diagonal.F
2422       - replace division with multiplication by inverse (similar to original version)
2423         update output of AD exp. global_ocean.90x40x15.
2424       - fix pkg/gmredi/gmredi_calc_psi_bvp.F & pkg/ggl90/ggl90_calc.F
2425         to enable the use of the vectorized & differentiable solve_tridiagonal.F
2426       - test exp. global_ocean.90x40x15/input_ad: switch to advection scheme 20 for
2427         vertical advection (to get solve_tridiagonal tested in AD mode).
2428    o pkg/seaice: ECCO-CLIVAR merge:
2429      1. seaice AREA relaxation
2430         * CPP option: SEAICE_ALLOW_AREA_RELAXATION
2431         * runtime flag: SEAICE_tauAreaObsRelax
2432      2. modified global mean cost imbalance code: CPP option
2433          ALLOW_SSH_GLOBMEAN_COST_CONTRIBUTION
2434    o another iteration on solve_*diagonal.F
2435       Make choices independent of AUTODIFF
2436       Default will be the adjoinable vectorized version.
2437       Alternative choices are:
2438       * non-adjoinable original version with low memory footprint:
2439         #define SOLVE_DIAGONAL_LOWMEMORY
2440       * still adjoinable but does not vectorize (k as inner-most loop):
2441         #define SOLVE_DIAGONAL_KINNER (keeping SOLVE_DIAGONAL_LOWMEMORY undef)
2442    o testreport
2443     - add option to use a home made wrapper around "make"
2444     - remove MITGCM_IEEE env. variable (no longer active)
2445    o pkg/shelfice
2446     - improve computation of friction velocity for velocity dependent
2447       exchange coefficients: include velocities into SHELFICEBoundaryLayer
2448       block to average velocities vertically
2449     - add TAF store directives for SHI_ALLOW_GAMMAFRICT
2450    o Modify diagonal solvers, now three versions (upon request):
2451      #ifndef SOLVE_DIAGONAL_AUTODIFF
2452        1. default version (dating back a while ago)
2453      #else /* def SOLVE_DIAGONAL_AUTODIFF */
2454      # ifdef SOLVE_DIAGONAL_KINNER
2455        2. adjoinable version with k-innermost loop (G. Forget)
2456      # else
2457        3. adjoinable vectorized version of 2.
2458      # endif
2459      #endif /* SOLVE_DIAGONAL_AUTODIFF */
2460      All flags are currently set within routines, but could/should be moved to CPP-options.
2461      Array bounds for 1. are as before, for 2.,3. cover the entire domain
2462      (could be changed for 1. too).
2463    o verification/lab_sea (fwd):
2464      - update the 4 fwd lab_sea test experiment: no longer SEAICE_GROWTH_LEGACY,
2465        use 7 categories (except hb87), new solve4temp params (except salt_plume),
2466        constant salinity (=4) or variable salinity (salt_plume) done through
2467        SItracer.
2468    o pkg/seaice:
2469      - rename parameters: SIsalFrac to SEAICE_saltFrac & SIsal0 to SEAICE_salt0;
2470      - remove old parameters ( SEAICE_freeze, SEAICEturbFluxFormula, SEAICE_gamma_t,
2471         SEAICE_gamma_t_frz, SEAICE_availHeatTaper & SEAICE_availHeatFracFrz)
2472        from SEAICE_PARMS.h ; still need to fix seaice_cost_sst.F (broken when
2473        SEAICE_freeze got retired) but already better than previously with
2474        SEAICE_freeze=123456.7 deg.C;
2475      - move setting of facOpenGrow/Melt from SEAICE_INIT_FIXED to SEAICE_READPARMS
2476        (safer multi-threaded setting); always set SEAICEuseEVP;
2477      - setting of ocean-ice turb. flux coeff: moved from SEAICE_CHECK to
2478        SEAICE_READPARMS & SEAICE_INIT_FIXED (this fixes wrong summary report);
2479        stop if multiple specifications for the same coeff; make sure default
2480        SEAICE_mcPheePiston is compatible with drF(1) & deltaT.
2481    o pkg/obcs:
2482      - allow to switch to upwind 1rst order advection scheme for the advective
2483        flux computation at the open-boundary; disabled for adjoint built.
2484    o pkg/ptracers:
2485      - rename PTRACERS_RESTART.h -> PTRACERS_START.h
2486      - rename ptracers_fields_blocking_exchanges.F -> ptracers_fields_blocking_exch.F
2487      - add parameter to decide when to start a tracer; use internal flag to
2488        know which tracer to step-forward; switch this internal flag at the top
2489        of forward_step.F (new S/R PTRACERS_SWITCH_ONOFF); for now, not enabled
2490        for adjoint built.
2491    o pkg/seaice:
2492      - add SEAICE_SIZE.h anywhere in the code where SEAICE.h is included ;
2493      - move MULTDIM declaration and setting from SEAICE.h to SEAICE_SIZE.h ;
2494      - keep experiment offline_exf_seaice truly single category (set MULTDIM=1).
2495    o pkg/ecco:
2496      - fix writing of output file DiagnosCost_ClimSalt/Theta
2497        and DiagnosCost_DriftSalt/Theta (if multi-tiles per proc).
2498    o pkg/seaice:
2499      - add missing initialisation of COR_ICE array in dynsolver.F
2500      - merging SEAICE_MULTICATEGORY define and undef cases. Now the same code is
2501        compiled either way, and is tested in all exps (multidim was only tested
2502        in lab_sea ad before).
2503      - cosmetic change to prepare for future addition of ITD. no change to results.
2504        no defaults change.
2505      - added run time param SEAICE_multDim (7 for SEAICE_MULTICATEGORY, 1 otherwise).
2506      - by lack of adequate verification experiments, I further used custom versions
2507        of global_ocean.cs32x15 to test multicat or not, with pickup or not. All
2508        should be correct.
2509      - avoid recomputations in ad.
2510    o array initialisation in adjoint mode:
2511      1) pkg/mom_common/mom_calc_ke.F:
2512        add full array initialisation of KE inside mom_calc_ke.F (ALLOW_AUTODIFF_TAMC):
2513        The S/R which calls MOM_CALC_KE initialises KE but in some recomputation
2514        part this initialisation is gone, resulting in Floating Point Exception
2515        (caught by open64 compiler with debug option).
2516      2) model/src/convective_weights.F
2517        set output convectCount over the full array range (instead of doing
2518        an update): this fix a similar issue when called within recomputation (adjoint)
2519        which could by-pass the initialisation (normally done in the caller S/R).
2520    o pkg/seaice:
2521      - final version of turbulent flux params, as agreed at MIT ice meet:
2522           SEAICE_mcPheePiston (default is ~ 0.000875)
2523           SEAICE_mcPheeTaper (default is 0.)
2524           SEAICE_frazilFrac (defualt is 1.)
2525           SEAICE_mcPheeStepFunc (default is false)
2526      - changes results at trunction error level
2527      - ifdef SEAICE_EXTERNAL_FLUXES, disallow SEAICE_waterAlbedo
2528    o added pkg/frazil:
2529      - see frazil_description.tex for details
2530      - verification experiment is global_with_exf/input.yearly; changes output.yearly.txt
2531    o pkg/shelfice/shelfice_thermodynamics.F
2532      - fix exponents for velocity dependent exchange coefficients: change
2533        from 2/3(=0) to 0.66666666666666667
2534      - move computation of velocity dependent exchange coefficients into
2535        separate loop, so that it applies to both thermodynamics
2536      - move some divisions by constants out of loops
2537    
2538    checkpoint63j (2012/02/16)
2539    o pkg/seaice:
2540      - overhaul of seaice_summary.F after feb 2012 clean-up of seaice_growth.F etc.
2541      - SItracer:  added run time params, and allow coupling to ocn salinity.
2542    o pkg/seaice: remove (almost) all divisions by constants within loops
2543      in seaice_growth.F and seaice_solve4temp.F, this changes (only) the cg2d
2544      results of global_ocean.cs32x15.seaice from 16 to 11 digits (but only
2545      those, caused by 1/QI -> recip_QI) -> update output.seaice.txt,
2546      output_adm.seaice_dynmix.txt and also lab_sea: output_adm.evp.txt
2547    o pkg/seaice :
2548      - simplify McPhee tapering, and allow to use it with SEAICEturbFluxFormula
2549        = 1 or 2, using newly added run time parameter SEAICE_availHeatTaper.
2550      - fix d_AREAbyATM, d_AREAbyOCN, d_AREAbyICE diags I broke in r1.148.
2551      - add permanent SItflux diag that corresponds to TFLUX but includes
2552        ice+snow. Hence SItflux-TFLUX should match the ice+snow heat budget.
2553      - allow activation/testing of a fix for suspected missing term in
2554        ocn-ice heat budget (to be confirmed). To test this, you want to
2555        undef SEAICE_DISABLE_HEATCONSFIX, and then set the run time param
2556        SEAICEheatConsFix to .TRUE. that also allows the 'SIaaflux' diagnostic.
2557      - no change in results, fwd or ad.
2558    o global_ocean.cs32x15/results: 3 changes following from the pkg/seaice commit below:
2559      - switch to variable freezing point.
2560           Results change : cg2d -> 1 digits; ad -> 3-6-6 digits.
2561      - bug fix : the sublimation term that was missing is now activated.
2562           Results change : cg2d -> 2 digits; ad -> 8-6-6 digits.
2563      - bug fix : flooding sign term for SIsal0.NE.0.
2564           Result change : cg2d -> 8 digits; ad -> 11-12-9 digits.
2565    o pkg/seaice:
2566      - unified freezing point treatment : the old SEAICE_VARIABLE_FREEZING_POINT
2567        is now the default, and the old default constant freezing point is recovered
2568        with SEAICE_tempFrz0    = -1.96,
2569             SEAICE_dTempFrz_dS = 0.,
2570      - retire SEAICE_freeze (= the old way of specifycing the constant freezing point)
2571      - remove ALLOW_SEAICE_FLOODING brackets; run time switch is already there.
2572      - bug fix (thanks to M. Losch) : the sublimation term that was missing is now
2573        activated. To reproduce old results with this bug define SEAICE_DISABLE_SUBLIM.
2574      - bug fix (silly me) : flooding sign term (seaice_growth.F r 1.149line 1211)
2575        was wrong for SIsal0.NE.0. Changes cs32x15 results (see above item for detail).
2576      - bug fix (thanks to O. Jahn) : area loss for melting  got messed up in
2577        seaice_growth r149 for legacy branch (no results change).
2578      - introduce SEAICE_CAP_SUBLIM : caps sublimation heat flux in solve4temp (code
2579        from I. Fenty).
2580      - results did not change except for global_ocean.cs32x15, mostly due to the
2581        switch to variable freezing point (see above item for detail).
2582    o pkg/thsice:
2583      - fix and simplify interface to salt_plume pkg ; diagnose directly amount of
2584        seawater freezing in thsice_calc_thickn (not used).
2585    o pkg/seaice: turbulent flux term specification via run time params.
2586      - replace CPP switches with run time switches to facilitate testing
2587      - retired CPPs : MCPHEE_OCEAN_ICE_HEAT_FLUX,
2588                       GRADIENT_MIXED_LAYER_TURBULENCE_FACTOR
2589      - added runtime parameter : SEAICEturbFluxFormula
2590      - move Mcphee constants to SEAICE_PARAMS.h
2591      - seaice_readparms.F : read turbulent flux term params (SEAICEturbFluxFormula;
2592                 SEAICE_availHeatFrac/Frz, or SEAICE_gamma_t/_frz if apply);
2593                 remove seaice_summary call (moved to seaice_init_fixed)
2594      - seaice_init_fixed.F : set SEAICE_availHeatFrac/Frz depending on
2595        SEAICEturbFluxFormula, and seaice_summary call (moved from seaice_readparms)
2596      - seaice_summary.F : add missing report of read turbulent flux term set up
2597                           and SITRACER.
2598      - seaice_check.F : check range; inform and stop if retired CPPs are used
2599                         (incl. SEAICE_AGE).
2600      - seaice_growth.F : unified use of SEAICE_availHeatFrac/Frz, without
2601             CPP switch, same computation as before for the different options.
2602      - change results at the truncation level.
2603    o pkg/seaice:
2604      - remove un-used parameters LAD & MAX_TICE ; add new run-time parameters:
2605        useMaykutSatVapPoly (default=F), postSolvTempIter (default=2) and
2606        SEAICE_wetAlbTemp (default=-1e-3). Remove option SEAICE_SOLVE4TEMP_LEGACY.
2607      - update verification/*/input*/data.seaice:
2608        to reproduce previous results with former #defined SEAICE_SOLVE4TEMP_LEGACY
2609        code, set useMaykutSatVapPoly=T & postSolvTempIter=0 ;
2610        and to reproduce previous results with former non-SOLVE4TEMP_LEGACY code,
2611        set SEAICE_wetAlbTemp=0 & SEAICE_snowThick=0.
2612    o pkg/seaice/seaice_solve4temp.F (SOLVE4TEMP_LEGACY):
2613      - remove LEGACY code for solving for tsurf (A1,A2,A3) but maintain the same
2614        algorithm (same choice: useMaykutPolySatVap=T, postSolvTempIter=0);
2615        difference in results only due to machine truncation.
2616      - remove MAX_TICE (tsurf is always =< TMELT anyway); keep MIN_TICE if using
2617        MaykutPolySatVap; keep MIN_LWDOWN.
2618      - adapt SEAICE_MODIFY_GROWTH_ADJ code (untested) to non-legacy formulation.
2619      - update output of verification exp. lab_sea (4 fwd: 11 cg2d digits except hb87,
2620        + 3 AD: 6 digits except evp) and offline_exf_seaice.seaice (12 digits).
2621    o pkg/salt_plume:
2622      - isolate saltPlumeFlux array exch into a specific S/R called from
2623        do_oceanic_phys.F
2624      - add interface to pkg/salt_plume (filling of saltPlumeFlux) in pkg/thsice.
2625    o verification:
2626      - move untested set-up to MITgcm_contrib/verification_other.
2627    o pkg/seaice:
2628      - retire old way of SEAICE_AGE. Now replaced with ALLOW_SITRACER.
2629    o pkg/seaice:
2630      - seaice_solve4temp.F (keeping results unchanged):
2631        * add 2 future run-time params to select which saturation vapor pressure
2632          formula is used and how post-iteration fluxes are set.
2633          Temporary set these 2 params according to option SOLVE4TEMP_LEGACY;
2634        * New piece of code (not used) to update surf. atmos. heat flux F_ia using
2635          the linearized expression to stay consistent with tsurf finding.
2636      - seaice_freedrift.F avoid floating exception in sqrt(y) since y=sqrt(x*x)-x
2637        can be < 0.
2638    o pkg/seaice/seaice_solve4temp.F (SOLVE4TEMP_LEGACY undef):
2639      - remove from F_ia (and from it's derivative dFiDTs1) the contribution of
2640        conductive heat flux F_c , and add it explicitly when updating tsurf as
2641        solution of: Fc = Fia + d/dT(Fia - Fc) *delta.tsurf
2642        so that now F_ia has a consistent meaning through the entire routine.
2643        This causes differences at truncation level: update output of fwd exp.
2644        global_ocean.cs32x15.seaice.
2645    o pkg/seaice:
2646      - lots of editing/cleaning in seaice_solve4temp.F + better documentation
2647        of arrays, sign/direction of fluxes; no effect on results.
2648      - replace hard coded 273.16 (=previous value of celsius2K) by celsius2K
2649        in seaice_budget_ocean.F & seaice_solve4temp.F (SOLVE4TEMP_LEGACY part);
2650        note: this should have been done before changing celsius2K default.
2651      - to keep results unchanged, add back old value of celsius2K in verification
2652        exp. input*/data : lab_sea (AD), offline_exf_seaice (fwd+AD) & seaice_obcs
2653      - replace hard coded seawater freezing temp in seaice_solve4temp.F (part
2654        SOLVE4TEMP_LEGACY) of 271.20 (=previous value of celsius2K + default
2655        value of SEAICE_freeze) by celsius2K+SEAICE_freeze so that seawater
2656        freezing temp is consistent with value in seaice_growth.F ; this causes
2657        differences at machine truncation level: update lab_sea AD output (3/4).
2658    o pkg/seaice:
2659      - mask (in exf_init_fixed.F) atemp,aqh,evap,precip,runoff,lwflx,areamask
2660        and climsst/sss even when using seaice (to prevent calculation that might
2661        use SST on land); does not affect any verification exp.
2662      - apply mask to taux,tauy (in seaice_get_dynforcing.F); update output
2663        of lab_sea.fd & lab_sea.hb87 and global_ocean.cs32x15.seaice_dynmix.
2664    o pkg/seaice/seaice_growth.F: add mask to avoid non-zero ice thickness
2665      over land (non-legacy code)
2666    o vectorize salt_plume package:
2667      - add extra code to salt_plume_frac and salt_plume_tendency_apply_s
2668      - this code computes plumebk everywhere (also over land), thus requires
2669        code to avoid divisions by zero and catch the case of kLev=Nr.
2670      - efficiency of salt_plume_frac is still sub-optimal
2671    o tools (genmake2):
2672      - fix makefile NAME specification (option: -makefile NAME) by adding
2673        "-f $MAKEFILE" in few places where it was missing including makedepend
2674        command (contribution from Paul).
2675    
2676    checkpoint63i (2012/01/24)
2677    o model/src:
2678      - add factorized versions of some EOS code to find_rho.F,
2679        define USE_FACTORIZED_EOS to turn it on (default for TARGET_NEC_SX)
2680    o model/src:
2681      - add celsius2K to namelist PARM01; remove unused recip_rhoNil from PARAMS.h;
2682      - change default celsius2K from 273.16 to 273.15
2683      - to keep results unchanged, add back old value of celsius2K in verification
2684        exp. input*/data : aim.5l_cs, 1D_ocean_ice_column, lab_sea (fwd),
2685         global_ocean.cs32x15(seaice) & cpl_aim+ocn(input_atm).
2686    o model/src: add a little initialisation trick to find_rho.F and find_alpha.F
2687      to make TAF generate vectorizable code
2688    o pkg/seaice/seaice_evp.F: add code (copied from CICE) that avoids underflows.
2689       Turn on by defining SEAICE_EVP_ELIMINATE_UNDERFLOWS. Most compilers
2690       have flags that do this more efficiently.
2691    o pkg/diagnostics/diagstats_calc.F
2692      - for TARGET_NEC_SX fix the treatment of the scaling factor tmpFac=scaleFact
2693    o pkg/obcs (with exch2):
2694      - derive OB indices in overlap region from OB-InsideMask (in obcs_init_fixed.F)
2695        and remove code (in obcs_readparms.F) which was based on EXCH of indices
2696        (through buffer) and did not account for exch2 (e.g., CS-grid) topology.
2697    o pkg/exf and seaice exp:
2698      - change offline_exf_seaice.seaicetd test exp. to use default DIFF1 value (=0)
2699        so that switching off area & heff advection flags does not affect results.
2700      - change default EXF_LWDOWN_WITH_EMISSIVITY to #define in EXF_OPTIONS.h
2701      - keep exp. seaice_obcs & 1D_ocean_ice_column(ad) unchanged (using #undef
2702        EXF_LWDOWN_WITH_EMISSIVITY) and, using pkg/exf default emissivities, update
2703        results of verification experiments: 1D_ocean_ice_column(fwd),
2704        global_ocean.cs32x15.seaice(fwd+ad) & seaice_dynmix(ad), lab_sea (all 8)
2705        and offline_exf_seaice (all 4).
2706    o pkg/seaice:
2707      - remove array YNEG, RIVER, TMIX (replaced by local var) from common block;
2708        remove also areaNm1 & hEffNm1 when SEAICE_GROWTH_LEGACY is undef.
2709      - fix bug: areaNm1 & hEffNm1 are needed in seaice_growth (SEAICE_GROWTH_LEGACY)
2710        but were not filled when resp. SEAICEadvArea=F & SEAICEadvHeff=F and
2711        not multi-dim advection;
2712      - fix seaice_growth.F to compile with both SEAICE_GROWTH_LEGACY and
2713        SHORTWAVE_HEATING #undef.
2714    o optim: make Makefile more robust (?)
2715    o pkg/obcs:
2716      * fix treatment of obcs_read_pickup for TAF
2717    o pkg/shelfice:
2718      * add missing initialisation of num_shifwflx
2719      * new adjoint verification exp. for isomip
2720      * change Prandtl and Schmidt numbers from generic formulations
2721        (in terms of model diffus. and visc.) to separate runtime
2722        parameters, with Holland and Jenkins (1999) default values.
2723    o pkg/exf (interpolation):
2724      - extended input field (2 rows) near the N & S poles:
2725        * fill in with the symetric value (when even Nb of data in longitude)
2726        * add average value at the poles only for scalar quantities ; for vector
2727          component interpolation, skip the averaging and keep duplicated values,
2728          unless the 2 components have same location (uvInterp=T) in which case
2729          interpolate the 2 components together using S/R EXF_INTERP_UV.
2730      - new S/R EXF_INTERP_UV to interpolate the 2 components of a vector field
2731        together: this allows to account properly for local orientation when
2732        averaging at N & S pole.
2733      - add CPP option EXF_USE_OLD_INTERP_POLE to recover old results regarding
2734        exf-interpolation near N & S poles. Undef by default.
2735      - add debug check/print on 1rst iter if debugLevel >=2.
2736    o pkg/exf:
2737      - change masking flags definition (no longer "parameter"), put them in
2738        common block and set them in S/R EXF_INIT_FIXED.
2739      - change recognized masking flag from s,u,v to c,w,s since the mask
2740        to use (maskC,W,S) depends on position on model grid and has little to
2741        do with scalar/vector difference; fix masking if using P-coordinates.
2742      - fix masking of wind-stress (was wrong if interpolated or read on A-grid)
2743        and update results of exp. global_with_exf (x2).
2744      - fix setting of zenith-angle table when SHORTWAVE_HEATING is undef.
2745    o pkg/obcs
2746      - S/R obcs_calc_stevens: fix a small bug (gammat -> gammas where appropriate)
2747    o pkg/exf (interpolation):
2748      - assume periodicity in X only if input field cover full longitude range.
2749      - improve search for lat. index (supposed to be faster, in ~log2(ny) steps,
2750        and should vectorise).
2751      - fix input lat of the 2 added row (in case we provide N.pole data).
2752    
2753    checkpoint63h (2011/12/30)
2754    o pkg/seaice:
2755      - change declaration of UVM from _RL to _RS in order to get B-grid
2756        uIce,vIce monitor when _RS = real*4
2757    o pkg/offline:
2758      - new S/R OFFLINE_RESET_PARMS for resetting main-model params (switch off flags);
2759      - compute vertical velocity if not read from file (switch on exactConserv
2760        & staggerTimeStep);
2761      - fix output of ptracer monitor iter & time for default PTRACERS_monitorFreq.
2762    o verification:
2763      - update grid-files (in tutorial_held_suarez_cs/input and fizhi-cs-32x32x40/input)
2764        with grid-angle generated using "utils/matlab/cs_grid/cubeCalcAngle.m":
2765        fix Pb in yG definition @ 2 missing corners (previously yG was averaged);
2766      - update output of exp. global_ocean.cs32x15.viscA4 after changing
2767        grid-file angles (used here for coriolis-3d);
2768      - remove (or gzip) few files not needed to run fizhi-cs experiments.
2769    o pkg/exf (vector interpolation):
2770      - rotate vector component toward local grid-axis orientation using grid-angles
2771        (stored in GRID.h) instead of locally computed rotation angle; keep old code
2772        available with exf option EXF_USE_OLD_VEC_ROTATION (undef by default).
2773    o pkg/seaice:
2774      - allow to compile with exf options ALLOW_ATM_TEMP or ALLOW_DOWNWARD_RADIATION
2775        undefined. Fix and remove the stop when ALLOW_RUNOFF is undefined.
2776    o pkg/PKG_OPTIONS.h files:
2777      - move #include "CPP_OPTIONS.h" just after #include "PACKAGES_CONFIG.h",
2778        outside of the #ifdef ALLOW_THISPKG / #endif block.
2779      - update verification/*/code/PKG_OPTIONS.h files.
2780    o add a verification experiment (offline_exf_seaice/input.seaice) that test
2781      the B-grid LSOR solver
2782    o pkg/seaice: sort out emissivity and long wave radiation step 2:
2783      - add emissivity for snow and ice as new run-time parameters
2784        (unfortunately) that default to the corresponding exf values; this
2785        changes results in most verification experiments so that for backward
2786        compatibility these parameter have to be set explicitly to inconsistent
2787        values (ugly);
2788      - the exf-flag EXF_LWDOWN_WITH_EMISSIVITY then gets rid off the hard-wired
2789        emissivities of 0.97 associated with lwdownloc in S/R seaice_solve4temp
2790        until we agree how to handle this bug properly
2791    o pkg/exf (interpolation):
2792      - add a set of run-time param ({inputfield}_interpMethod), one for
2793        each interpolated input field, to select the interpolation method
2794        with a value of zero switching off the interpolation;
2795      - print interpolation parameters to standard output;
2796      - refine exf_check.F accordingly ; stop if USE_NO_INTERP_RUNOFF is defined
2797        (to use instead runoff_interpMethod=0 in data.exf).
2798      - simplify default setting of interpolation parameters (for all fields,
2799        set position to match model grid cell-center position, leading to trivial
2800        interpolation in case of regular Lat-Lon grid) and fix for the case of
2801        non-uniform delY.
2802    o pkg/exf/exf_radiation.F: add the factor ocean_emissivity to lwdown, for
2803       within #ifdef EXF_LWDOWN_WITH_EMISSIVITY/#endif. Unless ocean_emissivity=1.
2804       this factor is absolutely required, because the lw exitance (= out-going
2805       long wave radiation) is emissivity*stefanBoltzmann*T^4 + rho*lwdown,
2806       where the reflectivity rho = 1-emissivity for conservation reasons. Once
2807       this is established, we can remove the CPP-Flag (if we want to).
2808    o pkg/seaice:
2809      - qualify a stop statement in S/R seaice_check: EXF_READ_EVAP and
2810        ALLOW_BULKFORMULAE are only required if SEAICE_EXTERNAL_FLUXES is defined
2811      - sort out emissivity and long wave radiation, step 1: make SEAICE_emissivity
2812        what the name implies (and not emissivity*BoltzmannConstant), this means
2813        the old default value of 5.5e-8 now means
2814        5.5e-8/5.670e-8 = 0.97001763668430343479 as ocean_emissivity in
2815        S/R exf_readparms
2816      - FV-discretization of the B-grid LSOR solver, turn on with
2817        SEAICE_LSRBNEW. This new solver also involves a slight re-organization
2818        of the calling routine dynsolver, so that B and C-grid code look a
2819        little more alike.
2820      - fix index bugs in ostres.F (B-grid code)
2821    o pkg/seaice/seaice_ocean_budget.F: change (unused) code to make it look better
2822    o pkg/seaice/seaice_readparms.F: make ocean_emissivity*stefanBoltzmann the
2823      default for SEAICE_emissivity, if useEXF; requires setting a wrong
2824      parameter value in global_ocean.cs32x15/input.seaice/data.seaice for
2825      backward compatiblity
2826    o model/src: use sigmaR in calc_ivdc
2827    
2828    checkpoint63g (2011/12/16)
2829    o pkg/seaice/seaice_growth.F:
2830      fix heat conservation of the coupled ocean-seaice system.
2831      when SEAICE_HEAT_CONSERV_FIX is defined, the mismatch of
2832      solid vs liquid water treatment is resolved via QNET.
2833    o pkg/seaice/seaice_growth.F:
2834      add missing term for sublimation in saltFlux, which was breaking conservation.
2835    o pkg/seaice/seaice_model.F:
2836      Remove this patholigical case treatment in evolution branch,
2837      where it is un-necessary and breaks conservation.
2838      Update global_ocean.cs32x15/results accordingly for
2839      output.seaice.txt output_adm.seaice.txt and output_adm.seaice_dynmix.txt
2840    o model/src:
2841      useRealFreshWaterFlux: remove masking of EmPmP (using maskInC) in
2842      external_forcing_surf.F and apply mask directly in S/R SOLVE_FOR_PRESSURE.
2843    o pkg/obcs:
2844      modify Stevens boundary conditions so that S/R obcs_calc_stevens computes
2845      tendency for temperature and salinity that is then applied to update
2846      theta and salt in S/R obcs_apply_ts; this requires proper masking of all
2847      horizontal advection and diffusion contributions on the boundary (in
2848      S/Rs gad_advection, gad_calc_rhs, gmredi_rtransport, gmredi_calc_diff), and
2849      removing the mask in S/R timestep_tracer. The advantage of this approach is
2850      that the updated tracer values include contributions from the surface
2851      forcing and vertical diffusion.
2852      This modification changes exp4.stevens because of vertical diffusion.
2853    o model/src:
2854      change non-curvilinear grid setting to also work with exch2 + blank tiles:
2855      - move delX,delY to new header file (SET_GRID.h) and adjust length to 1rst
2856        face dimensions.
2857      - new S/R INI_LOCAL_GRID to define model tile-local grid (using same units
2858        as delX,delY) and called from S/R INI_CARTESIAN_GRID, INI_CYLINDER_GRID
2859        and INI_SPHERICAL_POLAR_GRID.
2860      change test-experiment global_ocean.90x40x15:
2861      - split the domain in many more tiles (9x4 tiles of 10x10 each);
2862      - switch to exch2 and remove 1 blank-tile (but only for MPI test).
2863      - update results of both test (std & dwnslp).
2864    o pkg/diagnostics/diagstat_calc.F: fix problem with non-initialised halos in
2865       tmp-fields for TARGET_NEC_SX at the cost of extra loops and less vectorisation
2866    o model/src:
2867      - take sigma-coords related code out of update_etah.F into new S/R UPDATE_ETAWS
2868        and fix initialisation when using sigma-coords.
2869    o model/src:
2870     - improve Gael's changes from Jan 14, 2011 "addition of an 'update' of hfacc etc.
2871       to their current value at the beginning of forward_step.F": add a new run-time
2872       switch "doResetHFactors" (default=false) and use it to do (or not) the resetting.
2873     - set doResetHFactors=T in the following test exp:
2874        global_ocean.90x40x15/input (rStar) & input.dwnslp (linFS),
2875        global_ocean.cs32x15/input.seaice (rStar), hs94.cs-32x32x5/input.impIGW (linFS)
2876        and tutorial_global_oce_in_p (nonLinFS in p)
2877    o pkg/ecco
2878      - added IES cost term
2879    o verification/advect_xz
2880      - scale down the depth by 1/100 (from 200 km to just 2.km)
2881      - add secondary test using divergent flow, r-star and implicit vertical advection.
2882      - add note (check_conserve_TS.txt) and matlab script to check global
2883        conservation of T & S with NonLin-FreeSurf and Adams-Bashforth.
2884    o pkg/rbcs:
2885      - add missing relaxUFile & relaxVFile in namelist (in rbcs_readparms.F).
2886    o pkg/obcs (Stevens BCs):
2887      - fix various problems in the phase speed computations of the Stevens
2888        boundary conditions:
2889        - sign error for western and southern boundaries,
2890        - time tendencies were underestimated by factor of dTracerLev and some just
2891          zero (for multidim advection schemes) -> now estimate time tendencies
2892          from difference between previous (n) time level and the one before (n-1);
2893          this requires storing a field per tracer per boundary, also in the pickup
2894          files.
2895        - replace deltaTmom in cflMer/Zon computation with dTracerLev
2896        - set default phase velocity to cflMer/Zon
2897      - update verification experiment exp4.stevens
2898    o pkg/generic_advdiff (implicit_r):
2899      - fix implicit vertical advection conservation with AB and/or NonLin-FreeSurf
2900        (remove Tr*d/dz(w) in gad_implicit_r.F and add it in gad_calc_rhs.F);
2901      - fix implicit vertical diffusion or advection with NonLin FreeSurf
2902        (was using current recip_hFacC instead of future recip_hFacC): set future
2903        recip_hFac in thermodynamics.F and pass & use it in all vertical implicit
2904        solver S/R ;
2905      - fill diagnostics of vertical advective fluxes (computed from tendency)
2906        when using implicit vert. advection;
2907      - update output of exp that uses NonLin-FreeSurf & implicit vertical diffusion:
2908         global_ocean.90x40x15 (fwd+AD), global_ocean.cs32x15 (4 fwd +4 AD),
2909         tutorial_global_oce_in_p (fwd), tutorial_tracer_adjsens (AD)
2910         and cpl_aim+ocn (used in ocean); to be fixed: bottom_ctrl_5x5.
2911    o pkg/diagnostics:
2912      - add diags for T & S tendency which goes through Adams-Bashforth.
2913    
2914    checkpoint63f (2011/11/30)
2915    o pkg/obcs/obcs_calc_stevens.F:
2916      - join some loops to reduce number of if-statements
2917      - fix a bug in code for northern and southern boundaries.
2918    o pkg/seaice/seaice_init_varia.F
2919      - undo resetting UVM=0 that has slipped in unnoticed in r1.49 and
2920        caused zero ice-velocities for the B-grid code
2921    o pkg/seaice/seaice_init_fixed.F
2922      - fix a bug in the initialisation of the second metric terms
2923        k2AtC and k2AtZ: k2AtC was set to the value of k2AtZ and k2AtZ was 0.
2924      - this affects all seaice configurations with useCurviLinearGrid = .true.
2925        and SEAICEuseDynamics = .true. (default) and SEAICEuseMetricTerms
2926        = .true. (default)
2927      - the only verification experiment affected is global_ocean.cs32x15:
2928        icedyn, seaice, and seaice_dynmix (AD)
2929    o pkg/thsice/thsice_diagnostics_state.F
2930      - only for TARGET_NEC_SX: initialise all of tmpFld, so that overlap does
2931        not contain garbage that can lead to surprises in diagstats_calc.F
2932    o model/src:
2933      - move bi,bj loops inside INTEGR_CONTINUITY ;
2934      - call INTEGR_CONTINUITY directly from forward_step.F
2935        (previously called from momentum_correction_step.F)
2936      - call UPDATE_ETAH from integr_continuity.F and update initialise_varia.F,
2937        forward_step.F and pkg/ecco/the_main_loop.F
2938    o model/src/do_oceanic_phys.F:
2939      - reset addMass to zero only if useICEFRONT ;
2940      - separated k-loop for rhoInSitu calculation ;
2941      - add 2 diagnostics for wVel*delta^k(Rho) at constant pressure (= WdRHO_P)
2942        and at constant T,S (= WdRHOdP);
2943      NOTE: change diagnostics WRHOMASS : this is now simply the Vertical transport
2944        of In-Situ Density (Anomaly) (=wVel*rho^bar-k) (previously was Vertical
2945        transport of locally-referenced potential density);
2946        to recover old diag: (WRHOMASS)_old = (WRHOMASS)_new -1/2 * (WdRHOdP)
2947    o gluemnc:
2948      - replace ncrcat with ncks when adding variables to *.glob.nc
2949      - change the way variables without record dimensions are handled so that
2950        files that have variables with and without record variables can be glued:
2951        add a record dimension with a new unique name to be able to differentiate
2952        between variable with and without a-prior record dimensions. Remove
2953        this record dimension before adding the variable to the *.glob.nc file.
2954        This procedure automatically works also for grid.*.nc files that do not
2955        have any record dimension.
2956    o verification/cpl_aim+ocn:
2957      - generate new reference output on baudelaire (gfortran, mpich2) (previously
2958        from old aces-grid cluster, ao + ifort) and update 'run_cpl_test' script.
2959    o pkg/obcs/obcs_calc_stevens.F:
2960      - add code for northern and southern boundaries.
2961      - reorder some loops to save some operations and so that drFBar can be scalar
2962    o model/src:
2963      - re-arrange extrapolation calculation in Adams-Bashforth S/R (affects machine
2964        truncation) and add diagnostics for Adams-Bashforth tendency increment.
2965      - update test-exp. AD output:
2966        1D_ocean_ice_column, bottom_ctrl_5x5, lab_sea.noseaicedyn, obcs_ctrl;
2967      and FWD output: exp4 (x3), fizhi-cs-32x32x40, fizhi-cs-aqualev20,
2968        front_relax (x3), global_ocean.90x40x15 (x2), global_ocean.cs32x15 (x5),
2969        global_ocean_ebm, ideal_2D_oce, internal_wave, isomip (x3), lab_sea (x4),
2970        matrix_example, MLAdjust (x5), natl_box (x2), tutorial_advection_in_gyre,
2971        tutorial_global_oce_in_p, tutorial_global_oce_latlon and
2972        tutorial_plume_on_slope.
2973    o pkg/diagnostics/diagstats_calc.F: add special code for TARGET_NEC_SX
2974      that vectorises. This code uses 3 extra 2D fields, F90 array assignments
2975      and F90 intrinsic routines SUM, MINVAL, MAXVAL, but since TARGET_NEC_SX
2976      does not even come with an F77 compiler anymore, this should not be
2977      a limitation
2978    
2979    checkpoint63e (2011/11/06)
2980    o pkg/seaice adjoint of LSR:
2981      - substantially rework STORE dirs.
2982      - add new flag SEAICE_LSR_ADJOINT_ITER and parameter SOLV_MAX_FIXED
2983        this flag will do SOLV_MAX_ITERS but only store SOLV_MAX_FIXED fields
2984        and only perform SOLV_MAX_FIXED adjoint iters.
2985        If flag SEAICE_LSR_ADJOINT_ITER is undef-ined, the store in the iteration
2986        always goes to same record, meaning that the last forward field will be
2987        the one used in the adjoint - an approximation.
2988      - now produces non-zero LSR-related gradients, and acceptable gradients for
2989        An's zonal (x-z) test case (to be checked in)
2990      - lab_sea: produces acceptable gradients for lab_sea with forward/backward LSR
2991        (but these are screwed up by the thermodynamics in the first place);
2992        reduce from 4 to 3 timesteps to avoid t.d. issue as temporary solution;
2993        output_adm.txt also reflects changes to seaice_lsr
2994      - global_ocean.cs32x15:
2995        * the "default" input_ad.seaice has been re-defined to always exclude dynamics
2996          (output_adm.seaice.txt was updated)
2997        * new input_ad.seaice_dynmix tests a forward LSR / backward free-drift
2998          (output_adm.seaice_dynmix.txt)
2999    o test-exp. exp4+stevens:
3000      - switch off pTracers and nonHydrostatic (restart problems with NH); update output
3001    o pkg/seaice (lsr solver):
3002      - put coriolis term into FORCEX,Y (as in seaice_evp.F; previously in rhsU,V only);
3003        update output (change truncation) of FWD test exp lab_sea & global_ocean.cs32x15
3004      - fix SEAICEuseFREEDRIFT for new OBCS version (ndef OBCS_UVICE_OLD)
3005      - new parameter "LSR_mixIniGuess" allows (if=2,4) to mix free-drift solution
3006        into initial guess for linearised solver; use weight ~ (1/err)^2,4.
3007      - compute (with new S/R) and print initial (+ free-driff sol. if available)
3008        and final residual of linearised system.
3009    o pkg/pp81: add diagnostics for vertical eddy viscosity and diffusivity
3010      (requires new subroutines pp81_init_fixed.F/pp81_diagnostics_init.F)
3011    o pkg/obcs: Stevens BCs (still only for east and west)
3012      - fix Stevens BCs by using intermediate velocities of previous
3013        time step as "baroclinic" contribution rather velocity of one grid cell
3014        inside the boundaries; more consistent but makes the entire treatment
3015        more complicated, requires new pickup files and two new S/Rs:
3016        obcs_copy_uv_n and obcs_save_uv_n
3017        keep old version with flag OBCS_STEVENS_USE_INTERIOR_VELOCITY
3018        (undefined by default)
3019      - silently move computation of some grid factors into separate loops to
3020        save some recomputations
3021      - add a hack for non-linear free surface
3022      - add a verification experiment to exp4 that tests this code
3023    o make gluemnc/xplodemnc work with (moron) non-GNU shell tools
3024    
3025    checkpoint63d (2011/10/25)
3026    o pkg/obcs + seaice-dynamics:
3027      - new implementation calls OBCS_APPLY_UVICE (in seaice_dynsolver.F) before
3028        solving for uIce,vIce and prevent SEAICE_LSR or SEAICE_EVP to modify OB
3029        values (consistent with an implicit method).
3030      - add option OBCS_UVICE_OLD (in OBCS_OPTIONS.h, defined by default) to
3031        return to older implementation (same results as before); note that none of
3032        the "experimental" OBCS_SEAICE options are implemented in the new version.
3033      - switch test exp. seaice_obcs to use new version (update output).
3034    o pkg/seaice:
3035      - add few stop (B-grid & CS-exch, B-grid & obcs, AUTODIFF & SEAICE_maskRHS)
3036      - add parenthesis in Water-Ice drag calculations (evp & lsr);
3037      - in seaice_lsr.F, simplify and fix AA3 setting in case sNx or sNy=1;
3038        and fix case SEAICE_waterDrag=0 (but unstable if no or little seaice)
3039      - update output of test exp lab_sea that uses evp or lsr (fwd+ad)
3040        and global_ocean.cs32x15 (icedyn & seaice fwd+ad).
3041    o pkg/layers:
3042      - Include potential density as new coordinate (Thanks to David Munday)
3043    o pkg/dic:
3044      - Remove subroutine CALC_PCO2_APPROX_CO3 from carbon_chem.F and add
3045        carbonate computation/output to CALC_PCO2_APPROX
3046    o pkg/generic_advdiff
3047      - make TAF generate code that vectorizes:
3048        gad_dst3fl_adv_*.F, gad_u3c4_impl_r.F
3049    o model/src:
3050      - improve vectorization also for adjoint code of
3051        solve_tridiagonal and solve_pentadiagonal. As this requires up to
3052        5 new 3D-fields, this code is only turned on for the combination of
3053        ALLOW_AUTODIFF_TAMC and TARGET_NEC_SX. Also remove error message
3054        for singular matrix check (only for TARGET_NEC_SX).
3055      - remove hard-wiring of CPP-flag ALLOW_SOLVERS_KLOOPINSIDE to
3056        ALLOW_AUTODIFF. This flag now needs to be set outside of
3057        solve_tri/pentadiagonal.F
3058    o pkg/exf:
3059      - fix previous modif in exf_readparms.F (revision 1.66: treatment of
3060        optional namelist EXF_NML_OBCS).
3061      - add many debug-print (to trace down where pkg/cal error msg comes from)
3062    o pkg/mom_vecinv/mom_vi_hdissip.F
3063      - rearrange loops so that vectorization is improved and in particular
3064        the adjoint routine vectorizes. The code is a little longer now, but I
3065        think easier to read.
3066        Note: CPP-flag MOM_VI_ORIGINAL_VISCA4 is not tested.
3067    o pkg/seaice:
3068      - allow to specify initial seaice velocity from files (uIceFile,vIceFile)
3069    o pkg/exch2:
3070      - alternative code (without tile x tile matrix) for cumulated (global) sum;
3071        used as default; keep using matrix version in adjustment.cs-32x32x1.
3072    o tools/build_options:
3073      - after merging some MPI and/or multi-threads specific optfiles so that
3074        the modified default optfile support both built (using genmake2 -mpi
3075        for the MPI built, using genmake2 -omp for OpenMP built),
3076        move now obsolete optfiles to tools/build_options/unsupported/
3077       (add copy of email sent to support list in doc/optfiles_changes.txt)
3078    
3079    checkpoint63c (2011/09/28)
3080    o pkg/ebm:
3081      - fix ebm_zonalmean.F for several procs in Ydir (nPy > 1); update output of
3082        test exp. global_ocean_ebm (affects machine truncation, 12 digits for cg2d)
3083    o pkg/seaice (SItracer pickup)
3084    * Simple code for pickup of SItracer fields (#define ALLOW_SITRACER)
3085      To be done:
3086      - thorough testing of missing fields in S/R seaice_read_pickup
3087      - thorough matching between generic tracers and specific fields used
3088        (e.g. volume-weighted age, area-weighted age, salinity, ...)
3089    o pkg/grdchk:
3090      - all procs calculate and print finite-difference gradient (for testreport)
3091      - change description output used by testreport;
3092      - AD testing: also compare and report Finite-difference gradient;
3093        => update all output_adm*.txt
3094    o test exp. global_ocean_ebm:
3095      - switch back useRealFreshWaterFlux (no problem anymore with run-off);
3096        and turn on exactConserve; update (fwd) output.
3097    o pkg/seaice (LSR):
3098      - print to STDOUT number of solver iterations at SEAICE_monFreq interval.
3099      - modify solver to deal cleanly with u/v switch at face edges (CS-grid):
3100        * identical results with non-CS topology (but save up to half of EXCH calls)
3101        * no much changes in cs-32 verification tests since no ice at face edges
3102         (differences due to convergence criteria, since nb of iterations changed)
3103        * expect some differences on lat-lon-cap grid.
3104        update FWD results of global_ocean.cs32x15 test exp. (icedyn & seaice)
3105    o pkg/exch2:
3106      - add new CPP option to disable Cumul-Sum matrix (to save storage when using
3107        many tiles); until alternative coding is added, just add a stop.
3108    o pkg/kpp:
3109      - move ptracer/salt correction to KPP diffusivity from calc_3d_diffusivity.F
3110        to S/R KPP_CALC_DIFF_PTR (+ add tracer-index to argument list).
3111    o optfiles:
3112      - merged few MPI specific (*+mpi*) and multi-threads specific (*+mth) optfiles
3113        into corresponding standard one, which now support different build:
3114        (when using "genmake2 -mpi" for MPI built, "genmake2 -omp" for OpenMP built)
3115      - add "darwin_amd64_gfortran" optfile (initially from Constantinos, tested by Gael)
3116    o pkg/obcs (seaice):
3117      - add missing EXCH for uIce,vIce after applying OBCS;
3118      - remove S/R EXF_SWAPFFIELDS_X/Y , disable S/R EXF_SET_OBCS_X/Y by adding
3119        argument = number of levels to S/R EXF_SWAPFFIELDS_XZ/YZ and S/R
3120        EXF_SET_OBCS_XZ/YZ ; update obcs_exf_load.F;
3121      - fix EXF_SET_OBCS_XZ/YZ for multi-threaded (assuming loaded arrays are shared)
3122      - verification exp. seaice_obcs: split domain in 2 tiles ; add SIZE.h_mpi
3123        and eedata.mth for MPI and mutlti-threaded testing.
3124    o pkg/flt:
3125      - make FLT EXCH working with multi-threads (and MPI + multi-threads);
3126      - use buffer for floats IO (trajectories & profiles); size set in FLT_SIZE.h;
3127      - fix pickup and trajectories + profiles output with multi-threads;
3128      - add parameter to select group of fields to write along trajectory and
3129        profile (default unchanged);
3130      - only call PORT_RAND* function when flt_noise <> 0;
3131      - add multi-threaded test for verification exp. flt_example.
3132    o eesupp/src:
3133      - fix S/R ALL_PROC_DIE for MPI+multi-threads.
3134      - USE_OMP_THREADING: check that number of threads (from eedata) matches
3135        actual number (from env.var. setting).
3136    o pkg/ebm:
3137      - fix multi-threading in ebm_area_t.F ; clean-up EBM.h header file.
3138      - add multi-threaded test for verification exp. global_ocean_ebm
3139    
3140    checkpoint63b (2011/08/29)
3141    o pkg/ebm:
3142      - fix sign of runoff;
3143      - update directly forcing fields (Qnet,EmPmR) to use standard
3144        external_forcing_surf.F (remove ebm_forcing_surf.F);
3145      - avoid loading forcing fields a 2nd time (1rst time from ini_forcing.F);
3146      - set either tauThetaClimRelax (in data) or tauThetaZonRelax (in data.ebm)
3147        and apply relaxation towards corresponding SST field (2-D map or ZonAver).
3148      - update global_ocean_ebm parameters file data and update output (fwd+ad).
3149    o verification/matrix_example:
3150      - split domain in 8 tiles (2x4); add SIZE.h_mpi and eedata.mth for
3151        MPI and mutlti-threaded testing.
3152    o pkg/matrix:
3153      - change name of S/R MATRIX_INIT to S/R MATRIX_INIT_VARIA ;
3154      - fix for multi-tiles (add bi,bj indices to exp/impMatrixCounter);
3155      - fix for multi-threaded (remove DATA statement);
3156      - use standard DIFFERENT_MULTIPLE function;
3157      - add MATRIX_OPTIONS.h
3158    o verification/matrix_example:
3159       To allow to split the domain in several tiles, change the domain size
3160        from 31x31 to 32x32 by adding 1 row (on Southern side) + 1 column (on
3161        Western side) of land points.
3162    o (*_)write_pickup:
3163      - fix few bugs in mypackage_read/write_pickup.F
3164      - in MDS_WR_METAFILES calls, replace "myTime" by a local copy into
3165        array of length 1 (was caught by compiler syntax-check).
3166    o pkg/diagnostics (velocity potential solver):
3167      - fix initialisation of main diagonal matrix (for overlap values)
3168    o tools/build_options:
3169      - towards single optfile for MPI and non-MPI built: merge few +mpi optfile
3170        into previously non MPI one (linux_am64 pgf77,open64,pathf90,ifort11)
3171      - linux_amd64_gfortran: merge +mpi_generic version into standard optfile:
3172        * move IEEE flags to DEVEL section; take IEEE flags from +mpi_generic ;
3173        * FAST case: for now, keep -O3 with ini_masks_etc.F in NOOPTFILES list;
3174        and use "-devel" testreport option for standard testing on baudelaire.
3175    o pkg/grdchk:
3176      - Assume that all gradient-check position are within the same tile
3177        corresponding to global indices (iGloTile,jGloTile) and that
3178        positions (i,j indices or nbeg) are local to this tile;
3179      - set tile local-indices and proc. number according to tile global-indices;
3180      - remove grdchkwhichproc from namelist (retired param);
3181      - send adjoint gradient to all procs so that all procs print it to STDOUT;
3182      - switch on MPI test for global_ocean.90x40x15 AD test experiment.
3183    o adding package bbl (Bottom Boundary Layer)
3184      description in MITgcm/pkg/bbl/bbl_description.tex
3185      example/test experiment in MITgcm_contrib/bbl
3186    o adjoint verifications
3187      - changed 5 experiments to multi-tiles
3188        * global_ocean.90x40x15
3189        * obcs_ctrl
3190        * offline_exf_seaice
3191        * tutorial_dic_adjoffline
3192        * tutorial_tracer_adjsens
3193        changed reference output for those that crossed tile boundaries
3194        (changed choices of gradient check positions)
3195      - with same tiling, switch on MPI test for the last 4 (add SIZE.h_mpi)
3196      - temporary bug fix in grdchk_loc.F for obcs
3197    o genmake2 & testreport
3198      - add target "obj" (just for OBJFILES files) to Makefile;
3199      - add option to specify FEXTRAFLAGS on command line.
3200    o pkg/mypackage:
3201      - remove bi,bj arguments from argument list of S/R MYPACKAGE_CALC_RHS
3202    
3203    checkpoint63a (2011/08/02)
3204    o pkg/diagnostics (velocity potential):
3205      - fix velocity-potential calculation when using OBCS: balance net inflow
3206        at each level (new S/R OBCS_DIAG_BALANCE).
3207      - fix some of the problems with OBCS in stream-function calculation.
3208    o pkg/exf/exf_readparms.F
3209      - make treatment of optional namelists (EXF_NML_04, EXF_NML_SGRUNOFF,
3210        EXF_NML_OBCS) more consistent, so that you need not have these lists
3211        in data.exf when they are not used.
3212    o optim/optim_readdata.F:
3213      - add some output about obcs variables that might help debugging
3214      - add a check about nvarlength
3215    o pkg/ctrl: once again, fix computation of endrec in s/r ctrl_init_rec
3216    o pkg/diagnostics (velocity potential):
3217      - fix mask for OBCS (still problems in stream-function with OBCS);
3218      - add specific parameter (default = main code CG2D params) for solver;
3219      - in case of poor convergence, use solution corresponding to lowest residual.
3220    o pkg/seaice/seaice_growth.F: small changes that permit vectorizable
3221      adjoint code. In general statements like tmpscal=fld(i,j) are problematic
3222      and should be avoided where possible.
3223    o model/src (rStar):
3224      - include r* effect on reference-state (PhiRef) in totPhiHyd
3225        (so that it's really the potential anomaly at the cell center);
3226        affect solution only if z* with full pressure in EOS.
3227      - test-exp global_ocean.90x40x15: reduce viscA4 (was not stable) and
3228        update output (because of z* in totPhiHyd and viscA4 changes);
3229      - keep the previous diagnostics as "PHIHYDcR" (closer to potential anomaly
3230        @ constant r) until interpolation at constant r is implemented.
3231    o pkg/diagnostics
3232      - fix RCENTER diagnostics in case cell center is not at interface middle
3233    o add code for TEOS-10 (www.teos-10.org, McDougall et al. 2011). Use
3234      this eos with eosType = 'TEOS10', in data (PARM01). This eos implies
3235      that THETA and SALT are "conservative temperature" and "absolute
3236      salinity"
3237    o pkg/ctrl
3238      - fix computation of endrec in s/r ctrl_init_rec
3239      - ctrl_pack/unpack_*: remove unused variables and some obsolete code
3240    o pkg/seaice/seaice_growth.F
3241      - fix recomputation with FENTY_AREA_EXPANSION_CONTRACTION code,
3242        remove then obsolete STORE directives
3243      - fix STORE directives for tice and tices, so that only the
3244        appropriate part of the fields are stored (and not the entire
3245        field); update global_ocean.cs32x15.seaice AD output.
3246      - cosmetic changes: adjust CPP flags and indentation for better
3247        legibilty
3248    o pkg/autodiff: add mnc-output of adBottomDragFld (code contributed by
3249      Chris Wilson)
3250    o pkg/gmredi:
3251       Add Sub-Meso Eddies parameterisation from Baylor (for now, disabled with TAF),
3252       and test it in verification exp. "front_relax.bvp" (update output.bvp.txt)
3253    
3254    checkpoint63  (2011/07/11)
3255    o pkg/exch2:
3256     - rename+move: nTiles in W2_EXCH2_PARAMS.h --> exch2_nTiles in W2_EXCH2_TOPOLOGY.h
3257     - exch2 version of Cumul-Sum routine: S/R W2_SET_MAP_CUMSUM set up the
3258       (2*nTiles)x(nTiles) Cumul-Sum matrix and Master Proc collects all tiles X,Y
3259       increments, calculates Cumul-Sum @ tile origin and sends results to each tile.
3260    o pkg/diagnostics:
3261     - deal with pairs of post-processed diags which are computed together; in
3262       particular, re-order list of diags within 1 file to save 2nd computation.
3263     - add S/R to compute velocity stream-function (called after velocity-potential
3264       calculation) from divergence free transport -> new diagnostics "PsiVEL".
3265     - add parameter to select grid-point location where PsiVEL == 0.
3266    o eesupp/src:
3267       new S/R to calculate cumulated sum on tiled array, corner grid-cell location
3268       (specific S/R needed with exch2 topology - for now, just print an error msg)
3269    o pkg/shelfice
3270     - Implement friction velocity-dependent transfer coefficients following
3271       Holland and Jenkins, JPO, 1999
3272       Original code by M. Losch with small modifs.
3273       Enable with CPP option SHI_ALLOW_GAMMAFRICT
3274       and runtime flag SHELFICEuseGammaFrict
3275    o verification lab_sea & global_ocean.cs32x15:
3276     - use tools/xmakedepend (instead of cyrus_makedepend, in genmake_local):
3277       does not miss some dependencies (but is slower) and also works with many files
3278       (default makedepend limitation for AD built).
3279     - use cyrus_makedepend in adjustment.128x64x1 (so that it still tested).
3280    o pkg/diagnostics:
3281     - add run-time parameter "useMissingValue" (def=False) to fill land-point
3282        (i.e., where mask=0) with MissingValue ; used only in MNC output file.
3283       This replaces CPP-option DIAGNOSTICS_MISSING_VALUE.
3284     - Extend the use of "missing_value" setting from data.diagnostics for the case
3285       of counter-diagnostics (where fraction-weight is zero). This applies both to
3286       MNC and MDS output files.
3287    o pkg/seaice/seaice_growth.F:
3288      - add 'a priori' cap of latent heat flux based on actual mass considerations
3289        when SEAICE_ADD_SUBLIMATION_TO_FWBUDGET is used in conjunction with the
3290        non-legacy seaice_solve4temp.
3291      - add diagnostic of the residual sublimation freshwater flux (the freshwater
3292        flux taken from the ocean if the total actual latent heat fluxes exceed
3293        the maximum)
3294      - remove the CPP switch around the *_FWbySublim unit change and move diagnostic
3295       fill for SIatmQnt, SIfwSubl, SIatmFW to the end of seaice_growth.F.
3296      - add diagnostic of the actual sublimation freshwater flux (that is 0. ifndef
3297       SEAICE_ADD_SUBLIMATION_TO_FWBUDGET) and of the latent heat flux (evap+sublim).
3298      - bug fix : frWtrAtm needs a_FWbySublim ifdef SEAICE_ADD_SUBLIMATION_TO_FWBUDGET.
3299      - bug fix : missing part to Martin's r_FWbySublim pathological case fix.
3300    o verification 1D_ocean_ice_column:
3301       made model domain truly 1x1x23 instead of 5x5x23 with only center cell (3,3,:) wet
3302       update results
3303    o pkg/diagnostics:
3304     - Implement setting of "Post-Processed" diagnostics (corresponding to gdiag(5)='P')
3305       which are not filled-up but computed from other diags ; In this case, the mate
3306       diag points to the primary (filled-up) diag to used for post processing.
3307     - Update Velocity-potential computation using post-processed diag framework.
3308     ==> Change the ordering of fields and time-periods in MDS output file
3309       when using periodic averaging: now writes one time record with the full set
3310       of fields for this time period, then the next time reccord (it used to be
3311       one field with the full set of time records then the next field).
3312         Note: this is now similar to NetCDF (MNC) output file. <==
3313    
3314    checkpoint62z (2011/06/21)
3315    o adjoint monitor:
3316     - Add adjoint monitor output for packages exf, seaice
3317       and update relevant testreport output
3318    o pkg/seaice:
3319     - re-order diags inits so that they appear in order in available_diagnostics.log
3320     - added diags: hsnow thermo. rates of change, area preceeding ridiging process,
3321       area/heff/hsnow preceeding thermodynamic growth/melt.
3322     - modified diag: SIdA; output actual effect, as the description states.
3323     - modified description: SIqneti, SIqneto, SIuheff, SIvheff, SIdAb*, HSNOW.
3324     - retired redundant diags: SIyneg, SIfice, SIsnwice, SIthdgrh.
3325       (SIyneg->SIdHbOCN; SIfice->SIdHbATC; SIsnwice->SIdHbFLO;
3326        and SIthdgrh->SIdHbOCN+SIdHbATC+SIdHbATO)
3327     - modified diags (2) : switch all SIdA*, SIdH*, SIdS* from delta to rates.
3328     - added diagnostics for seaice generic tracers (SItr*).
3329     - added SItrUnit and SItrNameLong run time param (for SItr* diags).
3330     - in diag names, replaced 'PrTh' abbrev. of 'preceeding thermo' with 'PT'.
3331     I. Fenty: 18-Jun-2011:
3332     Minor changes to seaice package:
3333     1) Retired old variables (A22, SEAICE_lhsublim, areaMax, areaMin, hiceMin) and
3334        added some new ones (SEAICE_area_reg, SEAICE_hice_reg, SEAICE_area_floor)
3335       - Differentiated "regularization variables" from "floor variables"
3336        * areaMin became SEAICE_area_reg (old A22) and SEAICE_area_floor
3337        * hiceMin became SEAICE_hice_reg (old hiceMin)
3338          (with _reg meaning regularization variable)
3339       - SEAICE_lhSublim becomes lhSublim, the sum of SEAICE_lhEvap and SEAICE_lhFusion
3340        so as to ensure energy conservation when going between phases
3341      - A22 was not used anywhere
3342     2) Changed regularization procedure for heffActual and hsnowActual to ensure
3343        well-boundedness and smooth adjoint in seaice_growth.F
3344     3) Fixed a bug where seaice_solve4temp would not recognize ice-free grid cells
3345        because the old regularization always set heffActual >= 0.05 cm
3346     4) Changed the model so that the default behavior is to put a small (10^-5) "floor"
3347        on AREA when HEFF > 0.
3348      - went from requiring ALLOW_PRECLUDE_INFINITESIMAL_AREA to be defined to
3349        requiring that DISABLE_AREA_FLOOR *not* be defined
3350     Affected verifications:
3351      - 1D_ocean_ice_column (output.txt output_adm.txt)
3352      - global_ocean.cs32x15 (output.seaice.txt output_adm.seaice.txt)
3353    o pkg/diagnostics:
3354      - move MNC code from diagnostics_out.F into new diagnostics_mnc_out.F (2 S/R).
3355      - rename S/R GETDIAG to DIAGNOSTICS_GET_DIAG and change type of 1rst argument
3356        (was _RL, now integer) with option = 0 to retrieve all levels.
3357      - add pieces of code to compute velocity potential at each level (new diagnostics
3358        PhiVEL, works only when UVELMASS & VVELMASS are also turned on);
3359        for now, using same params as CG2D (target-resisual, max Nb of iter ...).
3360      - fix few issues with counter diagnostics in diagnostics_setdiag.F &
3361        diagstats_setdiag.F (if diagnostic counter is itself a counter diag)
3362        and in diagnostics_fract_fill.F (do not need a valid pointer for the
3363        diagnostics counter-mate); check that definition of counter-diagnostic
3364        includes a valid counter-mate (in diagnostics_set_levels.F).
3365    o model/src (rStar):
3366      - add rStar scaling factor in diags_phi_hyd.F (similar to calc_grad_phi_hyd.F);
3367        affect solution only if z* with full pressure in EOS;
3368        update output of test-exp global_ocean.90x40x15.
3369    o pkg/seaice:
3370      - introduce siEps=1e-5 parameter
3371      - use areaMax in AREA update (part 4), consistent with ridging step (part 2.5).
3372      - re-organize SEAICE_ADD_SUBLIMATION_TO_FWBUDGET code.
3373      - introduce ALLOW_SITRACER and seaice_tracer_phys.F to handle generic seaice tracer.
3374        For now it covers, and was tested for, ice salinity and age (attached to HEFF),
3375        as well as ice cover age and ridging index (attached to AREA).
3376        For now the run time parameters (in data.seaice/SEAICE_PARM03) are
3377        SItrName (e.g. 'age') and SItrMate ('HEFF', which is the default, or 'AREA').
3378        Up to SItrMaxNum=3 tracers can be used simultaneously.
3379    o pkg/salt_plume:
3380      -introduce SPsalFRAC run time parameter that sets the fraction of the
3381       salt by-product of ice growth (SPsalFRAC*(1-SIsalFRAC)*salt typically)
3382       that gets vertically redistributed (fluxed down) by pkg/salt_plume.
3383    o model debug options:
3384      - Switch reading of debugMode from S/R INI_PARMS (parameter file "data", stored
3385        in PARAMS.h) to S/R EESET_PARMS (parameter file "eedata", stored in EEPARAMS.h).
3386      - Refine debug-msg printing selection (3 new levels):
3387        debugMode  : controls printing of debug messages (sequence of S/R calls).
3388        debugLevel : controls printing of algorithm-relevant auxiliary/debug messages
3389         debLevZero =  0 ; /* level of disabled aux. msg printing */
3390         debLevA =  1 ; /* level of minimum  aux. msg printing */
3391         debLevB =  2 ; /* level of low aux. print (report read-file opening)*/
3392         debLevC =  3 ; /* level of moderate debug prt (most pkgs debug msg) */
3393         debLevD =  4 ; /* level of enhanced debug prt (add DEBUG_STATS prt) */
3394         debLevE =  5 ; /* level of extensive debug printing */
3395        New debugLevel default: with default debugMode value (=F),
3396          = 2 (debLevB) or = 1 (debLevA) in case ALLOW_AUTODIFF is defined.;
3397          and if debugMode=T, default debugLevel = 4 (debLevD).
3398        Relation with previous settings:
3399         debLevB (=2) corresponds to former debLevA (=1)
3400         debLevD (=4) corresponds to former debLevB (=2)
3401        Note:
3402         a) if debugLevel=0, skip WRITE_GRID call when nIter0 > 0 (same as before);
3403         b) default debugLevel=1 is convenient in AD runs (avoid many file opening msgs);
3404            to recover previous default, set debugLevel=2 (e.g. AD-test hs94.1x64x5)
3405      - Add new parameter (printResidualFreq, read from PARM02 namelist) to print
3406        detailed CG solvers convergence; off (=0) by default, except if debugLevel=5.
3407    o pkg/obcs:
3408      - change OBCSfixTopo default from True to False (should not change the results);
3409        keep OBCSfixTopo=T in verification-exp. seaice_obcs.
3410    o pkg/thsice:
3411      - fix bug in thsice_calc_thickn.F (was introduced in version 1.18) in
3412        2nd layer seaice sublimation (unlikely to happen)
3413      - use Interior mask for OBCS in thsice_advection.F (similar to what is
3414        done in gad_advection & seaice_advection).
3415    o adjoint:
3416      bug fix spotted by Gael Forget:
3417      seaice_advection and thsice_advection still had
3418      legacy CPP options to avoid CS corner updates for adjoint
3419    o pkg/seaice:
3420      => Change some of the defaults (2011/05/29):
3421         - change SEAICEuseFluxForm default (from False to True)
3422         - change DIFF1 default (from 0.004 m/s to 0. m/s)
3423         And print warnings if DIFF1 is not set in data.seaice and centered
3424          avection scheme is used without any diffusion.
3425      also:
3426      - fix seaice_diffusion calls in default AdvScheme part of seaice_advdiff.F;
3427      - set SEAICEdiffKh[] default in the same way as SEAICEadvSch[]
3428      - stop if DIFF1<>0 with SEAICEadvScheme <> 2, if DIFF1<>0 with any
3429        other non-zero SEAICEdiffKh[] diffusivity, if SEAICEadvSalt=T with
3430        #undef SEAICE_VARIABLE_SALINITY, if SEAICEadvAge=T with #undef SEAICE_AGE.
3431      update results of test exp.:
3432         lab_sea: output.fd (switch to AdvScheme=33 with diffKh=20)
3433             output.hb87, output_adm.evp (SEAICEuseFluxForm=T and diffKh=200)
3434             output_adm.noseaicedyn (SEAICEuseFluxForm=T)
3435         offline_exf_seaice: output.seaicetd, output_adm (SEAICEuseFluxForm=T)
3436         seaice_obcs: output (SEAICEuseFluxForm=T)
3437      and prescribe old default for SEAICEuseFluxForm (=F) and DIFF1 (=0.004)
3438          for standard fwd & AD lab_sea tests (to keep the same output).
3439    o pkg/seaice/seaice_growth.F:
3440      - use Ian Fenty's capping formulas for actual ice
3441      thickness thoughout EVOLUTION branch.
3442      - put treatment pathological case #2) in CPP brackets
3443      (ALLOW_AVOID_INFINITESIMAL_AREA, undef by default).
3444      - update global_ocean.cs32x15 and 1D_ocean_ice_colum results accordingly.
3445    o pkg/seaice:
3446      - seaice_diffusion.F : remove the min(DX,DY) factor permanently;
3447      pass the Laplacian diffusivity (in m^2/s) diffKh as a parameter;
3448      also pass fac as a param, which can be 1. (to update the tendency
3449      field) or the time step (to update the field itself).
3450      - seaice_advdiff.F: for multidim, call seaice_diffusion with
3451      e.g. SEAICEdiffKhHeff and with fac=1; for single-dim, call
3452      seaice_diffusion with e.g. SEAICEdiffKhHeff and with fac=time step.
3453      - SEAICE_PARAMS.h, seaice_readparms.F, seaice_check.F :
3454      hooks to handle SEAICEdiffKhHeff, SEAICEdiffKhArea, etc.
3455    o pkg/seaice:
3456      diffusion with centered advection scheme (diffus.F & advect.F):
3457      - simplify S/R DIFFUS (put deltaT & DIFF1 factor outside, move EXCH outside)
3458        to just compute the laplacian of input-field.
3459      - unroll k loop (harmonic,biharmonic diff) in advect.F to save 1 exch call.
3460      - fix flux-form version in diffus.F to conserve tracer.
3461      update output of lab_sea.fd & lab_sea.hb87 (1rst set of modif affects
3462       machine truncation) and lab_sea.salt_plume (conservative flux-form modif)
3463    
3464    checkpoint62y (2011/05/26)
3465    o pkg/seaice:
3466     - seaice_growth.F : in EVOLUTION branch, always include
3467       a_QSWbyATM_cover in qnet (as it should be).
3468     - verification/global_ocean.cs32x15 : update results accordingly
3469       (output.seaice.txt output_adm.seaice.txt).
3470    o pkg/seaice + obcs:
3471     - use maskInW & maskInS in multi-dim advection and biharmonic diffusion:
3472       equivalent of assuming no tracer gradient outside the OB region.
3473       update output of seaice_obcs (uses DIFF1 <>0 => biharmonic diffusion)
3474     - remove calls to OBCS_COPY_TRACER after EXCH calls (no longer needed
3475       after changes above);
3476     - obcs+seaice cleaning: apply seaice-tracer OB values to tracer field
3477       only at OB location (instead of over a band of OLx width).
3478    o pkg/seaice:
3479     - fix wrong indices in old (non Flux-Form) diffusion default S/R diffus.F
3480       (dxG(I+1, ...) changed to dxG(I, ...), no impact on Lat-Lon grid)
3481    o pkg/obcs:
3482      - split header file "OBCS.h" into 4 separated files:
3483        OBCS_PARAMS.h, OBCS_GRID.h, OBCS_FIELDS.h & OBCS_SEAICE.h
3484       Note: OBCS_PARAMS.h & OBCS_GRID.h can be included without OBCS_OPTIONS.h
3485         (contain no conditional statement which depends on OBCS options).
3486      - move "useOBCSYearlyFields" from "data.obcs" (hold in OBCS_PARAMS.h)
3487        to parameter file "data.exf", namelist EXF_NML_OBCS (in EXF_PARAM.h).
3488    o ctrl, cost, grdchk & autodiff pkgs:
3489      - make options file more standard (like other {PKG}_OPTIONS.h file but
3490        with AD_CONFIG.h); clean-up some of the included header files.
3491    o pkg/obcs:
3492      - do not mask tracer when applying OB (tracer == 0 could generate problems)
3493      - apply tracer OB values to tracer field only at OB location (instead of
3494        over a band of OLx width)
3495      - clean-up obcs_apply_w.F & obcs_apply_eta.F (since less calls to these S/R)
3496      - remove OBCS_MULTIDIM_OLD_VERSION code in gad_advection.F and remove
3497        obcs_apply_tloc.F & obcs_apply_sloc.F
3498    o obcs in model/src:
3499      - call OBCS_APPLY_W only if NonHydrostatic.
3500      - call OBCS_APPLY_ETA only if NonLinFreeSurf.
3501      - reset dEtaHdt and wVel to zero outside OB interior region ;
3502      - leave tracer unchanged outside OB interior region: This has no effect
3503        on the solution but just to prevent unrealistic tracer value outside OB.
3504      - zero out velocity outside OB interior region: This has no effect on
3505        the solution but just to prevent unrealistic velocity outside OB.
3506    o obcs and non-lin free-surf:
3507       move call to OBCS_APPLY_R_STAR from update_r_star.F to calc_r_star.F
3508       and call to OBCS_APPLY_SURF_DR from update_surf_dr.F to calc_surf_dr.F
3509       + add argument "etaFld" to OBCS_APPLY_R_STAR & OBCS_APPLY_SURF_DR:
3510       this fixes missing EXCH + get consistent eta OB value (+ fix restart).
3511       update results of test-exp. exp4(nlfs).
3512    o exp4 (nlfs) test-exp:
3513       use OBC for Eta at Western & Eastern OB (to test prescribing Eta
3514       with NonLin-FreeSurf); update output.nlfs.txt
3515    o obcs and 2d/3d solver norm:
3516       use interior masks (maskInC) to cancel out cg2d & cg3d matrix coeff at OB
3517       and outside OB interior region (will allow to place OB further inside the
3518       domain). Depending on the domain, can affects cg2d-Norm (previous
3519       cancellation outside OB was only partial), e.g. in exp4 & obcs_ctrl,
3520       and cg3d-Norm (previous Norm was computed before canceling OB terms),
3521       e.g. in tutorial_plume_on_slope.
3522      - update output of exp.: exp4 (x2), obcs_ctrl and tutorial_plume_on_slope.
3523    o pkg rbcs:
3524      - split RBCS.h into 3 files: RBCS_SIZE.h, RBCS_PARAMS.h & RBCS_FIELDS.h
3525      - add capability to apply relaxation to horizontal velocity uVel & vVel.
3526    o pkg/grdchk: add gradient check for control variable xx_shifwflx
3527    o pkg/shelfice/shelfice_init_fixed.F
3528      fix CPP-flag combinations
3529    o pkg/seaice: Merge iceage code of Pierre Rampal
3530      * update/change/correct ice age calculations
3531      * add age updates for pathological cases
3532      Probably needs more testing...
3533    
3534    checkpoint62x (2011/05/13)
3535    o pkg/mom_vecinv:
3536       high-order vorticity scheme: use interior masks (maskInW & S)
3537       to zero-out (outside OB) gradient of vorticity.
3538    o verification exp.:
3539       turn on "useEnergyConservingCoriolis" (better discretisation) in exp.
3540       hs94.128x64x5 and seaice_obcs ; update results.
3541    o pkg/obcs:
3542      fix bug in OBeta for YZ sections in obcs_exf_load.F
3543    o pkg/ctrl, pkg/shelfice, and optim:
3544      - add new control variable xx_shifwflx (fresh water flux underneath ice
3545        shelves). This is almost as tedious as obcs-ctrl, because the
3546        variables needs its own mask.
3547      - add a cost function term that penalizes the deviation of xx_shifwflx
3548        from the first guess (zero) in analogy to other control variables
3549    o pkg/shelfice:
3550      - start basic adjoint
3551    o pkg/ctrl:
3552      - remove extra 2D field "for good measure" when initializing in
3553        ctrl_set_globfld_[xy/xz/yz].F
3554      - replace hard coded precision 32 (a bug) in ctrl_map_ini_gen by ctrlprec
3555      - improve error messages in ctrl_set_unpack_*
3556    o OBC implementation in momentum:
3557       use interior masks (maskInC,W & S) in momentum S/R:
3558       - multiply divergence, tension and some del^i.u or del^j.v by maskInC
3559       - multiply del2u,del2v by maskInW/S (biharmonic viscosity)
3560       - multiply horiz. grad of vorticity by maskInW/S (in Leith scheme)
3561       - multiply gradient of wVel by maskInW/S in del2w calculation (NonHyd)
3562       Motivation: fix/clean implementation of OBC with biharmonic-viscosity
3563        (and also with Leith/Smagorinsky harmonic-viscosity).
3564       Update output of experiment dome and exp4 (+nlfs).
3565    o exp4 test-exp:
3566      - turn on: nonHydrostatic, exactConserv, viscA4 (with momDissip_In_AB=F)
3567        and prescribe time-varying OB (without pkg/exf) for zonal-velocity
3568        at Western & Eastern Boundaries (+/- 1 per-cent); Also prescribe
3569        time-varying OB at Western-side for wVel (NonHyd); update output.
3570      - add secondary set-up (.nlfs) using NonLin FreeSurf (z*) + mom_vecinv
3571        and biharmonic-viscosity ; also use prescribed time varying OB.
3572    o pkg/obcs:
3573      fix bug in OBWeta,OBWeta indices in obcs_apply_r_star.F
3574    o model/src:
3575      - fix startTime setting when baseTime<>0 & nIter0=0 are specified ;
3576      - initialise startTime & nIter0 with unlikely values: allows to set one
3577        from the other without ambiguity.
3578    o seaice_obcs test-exp.:
3579      add small diffK4T,S to test biharmonic diffusivity with OBCS ; update output.
3580    o pkg/obcs:
3581      - remove calls to OBCS_COPY_TRACER after EXCH for T,S & pTracer:
3582        no longer needed with maskInC,W,S in pkg/generic_advdiff.
3583    o pkg/seaice:
3584      - retired SEAICE_SALINITY and SEAICE_salinity in favor of
3585        SEAICE_VARIABLE_SALINITY and SIsalFRAC, respectively.
3586      - fixed bug in the initialization of sea ice salinity variable HSALT
3587        in seaice_init_varia.F  (removed dependence on ICE2WATR)
3588    o fizhi-cs test exp.:
3589       switch reference output convention for these 2 non-standard test-exp,
3590        from: pgi  6.1-5 on faulks (FC.6, -of linux_ia32_pgf77+authors_fc5)
3591          to: ifort 11.1 on baudelaire (FC.13, -of linux_amd64_ifort11)
3592       reason: faulks might get retired soon and pkg/fizhi has still Pb with gfortran
3593    o model/inc:
3594      - change type of PmEpR array (from _RS to _RL) to fix restart (with "-use_r4")
3595        of exp. global_ocean.90x40x15 (Suncronous time-stepping + Real-FW + NonLin-FS)
3596    o pkg/seaice:
3597      - fix calculation of saltFlux and saltPlumeFlux when using SEAICE_SALINITY
3598    o verification/lab_sea, 1D_ocean_ice_column, seaice_obcs, global_ocean.cs32x15
3599      - updated output*.txt files due to bug fixes in salt, saltPlumeFlux,
3600        and initial HSALT
3601    
3602    checkpoint62w (2011/04/26)
3603    o pkg/mom_fluxform:
3604      - fix calculation of del2u & del2v (no-slip BC) when using Non-Lin Free-Surf.
3605      - use parameter "sideDragFactor" in no-slip BC side-drag part.
3606      - update output of exp. global_ocean.90x40x15
3607    o pkg/mom_vecinv:
3608      mask del2u & del2v (no effect on results, but cleaner & closer to mom_fluxform)
3609    o update seaice exp.:
3610      use more consistent parameter values (remove "backward compatability only":
3611       ICE2WATR, SEAICE_lhSublim, SEAICE_cpAir, SEAICE_rhoAir + set rhoConstFresh)
3612      related to thermodynamics seaice. Update output (fwd+AD) of exp.:
3613       1D_ocean_ice_column (x2), lab_sea (x8), ioffline_exf_seaice (x2) & seaice_obcs
3614    o update test-exp global_ocean.90x40x15:
3615      o use default CD_CODE_OPTIONS file (Adams-Bashforth on CD Mom & Coriolis).
3616      o increase Overlap size from 2 to 3 (to allow to test bi-harmonic Visc.)
3617      o new pickup-files from a 100.yr run with pkg/down_slope (input.dwnslp params)
3618      o turn on zStar & viscA4 in standard set-up (dir input/)
3619        and update output files: output.txt & output.dwnslp.txt
3620    o new AD-test experiment: obcs_ctrl
3621      (From Matt MITgcm_Contrib/SOSE/BoxAdj) to test OBCS as control vector.
3622    o pkg/dic:
3623      fix two bugs in handling water vapour pressure in carbonate chemistry
3624      and air-sea fluxes. Found by Val Bennington and Galen McKinley
3625      (add DIC Option = WATERVAP_BUG to recover old results)
3626      update output of tutorial_global_oce_biogeo (fwd+AD) & tutorial_dic_adjoffline
3627    o adding allowInteriorFreezing option to check for water below freezing point
3628      at depth and bring the negative heat anomaly to the surface level
3629    o pkgs _fields_load:
3630      - extend GET_PERIODIC_INTERVAL to deal with non-periodic case (from pkg/rbcs)
3631      - use new S/R GET_PERIODIC_INTERVAL in pkgs:
3632        bulk_force, cheapaml, cfc, dic, obcs (+ ctrl/ctrl_get_gen_rec), offline and
3633        rbcs to get interpolation weights and time reccord number.
3634      - fix multi-threading in aim_fields_load.F
3635      - apply EXCH to temp arrays [0,1] after reading in dic_fields_load.F
3636    o external_fields_load:
3637      new S/R GET_PERIODIC_INTERVAL to calculate which time-record (and linear
3638       interpolation weights) to use in a periodic time-series ; do not divide by
3639       time-step to convert to integer:
3640       - this fixes case where externForcingPeriod is not multiple of time-step
3641          (Thanks to Christopher L. Wolfe)
3642       - this fixes case where externForcingPeriod is an odd multiple of time-step
3643         (was wrong by half of time-step); update results of tutorial_global_oce_in_p.
3644      store index of time-record which is currently loaded:
3645       - works without any assumption on sequence of calls to EXTERNAL_FIELDS_LOAD ;
3646       - needed for the adjoint but not yet used because of extensive recomputations;
3647         (to be fixed soon)
3648    
3649    checkpoint62v (2011/04/02)
3650    o verification/1D_ocean_ice_column added to test Ian Fenty's
3651      pkg/seaice_growth.F modifications for improving sea ice code differentiability
3652    o update output of exp4, internal_wave, seaice_obcs, tutorial_plume_on_slope
3653      (new velocity statistics after changing maskInW & maskInS definition)
3654    o pkg/generic_advdiff with OBCS:
3655      use maksInW & maskInS in advective flux and in biharmonic diffusion calculation:
3656      equivalent to assumption of no tracer gradient outside the OB region.
3657      This will affect the results if using obcs+biharmonic diffusion.
3658      update output_adm.txt of experiment bottom_ctrl_5x5 (not expected since no obc)
3659    o pkg/obcs:
3660      change definition of maskInW & maskInS: leave OB edges inside (maskIn=1)
3661      (e.g., maskInW(OB_Ie)=1 ) so that velocity normal-component at OB is still
3662      in Interior region. No impact on solution but affects Velocity monitor stats.
3663    o pkg/ptracers (adjoint)
3664      New option AUTODIFF_PTRACERS_SPLIT_FILES for writing separate
3665      tape file for each tracer
3666    o model/inc/src and pkg/autodiff: add parameters that allow to turn
3667      of parts of the adjoint code at run time. For now, there are only
3668      useKPPinAdMode, useGMrediInAdMode, and useSEAICEinAdMode. These
3669      parameters are set in data.pkg.
3670      This is the lazy coward's version of doing this, but still useful for
3671      debugging. In order to do it right, everything needs to be moved to
3672      pkg/autodiff.
3673    o pkg/autodiff: fix global_sum_tile_ad.F by resetting adsumPhi at
3674      the end; this fixes the adjoint balancing code for open boundaries.
3675    o pkg/ctrl:
3676      - change behavior of xx_${varname}period to be analogous to exf-conventions:
3677        xx_${varname}period =   0.,  means time-independent control part
3678        xx_${varname}period = -12., means one-year-periodic monthly control part
3679      - introduce helper routine ctrl_init_rec (part of ctrl_init.F) to
3680        clean up ctrl_init a little, remove unused variables
3681      - ctrl_init: fixed the handling of the start/endrec for obcs-variables
3682      - move "call cal_GetMonthsRec" from s/r ctrl_get_gen to s/r ctrl_get_gen_rec
3683    
3684    checkpoint62u (2011/03/15)
3685    o model/src:
3686      - for the adjoint, change NonLin-FreeSurf initialisation sequence: fill-in
3687        h0Fac from INITIALISE_FIXED and reset hFac to h0Fac in INITIALISE_VARIA ;
3688      - in initialise_varia.F (except for ALLOW_DEPTH_CONTROL) remove 2nd call to
3689        INI_DEPTHS, INI_MASKS_ETC & INI_LINEAR_PHISURF.
3690    o pkg/ctrl/obcs/ecco:
3691      - remove obsolete, unused, and partially broken code:
3692        ctrl_obcsvol/ctrl_obcsbal/ctrl_volflux and code within
3693        ALLOW_CTRL_OBCS_BALANCE
3694      - put a stop statement into ecco/cost_obcsvol.F, but also add
3695        cost_obcsvol to ecco_ad_diff.list
3696    o pkg/ecco: fix counting cost function contributions for obcs (code
3697      by Matt M.) and diffkr for diagnostics
3698    o pkg/ecco, pkg/ctrl, pkg/grdchk:
3699      add cost penalty terms for initial uvel, vvel, eta controls
3700      and I/O for prior error files
3701    o pkg/mdsio:
3702       move mds_check4file.F from eesupp/src to mdsio_check4file.F ; add option
3703       (new argument) to check for tiled file in mdsioLocalDir : this fix the
3704       restart from pickup_som , pickup_dic (& dic_co2atm) with mdsioLocalDir.
3705    o pkg/ctrl:
3706     - ctrl_obcsbal.F, ctrl_obcsvol.F: replace last calls of ctrl_getrec by
3707       ctrl_get_gen_rec, put a stop statement into ctrl_getrec. Remove
3708       unused and superfluous variables
3709     - ctrl_get_gen_rec.F: catch the case of xx_genperiod=0.
3710    o pkg/ecco
3711     - enable adjoint of Stevens OB
3712    o pkg/ctrl/ecco/grdchk:
3713      - remove global declaration of tmpfldx/yz and tmpfldx/yz2.
3714        Fortunately, we do not have any tests for the numerous cpp-flagged
3715        option of "obcs as control parameters" so we will never know
3716        if this is an improvement (but at least now things compile).
3717      - remove an obsolete initialization from ecco_cost_init_barfiles.F
3718      - fix some problems within never used ifdefs to make the code compile
3719    o pkg/obcs:
3720     - Refine Interior mask definition to work with more complex OB (e.g.
3721       if OB_Ie < OB_Iw); In case default setting is not sufficient, allows to
3722       read in Interior mask from file. Check if Interior mask is consistent
3723       with OB list of indices.
3724    o pkg/seaice
3725     - beginning code for a seaice tracer package,
3726       but currently only used for seaice age: SEAICE_AGE
3727       SEAICE_num = 4
3728       iTracer = 1: area-weighted ice age
3729               = 2: volume-weighted ice age
3730               = 3, 4: template for one-year vs. multi-year ice
3731       data.seaice has new namelist SEAICE_PARM03 for arrays related to
3732       SEAICE_num
3733    
3734    checkpoint62t (2011/03/05)
3735    o pkg/obcs:
3736     - obcs_apply_uv.F: change to a 2 steps method, first tangential component;
3737       then normal component. This ensures that the normal component is set
3738       correctly even when it conficts with tangential setting from an other OB.
3739       Affects results of test-experiment seaice_obcs: update the output.txt
3740    o pkg/obcs:
3741     - add code to monitor statistics of dynamical fields at OB.
3742     - take OBCS_BALANCE code out of obcs_calc.F into new S/R OBCS_BALANCE_FLOW :
3743       - fix to OBCS_BALANCE code (right hFac ; deal with simple OB intersection).
3744       - change default: balance the Net inflow through all OB (instead of balancing
3745         each OB separately); keep the old method if setting OBC_balanceFacX < 0.
3746     - switch on useOBCSbalance in dome experiment: only correct Western OB outflow
3747       to match Nortern OB inflow (OBCS_balanceFacN=0).
3748    o pkg/seaice:
3749     - redefined actual sea ice age to be ICEAGE/HEFF ifdef SEAICE_AGE_VOL
3750    o pkg/seaice (seaice_growth v 1.113):
3751     - reverting seaice_growth to v 1.111 in order to have code with exact bit
3752       compatibility with MITgcm_contrib/ifenty/Fenty_seaice_thermo_code_merge
3753       CPP option SEAICE_OCN_MELT_ACT_ON_AREA removed in v 1.112 is reintroduced
3754       runtime flag SEAICEareaFormula is kept but is inactive
3755    o model/src:
3756     - add new param to scale curvilinear grid distance and area when using
3757       a different sphere radius from the grid-files.
3758     - test/check multi-threads EXCH applied to local variable (cg2d_x)
3759    o adjoint:
3760     - enable adjoint of Stevens OB
3761     - add dummy_in_dynamics to enable extraction of ADJrhoinsitu
3762       (a bit delicate because of potentially modified adj. common block structure;
3763       current switch is ALLOW_AUTODIFF_MONITOR_DIAG, could be changed later)
3764    
3765    checkpoint62s (2011/02/15)
3766    o pkg/seaice (seaice_growth v 1.112):
3767     - introduce SEAICEareaFormula run time parameter, which selects the recipe for
3768       computing the ice cover tendency from effective thickness tendencies. Include
3769       Ian Fenty's formula.
3770     - remove 'undef SEAICE_OCN_MELT_ACT_ON_AREA' which may now be achieved using
3771       SEAICEareaFormula.
3772     - simplify notations for the various d_HEFF/d_AREA terms.
3773    o pkg/gmredi:
3774     - add Boundary-Value-Problem bolus transport (Ferrari etal, OM 2010) code
3775       from Christopher Wolfe (UCSD); add partial cell factor in vertical derivative;
3776       add a verification test-run (front_relax.bvp) to test GM_useBVP.
3777    o pkg/seaice (seaice_growth v 1.111):
3778     - for SEAICE_DO_OPEN_WATER_GROWTH, replace Gael's implementation with Ian's.
3779     - the new SEAICE_DO_OPEN_WATER_MELT allows open-water air-sea heat fluxes to
3780       also melt ice.
3781    o pkg/seaice:
3782     - McPhee formula for Ice-Ocean fluxes (provided by Ian Fenty).
3783     - can be used by #define MCPHEE_OCEAN_ICE_HEAT_FLUX in SEAICE_OPTIONS.h
3784    o pkg/cheapaml:
3785     - from Nico Wienders: New version of this package.
3786    o pkg/flt:
3787     - add CPP options to prevent floats to re-enter the opposite side of
3788       a periodic domain (default: keep periodicity)
3789    o pkg/gmredi:
3790     - apply exchange to GM_PsiX,GM_PsiY to get valid values near CS-corners
3791       (needed for multi-dim advection).
3792     - switch on GM Advective form in global_ocean.cs32x15 and update output.txt
3793    o model/src:
3794     - fix wrong re-setting of addMass array (ALLOW_ADDFLUID) for atmospheric run.
3795    o tutorial_tracer_adjsens
3796     - extend to NLFS and replace maskC by hFacC
3797       (change reference output accordingly)
3798    
3799    checkpoint62r (2011/01/24)
3800    o testreport:
3801     - add option -deloutp (-do) to remove output file after successful run
3802     - add option -mfile (-mf) for MPI machile-file and for each test-exp,
3803       extract exact list of procs from this file ; adjust COMMAND by
3804       replacing TR_MFILE & TR_NPROC with local machile-file & Nb of MPI procs.
3805    o pkg/ecco: replace old ineffective way of penalizing deviations from
3806      first guess (of obcs) with code by Matt Mazloff
3807    o pkg/ctrl: add code that allows the use of ALLOW_OBCS?_CONTROL without
3808      exf/cal
3809      - ctrl_init: fix initialisation (computation of diffrec) for obcs-ctrl
3810        and handle case of obcs?period == 0
3811        Not affected by these changes: There is still an inconsistency in
3812        the computation of start/endrec for the obcs variables for ALLOW_CAL
3813        defined (see comment by Menemenlis, 7-Mar-2003)
3814      - make S/R ctrl_get_gen_rec return something meaningful even if
3815        ALLOW_CAL is not defined
3816      - ctrl_getobcs?: simplify code so that it does not need to use
3817                       S/R exf_swapfields
3818    o testreport:
3819       allow to test MPI with different number of processors for each experiment:
3820       create file "SIZE.h.mpi" in each build dir.
3821       Note: update of "-command" argument not yet implemented.
3822    o model/src, pkg/autodiff, pkg/ecco, pkg/seaice:
3823      alleviate the need for additional 3D tapes when using
3824      the non-inear free surface in the adjoint. This is done
3825      by adding an 'update' of hfacc etc. to their current
3826      value at the beginning of forward_step.F.
3827    o pkg/seaice
3828      seaice_lsr: move stress-divergence computations out of outer pseudo-
3829      timestepping loop
3830    o pkg/obcs/obcs_prescribe_read.F: move 'CALL OBCS_EXTERNAL_FIELDS_LOAD'
3831      up, so that the calls of the ctrl_* subroutines are really at the end
3832      of the routine.
3833    o pkg/gmredi:
3834      allow to specify a 2-D horizontal map and a 1-D vertical profil
3835      as scaling factor for Isopycnal diffusivity (Redi) and GM diffusivity.
3836    o pkg/seaice:
3837      move lsr iterations from seaice_dynsolver to seaice_lsr.
3838    o pkg/seaice:
3839      reduce memory footprint of seaice mutldim advection tapes,
3840      by using a 2D tape independent of the generic_advdiff ones,
3841      and setting GAD_AREA=1 etc. rather than GAD_AREA=101 etc.
3842    
3843    checkpoint62q (2010/12/29)
3844    o model/src:
3845      - check horizontal grid-spacing for unset or zero/negative values.
3846      - change AD test hs94.1x64x5 to be truly a 2-D set-up.
3847    o pkg/flt:
3848      - use (recent) mdsio S/R MDS_READVEC_LOC instead of local FLT_MDSREADVECTOR
3849      - precision of input and output files set according to readBinaryPrec
3850        and writeBinaryPrec (previously always 64.b), pickup remains at 64 bits.
3851      - initial float position from tiled file was not converted to index space
3852        (looks like a bug): fixed to make it similar to initial pos. global file.
3853    o global_ocean.cs32x15:
3854       change SIZE.h of AD set-up to get same tiling as with MPI.
3855       Update output_adm, output_adm.thsice (pass@14) & output_adm.seaice (fail@11)
3856    o model/src:
3857       add flag to control printing of domain fields (bathymetry, hFac ...) in
3858       ini_mask_etc (call to plot_fieds_xy*).
3859    o pkg/thsice:
3860       if useEXF, some forcing fields are not valid in overlap: fixed by computing
3861       over the interior only + apply EXCH at the end (like with SEAICE advection).
3862    o pkg/mdsio:
3863      - add 2 arguments to S/R MDS_PASS_R4/8toRL/S for overlap size of buffer
3864        to copy to/from, so that it can be used to replace MDS_PASS_WH_R8toRL/RS.
3865      - change barrier call for safe multi-threads access to 3-D shared buffer.
3866      - MDS_READ/WRITEVEC_LOC use buffers from MDSIO_BUFF_3D.h (instead of local ones)
3867      - replace call to MDS_PASS_WH_R4/8toRL with call to MDS_PASS_R4/8toRL and
3868        remove the 4 S/R MDS_PASS_WH_R4/8toRL/S.
3869    o pkg/flt:
3870      - add fourth-order Runge-Kutta integration
3871      - add basic exch2 support (only 1 facet supported so far!)
3872    o pkg/mdsio+rw:
3873      new S/R to read local (or tile independent) vector (read counterpart of
3874       mds_writevec_loc, and front-end write_glvec_rl/rs).
3875    o global_ocean.cs32x15: additional input_ad.seaice experiment
3876        that uses pkg/seaice rather than pkg/thsice.
3877        (using multidim advection for seaice)
3878    o towards more F95 syntax for array specification in namelist:
3879      - change "data.diagnostics" (data.ptracers was changed before checkpoint62p)
3880        of all verification experiments.
3881           e.g.:    line: fields(1,3)='ETAN    ','ETANSQ  ',
3882          was changed to: fields(1:2,3)='ETAN    ','ETANSQ  ',
3883      - finish adding "-DNML_EXTENDED_F77" to DEFINES list in pgf77 and g77 optfiles
3884    o global_ocean.cs32x15: additional input.seaice experiment
3885        that uses pkg/seaice rather than pkg/thsice.
3886    
3887    checkpoint62p (2010/12/17)
3888    o pkg/thsice: rename (ad tape index) iicekey as ticekey, and move it
3889        to THSICE_SIZE.h to avoid conflict with pkg/seaice.
3890    o pkg/seaice: add seaice_diffusion.f seaice_map_thsice.f to adjoint.
3891        allow for use of multim. advection in seaice adjoint.
3892    o pkg/seaice: add diagnostics for snow precipitation and sublimation flux
3893      - first attempt to close budgets by taking into account the freshwater
3894        flux implied by the sublimation of snow and ice. So far only the
3895        volume budget is closed, turn on with soon-to-be-retired-again CPP-Flag
3896        SEAICE_ADD_SUBLIMATION_TO_FWBUDGET
3897    o eesupp/src:
3898      new S/R with new option (NML_EXTENDED_F77) to change array specification
3899      from F95 standard to commonly accepted extended F77 form.
3900      This would allow to use F95 syntax in namelist (needed with gfortran 4.4.5)
3901      and to revert back to the original syntax (with -DNML_EXTENDED_F77)
3902      for less tolerant f77 compiler (e.g., pgf77, g77).
3903    o globalFiles:
3904      commented out in parameter file "data" since it's not safe with MPI
3905      (e.g., wrong on aces); keep it if useSingleCpuIO=T (but not doing much
3906      in this case); no longer commented out in restart test (tst_2+2).
3907    o add adTapeDir to specify a special directory where adjoint tapes are
3908      written/read (adread_adwrite.F). adTapeDir is specified in data/PARM05
3909      and cannot be used together with mdsioLocalDir.
3910    o nesting pkgs:
3911      - packages_init_variables : put call to OBCS_INIT_VARIABLES in last position
3912      - update Gianmaria's Nesting pkgs (from Contrib/nesting_sannino)
3913      - add parameter files + utils dir + output from short run on beagle.
3914    o pkg/seaice:
3915        fix seaice_growth.F store directives; update results of exp. lab_sea.ad
3916    o pkg/seaice: explicitly store tsurfloc in seaice_solve4temp.F to avoid
3917      unnecessary copying in adjoint code, requires new parameter NMAX_ITER
3918    
3919    checkpoint62o (2010/11/25)
3920    o pkg/exf:
3921      - change CPP option EXF_VERBOSE to run-time logical param exf_verbose.
3922    o pkg/seaice:
3923      - seaice_ocean_stress: split a loop for better vectorization of the
3924        adjoint code
3925      - seaice_growth.F: fix bug in conservation of freshwater connected to
3926        capping of heff, put contribution into d_HEFFbyNEG
3927      - replace irritating parameters SEAICE_latentWater/Ice and SEAICE_sensHeat
3928        by something more sensible (parameters that are what their name implies)
3929      - change some defaults, so that by default exf-parameters are used for
3930        things like rhoAir, cpAir,latent/sensible heat parameters, in order
3931        to reproduce the old results, many data.seaice now contain funny values
3932        for cpAir and latent heat of sublimation
3933    o packages_readparms.F: move exf_readparms up in line so that
3934        exf-parameters are visible for other packages (e.g. seaice)
3935    o debugMode & debugLevel=2:
3936      - differentiate between debugMode & debugLevel=2:
3937        debugMode: controls printing of debug messages (sequence of S/R calls).
3938        debugLevel: controls printing of algorithm intermediate results and stats.
3939      - remove "if debugLevel=2 => debugMode" but keep "debugMode =>  debugLevel=2";
3940        => allows to print debug-stats without all sequence of call messages.
3941      - switch control of debug print from debugLevel to debugMode in many S/R.
3942    o pkg/obcs (obcs-sponge):
3943        fix bug that was introduced on Oct 25 (in dynamics.F v1.151): put back the
3944        call to OBCS_PRESCRIBE_EXCHANGES (need to exch gU,gV when using obcs-sponge)
3945    o pkg/generic_advdiff:
3946      - record overlap minimum size for each advection scheme;
3947      - refine criteria on overlap minimum size;
3948      - check and stop (in gad_check) if overlap size is too small.
3949    o pkg/obcs:
3950      - with ptracers: remove multiple calls to obcs_apply_ptracer (only done
3951        once, in ptracers_implicit.F)
3952      - with seaice: remove test on empty file name in obcs_apply_seaice (always
3953        apply OB values when tile has OB)
3954    o model/src, coriolis setting:
3955      - integer parameter "selectCoriMap" (=0,1,2) replaces 3 logical
3956        useConstantF, useBetaPlaneF, useSphereF ; can now read coriolis from
3957        files (selectCoriMap=3) with any grid.
3958      - add parameter "fPrime" for constant second Coriolis coeff (default=0).
3959    o pkg/seaice/seaice_growth.F:
3960        a few cosmetic changes that reduce the number of lines of code
3961    o pkg/obcs: add boundary conditions following Stevens (1990)
3962      - the code follows old MOM/NAOSIM code
3963      - so far it is only implemented for the eastern and western boundaries
3964        and NOT for pTracers
3965    o pkg/rbcs:
3966      - replace rbcsInIter by rbcsForcingOffset, the time in seconds at the
3967        beginning of the first rbcs forcing period.
3968      - add option rbcsSingleTimeFiles that makes rbcs read forcing data like the
3969        offline package, i.e., one file per time, labeled by iteration number;
3970        deltaTrbcs sets the timestep with which the data was generated;
3971        rbcsIter0 is the forcing iteration corresponding to rbcsForcingOffset.
3972      - rbcsForcingCycle=0 makes forcing non-cyclic.
3973      - make arithmetic safe for negative times and odd forcing periods.
3974    
3975    checkpoint62n (2010/11/09)
3976    o pkg/seaice:
3977        fix masking in free-drift S/R ; update results of exp. lab_sea.fd
3978    o pkg/obcs:
3979       New S/R to copy tracer value from the OB location to narrow band region
3980        (width = same as overlap) beyond the OB: preserve OB value (needed for
3981        high-order scheme) which were overwritten by EXCH call if in overlap
3982        region. Applied to theta, salt, ptracer and advected seaice variables.
3983       With seaice: use maskInC in similar way as in gad_advection.F,
3984        in seaice_advection.F and advect.F.
3985       Update output of experiment seaice_obcs and change exp4 to test OBCS with
3986        4th order Adv.Scheme. for pasive salt and ptracer.
3987    o tools/genmake2:
3988      - when looking for an optfile (not specified), only search for Fortran compiler
3989        (remove sym-link test + setting of CPP + makedepend check + C-compiler check)
3990      - in get_fortran_c_namemangling: use "$CC $CFLAG" to compile C test programm
3991        (instead of "$MAKE genmake_test.o" since an existing Makefile can be wrong)
3992      - set default for CPP to "cpp -traditional -P" (was the case without specifying
3993        an optfile, but otherwise default was just "cpp".
3994      - comment out PLATFORM=$p_PLATFORM (no idea where p_PLATFORM comes from)
3995      - when "CC" is not set in the optfile, look for possible C compiler
3996        (instead of just setting CC=cc)
3997      - put back version v.169 modif (from 2008/02/15), was dropped in v.173 changes:
3998        => add a ".F" to ".o" rule for source files with no "#include" (such as
3999           port_rand.F); otherwise, default ignores FOPTIM and just uses FFLAGS.
4000      - move gfortran before g77 in list of possible Fortran compiler (consistent
4001        with reference compiler switch from g77 to gfortran)
4002    o pkg/seaice:
4003      o remove SEAICE_OLD_AND_BAD_DISCRETIZATION-code, add a test to
4004        seaice_check that stops the model, when the CPP flag is used.
4005      o seaice_growth.F: make capping of ice volume conserving by returning the
4006        capped ice as freshwater to EmPmR. This does not change the verification
4007        experiments but will change runs where the capping is acutally active
4008    o change reference platform+compiler from faulks+g77 to baudelaire+gfortran
4009      (except the 2 fizhi test exp.); update output of exp.: bottom_ctrl_5x5,
4010         global_ocean.cs32x15 (icedyn, thsice, AD thsice), global_ocean_ebm (AD),
4011         lab_sea (fd, hb87, salt_plume), MLAdjust (3/5) and vermix (dd)
4012    o tools/genmake2:
4013      - merge genmake_warnings & genmake_errors into 1 log file: "genmake.log")
4014      - change DUMPSTATE default to false (can use "-ds" option to switch it to T)
4015      - clean previous genmake log files before anything else.
4016      - change Makefile to remove testreport log files (*.tr_log) and genmake log
4017        files only with "CLEAN" target (instead of "Clean");
4018    o pkg/generic_advdiff:
4019      Change OBCS in multiDim advection (gad_advection.F):
4020       Use maskInC to prevent intermediate update of tracer-field in OB regions,
4021       thus keeping current-time-step OB values; and remove the call to OBCS_APPLY
4022       which were applying future time-step OB values.
4023      This way, all explicit calculations use current-time-step OB values
4024       (simpler and more consistent).
4025      Affects results when set-up uses time-varying OBC and multi-dim advection;
4026       update output of experiment seaice_obcs.
4027    o pkg/seaice:
4028      move OPTIONS (formerly locally defined) to SEAICE_OPTIONS.h:
4029       this includes SEAICE_GROWTH_LEGACY (+ SEAICE_DO_OPEN_WATER_GROWTH &
4030         SEAICE_OCN_MELT_ACT_ON_AREA ) and SEAICE_SOLVE4TEMP_LEGACY.
4031      Default (pkg/seaice/SEAICE_OPTIONS.h) is to define SEAICE_SOLVE4TEMP_LEGACY
4032       but leave SEAICE_GROWTH_LEGACY undef ; For now, keep verification exp
4033       unchanged (SEAICE_GROWTH_LEGACY defined in */code*/SEAICE_OPTIONS.h)
4034    o pkg aim (2010/10/26):
4035      - Introduce ALLOW_INSOLATION, moving toward a more general incoming solar radiation
4036        formulation with obliquity, eccentricity, ... as run-time parameters,
4037      - Introduce diagnostics for top-of-the-atmaophere incoming solar radiation and
4038        upward shortwave radition at the surface (all-sky and clear-sky).
4039    o pkg/obcs:
4040      - writing sections with globalFiles=T does not work: switch to tiled-files
4041        when writing sections for OBCS (change pkg/rw/write_rec.F accordingly).
4042      - fix index bug (OB_Ie -> OB_Iw_) in obcs_apply_uvice.F
4043      - apply OBCS_SEAICE_COMPUTE_UVICE to both uice and vice at all obcs
4044    
4045    checkpoint62m (2010/10/21)
4046    o pkg/seaice: vectorize seaice_solve4temp.F
4047      - move iterations loops outside of i/j-loops
4048      - requires 2D arrays for TB and effConduct
4049      - add 2D iceOrNot to replace HICE_ACTUAL.GT.0, as HICE_ACTUAL is
4050        modified in this routine
4051      - a little bit of clean up, adjusting indentation, etc.
4052      - replaced a few TEN**a by exp(a*log(10.)) in new code for better
4053        performance and '**TWO' by '**2' (because TWO is a float),
4054        replaced ONE, ZERO
4055    o eesupp/src:
4056       fix flow dir for exch1_z_RX_cube, exch1_uv_RX_cube & exch1_bg_RX_cube
4057    o pkg/seaice/seaice_growth.F
4058      Revision 1.89 of seaice_growth.F completes the overall october 2010 revision and
4059      merging process. The merged routine has two branches, and one activates the 'evolution'
4060      branch by setting SEAICE_GROWTH_LEGACY to undef (at the top of the routine for now).
4061      In summary, here is what the '10/10 revision' did consist of
4062        part 1: seaice_growth.F revisions 1.71 to 1.75
4063          - Preliminary seaice_growth.F clean-up, keeping test results strictly unchanged.
4064            The emphasis here was on improving readability (e.g. by trying to use meaningful
4065            variable names) and modularity (e.g. by adding arrays to store heff etc. updates).
4066        part 1.5:
4067          - revising the lab_sea experiment to make it a more useful (i.e. stable
4068            and representative of an actual model run). This was done by generating a
4069            (winter) pickup to start from, switching back the main experiment dynamic
4070            solver from evp to lsr, having one of the experiments use the free drift solution.
4071        part 2: seaice_growth.F revisions 1.76 to 1.85
4072          - Sorting out hard-coded constants that prevented heat and fresh water conservation.
4073          - Sorting out the various fields units and sign (set early on and reset at the end)
4074            to avoid numerous scalings/re-scalings. By v1.85 the basic unit for ice, heat and
4075            fresh water stock is 'effective ice meters', and >0 implies more ice/snow.
4076          - Using tendency terms arrays (d_HEFF* etc.) to alleviate remaining code locks,
4077            and simplifying logical expressions to further improve readibility.
4078        part 3: seaice_growth.F revisions 1.86 to 1.89
4079          - Re-organize the blocks of code more logically.
4080          - Merging the '_if.F' pieces that add something new.
4081    o pkg/thsice:
4082      - vectorize thsice_solve4temp and thsice_get_exf.
4083        Problem: thsice_solve4temp has an unvectorizable statement that
4084        might also be problematic for TAF
4085      - thsice_get_exf: add the ALLOW_BULK_LARGEYEAGER04 CPP-flag. This
4086        does not change the verifcation experiment, but will change all
4087        experiments that have this flag undefined (not tested in verification);
4088        a little reorganization to save a few 2D fields and recomputations
4089      - 1st step of revisiting thsice adjoint (major recomp. sorted out)
4090      - 2nd step:  fix some store dirs
4091        o seems to work somewhat, i.e. using ifort but not g77
4092        o likely cause are incomplete init. or recomputation
4093        o start verification/global_ocean.cs32x15/input_ad.thsice
4094    o pkg/obcs: add support for exch2
4095      - the position of the boundary and prescribed values are specified using
4096        a global domain with exch2 facets stacked
4097        - in x for N,S boundaries (like W2_mapIO=-1)
4098        - in y for E,W boundaries (so E,W boundaries do not overlap)
4099    o pkg/mdsio: add support for writing global sections with exch2
4100        file layout is as for obcs described above:
4101        - for x-z sections, facets are stacked in x (like W2_mapIO=-1)
4102        - for y-z sections, facets are stacked in y
4103    o pkg/thsice:
4104       - change a few routines for better vectorization: thsice_albedo.F,
4105         thsice_step_temp.F, and in thsice_calc_thickn.F. Results are
4106         not affected, but in particular the latter routine has changed
4107         dramatically (not necessarily easier to read now).
4108       - re-arrange calculation in THSICE_SOLVE4TEMP: move outside of i,j loops
4109       iteration loop and call to S/R THSICE_GET_BULKF & THSICE_GET_EXF.
4110    o verification/lab_sea:
4111      - overhaul of the forward model experiments. The main motivation
4112        for this revision is that lab_sea has proven quite fragile (when
4113        changing the sea-ice code, and switching platforms) to a point
4114        when failures were very hard to attribute to specific code problems.
4115      - the suspected reason for this fragility is noise amplification by evp so,
4116        to start with, we decided to replace evp with lsr in the main experiment.
4117      - the input.lsr experiment thus became obsolete and was removed.
4118      - it was replaced with the input.fd experiment that uses an
4119        analytical "free drift" solution as the ice velocity field.
4120      - Taken together, input (lsr), input.fd (free drift) and input.hb87 (evp)
4121        will hopefully allow us to discriminate problems due to dynamic solvers
4122        from problems due to the thermodynamic code. input.salt_plume (lsr) allows
4123        us to test additional options, along with the salt plume package.
4124      - Finally a pickup was generated (at the end of a one year run) to
4125        make the tests more representative of an actual model run. Previously
4126        the tests starting point was a 1m thickness of ice everywhere.
4127    o pkg/seaice:
4128      - introducing S\R seaice_freedrift.F that compute the
4129        analytical solution to an approximate ice momentum
4130        equation (i.e. the simple stress/coriolis balance).
4131      - define SEAICE_ALLOW_FREEDRIFT to trigger the computation
4132        of the free drift velocity field, and enable its use.
4133        To actually use the free drift solution as the model ice
4134        velocity field set SEAICEuseFREEDRIFT to .TRUE. in data.seaice.
4135    o move "useOASIS" from PARAMS.h to EEPARAMS.h and read it from "eedata"
4136    
4137    checkpoint62l (2010/10/04)
4138    o pkg/seaice:
4139      -fix the USE_ORIGINAL_SBI version (for variable freezing point);
4140      -use "celsius2K" in SEAICE_VARIABLE_FREEZING_POINT and in new
4141       version (with USE_ORIGINAL_SBI undef);
4142    o add hooks for new packages OASIS, the package will follow
4143      (hooks exclude the seaice pkg for now)
4144    o pkg/autodiff: ALLOW_AUTODIFF_WHTAPEIO
4145      Option to use mdsio_read_whalos.F/mdsio_write_whalos.F,
4146      rather than mdsio_readvector.F/mdsio_writevector.F, within
4147      adread_adwrite.F to read/write adjoint-related tapes to disk.
4148    o eesupp and pkg/mdsio: ALLOW_WHIO
4149      Option to write/read 2D fields to files including tiles halos.
4150      The main purpose is for adjoint related "tape I/O".
4151      The secondary purpose is for debugging phases.
4152      A word on those rather specifically intended purposes.
4153      The code was meant to be stripped down to the bare minimum.
4154      Typically, there is a unique and basic mapping to the global
4155      buffer (tile by tile, then proc by proc, then level by level), and
4156      byteswaps and meta-files are omitted. Indeed the (*_WH*) code is not
4157      meant to generate user friendly outputs of various shapes and forms.
4158      Rather it is intended, for the knowledgeabale developers,
4159      to be largely independent of the many mdsio options, to allow
4160      outputs of tiles+halos in debugging phases and in adjoint runs,
4161      and to allow some flexibility in tuning (adoint) I/O depending on each
4162      file system behavior. With regard to tuning, most of the potential knobs
4163      (to leave files open, to allocate the I/O indep. of usesinglecpuio,
4164      to specify directories, to specify the typical size of I/O calls, etc.)
4165      are not yet included, and will be added if they prove useful.
4166    o pkg/seaice:
4167       fix uninitialised arrays in USE_ORIGINAL_SBI version of seaice_solve4temp.F
4168    o pkg/seaice:
4169       new S/R seaice_solve4temp.F: this is the merged version of Ian Fenty
4170       code (seaice_budget_ice_if.F) which enable to recover old standard
4171       code (seaice_budget_ice.F) when option USE_ORIGINAL_SBI is defined.
4172       temporary: add "#define USE_ORIGINAL_SBI" at the top of seaice_solve4temp.F.
4173    o model/src (rStar):
4174       use simple average (not area weighted) of rStarFac at U,V point when using
4175       vectorInvariant and selectKEscheme=1,3 (consistent with mom. vertical advection)
4176       update output of exp. fizhi-cs-32x32x40 and fizhi-cs-aqualev20.
4177    
4178    checkpoint62k (2010/09/17)
4179    o adjoint
4180       * changed verification/global_ocean.cs32x15 ; adjoint now tests
4181         Adams-Bashforth 3 + NLFS + RSTAR
4182       * some more modifs required for ECCO-GODAE v4
4183    o pkg/seaice
4184       add SEAICE_AGE_VOL option to use volume instead of area for
4185       integrating SEAICE_AGE
4186  o model/src:  o model/src:
4187     first check-in of sigma & hybrid-sigma coordinate code ; also includes     first check-in of sigma & hybrid-sigma coordinate code ; also includes
4188     non-linear free-surface parts ; but pressure-gradient not yet coded.     non-linear free-surface parts ; but pressure-gradient not yet coded.
# Line 273  o tools/build_options: Line 4452  o tools/build_options:
4452      but keep the former optfile for few weeks for smooth transition      but keep the former optfile for few weeks for smooth transition
4453  o pkg/ecco  o pkg/ecco
4454    - allow user defined cost function contributions    - allow user defined cost function contributions
4455          CPP: ALLOW_USERCOST_CONTRIBUTION       CPP: ALLOW_USERCOST_CONTRIBUTION
4456          USAGE: compute contributions in cost_usercost_all.F       USAGE: compute contributions in cost_usercost_all.F
4457    - note: this is identical to what ALLOW_GENCOST_CONTRIBUTION once was.    - note: this is identical to what ALLOW_GENCOST_CONTRIBUTION once was.
4458        the two options are complementary.        the two options are complementary.
4459  o pkg/smooth  o pkg/smooth

Legend:
Removed from v.1.1295  
changed lines
  Added in v.1.2072

  ViewVC Help
Powered by ViewVC 1.1.22