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

Legend:
Removed from v.1.1687  
changed lines
  Added in v.1.2310

  ViewVC Help
Powered by ViewVC 1.1.22