/[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.1559 by mlosch, Thu Dec 22 12:36:08 2011 UTC revision 1.2194 by jmc, Tue Oct 27 23:59:53 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/atm_compon_interf & ocn_compon_interf:
8      - combine into 1 (new) S/R CPL_EXPORT_IMPORT_DATA the two previous
9        S/R CPL_EXPORT_MY_DATA & CPL_IMPORT_EXTERNAL_DATA
10      - move bi,bj loops inside S/R OCN_STORE_MY_DATA
11    o pkg/atm_ocn_coupler:
12      - initialise to zero ATMVARS.h & OCNVARS.h arrays.
13    o pkg/rbcs:
14      - select RBCS-mask for Temp & Salt the same way as for pTracer ; this allows
15        to compile with maskLEN=1 when all tracers use the same RBCS-mask.
16      - add a short report (to STDOUT) about RBCS-mask settings.
17    
18    checkpoint65p (2015/10/23)
19    o pkg/seaice/seaice_evp.F: fix store directives and key computations, since
20        there is no adjoint test for EVP, we don't know what it does to the adjoint
21        solution, but at least there are no more recomputation warnings left
22    o pkg/seaice/seaice_evp.F: slight modification of averaging so that EVP stands
23        a chance of giving the same results as a fully converged VP (JFNK) solver
24    o tools/adjoint_options/adjoint_diva:
25      - fix bug (typo) in Tang-Linear FLAGS setting for MPI + DIVA
26    o pkg/streamice:
27      - spotted bug in streamice_driving_stress using dyG where should have been dxG
28    o pkg/exf:
29      - remove STOP statement that prevented to use wind or (wind-)stress
30        interpolation for constant-in-time forcing fields (wind/stress period = 0).
31    o pkg/seaice:
32      - replace SEAICE_EVP_USE_ADAPTATION by run time parameters, requires
33        5 additionals 2D fields and 6 new store directives
34      - change logic in seaice_readparms.F: EVP code can now be turned on in
35        various ways, setting SEAICE_deltaTev is no longer required,
36        alternatively set SEAICE_evpAlpha/Beta, SEAICEuseEVPstar, SEAICEuseEVPrev,
37        or SEAICEaEVPcoeff
38    o pkg/shelfice/shelfice_thermodynamics.F
39      - redefining uLoc/vLoc to u/v, instead of 2u/v
40    o pkg/seaice/seaice_evp.F: introduce "adaptive EVP" by Madlen Kimmritz
41      - this is an intermediate state of a truely converging EVP that has
42        the potential of outperforming implicit VP methods, I do not recommend
43        using it yet.
44      - for now, "adaptive EVP" is turned on by setting SEAICE_EVP_USE_ADAPTATION
45        and all parameters are hardwired
46      - for convergence it still requires very smooth regularisations, that means,
47        if SEAICE_DELTA_SMOOTHREG is defined, deltaCreg=deltaC+deltaMin, which is
48        different from the VP case with deltaCreg=sqrt(deltaC**2+deltaMin**2); also
49        specific averaging appears to be required, still subject to tuning
50      - still needs cleaning and I need to turn parameter into runtime parameters
51      - add code to compute and print residuals of iteration, compile with
52        defining ALLOW_SEAICE_EVP_RESIDUAL to enable it
53    o pkg/seaice/seaice_evp.F: fix a bug (factor of four in front of e12Csq)
54      that entered with r1.54 on Sep04, 2015, -> update results
55    
56    checkpoint65o (2015/09/14)
57    o pkg/mom_vecinv & mom_common:
58      - add deep-atmosphere geometry factor in mom_calc_visc.F + in routines
59        called from there.
60      - add anelastic and deep-atmosphere geometry factor in pkg/mom_vecinv ; this
61        allows to use Vector-Invariant form in deep atmos and anelastic formulation
62    o pkg/seaice: introduce fast ice parameterisation following Itkin et al. (2015)
63      and Koenig-Beatty+Holland (2012)
64      - two new parameters SEAICE_tensilFac and SEAICE_tensilDepth
65      - global 2D field tensileStrength, computed in seaice_calc_ice_strength
66      - requires an extra input argument for S/R seaice_calc_viscosities
67      - tensileStrength's depth dependence is different from Itkin et al. (2015)
68        (to be changed and played with, for now exponential)
69    o pkg/seaice: introduce new parameter SEAICEscaleSurfStress (default = .FALSE.)
70      - if TRUE scale ice-ocean and ice-atmosphere stress acting on sea ice
71        by AREA according to Connelly et al. (2004), JPO.
72      - For EVP and the LSR solver, the implicit part of the drag term is
73        the only non-zero term in the denominator when there is no ice (which
74        prevented running the model with zero ice-ocean drag). If
75        SEAICEscaleSurfStress = .TRUE., this results in a division by zero
76        (or zero main diagonals BU/BV) which need to be caught. A practical
77        consequence is that for open water, the momentum equation reduce
78        to trivially 0 = 0 + 0 (for EVP). For LSR, BU/BV are reset to 1, if
79        they happen to be zero, often leading to a non-zero solution over
80        open water.
81    o pkg/seaice: revise EVP code (seaice_evp.F) in preparation for a more
82        efficient EVP method.
83      - introduce area-weighted averages for e12 (analogously to
84        seaice_calc_viscosities.F); this totally changes lab_sea.hb87 (2 digits
85        remain, but also changing the order of terms in the previous average
86        changed the results as much) -> update experiment
87      - add SEAICE_DELTA_SMOOTHREG code
88      - disentangle computation of zetaC/deltaC and zetaZ/deltaZ, also for
89        TEM-code
90      - adjust loop bounds so that only required fields are computed
91      - add new averaging code for zetaZ/deltaZ (again similar to
92        seaice_calc_viscosities.F), inactive by default for now (will change
93        results again), but will replace old code eventually
94    o eesupp/src:
95      - add an other alternative for multi-proc GLOBAL_SUM (in global_sum_tile.F)
96        to always cumulate tile local-sum in the same order
97        (option #define GLOBAL_SUM_ORDER_TILES in CPP_EEOPTIONS.h).
98        Still uses MPI_Allreduce (like standard code) but on array of tiles
99        and should be faster than GLOBAL_SUM_SEND_RECV code.
100      - switch almost all verification experiments that use GLOBAL_SUM_SEND_RECV
101        (defined in CPP_EEOPTIONS.h_mpi) to GLOBAL_SUM_ORDER_TILES instead.
102      - add CPP_EEOPTIONS.h_mpi with GLOBAL_SUM_ORDER_TILES defined in 14 more exp.:
103         aim.5l_cs, cheapAML_box, deep_anelastic, dome, fizhi-cs-32x32x40,
104         fizhi-cs-aqualev20, fizhi-gridalt-hs, global_ocean_ebm, matrix_example,
105         natl_box, solid-body.cs-32x32x1, tutorial_advection_in_gyre,
106         tutorial_baroclinic_gyre and tutorial_held_suarez_cs.
107    
108    checkpoint65n (2015/07/29)
109    o pkg/thsice:
110      - add a warning when used with pkg/aim but without updating SST
111        (stepFwd_oceMxL=F & useCoupler=F & tauRelax_MxL<>-1 ).
112    o pkg/offline:
113      - change where Offline-Fields are loaded, from load_fields_driver.F to
114        directly within FORWARD_STEP, just after updating iter number and time;
115      - move setting of GM and KPP diffusivity out of OFFLINE_FIELDS_LOAD into new
116        S/R OFFLINE_GET_DIFFUS that is called towards the end of DO_OCEANIC_PHYS;
117       These changes allow:
118        a) to recover exactly on-line results using deltaToffline=deltaTClock,
119        tested (using offlineIter0= nIter0 -1 and offlineTimeOffset= -deltaT/2)
120        both with Lin & Non-Lin Free-Surf, both with staggerTimeStep & synchronous
121        time-step, both with GM & KPP files and with recomputing these fields;
122        b) no needs to switch on staggerTimeStep anymore;
123        c) simplify rescaling of offline horiz. velocity with Non-Lin Free-Surf.
124      - update output of experiment tutorial_dic_adjoffline (only 3 digits left).
125    o pkg/offline:
126      - change (rarely used) offset-iteration parameter to an offset time (in s):
127        can easily recover previous offset-iter effect by setting offset-time
128        (offlineTimeOffset) to offset-iter x deltaToffline;
129      - do not turn-off Temp & Salinity surface relaxation when using KPP (used
130        in KPP as part of surface buoyancy forcing) in offline run.
131      - fix ptracers KPP non-local term in the case where KPP is re-computed.
132    o OpenAD
133      - Adding preliminary ggl90 test to OpenAD verification.
134        Config. with ggl90 currently diverges after 64 time steps
135        so will need more work to become more stable
136      - Adding preliminary kpp test to OpenAD verification.
137        required small tweakes in kpp_routines.F
138      - Merge and update from Krishna Narayanan's contrib area:
139        * Add one variable for preliminary OpenAD DIVA
140        * Add replacement time-stepping for OpenAD DIVA
141        * genmake2 flag -diva (but only for OpenAD; preliminary)
142        * required modifs for OAD_support
143        successful preliminary test for tutorial_global_oce_biogeo/
144    o pkg/seaice:
145      - initialise deltaC in seaice_lsr, cosmetic changes in seaice_lsr
146      - add cpp-flag SEAICE_DELTA_SMOOTHREG for option of regularising
147        delta with a smooth function in s/r seaice_calc_viscosity
148        (no effect on EVP)
149      - rename local suffix "sqr" into "sq" for more consistent variable names
150    o pkg/seaice:
151        add new parameter SEAICE_deltaMin that is used ***only***
152        for regularizing Delta (and nothing else, like the parameter
153        which is also used for all sorts of things SEAICE_EPS).
154        Defaults to SEAICE_EPS for backward compatibility only.
155    o pkg/seaice: replace erroneously storing e12Csqr on the wrong tape with
156        the wrong key by inialising it before use -> fixes a recomputation
157        problem but does not fix the gradient
158    o pkg/layers:
159      - move resetting of flux arrays to outside the iLa loop
160        (this caused layers_diapycnal to not work with more than one layer coord.)
161      - fix bug in calculation of layers_recip_delta in layers_init_fixed.F
162    o pkg/layers:
163      - remove from common block 3D layers fields (used to diagnose transport
164        in tracer coords) and declare them as local arrays in layers_calc.F
165    o pkg/seaice:
166      - Rename SEAICE_VECTORIZE_LSR_ZEBRA to SEAICE_LSR_ZEBRA and define it
167        in lab_sea forward experiment (changes results -> updated)
168      - update adjoint experiment lab_sea after cleaning up seaice_lsr_tridiagu/v
169    o pkg/seaice: modify seaice_lsr.F in order to improve the gradient
170       computations; for SEAICE_VECTORIZE_LSR
171      - move the loops over which the tridiagonal solvers (seaice_lsr_tridiagu/v)
172        sweep to the outside,
173      - remove store directives and add "CADJ loop sequential" directives
174        in analogy to model/src/solve_tridiagonal.F
175      - replace many "#ifdef SEAICE_VECTORIZE_LSR_ZEBRA" by variable loop
176        boundaries to yield more readable code. This has also the charming side
177        effect that your can use SEAICE_VECTORIZE_LSR_ZEBRA without
178        SEAICE_VECTORIZE_LSR (i.e. adjoint without recomputations in
179        seaice_lsr_tridiagu/v now requires either of these flags, vectorization
180        still requires SEAICE_VECTORIZE_LSR with SEAICE_VECTORIZE_LSR_ZEBRA as
181        an additional option)
182       The tridiagonal solvers are now completely analoguous to solve_tridiagonal.F
183       but the adjoint gradients (which are affected by this change) still explode.
184    o coupler (atm & ocn _compon_interf):
185      - avoid using Exch2 IO mapping if not suitable.
186    
187    checkpoint65m (2015/06/15)
188    o pkg/layers:
189      - clean-up old parameters setting (from Sep 2012):
190        + remove old parameters setting from common block (declared locally);
191        + stop if any old parameter is mixed with new parameters;
192        + check for valid or consistent parameter setting (e.g., layers_name)
193      - check that layers_bounds for Pot.Density are in the right range;
194        this is supposed to catch un-updated setting after recently shifting
195        potential density field "prho" by -1000 (now in "sigma" scale).
196    o pkg/layers:
197      - Added missing call to layers_fill for keeping track of tottend in
198        pkg/diagnostics/diagnostics_fill_state.F
199    o pkg/layers:
200      - added CPP flux LAYERS_FINEGRID_DIAPYCNAL to disable fine-grid binning
201        of diapycnal fluxes
202    o pkg/layers:
203      - reverted changes to interpolation to previous treatment; there
204        was never actually a problem
205    o pkg/layers:
206      - fix interpolation of layers tracers in the presence of partial cells
207      - add lots of new functionality to compute water mass transformation
208        (enabled by CPP flag LAYERS_THERMODYNAMICS)
209      - add new calls from main code (diags_oceanic_surf_flux.F,
210        thermodynamics.F, impldiff.F) and gad to save the necessary fields
211        for layers_thermodynamics calculations
212    o pkg/ptracers:
213      - add capability of stepping a passive tracer forward without advection
214        by setting PTRACERS_advScheme to 0.
215    o pkg/diagnostics:
216      - add few (threads) _BARRIER around any update of "diag_pkgStatus".
217    o pkg/layers:
218      - shift potential density field "prho" by -1000 for density layer averaging so
219        that it corresponds to usual "sigma" definition (i.e., rho(p=const)-1000);
220        Note that density bin boundaries (layers_bounds in data.layers) have
221        to be set accordingly (i.e., shifted, in sigma scale).
222    o pkg/layers:
223      - fix snap-shot output of layer thickness @ V.pt and output of pot.density
224      - fix calculation of layer non-weighted velocity and layer probability
225      - add diagnostics for pot.density used for layer averaging
226    o pkg/seaice:
227      - seaice_calc_viscosity.F: change computation of deltaC**2 to ensure
228        positiveness, modify a few comments and improve variable names,
229      - the changed computation of deltaC affects most seaice-related
230        experiments at the truncation level.
231        seaice_itd.thermo is affected by far the most, with
232        only 7 digits of agreement remaining; update experiments.
233    
234    checkpoint65l (2015/05/04)
235    o pkg/shelfice:
236      - in shelfice_thermodynamics.F, if SHELFICEBoundaryLayer=.true., then set
237        factor drKp1 to zero where it is negative (ie. do not use
238        SHELFICEBoundaryLayer if hFacC>1)
239      - the same for factor drLoc in shelfice_forcing.F
240    o tools/genmake2: move FEXTRAFLAGS from FFLAGS to FOPTIM to avoid a problem
241        with modules in ptracers, when using testreport option "-small_f"
242    o pkg/seaice/seaice_growth.F (in case of SEAICE_ITD)
243      - replace tmpscal1**1.36 by faster exp(1.36*log(tmpscal1))
244    o verification/testreport
245      - add new option -small_f
246        with this option testreport first makes the target small_f (*.f files)
247        before running make (all). This is useful for explicit inlining when
248        all sources need to be full available.
249    o pkg/exf/exf_interp.F:
250        remove previous changes related to reverse (decreasing) input grids latitude
251    
252    checkpoint65k (2015/04/01)
253    o pkg/ecco:
254        fix missing cosphi initialization; use eccoiter in place of optimcycle;
255        if autodiff is not compiled then use READ_REC_XY_RL/READ_REC_XYZ_RL
256        instead of active read/write
257    o pkg/ctrl:
258        if autodiff is not compiled then use READ_REC_XY_RL/READ_REC_XYZ_RL
259        instead of active read/write.
260    o pkg/autodiff: make autodiff_readparms.F and autodiff_whtapeio_sync.F
261        return if .NOT.useAUTODIFF
262    o pkg/seaice: add CPP brackets (cost function related).
263    o model/src:
264        add useAUTODIFF run time switch.
265    o pkg/exf/exf_interp.F:
266        add code to allow input grids with latitude starting in the north (i.e. when
267        j=1 corresponds to northern edge of field); modify global_with_exf to test
268        this feature.
269    o verification/testreport:
270      - replace "grep -A3" with POSIX conformal sed command, because there are
271        implementations of grep that cannot do contextual searches
272      - replace "cat -n" by "nl" (two occurrences), because not all implementations
273        of "cat" have the option "-n"
274    o model/src:
275        add new file gsw_teos10.F that contains 3 functions, more or less a copy
276        of the gsw_toolbox.f90 of the TEOS-10 fortran interface, that are used to
277        convert from conservative to potential temperature. For now they are not
278        called anywhere.
279    o pkg/ggl90: make "useIDEMIX" useful
280      - re-organize code in s/r ggl90_calc a little to move computations that
281        are different for idemix into separate loops (changes verification
282        experiment idemix at truncation level, 12 digits remain -> updated)
283      - requires 2 new 2D fields KappaM, verticalShear
284      - make hFacI and recip_hFacI local 3D variables that are passed to
285        s/r ggl90_idemix
286      - fix and improve some comments
287    
288    checkpoint65j (2015/02/25)
289    o pkg/openad
290      - synchronize seawater.F with version in model/src: replace routine
291        body of sw_temp by calling sw_ptmp and fix/add a few comments.
292    o pkg/mnc:
293      - change default value of pickup_read/write_mnc params to FALSE
294        (since few features are missing in reading MNC pickup files).
295    o model/src:
296      - change default (background) vertical diffusivity for salt to be the
297        temperature (background) vertical diffusivity.
298      - change background vertical diffusivity in vertical mixing pkgs ggl90,
299        kl10, my82 and pp81 from temperature diffusivity to salinity diffusivity.
300        This makes ptracers default diffusivity (that uses salt diffKr) more
301        consistent with vertical mixing schemes.
302    o verification/testreport:
303      - fix typo in "-pcls" option ;
304      - put temp files in /tmp (instead of in local dir)
305      - add option "-ncad" to use genmake2 new option "-nocat4ad"
306      - allow to use "-j" option (for multi-procs make) for AD, OAD and TLM.
307    o pkg/ggl90 (idemix code):
308      - apply few fixes ; add some missing "_d 0" ; update output of exp.
309        global_ocean.90x40x15.idemix
310    o OpenAD
311      - enable active file I/O and begin removal of work-around code
312        for OpenAD for handling control variables (memory vs. active files)
313      - new CPP options file OPENAD_OPTIONS.h
314      - revert to genarr2d gradient check for hs94.1x64x5
315      - (genarr3d tested by tutorial_global_oce_biogeo, tutorial_tracer_adjsens)
316      - gentim2d works for halfpipe_streamice but not yet hs94.1x64x5
317    o tools/genmake2:
318      - add option for an alternative Makefile (from Martin) where multiple
319        source files are sent to TAF (instead of all in one file).
320    o pkg/ggl90: add IDEMIX (Olbers and Eden, 2013)
321      - code provided by Carsten Eden as an extension of ggl90
322      - so far the code is turned on within ggl90 by setting a CPP-flag at
323        compile time; a runtime flag implementation is not yet complete
324      - tested in new verification experiment global_ocean.90x40x15.idemix
325    o verification:
326      - reduce length of the AD test run by half for experiments
327        global_ocean.cs32x15 (std + thsice) and isomip
328      - enable active file I/O for OpenAD, adjust verifications accordingly
329      - halfpipe_streamice: change gradient check from genarr2d to gentim2d
330    o verification/testreport:
331      - fix two non-POSIX sed statements so that there are no error messages
332        on Mac OS X
333      - replace hostname -s with hostname | sed 's/\..*$//'
334    o model/src/seawater.F:
335      - simplify SW_TEMP to just calling SW_PTMP with P and PR exchanged
336        (following the matlab code), which would have avoided the bug caught
337        by Matt (see below) in the first place
338    o pkg/shelfice:
339      - implement alternative discretisation of quadratic drag (selectBotDragQuadr)
340        and true distance in no-slip BC (bottomVisc_pCell) similar to bottom-drag.
341      - fix sign of friction tendency (no-slip BC) and fix u,v drag for thin
342        ice-shelf case (i.e., within surface level).
343      - add config summary in shelfice_check.F
344      - remove global variable recip_SHELFICElatentHeat and replace by a local
345        variable recip_latentHeat
346      - introduce diagnostics for friction velocity uStar (in case of
347        SHELFICEuseGammaFrict)
348      - change verification experiment isomip.htd:
349        + start from pickup (as input_ad at nIter0=8640)
350        + start from SHELFICEmassFile instead of SHELFICEloadAnomaly file
351        + test SHELFICEuseGammaFrict = .TRUE.
352        + test SHELFICEadvDiffHeatFlux = .TRUE.
353    o model/src:
354      - fix bug (Thanks to Matt) in function SW_TEMP (to convert Pot.Temp to
355        in-situ Temp) and in routine SW_TEMP (in pkg/openad);
356        update output of experiments global_with_exf.yearly and isomip (all 6).
357    o pkg/shelfice:
358      - change setting of kTopC to also be zero where there is no ice-shelf.
359      - zero out surface forcing arrays (for now, for T & S + EmPmR) where
360        ice-shelf is.
361      - first attempt to get RealFreshWaterFlux effects: for now, only without
362        SHELFICEboundaryLayer ; not consistent if using synchronous time-stepping.
363    o pkg/seaice: add the option to prescribe a fixed thickness PDF
364      for thermodynamic calculations
365      - because of divisions of the type 7/7 not exactly equal to 1, this change
366        affects results of some verification experiments by up to 4 digits:
367        global_ocean.cs32x15.seaice, lab_sea, lab_sea.fd, lab_sea.salt_plume,
368        seaice_obcs, seaice_obcs.seaiceSponge, seaice_obcs.tides
369        adjoint: lab_sea, lab_sea.noseaicedyn
370        -> updated
371    
372    checkpoint65i (2015/01/23)
373    o model/src:
374      - change units of frictionHeating field from W to W/m^2
375      - fix bug in frictional heating from stratospheric drag in
376        S/R ATM_PHYS_TENDENCY_APPLY_V
377      - with synchronous time-stepping: move resetting to zero of frictionHeating
378        field from load_fields_driver.F to thermodynamics.F ;
379      - add diagnostics for frictional heating.
380    o model/src & gmredi K3D:
381      - add frictionHeating field to pickup-files (for synchronous time-stepping)
382      - move ALLOW_EDDYPSI block out of DYNVARS.h and merge it into FFIELDS.h
383      - rename uMean,vMean --> uEulerMean,vEulerMean (+ change diagnostics name
384        and name in pickup file).
385      - fix arguments of few DIAGNOSTICS_FILL calls in gmredi_k3d.F
386    o model/src:
387      - move (from ini_forcing.F) initialisation of all arrays in header file
388        FFIELDS.h into new S/R ini_ffields.F ; this fix broken restart
389        (since Nov 2012) with option selectAddFluid=1.
390    o pkg/shelfice:
391      - change units (+ document) of newly added field "shelfIceMassDynTendency"
392      - upgrade from _RS to _RL shelficeMass & shelficeLoadAnomaly arrays.
393    o pkg/obcs: re-organize obcs_calc_stevens.F to prepare for passive tracers
394    o pkg/seaice: two new runtime parameters:
395      - SEAICE_cStar replaces the hard wired "20" in the strength formulation,
396        long overdue
397      - SEAICE_tensilFac: preparation for Koenig-Beatty+Holland (2012)
398        parameterization of tensil stress for fast ice (does not do anything yet)
399    o pkg/seaice/seaice_check.F: left over from restricted addtive Schwarz method
400        for LSR: move checking overlaps out of JFNK-if-block
401    o pkg/atm_phys:
402      - move copy of grid and dynamical fields out of atm_phys_driver.F into
403        new S/R ATM_PHYS_DYN2PHYS.
404      - fix level height for Linear Free-Surf case (to be consistent with
405        fixed-in-time pressure levels).
406    o pkg/mom_common (bottomdrag):
407      - average bottomDragFld (ALLOW_BOTTOMDRAG_CONTROL) from grid-cell center
408        to correct location (U & V point) in S/R MOM_U/V_BOTTOMDRAG;
409        update output (adm & tlm) of experiment global_ocean.90x40x15.bottomdrag.
410    o pkg/shelfice (u/v_drag):
411      - add one argument (the other velocity component) to S/R SHELFICE_U/V_DRAG;
412      - use SHELFICEDragLinear & SHELFICEDragQuadratic in shelfice_v_drag.F
413        (now similar to shelfice_u_drag.F)
414      - remove condition on bottomDragTerms when calling SHELFICE_U/V_DRAG
415        from mom_vecinv.F (similar to mom_fluxform calls).
416    o pkg/mom_common (bottomdrag):
417      - add one argument (the other velocity component) to S/R MOM_U/V_BOTTOMDRAG;
418      - add options for alternative discretisation of velocity norm in quadratic
419        bottom drag: averaging of grid-cell-center KE to U.point and V.point
420        (selectBotDragQuadr=0, original code) can produce noisy patterns; this
421        improves when averaging only the other component (e.g. vVel for U bottom
422        drag) using wet-point method (selectBotDragQuadr=2) or not (=1).
423      - add options (bottomVisc_pCell) to account for partial-cell in bottom
424        friction (no-slip BC) thus getting the true distance from the bottom;
425        off by default since this also reduces model stability (explicit bottom
426        friction). Changes produce different machine truncation with linear-drag
427        + no-slip BC: update output of experiments exp4.stevens (10 digits) and
428        front_relax (bvp & mxl, 10 & 11 digits).
429    o model/src & mom pkgs:
430      - add one more level to vertical viscosity local arrays (Nr+1, previously Nr)
431        since no-slip bottom BC uses viscosity @ k+1 to update velocity @ level k
432      - for now and until vertical mixing scheme are updated to fill up level Nr+1,
433        just copy level Nr value to level Nr+1.
434    o doc:
435      - add notes form Abhisek Chakraborty on how to close Heat & Salt budgets.
436    o pkg/streamice:
437      - shelfice_init_varia.F, shelfice_init_fixed.F, shelfice_readparms.F,
438        SHELFICE.h: move array shelficemass to init_varia, initialise
439        from array shelficemassinit, which is set in init_fixed and
440        has option to be set from file; introduce array
441        shelficeMassDynTend array, set thru file in init_fixed
442      - NEW FILE: shelfice_step_icemass.F: update shelficemass from either
443        shelfIceFreshWaterFlux and shelficeMassDynTend or H_streamice in
444        pkg/streamice
445      - shelfice_thermodynamics.F: call shelfice_step_icemass if
446        SHELFICEMassStepping = .true.
447      - shelfice_ad_diff.list: add new subroutine shelfice_step_icemass.f
448    
449    checkpoint65h (2014/12/17)
450    o verification/global_ocean.90x40x15, global_ocean_ebm:
451      - update to generic controls.
452    o pkg/ctrl:
453      - ctrl_map_ini_genarr.F: test for igen>0
454      - ctrl_init_variables.F: add call to CTRL_MAP_INI_GENTIM2D.
455      - move gentim2d part of ctrl_map_ini_genarr.F to
456        new separate routine : ctrl_map_ini_gentim2d.F
457      - ctrl_cost_driver.F,ctrl_init.F ctrl_map_ini_genarr.F:
458        add time variable weights and cyclic controls (time mean,
459        seasonal cycle, etc) capabilities to gentim2d
460    o pkg/ecco:
461      - move reading of error, conversion to weights from
462        ecco_cost_init_fixed.F to ecco_toolbox.F (ecco_readwei)
463    o global_oce_llc90, cs32:
464      - activte sbo.
465      - CTRL_SIZE.h : add maxCtrlProc.
466      - activate the new genctrl capabilities.
467      - update following reorganization of global_oce_input_fields.tar.gz  
468    o pkg/ctrl/ctrl_ad_diff.list:
469      - add missing ctrl_init_rec.f
470    o tools/OAD_support/keepOriginal:
471      - add ctrl_init_rec.F
472    o model/src/the_main_loop.F, pkg/ctrl/ctrl_map_ini_genarr.F:
473      - avoid recomputations of xx_gentim2d_dummy.
474    o momentum diagnostics:
475      - move filling of diagnostics Um_Diss & Vm_Diss from mom_fluxform.F and
476        mom_vecinv.F to timestep.F (to include Smag-3D contribution).
477    o pkg/seaice/seaice_lsr.F:
478      - fix computation of BU/BV, make sure they are non-zero, only necessary
479        for cubed sphere exchanges and SEAICE_OLx/y>0.
480        This makes calling s/r fill_cs_corner_rl obsolete (removed).
481    o verification/global_ocean.cs32x15/input.seaice
482      - add test for strong implicit coupling and restricted addtive Schwarz
483        methods for LSR
484      - update results/output.seaice.txt
485    o verification/tutorial_global_oce_biogeo:
486      - AD & OAD set-up: switch off ALLOW_OLD_VIRTUALFLUX (like in fwd set-up)
487        and set PTRACERS_EvPrRn(1,2) to zero (for DIC & ALK);
488        update output_adm,_oadm,_tlm.txt
489    o pkg/dic:
490      - change default to "#undef ALLOW_OLD_VIRTUALFLUX" in DIC_OPTIONS.h
491      - add a stop when ALLOW_OLD_VIRTUALFLUX is defined and PTRACERS_EvPrRn
492        for tracer 1 & 2 is set (to avoid double counting of dilution effect).
493    o verification/tutorial_global_oce_biogeo:
494      - AD & OAD set-up: do not set PTRACERS_EvPrRn for tracer 1 & 2 since
495        dilution is already added by pkg/dic ALLOW_OLD_VIRTUALFLUX ;
496        update output_adm,_oadm,_tlm.txt
497    o eesupp/src:
498      - add fill_cs_corner_rl.F (_RL-copy of fill_cs_corner_rs.F)
499        and call it in seaice_lsr when using nonzero SEAICE_OLx/y
500    o pkg/seaice: introduce strongly implicit coupling, intended for stabilizing
501      LSR (following Hutchings et al. 2004)
502      - introduce zetaZ as a global variable (requires adjustments in
503        seaice_evp.F and seaice_jfnk.F) and compute analoguously to etaZ
504        in seaice_calc_viscosities.F
505      - new flag SEAICEuseStrImpCpl (default off)
506      - add new terms zetaZ*du/dy and zetaZ*dv/dx on both sides of the
507        momentum equations
508      - JFNK-solver (preconditioner) adjusted to allow using this method
509        (where it does not have any positive effect)
510    o pkg/seaice
511      - add overlap for restrictive additive Schwartz method also to LSR, but
512        turn it off by default (because it only seems to work for non-cubed
513        sphere/llc topologies)
514    o pkg/autodiff
515      - add extra exchanges in addummy_in_steppging also for mnc output
516    o pkg/seaice:
517      - add extra exchanges before dumping adjoint fields in seaice_ad_dump.F
518        to avoid stripes in the adjoint output (similar to addummy_in_stepping.F)
519    o pkg/obcs:
520      - add option to specify domain-connected piece Id along OB though files
521        (for now, only used to diagnose PhiVel; default =1 -> global correction)
522      - modify obcs_diag_balance.F to process each connected-part separately;
523        exclude OB where Id = 0 but keep the full divergence there (-> constant
524        Psi along this portion of OB and all inflow derived from grad(Phi))
525      - add example of OB-conect files in verification/so_box_biogeo/input.
526    o pkg/diagnostics:
527      - improve treatment of Open-Boundaries in Velocity-Potential calculation:
528      a) use non zero matrix element across OB and solve for Phi 1 grid point
529         outside OB (i.e, where tracer OBCS are applied).
530      b) global imbalance of inFlow/outFlow across OB: instead of modifying
531         velocity across OB, spread it uniformly along the OB in the RHS.
532    
533    checkpoint65g (2014/11/19)
534    o pkg/diagnostcis:
535      - add preconditioner off-diagonal factor (diagCG_pcOffDFac) as run-time param
536    o pkg/my82,pp81,kl10:
537      - fix ALLOW_3D_DIFFKR implementation (previously had no effect): use 3-D
538        field diffKr as background diffusivity to set minimum diffusivity value.
539    o pkg/seaice:
540      - add new parameter SEAICEuseEVPrev (for revisited EVP by
541        Bouillon et al 2013)
542      - add SEAICE_evpAlpha/Beta to namelist
543      - modify seaice_evp code to able to use SEAICEuseEVPrev. These changes
544        involve trivial re-ordering of divisions/multiplications that should not
545        have any effects, but ... they do change the results of lab_sea.hb87 so
546        that only 2 digits of agreement remain, in line with the general
547        instability/fragility of the evp-code. For now, I do not care and just
548        update the verification experiment
549    o pkg/ctrl : add generic pre-processing (xx_genarr2d_preproc etc)
550      - remove xx_genarr2d_numsmooth etc
551      - use xx_genarr2d_preproc etc instead
552      - carry out smooth_correl2D at initialization stage rather than during
553        time stepping.
554      - get smoothOpNb from xx_gentim2d_preproc
555    o global_oce_cs32 :
556      - add test of generic ecco capabilities.
557    o pkg/exf/exf_getsurfacefluxes.F :
558      - add to tmpUE/tmpVN rather than re-initializing them (conventional behavior).
559    o pkg/ctrl,ecco :
560      - omit un-necessary arguments to ctrl_cost_gen.F unless ECCO_CTRL_DEPRECATED
561        is defined.
562    o pkg/seaice: add diagnostics for Delta (deformation parameter)
563    o model/src:
564      - when ALLOW_3D_DIFFKR is defined, add a Warning if any of the vertical
565        diffusivity (background) is specified but ignored.
566    o verification:
567      - in testreport, convert hostname to lower case for default output dir name
568    o model, pkg : add useCTRL, useECCO parameters (on/off run time switch).
569    o pkg/dic: add modifications from Hajoon:
570      - add iron sedimentation flux function of the flux of PO4 out of bottom layer
571      - light attenuation: add self-shading effect by climatological Chlorophyll
572        (read from file).
573    o pkg/seaice/seaice_preconditioner.F : fix cpp flags, so that code also
574        compiles when SEAICE_ALLOW_DYNAMICS is undefined
575    o global_oce_llc90,cs32 : ecco_v4 verification exps now use separate
576        AUTODIFF_OPTIONS.h, CTRL_OPTIONS.h, ECCO_OPTIONS.h rather than
577        ECCO_CPPOPTIONS.h (i.e. replacing the deprecated, circumvoluted,
578        approach where CPP_OPTIONS.h includes an omnipotent
579        ECCO_CPPOPTIONS.h that superseeds pkgs '_OPTIONS.h').
580    o pkg/ctrl/ctrl_map_ini_genarr.F : include GMREDI_OPTIONS.h where
581        ALLOW_3D_KAPGM, ALLOW_3D_KAPREDI (to be added later) belong.
582    o pkg/seaice/SEAICE_SIZE.h : replace ALLOW_AUTODIFF_TAMC with ALLOW_AUTODIFF
583        to avoid needing AUTODIFF_OPTIONS.h anytime SEAICE_SIZE.h is included
584        (it seems that THSICE_SIZE.h, PTRACERS_SIZE.h have the same issue...)
585    o model/src, pkg/smooth, profiles, salt_plume, seaice, exf, ecco, ctrl :
586      add ECCO_OPTIONS.h, AUTODIFF_OPTIONS.h, CTRL_OPTIONS.h when needed
587      - ECCO_OPTIONS.h is needed when including ecco_cost.h, ecco.h
588      - AUTODIFF_OPTIONS.h is needed when including tamc.h, tamc_keys.h
589      - CTRL_OPTIONS.h is needed when including ctrl.h, optim.h, etc
590    o pkg/ctrl,ecco,exf :
591      - remove variables associated with NON-generic costs,
592        unless ECCO_CTRL_DEPRECATED is defined.
593      - remove NON-generic NON-obcs controls,
594        unless ECCO_CTRL_DEPRECATED is defined.
595    o pkg/ctrl : added ctrl_local_params.h
596    o pkg/ecco : added ecco_local_params.h
597    o verification : added ECCO_CTRL_DEPRECATED to most as and oad
598        experiments, which will progressively be removed once the
599        experiments are revised to use only generic controls/costs.
600    
601    checkpoint65f (2014/10/13)
602    o pkg/ctrl, ecco, seaice : minor changes in headers
603    o global_oce_llc90,cs32 : ecco_v4 verification exps now test generic
604        cost function and control capabilities added since checkpoint65c.
605    o pkg/ctrl: regroup all obcs ctrl variables in CTRL_OBCS.h.
606    o pkg/ecco: increase modularity and improve logic
607      - ecco_toolbox.F (new) : basic operations that are often used,
608        including ecco_zero, ecco_cp, ecco_cprsrl, ecco_diffmsk,
609        ecco_addcost, ecco_add, ecco_div, ecco_readbar.
610      - cost_gencal.F (new) : determine filnames and records.
611      - cost_genread.F, cost_generic.F : condense code using ecco_toolbox.
612      - cost_generic.F : use spzeroloc rather than hard-coded -9999,
613        and exploit the above functions leading to more compact code.
614      - cost_genread.F : rm un-necessary arguments, re-arrange args order.
615      - ecco_check.F, ecco_readparms.F : bring logic up to date (using_tpj,
616        using_ers, using_gfo, using_mdt is now only defined within gencost)
617    o pkg/ecco: extend generic cost capabilities
618      - pkg/ecco : added 3D gencost (ALLOW_GENCOST3D), added gencost
619        capabilities via gencost_preproc (+ _c,_i,_r related params),
620        gencost_posproc (+ _c,_i,_r related params), gencost_nrecperiod,
621        gencost_outputlevel arguments to cost_generic
622      - pkg/ecco/cost_genread.F (new) : interface between cost_generic
623        and active_read, making room for gencost_preproc to take effect.
624        Added preproc code ('climmon') to replace GENERIC_BAR_MONTH.
625      - pkg/ecco/cost_generic.F :
626        compute and store misfit maks*(model-data) in localdif that is
627        then used in cost and for output, output misfit if outlev.GT.0
628      - pkg/ecco/cost_averagesfields.F : depend on gencost_barskip
629        rather gencost_barfile for deciding whether to write barfile
630      - pkg/ecco/ecco_cost_driver.F : extract call to cost_profiles from cost_hyd
631      - pkg/ecco/ecco_cost_init_fixed.F : extract gencost weights from
632        ecco_cost_weights, re-activate ecco_summary, determine gencost_barskip
633      - pkg/ecco/ecco_summary.F : report gencost variables
634      - pkg/ecco/cost_gencost_customize.F : treat case of scatterometer costs
635    o pkg/sea/SEAICE_OPTIONS.h : add ALLOW_COST_ICE, ALLOW_SEAICE_COST_SMR_AREA
636    o pkg/ecco: internal re-organization
637      - resolve un-necessary dependancies within pkg/ecco and to pkg/ctrl
638        (rm includes of optim.h and ctrl.h, replace optimcycle with eccoiter,
639        mv relevant variables definition from ecco_cost.h to ecco.h,
640        make sure gencost routines only include ecco.h)
641      - throughout : add missing CCP switches, rm unused variables,
642        and rm un-necessary CPP switches
643      - throughout gencost routines : replace modelstartdate with
644        gencost_startdate when needed
645      - cost_bp_read.F : use arguments, instead of common blocs
646        so that it can be used also by (new) cost_gencost_bpv4.F
647      - ecco_init_varia.F : initialize RHOsumGlob_0, VOLsumGlob_0
648      - ecco_phys.F : compute etanFull
649      - ecco_readparms.F : rename using_topex as using_tpj, add
650        bpv4-grace to gencost list, initialize added parameters
651      - ecco_summary.F : include SIZE.h needed for augmented ecco.h
652    
653    checkpoint65e (2014/09/28)
654    o pkg/obcs:
655      - replaced the just-added CPP options with run-time variables
656        (see pkg/obcs/OBCS_PARAMS.h for details)
657    o pkg/obcs:
658      - add additional CPP options for sponge boundary layers
659        (see pkg/obcs/OBCS_OPTIONS.h for details)
660    o pkg/atm_phys:
661      - implement simple (obliquity only, assuming circular planet orbit)
662        seasonal cycle for incoming insolation ; used when run-time parameter
663        "select_incSW" is set to 1 ; by default (=0), uses old unchanged formula.
664    o pkg/exf, pkg/ecco, pkg/ctrl:
665      - add ctrlUseGen and .NOT.ctrlUseGen exclusive brackets
666      - activate gentim2d for xx_atemp,xx_aqh,xx_swdown,xx_lwdown,xx_precip
667      - implement gentim2d for xx_tauu, xx_tauv
668    o pkg/ctrl, pkg/ecco :
669      - fix and complement the generic controls implementation
670    o pkg/exf/exf_getclim.F, exf_getffields.F, exf_getsurfacefluxes.F,
671        pkg/shelfice/shelfice_thermodynamics.F,
672        verification/hs94.1x64x5/code_ad/ctrl_map_gentim2d.F,
673        verification/hs94.1x64x5/code_oad/ctrl_map_gentim2d.F :
674      - add weight in CTRL_GET_GEN calls
675    o pkg/ctrl :
676      - ctrl_get_gen.F : add weight as input parameter, and apply
677        it directly rather than using smooth_correl2Dw (to be retired).
678      - ctrl_map_gentim2d.F : add wgentim2d in CTRL_GET_GEN call
679    o pkg/ctrl :
680      - introduce run time switch ctrlUseGen (in ctrl.h, ctrl_check.F,
681        ctrl_init_variables.F, ctrl_readparms.F, ctrl_summary.F)
682      - re-activate ctrl_summary (call in ctrl_init.F)
683    o pkg/ctrl/ctrl_cost_gen.F :
684      - fix CCP brackets, remove un-necessary myiter, mytime
685    o pkg/ecco, pkg/ctrl :
686      - remove cost_genctrl.F (now pkg/ctrl/ctrl_cost_driver.F)
687      - remove cost_forcing_gen.F (now pkg/ctrl/ctrl_cost_gen2d.F)
688      - add ctrl_cost_driver.F (replaces pkg/ecco/cost_genctrl.F)
689      - add ctrl_cost_gen2d.F (replaces pkg/ecco/cost_forcing_gen.F)
690    
691    checkpoint65d (2014/09/15)
692    o pkg/ctrl/CTRL_GENARR.h, ctrl_readparms.F :
693      - add xx_genarr2d_bounds,xx_genarr3d_bounds,
694        xx_genarr2d_numsmooth, xx_genarr3d_numsmooth
695    o pkg/ctrl/ctrl_map_ini_genarr.F :
696      - remove compilation failure
697      - replace hard coded example
698      - use ctrl_map_ini_gen2D, 3D
699    o pkg/ctrl/ctrl_pack.F, ctrl_unpack.F :
700      - on/off switch based upon xx_genarr2d_weight,3d
701    o src/packages_init_variables.F :
702      - regroup pkg/estimation calls
703      - remove CTRL_MAP_INI, CTRL_MAP_INI_ECCO
704        (moved to ctrl_init_variables)
705    o cost/cost_init_varia.F :
706      - remove ecco_cost_init_varia
707        (moved to ecco_init_varia)
708    o ctrl/ctrl_init_variables.F :
709      - add CTRL_MAP_INI, CTRL_MAP_INI_ECCO
710      - add CTRL_MAP_INI_GENARR, SEAICE_CTRL_MAP_INI
711    o ctrl/ctrl_map_ini.F :
712      - remove ctrl_map_ini_genarr, seaice_ctrl_map_ini
713        (moved to ctrl_init_variables)
714    o ctrl/ctrl_map_ini_ecco.F :
715      - remove ECCO_PHYS (mv to ecco_init_varia)
716      - remove seaice_ctrl_map_ini (mv to ctrl_init_variables)
717    o ecco/ecco_ad_diff.list :
718      - add ecco_init_varia.f
719    o ecco/ecco_init_varia.F
720      - new routine
721    o pkg/streamice:
722      - move call to STREAMICE_INITIALIZE_PETSC from the_model_main.F
723        to streamice_init_fixed.F ; fix setting of STREAMICEisOn.
724      - from model/src, only call pkg/streamice routines if useStreamIce is TRUE.
725    o pkg/generic_advdiff:
726      - fix bug causing negatives in GAD_SMOLARKIEWICZ_HACK, introduced 8/8/2014.
727    o pkg/exf:
728      - exf_getffields.F : add xxg_atemp, xxg_aqh, xxg_swdown, xxg_lwdown,
729         xxg_precip capability
730      - exf_wind.F : no need for ALLOW_WSPEED_CONTROL cpp switch
731    o pkg/ctrl:
732      - ctrl_pack.F, ctrl_unpack.F : omit (un)packing of undefined xx_gentim2d
733    o model/src/load_fields_driver.F :
734      - move call to CTRL_MAP_GENTIM2D ahead of BULKF_FIELDS_LOAD, EXF_GETFORCING
735        so xx_gentim2d can be applied to e.g. exf fields in a timely manner.
736    o OpenAD verification experiments:
737      - Include explicitly AUTODIFF_OPTIONS.h, COST_OPTIONS.h, and CTRL_OPTIONS.h
738        in src files (to enable to skip the ECCO_CPPOPTIONS.h);
739        for now, only in pkgs used in OpenAD verification experiments.
740      - Change all except one (halfpipe_streamice) OpenAD experiments to use pkg
741        specific option file (AUTODIFF_OPTIONS.h, COST_OPTIONS.h & CTRL_OPTIONS.h)
742        instead of using ECCO_CPPOPTIONS.h (with all relevant options in it).
743        This applies to both TAF (*/code_ad/) and OpenAD (*/code_oad/) tests.
744    o OpenAD verification tests:
745      - finish removing ALLOW_AUTODIFF_OPENAD (replaced by ALLOW_OPENAD);
746      - finish replacing ALLOW_AUTODIFF_TAMC by ALLOW_AUTODIFF (except for
747        tape/storage which are specific to TAF/TAMC) in pkgs used in OpenAD exp.
748      - leave ALLOW_AUTODIFF_TAMC undef in OpenAD verification tests (*/code_oad/)
749        and remove local copy of "tamc.h" (needed only if ALLOW_AUTODIFF_TAMC).
750    o model/src & generic_advdiff:
751      - change hard-coded loop-range in S/R APPLY_FORCING_T/S to set T & S
752        forcing over 0:sNx+1, 0:sNy=1 (instead of just 1:sNx,1:sNy): Model
753        dynamics requires valid tracer forcing only over tile interior but, for
754        some diagnostics, may need to extend it over 1 point in tile halo region.
755      - in gad_calc_rhs.F, update calls to gmredi_x/ytransport to get valid
756        tendency over i,j_Min,Max range. This allows to simplfy i,j_Min,Max
757        setting in temp/salt/ptracer_integrate.F
758    o pkg/dic:
759      - multiply tracer tendencies by maskInC (if ussing OBCS) before updating
760        gchem tracers: this allows to skip the 2nd call to OBCS_APPLY_PTRACER
761        in gchem_forcing_sep.F
762    o pkg/autodiff & obcs:
763      - add storage of current OB values for U & V (was already done for T & S).
764    
765    checkpoint65c (2014/08/30)
766    o pkg/dic:
767      - take out of dic_atmos.F the initialisation part (corresponding to istate=0)
768        and move it to new S/R DIC_INI_ATMOS ; also simplify the dependencies for
769        AD compilers (but still a Pb with multi-threading and Ajoint dependencies).
770    o verification:
771      - new experiment testing OBCS and DIC pkgs, using params & output from
772        tutorial_global_oce_biogeo but limited to a sub-domain around Drake
773        passage: take OBCS from the last year of a 2 yrs simulation and initial
774        conditions from t=1.yr while keeping the same forcing.
775    o model/src:
776      - when allowFreezing=T, only reset below freezing initial Temp to Tfreezing
777        (at any k) if checkIniTemp is not set to FALSE (default checkIniTemp=T).
778    o pkg/diagnostics (Stats-Diags):
779      - re-write S/R DIAGSTATS_CALC (more similar to TARGET_NEC_SX part) to:
780        a) refine region where stats are computed, excluding where arrhFac=0 ;
781        b) fix missing interior mask (use with OBCS) in 3-D fields statistics;
782        c) extend regional stats over the region edges (for U or V pt location).
783    o pkg/gchem:
784      - add a (2nd) call to OBCS_APPLY_PTRACER in gchem_forcing_sep.F (needed since
785        pkg/dic is currently changing/updating ptracers values beyond the OB).
786    o verification (hs94):
787      - convert Held & Suarez external_forcing.F (from hs94.cs, with Sigma-coords
788        bits) to apply_forcing.F and undef USE_OLD_EXTERNAL_FORCING in experiments
789        hs94.cs-32x32x5 and tutorial_held_suarez_cs ; also use the same version of
790        apply_forcing.F in 2D hs94 (fwd, ad & oad) but keep LatLon hs94 unchanged.
791    o pkg/ptracers:
792      - implement Adams-Bashforth on pTracers (instead of on tracer tendency),
793        switched on by setting PTRACERS_doAB_onGpTr=F (default set to doAB_onGtGs)
794      - change exp4 secondary test (input.nlfs) to test AB on T & S & pTracer
795        with AB-2 code (so that it get tested).
796    o model/src:
797      - allow to apply Adams-Bashforth on Temp & Salt (instead of on gT,gS)
798        with AB-2 code (previously only available with AB-3 code).
799        Also move the code (call to ADAMS_BASHFORTH S/R) form thermodynamics.F
800        to temp/salt_integrate.F (since the 2nd part of gt/sNm1 update is done
801        there, by calling CYCLE_AB_TRACER).
802    o pkg/generic_advdiff:
803      - change Tracer argument (drop bi,bj indices) in S/R GAD_CALC_RHS,
804        GAD_C2_ADV_R, GAD_U3_ADV_R, GAD_C4_ADV_R, GAD_DIFF_R, GAD_BIHARM_R
805        + also in GMREDI_X/Y/RTRANSPORT ; and update corresponding calls in
806        S/R temp/salt/ptracers_integrate.F
807    o model/src & pkg/ptracers:
808      - remove common block variables gT,gS (in DYNVARS.h), except when
809         USE_OLD_EXTERNAL_FORCING is defined; update TAF storage accordingly.
810      - remove common block variable gPtr.
811    o model/src & pkgs:
812      - change gTracer (and/or tracer) argument (drop bi,bj indices) in S/R
813         ADAMS_BASHFORTH(2&3), CYCLE_(AB_)TRACER, FREESURF_RESCALE_G,
814         IMPLDIFF, SOLVE_TRIDIAGONAL & _PENTADIAGONAL, GAD_SOM_ADVECT,
815         GAD_ADVECTION, GAD_CALC_RHS, GAD_IMPLICIT_R, TIMEAVE_CUMUL_DIF_1T
816      + change accordingly all calling S/R.
817      - use local temperature/salinity/ptracer tendency array (without bi,bj)
818        in S/R temp/salt/ptracers_integrate.F
819    o pkg/seaice:
820      - move computation of stress contributions to rhsU/V in s/r seaice_lsr
821        to separate s/r seaice_lsr_rhsu/v in order to be able to re-use code
822      - make u/vIceC local variables if SEAICE_CGRID is defined only to be used
823        in seaice_lsr
824      - seaice_lsr.F: make local 4D arrays UXX, VYY, etc 2D
825        in s/r seaice_lsr_calc_coeffs
826    o pkg/mdsio:
827      - in MDS_READ/WRITE_FIELD, stop if file-name (+prefix) is too long
828        (e.g., > MAX_LEN_MBUF -90 ) or, in INI_MODEL_IO, if mdsioLocalDir is
829        too long (e.g., > MAX_LEN_FNAM/2 )
830    
831    checkpoint65b (2014/08/12)
832    o pkg/matrix:
833      - pass, as argument, updated tracer field to S/R MATRIX_STORE_TENDENCY_EXP
834    o model/src:
835      - fix initialisation of geothermalFile; compile geothermal-flux code in
836        natl_box verification experiment.
837    o model/src & pkg/down_slope:
838      - push the k loop inside S/R TIMESTEP_TRACER (now called outside the k loop).
839      - in dwnslp_apply.F, update tracer tendency instead of the future tracer
840        field and call S/R DWNSLP_APPLY before TIMESTEP_TRACER; this affects
841        results at machine truncation level: update output of experiments
842        global_ocean.90x40x15.dwnslp (FWD) and lab_sea.noseaicedyn (AD).
843    o pkg/diagnostics (Stats-Diags):
844      - do not cumulate the full volume when DIAGNOSTICS_FILL is
845        called with bibjFlg < 0 (no increment of the counter for 2D/3D diag);
846        This fix the mean statistics when DIAGNOSTICS_FILL is called multiple
847        times (but Min,Max and StD are still wrong).
848    o model/src:
849      - add geothermal flux forcing: read in ini_forcing.F as time-constant
850        field "geothermalFlux" applied in S/R APPLY_FORCING_T (apply_forcing.F)
851    o model/src:
852      - move CYCLE_TRACER calls from tracers_correction_step.F to temp/salt/ptracer
853        _integrate.F so that, when leaving S/R THERMODYANMICS, theta,salt and pTrac
854        arrays are already updated while adjustments (filters, conv.adjustment) are
855        still applied later, in S/R TRACERS_CORRECTION_STEP.
856    o model/src:
857      - store in common bloc array "rhoInSitu" the virtual potential temperature
858        anomaly that is used to compute geopotential: this make the atmos code
859        more similar to ocean code which already uses rhoInSitu in calc_phi_hyd.F
860    o pkg/seaice/seaice_lsr.F
861      - rename integer variable ilcall to ipass (that's what it is called
862        in the residual diagnostics
863      - change time stepping for NPSEUDOTIMESTEP > 2 (does not change the
864        default) for improved non-linear convergence of the first few steps
865      - adjust a few comments and add new ones to explain some of the store
866        directives
867    o pkg/generic_advdiff (& ptracers):
868      - re-work the code to check for valid advection scheme and for minimum
869        size of overlap (now stored in local common bloc in gad_advscheme.F)
870    o pkg/seaice: another attempt to make the adjoint work for sea ice dynamics
871      - re-initialize more variables in seaice_lsr: u/vIceC, u/vIceNm1
872      - add an auxilliary variable "bet" and fix store directives and keys in
873        seaice_lsr_tridiagu/v, this seems to do the trick (i.e. more or
874        less exact gradients in my tests); but there are still
875        recomputation warning (although gradients are sort of OK), when
876        SEAICE_LSR_VECTORIZE is not defined, so this flag and
877        SEAICE_LSR_VECTORIZE_ZEBRA are recommended for efficiency.
878      - update verification experiments lab_sea.
879      - change some comments in S/R seaice_calc_viscosities
880    o model/src:
881      - if staggerTimeStep=T, always apply exchange to velocity field in
882        do_stagger_fields_exchanges.F instead of in do_fields_blocking_exchanges.F
883        (independent of using multi-dim advection or not); no effect on FWD run
884        but affects AD results (at machine truncation level): update output of
885        experiment 1D_ocean_ice_column (ad: 12 digits), hs94.1x64x5 (ad,oad: 13.d)
886        and isomip (oad: 12.d).
887    o pkg/generic_advdiff:
888      - stop if doAB_onGtGs is set to FALSE but ignored
889      - refine warning related to stability of tracer time-stepping
890        regarding internal wave dynamics.
891      - setting of AdamsBashforth_T,S when doAB_onGtGs=F: remove condition
892        on staggerTimeStep & implicitIntGravWave (will now get a warning
893        if potentially unstable).
894    o pkg/kl10:
895      - add new pkg "kl10" for mixing due to internal wave breaking, from
896        http://www.sciencedirect.com/science/article/pii/S1463500310000144
897        (contribution from Jody Klymak), tested in verification experiment
898        verification/internal_wave/input.kl10/
899    o isomip experiment:
900      - test pkg/shelfice with Non-Lin Free-Surf in one of the FWD set-up
901        (input.htd) and update the output.
902    o cd_code experiments:
903      - use default cd_code options (#undef CD_CODE_NO_AB_MOMENTUM &
904        #undef CD_CODE_NO_AB_CORIOLIS) in experiments: cfc_example (fwd)
905        global_ocean.90x40x15 (ad & oad) and OpenAD (ad & oad) and
906        update the corresponding output.
907    o pkg/seaice:
908      - reduce the number of include files and store directives in
909        S/R seaice_lsr_tridiagu/v
910      - change the order of loops in one case in S/R seaice_lsr_tridiagv
911        (only for SEAICE_VECTORIZE_LSR_ZEBRA defined), which allows me to
912        get rid off one store directive (a TAF bug?)
913      - add one more instance of ifdef SEAICE_VECTORIZE_LSR_ZEBRA in
914        S/R seaice_lsr_tridiagv to change the loop range for consistency
915      - remove ilcall, m from parameter list of S/R seaice_lsr_tridiagu/v
916      - fix a bug that affects the JFNK solver: replace sNx/y by i/jMax in
917        S/R seaice_lsr_tridiagu/v (requires update of
918        offline_exf_seaice/input.dyn_jfnk)
919    
920    checkpoint65a (2014/07/27)
921    o model/src:
922      - Non-Lin Free-Surf in p/z coords: allows hFacW,S to be larger than
923        surrounding hFacC=1 @ edge of a step with different kSurfC on either side
924        (topo in p-coords, ice-shelf in z-coords); update output of experiments
925        tutorial_global_oce_in_p and isomip (both AD and OpenAD output).
926    o model/src:
927      - collect momentum forcing tendency into local 2-D array (passed as argument
928        to apply_forcing S/R); this simplifies mom. Forcing diagnostics and CD_CODE
929        parts in timestep.F (without CD_CODE_NO_AB_MOMENTUM defined = the default);
930        affects results at machine truncation level (e.g., if using OBCS_SPONGE).
931      - collect T & S forcing tendency into local 2-D array (passed as argument to
932        apply_forcing S/R); add 3-D diagnostics for temp & salt forcing tendency.
933        affects results at machine truncation level (e.g., ocean: if using
934        SHORTWAVE_HEATING ; atmos: if using FrictionHeating or (atm_Rq<>0) moist
935        correction due to vertical advection).
936      - update output of experiments: fizhi-cs-32x32x40 (13 digits),
937        global_ocean.cs32x15 (fwd: icedyn, seaice, thsice, all 3 @ 11d; adm & tml:
938        seaice_dynmix & thsice, fwd grd @ 3 & 8), hs94.1x64x5 (ad grd @ 13),
939        obcs_ctrl (ad & fwd grd @ 12 & 7).
940    o pkg/ptracers & diagnostics:
941      - use ptracers (short) name (instead of long one) to make ptracers diagnostics
942        title (to avoid some unexpected truncation); sort out ptracers diags units.
943      - collect ptracer forcing tendency into local 2-D array (passed as argument
944        to apply_forcing S/R); add 3-D diagnostics for ptracers forcing tendency.
945    
946    checkpoint65 (2014/07/18)
947    o pkg/fizhi:
948      - add parenthesis around fizhi tendencies in fizhi_tendency_apply.F: this
949        affects results at machine truncation level. Update output of experiments
950        fizhi-cs-32x32x40 (12 digits for cg2d) & fizhi-cs-aqualev20 (13 digits).
951    o pkg/seaice: more clean up
952      - rename TAF common block tapes to be more consistent and remove
953        unnecessary duplicates
954      - add store directives to remove more recomputations, but use smaller
955        tapes (and adjust keys) when SEAICE_LSR_ADJOINT_ITER is undefined.
956        The idea behind this flag is to reduce the memory footprint when the
957        adjoint of the LSR is not required. As of now, defining the flag
958        SEAICE_LSR_ADJOINT_ITER increases 4 common block tapes for 2D field by
959        a factor of SOLV_MAX_FIXED (=500 by default in SEAICE_SIZE.h).
960        For experiment offline_exf_seaice, this means on a linux box with gfortran
961        nearly a factor of 10 (but keep in mind there is mostly seaice code in
962        this experiment):
963        > size mitgcmuv_ad
964        text    data        bss     dec        hex
965        5100659 1216  220458952  225560827  d71c8fb
966        5339425 1200 1868783272 1874123897 6fb4dc79 (SEAICE_LSR_ADJOINT_ITER)
967        but only a moderate increase of 36% for global_ocean.cs32x15:
968        text    data        bss     dec        hex
969        6695027 1648 1014578664 1021275339 3cdf6ccb
970        6695203 1648 1382505320 1389202171 52cd8afb (SEAICE_LSR_ADJOINT_ITER)
971      - note: there are still recomputations in global_ocean.cs32x15 and
972        offline_exf_seaice and the gradient agreement changes (gets a
973        little worse) for global_ocean.cs32x15 (-> update output_adm.seaice.txt)
974      - in general, the AD gradients still are wrong
975    o OpenAD
976      - clean up code_oad/ directories somewhat by moving files
977        dontCompile, dontTransform, keepOriginal to OAD_support/
978    o model/src:
979      - using MOM fluxform and Non-Lin Free-Surf with momDissip_In_AB=F
980        (not currently tested): add dissipation terms before NLFS rescaling of
981        tendencies (previously done after).
982    o pkg/diagnostics:
983      - write stats-diags in ascii file with more digits (same as in monitor).
984    o pkg/down_slope:
985      - drop the bi,bj dimension of argument recip_hFac in S/R DWNSLP_APPLY; with
986        NLFS (not tested), use new recip_hFac value in order to conserve tracer.
987    o model/src:
988      - new file "apply_forcing.F" containing all the code previously in
989        external_forcing.F, but with new argument list: pass, as new argument,
990        the current level tendency array to update (instead of a direct update
991        of the common bloc array). Change the corresponding calls.
992      - add CPP option USE_OLD_EXTERNAL_FORCING (default is undef) to use
993        EXTERNAL_FORCING_U,V,T,S subroutines (for backward compatibility).
994    o pkg/seaice/seaice_lsr, a little bit of clean up
995      - rearrange some code blocks, so that now all calculations for
996        setting up the right-hand-sides done within one single block
997        (I find that easier to read and understand)
998      - rearrange freedrift-code to reduce the number of ifdefs
999      - adjust some indentations and comments
1000    
1001    checkpoint64z (2014/07/10)
1002    o model/src and several pkgs:
1003      - change argument list of all S/R called from external_forcing.F and
1004        called from ptracers_forcing.F (renamed to ptracers_apply_forcing.F)
1005        to pass, as argument, the current level tendency array to update
1006        (instead of a direct update of the common bloc array).
1007      - change also (in the same way) argument list of PTRACERS_APPLY_FORCING;
1008      - rename taueddy_external_forcing.f to taueddy_tendency_apply.F
1009    o pkg/seaice/seaice_lsr.F
1010      - always initialize local arrays in seaice_lsr_tridiagu/v
1011      - add more local tapes to seaice_lsr_tridiagu/v
1012      - move storing u/vice(:,:,bi,bj) out of seaice_lsr_tridiagu/v, but
1013        keep it in bi/bj loop; this seems to be essential
1014      - gradients are still wrong but only by 4-7 orders of magnitude
1015        instead of 15 orders of magnitude, lab_sea improves a little
1016    o pkg/seaice
1017      - (pkg/autodiff) remove storing/restoring of seaiceMaskU/V that
1018        generates unnecessary code in seaice_lsr_ad
1019      - add more store directives in seaice_lsr to avoid unnecessary code
1020        in seaice_lsr_ad
1021      - exclude some residual computations in seaice_lsr when
1022        ALLOW_AUTODIFF_TAMC is defined in order to avoid unnecessary code
1023        in seaice_lsr_ad
1024      - add more storing, a new tape (model/src/the_main_loop.F) and
1025        another key for SEAICE_LSR_VECTORIZE_ZEBRA (the local keys ilockey
1026        and klockey should be checked by a specialist)
1027      - modify ( define SEAICE_VECTORIZE_LSR and SEAICE_LSR_ADJOINT_ITER )
1028        and update lab_sea after previous changes in pkg/seaice below
1029    o pkg/autodiff:
1030      - introduce useSmoothCorrel2DinAdMode, SEAICEapproxLevInAd, and
1031        viscFacInAd : run time parameters allowing for adjoint switches
1032        note : logic for useSmoothCorrel2DinAdMode is in ctrl_readparms.F
1033    o pkg/ecco:
1034      - introduce cost_gencost_boxmean.F that computes a box mean
1035        temperature (for use in adjoint sensitivity studies).
1036    o model/src/set_defaults.F : initialize viscFacAdj to 1.
1037    o pkg/mom_common/mom_calc_visc.F:
1038      - ifdef ALLOW_AUTODIFF then include viscFacAdj factor.
1039    o pkg/seaice/seaice_summary.F:
1040      - statement for SEAICEadjMODE now in autodiff_readparms.F
1041    o pkg/seaice:
1042      - remove some store directives and add new ones in an effort to get
1043        finally rid off the recomputation warnings. This is successful
1044        when SEAICE_VECTORIZE_LSR ***and*** SEAICE_LSR_ADJOINT_ITER are
1045        defined (i.e. no extensive recomputation warnings left), but there
1046        are still too many recomputations on the solver iteration level
1047      - define SEAICE_VECTORISZE_LSR in offline_exf_seaice/code_ad/SEAICE_OPTIONS.h
1048      - move definition of MPSEUDOTIMESTEPS into TAMC-block in
1049        SEAICE_SIZE.h
1050      - add a store directive in S/R seaice_calc_viscosities
1051    o pkg/seaice (ITD code):
1052      - fix definition of Hlimit for multi-threaded case
1053      - use double precision arithmetic to compute Hlimit: this affects results;
1054        update output of experiment seaice_itd.
1055    o replace content of verification/seaice_itd
1056      - instead of a 1D column use the configuration of offline_exf_seaice
1057        to test the ice thickness distribution code with ridging
1058      - this is a first shot at this experiment
1059      - change of some defaults of ridging parameters SEAICEhStar (from
1060        100 to 25) and SEAICEmuRidging (from 5 to 3) in seaice_readparms.F
1061        and lot of new comments.
1062    
1063    checkpoint64y (2014/06/20)
1064    o pkg/seaice/seaice_reg_ridge.F:
1065      - modify the regularization of very small volumes of ice; only check
1066        total volume HEFF, and do not apply correction to individual ice
1067        classes because that leads to funny patterns in the heat and fw-fluxes
1068        into the ocean. Adjust seaice_itd/results/output.txt
1069      - replace nITD by SEAICE_multDim in loop-ranges
1070    o pkg/exf:
1071      - add code to process the case field period = -12. with UV interpolation.
1072      - move debug print (formerly active when exf_verbose=T) from EXF_getFFieldRec
1073        into S/R that calls it (i.e., exf_set_gen.F, exf_set_uv.F & obcs_exf_load.F)
1074    o verification/global_with_exf:
1075      - switch all fields period to -12. (was previously untested) in input/data.exf
1076        (but keep secondary test ".yearly" unchanged); update the reference output.
1077    o pkg/cal:
1078      - new calendar type "noLeapYear" for 365 days calendar without any leap year.
1079    o pkg/exf:
1080      - new integer parameter "exf_debugLev" (default set to main model debugLevel)
1081        to replace logical switch "exf_verbose"
1082      - report in STDOUT when loading a new record (if exf_debugLev >= 3)
1083    o pkg/sbo:
1084      - update from Katherine Quinn: evaluate mass directly from density and SSH
1085        (budget using Finite Volume method) instead of from bottom pressure.
1086      - allow testreport to collect few selected SBO output ; tested in exp.
1087        global_ocean.90x40x15 (after updating the results, to include SBO output).
1088      - fix some multi-threading issues (in output part).
1089    o model/src & most packages:
1090      - always call {PKG}_READPARMS even if corresponding use{PKG}=F;
1091      - in {PKG}_READPARMS, in case use{PKG}=F: add a call to new S/R
1092        PACKAGES_UNUSED_MSG to print a weak warning when parameter file
1093        "data.{pkg}" exist ; and leave the S/R (return) just after.
1094      - more standard LAND pkg interface (land_init_fixed.F, land_check.F).
1095        + call LAND_READPARMS from packages_readparms.F
1096    o pkg/seaice:
1097      - remove code that resets useThSice in S/R seaice_readparms and
1098        replace it by a warning in S/R seaice_check
1099      - remove parameter MULTDIM, replace with nITD and runtime
1100        parameter SEAICE_multDim (still hard-wired to nITD if
1101        SEAICE_ITD is defined)
1102    
1103    checkpoint64x (2014/05/24)
1104    o verification/lab_sea:
1105      - update adjoint and TLM output following changes to pkg/salt_plume
1106      - un-do the update after putting back local recip_Cp in few places.
1107    o pkg/salt_plume: modifications by An Nguyen:
1108      - add capability to do brine rejection (salt-plume) as function of
1109        volume+tracers (instead of only salinity tracer).
1110      - conserve volume by exchanging volume from each kLev to above to
1111        accommodate in-coming brine volume
1112      - store surface and klev exchanged fraction + volume in 4 new 3-d arrays
1113      - switch KPP surf buoyancy due to brine forcing to 3-d
1114        (3 more 3-d arrays, 2 for SPforcing[T,S], 1 for boplume)
1115      - add salt_plume_volfrac, salt_plume_apply, salt_plume_tendency_apply_t
1116      - unrelatedly, also add ad-hoc capability to vary salt_plume scheme
1117        in East/West Arctic.
1118    o pkg/sbo:
1119      - incorporate modifications from Katherine Quinn to enable the use of sbo
1120        pkg in ECCO-v4 set-up ; remove SBO-TimeAve output ; add monitor-like
1121        output for future testreport verification (unfinished).
1122    o pkg/atm_phys:
1123      - change diagnostics (AtPh_Trf & AtPh_Qrf) of DARGAN_BETTSMILLER S/R:
1124        skip the reseting of t_ref & q_ref to initial t & q ; this preserve the
1125        output of S/R CAPECALCNEW (Parcel temp & q) for diagnostics.
1126    o pkg/seaice
1127      seaice_calc_ice_strength.F: modify expression to avoid divisions
1128        (affects truncation)
1129      seaice_do_ridging.F: clean up the insectarium
1130      - fix a bug that was compensated by areaScaling (-> remove areaScaling code)
1131      - added SEAICEsnowFracRidge to redistributed snow (2nd bug)
1132      - set closing/openingRate to zero where no extra iteration is need (3rd bug)
1133      - add some debugging information and error messages (warnings)
1134    o model/src: modifications relatd to atmosphere p*:
1135      - Switch to more accurate p* coordinate slope term (calc_grad_phi_hyd.F)
1136      - With p* or Sigma-P, use constant reference Pot.Temp (thetaConst) instead
1137        of vertical profile tRef in geopotential background and anomaly.
1138      - Acount for true p* correction in theta <-> T conversion in pkg/aim_v23
1139        and pkg/atm_phys.
1140      - Update FWD output of experiments: aim.5l_cs (x2), fizhi-cs-32x32x40,
1141        fizhi-cs-aqualev20, fizhi-gridalt-hs, tutorial_held_suarez_cs, cpl_aim+ocn.
1142    o pkg/seaice: fix a bug in seaice_prepare_ridging.F, forgot a sqrt
1143    o pkg/ptracers: compute ptracer source/sink due to linear free surface.
1144        not used right now, but can be used in BGC packages to fix conservation.
1145    o pkg/dic, pkg/gchem: move tracer_meanarea to gchem, so it can be used by
1146        other packages too.
1147    o pkg/seaice/seaice_calc_ice_strength.F: replace SEAICE_rhoSnow by
1148        SEAICE_rhoIce in the Rothrock (1975)-type strength calculations (bug fix)
1149    o model/src:
1150      - since we have several heat capacity (even in model/src), define "recip_Cp"
1151        as local variable (no longer in common block) to avoid any confusion.
1152      - add thetaConst in PARAMS.h (to be used with pStar or sigma-P coords).
1153    o pkg/exf:
1154      - from Jeff Scott: add option (#define EXF_CALC_ATMRHO) to calculate local
1155        air density as function of air Temp, Humidity and atm pressure.
1156    
1157    checkpoint64w (2014/05/02)
1158    o verification:
1159      - update output_adm.txt files for experiment global_ocean.cs32x15 (seaice &
1160        seaice_dynmix) and lab_sea (primary test & noseaicedyn): moving/changing
1161        code from seaice_growth.F & seaice_advdiff.F to new ridging routines
1162        seaice_reg_ridge.F seaice_do_ridging.F affects AD gradient
1163        (down to 8-7 matching digits for global_ocean and 5-6 for lab_sea).
1164    o model/src: for atmosphere in p* coords:
1165      - store factor rStarFacC**atm_kappa (= pStarFacK) in common block
1166      - implement more accurate p* coordinate slope term (in calc_grad_phi_hyd.F),
1167        but not yet activated.
1168    o pkg/seaice: fix restart problem for ITD with new ice strength parameterisation:
1169      - move computation of opnWtrFrac = 1-AREA to before computing ice strength
1170      - this changes the results (but not for any verification experiment, because
1171        none tests this), but avoids having an extra field in the restart files
1172    o pkg/seaice: remove global variable TICE (not needed)
1173      - replace by TICES or local variable where necessary (cost_seaice_test,
1174        seaice_diagnostics_state)
1175      - move copying TICE to TICES from seaice_check_pickup to seaice_read_pickup
1176      - use specific read/write routines for reading and writing individual leves
1177        of a multilevel field
1178    o pkg/ctrl & model/inc:
1179      - move additional anomaly fields of control vars (related to options:
1180         ALLOW_KAPGM_CONTROL, ALLOW_KAPREDI_CONTROL and ALLOW_BOTTOMDRAG_CONTROL)
1181        from DYNVARS.h into new header file: CTRL_FIELDS.h
1182    o pkg/seaice: some small modifications to the ridging code
1183      - make fw2ObyRidge a global variable and add the freshwater flux to
1184        seaice_growth
1185      - pass actual thickness from seaice_prepare_ridging, so that it is
1186        computed only in one place and compute it in the same way as in
1187        seaice_growth
1188      - initialise more fields in seaice_do_ridging that where cause floating
1189        point exceptions over land
1190    o pkg/seaice: preparations for ridging code and first real ridging code
1191      - move most of "PART 1" of S/R seaice_growth into a new and separate
1192        S/R seaice_reg_ridge that will both regularize the state variable after
1193        advection call the actual ridging routine;
1194      - requires to make 5 fields global fields: d_HEFFbyNEG,d_HSNWbyNEG,
1195        d_AREAbyRLX,d_HEFFbyRLX,saltFluxAdjust;
1196      - remove ridging code from seaice_advdiff
1197      - clean up remaining part 1 of seaice_growth in an attempt to make it
1198        more readable (this is probably subjective)
1199      - call seaice_itd_redist once in the initialisation phase to have the initial
1200        conditions in the correct category
1201      - finally: add new ridging routine for ITD code
1202    
1203    checkpoint64v (2014/04/11)
1204    o pkg/ecco:
1205      - add runtime parameters mdt[start,end]date[1,2]
1206      - rename variable "tpmean" as "mdt" and "topexmeanfile" as "mdtdatfile"
1207    o pkg/seaice:
1208      - make deltaC a global variable, so that it can be used in ridging code
1209      - first step towards ridging: introduce new routines that compute
1210        ice strength based on ridging parameters
1211      - add diagnostic for HSNOWITD
1212      - add opnWtrFrac as a global variable (required for ridging scheme)
1213    o pkg/salt_plume + pkg/seaice/seaice_growth.F
1214      - add SALT_PLUME_IN_LEADS flag to activate pkg/salt_plume only when ice
1215        AREA exceeds a threshold (code contributed by I.Fenty in 2011)
1216    o verification/hs94.1x64x5:
1217      - leave ALLOW_AUTODIFF_TAMC undefined in code_oad/AUTODIFF_OPTIONS.h
1218      - do not use ECCO_CPPOPTIONS.h anymore for TAF & OpenAD Adjoint tests.
1219    o autodiff:
1220      - Start to include explicitly AUTODIFF_OPTIONS.h, COST_OPTIONS.h,
1221        and CTRL_OPTIONS.h in src files (to enable to skip the ECCO_CPPOPTIONS.h)
1222        For now, only in pkgs used in verification/hs94.1x64x5.
1223      - Replace ALLOW_AUTODIFF_TAMC by ALLOW_AUTODIFF (except for tape/storage
1224        which are specific to TAF/TAMC).
1225      - Replace ALLOW_AUTODIFF_OPENAD by ALLOW_OPENAD:
1226        since ALLOW_OPENAD is defined in PACKAGES_CONFIG.h (any time pkg/openad
1227        is compiled), this simplifies/reduces which *_OPTIONS.h file to include.
1228      - OpenAD: change Makefile to generate the appropriate AD_CONFIG.h when
1229        building mitgcmuv_ad (make adAll).
1230    o pkg/ecco:
1231      - cost_gencost_seaicev4.F:
1232         reformulate proxy cost as function of sst and local param SEAICE_freeze
1233         change cost names from siv4-[sst,vol] to siv4-[deconc,exconc]
1234      - add stop statement if old names siv4-[sst,vol] are used
1235      - add snapshots + cost reports for atmospheric longwave
1236      - remove factor 0.1 in front of wtau[u,v]
1237      - replace never used flag ALLOW_TMI_COST_CONTRIBUTION with
1238         ALLOW_TMI_SST_COST_CONTRIBUTION
1239    o pkg/atm_phys:
1240      - add some diagnostics for Short-wave and for convection S/R.
1241    o pkg/seaice/seaice_growth:
1242      - fix a bug in the lateral melt parameterization for SEAICE_ITD
1243        in seaice_growth; tempFrz needs to be computed inside the i/j-loop
1244      - rearrange loop order for better vector code in the same code block
1245      - rewrite the floeDiameter formula to have fewer divisions
1246      -  (miraculously) none of this changes the results of seaice_itd
1247    o pkg/smooth:
1248      - move param smooth2Ddiffnbt to pkg/ecco
1249    o pkg/salt_plume:
1250      - salt_plume_frac.F:
1251         clean up local param names
1252         reformulate (1-frac) to frac; original 1-frac was based on swfrac code
1253    o pkg/rw:
1254      - add RS version of S/R READ_MFLDS_LEV.
1255    o pkg/streamice:
1256      - fix the restart test by writing/reading pickup_streamice files.
1257    o pkg/seaice:
1258      - refine checks for jfnk-related parameters
1259      - comment out if statement with SEAICEuseIMEX parameter as long as there
1260        is no IMEX code to avoid confusion and surprises
1261    
1262    checkpoint64u (2014/03/07)
1263    o verification/MLAdjust:
1264      - rename secondary test suffix:
1265         1.leith  -> A4FlxF  + switch to flux-form & add side-drag
1266         0.leithD -> AhFlxF  + switch to flux-form
1267         0.smag   -> AhVrDv  (use Vorticity-Div. visc form) + add side-drag
1268         0.leith  -> AhStTn  (use Strain-Tension visc form) + add side-drag
1269    o pkg/mom_vecinv:
1270      - remove unused arguments from S/R MOM_VI_HDISSIP & MOM_HDISSIP (as it used
1271        to be before mom_calc_visc.F)
1272      - skip the call to MOM_CALC_TENSION & MOM_CALC_STRAIN if not needed.
1273      - add 2nd copy of vort3 & strain that knows about lateral BC (free/no slip):
1274        this is simpler for the adjoint and for diagnostics.
1275    o model/src + pkg/momentum:
1276      - add input files for  2-D additional Western and Southern cell-edge wall
1277         (e.g., to add "thin-wall" where it is =1).
1278      - fix sideDrag option for thin-walls with Non-Lin Free-Surf
1279        using 2nd hFacZ that is computed from initial (fix domain) hFac
1280      - known limitations of thin wall implementation: not yet coded for sigma
1281        coords; not working with CD-scheme neither.
1282    o pkg/seaice:
1283      - rename recently introduced parameters from (wrong name) AB to
1284        BDF (backward difference time discretisation)
1285      - retire runtime parameters SEAICEuseAB2, SEAICE_abEps
1286    o tools/adjoint_options:
1287      - remove setting of "OPENAD=true" (now set by command line "genmake2 -oad")
1288    
1289    checkpoint64t (2014/02/01)
1290    o pkg/ecco
1291      - add compile flag ALLOW_GENCOST_TIMEVARY_WEIGHT in ECCO_OPTIONS.h and
1292        runtime logical flag gencost_timevaryweight to read daily sea-ice sigma
1293      - replace hard-coded record number and period which only work for monthly
1294        with read-in runtime param that works for other periods (month,day,year)
1295    o pkg/thsice
1296      - corrected store directive fixes thsice adjoint gradient checks
1297    o genmake2 & testreport:
1298      - add genmake2 option "-oad" to generate a Makefile for OpenAD built and
1299        in this case, use tools/adjoint_options/adjoint_oad as default AD optfile.
1300        Update testreport accordingly. No need to set "export OPENAD=true"
1301        in adjoint_options/adjoint_oad anymore (will be removed later).
1302    o pkg/shelfice:
1303      - put T & S shelfice forcing into model surfaceForcing_T,_S (for now,
1304        only if SHELFICEboundaryLayer=F); Change model/src/external_forcing.F
1305        so that surface forcing applies to k=kSurf if using pkg/shelfice.
1306    o pkg/ctrl, pkg/grdchk, pkg/ecco:
1307      - Changes to make GENARR more modular (i.e. invisible if not used)
1308    o model/src/temp_integrate.F and salt_integrate.F
1309      - re-include store directives that were removed on Dec 27th.
1310    o model/src/external_forcing_surf.F
1311      - add storage directives for EmPmR and PmEpR to avoid recomputation of
1312        seaice_model in the adjoint that is problematic when seaice_model is
1313        turned off in the adjoint. The resolved issue dated back to July when
1314        EXTERNAL_FORCING_SURF call was moved.
1315        Update global_ocean.cs32x15/*/output_adm.seaice_dynmix.txt accordingly.
1316    o pkg/exf/exf_check.F
1317      - fix a small bug again (originally found by Wentao Liu, now found again)
1318      - streamline error output
1319    o pkg/streamice and aim_v23:
1320      - replace a few "_EXCH_XY_RL (" with "_EXCH_XY_RL(", so that
1321        Apple's /usr/bin/cpp knows what to do:
1322        Apple LLVM version 5.0 (clang-500.2.79) (based on LLVM 3.3svn)
1323        Target: x86_64-apple-darwin13.0.0
1324    
1325    checkpoint64s (2014/01/05)
1326    o tools/adjoint_options:
1327      - switch to fastopt.net TAF server (instead of default fastopt.de) for
1328        AD optfiles adjoint_diva & adjoint_f95 (similar to adjoint_default).
1329    o model/src:
1330      - remove some unnecessary TAF storage directives in forward_step.F and
1331        in dynamics.F (note: not always removed by TAF, e.g., double storage
1332        of kappaRU,kappaRV in former version of dynamics.F).
1333    o model/src & pkg/ptracers:
1334      - call directly GAD_IMPLICIT_R & IMPLDIFF + DWNSLP_APPLY from temp_integrate.F
1335        salt_integrate.F and ptracers_integrate.F (instead of from thermodynamics.F)
1336        and remove ptracers_dwnslp_apply.F & ptracers_implicit.F
1337      - call MATRIX_STORE_TENDENCY_EXP for each tracer (in ptracers_integrate.F)
1338      - add fZon & fMer as output argument of S/R GAD_CALC_RHS.
1339      - update TAF AD-output of experiments global_ocean.90x40x15 (13 for AD-grad).
1340    o useSingleCpuInput separates single-CPU input from single-CPU output;
1341        for now only implemented for in exf_interp_read.F
1342    o verification/advect_xy:
1343      - fix missing EXCH call in local version of ini_salt.F and update output.
1344    o momentum diagnostics:
1345      - fix which deltaT is used in Total-Tendency diagnostics.
1346      - fix typo in diagnostics for momentum tendency from AB.
1347    o pkg/seaice/seaice_lsr.F: fix an initialisation bug for the
1348        SEAICE_VECTORIZE_LSR_ZEBRA option that lead to NaNs on a NEC-SX8
1349    
1350    checkpoint64r (2013/12/08)
1351    o verification/*/results:
1352      - Update reference output of experiments that were passing with just 13 digits
1353         (make it easier to detect future changes in results)
1354    o model/src & pkg/ptracers:
1355      - move calls to GAD_ADVECTION (Multi-Dim advection) from thermodynamics.F to
1356        inside temp_integrate.F and salt_integrate.F and from ptracers_advection.F
1357        to inside ptracers_integrate.F ; remove ptracers_advection.F
1358    o coupling interface pkgs:
1359        [atm_compon_interf, ocn_compon_interf & atm_ocn_coupler]
1360      - change the config check to test the agreement of Ocean Depth
1361        with ATM land/sea mask (instead of ATM orography);
1362      - send to coupler the number of coupler time-steps to do for this run:
1363        this allows to check for consistency and don't need anymore to be
1364        specified in parameter file "data";
1365      in coupler:
1366      - check consistency of RunOff map versus Ocean Depth and ATM land/sea mask.
1367      - improve report to log-file of config setting (pass log-file unit to few S/R)
1368    o pkg/compon_communic:
1369      - add coupling send/receive for non-tiled integer vector;
1370      - add S/R to check and stop if any proc has an error (similar to
1371        eesupp/src/stop_if_error.F but single thread and across Comm_World).
1372    o pkg/exch2:
1373      - in exch2*_get_rx[1,2]: use new list "W2_tileIndex" to replace search
1374        through list of all tiles my proc owns.
1375    o model/src:
1376      - AUTODIFF only: in calc_adv_flow.F, recompute rTransKp (instead of copying
1377        from rTrans) to simplify dependencies (no need to store rTrans anymore in
1378        calling S/R); this affects AD results at machine truncation level:
1379        update AD-output (TAF) of experiments: 1D_ocean_ice_column,
1380        bottom_ctrl_5x5 & obcs_ctrl (12 digits for AD grad, same FWD grad).
1381    o tools/build_options:
1382      - simplify Warnings options (-ieee & -devel cases) in linux_amd64_gfortran
1383    o coupling interface pkgs:
1384        [compon_communic, atm_compon_interf & ocn_compon_interf]
1385      - move declaration of local array "ibuf" out of header file "CPLR_SIG.h"
1386        to each S/R that needs it; remove un-used variables.
1387      - change component tile registration (cpl_register.F in both compon_interf
1388        and mitcomponent_tile_register.F) to pass the full list of tiles
1389        information (including bi,bj) in 1 vector (instead of in a bi,bj matrix).
1390      - with pkg/exch2: adopt the same convention used for I/O to define mapping
1391        towards coupler global array (unless W2_useE2ioLayOut=F):
1392         a) can now use different tiling between atm & ocn comp.
1393         b) no needs to modify the run-Off map when changing tiling (was needed
1394            even if using the same tiling between atm & ocn).
1395         c) will allow to run with blank-tiles in 1 component (e.g., for ocean
1396            full land tiles); not yet tested.
1397      - check for valid mapping from comp. tile to coupler global array
1398      - improve report of tile registration results to log file.
1399    o pkg/exch2:
1400      - in eesupp/src/eeboot.F: move call to W2_EEBOOT before Coupler
1401        tile-registration (CPL_REGISTER);
1402      - activate (un-comment) definition and setting of "W2_tileIndex" list to
1403        store the local bi,bj indices of each tile;
1404      - also print bi,bj in local report to log file;
1405      - fix pkg/debug/debug_cs_corner_uv.F for the case nSy > 1 (left from
1406        Jun 2009 modif of pkg/exch2).
1407    o testing on baudelaire:
1408      - run 2 tests at a time: no significant slow down (since enough cpu) and
1409        get the full set of test done earlier
1410      - switch the ifort test to "-devel" ; run the OpenAD test everyday.
1411    o model/src/thermodynamics.F and routines called from it:
1412      - pkg/gmredi: gmredi_residual_flow.F (replacing gmredi_calc_uvflow.F &
1413        gmredi_calc_wflow.F) to update eulerian velocity (input) into residual
1414        velocity (outp) by adding bolus velocity.
1415      - model/src: calc_adv_flow.F (replacing calc_common_factors.F) to compute
1416        mass transport from velocity + lateral grid cell area
1417      - rename calc_gt.F to temp_integrate.F (includes call to TIMESTEP_TRACER)
1418      - rename calc_gs.F to salt_integrate.F (includes call to TIMESTEP_TRACER)
1419     in thermodynamics.F
1420      - remove k from thermodynamics.F and move it to temp_integrate.F
1421        salt_integrate.F and ptracers_integrate.F (now done inside the tracer
1422        loop).
1423      - compute locally (in thermodynamics.F) 3-D velocity field that is used to
1424        advect tracers; pass it as argument to GAD_ADVECTION, GAD_SOM_ADVECT,
1425        PTRACERS_ADVECTION, TEMP_INTEGRATE, SALT_INTEGRATE, PTRACERS_INTEGRATE,
1426        GAD_IMPLICIT_R and PTRACERS_IMPLICIT
1427      - update AD-output (TAF & OAD) of experiments: 1D_ocean_ice_column,
1428        global_ocean.90x40x15, tutorial_global_oce_biogeo and
1429        tutorial_tracer_adjsens (+ TLM output).
1430    o tools/OAD_support and (verification/*/) code_oad:
1431      - OAD_support/cb2mGetModules.csh: add PACKAGES_CONFIG.h in header file to
1432        module conversion ; remove unneeded CPP_EEOPTIONS.h.
1433      - code_oad/CPP_OPTIONS.h: remove PACKAGES_CONFIG.h and use a more standard
1434        version (closer to model/inc/CPP_OPTIONS.h).
1435    o model/src:
1436      - remove parameter "useOldFreezing" from PARAMS.h and push it to the
1437        retired list of parameters (routine FREEZE has been replace by surface
1438        freezing (10.yrs ago) and by pkg/frazil (interior freezing).
1439    o pkg/gmredi:
1440      - add option (GM_CALC_TRANSP_FROM_VEL) to compute transport directly from
1441        velocity (same scheme but affects machine truncation) for GM_AdvForm.
1442      - update output of FWD experiments: front_relax.bvp,
1443        global_ocean.90x40x15.dwnslp, global_ocean.cs32x15 and ideal_2D_oce.
1444    
1445    checkpoint64q (2013/11/17)
1446    o verification:
1447      - generate new output on baudelaire (gfortran, -ieee) for OpenAD experiments
1448        tutorial_global_oce_biogeo and global_ocean.90x40x15.
1449      - generate new output (growth & melt) for seaice_itd experiment after
1450        updating the input pickup_seaice files (previously wrong).
1451    o pkg/cost:
1452      - define a "final cost function" for each tile, and use GLOBAL_SUM_TILE_RL
1453        (instead of _GLOBAL_SUM_RL) to get the final cost from all procs & threads:
1454        o this fixes global-sum value if multi-threads (since GLOBAL_SUM_RL
1455          cannot be applied to var in common block).
1456        o allows to get results independent of tile-per-proc setting (if using
1457          slower GLOBAL_SUM_SEND_RECV option).
1458      - update accordingly: seaice_cost_final.F, shelfice_cost_final.F,
1459        thsice_cost_final.F and ecco_cost_final.F (this one affects lab_sea
1460        forward gradients: update output).
1461      - update */code_oad/externalDummies.F by adding dummy GLOBAL_SUM_TILE_RL
1462        S/R and, for most exp., also comment out GLOBAL_SUM_R8.
1463    o pkg/mom_common:
1464      - move to pkg/mom_common and model/src (previously in tutorial_deep_convection
1465        code) 2nd version of isotropic 3-D Smagorinsky code interface: strain and
1466        viscosity are locally declared in dynmics.F and pass as argument to CALC_GW;
1467        ensure that all field value that are used are set.
1468    o tutorial_deep_convection (smag3d):
1469      - add missing scaling in mom_calc_smag_3d.F;
1470      - set smag3D_coeff in input.smag3d such that results do not change.
1471    o pkg/dic:
1472      - change dic_cost.F to compute cost on each tile first and then apply
1473        GLOBAL_SUM_TILE_RL: this affects forward gradient of AD experiments
1474        tutorial_dic_adjoffline & tutorial_global_oce_biogeo; update output.
1475      - remove kLev argument and use GLOBAL_SUM_TILE_RL in tracer_meanarea.
1476    o eesupp/src & pkg/mdsio:
1477      - remove gather/scatter_vector.F (from eesupp) and mdsio_read/writevector.F
1478        (from pkg/mdsio) since they are no longer used for tape IO.
1479      - move simple C subroutine "setdir.c" from pkg/compon_communic to eesupp/src
1480        (+ keep a copy in pkg/atm_ocn_coupler).
1481    o verification/isomip:
1482      - split domain in 8 squared tiles (instead of just 2) for FWD, AD & OAD tests.
1483    o tools/build_options:
1484      - optfile linux_amd64_ifort11, fast (no ieee) case:
1485        to get a working restart for all experiments, add "-fp-model source"
1486        to FOPTIM (also remove "-opt-streaming-stores auto" <- this is the default).
1487    
1488    checkpoint64p (2013/10/20)
1489    o pkg/autodiff:
1490      - adread_adwrite.F: when type and length do not match ALLOW_AUTODIFF_WHTAPEIO
1491        criteria, return to simple (default) tape IO format.
1492    o pkg/mdsio (+ eesupp/src):
1493      - rewrite/simplify tape-IO S/R (new S/R MDS_READ/WRITE_TAPE replace
1494        previous MDSREAD/WRITEVECTOR) with 2 array argument from each type (R4/R8);
1495      - fix globalFile and singleCpuIO options using simpler global mapping.
1496      - new pairs of scatter/gather vector S/R (one for each type, generated from
1497        template) corresponding to simpler global mapping.
1498      - adread_write.F: switch to new S/R (but leave old calls commented) and write
1499        to globalFile when parameter globalFiles is set to True.
1500      - switch on useSingleCpuIO in AD experiments: global_ocean.90x40x15 & isomip.
1501    o pkg/autodiff:
1502      - adread_adwrite.F: add a hack for RS arrays (when RS=real*4);
1503        with ALLOW_AUTODIFF_WHTAPEIO defined, since corresponding (real*4) is
1504        missing, just add a STOP if array type do not match.
1505    o pkg/exf:
1506      - to allow to use seaice-fraction from pkg/exf in other pkgs than pkg/seaice:
1507         rename CPP option EXF_ALLOW_SEAICE_RELAX to EXF_SEAICE_FRACTION
1508         and rename array obsSIce to exf_iceFraction.
1509    o tutorial_deep_convection:
1510      - add 1rst version of isotropic 3-D Smagorinsky code (from Louis-Philippe),
1511        for now all in this exp. code dir.
1512      - add secondary test using Smag-3D viscosity (keep very low backgroud visc for
1513        testing) and flux-limter advection scheme for Temp. (no explicit diffusion).
1514    o eesupp/src:
1515      - added SINGLE_DISK_IO option because reading of parameter files on
1516        very large number of processors did not work with existing set-up
1517    
1518    checkpoint64o (2013/09/25)
1519    o pkg/atm_phys & atm_compon_interf:
1520      - allows for coupling of gray-atmosphere (atm_phys) with ocean.
1521    o tools/build_options:
1522      - switch from "-fPIC" to "-mcmodel=medium" in optfiles: linux_amd64_gfortran
1523        & linux_amd64_ifort11 and in linux_amd64_g77 & linux_amd64_open64 also
1524        remove CPP setting (was identical to genmake2 default).
1525    o pkg/gmredi & model/src: Some updating and work done on the residual model.
1526      - created new file model/src/calc_eddy_stress.F to calculate the eddy stress.
1527      - fixed up the calculation of the eddy stress and how it is added to the
1528        external forcing via taueddy_external_forcing.F
1529      - at the moment, it is very experimental and only works with the variable eddy
1530        diffusivity calculated in gmredi_k3d.F
1531    o pkg/seaice/seaice_check.F: add a check to catch the case of specifying
1532        lw/swfluxfile instead of lw/swdownfile in data.exf together with pkg/seaice
1533    o testreport (& tools/do_tst_2+2):
1534      - for MPI test, set default COMMAND to 'mpirun -v -np TR_NPROC ./{executable}'
1535    o tools/build_options: linux_amd64_gfortran & linux_amd64_ifort11:
1536      - remove CPP='cpp -traditional -P' (this is genmake2 default)
1537      - add switch (for big setups) to use 'medium' memory-model (but leave it
1538        commented out for now). Note: needed with FC 19 to compile big setups.
1539    o pkg/atm_compon_interf:
1540      - regroup per field origin (model & pkgs) the coupling storage routines
1541         (which accumalate in time each coupling field)
1542      - move bi,bj loops inside atm_store_my_data.F and store also wind-stress;
1543        update accordingly + simplify aim_do_physics.F
1544    
1545    checkpoint64n (2013/08/26)
1546    o pkg/bbl:
1547      - update formulation to reduce dispersion of tracer properties in bbl
1548      - replaced horizontal and vertical transport parameters with velocities
1549      - changes results for verification/global_with_exf.yearly
1550    o verification/halfpipe_streamice:
1551      - change to matrix construction; update both Fwd & AD output.
1552    o verification/tutorial_tracer_adjsens:
1553      - OpenAD test: switch to vector-invariant momentum since fluxform with
1554        rStar causes problems with OpenAD; update output.
1555    o tools:
1556      - genmake2: define a common prefix for all temp-file names ; move them
1557        to local /tmp disk (but would be easy to move them back);
1558      - xmakedepend: apply the same switch for temp-files.
1559    o pkg/offline:
1560      - changes for use with rStar (NLFS): assume that we continue to provide
1561        UVELMASS/hFacW_ini & VVELMASS/hFacS_ini (hFacWi,S_ini as written in grid
1562        output files) and apply r* scaling at each time-step (function of the time
1563        varying Eta field); use normal pickup files (needed for restart with NLFS).
1564    o adjoint with OpenAD:
1565      - move OpenAD-specific files from verification/OpenAD/code_oad_all to a new
1566        package openad.  This package has to be compiled for all runs with OpenAD
1567        instead of specifying code_oad_all as a modification directory.
1568      - link the fortran templates from tools/OAD_support to the build directory
1569        for preprocessing to avoid conflicts between different setups compiled
1570        simultaneously and simplify cleanup.
1571    o pkg/exf:
1572      - in exf_getforcing.F: comment out most of the EXCH calls (fields used by
1573        main model or other pkgs are exchanged in EXF_MAPFIELDS).
1574    o model/src:
1575      - do_stagger_fields_exchanges.F: skip EXCH calls when using pkg/offline
1576        (similar to do_fields_blocking_exchanges.F).
1577    o tools/genmake2:
1578      - remove TAF output src code just before calling staf (when not doing a fresh
1579        built, will stop if things go wrong with staf).
1580      - fix target "adobj" (left from TAF version-2 transition)
1581    o pkg/diagnostics:
1582      - add a parameter to track the status of pkg/diagnostics activation;
1583        this replace/extend the use of logical param "settingDiags" (to check
1584        when adding diag to the list) to also check any DIAGNOSTICS_[]FILL* call.
1585        New S/R to print error message and stop when pkgStatus is not right.
1586      - to try: add a warning when "data.diagnostics" exist but useDiagnostics=F.
1587    
1588    checkpoint64m (2013/08/13)
1589    o model/inc:
1590      - move FCORI_MACROS.h from PARAMS(_MACROS).h to GRID_MACROS.h (left from
1591        8 yrs ago modif when Coriolis arrays were moved from PARAMS.h to GRID.h)
1592    o pkg/kpp & aim_v23:
1593      - only call DIAGNOSTICS_FILL when useDiagnostics=TRUE.
1594    o pkg/seaice:
1595      - restore (last time on 2011/12/24) ability to compile pkg/seaice with
1596        undefined pkg/exf ALLOW_ATM_TEMP or ALLOW_RUNOFF CPP-options.
1597      - only call DIAGNOSTICS_FILL when useDiagnostics=TRUE.
1598    o eesupp/src:
1599      - fix check for overlap-size argument (myOLn.GT.MAX_OLY_EXCH)
1600        in exch1_rx[_ad].template (thanks to Francois Lefeuvre report).
1601    o switch to TAF version-2:
1602      - add flow directives to "freeze" naming convention for ad-routines that
1603        are used in I/O routines of adjoint state and associated common blocks
1604        that are used in adcommon.h (backward compatible with version-1)
1605      - update all ad-optfiles (in tools/adjoint_options + few local to some
1606        verification exp) to switch to latest TAF version (currently 2.5.5);
1607        merge "*_mpi" adoptfiles into the corresponding non-mpi (but commented
1608        out except for diva).
1609      - the major change with TAF version-2 is that both the differentiated
1610        routines and the forward routines (new) are returned as part of the TAF
1611        output source code. Update genmake2 accordingly.
1612      - new output for AD experiment tutorial_global_oce_biogeo (better AD gradient
1613        with version-2 when compared to TLM or FWD gradient); other experiments
1614        output show minor changes (machine truncation level); update the few AD &
1615        TLM output with 12 matching digits only (some prior to version-2 switch).
1616    
1617    checkpoint64l (2013/08/05)
1618    o model/src:
1619      - in dynamics.F, skip the call to CALC_VISCOSITY if momViscosity=F
1620      - main_do_loop.F: no longer includes additional (AUTODIFF) header files
1621        when using TAF but only if using OpenAD.
1622    o pkg/mom_common+fluxform+vecinv:
1623      - always set horiz. viscosity arrays to background value before calling
1624        MOM_CALC_VISC (in MOM_FLUXFORM & MOM_VECINV) and call S/R MOM_CALC_VISC
1625        only when using variable horiz. viscosity (useVariableVisc=T);
1626      - simplify mom_vecinv.F (only 1 block for momViscosity).
1627    o pkg/mom_common: variable horiz. viscosity in NH code
1628      - move horiz-viscosity 3-D arrays viscAh_W & viscA4_W (used in calc_gw.F)
1629        from model/inc/NH_VARS.h to pkg/mom_common/MOM_VISC.h
1630      - store in common block (in MOM_VISC.h) logical parameters: useHarmonicVisc,
1631        useBiharmonicVisc & useVariableVisc.
1632      - fix old bug (already in 1rst implementation of variable horizontal viscosity
1633        in calc_gw.F, version 1.27, 2006/06/20):
1634        horizontal bi-harmonic viscosity in gW was missing when wiscA4W=0
1635        even if variable bi-harmonic viscosity (e.g., viscA4Grid) was non-zero.
1636      - change background horiz viscosity in vertical momentum (gW) to always be
1637        viscAhW,viscA4W (instead of switching to viscAhD, viscA4D when using
1638        any type of variable viscosity, e.g., viscAh/4Grid)
1639      - change default value of viscAhW,viscA4W to viscAhD,viscA4D (instead of
1640        viscAh,viscA4) which default to viscAh,viscA4 :  this avoid missing
1641        horiz. viscosity in W eq when just setting viscAhD/Z,viscA4D/Z (since
1642        default viscAh,viscA4 is zero).
1643    o model/src:
1644      - extend length of drC & recip_drC from Nr to Nr+1.
1645    o Divided Adjoint (DIVA) with MPI:
1646      - genmake2: do not create local ./mpi_headers dir when no file to copy into.
1647      - remove option ALLOW_DIVIDED_ADJOINT_MPI (replaced by ALLOW_DIVIDED_ADJOINT
1648        and ALLOW_USE_MPI) from model/src code and from ECCO_CPPOPTIONS.h.
1649    
1650    checkpoint64k (2013/07/23)
1651    o tools/OAD_support:
1652      - avoid the need for file "oadtempflile" in insertTemplateDir.bash
1653        and remove it from genmake2.
1654    o tools/build_options:
1655      - remove MPI_HEADER_FILES_INC setting (no longer used) and comment out
1656        MPI_HEADER_FILES list (let genmake2 find the missing headers)
1657    o verification/halfpipe_streamice:
1658      - change to driving stress formulation; update both Fwd & AD output.
1659    o tools/genmake2 and Divided Adjoint with MPI:
1660      - remove default setting of MPIINCLUDEDIR from $MPIHOME (always been broken);
1661      - only create local ./mpi_headers dir if using MPI and MPIINCLUDEDIR is set;
1662      - add new variable (LOCAL_MPI_HEADERS, replace MPI_HEADER_FILES_INC) in
1663        Makefile, which is set by genmake2, and check which mpi-headers are needed.
1664        Note: need to update adjoint_options/adjoint_diva_mpi accordingly.
1665      - update target "CLEAN" (to also remove ./mpi_headers/ dir).
1666    o testreport:
1667      - changes for Divided Adjoint Run: when file "run_ADM_DIVA" is present,
1668        perform additional runs (number of additional runs is "add_DIVA_runs" taken
1669        from file run_ADM_DIVA ; should match "nchklev_3" in file "code_ad/tamc.h").
1670    o verification/lab_sea (AD test):
1671      - change to test Divided Adjoint Run in this set-up (both standard AD test
1672        and 2 secondary AD test: noseaice + noseaicedyn); drop the evp AD test.
1673    o pkg atm_ & ocn_compon_interf:
1674      - remove cpl_earlyExpImpCall=F option (was mainly a hack added for the old
1675        staggerTimeStep implementation) and disable (retired) corresponding
1676        parameter.
1677    o pkg/offline:
1678      - comment out unused field-array: ICEM, ConvectCount, hflx[01], icem[01];
1679      - add S/R OFFLINE_CHECK to print offline parameter summary
1680        and stop if loading a file that is not used;
1681      - enable to calculate GMRedi tensor, KPP mixing and convective index
1682        when the corresponding file(s) is/are not specified (but pkg is used).
1683      - comment out resetting of monitorFreq (to endTime) since it still useful
1684        for monitoring CFL numbers and checking offline fields.
1685    o OpenAD:
1686      - do not define OAD_DEBUG (in tools/adjoint_options/adjoint_oad) to get
1687        smaller standard output) and generate new (smaller) output (on baudelaire
1688        using gfortran with -ieee) for exp. tutorial_tracer_adjsens
1689    o model/src:
1690      - call EXTERNAL_FORCING_SURF outside bi,bj loops (in do_oceanic_phys.F),
1691        (where external_forcing_adjust was called) and change list of arguments;
1692      - merge external_forcing_adjust.F into external_forcing_surf.F
1693      - put surface relaxation of SST & SSS in new S/R (forcing_surf_relax.F)
1694        which also contains balancing surface relaxation (ALLOW_BALANCE_RELAX,
1695        previously in file "balance_relax.F", now removed); remove corresponding
1696        arrays in FFIELDS.h.
1697      - EXTERNAL_FORCING_SURF is now called when using pkg/offline; implement
1698        a hack for getting back surfaceForcingS (loaded from file) when using
1699        ALLOW_OLD_VIRTUALFLUX (pkg/dic, in DIC_OPTIONS.h) in offline set-up.
1700      - update output of AD test experiment global_ocean.cs32x15.seaice_dynmix
1701        (was getting only 11 digits for AD-grad, due to different truncation
1702         error in AD code).
1703    
1704    checkpoint64j (2013/07/04)
1705    o pkg/offline:
1706      - to enable the use of other features with pkg offline (e.g., obcs),
1707        also call S/R DO_OCEANIC_PHYS in offline run - more modifs to come.
1708      - comment out "allowFreezing" (now active) in 2 offline testing exp.
1709    o pkg/exf ALLOW_RUNOFTEMP
1710      - fix sign and make compatible with temp_EvPrRn .NE. UNSET_RL
1711      - ahdded RUNOFTEMP test to verification/global_ocean.cs32x15/input.seaice
1712      - changes verification/global_ocean.cs32x15/results/output.seaice.txt
1713    o pkg/atm_phys:
1714      - allows to add some damping on uVel,vVel (strength only function of k).
1715    o verification, ad-tests:
1716      - reduce length of the simulation for AD test: global_ocean.cs32x15.seaice,
1717        global_ocean_ebm and offline_exf_seaice.thsice.
1718    o verification/halfpipe_streamice:
1719      - found a bug in s/r pkg/streamice/streamice_advect_thickness which caused
1720        flux input boundary conditions to be ignored; a fix for this bug changed
1721        verification results for forward test.
1722      - add adjoint test.
1723    o pkg/ptracers:
1724      - allow to restart without SOM pickup (resetting SOM to zero).
1725    o pkg/gmredi:
1726      - New parameterisation for the calculation of K and (GM_PsiX,GM_PsiY) added.
1727      - It uses mixing length theory and suppression by steering level effects to
1728        calculate a diffusivity used in the Redi tensor (see Bates et al., submitted
1729        to JPO, for more details).
1730      - It also uses the diffusivity to calculate an eddy induced streamfunction
1731        based on a PV closure (rather than a buoyancy closure as in GM).
1732      - New files added to pkg/gmredi:
1733        gmredi_k3d.F calculates the diffusivity for the Redi tensor and the eddy
1734          induced overturning streamfunction (called from gmredi_calc_tensor)
1735        gmredi_calc_eigs.F calculates the eigenvalues and eigenvectors required
1736          for use in gmredi_k3d
1737        gmredi_calc_urms.F calculates the the rms eddy velocity used to calculate
1738          the eddy diffusivity
1739    
1740    checkpoint64i (2013/06/18)
1741    o pkg/cheapaml:
1742      - take src files from MITgcm_contrib/verification_other/offline_cheapaml/code
1743        that enable the use of seaice (pkg/thsice thermo & pkg/seaice dynamics)
1744        with pkg/cheapaml.
1745    o utils/python: add subpackage for cubed sphere function, first example is
1746        simple cs.pcol to plot 2D fields on a map
1747    o pkg/streamice:
1748      - This is a new package in MITgcm, which solves dynamic equations for ice
1749         sheets and ice streams
1750      - At the moment it is independent of atmosphere/ocean dynamics, or any
1751        other physical packages in MITgcm, even ShelfIce (although it is anticipat-
1752        ed that this will change)
1753      - There is a new verification exercise that tests it, halfpipe_streamice,
1754        evolves a 40x80 km ice stream/ice shelf (at coarse resolution) in a
1755        rectangular embayment
1756      - halfpipe_streamice is forward-only for now, will have TAF test soon
1757      - for questions, email dgoldber@mit.edu
1758    o pkg/thsice:
1759      - fix filling of snow-precip diagnostic (SIsnwPrc) (left from the removing
1760        of snowPrc from common bloc, on May 2nd, thsice_step_fwd.F revision 1.40);
1761      - remove diagnostics 'SI_FrcFx' ( now identical to 'SI_Fract' with new
1762         call sequence: ice-Thermo(thsice),ice-Dyn,ice-Advect );
1763      - allow precip from pkg/cheapaml to make snow over seaice.
1764    o pkg/cfc:
1765      - move in separated header file (CFC_ATMOS.h) time-serie arrays of Atmos CFC
1766      - remove atmos CFC 2-D arrays from common bloc (now local variables)
1767      - change some hard-coded constant to run time parameter for reading and
1768        and interpolating atmospheric CFC ; keep same default as previously.
1769      - more flexible reading of Atmos CFC (number of records no longer hard-coded)
1770      - put arguments in standard order: myTime, myIter, myThid
1771      - use standard S/R GET_PERIODIC_INTERVAL for time interpolation of
1772        atmospheric CFC ; fix for the case myIter < PTRACERS_iter0.
1773      - fix calculation of surf tendencys for partial-cell and/or Non-Lin Free-Surf
1774      - new routine to print summary of CFC params and check for consistency.
1775    o pkg/seaice: add uice/vice to the parameter list of s/r seaice_advdiff,
1776      similar to thsice_advdiff.
1777      Note that for the B-grid case the routine parameters uc/vc are overwritten.
1778    o pkg/cfc:
1779      - change time interpolation for atmospheric CFC-11 (now same as for CFC-12);
1780        update output (CFC-11) of experiment cfc_example and tutorial_cfc_offline.
1781      - fix interpolation of atmphspheric CFC between Sorthern and Northern
1782        hemisphere value.
1783    o pkg/seaice:
1784      - allow to use seaice dynamics without pkg/exf (e.g., using pkg/cheapaml)
1785    o pkg/seaice: add Adams-Bashforth2 time discretization for ice dynamics;
1786                  so far only for JFNK-solver, turn on with SEAICEuseAB2 = .TRUE.
1787      - requires an additional time level that is stored in the pickup
1788      - you can start with AB2 from a pickup without this time level with
1789        pickupStrictlyMatch = .false.
1790    
1791    checkpoint64h (2013/05/26)
1792    o pkg/cheapaml:
1793      - replace one ()**.5 with SQRT + use temp var "cdu = tau/Du" (coare3_flux);
1794        affect machine truncation (but exp cheapAML_box still pass with 13 digits).
1795      - consistent treatment of uWind,vWind location: assume everywhere in
1796        pkg/cheapaml that they are on C-grid (@ uVel,vVel location)
1797        (Note: was already the case for Tair,Qair advection);
1798        add option (INCONSISTENT_WIND_LOCATION) to recover old results.
1799      - compute diabatic forcing only in the interior (excluding overlap regions)
1800      - fill in array "Qsw" (for short-wave heating);
1801      - add diagnostic for precip ; fill-in diagnostics for cheapAML state vars
1802        before any update (consistent with MITgcm state var diagnostics);
1803      - cheapaml_fields_load.F & cheapaml_init_varia.F : only fill outer edges if
1804        non periodic ; + adjusted for uWind,vWind (C-grid).
1805    o pkg/seaice:
1806      - remove dependence of pkg/seaice versus pkg/exf (file: pkg/pkg_depend) and
1807        add explicitly pkg/exf in experiments that currently use pkg/seaice.
1808      - allows to compile pkg/seaice without pkg/exf.
1809    o tools/OAD_support:
1810      - use a local copy (ourRWCPinBd) to ensure index ourRWCP stays within bounds
1811        of array "ourStepOf" in function rvNextAction (revolve.F90).
1812    o pkg/aim_compon_interf renamed to pkg/atm_compon_interf
1813      - change pkg name (to be used with other atmospheric physics pkg)
1814        but by-pass CVS when making the new pkg so that we keep the CVS history.
1815    o pkg/offline:
1816      - call OFFLINE_FIELDS_LOAD from pkg/offline/offline_init_varia.F
1817        (previously called from pkg/dic_surfforcing_init.F)
1818    o model/src:
1819      - re-order sequence of calls within packages_init_variables.F, using
1820        standard order, except for:
1821         DIAGNOSTICS_INIT_VARIA and OFFLINE_INIT_VARIA (called @ the top),
1822         CTRL_MAP_INI and OBCS_INIT_VARIABLES (called @ the bottom)
1823    o new pkg: atm_phys
1824      - add entry point and source code (previously in contrib
1825          verification_other/atm_gray/code_gray/) for new pkg "atm_phys"
1826        (atmospheric physics pkg from P. O'Gorman and T. Schneider, JCl, 2008).
1827      - re-order sequence of calls within packages_readparms.F,
1828         packages_init_fixed.F and packages_write_pickup.F
1829        (but skip packages_init_variables.F because of TAF issues).
1830      - update contrib/*/atm_gray/ experiment.
1831    o pkg/seaice (ITD code):
1832      - simplify and fix the writing of pickup-files for ITD case
1833    o pkg/seaice (ITD code):
1834      - introduce floe size dependent lateral melt for ITD case;
1835      - cleaning (avoid division by zero, change to f77 syntax, remove tabs)
1836      - update seaice_itd experiment main output.
1837    o pkg/thsice:
1838      - remove snowPrc from common block THSICE_FLUX, in THSICE_VARS.h and
1839        declared it locally (without bi,bj) in thsice_main.F & aim_do_physics.F;
1840        changed accordingly pkg/atm2d.
1841    
1842    checkpoint64g (2013/05/01)
1843    o pkg/exf ALLOW_RUNOFTEMP
1844      - if defined,  river and glacier runoff temperature can be read-in from
1845        runoftempfile; runoftempfile needs to have same format as runofffile
1846    o pkg/thsice (& pkg/bulk_force):
1847      - In case Energy-Reference-Level (ERL) is used (temp_EvPrRn=0), account
1848        for energy content of Precip + RunOff & Evap (like with pkg/exf).
1849      - change computation domain to always be the interior (without overlap).
1850      - fix bug (wrong overlap) when using EXF and stressReduction > 0.
1851    o verification/tutorial_global_oce_biogeo:
1852      - add preliminary OpenAD setup (still has problems)
1853    o pkg/seaice:
1854      - turn some parameters for choosing the convergence criterion of
1855        the inexact Newton method (JFNK) into runtime parameters for convenience
1856      - clean up seaice_calc_viscosities.F: remove/retire two options for
1857        SEAICetaZmethod (1,2), introduce area weighting for method 3; this changes
1858        the results of lab_sea/input because a division has been replaced by
1859        a multiplication with the reciprocal (sumNorm)
1860      - modify offline_exf_seaice/input.dyn_jfnk/data.seaice to improve
1861        convergence of solver (changes results, of course), and to test some
1862        new features
1863    o model/src:
1864      - remove unused (since Aug 2006) S/R SET_WRITE_GLOBAL_PICKUP and its call.
1865      - remove unused forcing field "dQdT" and associated parameter "dQdTFile".
1866      - move forcing adjustment (balancing surface forcing) in specific S/R
1867        where might also be applied exchanges (if needed) to forcing arrays.
1868    o pkg/shelfice:
1869      - allow to specify the Ice-Shelf mass per unit area (instead of
1870        shelficeLoadAnomaly) and do the conversion from one to the other
1871      - move loading from file of shelficeLoadAnomaly from SHELFICE_INIT_VARIA
1872        to SHELFICE_INIT_FIXED: (a) avoid some TAF recompution issues and
1873        (b) will be loaded in time (before calling INI_PRESSURE) in case it is
1874        needed in phi0surf for initial pressure calculation when useDynP_inEos_Zc
1875      - update isomip experiment forward output (get machine truncation error
1876        from conversion shelficeLoadAnomaly -> shelficeMass -> shelficeLoadAnomaly)
1877    o verification/offline_exf_seaice:
1878      revise data.seaice in input.thermo and input_ad and update results accordingly
1879        HO = 0.2, SEAICE_areaLossFormula = 2,
1880        SEAICE_growMeltByConv = .TRUE.,
1881        SEAICE_doOpenWaterMelt = .TRUE.,
1882      Improve consistency with input.thsice and fix the spurious 500m ice corners
1883    o verification/global_ocean.cs32x15:
1884      - set Energy Reference Level to liq. water @ 0 degC: temp_EvPrRn=0.,
1885        in icedyn (thsice+seaice-dyn) test and update output.
1886    o verification/offline_exf_seaice:
1887      - adjust list of tested variables (with testreport) and update
1888        standard test output with better slection of monitored fields.
1889    o pkg/cd_code:
1890      - swtich off Adams-Bashforth on the 1rst iteration. Update output of
1891        experiment lab_sea.hb87
1892    o tools/genmake2:
1893      - change default makedepend from the system default to tools/xmakedepend:
1894        When no makedepend is specified, select tools/xmakedepend it the test pass,
1895        otherwise select the system default (if exist and pass the test) or
1896        try to build cyrus-makedepend ; stop if none of the 3 works.
1897    o pkg/exf & pkg/thsice:
1898      - In case Energy-Reference-Level (ERL) is used (temp_EvPrRn=0), account
1899        for energy content of Precip + RunOff & Evap. Assumes:
1900       1) Rain has same temp as Air.
1901       2) Snow has no heat capacity (consistent with seaice & thsice pkgs)
1902       3) Run-Off comes at the temp of surface water (with same Cp)
1903       4) Evap over ocean is released to the Atmos @ surf-temp (=SST); should be
1904        put directly into Latent Heat flux & should use water-vapor heat capacity.
1905       5) Evap over snow/seaice (pkg/thsice) assumes constant Lf+Lv (consistent
1906        with snow having no Cp) => water vapor is released to Atmos @ 0^oC (=ERL).
1907    o pkg/seaice: simplify the use of CPP flags in JFNK-related files
1908        (compile when SEAICE_ALLOW_JFNK is defined)
1909    o pkg/thsice:
1910      - fix oceanic flux diagnostics & timeave (left from new sequence of calls
1911        implementation): move THSICE_AVE call after the advection (called directly
1912        from thsice_do_advect.F).
1913    o verification/global_ocean.90x40x15 and OpenAD:
1914      New experiment for OpenAD is identical to the one in input_ad except that
1915        multiDimAdvection=.FALSE.,
1916      There is still an issue with this.
1917    o pkg/thsice:
1918      - account for ice velocity (ocean relative velocity) in turbulent heat flux
1919        at the base of the ice; update output of global_ocean.cs32x15 (icedyn)
1920        and offline_exf_seaice (main test).
1921    
1922    checkpoint64f (2013/03/31)
1923    o verification/OpenAD:
1924      - new (smaller, without OAD_DEBUG) output_oadm.txt generated using gfortran.
1925    o verification/isomip, pkg/shelfice and OpenAD:
1926      - add OpenAD setup to this exp and make shelfice package work with OpenAD
1927    o verification/tutorial_global_oce_biogeo:
1928      - update AD and TLM output after turning off ALLOW_FE (in DIC_OPTIONS.h)
1929    o verification/offline_exf_seaice:
1930      - replace adjoint experiment (now similar to fwd input.thermo/ setup).
1931    o verification/tutorial_tracer_adjsens, pkg/ptracers and OpenAD:
1932      - add OpenAD setup to this exp and make ptracers package work with OpenAD
1933    o pkg/seaice/seaice_evp.F:
1934       mask the asymmetric contribution of the ice-ocean stress (when
1935       the turningAngle is non-zero) over open water to avoid stripes
1936       in the EVP-solutions after many EVP-substeps. This does not change
1937       the verification experiment (because turningAngle=0 in that experiment),
1938       but will affect other EVP solutions with turningAngle.ne.0
1939    o verification, AD & TLM output:
1940      - new TAF version 2.3.10 (previously 2.3.8) add more parenthesis in multiple
1941        additions and multiplications which affect results at machine truncation
1942        level. Update few AD output (1D_ocean_ice_column, bottom_ctrl_5x5,
1943        lab_sea.noseaicedyn & offline_exf_seaice) and TLM output
1944        (1D_ocean_ice_column & tutorial_tracer_adjsens.som81) which had only 12
1945        digits of matching.
1946    o pkg/seaice:
1947       modify lsr-algorithm so that it vectorizes AND converges by using a
1948       "zebra" method: split vector loop into two with step size 2; this
1949       solves a general convergence problem for the JFNK solver on a vector
1950       computer. It has the potential to even improve convergence for
1951       non-vector machines, but it does change the results so it is turned
1952       off by default. To turn on define CPP-flags SEAICE_VECTORIZE_LSR and
1953       SEAICE_VECTORIZE_LSR_ZEBRA in SEAICE_OPTIONS.h
1954    
1955    checkpoint64e (2013/03/05)
1956    o pkg/ecco and several verification experiments:
1957       Remove special versions of the_model_main.F, the_main_loop.F, forward_step.F
1958       from ecco package, and revert to unified routine in model/src/
1959       Adjust verification experiments accordingly, especially gloal_oce_llc90
1960       Should conclude long-standing work by Gael to reconsile the_main_loop with
1961       ECCO and will enable OpenAD's revolve loop in ECCO setup.
1962    o pkg/generic_advdiff:
1963      - implement compressible flow method for multi-dim advection (similar to
1964        gad_som_advect.F); add new option "GAD_MULTIDIM_COMPRESSIBLE" (since
1965        TAF generates many recomputations) to use it; no yet coded with implicit
1966        vertical advection.
1967      - change experiment advect_cs (new output) and advect_xy (same output)
1968        to test compressible flow multi-dim advection.
1969    o pkg/generic_advdiff:
1970      - fix SOM advection for unusual cases (linear Free-Surf in r*, other
1971        cases where linear Free-Surf is not @ k=1, e.g., useShelfIce)
1972    o pkg/seaice:
1973      - fix bug in the no-slip implementation in seaice_calc_strainrates.F, this
1974        bug affects two verification experiments (lab_sea and lab_sea.hb87),
1975        recover old (wrong) results by setting noSlipFac = 2. in
1976        seaice_calc_strainrates.F;
1977      - add another averaging method for etaZ (etaZmethod=3), a mix of 2 and 0
1978      - add runtime parameter SEAICE_JFNKepsilon for that finite difference
1979        gradient in the Jacobian times vector operation (s/r seaice_jacvec)
1980      - fix line search in seaice_jfnk.F (s/r seaice_jfnk_update)
1981    o pkg/seaice: reorganize seaice_lsr.F to be able to reuse more code:
1982      - new subroutines seaice_lsr_tridiagu/v
1983      - introduce loop bounds i/jmin/max to be able to use a restricted
1984        additive Schwarz method, but not used for now.
1985      - rename SEAICE_CALC_LSR_COEFFS into SEAICE_LSR_CALC_COEFFS
1986      - use new subroutines seaice_lsr_tridiagu/v in s/r seaice_preconditioner
1987    o OpenAD support
1988       Reorganize S/R call for overall time-stepping loop to facilitate
1989       OpenAD revolve loop replacement
1990       (new S/R main_do_loop.F)
1991    o model/src:
1992      - add 3-D array 3rd dimension to argument list of S/R ADAMS_BASHFORTH2/3;
1993      - pkg/cheapaml: remove local S/R ADAMS2d and use instead standard S/R
1994        ADAMS_BASHFORTH2.
1995    o pkg/cheapaml:
1996      - add new parameter (default=F, same as before) to disable full domain
1997        (including land) periodicity in X & Y dir.
1998      - new S/R CHEAPAML_COPY_EDGES to copy relaxation field into edges of
1999        prognostics field ; merge the 2 S/R cycle_2d_tracer and timestep_2d_tracer
2000        into single S/R CHEAPAML_TIMESTEP.
2001    
2002    checkpoint64d (2013/02/17)
2003    o pkg/monitor (angular momentum):
2004      - do not add Eta contribution to the total AM if using rigid-lid;
2005      - correct for Adams-Bashforth in zonal-wind part (instead of in AM_eta).
2006      - horizontal discretisation: compute Zonal wind contribution separately for
2007        each component (instead of from cell centered averaged) and use the 4
2008        grid-cell corner averaged value of Omega*(R*cos_Phi)^2 in AM_eta part.
2009      - Check that AM is conserved with linear dynamics (momAdvection=F and linear
2010        FreeSurf) if using vectorInvariant momentum.
2011    o model/src (horizontal grid):
2012      - move initialisation of all horizontal grid arrays to null value
2013        from specific horizontal grid S/R to main S/R INI_GRID;
2014      - add 2 new arrays to project model C-grid velocity on to zonal direction
2015        (similar to AngleCosC & -AngleSinC but at U and V point location) and
2016        compute them in S/R CALC_GRID_ANGLES.
2017    o pkg/seaice: replace a hard coded parameter by a runtime parameter
2018        SEAICE_JFNK_tolIter
2019    o pkg/seaice: introduce a restricted additive Schwarz (RAS) method in
2020        preconditioner for JFNK (run LSR into the overlaps as far as possible,
2021        i.e OLx/y-2, but overwrite the solution in the overlaps)
2022      - extend loop range in seaice_calc_viscosity
2023      - add new parameters SEAICE_OLx/y (default = OLx/y-2)
2024      - add flexible loop ranges to seaice_preconditioner, seaice_calc_lsr_coeffs
2025      - slightly modify loops in tridiagonal solver lsr-preconditioner
2026      - by default remove the extra exchange in seaice_preconditioner with a
2027        replacement of an undocumented CPP flag by SEAICE_PRECOND_EXTRA_EXCHANGE
2028      - modify offline_exf_seaice so that old results without RAS are reproduced
2029        for output.dyn_jfnk.txt
2030      in seaice_fgmres.F (unrelated to RAS)
2031      - add a cpp-flag option for a re-ordered mapping (potentially more
2032        efficient), but because this changes the results, turn it off by
2033        default
2034      - replace the save statement by local common blocks
2035    o utils/matlab:
2036      - fix tile-offset in rdmnc.m when output was produced using EXCH2.
2037      - update cs_grid/bk_line scripts to use load_grid.m (in utils/matlab)
2038        instead of local script "load_cs.m".
2039    o pkg/seaice:
2040      - fix a serious bug in seaice_fgmres.F, s/r seaice_scalprod, connected
2041        to the scalarProductMetric and the unrolling. By chance this does not
2042        change the verification experiment, because of the particular domain
2043        decomposition
2044    o pkg/diagnostics:
2045      - change default missing_value from UNSET_RL to -999.
2046    o pkg/layers: improve vectorization of layers_fluxcalc.F
2047      - step 1: split loops, make TatU/V 2D arrays. This alone reduces the cpu
2048        time spent in this routine by more than a factor of 3 on an NEC-SX8
2049      - step 2: replace search algorithm by a bisection algorithm found in
2050        Press et al. Numerical Recipes in Fortran. This algorithm can be
2051        vectorized and finds the correct bin in approx. log2(Nlayers) steps.
2052        For now, use this algorithm only for TARGET_NEC_SX defined.
2053      - moved the search algorithm into a separate subroutine, that is kept
2054        within the same file for automatic inlining.
2055      - modified catching potential errors
2056    o pkg/ecco:
2057      - add compile switches ALLOW_SHALLOW_ALTIMETRY and ALLOW_HIGHLAT_ALTIMETRY.
2058    o model/src, pkg/autodiff, pkg/ctrl, pkg/grdchk :
2059      - modifications for ALLOW_GENTIM2D_CONTROL
2060      -- forward_step.F, the_main_loop.F : pass options and arrays for adjoint tapes.
2061      -- load_fields_driver.F : add call to CTRL_MAP_GENTIM2D( myTime, myIter, myThid )
2062      -- add xx_gentim2d0/1 in ctrl_ad_check_lev1_dir.h checkpoint_lev1_directives.h etc
2063      -- use ctrl_swapffields.F (new) instead of exf_SwapFFields.F in ctrl_get_gen.F
2064    o model/src:
2065      - account for moist thermodynamics in (dry) potential temperature equation;
2066        update results of experiments: aim.5l_cs (x2), fizhi-cs (std + aqualev)
2067        and cpl_aim+ocn.
2068      - also switch to standard compiler (gfortran, was using ifort previously)
2069        for fizhi-cs experiments reference output.
2070    o pkg/ctrl:
2071      - 1st step toward generic time-varying control variable (2D) via CPP option
2072        ALLOW_GENTIM2D_CONTROL
2073      - note new namelist ctrl_nml_genarr in data.ctrl
2074    o verification/global_ocean.cs32x15:
2075      - switch off OLD_THSICE_CALL_SEQUENCE (both forward and AD code) to use new
2076        thsice calling sequence and update "output.icedyn.txt" output file.
2077    o pkg/ptracers:
2078      - from Ryan A.: code to allow to restart a tracer at regular time interval
2079        specifying a reset frequency and a reset-phase (for each tracers).
2080    o pkg/thsice:
2081      - implement new sequence of calls for thsice+seaice:
2082          previously:   ice-Dyn,ice-Advect,ice-Thermo(thsice)
2083          new sequence: ice-Thermo(thsice),ice-Dyn,ice-Advect
2084      - allows (with temporary CPP option "#define OLD_THSICE_CALL_SEQUENCE"
2085        in CPP_OPTIONS.h) to recover old sequence;
2086      - update diagnostics for Intermediate State thsice diagnostics: now filled
2087        just before advection (instead of just after advection in old sequence);
2088      - update output of experiment offline_exf_seaice (standard test);
2089      - in global_ocean.cs32x15 exp., postpone output.icedyn.txt update
2090        by setting #define OLD_THSICE_CALL_SEQUENCE in CPP_OPTIONS.h
2091    o pkg/aim_v23:
2092      - use tiled array for aim_CO2 and surface wind speed for export to coupler;
2093      - use standard pkg/mdsio routines to read & write CO2 pickup file;
2094      - in-line S/R AIM_AIM2DYN_EXCHANGES in aim_do_physics.F;
2095      - Implement new sequence of calls for seaice advection (with thsice and
2096        seaice diffusion): do ice advection after ice-Thermodynamic (previously
2097        was done before); change aim_do_physics.F (split the bi,bj loops block);
2098      - use same CPP option (OLD_THSICE_CALL_SEQUENCE) to recover old sequence;
2099    o pkg/thsice:
2100      - add a missing EXCH of sIceLoad in thsice_main.F (ocean set-up) for the case
2101        where just seaice diffusion is used without seaice-dynamics.
2102    
2103    checkpoint64c (2013/01/18)
2104    o pkg/seaice:
2105      - add a parameter JFNKres_tFac that can replace JFNKres_t
2106        (= JFNKres_tFac*JFNKresidual before JFNK solver)
2107      - add a line search option to the JFNK solver
2108      - move update of u/vIce and computation of initial residual into a separate
2109        routine (same file); makes the code a little easier to read (?)
2110      - the line search requires computation of the residual and for some reason
2111        I cannot do the update of u/vIce at the beginning of the Newton loop
2112        without changing the results, so we move computation of the new residual
2113        also to the end of the Newton loop, even without the line search
2114    o pkg/mdsio:
2115      - write missing value (corresponding to undefined array value) to meta files;
2116        skip this if missing value is one (UNSET_RL would be a better value for the
2117        case of undefined missing value but it's current the default missing-value);
2118        Also update mdsio_read_meta.F (reading timeInterval & missing-value).
2119    o pkg/exf & thsice:
2120      - for diagnostics purpose, fill-up and update Qsw array (+ fill the
2121        diagnostics) even when SHORTWAVE_HEATING is #undef;
2122    o verification/cfc_example:
2123      - turn on pkg/layers with pkg/diagnostics (to test pkg/layers and to
2124        illustrate how to use it).
2125    o verification/offline_exf_seaice:
2126      in input: add SEAICErestoreUnderIce=.TRUE., and reduce size of forcing
2127        files to only one time-record.
2128      in input.thermo: narrow the 2 bands of low initial ice-concentration near
2129        N & S edges; switch on SEAICErestoreUnderIce=T; use pkg/diagnostics for
2130        snapshot output; same mcPheePiston value as in thsice with
2131        surf-current=0.2m/s.
2132      in input.thsice: similar set-up as in input.thermo (channel with same seaice
2133        initial conditions).
2134    o verification/cfc_example:
2135      - update file "data" with more standard choice (default rotationPeriod,
2136        exactConserv=T, reduce ivdc_kappa to 10, remove multiDimAdvection=F,
2137        set deltaTFreeSurf to deltaTtracer) and update the output.
2138    o pkg/layers:
2139      - fix bolus part so that it compiles with #undef GM_BOLUS_ADVEC;
2140      - ensure that "layers_bolus" is switched to False when useGMRedi=False.
2141    o verification/offline_exf_seaice:
2142      - set all {field}period to zero for constant-in-time forcing (not tested
2143        anywhere else).
2144    o verification/offline_exf_seaice:
2145      - dyn_lsr  : use pkg/seaice S/R (instead of pkg/thsice) to advect sea-ice;
2146      - dyn_jfnk : use pkg/thsice S/R (instead of pkg/seaice) to advect sea-ice.
2147    o model/src:
2148      - implement Finite-Volume method for (hydrostatic) presure gradient
2149        from S.-J. Lin (QJRMS 1997), for atmosphere using sigma-coordinate.
2150    o pkg/seaice: implement EVP* by Lemieux et al. (2012).
2151      - In order to be compatible with the default EVP code, this requires changing
2152        the EVP code around a little; and because any small change immediately
2153        breaks the lab_sea.hb87 verification experiment, the reference output is
2154        updated two times (each time the remaining aggrement was only 2 digits):
2155        - after replacing 1/dt by 1*recip_dt with a precomputed recip_dt
2156        - after replacing 1/(1+0.5*dt/tau) by a/(a+1), with a=2*tau/dt
2157        The adjoint test lab_sea.evp also needed to be updated.
2158      - Turn on EVP* by setting SEAICE_deltaTevp as before, and setting
2159        SEAICEuseEVPstar=.true.; for EVP* SEAICE_deltaTevp does not need to be
2160        a factor of SEAICE_deltaTdyn, and you can set the number of EVP steps
2161        explicitly with SEAICEnEVPstarSteps (thereby overriding the default of
2162        INT(SEAICE_deltaTdyn/SEAICE_deltaTevp)). Controlling EVP* is deliberately
2163        kept obscure, because I need to test it a little more.
2164    o pkg/cheapaml:
2165      - fix few incorrect type (_RL/_RS) in subroutine calls.
2166    o pkg/seaice:
2167      - new S/R SEAICE_MAP_RS2VEC (similar to SEAICE_MAP2VEC) to map _RS arrays
2168        to _RL vector; this fixes JFNK code when compiling with "-use_r4" option.
2169    o model/src:
2170      - add a warning if using select_rStar=2 with nonlinFreeSurf <> 4;
2171        change (in input_ad*/data) select_rStar from 2 to 1 for AD verification
2172        experiments global_ocean.cs32x15 & tutorial_tracer_adjsens (+ update output)
2173    o pkg/cheapaml:
2174      - replace "273.1 _d 0" by celsius2K in pkg/cheapaml/cheapaml.F and
2175        update output of experiment cheapAML_box.
2176      - store in CHEAPAML.h coeffs ssq[0:2] for saturation specific humidity,
2177        and set them only in one place (cheapaml_readparms.F).
2178      - replace "273.16 _d 0" by celsius2K & replace "3.14159 _d 0" by constant "PI"
2179      - remove re-setting of main-model parameter "celsius2K" (in cheapaml_readparms)
2180        and re-setting of cheapAML params "lath" & "p0" (in cheapaml_init_varia).
2181    o model/src/the_main_loop.F:
2182      - fix revision 129 : need both ALLOW_ECCO and ALLOW_ECCO_EVOLUTION.
2183    o pkg/seaice:
2184      - remove legacy branch code.
2185      - retire SEAICE_GROWTH_LEGACY and SEAICE_CAP_HEFF accordingly.
2186    o verification/*/code*/SEAICE_OPTIONS.h:
2187      - remove documentation for retired CPP flags (SEAICE_GROWTH_LEGACY,
2188        SEAICE_CAP_HEFF).
2189    o pkg/cheapaml:
2190      - use standard routine (S/R GET_PERIODIC_INTERVAL) to decide when it is time
2191        to load new forcing fields.
2192      - add missing "_d 0" where it's needed; + some editing (improve indentation).
2193      - remove switch to "-r8" compiler option (no longer needed) in verification
2194        cheapAML_box, keep same output (small trucation error differences).
2195    o verification/offline_exf_seaice:
2196      - add thermodynamics only test.
2197    o verification/cheapAML_box:
2198      - split the domain in 8 (2x4) tiles; add MPI and multi-threaded test;
2199        keep same output (same 14 digits for cg2d).
2200      - switch on "-r8" compiler option (some numerical values are missing
2201        the "_d 0") and update output (only 6 digits for cg2d were preserved).
2202    
2203    checkpoint64b (2012/12/24)
2204    o pkg/cheapaml:
2205      - remove un-used variables (Qnet,EmPmR) from pickup files.
2206      - store tendency of advected variables into cheapaml pickup file
2207        and fix the AB-2 restart.
2208    o verification/offline_exf_seaice and lab_sea adjoint:
2209      - switch to new code (#undef SEAICE_GROWTH_LEGACY).
2210      - switch to 4 time steps in offline, consistent with lab_sea.
2211      - match parameters from SEAICE_GROWTH_LEGACY branch in data.seaice.
2212      - update results after change of experiment seaice.
2213    o pkg/seaice:
2214      - remove option SEAICE_MULTICATEGORY; has been replaced with run-time
2215        parameter SEAICE_multDim. Issue a warning if SEAICE_MULTICATEGORY is
2216        still defined since SEAICE_multDim needs to be set to MULTDIM value (from
2217        SEAICE_SIZE.h) to recover previous #define SEAICE_MULTICATEGORY default.
2218    o model/src:
2219      - add run-time parameter to select CG2D solver minimum-residual solution
2220        (in case of a poor convergence).
2221    o pkg/seaice/seaice_lsr.F
2222      - move calculation of matrix coefficients into new
2223        S/R SEAICE_CALC_LSR_COEFFS; for now this routine remains in the same
2224        file; the main purpose of this change is to be able to reuse the code
2225        in S/R SEAICE_PRECONDITIONER
2226      - modify the computation of the residual so that the mass of sea-ice
2227        is not used twice; this simplifies the calculations, but since
2228        the residual is never used except when LSR_mixIniGuess.ge.4---and this is
2229        not tested in testreport---this does not affect the testreport results.
2230    o verification/seaice_obcs:
2231      - disable SEAICE_GROWTH_LEGACY; reset input files to match those of
2232        verification/lab_sea/input.salt_plume; changes results/output.txt*
2233    o model/src:
2234      - adapt quasi-hydrostatic formulation to work with p or p* coordinate.
2235    o pkg/seaice:
2236      - improve description of parameters in seaice_fgmres.F and start
2237        cleaning up the code
2238      - change name of SCALPROD to SEAICE_SCALPROD and modify meaning of
2239        second argument
2240      - add a metric based on grid cell area to SEAICE_SCALPROD; update
2241        results of offline_exf_seaice.dyn_jfnk
2242      - compute initial residual norm in seaice_jfnk based on SEAICE_SCALPROD
2243    o pkg/aim_v23:
2244      - fix an other bug in dissipation heating (grid-cell area was missing).
2245    o model/src + pkg/seaice:
2246      - add global (multi-tile) linear solver for pair of tri-diagonal system
2247        along X and Y lines, respectively for U and V component.
2248        Note: 1) MPI and cube-exchange not yet coded.
2249            2) probably not accurate for poorly conditioned / large size problem.
2250      - add option for SEAICE_LSR to use global (multi-tile) tri-diagonal solver;
2251        default: not compiled and not used.
2252    o pkg/seaice:
2253      - first attempt at a multi-threaded fgmres solver for the JFNK solver:
2254        introduce bi/bj loops and use global_sum_tile_rl instead of
2255        mpi_allreduce in seaice_fgmres.F
2256      - improve diagnostics output for fgmres solver (seaice_fgmres.F)
2257      - replace a few unnecessary goto statements by if-blocks  (seaice_fgmres.F)
2258      - add a verification experiment for JFNK in offline_exf_seaice
2259    o verification:
2260      - change (for now, only fwd test) offline_exf_seaice experiment:
2261        use a re-entrant channel with idealized coastline (trapezoidal shape)
2262        at southern boundary to explore seaice dynamics and thermodynamics
2263        with simple forcing. Main set-up has dynamics+thermo and SST relaxation;
2264        secondary test (input.thsice) use thermodynamics only with SST relaxation.
2265      - add seaice-dynamics only secondary test using LSR and pkg/thsice advection.
2266    o pkg/exf:
2267      - disable "sstExtrapol" when Nr=1
2268    o verification:
2269      - add new experiment "cheapAML_box" (simple 1 layer set-up from Bruno Deremble)
2270        to test pkg/cheapaml.
2271    o pkg/aim_v23 & pkg/shap_filt:
2272      - fix dissipation heating (erroneous gravity multiplication factor).
2273    o pkg/seaice:
2274      - remove unused field pressPre from jfnk solver
2275      - rename two subroutines in seaice_preconditioner.F
2276    o eesupp/src:
2277       - S/R MDSFINDUNIT avoids reserved unit numbers (scrUnit1, eeDataUnit ...)
2278    o pkg/seaice/seaice_preconditioner.F: fix preconditioner once again
2279       - remove wrong parts of the rhs and the lhs (were in there
2280         because I did not understand the concept of this preconditioner)
2281       - add an exchange between u- and v-sweep. This increases communication
2282         by a factor of two but improves the convergence of jfnk. Ideally,
2283         one would like the u- and v-sweep to be independent. So far within
2284         undocumented ifdefs
2285       - reorganize the extra computations for printing the residuals
2286    o tools/genmake2:
2287      - comment out the "mpif.h" include in NetCDF test programm (for MPI built)
2288        since it's not necessary (and was preventing to use MNC in some cases).
2289    
2290    checkpoint64a (2012/11/16)
2291    o pkg/autodiff:
2292      - improve pkg-internal logical parameter switch (inAd/inFwd mode) so that
2293        autodiff_readparms.F no longer depends on calling order (within
2294        packages_readparms.F) and no longer requires to include ${PKG}_PARMS.h):
2295        rename param turnFreeDriftInAdMode to SEAICEuseFREEDRIFTswitchInAd
2296        and change param SEAICEuseDYNAMICSinAdMode to SEAICEuseDYNAMICSswitchInAd.
2297    o pkg/obcs:
2298      - adding tidal velocity forcing capability to obcs
2299        for usage example, see verification/seaice_obcs/input.tides
2300    o pkg/seaice:
2301      - turn the LSR-relaxation parameters WFAU/V into runtime parameters
2302        SEAICE_LSRrelaxU/V
2303      - introduce runtime parameter SEAICEetaZmethod (=0 by default)
2304    o pkg/aim_v23:
2305      - implement heating from friction (bottom friction and stratospheric drag).
2306    o pkg/shap_filt:
2307      - fix diagnostic "SHAP_dKE" (was 2 time smaller); implement heating from
2308        dissipation but only for Shap_funct=2, active when addFrictionHeating=T.
2309    o model/src:
2310      - move AddMass common block from DYNVARS.h to FFIELDS.h; allow to read-in
2311        time-constant addMass field from file (addMassFile);
2312      - support for heating due to friction (and Kinetic Energy dissipation):
2313        add option, run-time switch and 3-D field array + support code ; each pkg
2314        or S/R can add heating contribution (if there is a sink of KE); the sum is
2315        accounted for as a Temperature tendency term (EXTERNAL_FORCING_T).
2316    o pkg/seaice:
2317      - complete merge of ITD code into seaice_growth.F
2318        from MITgcm_contrib/torge/itd/code/
2319        no verification so far, but Torge Martin tested
2320        "1-D test case and Beaufort set up;
2321        deliver okay results after 1 model year."
2322      - complete merge of SEAICE_SIZE.h into all relevant routines
2323      - move computation of eta at Z-points into calc_viscosities
2324        + introduce global field etaZ
2325        + add different methods for computing etaZ, for now the old
2326          method (simple averages of eta to Z-points) is hardwired
2327        + replace etaMeanZ by etaZ in seaice_lsr, seaice_calc_residual,
2328          seaice_preconditioner
2329      - simplify computations for SEAICE_ZETA_SMOOTHREG
2330      - seaice_preconditioner:
2331        + replace one remaining press by pressLoc (mistake)
2332        + adjust printing of residuals
2333      - improve I/O of diagnostics of JFNK in seaice_jfnk.F:
2334        + add (SEAICE.h) and rename some counters (initiliased in
2335          seaice_init_fixed.F)
2336        + add _BEGIN/END_MASTER (myThid)  around print statements
2337        + print total number of iterations and failures over SEAICE_monFreq
2338          interval to STDOUT
2339      - move control over output-messages by fgmres to seaice_jfnk to save
2340        some operations
2341      - move resetting initial guess for fgmres outside of seaice_fgmres_driver
2342        in order to make restarts with sol .ne. zero (fgmres with restarts)
2343        (seaice_jfnk.F, seaice_fgmres.F)
2344      - seaice_calc_l/rhs.F: replace maskW/S by maskInW/S; this fixes
2345        a serious convergence problem when open boundaries are involved
2346    o pkg/ggl90: fix computation of control volumes for the case of
2347      ALLOW_GGL90_HORIZDIFF (probably not used very often): move control volumes
2348      up half a grid cell from C-centered to W-centered (pointed out by C. Eden)
2349    o pkg/seaice: simplify seaice_evp by avoiding use of extra fields u/vIceC
2350    o pkg/autodiff
2351      - Add inAdMode switch for SEAICEuseDYNAMICS:
2352        SEAICEuseDYNAMICSinAdMode
2353        (extend logic in ADAUTODIFF_INADMODE_SET)
2354    o pkg/seaice
2355      - Step 1 of merging ice-thickness distribution (ITD) code from
2356        MITgcm_contrib/torge/itd/ (author: Torge Martin)
2357        The code implements concept laid out in Thorndike et al. (1975);
2358        code is enabled via CPP flag SEAICE_ITD
2359        nITD (in SEAICE_SIZE.h) defines number of ice thickness categories;
2360        code is not complete yet!!
2361      - SEAICE_SIZE.h now included in almost all seaice routines
2362    o verification (using seaice):
2363      - switch back seaice-dynamics (+ lower SOLV_MAX_ITERS) in ADM exp.
2364        global_ocean.cs32x15.seaice ; update results.
2365      - compile B-grid dynamics in FW test exp 1D_ocean_ice_column ;
2366      - compile C-grid dynamics with #define SEAICE_ALLOW_JFNK in FW test exp
2367        offline_exf_seaice (previously compiling B-grid).
2368    o pkg/exf:
2369      - fix some STOP conditions in exf_check.F (from Aug 28, modifs did not allow
2370        to specify neither just 1 comp of wind or wind-stress, nor no surface momentum
2371        forcing): just replace CPP option ALLOW_ATM_WIND with run-time param useAtmWind.
2372    o pkg/layers (adjust changes from Sept 19):
2373      - do snap-shot output and fill diagnostics from inside iLa loop (layers_calc.F)
2374        this allows to remove "layers_maxNum" dimension from all layers arrays.
2375    o pkg/layers (adjust changes from Sept 19):
2376      - remove ALLOW_LAYERS_OUTPUT ; fix snap-shot and time-ave output ;
2377      - snap-shot extended to all type of layers (not just the 1rst type);
2378      - remove layers variables when corresponding CPP option is undef.
2379    o pkg/layers:
2380      - rename pkg/layers variable and add new output (layer exist & un-weighted
2381        velocity in layer)
2382    o pkg/seaice:
2383      - simplify (?) ocean-drag coefficent computations by using
2384        the same routine in all three solvers (saves some code lines)
2385      - remove global fields DRAGA and DRAGS from C-grid code and
2386        declare them locally in lsr.F (the only place where they are
2387        still used)
2388      - update AD output of lab_sea.evp (very sensitive anyway).
2389    o pkg/seaice: add Jacobian-free Newton Krylov solver for ice dynamics
2390      (Lemieux et al. 2010, 2012). Turn on with the usual SEAICE_ALLOW_JFNK
2391      and SEAICEuseJFNK=.true. A few things to note:
2392      - involves a FGMRES, that is parallel but very inefficient,
2393        because of many scalar products (global sums) in the Gram-Schmidt
2394        orthogonalization method. Needs to be replaced. Original code
2395        from J.-F. Lemieux
2396      - preconditioner for FGMRES is a stripped down version of LSOR
2397      - SOLV_MAX_ITERS is now used for LSOR as a solver and as a
2398        preconditioner. For the preconditioner, the default is set to 10.
2399      - Jacobian times vector is computed with finite differences
2400      - marginally related to JFNK-solver: add a smooth regularization for
2401        zeta with tanh that will improve convergence (Lemieux and Tremblay,
2402        2009) for any implicit solver (not implemented for EVP because EVP
2403        does not need this regularization in the first place). Define
2404        SEAICE_ZETA_SMOOTHREG in SEAICE_OPTIONS.h to use.
2405    o eesupp/src:
2406      - check in genmake2 that intrinsic S/R flush is available.
2407      - add S/R to flush IO unit (if intrinsic S/R flush is available)
2408      - flush standard & error msg unit before MPI termination
2409      - if debugMode, flush IO unit after printing msg
2410    o pkg/ctrl:
2411      - ctrl_unpack.F, ALLOW_GENARR3D_CONTROL code: fix missing argument in call
2412        to ctrl_set_unpack_xyz.
2413    
2414    checkpoint64 (2012/10/09)
2415    o pkg/shelfice
2416      - in mom_fluxform.F, mom_vecinv.F:
2417        CALL SHELFICE_V_DRAG(bi,bj,k,vFld,KE,KappaRU,vF,myThid)
2418        Bug fix KappaRU -> KappaRV
2419        does not change verification/isomip but may change other setups
2420        (presumably constant KappaRU=KappaRV)
2421      - fix diagnostics SHIU/Vdrag (thanks to Tom Millgate)
2422    o pkg/obcs:
2423      - fixed some indexing bugs in obcs_seaice_sponge.F
2424      - added obcs relaxation subroutines for HSALT and HSNOW
2425      - changes verification/seaice_obcs/results/obcs_seaice_sponge.F
2426    o pkg/seaice:
2427      - add "multicategory" parameterization for snow in analogy to ice,
2428        default is off for now.
2429    o pkg/obcs:
2430      - added obcs_seaice_sponge.F for obcs relaxation of seaice variables;
2431        see verification/seaice_obcs/input.seaiceSponge for example application.
2432      - remove local commom bloc "OBCS_GLOBAL" in obcs_readparms.F and do all the OB
2433        index setting by master-thread. This fix multi-threads Pb in previous modifs.
2434    o pkg/layers :
2435      - add diagnostics to pkg/layers
2436      - move the meat of pkg/layers from layers_calc.F to layers_fluxcalc.F
2437        (from R.Tulloch). Layers_calc.F now calls layers_fluxcalc.F accordingly.
2438    o pkg/generic_advdiff/gad_implicit_r.F :
2439      - fix ADVr diagnostics in case of both implicit vertical advection and diffusion.
2440    o pkg/seaice/seaice_growth.F:
2441      - fix SItflux diagnostics in virtual salt flux + balanceEmpmr case.
2442    o pkg/obcs:
2443      - change default setting of OBCS_UVICE_OLD from defined to undef;
2444      - use new parameter OB_indexNone for null index value (instead of hard-coded 0)
2445        in all pkg/obcs code and in other pkgs; remove k loop in obcs_check_depths.F;
2446      - pass OB_indexNone as (new) argument to S/R CTRL_MASK_SET_[X,Y]Z;
2447      - change OB null index value (OB_indexNone) to -99 ; this fix the problem
2448        with Southern & Western OB at a tile edge (at least in a simple set-up).
2449    o pkg/obcs:
2450      - change settings of OB index in case OB coincides with tile edge (shared by
2451        2 tiles), so that common OB location is registered by both tiles (instead of
2452        only 1). However, for Southern and Western OB, index value = 0 is not
2453        recognized as valid OB index (=default null value) and needs to be fixed.
2454      - modify accordingly OBCS_BALANCE_FLOW and OBCS_MONITOR (avoid double counting)
2455      - new parameter "OB_indexNone" for null index value (for now, still zero)
2456        to replace hard-coded null index value of zero.
2457    o pkg/exch2:
2458      - improve W2_USE_E2_SAFEMODE (faster) and W2_E2_DEBUG_ON:
2459        always check buffer-size (but outside the loop); move checking for valid
2460        index from W2_USE_E2_SAFEMODE to W2_E2_DEBUG_ON; in W2_E2_DEBUG_ON,
2461        print each tile and point connection only if |W2_printMsg|>= 2 and 3.
2462    o pkg/ctrl (pack & unpack):
2463      - in ctrl_pack.F & ctrl_unpack.F, use the same local file-name variable
2464        (locally defined) for different variables (+ remove the variable-specific
2465        file name in CTRL_GENARR.h). For now, only implemented for GENARR2/3D_CONTROL
2466        (to be extended to other local file names in ctrl.h).
2467    o pkg/flt:
2468      - add a FLT_Iter0 option (similar to PTRACERS_Iter0).
2469    o pkg/mdsio:
2470      - fix missing STOP in mdsio_readvec_loc.F (case ioUnit=0) when file is missing
2471    o tools/genmake2:
2472      - add similar dependences for target EXE_AD & EXE_FTL as we have for EXECUTABLE
2473        (added by Alistair in version 1.51 for building without make depend);
2474      - remove Header files list (H_SRC_FILES) from the dependence of targets
2475         ad_input_code.f & ftl_input_code.f (not clear why it was added in the first
2476        place in version 1.23): this save going through staf when unrelated header
2477        file has been modified.
2478       Note: for an intermediate target (e.g., ad_input_code.f or adtaf) without
2479        "make depend" step, still need to do "make links" before "make adtaf".
2480    o eesupp/src (+ few pkg src files) & genmake2:
2481      - finish to remove ALWAYS_USE_MPI in source code that TAF does not see;
2482      - no longer set ALWAYS_USE_MPI in Makefile (was done by genmake2).
2483      - improve genmake2 checking for ALLOW_${PKG} in CPP_OPTIONS.h files (distinguish
2484         upper/lower case ; account for space between "#" and undef/define)
2485    o pkg/flt (with exch2):
2486      - cleaning: fix so that it compiles; move remaining MPI calls out of flt_exch2.F;
2487      - simplify threads synchronisation; fix (many issues) multi-threaded with MPI.
2488    
2489    checkpoint63s (2012/09/05)
2490    o pkg/ecco:
2491      - remove #ifdef ALLOW_SMOOTH_CORREL3D brackets.
2492      - add more relevant #ifdef ALLOW_SMOOTH ones.
2493      - sort out useAtmWind, useSMOOTH, ctrlSmoothCorrel2D.
2494    o pkg/ctrl:
2495      - CTRL_OPTIONS.h : document CPPs related to smoothing; ALLOW_SMOOTH_CORREL2D/3D,
2496        ALLOW_CTRL_SMOOTH, ALLOW_SMOOTH_CTRL2D, ALLOW_SMOOTH_CTRL3D.
2497      - ctrl.h : document run time params doInitXX, doMainPack, doMainUnpack, doPackDiag,
2498        doSinglePrecTapelev (audodiff param!), ctrlSmoothCorrel2D (new) and
2499        ctrlSmoothCorrel3D (new).
2500        The added ctrlSmoothCorrel2D/3D replace the old ALLOW_SMOOTH_CORREL2D/3D CPP.
2501      - ctrl_readparms.F : initialise ctrlSmoothCorrel2D/3D and read from namelist.
2502      - ctrl_init.F ctrl_pack.F ctrl_unpack.F : switch off ustress/vstress
2503        controls when useAtmWind, and vice versa.
2504      - ctrl_map_ini_ecco.F : UVEL0, VVEL0, edtaux, edtauy cannot be smoothed as tracers.
2505      - ctrl_get_gen.F : replace #ifdef ALLOW_SMOOTH_CORREL2D with
2506          #ifdef ALLOW_SMOOTH, IF ctrlSmoothCorrel2D, IF useSMOOTH.
2507      - ctrl_map_ini_gen.F : replace #ifdef ALLOW_SMOOTH_CORREL3D with
2508          #ifdef ALLOW_SMOOTH, IF ctrlSmoothCorrel3D, IF useSMOOTH.
2509      - ctrl_set_pack_xy[z].F, ctrl_set_unpack_xy[z].F:
2510        replace ALLOW_SMOOTH_CORREL2D/3D brackets with ctrlSmoothCorrel2D/3D.
2511    o pkg/smooth:
2512      - remove un-necessary includes.
2513      - remove ALLOW_SMOOTH*D and ALLOW_SMOOTH_CORREL*D brakets.
2514        Those CPP options were never defined, and not necessary.
2515    o model/src:
2516      - fix CPP brackets in ini_mixing.F (GM_background_K belongs to gmredi).
2517      - standard treatment of useSMOOTH.
2518    o pkg/autodiff:
2519      - add LOGICAL useGGL90inAdMode, useGGL90inFwdMode, useSALT_PLUMEinAdMode,
2520        useSALT_PLUMEInFwdMode allowing to switch off ggl90 and salt_plume adjoint.
2521    o pkg/exch2:
2522      - add "if usingMPI" where it was missing (in exch2_rx?_cube*.template)
2523        + start to remove ALWAYS_USE_MPI in source code that TAF does not see.
2524      - make new S/R W2_MAP_PROCS out of w2_eeboot.F to setup exch2 CommonFlag
2525        and tiles to process mapping.
2526      - re-arrange 3 header files (W2_EXCH2_PARAMS.h, _BUFFER.h & _TOPOLOGY.h)
2527        moving /EXCH2_FILLVAL_RX/ & /W2_EXCH2_COMMFLAG/ to W2_EXCH2_TOPOLOGY.h;
2528        rename "exch2_tProc" to "W2_tileProc" and move seting of e2FillValue_RX
2529        from w2_eeboot.F to w2_readparms.F.
2530    o eesupp/src:
2531      - set exchNeedsMemsync & exchUsesBarrier according to "usingMPI" (instead of
2532        ALWAYS_USE_MPI) + moved from ini_communication_patterns.F to eeset_parms.F;
2533        also move setting of exchCollectStatistics from exch_init.F to eeset_parms.F
2534      - in eedie.F and all_proc_die.F, always call MPI_FINALIZE when ALLOW_USE_MPI
2535        is defined (remove condition on usingMPI) to match cases where MPI_INIT
2536        has been called.
2537      - fix bug I put in previous modif of exch_sm_3d_rx.template (not much used);
2538      - change default (non-MPI) value of myPid (from 1 to 0) to match MPI settings
2539        (so that on 1 proc, get same myPid independently of usingMPI)
2540      - add a stop if multi-procs but usingMPI=F ; stop also if usingMPI=T and
2541        useCubedSphereExchange with EXCH-1 (safer).
2542      - add "if usingMPI" where it was missing (+ start to remove ALWAYS_USE_MPI).
2543    o pkg/ggl90:
2544      - fix bug in filling corner mask array "mskCor" (FILL_CS_CORNER_TR_RL call)
2545        used in ALLOW_GGL90_SMOOTH code.
2546    o pkg/flt:
2547      - fix typo in FLT_WITHOUT_Y_PERIODICITY (the effect was to ignore stopping
2548        floats at the Southern end of the domain).
2549    o eesupp/inc:
2550      - add a list of CPP-options which can be set by Makefile (DEF_IN_MAKEFILE.h);
2551        but not used (and not to be used) anywhere, just for documentation.
2552    o pkg/autodiff, exf, ptracers & seaice (AD & TL output):
2553      - comment out the very nasty "writeBinaryPrec = writeStatePrec" line, since:
2554        a) can damage previously written records in any other multi-record files.
2555        b) if needed, can easily do it cleanly, by calling S/R WRITE_REC_3D_RL/S.
2556    o tools/genmake2:
2557      - define variable MAKE within Makefile and use it in place of 'make';
2558      - update AD_CONFIG.h (if needed) before building any of the executable
2559        (forward, adjoint or tangent-lin); this involves a 2nd invocation of make;
2560        and add the usual #ifndef/#define AD_CONFIG_H in AD_CONFIG.h;
2561      - always print usual warning comment 'this file is automatically generated'
2562        from script convert_cpp_cmd2defines (+ remove this warning from genmake2).
2563    o pkg/cheapaml:
2564      - updated to correspond to the code used in accepted paper (Nico Wienders).
2565    o pkg/exf:
2566        added run time switch useAtmWind to replace ALLOW_ATM_WIND cpp switch.
2567        ALLOW_ATM_WIND now just sets the useAtmWind default (see exf_readparms.F)
2568        and force defines ALLOW_BULKFORMULAE (EXF_OPTIONS.h).
2569    o pkg/exf, autodiff, ctrl, ecco and seaice:
2570        remove ALLOW_ATM_WIND brackets, or replace them with useAtmWind ones.
2571    o pkg/ctrl, ecco:
2572        allow to compile both ALLOW_U/VSTRESS_CONTROL and ALLOW_U/VWIND_CONTROL.
2573        Depending on useAtmWind, one is inactive, and the other is active (see
2574        exf_getffields.F/exf_getsurfacefluxes.F).
2575    o tools/genmake2:
2576      - improve error msg when failing in 2nd test of check_for_broken_Ff
2577      - fix option '-makefile' short-name (-mf according to genmake2 -help)
2578      - source local config file "genmake_local" just after processing the genmake2
2579        command arguments (previously done before processing arg).
2580    o pkg/grdchk:
2581      - add a call to TURNOFF_MODEL_IO for Tangent-Linear run (in this case, call
2582        to this routine from cost_final has been dropped in g_cost_final)
2583      - improve printed information (more explicit msg, no longer using "print *,"
2584         fix fcpertminus printed value).
2585    o model/src:
2586      - move call to COST_INIT_VARIA out of packages_init_variables.F directly
2587        into initialise_varia.F (just after calling PACKAGES_INIT_VARIABLES):
2588        this prevents getting cost-funct reset in adinitialise_varia recomputations.
2589    o pkg/dic:
2590      - move initialisation of "freefe" array from from dic_biotic_forcing.F to
2591        fe_chem.F: this prevents TAF from dropping this initialisation in TLM code.
2592    o pkg/grdchk:
2593      - grdchk_main.F : added CALL GLOBAL_SUM_INT( ierr , myThid )
2594      - grdchk_getadxx.F etc. : omit I/O if ierr.EQ.0
2595    o pkg/autodiff/ctrl/grdchk :
2596      - attempt to sort out what works and what does not,
2597        with regard to I/O, and to warn/stop accordingly.
2598    o pkg/grdchk:
2599      - attempt to fix grdchk in the case of useSingleCpuIO.
2600      - "if ( myProcId .EQ. grdchkwhichproc .AND. ierr .EQ. 0 )"
2601       statements were moved from grdchk_main.F and into
2602       grdchk_getadxx.F grdchk_getxx.F grdchk_setxx.F.
2603      - a global sum is applied to record numbers icvrec/layer
2604       out of grdchk_loc so that they be passed to I/O routines.
2605    o pkg/smooth:
2606      - fix recomputation that appeared with nlfs : use smooth_recip_hFacC,
2607        smooth_hFacW, smooth_hFacS (copied at init_fixed) in 3d case.
2608    o verification/testreport:
2609      - add option '-tlm' for Tangent-Linear test (-adm,-oad,-tlm are all exclusive);
2610      - can also use compressed (gzip) reference output file;
2611      - change format (in pkg/grdchk) of TLM output (+ add forward gradient)
2612        to be easier to collect by testreport.
2613      - update existing TLM output (half out-of-date by more than 3 yrs).
2614      - report NETCDF & LAPACK settings (from genmake2) in output dir.
2615      - report run-time in each individual summary (previously only for AD test);
2616        for TLM test, add also TAF version.
2617      - add daily TLM test on (old) aces cluster + weekly test on baudelaire.
2618    
2619    checkpoint63r (2012/08/15)
2620    o tools/genmake2:
2621      - fix Makefile for target ftlall (+ update files to clean after make ftlall)
2622    o pkg/ecco/ecco_cost_final.F :
2623      - fix fc print statements (to stdout and costfunction0000) so
2624        that the printed value is always after the global sum.
2625    o pkg/seaice/seaice_dynsolver.F :
2626      - fix ice strength assymptote at SEAICE_area_max<1
2627        (no change for the standard case of SEAICE_area_max=1)
2628    o some cleaning:
2629      - pkg source files: ensure that all *.F files from each pkg included the
2630        corresponding ${PKG}_OPTIONS.h file (except stand-alone src file which
2631        only includes CPP_EEOPTIONS.h); fix S/R CTRL_SMOOTH ; update AD experiment
2632        code_ad/*.F src files; add new option-file in pkg/admtlm + corresponding
2633        includes;
2634      - model/src: add PACKAGES_CONFIG.h wherever ALLOW_AUTODIFF[_TAMC] is used.
2635      - ALLOW_DIFFKR_CONTROL: add a stop in S/R CTRL_CHECK in case ALLOW_3D_DIFFKR
2636        is undef; also define /DYNVARS_DIFFKR/ common block in DYNVARS.h when
2637        ALLOW_DIFFKR_CONTROL is defined, to allow to compile and reach this stop.
2638      - update option-file CPP_OPTIONS.h of all AD experiments:
2639        * no longer include PACKAGES_CONFIG.h ;
2640        * includes ECCO_CPPOPTIONS.h if PACKAGES_CONFIG.h has been included ;
2641        * def/undef ALLOW_3D_DIFFKR independently of ALLOW_DIFFKR_CONTROL (before
2642          including ECCO_CPPOPTIONS.h).
2643    o pkg/cost, pkg/ctrl, pkg/ecco option-file:
2644      - clean-up and split content of old pkg/ecco/ECCO_CPPOPTIONS.h file into
2645        separated pkg option-file (done according to old doc from ECCO_CPPOPTIONS.h,
2646        not necessary accurate).
2647      - add a template for option-file ECCO_CPPOPTIONS.h, mostly empty, in
2648        pkg/autodiff, i.e., the 1rst pkg to compile for adjoint built, with lines to
2649        deliberately break compilation (a remainder that it needs to be customized)
2650      - in pkg/ecco, includes ECCO_OPTIONS.h instead of COST_OPTIONS.h
2651      - rename COST_CPPOPTIONS.h to COST_OPTIONS.h
2652      - rename CTRL_CPPOPTIONS.h to CTRL_OPTIONS.h
2653    o tools/genamke2:
2654      - check for lapack.
2655    o pkg/cost and pkg/ecco : attempt to sort out some of the limiting intricacies.
2656      - pkg/cost.cost_final.F : allow for use of pkg/ecco and pkg/cost cost functions
2657        jointly. The exclusive ifdefs were removed, to add costs terms (when defined)
2658        from both packages.
2659      - the fc global sum in pkg/ecco/ecco_cost_final.F was removed accordingly.
2660      - for objf_atl we use either the pkg/ecco or the pkg/cost term depending on CPPs.
2661      - pkg/ecco and model/src : add CPP brackets around pkg/cost and pkg/ctrl includes
2662        of "CTRL_SIZE.h" "ctrl.h" "ctrl_dummy.h" "optim.h" / "cost.h" accordingly.
2663    o pkg/cost : add comments to explain special and/or untested setups.
2664    o pkg/exf:
2665      - use EXF_OPTIONS.h to set pkg/exf options except if done in ECCO_CPPOPTIONS.h
2666        (previously, ALLOW_AUTODIFF_TAMC was controling this switch).
2667    o verification/*/code_ad:
2668      mimimal cleaning of AD experiments ECCO_CPPOPTIONS.h option-file:
2669      - reccord when this file is included (define ECCO_CPPOPTIONS_H)
2670      - remove the most obvious obsolete features (e.g., #define ALLOW_COST not
2671        allowed since Oct 2003 in any option-file except in PACKAGES_CONFIG.h)
2672    o pkg/seaice :
2673      - added possibility to change ice strength/PRESS0 relationship to
2674        HEFF, according to the following run time parameters
2675        SEAICEpresPow0 :: HEFF exponent for ice strength below SEAICEpresH0 (integer, >0)
2676        SEAICEpresPow1 :: HEFF exponent for ice strength above SEAICEpresH0 (integer, >0)
2677        SEAICEpresH0   :: HEFF threshold for ice strength            (m)
2678    o pkg/ggl90 :
2679      - added run time flag mxlSurfFlag to include the code that ensure
2680        mixing between first and second level (previously included as a comment)
2681    o verification/1D_ocean_ice_column/input_ad/data.autodiff :
2682      - add test of newly added dumpAdByRec=T option where
2683        we write all records to one file per variable.
2684    o verification/global_ocean.cs32x15/code_ad/CPP_OPTIONS.h :
2685      - switch to #define ALLOW_BALANCE_RELAX and ALLOW_BALANCE_FLUXES
2686        to check that this code is ok with taf and compiles in adjoint.
2687    o pkg/autodiff :
2688      - added run time param dumpAdByRec : ad dump format switch.
2689        If true then write all records to one file per variable.
2690        Else write one file per record (remains the default).
2691      - revise seaice_ad_dump.F and exf_adjoint_snapshots_ad.F accordingly.
2692    o pkg/seaice:
2693     - Added SEAICEuseTILT run time switch : if set to
2694       false then omit the tilt term in seaice dynamics.
2695     - Fix free drift calculation.
2696    o pkg/shelfice:
2697      When initializing SHELFICEDragQuadratic, set default to be
2698      consistent with shiCdrag in case SHELFICEuseGammaFrict is used,
2699      but retain option to set it independently
2700      (inconsistenty spotted by Veronique Dansereau)
2701    o eesupp/inc:
2702      - in EEPARAMS.h, add real-type constant for some frequently used simple number
2703         (0,1,2,1/2), with name explicitly referring to RS/RL type.
2704    o model/src:
2705      - move balancing of relaxation terms to new S/R balance_relax.F.
2706    o pkg/autodiff:
2707      re-write active I/O high-level (control) S/R:
2708      - rename  S/R ACTIVE_READ/WRITE_RL to ACTIVE_READ/WRITE_3D_RL
2709      - add 1 more argument (useCurrentDir) to replace the "_LOC" 2nd set of S/R.
2710      - use standard pkg/mdsio I/O routines (MDS_READ/WRITE_SEC_XZ/YZ  and
2711        MDS_READ/WRITE_FIELD); change loops to multi-threads.
2712      - update and merge active_file_control_slice.flow into active_file_control.flow
2713      - update the calls in lower level S/R (active_file.F, active_file_g.F and
2714        active_file_ad.F) keeping the argument list and function unchanged.
2715      - also update lower-level "_LOC" version (call same S/R with "useCurrentDir
2716        =.TRUE.") and remove high-level (control) _loc version (not called anymore).
2717      - new low-level active I/O routines, one for each type (RL/RS), for active var
2718        of various (XY,XZ,YZ) shape and level number (arguments: arrShape, myNr);
2719        fix ctrl_init_wet.F & ecco_cost_weights.F by calling the new S/R with the
2720        right type.
2721    o autodiff and RS=real*4:
2722      - call the right type (_RS instead of _RL) of S/R in few output S/R (pkg/exf
2723        ad-monitor and snapshots); disable arrType='RS' in mdsio_gl*.F ;
2724      - change argument type of 3-D mask argument to _RS to match type in the call
2725        (in seaice_cost*.F, ctrl_*_gen.F and *ctrl_bound.F); to be continued.
2726    o pkg/thsice:
2727      - re-anable balanceEmPmR when useSEAICE=T with useThSIce=T.
2728      - option to correct ocean fresh-water flux for imbalance of Atmos+Land
2729        fresh-water flux: uniform correction or proportional to local precip.
2730    o pkg/ctrl:
2731      - new header file CTRL_SIZE.h for parameters maxCtrlArr2D, maxCtrlArr3D
2732      - redefine CPP option ALLOW_BOTTOMDRAG_CONTROL to
2733                            ALLOW_BOTTOMDRAG_CONTROL_NONGENERIC
2734      - verification/hs94.1x64x5/ tests ALLOW_GENARR{2D,3D}_CONTROL
2735    
2736    checkpoint63q (2012/07/30)
2737    o pkg/autodiff:
2738      note about monitor and snap-shot of ad-variables:
2739      a) need to apply ADEXCH before monitor or output of ad-vars to include
2740       overlap contributions (was done for adjDump but missing for monitor).
2741      b) since ADEXCH implies adding overlap values to interior array, machine
2742       truncation error is expected when adding an ADEXCH call in the middle of
2743       the time-stepping (although mathematically identical).
2744      modifs:
2745      - fix some incorrect type (RL/RS, UV/scalar) in ADEXCH calls and ad-vars
2746        declaration (adEddyPsiX,adEddyPsiY in adcommon.h).
2747      - add new run-time params (dumpAdVarExch & mon_AdVarExch) to select how  to
2748        apply ADEXCH before monitor or snap-shot of ad-variables:
2749           =0 : no ADEXCH ; =1 : do ADEXCH ; =2 : apply ADEXCH on a local copy.
2750      - implement new method (copy+adexch) for snap-shot and monitor of main model
2751        ad-vars (initially not used by default -> output unchanged).
2752      - change default (set to 2) to use new method and update few output_adm.txt
2753        with accurate ad-monitor (global_ocean.90x40x15, tutorial_global_oce_biogeo
2754        and both tutorial_tracer_adjsens tests).
2755      - switch 2 global_ocean.cs32x15 AD-tests to AB-2 (seaice_dynmix & thsice)
2756        and turn off momDissip_In_AB in the 2 other (needed for stable AB-3).
2757    o pkg/ctrl:
2758      enable the use of a variable number (maxCtrlArr2D, maxCtrlArr3D) of
2759      generic control variables via
2760      #define ALLOW_GENARR2D_CONTROL and/or #define ALLOW_GENARR3D_CONTROL
2761      Only required customization should be S/R ctrl_map_ini_genarr.F
2762      (routine in repository contains example)
2763    o pkg/exf:
2764      - fix and refine checking of surface-relaxation setting when using EXF
2765    o verification (adjoint exp):
2766      - reduce length of simulation by half for experiment global_ocean.cs32x15
2767        (std, seaice & seaice_dynmix) and exp tutorial_dic_adjoffline; update output.
2768    o pkg/mom_common (mom_u/v_bottomdrag), pkg/shelfice (shelfice_u/v_drag)
2769      - replace if statements KE.ne.0 with KE.gt.0 to avoid sqrt of negative numbers
2770        of KE that can occur with aggressive optimization
2771      + put quadratic bottom drag calculation in separated loops (only done if
2772        using bottomDragQuadratic)
2773    o model/src: CG2D_NSA
2774      - clean-up:  stop if cg2dNormaliseRHS=T and AUTODIFF
2775         and replace GLOBAL_SUM calls with GLOBAL_SUM_TILE.
2776      - in test-exp that uses CG2D_NSA (bottom_ctrl & tutorial_tracer_adjsens),
2777         change cg2d residual target to be expressed in Wunits (=> do not normalise
2778         RHS ; this fix global_max Pb with TAF); update output.
2779    o verification/tutorial_tracer_adjsens:
2780       improve parameter consistency (and get rid of warnings):
2781       - use deltaTFreeSurf=deltaTtracer (better with NonLin FreeSurf);
2782       - switch Temp Adv Scheme from 81 to 80 (no limiter since theta < 0 is physical)
2783       - use staggerTimeStep (for stability) in som81; use default rotation period.
2784    o pkg/exch2:
2785      - with empty facet: fix compact-format (W2_mapIO=1) definition (was previously
2786        reset to 0 = 1 long line in X)
2787    o pkg/mdsio:
2788      - fix reading of dimensions from meta file for large-size domain
2789    o model/src:
2790      - fix saltIsActiveTr setting for IdealGas eosType (eosType is 6 character long);
2791      - to refine CS-grid check, add logical flag "hasWetCSCorners": true if using
2792        Cubed-Sphere Exch with CS-corners inside the domain;
2793        make new S/R INI_GLOBAL_DOMAIN from code in ini_linear_phisurf.F to calculate
2794        globalArea and to set hasWetCSCorners.
2795      - add warning if usingCurvilinearGrid and momAdvection in flux-form (missing
2796        metric terms); stop if hasWetCSCorners=T and momAdvection in flux-form.
2797      - re-activate the stop if useCDscheme and hasWetCSCorners=T (previously if
2798        useCDscheme and useCubedSphereExchange).
2799    o pkg/seaice/seaice_growth.F :
2800      - compute the SEAICE_DISABLE_HEATCONSFIX term accordingly
2801        for the (.NOT.useRealFreshWaterFlux).OR.(nonlinFreeSurf.EQ.0)
2802        when the previous code was not correct.
2803      - in all cases diagnoze the boundary condition mismatch to SIaaflux
2804      - in the case of useRealFreshWaterFlux.AND.(nonlinFreeSurf.GT.0) add
2805        that term to QNET (essentially to set the melt/freeze water to 0degC).
2806        when SEAICEheatConsFix is true, so that the ocean+ice budget heat is closed.
2807    o verification/global_ocean.cs32x15/input.seaice :
2808      - add SEAICEheatConsFix in data.seaice, ensuring closed ocean+ice heat budget.
2809      - add diagnostics (commented out) for budget test using my matlab codes (gcmfaces).
2810      - update results (output.seaice.txt) accordingly.
2811    o verification/lab_sea/input/data.seaice :
2812      - remove SEAICEheatConsFix, which is now be tested
2813        in global_ocean.cs32x15. The presently coded fix
2814        is only consistent with real fresh water + nlfs.
2815      - update results (output.txt) accordingly.
2816    o pkg/salt_plume: added diagnotic for salt tendency (oceSPtnd).
2817    o AD_CONFIG.h file:
2818      - in genmake2: remove "#undef ALLOW_ECCO_OPTIMIZATION" from AD_CONFIG.h;
2819      - remove #include "AD_CONFIG.h" from all included OPTIONS files and
2820        add it explicitly in each fortran src file where it is needed.
2821        motivation: header file AD_CONFIG.h is generated/modified after "make depend"
2822        thus introducing potentially wrong dependency; therefore, better to include
2823        it only where it's really needed, and after any other included OPTIONS file
2824        (less tempting to bring conditional includes according to ALLOW_ADJOINT_RUN
2825        or ALLOW_TANGENTLINEAR_RUN).
2826    
2827    checkpoint63p (2012/07/06)
2828    o pkg/autodiff:
2829      - rename S/R INI_AUTODIFF to AUTODIFF_INIT_VARIA ;
2830      - create new header file "AUTODIFF_PARAMS.h" for pkg/autodiff parameters
2831        which are now read from new parameter file "data.autodiff" (inAdExact
2832        previously in "data", use{KPP/GMRedi/SEAICE}inAdMode previously in data.pkg)
2833      - add file "data.autodiff" in all verification/*/input_ad/ directories.
2834      - add run-time parameter to turn On/Off SEAICEuseFREEDRIFT in adjoint/forward
2835        mode (used in global_ocean.cs32x15.seaice_dynmix test exp.)
2836    o verification/tutorial_tracer_adjsens/
2837      - add extra sub-verification which uses "SOM" advection scheme
2838        (2nd Order-Moment Advection Scheme, Prather Limiter) with
2839          #define GAD_ALLOW_TS_SOM_ADV in GAD_OPTIONS.h
2840        and in data:
2841          multiDimAdvection=.TRUE.,
2842          tempAdvScheme=81,
2843          saltAdvScheme=81,
2844    o model/src:
2845      - introduce ALLOW_BALANCE_RELAX which allow the removal
2846       of the global mean of relaxation terms by setting
2847       balanceThetaClimRelax and balanceSaltClimRelax
2848      - disable balanceEmPmR and balanceQnet in the case when useSeaice.
2849       This case is now treated appropriately in seaice_growth.F
2850    o pkg/seaice:
2851      - do balanceEmPmR and balanceQnet based on the net fluxes
2852        (SItflux) that enter the ocean+ice system rather than QNET
2853        and EMPMR. Works best in real fresh water.
2854      - SIatmFW, SIatmQnet, and SItflux computations had to be moved
2855        out of the diagnotics bloc, and stored in global arrays.
2856    
2857    checkpoint63o (2012/06/29)
2858    o vertical mixing schemes:
2859      - remove unused S/R CALC_BUOYANCY (left from branch-atmos merging)
2860      - replace computation of density (in Function STATE1, opps_calc.F) by a call
2861        to S/R FIND_RHO_SCALAR
2862      - pass sigmaR to S/R PP81_CALC, MY82_CALC (but not yet used) and to GGL90_CALC
2863        and use it for N^2 calculation in ggl90_calc.F (save 2 density computations);
2864        affects output (vermix.ggl90) at truncation level.
2865    o testreport:
2866      - change adjustment of SIZE.h for mpi+mth testing: preserve enough tiles
2867        (nSx,nSy) for the number of threads (from eedata.mth)
2868    o model/src:
2869      - remove 2nd set of calls at the top of initialise_varia.F (Adjoint part)
2870        related to Non_Lin Free-Surf or Bottom-Control (but not longer necessary).
2871    o verification/tutorial_tracer_adjsens/
2872      - compile with ALLOW_CG2D_NSA
2873      - run with nonlinFreeSurf=3
2874      - update reference output_adm.txt
2875    o tools/genmake2:
2876      - add "-DHAVE_NETCDF" to the DEFINES list when NetCDF is available ;
2877        refine usePROFILES switching off (only when NetCDF is not available).
2878    o verification (atmospheric set-up):
2879      - change eosType='IDEALGAS' to eosType='IDEALG' to match variable declaration
2880    o pkg/profiles : refine profiles and files handling.
2881    o model/src and pkg/ecco : introduce run-time switch usePROFILES.
2882    o model/src/the_main_loop.F, forward_step.F and pkg/exf/EXF_OPTIONS.h :
2883      - changes to use model/src/the_main_loop.F rather than the ecco version
2884        in ecco type adjoint runs.
2885    o model/src:
2886      - move computation of recip of grid distance & area from INI_MASKS_ETC to INI_GRID
2887      - move setting of h0Fac[C,W,S] from INI_LINEAR_PHISURF to INI_MASKS_ETC
2888      - update_masks_etc.F: rename SMOOTH*_R4,R8 function to the corresponding type (RS,RL)
2889    o model/src:
2890      - fix S/R UPDATE_CG2D for ALLOW_DEPTH_CONTROL case (was empty before);
2891        update output of test experiment bottom_ctrl_5x5.
2892    o pkg/generic_advdiff:
2893      - implement vertical bi-harmonic diffusion (for now, only for T & S and
2894        only explicitly).
2895    o verification/bottom_ctrl_5x5/
2896      update reference output (results changed quite some time ago,
2897      not sure when; but new reference results look ok in terms of grdchk)
2898    o verification/1D_ocean_ice_column/
2899      For verification purposes, the exact adjoint rather than an approx.
2900      should be used (e.g., to comare against F.D. or TLM).
2901      removed autodiff_inadmode*_ad.F routines in code_ad/
2902      Update results/ accordingly.
2903    o pkg/cal:
2904      - change cal_getdate.F so that output date is function of input time only
2905        (less ambiguous, not mixed up with input iteration number).
2906      - fix calendarDumps for non-zero phase-lag (S/R CAL_TIME2DUMP).
2907    o pkg/diagnostics:
2908      - implement calendarDumps also for stats-diags
2909      - implement calendarDumps also for snap-shot output (negative freq)
2910      - for now, ignores calendarDumps if non-zero phase-lag.
2911    
2912    checkpoint63n (2012/06/04)
2913    o model/src:
2914      - recompute rSurfW & S to ensure consistent column thickness (needed for rStar)
2915        between Sum_k(hFac*drF) and rSurf-rLow, for now only when using pkg/shelfice;
2916      - use h0FacC, W & S to compute hFac_surfC, W & S in calc_surf_dr.F (more
2917        similar to calc_r_star.F); update results of experiment internal_wave and
2918        tutorial_global_oce_in_p (affected @ truncation level).
2919    o pkg/shelfice:
2920      - add parameterisation of advective-diffusive flux into the ice shelf
2921        according to Holland and Jenkins (1999), eq.22-33, as suggested by Jan De Ryd
2922      - simply eps3/3a computation
2923    o eesupp:
2924     - add new CPP option (DISCONNECTED_TILES) to disconnect tiles (no exchange
2925       between tiles, just fill-in edges assuming locally periodic subdomain) and
2926       add corresponding exchange subroutines (EXCH0);
2927     - new CG-solver version (_EX0) for disconnected-tiles special case.
2928    o model/src (CG-solvers):
2929     - modify Single-Reduction version (CG2D_SR) in case cg2dMaxIters is reached
2930       (similar final residual output and max-Iter number as with standard version);
2931     - allows to store and use lowest-residual solution (standard & _SR versions);
2932     - cleaning up (remove old, commented out code, LETS_MAKE_JAM ...).
2933     - by default, also compile CG2D_SR version (define ALLOW_SRCG in CPP_OPTIONS.h)
2934    o eesup/src:
2935     - global_vec_sum.F cleaning: add a BARRIER ; update comments ; remove ndef
2936       ALWAYS_USE_MPI (no longer needed after fixing usingMPI settings - March 2012)
2937    o pkg/salt_plume added to lab_sea/input_ad.noseaicedyn
2938    
2939    checkpoint63m (2012/04/27)
2940    o pkg/shelfice:
2941     - account for partical cells in surface level below ice-shelf for hydrostatic
2942       pressure calculion (set uniformFreeSurfLev to F); update isomip experiments.
2943    o ad test experiments:
2944     - update and rename to "ad_optfile.local" local AD-optfile specific to a
2945       particular adjoint verification experiment (in verification/*/code_ad/)
2946    o pkg/seaice & pkg/exf:
2947     - Part two of ECCO-CLIVAR code merges.
2948       Completes merge of seaice area relax. code.
2949       Requires unified CPP option EXF_ALLOW_SEAICE_RELAX
2950       to be set in EXF_OPTIONS.h since this pkg controls its I/O
2951       (and avoids second CPP option in SEAICE_OPTIONS.h)
2952     - change default value of costIceStart & costIceEnd to a valid date.
2953     - add snowPrecip to HSNOW in seaice_growth
2954    o pkg/ptracers:
2955     - move ptracers summary and setup check into separated S/R ; add a check for
2956       valid PTRACERS_Iter0 value (error+stop or just warning).
2957    o pkg/cal (+ pkg/ecco):
2958     - avoid calling a S/R with 2 times the same arg (FWD: unless both are only used
2959       as input; and for AD, unless both are not differentiable (e.g., k index)).
2960    o model/src:
2961     - define internal flag "uniformFreeSurfLev" (=T when free-surface level-index
2962       is everywhere k=1) to speed-up some calculations (by pass kSurf reference);
2963       temporary set to usingZCoords value (to be changed to F when using shelfice).
2964     - hydrostatic pressure: implement partial cell near the surface also for
2965       Z-coordinates (for the case where uniformFreeSurfLev=F); replace test on
2966       usingZCoords with test on uniformFreeSurfLev where needed (in NonHyd code).
2967    o pkg/ctrl/ctrl_init.F:
2968     - add a formal parameter to s/r ctrl_init_rec to print
2969       xx_$(ctrl_valiable)_file for easier debugging
2970     - move call of cal_* routines into the if-block where they are really
2971       needed so that xx_$(ctrl_variable)_period can be 0 or -12 without having
2972       to specify a startdate
2973    o pkg/seaice:
2974     - update comments in SEAICE_OPTIONS.h (+ similar update of lab_sea/code and
2975       global_ocean.cs32x15/code versions).
2976     - turn on seaice Multi-category (in data.seaice, SEAICE_multDim=7) for
2977       verification experiment global_ocean.cs32x15.seaice and update results.
2978    o pkg/exf:
2979     - new S/R EXF_GETFIELD_START to return starting-time of a forcing field
2980       (according to useExfYearlyFields).
2981    o pkg/cal:
2982     - move calendar setting & summary (previously in cal_readparams.F) into new
2983       S/R CAL_INIT_FIXED to be called later in the initialisation process, once
2984       length of the simulation is set (after SET_PARMS call); This is an attempt
2985       to fix Pb when, e.g.: pkg/longstep, modifies the length of the run.
2986     - For safety: keep a record of pkg/cal parameter settings status
2987               to allow to STOP if one pkg/cal S/R is called too early.
2988     - add a stop in all basic pkg/cal subroutines if called before setting is done.
2989     - modify cal_getdate.F: stop when nothing was returned;
2990       if called with myIter=-1, simply retrun modelBaseDate (1,2 = startDate_1,_2);
2991       this allows to remove "cal.h" from seaice_read_parms.F & init_mnc_vars.F.
2992    
2993    checkpoint63l (2012/04/04)
2994    o pkg/bbl:
2995      - fix call to FIND_RHO_2D in bbl_calc_rho.F (case multi-tiles per proc);
2996        update global_with_exf output.yearly.txt file.
2997    o pkg/cal:
2998      - start to clean-up cal_set.F ; fix for the case where baseTime is non-zero.
2999      - remove 2 unsused and very short (1 line only) functions ;
3000      - remove unsused subroutines from AD-Diff list.
3001    o model/src:
3002      - start to implement clean wait to stop in initialization S/R (config_check.F,
3003         packages_check.F, ini_parms.F and pkg/obcs/obcs_check.F + pkg/mypackage)
3004    o folowing PRINT_MESSAGE changes:
3005      - remove reminder multiple print to the same file (STDOUT) when multi-threads.
3006    o pkg/bbl:
3007      - modification so it can work with z*
3008      - replace deltaT with dTtracerLev(k) for asynchronous time stepping
3009      - global_with_exf/input.yearly verification; changes output.yearly.txt
3010    o eesupp/src:
3011      - PRINT_MESSAGE: use OpenMP critical instruction (similar to PRINT_ERROR);
3012        writing to unit 0 (if unit=errorMessageUnit) extended to the case myThid=1
3013      - CHECK_THREADS: specific code if using OpenMP threading: improve checking of
3014        # of threads across processors (e.g., different env OMP_NUM_THREADS setting)
3015      - improve special preliminary call to EESET_PARMS (if eedata is read 2 times).
3016      - when using MPI, always set usingMPI=T ; set default accordingly and stop
3017        if not consistent.
3018      - ALL_PROC_DIE: add a BARRIER after MPI_FINALIZE call ; skip this when thread
3019        argument is zero (in case called within single-thread section).
3020    o pkg/fizhi:
3021        clean-up turbulence cold-start switch: decided in fizhi_init_vars.F, stored
3022        in common bloc (fizhi_coms.h) and then passed as argument up to S/R TURBIO.
3023    o pkg/exch2:
3024      - add argument "updateCorners" to S/R exch2_get_uv_bounds (enable to
3025        activate EXCH_IGNORE_CORNERS in vector EXCH S/R).
3026      - switch 1rst EXCH call to IGNORE_CORNERS (instead of UPDATE_CORNERS)
3027        but keep the 2nd with UPDATE_CORNERS: this prevents overwriting good data
3028        with bad ones coming from a not-yet-updated halo.
3029        This should fix the problem when sNx <> sNy and GCD(sNx,sNy) < 2*Olx.
3030    o pkg/frazil:
3031        move FrzForcT diag from frazil_diagnostics_state.F to frazil_calc_rhs.F
3032        http://mitgcm.org/pipermail/mitgcm-devel/2012-March/005384.html
3033    o model/src/config_check.F: add a check for OLx>sNx/OLy>sNy
3034    o verification/lab_sea
3035      * #undef SEAICE_EXCLUDE_FOR_EXACT_AD_TESTING
3036      * #define ALLOW_SST_CONTROL & ALLOW_SST_CONTROL
3037      * nTimeSteps 3 -> 4
3038      * changed reference output accordingly
3039    o pkg/ctrl:
3040      * fix ctrl_get_gen for xx_sst, xx_sss
3041    o pkg/fizhi:
3042      - fix 2 calls to S/R GRD2MSC (argument igrd) in update_earth_exports.F
3043        update results of exp. fizhi-cs-32x32x40 (fail with only 6 digits for cg2d)
3044      - by default, use new version of S/R GETPWHERE (#define TRY_NEW_GETPWHERE);
3045        fix few out-of-bounds indices in referencing vars (initialise igrd to 1);
3046        clean-up fizhi_turb.F (remove unused & uninitialised qdiaglsm array).
3047    o pkg/gmredi:
3048      - add diagnostic of Redi (main diagnonal) vertical diffusive flux of Temp
3049    o pkg/fizhi:
3050      - fix few initialisation and multi-tile Pb: aqualev & gridalt now pass the
3051        (old)aces open64 tuv test.
3052    o pkg/icefront: fix bug and reorder loop in icefront_init_varia.F
3053    o pkg/mom_vecinv:
3054      - fix 1 loop range in mom_vecinv.F to be like all the other loops which
3055        set/update gu,gv/Diss (fix Pb of uninitialised fVerUkp in admom_vecinv
3056        with non-lin free-surf).
3057    o model/src: move k-loop outside of i/j-loops when (re-)computing R_low
3058      in ini/update_masks_etc.F in order to avoid -O3 optimization problems with
3059      some compilers (gfortran 4.6.0 on MacOS)
3060    o momentum:
3061      - separate fVer?(:,:,kUp) & fVer?(:,:,kDown) in argument list of MOM_FLUXFORM
3062        & MOM_VECINV subroutines (to help TAF). This fixes Pb of uninitialised
3063        fVer?(kUp) in admom_fluxform with non-lin free-surf or bottom control.
3064    
3065    checkpoint63k (2012/03/17)
3066    o model/src:
3067       - selectAddFluid (ALLOW_ADDFLUID): add missing term in horizontal momentum
3068         flux-form (mom_fluxform.F) and vertical momentum (calc_gw.F) equations.
3069       - SOLVE_DIAGONAL: switch default to use adjoinable & vectorized version
3070         (#undef SOLVE_DIAGONAL_LOWMEMORY); update output of exp. front_relax.bvp.
3071    o model/src: solve_*diagonal.F
3072       - replace division with multiplication by inverse (similar to original version)
3073         update output of AD exp. global_ocean.90x40x15.
3074       - fix pkg/gmredi/gmredi_calc_psi_bvp.F & pkg/ggl90/ggl90_calc.F
3075         to enable the use of the vectorized & differentiable solve_tridiagonal.F
3076       - test exp. global_ocean.90x40x15/input_ad: switch to advection scheme 20 for
3077         vertical advection (to get solve_tridiagonal tested in AD mode).
3078    o pkg/seaice: ECCO-CLIVAR merge:
3079      1. seaice AREA relaxation
3080         * CPP option: SEAICE_ALLOW_AREA_RELAXATION
3081         * runtime flag: SEAICE_tauAreaObsRelax
3082      2. modified global mean cost imbalance code: CPP option
3083          ALLOW_SSH_GLOBMEAN_COST_CONTRIBUTION
3084    o another iteration on solve_*diagonal.F
3085       Make choices independent of AUTODIFF
3086       Default will be the adjoinable vectorized version.
3087       Alternative choices are:
3088       * non-adjoinable original version with low memory footprint:
3089         #define SOLVE_DIAGONAL_LOWMEMORY
3090       * still adjoinable but does not vectorize (k as inner-most loop):
3091         #define SOLVE_DIAGONAL_KINNER (keeping SOLVE_DIAGONAL_LOWMEMORY undef)
3092    o testreport
3093     - add option to use a home made wrapper around "make"
3094     - remove MITGCM_IEEE env. variable (no longer active)
3095    o pkg/shelfice
3096     - improve computation of friction velocity for velocity dependent
3097       exchange coefficients: include velocities into SHELFICEBoundaryLayer
3098       block to average velocities vertically
3099     - add TAF store directives for SHI_ALLOW_GAMMAFRICT
3100    o Modify diagonal solvers, now three versions (upon request):
3101      #ifndef SOLVE_DIAGONAL_AUTODIFF
3102        1. default version (dating back a while ago)
3103      #else /* def SOLVE_DIAGONAL_AUTODIFF */
3104      # ifdef SOLVE_DIAGONAL_KINNER
3105        2. adjoinable version with k-innermost loop (G. Forget)
3106      # else
3107        3. adjoinable vectorized version of 2.
3108      # endif
3109      #endif /* SOLVE_DIAGONAL_AUTODIFF */
3110      All flags are currently set within routines, but could/should be moved to CPP-options.
3111      Array bounds for 1. are as before, for 2.,3. cover the entire domain
3112      (could be changed for 1. too).
3113    o verification/lab_sea (fwd):
3114      - update the 4 fwd lab_sea test experiment: no longer SEAICE_GROWTH_LEGACY,
3115        use 7 categories (except hb87), new solve4temp params (except salt_plume),
3116        constant salinity (=4) or variable salinity (salt_plume) done through
3117        SItracer.
3118    o pkg/seaice:
3119      - rename parameters: SIsalFrac to SEAICE_saltFrac & SIsal0 to SEAICE_salt0;
3120      - remove old parameters ( SEAICE_freeze, SEAICEturbFluxFormula, SEAICE_gamma_t,
3121         SEAICE_gamma_t_frz, SEAICE_availHeatTaper & SEAICE_availHeatFracFrz)
3122        from SEAICE_PARMS.h ; still need to fix seaice_cost_sst.F (broken when
3123        SEAICE_freeze got retired) but already better than previously with
3124        SEAICE_freeze=123456.7 deg.C;
3125      - move setting of facOpenGrow/Melt from SEAICE_INIT_FIXED to SEAICE_READPARMS
3126        (safer multi-threaded setting); always set SEAICEuseEVP;
3127      - setting of ocean-ice turb. flux coeff: moved from SEAICE_CHECK to
3128        SEAICE_READPARMS & SEAICE_INIT_FIXED (this fixes wrong summary report);
3129        stop if multiple specifications for the same coeff; make sure default
3130        SEAICE_mcPheePiston is compatible with drF(1) & deltaT.
3131    o pkg/obcs:
3132      - allow to switch to upwind 1rst order advection scheme for the advective
3133        flux computation at the open-boundary; disabled for adjoint built.
3134    o pkg/ptracers:
3135      - rename PTRACERS_RESTART.h -> PTRACERS_START.h
3136      - rename ptracers_fields_blocking_exchanges.F -> ptracers_fields_blocking_exch.F
3137      - add parameter to decide when to start a tracer; use internal flag to
3138        know which tracer to step-forward; switch this internal flag at the top
3139        of forward_step.F (new S/R PTRACERS_SWITCH_ONOFF); for now, not enabled
3140        for adjoint built.
3141    o pkg/seaice:
3142      - add SEAICE_SIZE.h anywhere in the code where SEAICE.h is included ;
3143      - move MULTDIM declaration and setting from SEAICE.h to SEAICE_SIZE.h ;
3144      - keep experiment offline_exf_seaice truly single category (set MULTDIM=1).
3145    o pkg/ecco:
3146      - fix writing of output file DiagnosCost_ClimSalt/Theta
3147        and DiagnosCost_DriftSalt/Theta (if multi-tiles per proc).
3148    o pkg/seaice:
3149      - add missing initialisation of COR_ICE array in dynsolver.F
3150      - merging SEAICE_MULTICATEGORY define and undef cases. Now the same code is
3151        compiled either way, and is tested in all exps (multidim was only tested
3152        in lab_sea ad before).
3153      - cosmetic change to prepare for future addition of ITD. no change to results.
3154        no defaults change.
3155      - added run time param SEAICE_multDim (7 for SEAICE_MULTICATEGORY, 1 otherwise).
3156      - by lack of adequate verification experiments, I further used custom versions
3157        of global_ocean.cs32x15 to test multicat or not, with pickup or not. All
3158        should be correct.
3159      - avoid recomputations in ad.
3160    o array initialisation in adjoint mode:
3161      1) pkg/mom_common/mom_calc_ke.F:
3162        add full array initialisation of KE inside mom_calc_ke.F (ALLOW_AUTODIFF_TAMC):
3163        The S/R which calls MOM_CALC_KE initialises KE but in some recomputation
3164        part this initialisation is gone, resulting in Floating Point Exception
3165        (caught by open64 compiler with debug option).
3166      2) model/src/convective_weights.F
3167        set output convectCount over the full array range (instead of doing
3168        an update): this fix a similar issue when called within recomputation (adjoint)
3169        which could by-pass the initialisation (normally done in the caller S/R).
3170    o pkg/seaice:
3171      - final version of turbulent flux params, as agreed at MIT ice meet:
3172           SEAICE_mcPheePiston (default is ~ 0.000875)
3173           SEAICE_mcPheeTaper (default is 0.)
3174           SEAICE_frazilFrac (defualt is 1.)
3175           SEAICE_mcPheeStepFunc (default is false)
3176      - changes results at trunction error level
3177      - ifdef SEAICE_EXTERNAL_FLUXES, disallow SEAICE_waterAlbedo
3178    o added pkg/frazil:
3179      - see frazil_description.tex for details
3180      - verification experiment is global_with_exf/input.yearly; changes output.yearly.txt
3181    o pkg/shelfice/shelfice_thermodynamics.F
3182      - fix exponents for velocity dependent exchange coefficients: change
3183        from 2/3(=0) to 0.66666666666666667
3184      - move computation of velocity dependent exchange coefficients into
3185        separate loop, so that it applies to both thermodynamics
3186      - move some divisions by constants out of loops
3187    
3188    checkpoint63j (2012/02/16)
3189    o pkg/seaice:
3190      - overhaul of seaice_summary.F after feb 2012 clean-up of seaice_growth.F etc.
3191      - SItracer:  added run time params, and allow coupling to ocn salinity.
3192    o pkg/seaice: remove (almost) all divisions by constants within loops
3193      in seaice_growth.F and seaice_solve4temp.F, this changes (only) the cg2d
3194      results of global_ocean.cs32x15.seaice from 16 to 11 digits (but only
3195      those, caused by 1/QI -> recip_QI) -> update output.seaice.txt,
3196      output_adm.seaice_dynmix.txt and also lab_sea: output_adm.evp.txt
3197    o pkg/seaice :
3198      - simplify McPhee tapering, and allow to use it with SEAICEturbFluxFormula
3199        = 1 or 2, using newly added run time parameter SEAICE_availHeatTaper.
3200      - fix d_AREAbyATM, d_AREAbyOCN, d_AREAbyICE diags I broke in r1.148.
3201      - add permanent SItflux diag that corresponds to TFLUX but includes
3202        ice+snow. Hence SItflux-TFLUX should match the ice+snow heat budget.
3203      - allow activation/testing of a fix for suspected missing term in
3204        ocn-ice heat budget (to be confirmed). To test this, you want to
3205        undef SEAICE_DISABLE_HEATCONSFIX, and then set the run time param
3206        SEAICEheatConsFix to .TRUE. that also allows the 'SIaaflux' diagnostic.
3207      - no change in results, fwd or ad.
3208    o global_ocean.cs32x15/results: 3 changes following from the pkg/seaice commit below:
3209      - switch to variable freezing point.
3210           Results change : cg2d -> 1 digits; ad -> 3-6-6 digits.
3211      - bug fix : the sublimation term that was missing is now activated.
3212           Results change : cg2d -> 2 digits; ad -> 8-6-6 digits.
3213      - bug fix : flooding sign term for SIsal0.NE.0.
3214           Result change : cg2d -> 8 digits; ad -> 11-12-9 digits.
3215    o pkg/seaice:
3216      - unified freezing point treatment : the old SEAICE_VARIABLE_FREEZING_POINT
3217        is now the default, and the old default constant freezing point is recovered
3218        with SEAICE_tempFrz0    = -1.96,
3219             SEAICE_dTempFrz_dS = 0.,
3220      - retire SEAICE_freeze (= the old way of specifycing the constant freezing point)
3221      - remove ALLOW_SEAICE_FLOODING brackets; run time switch is already there.
3222      - bug fix (thanks to M. Losch) : the sublimation term that was missing is now
3223        activated. To reproduce old results with this bug define SEAICE_DISABLE_SUBLIM.
3224      - bug fix (silly me) : flooding sign term (seaice_growth.F r 1.149line 1211)
3225        was wrong for SIsal0.NE.0. Changes cs32x15 results (see above item for detail).
3226      - bug fix (thanks to O. Jahn) : area loss for melting  got messed up in
3227        seaice_growth r149 for legacy branch (no results change).
3228      - introduce SEAICE_CAP_SUBLIM : caps sublimation heat flux in solve4temp (code
3229        from I. Fenty).
3230      - results did not change except for global_ocean.cs32x15, mostly due to the
3231        switch to variable freezing point (see above item for detail).
3232    o pkg/thsice:
3233      - fix and simplify interface to salt_plume pkg ; diagnose directly amount of
3234        seawater freezing in thsice_calc_thickn (not used).
3235    o pkg/seaice: turbulent flux term specification via run time params.
3236      - replace CPP switches with run time switches to facilitate testing
3237      - retired CPPs : MCPHEE_OCEAN_ICE_HEAT_FLUX,
3238                       GRADIENT_MIXED_LAYER_TURBULENCE_FACTOR
3239      - added runtime parameter : SEAICEturbFluxFormula
3240      - move Mcphee constants to SEAICE_PARAMS.h
3241      - seaice_readparms.F : read turbulent flux term params (SEAICEturbFluxFormula;
3242                 SEAICE_availHeatFrac/Frz, or SEAICE_gamma_t/_frz if apply);
3243                 remove seaice_summary call (moved to seaice_init_fixed)
3244      - seaice_init_fixed.F : set SEAICE_availHeatFrac/Frz depending on
3245        SEAICEturbFluxFormula, and seaice_summary call (moved from seaice_readparms)
3246      - seaice_summary.F : add missing report of read turbulent flux term set up
3247                           and SITRACER.
3248      - seaice_check.F : check range; inform and stop if retired CPPs are used
3249                         (incl. SEAICE_AGE).
3250      - seaice_growth.F : unified use of SEAICE_availHeatFrac/Frz, without
3251             CPP switch, same computation as before for the different options.
3252      - change results at the truncation level.
3253    o pkg/seaice:
3254      - remove un-used parameters LAD & MAX_TICE ; add new run-time parameters:
3255        useMaykutSatVapPoly (default=F), postSolvTempIter (default=2) and
3256        SEAICE_wetAlbTemp (default=-1e-3). Remove option SEAICE_SOLVE4TEMP_LEGACY.
3257      - update verification/*/input*/data.seaice:
3258        to reproduce previous results with former #defined SEAICE_SOLVE4TEMP_LEGACY
3259        code, set useMaykutSatVapPoly=T & postSolvTempIter=0 ;
3260        and to reproduce previous results with former non-SOLVE4TEMP_LEGACY code,
3261        set SEAICE_wetAlbTemp=0 & SEAICE_snowThick=0.
3262    o pkg/seaice/seaice_solve4temp.F (SOLVE4TEMP_LEGACY):
3263      - remove LEGACY code for solving for tsurf (A1,A2,A3) but maintain the same
3264        algorithm (same choice: useMaykutPolySatVap=T, postSolvTempIter=0);
3265        difference in results only due to machine truncation.
3266      - remove MAX_TICE (tsurf is always =< TMELT anyway); keep MIN_TICE if using
3267        MaykutPolySatVap; keep MIN_LWDOWN.
3268      - adapt SEAICE_MODIFY_GROWTH_ADJ code (untested) to non-legacy formulation.
3269      - update output of verification exp. lab_sea (4 fwd: 11 cg2d digits except hb87,
3270        + 3 AD: 6 digits except evp) and offline_exf_seaice.seaice (12 digits).
3271    o pkg/salt_plume:
3272      - isolate saltPlumeFlux array exch into a specific S/R called from
3273        do_oceanic_phys.F
3274      - add interface to pkg/salt_plume (filling of saltPlumeFlux) in pkg/thsice.
3275    o verification:
3276      - move untested set-up to MITgcm_contrib/verification_other.
3277    o pkg/seaice:
3278      - retire old way of SEAICE_AGE. Now replaced with ALLOW_SITRACER.
3279    o pkg/seaice:
3280      - seaice_solve4temp.F (keeping results unchanged):
3281        * add 2 future run-time params to select which saturation vapor pressure
3282          formula is used and how post-iteration fluxes are set.
3283          Temporary set these 2 params according to option SOLVE4TEMP_LEGACY;
3284        * New piece of code (not used) to update surf. atmos. heat flux F_ia using
3285          the linearized expression to stay consistent with tsurf finding.
3286      - seaice_freedrift.F avoid floating exception in sqrt(y) since y=sqrt(x*x)-x
3287        can be < 0.
3288    o pkg/seaice/seaice_solve4temp.F (SOLVE4TEMP_LEGACY undef):
3289      - remove from F_ia (and from it's derivative dFiDTs1) the contribution of
3290        conductive heat flux F_c , and add it explicitly when updating tsurf as
3291        solution of: Fc = Fia + d/dT(Fia - Fc) *delta.tsurf
3292        so that now F_ia has a consistent meaning through the entire routine.
3293        This causes differences at truncation level: update output of fwd exp.
3294        global_ocean.cs32x15.seaice.
3295    o pkg/seaice:
3296      - lots of editing/cleaning in seaice_solve4temp.F + better documentation
3297        of arrays, sign/direction of fluxes; no effect on results.
3298      - replace hard coded 273.16 (=previous value of celsius2K) by celsius2K
3299        in seaice_budget_ocean.F & seaice_solve4temp.F (SOLVE4TEMP_LEGACY part);
3300        note: this should have been done before changing celsius2K default.
3301      - to keep results unchanged, add back old value of celsius2K in verification
3302        exp. input*/data : lab_sea (AD), offline_exf_seaice (fwd+AD) & seaice_obcs
3303      - replace hard coded seawater freezing temp in seaice_solve4temp.F (part
3304        SOLVE4TEMP_LEGACY) of 271.20 (=previous value of celsius2K + default
3305        value of SEAICE_freeze) by celsius2K+SEAICE_freeze so that seawater
3306        freezing temp is consistent with value in seaice_growth.F ; this causes
3307        differences at machine truncation level: update lab_sea AD output (3/4).
3308    o pkg/seaice:
3309      - mask (in exf_init_fixed.F) atemp,aqh,evap,precip,runoff,lwflx,areamask
3310        and climsst/sss even when using seaice (to prevent calculation that might
3311        use SST on land); does not affect any verification exp.
3312      - apply mask to taux,tauy (in seaice_get_dynforcing.F); update output
3313        of lab_sea.fd & lab_sea.hb87 and global_ocean.cs32x15.seaice_dynmix.
3314    o pkg/seaice/seaice_growth.F: add mask to avoid non-zero ice thickness
3315      over land (non-legacy code)
3316    o vectorize salt_plume package:
3317      - add extra code to salt_plume_frac and salt_plume_tendency_apply_s
3318      - this code computes plumebk everywhere (also over land), thus requires
3319        code to avoid divisions by zero and catch the case of kLev=Nr.
3320      - efficiency of salt_plume_frac is still sub-optimal
3321    o tools (genmake2):
3322      - fix makefile NAME specification (option: -makefile NAME) by adding
3323        "-f $MAKEFILE" in few places where it was missing including makedepend
3324        command (contribution from Paul).
3325    
3326    checkpoint63i (2012/01/24)
3327    o model/src:
3328      - add factorized versions of some EOS code to find_rho.F,
3329        define USE_FACTORIZED_EOS to turn it on (default for TARGET_NEC_SX)
3330    o model/src:
3331      - add celsius2K to namelist PARM01; remove unused recip_rhoNil from PARAMS.h;
3332      - change default celsius2K from 273.16 to 273.15
3333      - to keep results unchanged, add back old value of celsius2K in verification
3334        exp. input*/data : aim.5l_cs, 1D_ocean_ice_column, lab_sea (fwd),
3335         global_ocean.cs32x15(seaice) & cpl_aim+ocn(input_atm).
3336    o model/src: add a little initialisation trick to find_rho.F and find_alpha.F
3337      to make TAF generate vectorizable code
3338    o pkg/seaice/seaice_evp.F: add code (copied from CICE) that avoids underflows.
3339       Turn on by defining SEAICE_EVP_ELIMINATE_UNDERFLOWS. Most compilers
3340       have flags that do this more efficiently.
3341    o pkg/diagnostics/diagstats_calc.F
3342      - for TARGET_NEC_SX fix the treatment of the scaling factor tmpFac=scaleFact
3343    o pkg/obcs (with exch2):
3344      - derive OB indices in overlap region from OB-InsideMask (in obcs_init_fixed.F)
3345        and remove code (in obcs_readparms.F) which was based on EXCH of indices
3346        (through buffer) and did not account for exch2 (e.g., CS-grid) topology.
3347    o pkg/exf and seaice exp:
3348      - change offline_exf_seaice.seaicetd test exp. to use default DIFF1 value (=0)
3349        so that switching off area & heff advection flags does not affect results.
3350      - change default EXF_LWDOWN_WITH_EMISSIVITY to #define in EXF_OPTIONS.h
3351      - keep exp. seaice_obcs & 1D_ocean_ice_column(ad) unchanged (using #undef
3352        EXF_LWDOWN_WITH_EMISSIVITY) and, using pkg/exf default emissivities, update
3353        results of verification experiments: 1D_ocean_ice_column(fwd),
3354        global_ocean.cs32x15.seaice(fwd+ad) & seaice_dynmix(ad), lab_sea (all 8)
3355        and offline_exf_seaice (all 4).
3356    o pkg/seaice:
3357      - remove array YNEG, RIVER, TMIX (replaced by local var) from common block;
3358        remove also areaNm1 & hEffNm1 when SEAICE_GROWTH_LEGACY is undef.
3359      - fix bug: areaNm1 & hEffNm1 are needed in seaice_growth (SEAICE_GROWTH_LEGACY)
3360        but were not filled when resp. SEAICEadvArea=F & SEAICEadvHeff=F and
3361        not multi-dim advection;
3362      - fix seaice_growth.F to compile with both SEAICE_GROWTH_LEGACY and
3363        SHORTWAVE_HEATING #undef.
3364    o optim: make Makefile more robust (?)
3365    o pkg/obcs:
3366      * fix treatment of obcs_read_pickup for TAF
3367    o pkg/shelfice:
3368      * add missing initialisation of num_shifwflx
3369      * new adjoint verification exp. for isomip
3370      * change Prandtl and Schmidt numbers from generic formulations
3371        (in terms of model diffus. and visc.) to separate runtime
3372        parameters, with Holland and Jenkins (1999) default values.
3373    o pkg/exf (interpolation):
3374      - extended input field (2 rows) near the N & S poles:
3375        * fill in with the symetric value (when even Nb of data in longitude)
3376        * add average value at the poles only for scalar quantities ; for vector
3377          component interpolation, skip the averaging and keep duplicated values,
3378          unless the 2 components have same location (uvInterp=T) in which case
3379          interpolate the 2 components together using S/R EXF_INTERP_UV.
3380      - new S/R EXF_INTERP_UV to interpolate the 2 components of a vector field
3381        together: this allows to account properly for local orientation when
3382        averaging at N & S pole.
3383      - add CPP option EXF_USE_OLD_INTERP_POLE to recover old results regarding
3384        exf-interpolation near N & S poles. Undef by default.
3385      - add debug check/print on 1rst iter if debugLevel >=2.
3386    o pkg/exf:
3387      - change masking flags definition (no longer "parameter"), put them in
3388        common block and set them in S/R EXF_INIT_FIXED.
3389      - change recognized masking flag from s,u,v to c,w,s since the mask
3390        to use (maskC,W,S) depends on position on model grid and has little to
3391        do with scalar/vector difference; fix masking if using P-coordinates.
3392      - fix masking of wind-stress (was wrong if interpolated or read on A-grid)
3393        and update results of exp. global_with_exf (x2).
3394      - fix setting of zenith-angle table when SHORTWAVE_HEATING is undef.
3395    o pkg/obcs
3396      - S/R obcs_calc_stevens: fix a small bug (gammat -> gammas where appropriate)
3397    o pkg/exf (interpolation):
3398      - assume periodicity in X only if input field cover full longitude range.
3399      - improve search for lat. index (supposed to be faster, in ~log2(ny) steps,
3400        and should vectorise).
3401      - fix input lat of the 2 added row (in case we provide N.pole data).
3402    
3403    checkpoint63h (2011/12/30)
3404    o pkg/seaice:
3405      - change declaration of UVM from _RL to _RS in order to get B-grid
3406        uIce,vIce monitor when _RS = real*4
3407    o pkg/offline:
3408      - new S/R OFFLINE_RESET_PARMS for resetting main-model params (switch off flags);
3409      - compute vertical velocity if not read from file (switch on exactConserv
3410        & staggerTimeStep);
3411      - fix output of ptracer monitor iter & time for default PTRACERS_monitorFreq.
3412    o verification:
3413      - update grid-files (in tutorial_held_suarez_cs/input and fizhi-cs-32x32x40/input)
3414        with grid-angle generated using "utils/matlab/cs_grid/cubeCalcAngle.m":
3415        fix Pb in yG definition @ 2 missing corners (previously yG was averaged);
3416      - update output of exp. global_ocean.cs32x15.viscA4 after changing
3417        grid-file angles (used here for coriolis-3d);
3418      - remove (or gzip) few files not needed to run fizhi-cs experiments.
3419    o pkg/exf (vector interpolation):
3420      - rotate vector component toward local grid-axis orientation using grid-angles
3421        (stored in GRID.h) instead of locally computed rotation angle; keep old code
3422        available with exf option EXF_USE_OLD_VEC_ROTATION (undef by default).
3423    o pkg/seaice:
3424      - allow to compile with exf options ALLOW_ATM_TEMP or ALLOW_DOWNWARD_RADIATION
3425        undefined. Fix and remove the stop when ALLOW_RUNOFF is undefined.
3426    o pkg/PKG_OPTIONS.h files:
3427      - move #include "CPP_OPTIONS.h" just after #include "PACKAGES_CONFIG.h",
3428        outside of the #ifdef ALLOW_THISPKG / #endif block.
3429      - update verification/*/code/PKG_OPTIONS.h files.
3430    o add a verification experiment (offline_exf_seaice/input.seaice) that test
3431      the B-grid LSOR solver
3432  o pkg/seaice: sort out emissivity and long wave radiation step 2:  o pkg/seaice: sort out emissivity and long wave radiation step 2:
3433    - add emissivity for snow and ice as new run-time parameters    - add emissivity for snow and ice as new run-time parameters
3434      (unfortunately) that default to the corresponding exf values; this      (unfortunately) that default to the corresponding exf values; this
3435      changes results in most verification experiments so that for backward      changes results in most verification experiments so that for backward
3436      compatibility these parameter have to be set explicitly to inconsistent      compatibility these parameter have to be set explicitly to inconsistent
3437      values (ugly);      values (ugly);
3438    - the exf-flag EXF_LWDOWN_WITH_EMISSIVITY then gets rid off the hard-wired    - the exf-flag EXF_LWDOWN_WITH_EMISSIVITY then gets rid off the hard-wired
3439      emissivities of 0.97 associated with lwdownloc in S/R seaice_solve4temp      emissivities of 0.97 associated with lwdownloc in S/R seaice_solve4temp
3440      until we agree how to handle this bug properly      until we agree how to handle this bug properly

Legend:
Removed from v.1.1559  
changed lines
  Added in v.1.2194

  ViewVC Help
Powered by ViewVC 1.1.22