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

Legend:
Removed from v.1.1286  
changed lines
  Added in v.1.2173

  ViewVC Help
Powered by ViewVC 1.1.22