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

Legend:
Removed from v.1.1502  
changed lines
  Added in v.1.2055

  ViewVC Help
Powered by ViewVC 1.1.22