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

Legend:
Removed from v.1.1641  
changed lines
  Added in v.1.2264

  ViewVC Help
Powered by ViewVC 1.1.22