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

Legend:
Removed from v.1.1289  
changed lines
  Added in v.1.1989

  ViewVC Help
Powered by ViewVC 1.1.22