/[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.1295 by jmc, Sat Sep 11 21:39:13 2010 UTC revision 1.1821 by mlosch, Fri Feb 8 07:56:45 2013 UTC
# Line 4  $Name$ Line 4  $Name$
4      Notes on tags used in MITgcmUV      Notes on tags used in MITgcmUV
5      ==============================      ==============================
6    
7    o pkg/diagnostics:
8      - change default missing_value from UNSET_RL to -999.
9    o pkg/layers: improve vectorization of layers_fluxcalc.F
10      - step 1: split loops, make TatU/V 2D arrays. This alone reduces the cpu
11        time spent in this routine by more than a factor of 3 on an NEC-SX8
12      - step 2: replace search algorithm by a bisection algorithm found in
13        Press et al. Numerical Recipes in Fortran. This algorithm can be
14        vectorized and finds the correct bin in approx. log2(Nlayers) steps.
15        For now, use this algorithm only for TARGET_NEC_SX defined.
16      - moved the search algorithm into a separate subroutine, that is kept
17        within the same file for automatic inlining.
18      - modified catching potential errors
19    o pkg/ecco:
20      - add compile switches ALLOW_SHALLOW_ALTIMETRY and ALLOW_HIGHLAT_ALTIMETRY.
21    o model/src, pkg/autodiff, pkg/ctrl, pkg/grdchk :
22      - modifications for ALLOW_GENTIM2D_CONTROL
23      -- forward_step.F, the_main_loop.F : pass options and arrays for adjoint tapes.
24      -- load_fields_driver.F : add call to CTRL_MAP_GENTIM2D( myTime, myIter, myThid )
25      -- add xx_gentim2d0/1 in ctrl_ad_check_lev1_dir.h checkpoint_lev1_directives.h etc
26      -- use ctrl_swapffields.F (new) instead of exf_SwapFFields.F in ctrl_get_gen.F
27    o model/src:
28      - account for moist thermodynamics in (dry) potential temperature equation;
29        update results of experiments: aim.5l_cs (x2), fizhi-cs (std + aqualev)
30        and cpl_aim+ocn.
31      - also switch to standard compiler (gfortran, was using ifort previously)
32        for fizhi-cs experiments reference output.
33    o pkg/ctrl:
34      - 1st step toward generic time-varying control variable (2D) via CPP option
35        ALLOW_GENTIM2D_CONTROL
36      - note new namelist ctrl_nml_genarr in data.ctrl
37    o verification/global_ocean.cs32x15:
38      - switch off OLD_THSICE_CALL_SEQUENCE (both forward and AD code) to use new
39        thsice calling sequence and update "output.icedyn.txt" output file.
40    o pkg/ptracers:
41      - from Ryan A.: code to allow to restart a tracer at regular time interval
42        specifying a reset frequency and a reset-phase (for each tracers).
43    o pkg/thsice:
44      - implement new sequence of calls for thsice+seaice:
45          previously:   ice-Dyn,ice-Advect,ice-Thermo(thsice)
46          new sequence: ice-Thermo(thsice),ice-Dyn,ice-Advect
47      - allows (with temporary CPP option "#define OLD_THSICE_CALL_SEQUENCE"
48        in CPP_OPTIONS.h) to recover old sequence;
49      - update diagnostics for Intermediate State thsice diagnostics: now filled
50        just before advection (instead of just after advection in old sequence);
51      - update output of experiment offline_exf_seaice (standard test);
52      - in global_ocean.cs32x15 exp., postpone output.icedyn.txt update
53        by setting #define OLD_THSICE_CALL_SEQUENCE in CPP_OPTIONS.h
54    o pkg/aim_v23:
55      - use tiled array for aim_CO2 and surface wind speed for export to coupler;
56      - use standard pkg/mdsio routines to read & write CO2 pickup file;
57      - in-line S/R AIM_AIM2DYN_EXCHANGES in aim_do_physics.F;
58      - Implement new sequence of calls for seaice advection (with thsice and
59        seaice diffusion): do ice advection after ice-Thermodynamic (previously
60        was done before); change aim_do_physics.F (split the bi,bj loops block);
61      - use same CPP option (OLD_THSICE_CALL_SEQUENCE) to recover old sequence;
62    o pkg/thsice:
63      - add a missing EXCH of sIceLoad in thsice_main.F (ocean set-up) for the case
64        where just seaice diffusion is used without seaice-dynamics.
65    
66    checkpoint64c (2013/01/18)
67    o pkg/seaice:
68      - add a parameter JFNKres_tFac that can replace JFNKres_t
69        (= JFNKres_tFac*JFNKresidual before JFNK solver)
70      - add a line search option to the JFNK solver
71      - move update of u/vIce and computation of initial residual into a separate
72        routine (same file); makes the code a little easier to read (?)
73      - the line search requires computation of the residual and for some reason
74        I cannot do the update of u/vIce at the beginning of the Newton loop
75        without changing the results, so we move computation of the new residual
76        also to the end of the Newton loop, even without the line search
77    o pkg/mdsio:
78      - write missing value (corresponding to undefined array value) to meta files;
79        skip this if missing value is one (UNSET_RL would be a better value for the
80        case of undefined missing value but it's current the default missing-value);
81        Also update mdsio_read_meta.F (reading timeInterval & missing-value).
82    o pkg/exf & thsice:
83      - for diagnostics purpose, fill-up and update Qsw array (+ fill the
84        diagnostics) even when SHORTWAVE_HEATING is #undef;
85    o verification/cfc_example:
86      - turn on pkg/layers with pkg/diagnostics (to test pkg/layers and to
87        illustrate how to use it).
88    o verification/offline_exf_seaice:
89      in input: add SEAICErestoreUnderIce=.TRUE., and reduce size of forcing
90        files to only one time-record.
91      in input.thermo: narrow the 2 bands of low initial ice-concentration near
92        N & S edges; switch on SEAICErestoreUnderIce=T; use pkg/diagnostics for
93        snapshot output; same mcPheePiston value as in thsice with
94        surf-current=0.2m/s.
95      in input.thsice: similar set-up as in input.thermo (channel with same seaice
96        initial conditions).
97    o verification/cfc_example:
98      - update file "data" with more standard choice (default rotationPeriod,
99        exactConserv=T, reduce ivdc_kappa to 10, remove multiDimAdvection=F,
100        set deltaTFreeSurf to deltaTtracer) and update the output.
101    o pkg/layers:
102      - fix bolus part so that it compiles with #undef GM_BOLUS_ADVEC;
103      - ensure that "layers_bolus" is switched to False when useGMRedi=False.
104    o verification/offline_exf_seaice:
105      - set all {field}period to zero for constant-in-time forcing (not tested
106        anywhere else).
107    o verification/offline_exf_seaice:
108      - dyn_lsr  : use pkg/seaice S/R (instead of pkg/thsice) to advect sea-ice;
109      - dyn_jfnk : use pkg/thsice S/R (instead of pkg/seaice) to advect sea-ice.
110    o model/src:
111      - implement Finite-Volume method for (hydrostatic) presure gradient
112        from S.-J. Lin (QJRMS 1997), for atmosphere using sigma-coordinate.
113    o pkg/seaice: implement EVP* by Lemieux et al. (2012).
114      - In order to be compatible with the default EVP code, this requires changing
115        the EVP code around a little; and because any small change immediately
116        breaks the lab_sea.hb87 verification experiment, the reference output is
117        updated two times (each time the remaining aggrement was only 2 digits):
118        - after replacing 1/dt by 1*recip_dt with a precomputed recip_dt
119        - after replacing 1/(1+0.5*dt/tau) by a/(a+1), with a=2*tau/dt
120        The adjoint test lab_sea.evp also needed to be updated.
121      - Turn on EVP* by setting SEAICE_deltaTevp as before, and setting
122        SEAICEuseEVPstar=.true.; for EVP* SEAICE_deltaTevp does not need to be
123        a factor of SEAICE_deltaTdyn, and you can set the number of EVP steps
124        explicitly with SEAICEnEVPstarSteps (thereby overriding the default of
125        INT(SEAICE_deltaTdyn/SEAICE_deltaTevp)). Controlling EVP* is deliberately
126        kept obscure, because I need to test it a little more.
127    o pkg/cheapaml:
128      - fix few incorrect type (_RL/_RS) in subroutine calls.
129    o pkg/seaice:
130      - new S/R SEAICE_MAP_RS2VEC (similar to SEAICE_MAP2VEC) to map _RS arrays
131        to _RL vector; this fixes JFNK code when compiling with "-use_r4" option.
132    o model/src:
133      - add a warning if using select_rStar=2 with nonlinFreeSurf <> 4;
134        change (in input_ad*/data) select_rStar from 2 to 1 for AD verification
135        experiments global_ocean.cs32x15 & tutorial_tracer_adjsens (+ update output)
136    o pkg/cheapaml:
137      - replace "273.1 _d 0" by celsius2K in pkg/cheapaml/cheapaml.F and
138        update output of experiment cheapAML_box.
139      - store in CHEAPAML.h coeffs ssq[0:2] for saturation specific humidity,
140        and set them only in one place (cheapaml_readparms.F).
141      - replace "273.16 _d 0" by celsius2K & replace "3.14159 _d 0" by constant "PI"
142      - remove re-setting of main-model parameter "celsius2K" (in cheapaml_readparms)
143        and re-setting of cheapAML params "lath" & "p0" (in cheapaml_init_varia).
144    o model/src/the_main_loop.F:
145      - fix revision 129 : need both ALLOW_ECCO and ALLOW_ECCO_EVOLUTION.
146    o pkg/seaice:
147      - remove legacy branch code.
148      - retire SEAICE_GROWTH_LEGACY and SEAICE_CAP_HEFF accordingly.
149    o verification/*/code*/SEAICE_OPTIONS.h:
150      - remove documentation for retired CPP flags (SEAICE_GROWTH_LEGACY,
151        SEAICE_CAP_HEFF).
152    o pkg/cheapaml:
153      - use standard routine (S/R GET_PERIODIC_INTERVAL) to decide when it is time
154        to load new forcing fields.
155      - add missing "_d 0" where it's needed; + some editing (improve indentation).
156      - remove switch to "-r8" compiler option (no longer needed) in verification
157        cheapAML_box, keep same output (small trucation error differences).
158    o verification/offline_exf_seaice:
159      - add thermodynamics only test.
160    o verification/cheapAML_box:
161      - split the domain in 8 (2x4) tiles; add MPI and multi-threaded test;
162        keep same output (same 14 digits for cg2d).
163      - switch on "-r8" compiler option (some numerical values are missing
164        the "_d 0") and update output (only 6 digits for cg2d were preserved).
165    
166    checkpoint64b (2012/12/24)
167    o pkg/cheapaml:
168      - remove un-used variables (Qnet,EmPmR) from pickup files.
169      - store tendency of advected variables into cheapaml pickup file
170        and fix the AB-2 restart.
171    o verification/offline_exf_seaice and lab_sea adjoint:
172      - switch to new code (#undef SEAICE_GROWTH_LEGACY).
173      - switch to 4 time steps in offline, consistent with lab_sea.
174      - match parameters from SEAICE_GROWTH_LEGACY branch in data.seaice.
175      - update results after change of experiment seaice.
176    o pkg/seaice:
177      - remove option SEAICE_MULTICATEGORY; has been replaced with run-time
178        parameter SEAICE_multDim. Issue a warning if SEAICE_MULTICATEGORY is
179        still defined since SEAICE_multDim needs to be set to MULTDIM value (from
180        SEAICE_SIZE.h) to recover previous #define SEAICE_MULTICATEGORY default.
181    o model/src:
182      - add run-time parameter to select CG2D solver minimum-residual solution
183        (in case of a poor convergence).
184    o pkg/seaice/seaice_lsr.F
185      - move calculation of matrix coefficients into new
186        S/R SEAICE_CALC_LSR_COEFFS; for now this routine remains in the same
187        file; the main purpose of this change is to be able to reuse the code
188        in S/R SEAICE_PRECONDITIONER
189      - modify the computation of the residual so that the mass of sea-ice
190        is not used twice; this simplifies the calculations, but since
191        the residual is never used except when LSR_mixIniGuess.ge.4---and this is
192        not tested in testreport---this does not affect the testreport results.
193    o verification/seaice_obcs:
194      - disable SEAICE_GROWTH_LEGACY; reset input files to match those of
195        verification/lab_sea/input.salt_plume; changes results/output.txt*
196    o model/src:
197      - adapt quasi-hydrostatic formulation to work with p or p* coordinate.
198    o pkg/seaice:
199      - improve description of parameters in seaice_fgmres.F and start
200        cleaning up the code
201      - change name of SCALPROD to SEAICE_SCALPROD and modify meaning of
202        second argument
203      - add a metric based on grid cell area to SEAICE_SCALPROD; update
204        results of offline_exf_seaice.dyn_jfnk
205      - compute initial residual norm in seaice_jfnk based on SEAICE_SCALPROD
206    o pkg/aim_v23:
207      - fix an other bug in dissipation heating (grid-cell area was missing).
208    o model/src + pkg/seaice:
209      - add global (multi-tile) linear solver for pair of tri-diagonal system
210        along X and Y lines, respectively for U and V component.
211        Note: 1) MPI and cube-exchange not yet coded.
212            2) probably not accurate for poorly conditioned / large size problem.
213      - add option for SEAICE_LSR to use global (multi-tile) tri-diagonal solver;
214        default: not compiled and not used.
215    o pkg/seaice:
216      - first attempt at a multi-threaded fgmres solver for the JFNK solver:
217        introduce bi/bj loops and use global_sum_tile_rl instead of
218        mpi_allreduce in seaice_fgmres.F
219      - improve diagnostics output for fgmres solver (seaice_fgmres.F)
220      - replace a few unnecessary goto statements by if-blocks  (seaice_fgmres.F)
221      - add a verification experiment for JFNK in offline_exf_seaice
222    o verification:
223      - change (for now, only fwd test) offline_exf_seaice experiment:
224        use a re-entrant channel with idealized coastline (trapezoidal shape)
225        at southern boundary to explore seaice dynamics and thermodynamics
226        with simple forcing. Main set-up has dynamics+thermo and SST relaxation;
227        secondary test (input.thsice) use thermodynamics only with SST relaxation.
228      - add seaice-dynamics only secondary test using LSR and pkg/thsice advection.
229    o pkg/exf:
230      - disable "sstExtrapol" when Nr=1
231    o verification:
232      - add new experiment "cheapAML_box" (simple 1 layer set-up from Bruno Deremble)
233        to test pkg/cheapaml.
234    o pkg/aim_v23 & pkg/shap_filt:
235      - fix dissipation heating (erroneous gravity multiplication factor).
236    o pkg/seaice:
237      - remove unused field pressPre from jfnk solver
238      - rename two subroutines in seaice_preconditioner.F
239    o eesupp/src:
240       - S/R MDSFINDUNIT avoids reserved unit numbers (scrUnit1, eeDataUnit ...)
241    o pkg/seaice/seaice_preconditioner.F: fix preconditioner once again
242       - remove wrong parts of the rhs and the lhs (were in there
243         because I did not understand the concept of this preconditioner)
244       - add an exchange between u- and v-sweep. This increases communication
245         by a factor of two but improves the convergence of jfnk. Ideally,
246         one would like the u- and v-sweep to be independent. So far within
247         undocumented ifdefs
248       - reorganize the extra computations for printing the residuals
249    o tools/genmake2:
250      - comment out the "mpif.h" include in NetCDF test programm (for MPI built)
251        since it's not necessary (and was preventing to use MNC in some cases).
252    
253    checkpoint64a (2012/11/16)
254    o pkg/autodiff:
255      - improve pkg-internal logical parameter switch (inAd/inFwd mode) so that
256        autodiff_readparms.F no longer depends on calling order (within
257        packages_readparms.F) and no longer requires to include ${PKG}_PARMS.h):
258        rename param turnFreeDriftInAdMode to SEAICEuseFREEDRIFTswitchInAd
259        and change param SEAICEuseDYNAMICSinAdMode to SEAICEuseDYNAMICSswitchInAd.
260    o pkg/obcs:
261      - adding tidal velocity forcing capability to obcs
262        for usage example, see verification/seaice_obcs/input.tides
263    o pkg/seaice:
264      - turn the LSR-relaxation parameters WFAU/V into runtime parameters
265        SEAICE_LSRrelaxU/V
266      - introduce runtime parameter SEAICEetaZmethod (=0 by default)
267    o pkg/aim_v23:
268      - implement heating from friction (bottom friction and stratospheric drag).
269    o pkg/shap_filt:
270      - fix diagnostic "SHAP_dKE" (was 2 time smaller); implement heating from
271        dissipation but only for Shap_funct=2, active when addFrictionHeating=T.
272    o model/src:
273      - move AddMass common block from DYNVARS.h to FFIELDS.h; allow to read-in
274        time-constant addMass field from file (addMassFile);
275      - support for heating due to friction (and Kinetic Energy dissipation):
276        add option, run-time switch and 3-D field array + support code ; each pkg
277        or S/R can add heating contribution (if there is a sink of KE); the sum is
278        accounted for as a Temperature tendency term (EXTERNAL_FORCING_T).
279    o pkg/seaice:
280      - complete merge of ITD code into seaice_growth.F
281        from MITgcm_contrib/torge/itd/code/
282        no verification so far, but Torge Martin tested
283        "1-D test case and Beaufort set up;
284        deliver okay results after 1 model year."
285      - complete merge of SEAICE_SIZE.h into all relevant routines
286      - move computation of eta at Z-points into calc_viscosities
287        + introduce global field etaZ
288        + add different methods for computing etaZ, for now the old
289          method (simple averages of eta to Z-points) is hardwired
290        + replace etaMeanZ by etaZ in seaice_lsr, seaice_calc_residual,
291          seaice_preconditioner
292      - simplify computations for SEAICE_ZETA_SMOOTHREG
293      - seaice_preconditioner:
294        + replace one remaining press by pressLoc (mistake)
295        + adjust printing of residuals
296      - improve I/O of diagnostics of JFNK in seaice_jfnk.F:
297        + add (SEAICE.h) and rename some counters (initiliased in
298          seaice_init_fixed.F)
299        + add _BEGIN/END_MASTER (myThid)  around print statements
300        + print total number of iterations and failures over SEAICE_monFreq
301          interval to STDOUT
302      - move control over output-messages by fgmres to seaice_jfnk to save
303        some operations
304      - move resetting initial guess for fgmres outside of seaice_fgmres_driver
305        in order to make restarts with sol .ne. zero (fgmres with restarts)
306        (seaice_jfnk.F, seaice_fgmres.F)
307      - seaice_calc_l/rhs.F: replace maskW/S by maskInW/S; this fixes
308        a serious convergence problem when open boundaries are involved
309    o pkg/ggl90: fix computation of control volumes for the case of
310      ALLOW_GGL90_HORIZDIFF (probably not used very often): move control volumes
311      up half a grid cell from C-centered to W-centered (pointed out by C. Eden)
312    o pkg/seaice: simplify seaice_evp by avoiding use of extra fields u/vIceC
313    o pkg/autodiff
314      - Add inAdMode switch for SEAICEuseDYNAMICS:
315        SEAICEuseDYNAMICSinAdMode
316        (extend logic in ADAUTODIFF_INADMODE_SET)
317    o pkg/seaice
318      - Step 1 of merging ice-thickness distribution (ITD) code from
319        MITgcm_contrib/torge/itd/ (author: Torge Martin)
320        The code implements concept laid out in Thorndike et al. (1975);
321        code is enabled via CPP flag SEAICE_ITD
322        nITD (in SEAICE_SIZE.h) defines number of ice thickness categories;
323        code is not complete yet!!
324      - SEAICE_SIZE.h now included in almost all seaice routines
325    o verification (using seaice):
326      - switch back seaice-dynamics (+ lower SOLV_MAX_ITERS) in ADM exp.
327        global_ocean.cs32x15.seaice ; update results.
328      - compile B-grid dynamics in FW test exp 1D_ocean_ice_column ;
329      - compile C-grid dynamics with #define SEAICE_ALLOW_JFNK in FW test exp
330        offline_exf_seaice (previously compiling B-grid).
331    o pkg/exf:
332      - fix some STOP conditions in exf_check.F (from Aug 28, modifs did not allow
333        to specify neither just 1 comp of wind or wind-stress, nor no surface momentum
334        forcing): just replace CPP option ALLOW_ATM_WIND with run-time param useAtmWind.
335    o pkg/layers (adjust changes from Sept 19):
336      - do snap-shot output and fill diagnostics from inside iLa loop (layers_calc.F)
337        this allows to remove "layers_maxNum" dimension from all layers arrays.
338    o pkg/layers (adjust changes from Sept 19):
339      - remove ALLOW_LAYERS_OUTPUT ; fix snap-shot and time-ave output ;
340      - snap-shot extended to all type of layers (not just the 1rst type);
341      - remove layers variables when corresponding CPP option is undef.
342    o pkg/layers:
343      - rename pkg/layers variable and add new output (layer exist & un-weighted
344        velocity in layer)
345    o pkg/seaice:
346      - simplify (?) ocean-drag coefficent computations by using
347        the same routine in all three solvers (saves some code lines)
348      - remove global fields DRAGA and DRAGS from C-grid code and
349        declare them locally in lsr.F (the only place where they are
350        still used)
351      - update AD output of lab_sea.evp (very sensitive anyway).
352    o pkg/seaice: add Jacobian-free Newton Krylov solver for ice dynamics
353      (Lemieux et al. 2010, 2012). Turn on with the usual SEAICE_ALLOW_JFNK
354      and SEAICEuseJFNK=.true. A few things to note:
355      - involves a FGMRES, that is parallel but very inefficient,
356        because of many scalar products (global sums) in the Gram-Schmidt
357        orthogonalization method. Needs to be replaced. Original code
358        from J.-F. Lemieux
359      - preconditioner for FGMRES is a stripped down version of LSOR
360      - SOLV_MAX_ITERS is now used for LSOR as a solver and as a
361        preconditioner. For the preconditioner, the default is set to 10.
362      - Jacobian times vector is computed with finite differences
363      - marginally related to JFNK-solver: add a smooth regularization for
364        zeta with tanh that will improve convergence (Lemieux and Tremblay,
365        2009) for any implicit solver (not implemented for EVP because EVP
366        does not need this regularization in the first place). Define
367        SEAICE_ZETA_SMOOTHREG in SEAICE_OPTIONS.h to use.
368    o eesupp/src:
369      - check in genmake2 that intrinsic S/R flush is available.
370      - add S/R to flush IO unit (if intrinsic S/R flush is available)
371      - flush standard & error msg unit before MPI termination
372      - if debugMode, flush IO unit after printing msg
373    o pkg/ctrl:
374      - ctrl_unpack.F, ALLOW_GENARR3D_CONTROL code: fix missing argument in call
375        to ctrl_set_unpack_xyz.
376    
377    checkpoint64 (2012/10/09)
378    o pkg/shelfice
379      - in mom_fluxform.F, mom_vecinv.F:
380        CALL SHELFICE_V_DRAG(bi,bj,k,vFld,KE,KappaRU,vF,myThid)
381        Bug fix KappaRU -> KappaRV
382        does not change verification/isomip but may change other setups
383        (presumably constant KappaRU=KappaRV)
384      - fix diagnostics SHIU/Vdrag (thanks to Tom Millgate)
385    o pkg/obcs:
386      - fixed some indexing bugs in obcs_seaice_sponge.F
387      - added obcs relaxation subroutines for HSALT and HSNOW
388      - changes verification/seaice_obcs/results/obcs_seaice_sponge.F
389    o pkg/seaice:
390      - add "multicategory" parameterization for snow in analogy to ice,
391        default is off for now.
392    o pkg/obcs:
393      - added obcs_seaice_sponge.F for obcs relaxation of seaice variables;
394        see verification/seaice_obcs/input.seaiceSponge for example application.
395      - remove local commom bloc "OBCS_GLOBAL" in obcs_readparms.F and do all the OB
396        index setting by master-thread. This fix multi-threads Pb in previous modifs.
397    o pkg/layers :
398      - add diagnostics to pkg/layers
399      - move the meat of pkg/layers from layers_calc.F to layers_fluxcalc.F
400        (from R.Tulloch). Layers_calc.F now calls layers_fluxcalc.F accordingly.
401    o pkg/generic_advdiff/gad_implicit_r.F :
402      - fix ADVr diagnostics in case of both implicit vertical advection and diffusion.
403    o pkg/seaice/seaice_growth.F:
404      - fix SItflux diagnostics in virtual salt flux + balanceEmpmr case.
405    o pkg/obcs:
406      - change default setting of OBCS_UVICE_OLD from defined to undef;
407      - use new parameter OB_indexNone for null index value (instead of hard-coded 0)
408        in all pkg/obcs code and in other pkgs; remove k loop in obcs_check_depths.F;
409      - pass OB_indexNone as (new) argument to S/R CTRL_MASK_SET_[X,Y]Z;
410      - change OB null index value (OB_indexNone) to -99 ; this fix the problem
411        with Southern & Western OB at a tile edge (at least in a simple set-up).
412    o pkg/obcs:
413      - change settings of OB index in case OB coincides with tile edge (shared by
414        2 tiles), so that common OB location is registered by both tiles (instead of
415        only 1). However, for Southern and Western OB, index value = 0 is not
416        recognized as valid OB index (=default null value) and needs to be fixed.
417      - modify accordingly OBCS_BALANCE_FLOW and OBCS_MONITOR (avoid double counting)
418      - new parameter "OB_indexNone" for null index value (for now, still zero)
419        to replace hard-coded null index value of zero.
420    o pkg/exch2:
421      - improve W2_USE_E2_SAFEMODE (faster) and W2_E2_DEBUG_ON:
422        always check buffer-size (but outside the loop); move checking for valid
423        index from W2_USE_E2_SAFEMODE to W2_E2_DEBUG_ON; in W2_E2_DEBUG_ON,
424        print each tile and point connection only if |W2_printMsg|>= 2 and 3.
425    o pkg/ctrl (pack & unpack):
426      - in ctrl_pack.F & ctrl_unpack.F, use the same local file-name variable
427        (locally defined) for different variables (+ remove the variable-specific
428        file name in CTRL_GENARR.h). For now, only implemented for GENARR2/3D_CONTROL
429        (to be extended to other local file names in ctrl.h).
430    o pkg/flt:
431      - add a FLT_Iter0 option (similar to PTRACERS_Iter0).
432    o pkg/mdsio:
433      - fix missing STOP in mdsio_readvec_loc.F (case ioUnit=0) when file is missing
434    o tools/genmake2:
435      - add similar dependences for target EXE_AD & EXE_FTL as we have for EXECUTABLE
436        (added by Alistair in version 1.51 for building without make depend);
437      - remove Header files list (H_SRC_FILES) from the dependence of targets
438         ad_input_code.f & ftl_input_code.f (not clear why it was added in the first
439        place in version 1.23): this save going through staf when unrelated header
440        file has been modified.
441       Note: for an intermediate target (e.g., ad_input_code.f or adtaf) without
442        "make depend" step, still need to do "make links" before "make adtaf".
443    o eesupp/src (+ few pkg src files) & genmake2:
444      - finish to remove ALWAYS_USE_MPI in source code that TAF does not see;
445      - no longer set ALWAYS_USE_MPI in Makefile (was done by genmake2).
446      - improve genmake2 checking for ALLOW_${PKG} in CPP_OPTIONS.h files (distinguish
447         upper/lower case ; account for space between "#" and undef/define)
448    o pkg/flt (with exch2):
449      - cleaning: fix so that it compiles; move remaining MPI calls out of flt_exch2.F;
450      - simplify threads synchronisation; fix (many issues) multi-threaded with MPI.
451    
452    checkpoint63s (2012/09/05)
453    o pkg/ecco:
454      - remove #ifdef ALLOW_SMOOTH_CORREL3D brackets.
455      - add more relevant #ifdef ALLOW_SMOOTH ones.
456      - sort out useAtmWind, useSMOOTH, ctrlSmoothCorrel2D.
457    o pkg/ctrl:
458      - CTRL_OPTIONS.h : document CPPs related to smoothing; ALLOW_SMOOTH_CORREL2D/3D,
459        ALLOW_CTRL_SMOOTH, ALLOW_SMOOTH_CTRL2D, ALLOW_SMOOTH_CTRL3D.
460      - ctrl.h : document run time params doInitXX, doMainPack, doMainUnpack, doPackDiag,
461        doSinglePrecTapelev (audodiff param!), ctrlSmoothCorrel2D (new) and
462        ctrlSmoothCorrel3D (new).
463        The added ctrlSmoothCorrel2D/3D replace the old ALLOW_SMOOTH_CORREL2D/3D CPP.
464      - ctrl_readparms.F : initialise ctrlSmoothCorrel2D/3D and read from namelist.
465      - ctrl_init.F ctrl_pack.F ctrl_unpack.F : switch off ustress/vstress
466        controls when useAtmWind, and vice versa.
467      - ctrl_map_ini_ecco.F : UVEL0, VVEL0, edtaux, edtauy cannot be smoothed as tracers.
468      - ctrl_get_gen.F : replace #ifdef ALLOW_SMOOTH_CORREL2D with
469          #ifdef ALLOW_SMOOTH, IF ctrlSmoothCorrel2D, IF useSMOOTH.
470      - ctrl_map_ini_gen.F : replace #ifdef ALLOW_SMOOTH_CORREL3D with
471          #ifdef ALLOW_SMOOTH, IF ctrlSmoothCorrel3D, IF useSMOOTH.
472      - ctrl_set_pack_xy[z].F, ctrl_set_unpack_xy[z].F:
473        replace ALLOW_SMOOTH_CORREL2D/3D brackets with ctrlSmoothCorrel2D/3D.
474    o pkg/smooth:
475      - remove un-necessary includes.
476      - remove ALLOW_SMOOTH*D and ALLOW_SMOOTH_CORREL*D brakets.
477        Those CPP options were never defined, and not necessary.
478    o model/src:
479      - fix CPP brackets in ini_mixing.F (GM_background_K belongs to gmredi).
480      - standard treatment of useSMOOTH.
481    o pkg/autodiff:
482      - add LOGICAL useGGL90inAdMode, useGGL90inFwdMode, useSALT_PLUMEinAdMode,
483        useSALT_PLUMEInFwdMode allowing to switch off ggl90 and salt_plume adjoint.
484    o pkg/exch2:
485      - add "if usingMPI" where it was missing (in exch2_rx?_cube*.template)
486        + start to remove ALWAYS_USE_MPI in source code that TAF does not see.
487      - make new S/R W2_MAP_PROCS out of w2_eeboot.F to setup exch2 CommonFlag
488        and tiles to process mapping.
489      - re-arrange 3 header files (W2_EXCH2_PARAMS.h, _BUFFER.h & _TOPOLOGY.h)
490        moving /EXCH2_FILLVAL_RX/ & /W2_EXCH2_COMMFLAG/ to W2_EXCH2_TOPOLOGY.h;
491        rename "exch2_tProc" to "W2_tileProc" and move seting of e2FillValue_RX
492        from w2_eeboot.F to w2_readparms.F.
493    o eesupp/src:
494      - set exchNeedsMemsync & exchUsesBarrier according to "usingMPI" (instead of
495        ALWAYS_USE_MPI) + moved from ini_communication_patterns.F to eeset_parms.F;
496        also move setting of exchCollectStatistics from exch_init.F to eeset_parms.F
497      - in eedie.F and all_proc_die.F, always call MPI_FINALIZE when ALLOW_USE_MPI
498        is defined (remove condition on usingMPI) to match cases where MPI_INIT
499        has been called.
500      - fix bug I put in previous modif of exch_sm_3d_rx.template (not much used);
501      - change default (non-MPI) value of myPid (from 1 to 0) to match MPI settings
502        (so that on 1 proc, get same myPid independently of usingMPI)
503      - add a stop if multi-procs but usingMPI=F ; stop also if usingMPI=T and
504        useCubedSphereExchange with EXCH-1 (safer).
505      - add "if usingMPI" where it was missing (+ start to remove ALWAYS_USE_MPI).
506    o pkg/ggl90:
507      - fix bug in filling corner mask array "mskCor" (FILL_CS_CORNER_TR_RL call)
508        used in ALLOW_GGL90_SMOOTH code.
509    o pkg/flt:
510      - fix typo in FLT_WITHOUT_Y_PERIODICITY (the effect was to ignore stopping
511        floats at the Southern end of the domain).
512    o eesupp/inc:
513      - add a list of CPP-options which can be set by Makefile (DEF_IN_MAKEFILE.h);
514        but not used (and not to be used) anywhere, just for documentation.
515    o pkg/autodiff, exf, ptracers & seaice (AD & TL output):
516      - comment out the very nasty "writeBinaryPrec = writeStatePrec" line, since:
517        a) can damage previously written records in any other multi-record files.
518        b) if needed, can easily do it cleanly, by calling S/R WRITE_REC_3D_RL/S.
519    o tools/genmake2:
520      - define variable MAKE within Makefile and use it in place of 'make';
521      - update AD_CONFIG.h (if needed) before building any of the executable
522        (forward, adjoint or tangent-lin); this involves a 2nd invocation of make;
523        and add the usual #ifndef/#define AD_CONFIG_H in AD_CONFIG.h;
524      - always print usual warning comment 'this file is automatically generated'
525        from script convert_cpp_cmd2defines (+ remove this warning from genmake2).
526    o pkg/cheapaml:
527      - updated to correspond to the code used in accepted paper (Nico Wienders).
528    o pkg/exf:
529        added run time switch useAtmWind to replace ALLOW_ATM_WIND cpp switch.
530        ALLOW_ATM_WIND now just sets the useAtmWind default (see exf_readparms.F)
531        and force defines ALLOW_BULKFORMULAE (EXF_OPTIONS.h).
532    o pkg/exf, autodiff, ctrl, ecco and seaice:
533        remove ALLOW_ATM_WIND brackets, or replace them with useAtmWind ones.
534    o pkg/ctrl, ecco:
535        allow to compile both ALLOW_U/VSTRESS_CONTROL and ALLOW_U/VWIND_CONTROL.
536        Depending on useAtmWind, one is inactive, and the other is active (see
537        exf_getffields.F/exf_getsurfacefluxes.F).
538    o tools/genmake2:
539      - improve error msg when failing in 2nd test of check_for_broken_Ff
540      - fix option '-makefile' short-name (-mf according to genmake2 -help)
541      - source local config file "genmake_local" just after processing the genmake2
542        command arguments (previously done before processing arg).
543    o pkg/grdchk:
544      - add a call to TURNOFF_MODEL_IO for Tangent-Linear run (in this case, call
545        to this routine from cost_final has been dropped in g_cost_final)
546      - improve printed information (more explicit msg, no longer using "print *,"
547         fix fcpertminus printed value).
548    o model/src:
549      - move call to COST_INIT_VARIA out of packages_init_variables.F directly
550        into initialise_varia.F (just after calling PACKAGES_INIT_VARIABLES):
551        this prevents getting cost-funct reset in adinitialise_varia recomputations.
552    o pkg/dic:
553      - move initialisation of "freefe" array from from dic_biotic_forcing.F to
554        fe_chem.F: this prevents TAF from dropping this initialisation in TLM code.
555    o pkg/grdchk:
556      - grdchk_main.F : added CALL GLOBAL_SUM_INT( ierr , myThid )
557      - grdchk_getadxx.F etc. : omit I/O if ierr.EQ.0
558    o pkg/autodiff/ctrl/grdchk :
559      - attempt to sort out what works and what does not,
560        with regard to I/O, and to warn/stop accordingly.
561    o pkg/grdchk:
562      - attempt to fix grdchk in the case of useSingleCpuIO.
563      - "if ( myProcId .EQ. grdchkwhichproc .AND. ierr .EQ. 0 )"
564       statements were moved from grdchk_main.F and into
565       grdchk_getadxx.F grdchk_getxx.F grdchk_setxx.F.
566      - a global sum is applied to record numbers icvrec/layer
567       out of grdchk_loc so that they be passed to I/O routines.
568    o pkg/smooth:
569      - fix recomputation that appeared with nlfs : use smooth_recip_hFacC,
570        smooth_hFacW, smooth_hFacS (copied at init_fixed) in 3d case.
571    o verification/testreport:
572      - add option '-tlm' for Tangent-Linear test (-adm,-oad,-tlm are all exclusive);
573      - can also use compressed (gzip) reference output file;
574      - change format (in pkg/grdchk) of TLM output (+ add forward gradient)
575        to be easier to collect by testreport.
576      - update existing TLM output (half out-of-date by more than 3 yrs).
577      - report NETCDF & LAPACK settings (from genmake2) in output dir.
578      - report run-time in each individual summary (previously only for AD test);
579        for TLM test, add also TAF version.
580      - add daily TLM test on (old) aces cluster + weekly test on baudelaire.
581    
582    checkpoint63r (2012/08/15)
583    o tools/genmake2:
584      - fix Makefile for target ftlall (+ update files to clean after make ftlall)
585    o pkg/ecco/ecco_cost_final.F :
586      - fix fc print statements (to stdout and costfunction0000) so
587        that the printed value is always after the global sum.
588    o pkg/seaice/seaice_dynsolver.F :
589      - fix ice strength assymptote at SEAICE_area_max<1
590        (no change for the standard case of SEAICE_area_max=1)
591    o some cleaning:
592      - pkg source files: ensure that all *.F files from each pkg included the
593        corresponding ${PKG}_OPTIONS.h file (except stand-alone src file which
594        only includes CPP_EEOPTIONS.h); fix S/R CTRL_SMOOTH ; update AD experiment
595        code_ad/*.F src files; add new option-file in pkg/admtlm + corresponding
596        includes;
597      - model/src: add PACKAGES_CONFIG.h wherever ALLOW_AUTODIFF[_TAMC] is used.
598      - ALLOW_DIFFKR_CONTROL: add a stop in S/R CTRL_CHECK in case ALLOW_3D_DIFFKR
599        is undef; also define /DYNVARS_DIFFKR/ common block in DYNVARS.h when
600        ALLOW_DIFFKR_CONTROL is defined, to allow to compile and reach this stop.
601      - update option-file CPP_OPTIONS.h of all AD experiments:
602        * no longer include PACKAGES_CONFIG.h ;
603        * includes ECCO_CPPOPTIONS.h if PACKAGES_CONFIG.h has been included ;
604        * def/undef ALLOW_3D_DIFFKR independently of ALLOW_DIFFKR_CONTROL (before
605          including ECCO_CPPOPTIONS.h).
606    o pkg/cost, pkg/ctrl, pkg/ecco option-file:
607      - clean-up and split content of old pkg/ecco/ECCO_CPPOPTIONS.h file into
608        separated pkg option-file (done according to old doc from ECCO_CPPOPTIONS.h,
609        not necessary accurate).
610      - add a template for option-file ECCO_CPPOPTIONS.h, mostly empty, in
611        pkg/autodiff, i.e., the 1rst pkg to compile for adjoint built, with lines to
612        deliberately break compilation (a remainder that it needs to be customized)
613      - in pkg/ecco, includes ECCO_OPTIONS.h instead of COST_OPTIONS.h
614      - rename COST_CPPOPTIONS.h to COST_OPTIONS.h
615      - rename CTRL_CPPOPTIONS.h to CTRL_OPTIONS.h
616    o tools/genamke2:
617      - check for lapack.
618    o pkg/cost and pkg/ecco : attempt to sort out some of the limiting intricacies.
619      - pkg/cost.cost_final.F : allow for use of pkg/ecco and pkg/cost cost functions
620        jointly. The exclusive ifdefs were removed, to add costs terms (when defined)
621        from both packages.
622      - the fc global sum in pkg/ecco/ecco_cost_final.F was removed accordingly.
623      - for objf_atl we use either the pkg/ecco or the pkg/cost term depending on CPPs.
624      - pkg/ecco and model/src : add CPP brackets around pkg/cost and pkg/ctrl includes
625        of "CTRL_SIZE.h" "ctrl.h" "ctrl_dummy.h" "optim.h" / "cost.h" accordingly.
626    o pkg/cost : add comments to explain special and/or untested setups.
627    o pkg/exf:
628      - use EXF_OPTIONS.h to set pkg/exf options except if done in ECCO_CPPOPTIONS.h
629        (previously, ALLOW_AUTODIFF_TAMC was controling this switch).
630    o verification/*/code_ad:
631      mimimal cleaning of AD experiments ECCO_CPPOPTIONS.h option-file:
632      - reccord when this file is included (define ECCO_CPPOPTIONS_H)
633      - remove the most obvious obsolete features (e.g., #define ALLOW_COST not
634        allowed since Oct 2003 in any option-file except in PACKAGES_CONFIG.h)
635    o pkg/seaice :
636      - added possibility to change ice strength/PRESS0 relationship to
637        HEFF, according to the following run time parameters
638        SEAICEpresPow0 :: HEFF exponent for ice strength below SEAICEpresH0 (integer, >0)
639        SEAICEpresPow1 :: HEFF exponent for ice strength above SEAICEpresH0 (integer, >0)
640        SEAICEpresH0   :: HEFF threshold for ice strength            (m)
641    o pkg/ggl90 :
642      - added run time flag mxlSurfFlag to include the code that ensure
643        mixing between first and second level (previously included as a comment)
644    o verification/1D_ocean_ice_column/input_ad/data.autodiff :
645      - add test of newly added dumpAdByRec=T option where
646        we write all records to one file per variable.
647    o verification/global_ocean.cs32x15/code_ad/CPP_OPTIONS.h :
648      - switch to #define ALLOW_BALANCE_RELAX and ALLOW_BALANCE_FLUXES
649        to check that this code is ok with taf and compiles in adjoint.
650    o pkg/autodiff :
651      - added run time param dumpAdByRec : ad dump format switch.
652        If true then write all records to one file per variable.
653        Else write one file per record (remains the default).
654      - revise seaice_ad_dump.F and exf_adjoint_snapshots_ad.F accordingly.
655    o pkg/seaice:
656     - Added SEAICEuseTILT run time switch : if set to
657       false then omit the tilt term in seaice dynamics.
658     - Fix free drift calculation.
659    o pkg/shelfice:
660      When initializing SHELFICEDragQuadratic, set default to be
661      consistent with shiCdrag in case SHELFICEuseGammaFrict is used,
662      but retain option to set it independently
663      (inconsistenty spotted by Veronique Dansereau)
664    o eesupp/inc:
665      - in EEPARAMS.h, add real-type constant for some frequently used simple number
666         (0,1,2,1/2), with name explicitly referring to RS/RL type.
667    o model/src:
668      - move balancing of relaxation terms to new S/R balance_relax.F.
669    o pkg/autodiff:
670      re-write active I/O high-level (control) S/R:
671      - rename  S/R ACTIVE_READ/WRITE_RL to ACTIVE_READ/WRITE_3D_RL
672      - add 1 more argument (useCurrentDir) to replace the "_LOC" 2nd set of S/R.
673      - use standard pkg/mdsio I/O routines (MDS_READ/WRITE_SEC_XZ/YZ  and
674        MDS_READ/WRITE_FIELD); change loops to multi-threads.
675      - update and merge active_file_control_slice.flow into active_file_control.flow
676      - update the calls in lower level S/R (active_file.F, active_file_g.F and
677        active_file_ad.F) keeping the argument list and function unchanged.
678      - also update lower-level "_LOC" version (call same S/R with "useCurrentDir
679        =.TRUE.") and remove high-level (control) _loc version (not called anymore).
680      - new low-level active I/O routines, one for each type (RL/RS), for active var
681        of various (XY,XZ,YZ) shape and level number (arguments: arrShape, myNr);
682        fix ctrl_init_wet.F & ecco_cost_weights.F by calling the new S/R with the
683        right type.
684    o autodiff and RS=real*4:
685      - call the right type (_RS instead of _RL) of S/R in few output S/R (pkg/exf
686        ad-monitor and snapshots); disable arrType='RS' in mdsio_gl*.F ;
687      - change argument type of 3-D mask argument to _RS to match type in the call
688        (in seaice_cost*.F, ctrl_*_gen.F and *ctrl_bound.F); to be continued.
689    o pkg/thsice:
690      - re-anable balanceEmPmR when useSEAICE=T with useThSIce=T.
691      - option to correct ocean fresh-water flux for imbalance of Atmos+Land
692        fresh-water flux: uniform correction or proportional to local precip.
693    o pkg/ctrl:
694      - new header file CTRL_SIZE.h for parameters maxCtrlArr2D, maxCtrlArr3D
695      - redefine CPP option ALLOW_BOTTOMDRAG_CONTROL to
696                            ALLOW_BOTTOMDRAG_CONTROL_NONGENERIC
697      - verification/hs94.1x64x5/ tests ALLOW_GENARR{2D,3D}_CONTROL
698    
699    checkpoint63q (2012/07/30)
700    o pkg/autodiff:
701      note about monitor and snap-shot of ad-variables:
702      a) need to apply ADEXCH before monitor or output of ad-vars to include
703       overlap contributions (was done for adjDump but missing for monitor).
704      b) since ADEXCH implies adding overlap values to interior array, machine
705       truncation error is expected when adding an ADEXCH call in the middle of
706       the time-stepping (although mathematically identical).
707      modifs:
708      - fix some incorrect type (RL/RS, UV/scalar) in ADEXCH calls and ad-vars
709        declaration (adEddyPsiX,adEddyPsiY in adcommon.h).
710      - add new run-time params (dumpAdVarExch & mon_AdVarExch) to select how  to
711        apply ADEXCH before monitor or snap-shot of ad-variables:
712           =0 : no ADEXCH ; =1 : do ADEXCH ; =2 : apply ADEXCH on a local copy.
713      - implement new method (copy+adexch) for snap-shot and monitor of main model
714        ad-vars (initially not used by default -> output unchanged).
715      - change default (set to 2) to use new method and update few output_adm.txt
716        with accurate ad-monitor (global_ocean.90x40x15, tutorial_global_oce_biogeo
717        and both tutorial_tracer_adjsens tests).
718      - switch 2 global_ocean.cs32x15 AD-tests to AB-2 (seaice_dynmix & thsice)
719        and turn off momDissip_In_AB in the 2 other (needed for stable AB-3).
720    o pkg/ctrl:
721      enable the use of a variable number (maxCtrlArr2D, maxCtrlArr3D) of
722      generic control variables via
723      #define ALLOW_GENARR2D_CONTROL and/or #define ALLOW_GENARR3D_CONTROL
724      Only required customization should be S/R ctrl_map_ini_genarr.F
725      (routine in repository contains example)
726    o pkg/exf:
727      - fix and refine checking of surface-relaxation setting when using EXF
728    o verification (adjoint exp):
729      - reduce length of simulation by half for experiment global_ocean.cs32x15
730        (std, seaice & seaice_dynmix) and exp tutorial_dic_adjoffline; update output.
731    o pkg/mom_common (mom_u/v_bottomdrag), pkg/shelfice (shelfice_u/v_drag)
732      - replace if statements KE.ne.0 with KE.gt.0 to avoid sqrt of negative numbers
733        of KE that can occur with aggressive optimization
734      + put quadratic bottom drag calculation in separated loops (only done if
735        using bottomDragQuadratic)
736    o model/src: CG2D_NSA
737      - clean-up:  stop if cg2dNormaliseRHS=T and AUTODIFF
738         and replace GLOBAL_SUM calls with GLOBAL_SUM_TILE.
739      - in test-exp that uses CG2D_NSA (bottom_ctrl & tutorial_tracer_adjsens),
740         change cg2d residual target to be expressed in Wunits (=> do not normalise
741         RHS ; this fix global_max Pb with TAF); update output.
742    o verification/tutorial_tracer_adjsens:
743       improve parameter consistency (and get rid of warnings):
744       - use deltaTFreeSurf=deltaTtracer (better with NonLin FreeSurf);
745       - switch Temp Adv Scheme from 81 to 80 (no limiter since theta < 0 is physical)
746       - use staggerTimeStep (for stability) in som81; use default rotation period.
747    o pkg/exch2:
748      - with empty facet: fix compact-format (W2_mapIO=1) definition (was previously
749        reset to 0 = 1 long line in X)
750    o pkg/mdsio:
751      - fix reading of dimensions from meta file for large-size domain
752    o model/src:
753      - fix saltIsActiveTr setting for IdealGas eosType (eosType is 6 character long);
754      - to refine CS-grid check, add logical flag "hasWetCSCorners": true if using
755        Cubed-Sphere Exch with CS-corners inside the domain;
756        make new S/R INI_GLOBAL_DOMAIN from code in ini_linear_phisurf.F to calculate
757        globalArea and to set hasWetCSCorners.
758      - add warning if usingCurvilinearGrid and momAdvection in flux-form (missing
759        metric terms); stop if hasWetCSCorners=T and momAdvection in flux-form.
760      - re-activate the stop if useCDscheme and hasWetCSCorners=T (previously if
761        useCDscheme and useCubedSphereExchange).
762    o pkg/seaice/seaice_growth.F :
763      - compute the SEAICE_DISABLE_HEATCONSFIX term accordingly
764        for the (.NOT.useRealFreshWaterFlux).OR.(nonlinFreeSurf.EQ.0)
765        when the previous code was not correct.
766      - in all cases diagnoze the boundary condition mismatch to SIaaflux
767      - in the case of useRealFreshWaterFlux.AND.(nonlinFreeSurf.GT.0) add
768        that term to QNET (essentially to set the melt/freeze water to 0degC).
769        when SEAICEheatConsFix is true, so that the ocean+ice budget heat is closed.
770    o verification/global_ocean.cs32x15/input.seaice :
771      - add SEAICEheatConsFix in data.seaice, ensuring closed ocean+ice heat budget.
772      - add diagnostics (commented out) for budget test using my matlab codes (gcmfaces).
773      - update results (output.seaice.txt) accordingly.
774    o verification/lab_sea/input/data.seaice :
775      - remove SEAICEheatConsFix, which is now be tested
776        in global_ocean.cs32x15. The presently coded fix
777        is only consistent with real fresh water + nlfs.
778      - update results (output.txt) accordingly.
779    o pkg/salt_plume: added diagnotic for salt tendency (oceSPtnd).
780    o AD_CONFIG.h file:
781      - in genmake2: remove "#undef ALLOW_ECCO_OPTIMIZATION" from AD_CONFIG.h;
782      - remove #include "AD_CONFIG.h" from all included OPTIONS files and
783        add it explicitly in each fortran src file where it is needed.
784        motivation: header file AD_CONFIG.h is generated/modified after "make depend"
785        thus introducing potentially wrong dependency; therefore, better to include
786        it only where it's really needed, and after any other included OPTIONS file
787        (less tempting to bring conditional includes according to ALLOW_ADJOINT_RUN
788        or ALLOW_TANGENTLINEAR_RUN).
789    
790    checkpoint63p (2012/07/06)
791    o pkg/autodiff:
792      - rename S/R INI_AUTODIFF to AUTODIFF_INIT_VARIA ;
793      - create new header file "AUTODIFF_PARAMS.h" for pkg/autodiff parameters
794        which are now read from new parameter file "data.autodiff" (inAdExact
795        previously in "data", use{KPP/GMRedi/SEAICE}inAdMode previously in data.pkg)
796      - add file "data.autodiff" in all verification/*/input_ad/ directories.
797      - add run-time parameter to turn On/Off SEAICEuseFREEDRIFT in adjoint/forward
798        mode (used in global_ocean.cs32x15.seaice_dynmix test exp.)
799    o verification/tutorial_tracer_adjsens/
800      - add extra sub-verification which uses "SOM" advection scheme
801        (2nd Order-Moment Advection Scheme, Prather Limiter) with
802          #define GAD_ALLOW_TS_SOM_ADV in GAD_OPTIONS.h
803        and in data:
804          multiDimAdvection=.TRUE.,
805          tempAdvScheme=81,
806          saltAdvScheme=81,
807    o model/src:
808      - introduce ALLOW_BALANCE_RELAX which allow the removal
809       of the global mean of relaxation terms by setting
810       balanceThetaClimRelax and balanceSaltClimRelax
811      - disable balanceEmPmR and balanceQnet in the case when useSeaice.
812       This case is now treated appropriately in seaice_growth.F
813    o pkg/seaice:
814      - do balanceEmPmR and balanceQnet based on the net fluxes
815        (SItflux) that enter the ocean+ice system rather than QNET
816        and EMPMR. Works best in real fresh water.
817      - SIatmFW, SIatmQnet, and SItflux computations had to be moved
818        out of the diagnotics bloc, and stored in global arrays.
819    
820    checkpoint63o (2012/06/29)
821    o vertical mixing schemes:
822      - remove unused S/R CALC_BUOYANCY (left from branch-atmos merging)
823      - replace computation of density (in Function STATE1, opps_calc.F) by a call
824        to S/R FIND_RHO_SCALAR
825      - pass sigmaR to S/R PP81_CALC, MY82_CALC (but not yet used) and to GGL90_CALC
826        and use it for N^2 calculation in ggl90_calc.F (save 2 density computations);
827        affects output (vermix.ggl90) at truncation level.
828    o testreport:
829      - change adjustment of SIZE.h for mpi+mth testing: preserve enough tiles
830        (nSx,nSy) for the number of threads (from eedata.mth)
831    o model/src:
832      - remove 2nd set of calls at the top of initialise_varia.F (Adjoint part)
833        related to Non_Lin Free-Surf or Bottom-Control (but not longer necessary).
834    o verification/tutorial_tracer_adjsens/
835      - compile with ALLOW_CG2D_NSA
836      - run with nonlinFreeSurf=3
837      - update reference output_adm.txt
838    o tools/genmake2:
839      - add "-DHAVE_NETCDF" to the DEFINES list when NetCDF is available ;
840        refine usePROFILES switching off (only when NetCDF is not available).
841    o verification (atmospheric set-up):
842      - change eosType='IDEALGAS' to eosType='IDEALG' to match variable declaration
843    o pkg/profiles : refine profiles and files handling.
844    o model/src and pkg/ecco : introduce run-time switch usePROFILES.
845    o model/src/the_main_loop.F, forward_step.F and pkg/exf/EXF_OPTIONS.h :
846      - changes to use model/src/the_main_loop.F rather than the ecco version
847        in ecco type adjoint runs.
848    o model/src:
849      - move computation of recip of grid distance & area from INI_MASKS_ETC to INI_GRID
850      - move setting of h0Fac[C,W,S] from INI_LINEAR_PHISURF to INI_MASKS_ETC
851      - update_masks_etc.F: rename SMOOTH*_R4,R8 function to the corresponding type (RS,RL)
852    o model/src:
853      - fix S/R UPDATE_CG2D for ALLOW_DEPTH_CONTROL case (was empty before);
854        update output of test experiment bottom_ctrl_5x5.
855    o pkg/generic_advdiff:
856      - implement vertical bi-harmonic diffusion (for now, only for T & S and
857        only explicitly).
858    o verification/bottom_ctrl_5x5/
859      update reference output (results changed quite some time ago,
860      not sure when; but new reference results look ok in terms of grdchk)
861    o verification/1D_ocean_ice_column/
862      For verification purposes, the exact adjoint rather than an approx.
863      should be used (e.g., to comare against F.D. or TLM).
864      removed autodiff_inadmode*_ad.F routines in code_ad/
865      Update results/ accordingly.
866    o pkg/cal:
867      - change cal_getdate.F so that output date is function of input time only
868        (less ambiguous, not mixed up with input iteration number).
869      - fix calendarDumps for non-zero phase-lag (S/R CAL_TIME2DUMP).
870    o pkg/diagnostics:
871      - implement calendarDumps also for stats-diags
872      - implement calendarDumps also for snap-shot output (negative freq)
873      - for now, ignores calendarDumps if non-zero phase-lag.
874    
875    checkpoint63n (2012/06/04)
876    o model/src:
877      - recompute rSurfW & S to ensure consistent column thickness (needed for rStar)
878        between Sum_k(hFac*drF) and rSurf-rLow, for now only when using pkg/shelfice;
879      - use h0FacC, W & S to compute hFac_surfC, W & S in calc_surf_dr.F (more
880        similar to calc_r_star.F); update results of experiment internal_wave and
881        tutorial_global_oce_in_p (affected @ truncation level).
882    o pkg/shelfice:
883      - add parameterisation of advective-diffusive flux into the ice shelf
884        according to Holland and Jenkins (1999), eq.22-33, as suggested by Jan De Ryd
885      - simply eps3/3a computation
886    o eesupp:
887     - add new CPP option (DISCONNECTED_TILES) to disconnect tiles (no exchange
888       between tiles, just fill-in edges assuming locally periodic subdomain) and
889       add corresponding exchange subroutines (EXCH0);
890     - new CG-solver version (_EX0) for disconnected-tiles special case.
891    o model/src (CG-solvers):
892     - modify Single-Reduction version (CG2D_SR) in case cg2dMaxIters is reached
893       (similar final residual output and max-Iter number as with standard version);
894     - allows to store and use lowest-residual solution (standard & _SR versions);
895     - cleaning up (remove old, commented out code, LETS_MAKE_JAM ...).
896     - by default, also compile CG2D_SR version (define ALLOW_SRCG in CPP_OPTIONS.h)
897    o eesup/src:
898     - global_vec_sum.F cleaning: add a BARRIER ; update comments ; remove ndef
899       ALWAYS_USE_MPI (no longer needed after fixing usingMPI settings - March 2012)
900    o pkg/salt_plume added to lab_sea/input_ad.noseaicedyn
901    
902    checkpoint63m (2012/04/27)
903    o pkg/shelfice:
904     - account for partical cells in surface level below ice-shelf for hydrostatic
905       pressure calculion (set uniformFreeSurfLev to F); update isomip experiments.
906    o ad test experiments:
907     - update and rename to "ad_optfile.local" local AD-optfile specific to a
908       particular adjoint verification experiment (in verification/*/code_ad/)
909    o pkg/seaice & pkg/exf:
910     - Part two of ECCO-CLIVAR code merges.
911       Completes merge of seaice area relax. code.
912       Requires unified CPP option EXF_ALLOW_SEAICE_RELAX
913       to be set in EXF_OPTIONS.h since this pkg controls its I/O
914       (and avoids second CPP option in SEAICE_OPTIONS.h)
915     - change default value of costIceStart & costIceEnd to a valid date.
916     - add snowPrecip to HSNOW in seaice_growth
917    o pkg/ptracers:
918     - move ptracers summary and setup check into separated S/R ; add a check for
919       valid PTRACERS_Iter0 value (error+stop or just warning).
920    o pkg/cal (+ pkg/ecco):
921     - avoid calling a S/R with 2 times the same arg (FWD: unless both are only used
922       as input; and for AD, unless both are not differentiable (e.g., k index)).
923    o model/src:
924     - define internal flag "uniformFreeSurfLev" (=T when free-surface level-index
925       is everywhere k=1) to speed-up some calculations (by pass kSurf reference);
926       temporary set to usingZCoords value (to be changed to F when using shelfice).
927     - hydrostatic pressure: implement partial cell near the surface also for
928       Z-coordinates (for the case where uniformFreeSurfLev=F); replace test on
929       usingZCoords with test on uniformFreeSurfLev where needed (in NonHyd code).
930    o pkg/ctrl/ctrl_init.F:
931     - add a formal parameter to s/r ctrl_init_rec to print
932       xx_$(ctrl_valiable)_file for easier debugging
933     - move call of cal_* routines into the if-block where they are really
934       needed so that xx_$(ctrl_variable)_period can be 0 or -12 without having
935       to specify a startdate
936    o pkg/seaice:
937     - update comments in SEAICE_OPTIONS.h (+ similar update of lab_sea/code and
938       global_ocean.cs32x15/code versions).
939     - turn on seaice Multi-category (in data.seaice, SEAICE_multDim=7) for
940       verification experiment global_ocean.cs32x15.seaice and update results.
941    o pkg/exf:
942     - new S/R EXF_GETFIELD_START to return starting-time of a forcing field
943       (according to useExfYearlyFields).
944    o pkg/cal:
945     - move calendar setting & summary (previously in cal_readparams.F) into new
946       S/R CAL_INIT_FIXED to be called later in the initialisation process, once
947       length of the simulation is set (after SET_PARMS call); This is an attempt
948       to fix Pb when, e.g.: pkg/longstep, modifies the length of the run.
949     - For safety: keep a record of pkg/cal parameter settings status
950               to allow to STOP if one pkg/cal S/R is called too early.
951     - add a stop in all basic pkg/cal subroutines if called before setting is done.
952     - modify cal_getdate.F: stop when nothing was returned;
953       if called with myIter=-1, simply retrun modelBaseDate (1,2 = startDate_1,_2);
954       this allows to remove "cal.h" from seaice_read_parms.F & init_mnc_vars.F.
955    
956    checkpoint63l (2012/04/04)
957    o pkg/bbl:
958      - fix call to FIND_RHO_2D in bbl_calc_rho.F (case multi-tiles per proc);
959        update global_with_exf output.yearly.txt file.
960    o pkg/cal:
961      - start to clean-up cal_set.F ; fix for the case where baseTime is non-zero.
962      - remove 2 unsused and very short (1 line only) functions ;
963      - remove unsused subroutines from AD-Diff list.
964    o model/src:
965      - start to implement clean wait to stop in initialization S/R (config_check.F,
966         packages_check.F, ini_parms.F and pkg/obcs/obcs_check.F + pkg/mypackage)
967    o folowing PRINT_MESSAGE changes:
968      - remove reminder multiple print to the same file (STDOUT) when multi-threads.
969    o pkg/bbl:
970      - modification so it can work with z*
971      - replace deltaT with dTtracerLev(k) for asynchronous time stepping
972      - global_with_exf/input.yearly verification; changes output.yearly.txt
973    o eesupp/src:
974      - PRINT_MESSAGE: use OpenMP critical instruction (similar to PRINT_ERROR);
975        writing to unit 0 (if unit=errorMessageUnit) extended to the case myThid=1
976      - CHECK_THREADS: specific code if using OpenMP threading: improve checking of
977        # of threads across processors (e.g., different env OMP_NUM_THREADS setting)
978      - improve special preliminary call to EESET_PARMS (if eedata is read 2 times).
979      - when using MPI, always set usingMPI=T ; set default accordingly and stop
980        if not consistent.
981      - ALL_PROC_DIE: add a BARRIER after MPI_FINALIZE call ; skip this when thread
982        argument is zero (in case called within single-thread section).
983    o pkg/fizhi:
984        clean-up turbulence cold-start switch: decided in fizhi_init_vars.F, stored
985        in common bloc (fizhi_coms.h) and then passed as argument up to S/R TURBIO.
986    o pkg/exch2:
987      - add argument "updateCorners" to S/R exch2_get_uv_bounds (enable to
988        activate EXCH_IGNORE_CORNERS in vector EXCH S/R).
989      - switch 1rst EXCH call to IGNORE_CORNERS (instead of UPDATE_CORNERS)
990        but keep the 2nd with UPDATE_CORNERS: this prevents overwriting good data
991        with bad ones coming from a not-yet-updated halo.
992        This should fix the problem when sNx <> sNy and GCD(sNx,sNy) < 2*Olx.
993    o pkg/frazil:
994        move FrzForcT diag from frazil_diagnostics_state.F to frazil_calc_rhs.F
995        http://mitgcm.org/pipermail/mitgcm-devel/2012-March/005384.html
996    o model/src/config_check.F: add a check for OLx>sNx/OLy>sNy
997    o verification/lab_sea
998      * #undef SEAICE_EXCLUDE_FOR_EXACT_AD_TESTING
999      * #define ALLOW_SST_CONTROL & ALLOW_SST_CONTROL
1000      * nTimeSteps 3 -> 4
1001      * changed reference output accordingly
1002    o pkg/ctrl:
1003      * fix ctrl_get_gen for xx_sst, xx_sss
1004    o pkg/fizhi:
1005      - fix 2 calls to S/R GRD2MSC (argument igrd) in update_earth_exports.F
1006        update results of exp. fizhi-cs-32x32x40 (fail with only 6 digits for cg2d)
1007      - by default, use new version of S/R GETPWHERE (#define TRY_NEW_GETPWHERE);
1008        fix few out-of-bounds indices in referencing vars (initialise igrd to 1);
1009        clean-up fizhi_turb.F (remove unused & uninitialised qdiaglsm array).
1010    o pkg/gmredi:
1011      - add diagnostic of Redi (main diagnonal) vertical diffusive flux of Temp
1012    o pkg/fizhi:
1013      - fix few initialisation and multi-tile Pb: aqualev & gridalt now pass the
1014        (old)aces open64 tuv test.
1015    o pkg/icefront: fix bug and reorder loop in icefront_init_varia.F
1016    o pkg/mom_vecinv:
1017      - fix 1 loop range in mom_vecinv.F to be like all the other loops which
1018        set/update gu,gv/Diss (fix Pb of uninitialised fVerUkp in admom_vecinv
1019        with non-lin free-surf).
1020    o model/src: move k-loop outside of i/j-loops when (re-)computing R_low
1021      in ini/update_masks_etc.F in order to avoid -O3 optimization problems with
1022      some compilers (gfortran 4.6.0 on MacOS)
1023    o momentum:
1024      - separate fVer?(:,:,kUp) & fVer?(:,:,kDown) in argument list of MOM_FLUXFORM
1025        & MOM_VECINV subroutines (to help TAF). This fixes Pb of uninitialised
1026        fVer?(kUp) in admom_fluxform with non-lin free-surf or bottom control.
1027    
1028    checkpoint63k (2012/03/17)
1029    o model/src:
1030       - selectAddFluid (ALLOW_ADDFLUID): add missing term in horizontal momentum
1031         flux-form (mom_fluxform.F) and vertical momentum (calc_gw.F) equations.
1032       - SOLVE_DIAGONAL: switch default to use adjoinable & vectorized version
1033         (#undef SOLVE_DIAGONAL_LOWMEMORY); update output of exp. front_relax.bvp.
1034    o model/src: solve_*diagonal.F
1035       - replace division with multiplication by inverse (similar to original version)
1036         update output of AD exp. global_ocean.90x40x15.
1037       - fix pkg/gmredi/gmredi_calc_psi_bvp.F & pkg/ggl90/ggl90_calc.F
1038         to enable the use of the vectorized & differentiable solve_tridiagonal.F
1039       - test exp. global_ocean.90x40x15/input_ad: switch to advection scheme 20 for
1040         vertical advection (to get solve_tridiagonal tested in AD mode).
1041    o pkg/seaice: ECCO-CLIVAR merge:
1042      1. seaice AREA relaxation
1043         * CPP option: SEAICE_ALLOW_AREA_RELAXATION
1044         * runtime flag: SEAICE_tauAreaObsRelax
1045      2. modified global mean cost imbalance code: CPP option
1046          ALLOW_SSH_GLOBMEAN_COST_CONTRIBUTION
1047    o another iteration on solve_*diagonal.F
1048       Make choices independent of AUTODIFF
1049       Default will be the adjoinable vectorized version.
1050       Alternative choices are:
1051       * non-adjoinable original version with low memory footprint:
1052         #define SOLVE_DIAGONAL_LOWMEMORY
1053       * still adjoinable but does not vectorize (k as inner-most loop):
1054         #define SOLVE_DIAGONAL_KINNER (keeping SOLVE_DIAGONAL_LOWMEMORY undef)
1055    o testreport
1056     - add option to use a home made wrapper around "make"
1057     - remove MITGCM_IEEE env. variable (no longer active)
1058    o pkg/shelfice
1059     - improve computation of friction velocity for velocity dependent
1060       exchange coefficients: include velocities into SHELFICEBoundaryLayer
1061       block to average velocities vertically
1062     - add TAF store directives for SHI_ALLOW_GAMMAFRICT
1063    o Modify diagonal solvers, now three versions (upon request):
1064      #ifndef SOLVE_DIAGONAL_AUTODIFF
1065        1. default version (dating back a while ago)
1066      #else /* def SOLVE_DIAGONAL_AUTODIFF */
1067      # ifdef SOLVE_DIAGONAL_KINNER
1068        2. adjoinable version with k-innermost loop (G. Forget)
1069      # else
1070        3. adjoinable vectorized version of 2.
1071      # endif
1072      #endif /* SOLVE_DIAGONAL_AUTODIFF */
1073      All flags are currently set within routines, but could/should be moved to CPP-options.
1074      Array bounds for 1. are as before, for 2.,3. cover the entire domain
1075      (could be changed for 1. too).
1076    o verification/lab_sea (fwd):
1077      - update the 4 fwd lab_sea test experiment: no longer SEAICE_GROWTH_LEGACY,
1078        use 7 categories (except hb87), new solve4temp params (except salt_plume),
1079        constant salinity (=4) or variable salinity (salt_plume) done through
1080        SItracer.
1081    o pkg/seaice:
1082      - rename parameters: SIsalFrac to SEAICE_saltFrac & SIsal0 to SEAICE_salt0;
1083      - remove old parameters ( SEAICE_freeze, SEAICEturbFluxFormula, SEAICE_gamma_t,
1084         SEAICE_gamma_t_frz, SEAICE_availHeatTaper & SEAICE_availHeatFracFrz)
1085        from SEAICE_PARMS.h ; still need to fix seaice_cost_sst.F (broken when
1086        SEAICE_freeze got retired) but already better than previously with
1087        SEAICE_freeze=123456.7 deg.C;
1088      - move setting of facOpenGrow/Melt from SEAICE_INIT_FIXED to SEAICE_READPARMS
1089        (safer multi-threaded setting); always set SEAICEuseEVP;
1090      - setting of ocean-ice turb. flux coeff: moved from SEAICE_CHECK to
1091        SEAICE_READPARMS & SEAICE_INIT_FIXED (this fixes wrong summary report);
1092        stop if multiple specifications for the same coeff; make sure default
1093        SEAICE_mcPheePiston is compatible with drF(1) & deltaT.
1094    o pkg/obcs:
1095      - allow to switch to upwind 1rst order advection scheme for the advective
1096        flux computation at the open-boundary; disabled for adjoint built.
1097    o pkg/ptracers:
1098      - rename PTRACERS_RESTART.h -> PTRACERS_START.h
1099      - rename ptracers_fields_blocking_exchanges.F -> ptracers_fields_blocking_exch.F
1100      - add parameter to decide when to start a tracer; use internal flag to
1101        know which tracer to step-forward; switch this internal flag at the top
1102        of forward_step.F (new S/R PTRACERS_SWITCH_ONOFF); for now, not enabled
1103        for adjoint built.
1104    o pkg/seaice:
1105      - add SEAICE_SIZE.h anywhere in the code where SEAICE.h is included ;
1106      - move MULTDIM declaration and setting from SEAICE.h to SEAICE_SIZE.h ;
1107      - keep experiment offline_exf_seaice truly single category (set MULTDIM=1).
1108    o pkg/ecco:
1109      - fix writing of output file DiagnosCost_ClimSalt/Theta
1110        and DiagnosCost_DriftSalt/Theta (if multi-tiles per proc).
1111    o pkg/seaice:
1112      - add missing initialisation of COR_ICE array in dynsolver.F
1113      - merging SEAICE_MULTICATEGORY define and undef cases. Now the same code is
1114        compiled either way, and is tested in all exps (multidim was only tested
1115        in lab_sea ad before).
1116      - cosmetic change to prepare for future addition of ITD. no change to results.
1117        no defaults change.
1118      - added run time param SEAICE_multDim (7 for SEAICE_MULTICATEGORY, 1 otherwise).
1119      - by lack of adequate verification experiments, I further used custom versions
1120        of global_ocean.cs32x15 to test multicat or not, with pickup or not. All
1121        should be correct.
1122      - avoid recomputations in ad.
1123    o array initialisation in adjoint mode:
1124      1) pkg/mom_common/mom_calc_ke.F:
1125        add full array initialisation of KE inside mom_calc_ke.F (ALLOW_AUTODIFF_TAMC):
1126        The S/R which calls MOM_CALC_KE initialises KE but in some recomputation
1127        part this initialisation is gone, resulting in Floating Point Exception
1128        (caught by open64 compiler with debug option).
1129      2) model/src/convective_weights.F
1130        set output convectCount over the full array range (instead of doing
1131        an update): this fix a similar issue when called within recomputation (adjoint)
1132        which could by-pass the initialisation (normally done in the caller S/R).
1133    o pkg/seaice:
1134      - final version of turbulent flux params, as agreed at MIT ice meet:
1135           SEAICE_mcPheePiston (default is ~ 0.000875)
1136           SEAICE_mcPheeTaper (default is 0.)
1137           SEAICE_frazilFrac (defualt is 1.)
1138           SEAICE_mcPheeStepFunc (default is false)
1139      - changes results at trunction error level
1140      - ifdef SEAICE_EXTERNAL_FLUXES, disallow SEAICE_waterAlbedo
1141    o added pkg/frazil:
1142      - see frazil_description.tex for details
1143      - verification experiment is global_with_exf/input.yearly; changes output.yearly.txt
1144    o pkg/shelfice/shelfice_thermodynamics.F
1145      - fix exponents for velocity dependent exchange coefficients: change
1146        from 2/3(=0) to 0.66666666666666667
1147      - move computation of velocity dependent exchange coefficients into
1148        separate loop, so that it applies to both thermodynamics
1149      - move some divisions by constants out of loops
1150    
1151    checkpoint63j (2012/02/16)
1152    o pkg/seaice:
1153      - overhaul of seaice_summary.F after feb 2012 clean-up of seaice_growth.F etc.
1154      - SItracer:  added run time params, and allow coupling to ocn salinity.
1155    o pkg/seaice: remove (almost) all divisions by constants within loops
1156      in seaice_growth.F and seaice_solve4temp.F, this changes (only) the cg2d
1157      results of global_ocean.cs32x15.seaice from 16 to 11 digits (but only
1158      those, caused by 1/QI -> recip_QI) -> update output.seaice.txt,
1159      output_adm.seaice_dynmix.txt and also lab_sea: output_adm.evp.txt
1160    o pkg/seaice :
1161      - simplify McPhee tapering, and allow to use it with SEAICEturbFluxFormula
1162        = 1 or 2, using newly added run time parameter SEAICE_availHeatTaper.
1163      - fix d_AREAbyATM, d_AREAbyOCN, d_AREAbyICE diags I broke in r1.148.
1164      - add permanent SItflux diag that corresponds to TFLUX but includes
1165        ice+snow. Hence SItflux-TFLUX should match the ice+snow heat budget.
1166      - allow activation/testing of a fix for suspected missing term in
1167        ocn-ice heat budget (to be confirmed). To test this, you want to
1168        undef SEAICE_DISABLE_HEATCONSFIX, and then set the run time param
1169        SEAICEheatConsFix to .TRUE. that also allows the 'SIaaflux' diagnostic.
1170      - no change in results, fwd or ad.
1171    o global_ocean.cs32x15/results: 3 changes following from the pkg/seaice commit below:
1172      - switch to variable freezing point.
1173           Results change : cg2d -> 1 digits; ad -> 3-6-6 digits.
1174      - bug fix : the sublimation term that was missing is now activated.
1175           Results change : cg2d -> 2 digits; ad -> 8-6-6 digits.
1176      - bug fix : flooding sign term for SIsal0.NE.0.
1177           Result change : cg2d -> 8 digits; ad -> 11-12-9 digits.
1178    o pkg/seaice:
1179      - unified freezing point treatment : the old SEAICE_VARIABLE_FREEZING_POINT
1180        is now the default, and the old default constant freezing point is recovered
1181        with SEAICE_tempFrz0    = -1.96,
1182             SEAICE_dTempFrz_dS = 0.,
1183      - retire SEAICE_freeze (= the old way of specifycing the constant freezing point)
1184      - remove ALLOW_SEAICE_FLOODING brackets; run time switch is already there.
1185      - bug fix (thanks to M. Losch) : the sublimation term that was missing is now
1186        activated. To reproduce old results with this bug define SEAICE_DISABLE_SUBLIM.
1187      - bug fix (silly me) : flooding sign term (seaice_growth.F r 1.149line 1211)
1188        was wrong for SIsal0.NE.0. Changes cs32x15 results (see above item for detail).
1189      - bug fix (thanks to O. Jahn) : area loss for melting  got messed up in
1190        seaice_growth r149 for legacy branch (no results change).
1191      - introduce SEAICE_CAP_SUBLIM : caps sublimation heat flux in solve4temp (code
1192        from I. Fenty).
1193      - results did not change except for global_ocean.cs32x15, mostly due to the
1194        switch to variable freezing point (see above item for detail).
1195    o pkg/thsice:
1196      - fix and simplify interface to salt_plume pkg ; diagnose directly amount of
1197        seawater freezing in thsice_calc_thickn (not used).
1198    o pkg/seaice: turbulent flux term specification via run time params.
1199      - replace CPP switches with run time switches to facilitate testing
1200      - retired CPPs : MCPHEE_OCEAN_ICE_HEAT_FLUX,
1201                       GRADIENT_MIXED_LAYER_TURBULENCE_FACTOR
1202      - added runtime parameter : SEAICEturbFluxFormula
1203      - move Mcphee constants to SEAICE_PARAMS.h
1204      - seaice_readparms.F : read turbulent flux term params (SEAICEturbFluxFormula;
1205                 SEAICE_availHeatFrac/Frz, or SEAICE_gamma_t/_frz if apply);
1206                 remove seaice_summary call (moved to seaice_init_fixed)
1207      - seaice_init_fixed.F : set SEAICE_availHeatFrac/Frz depending on
1208        SEAICEturbFluxFormula, and seaice_summary call (moved from seaice_readparms)
1209      - seaice_summary.F : add missing report of read turbulent flux term set up
1210                           and SITRACER.
1211      - seaice_check.F : check range; inform and stop if retired CPPs are used
1212                         (incl. SEAICE_AGE).
1213      - seaice_growth.F : unified use of SEAICE_availHeatFrac/Frz, without
1214             CPP switch, same computation as before for the different options.
1215      - change results at the truncation level.
1216    o pkg/seaice:
1217      - remove un-used parameters LAD & MAX_TICE ; add new run-time parameters:
1218        useMaykutSatVapPoly (default=F), postSolvTempIter (default=2) and
1219        SEAICE_wetAlbTemp (default=-1e-3). Remove option SEAICE_SOLVE4TEMP_LEGACY.
1220      - update verification/*/input*/data.seaice:
1221        to reproduce previous results with former #defined SEAICE_SOLVE4TEMP_LEGACY
1222        code, set useMaykutSatVapPoly=T & postSolvTempIter=0 ;
1223        and to reproduce previous results with former non-SOLVE4TEMP_LEGACY code,
1224        set SEAICE_wetAlbTemp=0 & SEAICE_snowThick=0.
1225    o pkg/seaice/seaice_solve4temp.F (SOLVE4TEMP_LEGACY):
1226      - remove LEGACY code for solving for tsurf (A1,A2,A3) but maintain the same
1227        algorithm (same choice: useMaykutPolySatVap=T, postSolvTempIter=0);
1228        difference in results only due to machine truncation.
1229      - remove MAX_TICE (tsurf is always =< TMELT anyway); keep MIN_TICE if using
1230        MaykutPolySatVap; keep MIN_LWDOWN.
1231      - adapt SEAICE_MODIFY_GROWTH_ADJ code (untested) to non-legacy formulation.
1232      - update output of verification exp. lab_sea (4 fwd: 11 cg2d digits except hb87,
1233        + 3 AD: 6 digits except evp) and offline_exf_seaice.seaice (12 digits).
1234    o pkg/salt_plume:
1235      - isolate saltPlumeFlux array exch into a specific S/R called from
1236        do_oceanic_phys.F
1237      - add interface to pkg/salt_plume (filling of saltPlumeFlux) in pkg/thsice.
1238    o verification:
1239      - move untested set-up to MITgcm_contrib/verification_other.
1240    o pkg/seaice:
1241      - retire old way of SEAICE_AGE. Now replaced with ALLOW_SITRACER.
1242    o pkg/seaice:
1243      - seaice_solve4temp.F (keeping results unchanged):
1244        * add 2 future run-time params to select which saturation vapor pressure
1245          formula is used and how post-iteration fluxes are set.
1246          Temporary set these 2 params according to option SOLVE4TEMP_LEGACY;
1247        * New piece of code (not used) to update surf. atmos. heat flux F_ia using
1248          the linearized expression to stay consistent with tsurf finding.
1249      - seaice_freedrift.F avoid floating exception in sqrt(y) since y=sqrt(x*x)-x
1250        can be < 0.
1251    o pkg/seaice/seaice_solve4temp.F (SOLVE4TEMP_LEGACY undef):
1252      - remove from F_ia (and from it's derivative dFiDTs1) the contribution of
1253        conductive heat flux F_c , and add it explicitly when updating tsurf as
1254        solution of: Fc = Fia + d/dT(Fia - Fc) *delta.tsurf
1255        so that now F_ia has a consistent meaning through the entire routine.
1256        This causes differences at truncation level: update output of fwd exp.
1257        global_ocean.cs32x15.seaice.
1258    o pkg/seaice:
1259      - lots of editing/cleaning in seaice_solve4temp.F + better documentation
1260        of arrays, sign/direction of fluxes; no effect on results.
1261      - replace hard coded 273.16 (=previous value of celsius2K) by celsius2K
1262        in seaice_budget_ocean.F & seaice_solve4temp.F (SOLVE4TEMP_LEGACY part);
1263        note: this should have been done before changing celsius2K default.
1264      - to keep results unchanged, add back old value of celsius2K in verification
1265        exp. input*/data : lab_sea (AD), offline_exf_seaice (fwd+AD) & seaice_obcs
1266      - replace hard coded seawater freezing temp in seaice_solve4temp.F (part
1267        SOLVE4TEMP_LEGACY) of 271.20 (=previous value of celsius2K + default
1268        value of SEAICE_freeze) by celsius2K+SEAICE_freeze so that seawater
1269        freezing temp is consistent with value in seaice_growth.F ; this causes
1270        differences at machine truncation level: update lab_sea AD output (3/4).
1271    o pkg/seaice:
1272      - mask (in exf_init_fixed.F) atemp,aqh,evap,precip,runoff,lwflx,areamask
1273        and climsst/sss even when using seaice (to prevent calculation that might
1274        use SST on land); does not affect any verification exp.
1275      - apply mask to taux,tauy (in seaice_get_dynforcing.F); update output
1276        of lab_sea.fd & lab_sea.hb87 and global_ocean.cs32x15.seaice_dynmix.
1277    o pkg/seaice/seaice_growth.F: add mask to avoid non-zero ice thickness
1278      over land (non-legacy code)
1279    o vectorize salt_plume package:
1280      - add extra code to salt_plume_frac and salt_plume_tendency_apply_s
1281      - this code computes plumebk everywhere (also over land), thus requires
1282        code to avoid divisions by zero and catch the case of kLev=Nr.
1283      - efficiency of salt_plume_frac is still sub-optimal
1284    o tools (genmake2):
1285      - fix makefile NAME specification (option: -makefile NAME) by adding
1286        "-f $MAKEFILE" in few places where it was missing including makedepend
1287        command (contribution from Paul).
1288    
1289    checkpoint63i (2012/01/24)
1290    o model/src:
1291      - add factorized versions of some EOS code to find_rho.F,
1292        define USE_FACTORIZED_EOS to turn it on (default for TARGET_NEC_SX)
1293    o model/src:
1294      - add celsius2K to namelist PARM01; remove unused recip_rhoNil from PARAMS.h;
1295      - change default celsius2K from 273.16 to 273.15
1296      - to keep results unchanged, add back old value of celsius2K in verification
1297        exp. input*/data : aim.5l_cs, 1D_ocean_ice_column, lab_sea (fwd),
1298         global_ocean.cs32x15(seaice) & cpl_aim+ocn(input_atm).
1299    o model/src: add a little initialisation trick to find_rho.F and find_alpha.F
1300      to make TAF generate vectorizable code
1301    o pkg/seaice/seaice_evp.F: add code (copied from CICE) that avoids underflows.
1302       Turn on by defining SEAICE_EVP_ELIMINATE_UNDERFLOWS. Most compilers
1303       have flags that do this more efficiently.
1304    o pkg/diagnostics/diagstats_calc.F
1305      - for TARGET_NEC_SX fix the treatment of the scaling factor tmpFac=scaleFact
1306    o pkg/obcs (with exch2):
1307      - derive OB indices in overlap region from OB-InsideMask (in obcs_init_fixed.F)
1308        and remove code (in obcs_readparms.F) which was based on EXCH of indices
1309        (through buffer) and did not account for exch2 (e.g., CS-grid) topology.
1310    o pkg/exf and seaice exp:
1311      - change offline_exf_seaice.seaicetd test exp. to use default DIFF1 value (=0)
1312        so that switching off area & heff advection flags does not affect results.
1313      - change default EXF_LWDOWN_WITH_EMISSIVITY to #define in EXF_OPTIONS.h
1314      - keep exp. seaice_obcs & 1D_ocean_ice_column(ad) unchanged (using #undef
1315        EXF_LWDOWN_WITH_EMISSIVITY) and, using pkg/exf default emissivities, update
1316        results of verification experiments: 1D_ocean_ice_column(fwd),
1317        global_ocean.cs32x15.seaice(fwd+ad) & seaice_dynmix(ad), lab_sea (all 8)
1318        and offline_exf_seaice (all 4).
1319    o pkg/seaice:
1320      - remove array YNEG, RIVER, TMIX (replaced by local var) from common block;
1321        remove also areaNm1 & hEffNm1 when SEAICE_GROWTH_LEGACY is undef.
1322      - fix bug: areaNm1 & hEffNm1 are needed in seaice_growth (SEAICE_GROWTH_LEGACY)
1323        but were not filled when resp. SEAICEadvArea=F & SEAICEadvHeff=F and
1324        not multi-dim advection;
1325      - fix seaice_growth.F to compile with both SEAICE_GROWTH_LEGACY and
1326        SHORTWAVE_HEATING #undef.
1327    o optim: make Makefile more robust (?)
1328    o pkg/obcs:
1329      * fix treatment of obcs_read_pickup for TAF
1330    o pkg/shelfice:
1331      * add missing initialisation of num_shifwflx
1332      * new adjoint verification exp. for isomip
1333      * change Prandtl and Schmidt numbers from generic formulations
1334        (in terms of model diffus. and visc.) to separate runtime
1335        parameters, with Holland and Jenkins (1999) default values.
1336    o pkg/exf (interpolation):
1337      - extended input field (2 rows) near the N & S poles:
1338        * fill in with the symetric value (when even Nb of data in longitude)
1339        * add average value at the poles only for scalar quantities ; for vector
1340          component interpolation, skip the averaging and keep duplicated values,
1341          unless the 2 components have same location (uvInterp=T) in which case
1342          interpolate the 2 components together using S/R EXF_INTERP_UV.
1343      - new S/R EXF_INTERP_UV to interpolate the 2 components of a vector field
1344        together: this allows to account properly for local orientation when
1345        averaging at N & S pole.
1346      - add CPP option EXF_USE_OLD_INTERP_POLE to recover old results regarding
1347        exf-interpolation near N & S poles. Undef by default.
1348      - add debug check/print on 1rst iter if debugLevel >=2.
1349    o pkg/exf:
1350      - change masking flags definition (no longer "parameter"), put them in
1351        common block and set them in S/R EXF_INIT_FIXED.
1352      - change recognized masking flag from s,u,v to c,w,s since the mask
1353        to use (maskC,W,S) depends on position on model grid and has little to
1354        do with scalar/vector difference; fix masking if using P-coordinates.
1355      - fix masking of wind-stress (was wrong if interpolated or read on A-grid)
1356        and update results of exp. global_with_exf (x2).
1357      - fix setting of zenith-angle table when SHORTWAVE_HEATING is undef.
1358    o pkg/obcs
1359      - S/R obcs_calc_stevens: fix a small bug (gammat -> gammas where appropriate)
1360    o pkg/exf (interpolation):
1361      - assume periodicity in X only if input field cover full longitude range.
1362      - improve search for lat. index (supposed to be faster, in ~log2(ny) steps,
1363        and should vectorise).
1364      - fix input lat of the 2 added row (in case we provide N.pole data).
1365    
1366    checkpoint63h (2011/12/30)
1367    o pkg/seaice:
1368      - change declaration of UVM from _RL to _RS in order to get B-grid
1369        uIce,vIce monitor when _RS = real*4
1370    o pkg/offline:
1371      - new S/R OFFLINE_RESET_PARMS for resetting main-model params (switch off flags);
1372      - compute vertical velocity if not read from file (switch on exactConserv
1373        & staggerTimeStep);
1374      - fix output of ptracer monitor iter & time for default PTRACERS_monitorFreq.
1375    o verification:
1376      - update grid-files (in tutorial_held_suarez_cs/input and fizhi-cs-32x32x40/input)
1377        with grid-angle generated using "utils/matlab/cs_grid/cubeCalcAngle.m":
1378        fix Pb in yG definition @ 2 missing corners (previously yG was averaged);
1379      - update output of exp. global_ocean.cs32x15.viscA4 after changing
1380        grid-file angles (used here for coriolis-3d);
1381      - remove (or gzip) few files not needed to run fizhi-cs experiments.
1382    o pkg/exf (vector interpolation):
1383      - rotate vector component toward local grid-axis orientation using grid-angles
1384        (stored in GRID.h) instead of locally computed rotation angle; keep old code
1385        available with exf option EXF_USE_OLD_VEC_ROTATION (undef by default).
1386    o pkg/seaice:
1387      - allow to compile with exf options ALLOW_ATM_TEMP or ALLOW_DOWNWARD_RADIATION
1388        undefined. Fix and remove the stop when ALLOW_RUNOFF is undefined.
1389    o pkg/PKG_OPTIONS.h files:
1390      - move #include "CPP_OPTIONS.h" just after #include "PACKAGES_CONFIG.h",
1391        outside of the #ifdef ALLOW_THISPKG / #endif block.
1392      - update verification/*/code/PKG_OPTIONS.h files.
1393    o add a verification experiment (offline_exf_seaice/input.seaice) that test
1394      the B-grid LSOR solver
1395    o pkg/seaice: sort out emissivity and long wave radiation step 2:
1396      - add emissivity for snow and ice as new run-time parameters
1397        (unfortunately) that default to the corresponding exf values; this
1398        changes results in most verification experiments so that for backward
1399        compatibility these parameter have to be set explicitly to inconsistent
1400        values (ugly);
1401      - the exf-flag EXF_LWDOWN_WITH_EMISSIVITY then gets rid off the hard-wired
1402        emissivities of 0.97 associated with lwdownloc in S/R seaice_solve4temp
1403        until we agree how to handle this bug properly
1404    o pkg/exf (interpolation):
1405      - add a set of run-time param ({inputfield}_interpMethod), one for
1406        each interpolated input field, to select the interpolation method
1407        with a value of zero switching off the interpolation;
1408      - print interpolation parameters to standard output;
1409      - refine exf_check.F accordingly ; stop if USE_NO_INTERP_RUNOFF is defined
1410        (to use instead runoff_interpMethod=0 in data.exf).
1411      - simplify default setting of interpolation parameters (for all fields,
1412        set position to match model grid cell-center position, leading to trivial
1413        interpolation in case of regular Lat-Lon grid) and fix for the case of
1414        non-uniform delY.
1415    o pkg/exf/exf_radiation.F: add the factor ocean_emissivity to lwdown, for
1416       within #ifdef EXF_LWDOWN_WITH_EMISSIVITY/#endif. Unless ocean_emissivity=1.
1417       this factor is absolutely required, because the lw exitance (= out-going
1418       long wave radiation) is emissivity*stefanBoltzmann*T^4 + rho*lwdown,
1419       where the reflectivity rho = 1-emissivity for conservation reasons. Once
1420       this is established, we can remove the CPP-Flag (if we want to).
1421    o pkg/seaice:
1422      - qualify a stop statement in S/R seaice_check: EXF_READ_EVAP and
1423        ALLOW_BULKFORMULAE are only required if SEAICE_EXTERNAL_FLUXES is defined
1424      - sort out emissivity and long wave radiation, step 1: make SEAICE_emissivity
1425        what the name implies (and not emissivity*BoltzmannConstant), this means
1426        the old default value of 5.5e-8 now means
1427        5.5e-8/5.670e-8 = 0.97001763668430343479 as ocean_emissivity in
1428        S/R exf_readparms
1429      - FV-discretization of the B-grid LSOR solver, turn on with
1430        SEAICE_LSRBNEW. This new solver also involves a slight re-organization
1431        of the calling routine dynsolver, so that B and C-grid code look a
1432        little more alike.
1433      - fix index bugs in ostres.F (B-grid code)
1434    o pkg/seaice/seaice_ocean_budget.F: change (unused) code to make it look better
1435    o pkg/seaice/seaice_readparms.F: make ocean_emissivity*stefanBoltzmann the
1436      default for SEAICE_emissivity, if useEXF; requires setting a wrong
1437      parameter value in global_ocean.cs32x15/input.seaice/data.seaice for
1438      backward compatiblity
1439    o model/src: use sigmaR in calc_ivdc
1440    
1441    checkpoint63g (2011/12/16)
1442    o pkg/seaice/seaice_growth.F:
1443      fix heat conservation of the coupled ocean-seaice system.
1444      when SEAICE_HEAT_CONSERV_FIX is defined, the mismatch of
1445      solid vs liquid water treatment is resolved via QNET.
1446    o pkg/seaice/seaice_growth.F:
1447      add missing term for sublimation in saltFlux, which was breaking conservation.
1448    o pkg/seaice/seaice_model.F:
1449      Remove this patholigical case treatment in evolution branch,
1450      where it is un-necessary and breaks conservation.
1451      Update global_ocean.cs32x15/results accordingly for
1452      output.seaice.txt output_adm.seaice.txt and output_adm.seaice_dynmix.txt
1453    o model/src:
1454      useRealFreshWaterFlux: remove masking of EmPmP (using maskInC) in
1455      external_forcing_surf.F and apply mask directly in S/R SOLVE_FOR_PRESSURE.
1456    o pkg/obcs:
1457      modify Stevens boundary conditions so that S/R obcs_calc_stevens computes
1458      tendency for temperature and salinity that is then applied to update
1459      theta and salt in S/R obcs_apply_ts; this requires proper masking of all
1460      horizontal advection and diffusion contributions on the boundary (in
1461      S/Rs gad_advection, gad_calc_rhs, gmredi_rtransport, gmredi_calc_diff), and
1462      removing the mask in S/R timestep_tracer. The advantage of this approach is
1463      that the updated tracer values include contributions from the surface
1464      forcing and vertical diffusion.
1465      This modification changes exp4.stevens because of vertical diffusion.
1466    o model/src:
1467      change non-curvilinear grid setting to also work with exch2 + blank tiles:
1468      - move delX,delY to new header file (SET_GRID.h) and adjust length to 1rst
1469        face dimensions.
1470      - new S/R INI_LOCAL_GRID to define model tile-local grid (using same units
1471        as delX,delY) and called from S/R INI_CARTESIAN_GRID, INI_CYLINDER_GRID
1472        and INI_SPHERICAL_POLAR_GRID.
1473      change test-experiment global_ocean.90x40x15:
1474      - split the domain in many more tiles (9x4 tiles of 10x10 each);
1475      - switch to exch2 and remove 1 blank-tile (but only for MPI test).
1476      - update results of both test (std & dwnslp).
1477    o pkg/diagnostics/diagstat_calc.F: fix problem with non-initialised halos in
1478       tmp-fields for TARGET_NEC_SX at the cost of extra loops and less vectorisation
1479    o model/src:
1480      - take sigma-coords related code out of update_etah.F into new S/R UPDATE_ETAWS
1481        and fix initialisation when using sigma-coords.
1482    o model/src:
1483     - improve Gael's changes from Jan 14, 2011 "addition of an 'update' of hfacc etc.
1484       to their current value at the beginning of forward_step.F": add a new run-time
1485       switch "doResetHFactors" (default=false) and use it to do (or not) the resetting.
1486     - set doResetHFactors=T in the following test exp:
1487        global_ocean.90x40x15/input (rStar) & input.dwnslp (linFS),
1488        global_ocean.cs32x15/input.seaice (rStar), hs94.cs-32x32x5/input.impIGW (linFS)
1489        and tutorial_global_oce_in_p (nonLinFS in p)
1490    o pkg/ecco
1491      - added IES cost term
1492    o verification/advect_xz
1493      - scale down the depth by 1/100 (from 200 km to just 2.km)
1494      - add secondary test using divergent flow, r-star and implicit vertical advection.
1495      - add note (check_conserve_TS.txt) and matlab script to check global
1496        conservation of T & S with NonLin-FreeSurf and Adams-Bashforth.
1497    o pkg/rbcs:
1498      - add missing relaxUFile & relaxVFile in namelist (in rbcs_readparms.F).
1499    o pkg/obcs (Stevens BCs):
1500      - fix various problems in the phase speed computations of the Stevens
1501        boundary conditions:
1502        - sign error for western and southern boundaries,
1503        - time tendencies were underestimated by factor of dTracerLev and some just
1504          zero (for multidim advection schemes) -> now estimate time tendencies
1505          from difference between previous (n) time level and the one before (n-1);
1506          this requires storing a field per tracer per boundary, also in the pickup
1507          files.
1508        - replace deltaTmom in cflMer/Zon computation with dTracerLev
1509        - set default phase velocity to cflMer/Zon
1510      - update verification experiment exp4.stevens
1511    o pkg/generic_advdiff (implicit_r):
1512      - fix implicit vertical advection conservation with AB and/or NonLin-FreeSurf
1513        (remove Tr*d/dz(w) in gad_implicit_r.F and add it in gad_calc_rhs.F);
1514      - fix implicit vertical diffusion or advection with NonLin FreeSurf
1515        (was using current recip_hFacC instead of future recip_hFacC): set future
1516        recip_hFac in thermodynamics.F and pass & use it in all vertical implicit
1517        solver S/R ;
1518      - fill diagnostics of vertical advective fluxes (computed from tendency)
1519        when using implicit vert. advection;
1520      - update output of exp that uses NonLin-FreeSurf & implicit vertical diffusion:
1521         global_ocean.90x40x15 (fwd+AD), global_ocean.cs32x15 (4 fwd +4 AD),
1522         tutorial_global_oce_in_p (fwd), tutorial_tracer_adjsens (AD)
1523         and cpl_aim+ocn (used in ocean); to be fixed: bottom_ctrl_5x5.
1524    o pkg/diagnostics:
1525      - add diags for T & S tendency which goes through Adams-Bashforth.
1526    
1527    checkpoint63f (2011/11/30)
1528    o pkg/obcs/obcs_calc_stevens.F:
1529      - join some loops to reduce number of if-statements
1530      - fix a bug in code for northern and southern boundaries.
1531    o pkg/seaice/seaice_init_varia.F
1532      - undo resetting UVM=0 that has slipped in unnoticed in r1.49 and
1533        caused zero ice-velocities for the B-grid code
1534    o pkg/seaice/seaice_init_fixed.F
1535      - fix a bug in the initialisation of the second metric terms
1536        k2AtC and k2AtZ: k2AtC was set to the value of k2AtZ and k2AtZ was 0.
1537      - this affects all seaice configurations with useCurviLinearGrid = .true.
1538        and SEAICEuseDynamics = .true. (default) and SEAICEuseMetricTerms
1539        = .true. (default)
1540      - the only verification experiment affected is global_ocean.cs32x15:
1541        icedyn, seaice, and seaice_dynmix (AD)
1542    o pkg/thsice/thsice_diagnostics_state.F
1543      - only for TARGET_NEC_SX: initialise all of tmpFld, so that overlap does
1544        not contain garbage that can lead to surprises in diagstats_calc.F
1545    o model/src:
1546      - move bi,bj loops inside INTEGR_CONTINUITY ;
1547      - call INTEGR_CONTINUITY directly from forward_step.F
1548        (previously called from momentum_correction_step.F)
1549      - call UPDATE_ETAH from integr_continuity.F and update initialise_varia.F,
1550        forward_step.F and pkg/ecco/the_main_loop.F
1551    o model/src/do_oceanic_phys.F:
1552      - reset addMass to zero only if useICEFRONT ;
1553      - separated k-loop for rhoInSitu calculation ;
1554      - add 2 diagnostics for wVel*delta^k(Rho) at constant pressure (= WdRHO_P)
1555        and at constant T,S (= WdRHOdP);
1556      NOTE: change diagnostics WRHOMASS : this is now simply the Vertical transport
1557        of In-Situ Density (Anomaly) (=wVel*rho^bar-k) (previously was Vertical
1558        transport of locally-referenced potential density);
1559        to recover old diag: (WRHOMASS)_old = (WRHOMASS)_new -1/2 * (WdRHOdP)
1560    o gluemnc:
1561      - replace ncrcat with ncks when adding variables to *.glob.nc
1562      - change the way variables without record dimensions are handled so that
1563        files that have variables with and without record variables can be glued:
1564        add a record dimension with a new unique name to be able to differentiate
1565        between variable with and without a-prior record dimensions. Remove
1566        this record dimension before adding the variable to the *.glob.nc file.
1567        This procedure automatically works also for grid.*.nc files that do not
1568        have any record dimension.
1569    o verification/cpl_aim+ocn:
1570      - generate new reference output on baudelaire (gfortran, mpich2) (previously
1571        from old aces-grid cluster, ao + ifort) and update 'run_cpl_test' script.
1572    o pkg/obcs/obcs_calc_stevens.F:
1573      - add code for northern and southern boundaries.
1574      - reorder some loops to save some operations and so that drFBar can be scalar
1575    o model/src:
1576      - re-arrange extrapolation calculation in Adams-Bashforth S/R (affects machine
1577        truncation) and add diagnostics for Adams-Bashforth tendency increment.
1578      - update test-exp. AD output:
1579        1D_ocean_ice_column, bottom_ctrl_5x5, lab_sea.noseaicedyn, obcs_ctrl;
1580      and FWD output: exp4 (x3), fizhi-cs-32x32x40, fizhi-cs-aqualev20,
1581        front_relax (x3), global_ocean.90x40x15 (x2), global_ocean.cs32x15 (x5),
1582        global_ocean_ebm, ideal_2D_oce, internal_wave, isomip (x3), lab_sea (x4),
1583        matrix_example, MLAdjust (x5), natl_box (x2), tutorial_advection_in_gyre,
1584        tutorial_global_oce_in_p, tutorial_global_oce_latlon and
1585        tutorial_plume_on_slope.
1586    o pkg/diagnostics/diagstats_calc.F: add special code for TARGET_NEC_SX
1587      that vectorises. This code uses 3 extra 2D fields, F90 array assignments
1588      and F90 intrinsic routines SUM, MINVAL, MAXVAL, but since TARGET_NEC_SX
1589      does not even come with an F77 compiler anymore, this should not be
1590      a limitation
1591    
1592    checkpoint63e (2011/11/06)
1593    o pkg/seaice adjoint of LSR:
1594      - substantially rework STORE dirs.
1595      - add new flag SEAICE_LSR_ADJOINT_ITER and parameter SOLV_MAX_FIXED
1596        this flag will do SOLV_MAX_ITERS but only store SOLV_MAX_FIXED fields
1597        and only perform SOLV_MAX_FIXED adjoint iters.
1598        If flag SEAICE_LSR_ADJOINT_ITER is undef-ined, the store in the iteration
1599        always goes to same record, meaning that the last forward field will be
1600        the one used in the adjoint - an approximation.
1601      - now produces non-zero LSR-related gradients, and acceptable gradients for
1602        An's zonal (x-z) test case (to be checked in)
1603      - lab_sea: produces acceptable gradients for lab_sea with forward/backward LSR
1604        (but these are screwed up by the thermodynamics in the first place);
1605        reduce from 4 to 3 timesteps to avoid t.d. issue as temporary solution;
1606        output_adm.txt also reflects changes to seaice_lsr
1607      - global_ocean.cs32x15:
1608        * the "default" input_ad.seaice has been re-defined to always exclude dynamics
1609          (output_adm.seaice.txt was updated)
1610        * new input_ad.seaice_dynmix tests a forward LSR / backward free-drift
1611          (output_adm.seaice_dynmix.txt)
1612    o test-exp. exp4+stevens:
1613      - switch off pTracers and nonHydrostatic (restart problems with NH); update output
1614    o pkg/seaice (lsr solver):
1615      - put coriolis term into FORCEX,Y (as in seaice_evp.F; previously in rhsU,V only);
1616        update output (change truncation) of FWD test exp lab_sea & global_ocean.cs32x15
1617      - fix SEAICEuseFREEDRIFT for new OBCS version (ndef OBCS_UVICE_OLD)
1618      - new parameter "LSR_mixIniGuess" allows (if=2,4) to mix free-drift solution
1619        into initial guess for linearised solver; use weight ~ (1/err)^2,4.
1620      - compute (with new S/R) and print initial (+ free-driff sol. if available)
1621        and final residual of linearised system.
1622    o pkg/pp81: add diagnostics for vertical eddy viscosity and diffusivity
1623      (requires new subroutines pp81_init_fixed.F/pp81_diagnostics_init.F)
1624    o pkg/obcs: Stevens BCs (still only for east and west)
1625      - fix Stevens BCs by using intermediate velocities of previous
1626        time step as "baroclinic" contribution rather velocity of one grid cell
1627        inside the boundaries; more consistent but makes the entire treatment
1628        more complicated, requires new pickup files and two new S/Rs:
1629        obcs_copy_uv_n and obcs_save_uv_n
1630        keep old version with flag OBCS_STEVENS_USE_INTERIOR_VELOCITY
1631        (undefined by default)
1632      - silently move computation of some grid factors into separate loops to
1633        save some recomputations
1634      - add a hack for non-linear free surface
1635      - add a verification experiment to exp4 that tests this code
1636    o make gluemnc/xplodemnc work with (moron) non-GNU shell tools
1637    
1638    checkpoint63d (2011/10/25)
1639    o pkg/obcs + seaice-dynamics:
1640      - new implementation calls OBCS_APPLY_UVICE (in seaice_dynsolver.F) before
1641        solving for uIce,vIce and prevent SEAICE_LSR or SEAICE_EVP to modify OB
1642        values (consistent with an implicit method).
1643      - add option OBCS_UVICE_OLD (in OBCS_OPTIONS.h, defined by default) to
1644        return to older implementation (same results as before); note that none of
1645        the "experimental" OBCS_SEAICE options are implemented in the new version.
1646      - switch test exp. seaice_obcs to use new version (update output).
1647    o pkg/seaice:
1648      - add few stop (B-grid & CS-exch, B-grid & obcs, AUTODIFF & SEAICE_maskRHS)
1649      - add parenthesis in Water-Ice drag calculations (evp & lsr);
1650      - in seaice_lsr.F, simplify and fix AA3 setting in case sNx or sNy=1;
1651        and fix case SEAICE_waterDrag=0 (but unstable if no or little seaice)
1652      - update output of test exp lab_sea that uses evp or lsr (fwd+ad)
1653        and global_ocean.cs32x15 (icedyn & seaice fwd+ad).
1654    o pkg/layers:
1655      - Include potential density as new coordinate (Thanks to David Munday)
1656    o pkg/dic:
1657      - Remove subroutine CALC_PCO2_APPROX_CO3 from carbon_chem.F and add
1658        carbonate computation/output to CALC_PCO2_APPROX
1659    o pkg/generic_advdiff
1660      - make TAF generate code that vectorizes:
1661        gad_dst3fl_adv_*.F, gad_u3c4_impl_r.F
1662    o model/src:
1663      - improve vectorization also for adjoint code of
1664        solve_tridiagonal and solve_pentadiagonal. As this requires up to
1665        5 new 3D-fields, this code is only turned on for the combination of
1666        ALLOW_AUTODIFF_TAMC and TARGET_NEC_SX. Also remove error message
1667        for singular matrix check (only for TARGET_NEC_SX).
1668      - remove hard-wiring of CPP-flag ALLOW_SOLVERS_KLOOPINSIDE to
1669        ALLOW_AUTODIFF. This flag now needs to be set outside of
1670        solve_tri/pentadiagonal.F
1671    o pkg/exf:
1672      - fix previous modif in exf_readparms.F (revision 1.66: treatment of
1673        optional namelist EXF_NML_OBCS).
1674      - add many debug-print (to trace down where pkg/cal error msg comes from)
1675    o pkg/mom_vecinv/mom_vi_hdissip.F
1676      - rearrange loops so that vectorization is improved and in particular
1677        the adjoint routine vectorizes. The code is a little longer now, but I
1678        think easier to read.
1679        Note: CPP-flag MOM_VI_ORIGINAL_VISCA4 is not tested.
1680    o pkg/seaice:
1681      - allow to specify initial seaice velocity from files (uIceFile,vIceFile)
1682    o pkg/exch2:
1683      - alternative code (without tile x tile matrix) for cumulated (global) sum;
1684        used as default; keep using matrix version in adjustment.cs-32x32x1.
1685    o tools/build_options:
1686      - after merging some MPI and/or multi-threads specific optfiles so that
1687        the modified default optfile support both built (using genmake2 -mpi
1688        for the MPI built, using genmake2 -omp for OpenMP built),
1689        move now obsolete optfiles to tools/build_options/unsupported/
1690       (add copy of email sent to support list in doc/optfiles_changes.txt)
1691    
1692    checkpoint63c (2011/09/28)
1693    o pkg/ebm:
1694      - fix ebm_zonalmean.F for several procs in Ydir (nPy > 1); update output of
1695        test exp. global_ocean_ebm (affects machine truncation, 12 digits for cg2d)
1696    o pkg/seaice (SItracer pickup)
1697    * Simple code for pickup of SItracer fields (#define ALLOW_SITRACER)
1698      To be done:
1699      - thorough testing of missing fields in S/R seaice_read_pickup
1700      - thorough matching between generic tracers and specific fields used
1701        (e.g. volume-weighted age, area-weighted age, salinity, ...)
1702    o pkg/grdchk:
1703      - all procs calculate and print finite-difference gradient (for testreport)
1704      - change description output used by testreport;
1705      - AD testing: also compare and report Finite-difference gradient;
1706        => update all output_adm*.txt
1707    o test exp. global_ocean_ebm:
1708      - switch back useRealFreshWaterFlux (no problem anymore with run-off);
1709        and turn on exactConserve; update (fwd) output.
1710    o pkg/seaice (LSR):
1711      - print to STDOUT number of solver iterations at SEAICE_monFreq interval.
1712      - modify solver to deal cleanly with u/v switch at face edges (CS-grid):
1713        * identical results with non-CS topology (but save up to half of EXCH calls)
1714        * no much changes in cs-32 verification tests since no ice at face edges
1715         (differences due to convergence criteria, since nb of iterations changed)
1716        * expect some differences on lat-lon-cap grid.
1717        update FWD results of global_ocean.cs32x15 test exp. (icedyn & seaice)
1718    o pkg/exch2:
1719      - add new CPP option to disable Cumul-Sum matrix (to save storage when using
1720        many tiles); until alternative coding is added, just add a stop.
1721    o pkg/kpp:
1722      - move ptracer/salt correction to KPP diffusivity from calc_3d_diffusivity.F
1723        to S/R KPP_CALC_DIFF_PTR (+ add tracer-index to argument list).
1724    o optfiles:
1725      - merged few MPI specific (*+mpi*) and multi-threads specific (*+mth) optfiles
1726        into corresponding standard one, which now support different build:
1727        (when using "genmake2 -mpi" for MPI built, "genmake2 -omp" for OpenMP built)
1728      - add "darwin_amd64_gfortran" optfile (initially from Constantinos, tested by Gael)
1729    o pkg/obcs (seaice):
1730      - add missing EXCH for uIce,vIce after applying OBCS;
1731      - remove S/R EXF_SWAPFFIELDS_X/Y , disable S/R EXF_SET_OBCS_X/Y by adding
1732        argument = number of levels to S/R EXF_SWAPFFIELDS_XZ/YZ and S/R
1733        EXF_SET_OBCS_XZ/YZ ; update obcs_exf_load.F;
1734      - fix EXF_SET_OBCS_XZ/YZ for multi-threaded (assuming loaded arrays are shared)
1735      - verification exp. seaice_obcs: split domain in 2 tiles ; add SIZE.h_mpi
1736        and eedata.mth for MPI and mutlti-threaded testing.
1737    o pkg/flt:
1738      - make FLT EXCH working with multi-threads (and MPI + multi-threads);
1739      - use buffer for floats IO (trajectories & profiles); size set in FLT_SIZE.h;
1740      - fix pickup and trajectories + profiles output with multi-threads;
1741      - add parameter to select group of fields to write along trajectory and
1742        profile (default unchanged);
1743      - only call PORT_RAND* function when flt_noise <> 0;
1744      - add multi-threaded test for verification exp. flt_example.
1745    o eesupp/src:
1746      - fix S/R ALL_PROC_DIE for MPI+multi-threads.
1747      - USE_OMP_THREADING: check that number of threads (from eedata) matches
1748        actual number (from env.var. setting).
1749    o pkg/ebm:
1750      - fix multi-threading in ebm_area_t.F ; clean-up EBM.h header file.
1751      - add multi-threaded test for verification exp. global_ocean_ebm
1752    
1753    checkpoint63b (2011/08/29)
1754    o pkg/ebm:
1755      - fix sign of runoff;
1756      - update directly forcing fields (Qnet,EmPmR) to use standard
1757        external_forcing_surf.F (remove ebm_forcing_surf.F);
1758      - avoid loading forcing fields a 2nd time (1rst time from ini_forcing.F);
1759      - set either tauThetaClimRelax (in data) or tauThetaZonRelax (in data.ebm)
1760        and apply relaxation towards corresponding SST field (2-D map or ZonAver).
1761      - update global_ocean_ebm parameters file data and update output (fwd+ad).
1762    o verification/matrix_example:
1763      - split domain in 8 tiles (2x4); add SIZE.h_mpi and eedata.mth for
1764        MPI and mutlti-threaded testing.
1765    o pkg/matrix:
1766      - change name of S/R MATRIX_INIT to S/R MATRIX_INIT_VARIA ;
1767      - fix for multi-tiles (add bi,bj indices to exp/impMatrixCounter);
1768      - fix for multi-threaded (remove DATA statement);
1769      - use standard DIFFERENT_MULTIPLE function;
1770      - add MATRIX_OPTIONS.h
1771    o verification/matrix_example:
1772       To allow to split the domain in several tiles, change the domain size
1773        from 31x31 to 32x32 by adding 1 row (on Southern side) + 1 column (on
1774        Western side) of land points.
1775    o (*_)write_pickup:
1776      - fix few bugs in mypackage_read/write_pickup.F
1777      - in MDS_WR_METAFILES calls, replace "myTime" by a local copy into
1778        array of length 1 (was caught by compiler syntax-check).
1779    o pkg/diagnostics (velocity potential solver):
1780      - fix initialisation of main diagonal matrix (for overlap values)
1781    o tools/build_options:
1782      - towards single optfile for MPI and non-MPI built: merge few +mpi optfile
1783        into previously non MPI one (linux_am64 pgf77,open64,pathf90,ifort11)
1784      - linux_amd64_gfortran: merge +mpi_generic version into standard optfile:
1785        * move IEEE flags to DEVEL section; take IEEE flags from +mpi_generic ;
1786        * FAST case: for now, keep -O3 with ini_masks_etc.F in NOOPTFILES list;
1787        and use "-devel" testreport option for standard testing on baudelaire.
1788    o pkg/grdchk:
1789      - Assume that all gradient-check position are within the same tile
1790        corresponding to global indices (iGloTile,jGloTile) and that
1791        positions (i,j indices or nbeg) are local to this tile;
1792      - set tile local-indices and proc. number according to tile global-indices;
1793      - remove grdchkwhichproc from namelist (retired param);
1794      - send adjoint gradient to all procs so that all procs print it to STDOUT;
1795      - switch on MPI test for global_ocean.90x40x15 AD test experiment.
1796    o adding package bbl (Bottom Boundary Layer)
1797      description in MITgcm/pkg/bbl/bbl_description.tex
1798      example/test experiment in MITgcm_contrib/bbl
1799    o adjoint verifications
1800      - changed 5 experiments to multi-tiles
1801        * global_ocean.90x40x15
1802        * obcs_ctrl
1803        * offline_exf_seaice
1804        * tutorial_dic_adjoffline
1805        * tutorial_tracer_adjsens
1806        changed reference output for those that crossed tile boundaries
1807        (changed choices of gradient check positions)
1808      - with same tiling, switch on MPI test for the last 4 (add SIZE.h_mpi)
1809      - temporary bug fix in grdchk_loc.F for obcs
1810    o genmake2 & testreport
1811      - add target "obj" (just for OBJFILES files) to Makefile;
1812      - add option to specify FEXTRAFLAGS on command line.
1813    o pkg/mypackage:
1814      - remove bi,bj arguments from argument list of S/R MYPACKAGE_CALC_RHS
1815    
1816    checkpoint63a (2011/08/02)
1817    o pkg/diagnostics (velocity potential):
1818      - fix velocity-potential calculation when using OBCS: balance net inflow
1819        at each level (new S/R OBCS_DIAG_BALANCE).
1820      - fix some of the problems with OBCS in stream-function calculation.
1821    o pkg/exf/exf_readparms.F
1822      - make treatment of optional namelists (EXF_NML_04, EXF_NML_SGRUNOFF,
1823        EXF_NML_OBCS) more consistent, so that you need not have these lists
1824        in data.exf when they are not used.
1825    o optim/optim_readdata.F:
1826      - add some output about obcs variables that might help debugging
1827      - add a check about nvarlength
1828    o pkg/ctrl: once again, fix computation of endrec in s/r ctrl_init_rec
1829    o pkg/diagnostics (velocity potential):
1830      - fix mask for OBCS (still problems in stream-function with OBCS);
1831      - add specific parameter (default = main code CG2D params) for solver;
1832      - in case of poor convergence, use solution corresponding to lowest residual.
1833    o pkg/seaice/seaice_growth.F: small changes that permit vectorizable
1834      adjoint code. In general statements like tmpscal=fld(i,j) are problematic
1835      and should be avoided where possible.
1836    o model/src (rStar):
1837      - include r* effect on reference-state (PhiRef) in totPhiHyd
1838        (so that it's really the potential anomaly at the cell center);
1839        affect solution only if z* with full pressure in EOS.
1840      - test-exp global_ocean.90x40x15: reduce viscA4 (was not stable) and
1841        update output (because of z* in totPhiHyd and viscA4 changes);
1842      - keep the previous diagnostics as "PHIHYDcR" (closer to potential anomaly
1843        @ constant r) until interpolation at constant r is implemented.
1844    o pkg/diagnostics
1845      - fix RCENTER diagnostics in case cell center is not at interface middle
1846    o add code for TEOS-10 (www.teos-10.org, McDougall et al. 2011). Use
1847      this eos with eosType = 'TEOS10', in data (PARM01). This eos implies
1848      that THETA and SALT are "conservative temperature" and "absolute
1849      salinity"
1850    o pkg/ctrl
1851      - fix computation of endrec in s/r ctrl_init_rec
1852      - ctrl_pack/unpack_*: remove unused variables and some obsolete code
1853    o pkg/seaice/seaice_growth.F
1854      - fix recomputation with FENTY_AREA_EXPANSION_CONTRACTION code,
1855        remove then obsolete STORE directives
1856      - fix STORE directives for tice and tices, so that only the
1857        appropriate part of the fields are stored (and not the entire
1858        field); update global_ocean.cs32x15.seaice AD output.
1859      - cosmetic changes: adjust CPP flags and indentation for better
1860        legibilty
1861    o pkg/autodiff: add mnc-output of adBottomDragFld (code contributed by
1862      Chris Wilson)
1863    o pkg/gmredi:
1864       Add Sub-Meso Eddies parameterisation from Baylor (for now, disabled with TAF),
1865       and test it in verification exp. "front_relax.bvp" (update output.bvp.txt)
1866    
1867    checkpoint63  (2011/07/11)
1868    o pkg/exch2:
1869     - rename+move: nTiles in W2_EXCH2_PARAMS.h --> exch2_nTiles in W2_EXCH2_TOPOLOGY.h
1870     - exch2 version of Cumul-Sum routine: S/R W2_SET_MAP_CUMSUM set up the
1871       (2*nTiles)x(nTiles) Cumul-Sum matrix and Master Proc collects all tiles X,Y
1872       increments, calculates Cumul-Sum @ tile origin and sends results to each tile.
1873    o pkg/diagnostics:
1874     - deal with pairs of post-processed diags which are computed together; in
1875       particular, re-order list of diags within 1 file to save 2nd computation.
1876     - add S/R to compute velocity stream-function (called after velocity-potential
1877       calculation) from divergence free transport -> new diagnostics "PsiVEL".
1878     - add parameter to select grid-point location where PsiVEL == 0.
1879    o eesupp/src:
1880       new S/R to calculate cumulated sum on tiled array, corner grid-cell location
1881       (specific S/R needed with exch2 topology - for now, just print an error msg)
1882    o pkg/shelfice
1883     - Implement friction velocity-dependent transfer coefficients following
1884       Holland and Jenkins, JPO, 1999
1885       Original code by M. Losch with small modifs.
1886       Enable with CPP option SHI_ALLOW_GAMMAFRICT
1887       and runtime flag SHELFICEuseGammaFrict
1888    o verification lab_sea & global_ocean.cs32x15:
1889     - use tools/xmakedepend (instead of cyrus_makedepend, in genmake_local):
1890       does not miss some dependencies (but is slower) and also works with many files
1891       (default makedepend limitation for AD built).
1892     - use cyrus_makedepend in adjustment.128x64x1 (so that it still tested).
1893    o pkg/diagnostics:
1894     - add run-time parameter "useMissingValue" (def=False) to fill land-point
1895        (i.e., where mask=0) with MissingValue ; used only in MNC output file.
1896       This replaces CPP-option DIAGNOSTICS_MISSING_VALUE.
1897     - Extend the use of "missing_value" setting from data.diagnostics for the case
1898       of counter-diagnostics (where fraction-weight is zero). This applies both to
1899       MNC and MDS output files.
1900    o pkg/seaice/seaice_growth.F:
1901      - add 'a priori' cap of latent heat flux based on actual mass considerations
1902        when SEAICE_ADD_SUBLIMATION_TO_FWBUDGET is used in conjunction with the
1903        non-legacy seaice_solve4temp.
1904      - add diagnostic of the residual sublimation freshwater flux (the freshwater
1905        flux taken from the ocean if the total actual latent heat fluxes exceed
1906        the maximum)
1907      - remove the CPP switch around the *_FWbySublim unit change and move diagnostic
1908       fill for SIatmQnt, SIfwSubl, SIatmFW to the end of seaice_growth.F.
1909      - add diagnostic of the actual sublimation freshwater flux (that is 0. ifndef
1910       SEAICE_ADD_SUBLIMATION_TO_FWBUDGET) and of the latent heat flux (evap+sublim).
1911      - bug fix : frWtrAtm needs a_FWbySublim ifdef SEAICE_ADD_SUBLIMATION_TO_FWBUDGET.
1912      - bug fix : missing part to Martin's r_FWbySublim pathological case fix.
1913    o verification 1D_ocean_ice_column:
1914       made model domain truly 1x1x23 instead of 5x5x23 with only center cell (3,3,:) wet
1915       update results
1916    o pkg/diagnostics:
1917     - Implement setting of "Post-Processed" diagnostics (corresponding to gdiag(5)='P')
1918       which are not filled-up but computed from other diags ; In this case, the mate
1919       diag points to the primary (filled-up) diag to used for post processing.
1920     - Update Velocity-potential computation using post-processed diag framework.
1921     ==> Change the ordering of fields and time-periods in MDS output file
1922       when using periodic averaging: now writes one time record with the full set
1923       of fields for this time period, then the next time reccord (it used to be
1924       one field with the full set of time records then the next field).
1925         Note: this is now similar to NetCDF (MNC) output file. <==
1926    
1927    checkpoint62z (2011/06/21)
1928    o adjoint monitor:
1929     - Add adjoint monitor output for packages exf, seaice
1930       and update relevant testreport output
1931    o pkg/seaice:
1932     - re-order diags inits so that they appear in order in available_diagnostics.log
1933     - added diags: hsnow thermo. rates of change, area preceeding ridiging process,
1934       area/heff/hsnow preceeding thermodynamic growth/melt.
1935     - modified diag: SIdA; output actual effect, as the description states.
1936     - modified description: SIqneti, SIqneto, SIuheff, SIvheff, SIdAb*, HSNOW.
1937     - retired redundant diags: SIyneg, SIfice, SIsnwice, SIthdgrh.
1938       (SIyneg->SIdHbOCN; SIfice->SIdHbATC; SIsnwice->SIdHbFLO;
1939        and SIthdgrh->SIdHbOCN+SIdHbATC+SIdHbATO)
1940     - modified diags (2) : switch all SIdA*, SIdH*, SIdS* from delta to rates.
1941     - added diagnostics for seaice generic tracers (SItr*).
1942     - added SItrUnit and SItrNameLong run time param (for SItr* diags).
1943     - in diag names, replaced 'PrTh' abbrev. of 'preceeding thermo' with 'PT'.
1944     I. Fenty: 18-Jun-2011:
1945     Minor changes to seaice package:
1946     1) Retired old variables (A22, SEAICE_lhsublim, areaMax, areaMin, hiceMin) and
1947        added some new ones (SEAICE_area_reg, SEAICE_hice_reg, SEAICE_area_floor)
1948       - Differentiated "regularization variables" from "floor variables"
1949        * areaMin became SEAICE_area_reg (old A22) and SEAICE_area_floor
1950        * hiceMin became SEAICE_hice_reg (old hiceMin)
1951          (with _reg meaning regularization variable)
1952       - SEAICE_lhSublim becomes lhSublim, the sum of SEAICE_lhEvap and SEAICE_lhFusion
1953        so as to ensure energy conservation when going between phases
1954      - A22 was not used anywhere
1955     2) Changed regularization procedure for heffActual and hsnowActual to ensure
1956        well-boundedness and smooth adjoint in seaice_growth.F
1957     3) Fixed a bug where seaice_solve4temp would not recognize ice-free grid cells
1958        because the old regularization always set heffActual >= 0.05 cm
1959     4) Changed the model so that the default behavior is to put a small (10^-5) "floor"
1960        on AREA when HEFF > 0.
1961      - went from requiring ALLOW_PRECLUDE_INFINITESIMAL_AREA to be defined to
1962        requiring that DISABLE_AREA_FLOOR *not* be defined
1963     Affected verifications:
1964      - 1D_ocean_ice_column (output.txt output_adm.txt)
1965      - global_ocean.cs32x15 (output.seaice.txt output_adm.seaice.txt)
1966    o pkg/diagnostics:
1967      - move MNC code from diagnostics_out.F into new diagnostics_mnc_out.F (2 S/R).
1968      - rename S/R GETDIAG to DIAGNOSTICS_GET_DIAG and change type of 1rst argument
1969        (was _RL, now integer) with option = 0 to retrieve all levels.
1970      - add pieces of code to compute velocity potential at each level (new diagnostics
1971        PhiVEL, works only when UVELMASS & VVELMASS are also turned on);
1972        for now, using same params as CG2D (target-resisual, max Nb of iter ...).
1973      - fix few issues with counter diagnostics in diagnostics_setdiag.F &
1974        diagstats_setdiag.F (if diagnostic counter is itself a counter diag)
1975        and in diagnostics_fract_fill.F (do not need a valid pointer for the
1976        diagnostics counter-mate); check that definition of counter-diagnostic
1977        includes a valid counter-mate (in diagnostics_set_levels.F).
1978    o model/src (rStar):
1979      - add rStar scaling factor in diags_phi_hyd.F (similar to calc_grad_phi_hyd.F);
1980        affect solution only if z* with full pressure in EOS;
1981        update output of test-exp global_ocean.90x40x15.
1982    o pkg/seaice:
1983      - introduce siEps=1e-5 parameter
1984      - use areaMax in AREA update (part 4), consistent with ridging step (part 2.5).
1985      - re-organize SEAICE_ADD_SUBLIMATION_TO_FWBUDGET code.
1986      - introduce ALLOW_SITRACER and seaice_tracer_phys.F to handle generic seaice tracer.
1987        For now it covers, and was tested for, ice salinity and age (attached to HEFF),
1988        as well as ice cover age and ridging index (attached to AREA).
1989        For now the run time parameters (in data.seaice/SEAICE_PARM03) are
1990        SItrName (e.g. 'age') and SItrMate ('HEFF', which is the default, or 'AREA').
1991        Up to SItrMaxNum=3 tracers can be used simultaneously.
1992    o pkg/salt_plume:
1993      -introduce SPsalFRAC run time parameter that sets the fraction of the
1994       salt by-product of ice growth (SPsalFRAC*(1-SIsalFRAC)*salt typically)
1995       that gets vertically redistributed (fluxed down) by pkg/salt_plume.
1996    o model debug options:
1997      - Switch reading of debugMode from S/R INI_PARMS (parameter file "data", stored
1998        in PARAMS.h) to S/R EESET_PARMS (parameter file "eedata", stored in EEPARAMS.h).
1999      - Refine debug-msg printing selection (3 new levels):
2000        debugMode  : controls printing of debug messages (sequence of S/R calls).
2001        debugLevel : controls printing of algorithm-relevant auxiliary/debug messages
2002         debLevZero =  0 ; /* level of disabled aux. msg printing */
2003         debLevA =  1 ; /* level of minimum  aux. msg printing */
2004         debLevB =  2 ; /* level of low aux. print (report read-file opening)*/
2005         debLevC =  3 ; /* level of moderate debug prt (most pkgs debug msg) */
2006         debLevD =  4 ; /* level of enhanced debug prt (add DEBUG_STATS prt) */
2007         debLevE =  5 ; /* level of extensive debug printing */
2008        New debugLevel default: with default debugMode value (=F),
2009          = 2 (debLevB) or = 1 (debLevA) in case ALLOW_AUTODIFF is defined.;
2010          and if debugMode=T, default debugLevel = 4 (debLevD).
2011        Relation with previous settings:
2012         debLevB (=2) corresponds to former debLevA (=1)
2013         debLevD (=4) corresponds to former debLevB (=2)
2014        Note:
2015         a) if debugLevel=0, skip WRITE_GRID call when nIter0 > 0 (same as before);
2016         b) default debugLevel=1 is convenient in AD runs (avoid many file opening msgs);
2017            to recover previous default, set debugLevel=2 (e.g. AD-test hs94.1x64x5)
2018      - Add new parameter (printResidualFreq, read from PARM02 namelist) to print
2019        detailed CG solvers convergence; off (=0) by default, except if debugLevel=5.
2020    o pkg/obcs:
2021      - change OBCSfixTopo default from True to False (should not change the results);
2022        keep OBCSfixTopo=T in verification-exp. seaice_obcs.
2023    o pkg/thsice:
2024      - fix bug in thsice_calc_thickn.F (was introduced in version 1.18) in
2025        2nd layer seaice sublimation (unlikely to happen)
2026      - use Interior mask for OBCS in thsice_advection.F (similar to what is
2027        done in gad_advection & seaice_advection).
2028    o adjoint:
2029      bug fix spotted by Gael Forget:
2030      seaice_advection and thsice_advection still had
2031      legacy CPP options to avoid CS corner updates for adjoint
2032    o pkg/seaice:
2033      => Change some of the defaults (2011/05/29):
2034         - change SEAICEuseFluxForm default (from False to True)
2035         - change DIFF1 default (from 0.004 m/s to 0. m/s)
2036         And print warnings if DIFF1 is not set in data.seaice and centered
2037          avection scheme is used without any diffusion.
2038      also:
2039      - fix seaice_diffusion calls in default AdvScheme part of seaice_advdiff.F;
2040      - set SEAICEdiffKh[] default in the same way as SEAICEadvSch[]
2041      - stop if DIFF1<>0 with SEAICEadvScheme <> 2, if DIFF1<>0 with any
2042        other non-zero SEAICEdiffKh[] diffusivity, if SEAICEadvSalt=T with
2043        #undef SEAICE_VARIABLE_SALINITY, if SEAICEadvAge=T with #undef SEAICE_AGE.
2044      update results of test exp.:
2045         lab_sea: output.fd (switch to AdvScheme=33 with diffKh=20)
2046             output.hb87, output_adm.evp (SEAICEuseFluxForm=T and diffKh=200)
2047             output_adm.noseaicedyn (SEAICEuseFluxForm=T)
2048         offline_exf_seaice: output.seaicetd, output_adm (SEAICEuseFluxForm=T)
2049         seaice_obcs: output (SEAICEuseFluxForm=T)
2050      and prescribe old default for SEAICEuseFluxForm (=F) and DIFF1 (=0.004)
2051          for standard fwd & AD lab_sea tests (to keep the same output).
2052    o pkg/seaice/seaice_growth.F:
2053      - use Ian Fenty's capping formulas for actual ice
2054      thickness thoughout EVOLUTION branch.
2055      - put treatment pathological case #2) in CPP brackets
2056      (ALLOW_AVOID_INFINITESIMAL_AREA, undef by default).
2057      - update global_ocean.cs32x15 and 1D_ocean_ice_colum results accordingly.
2058    o pkg/seaice:
2059      - seaice_diffusion.F : remove the min(DX,DY) factor permanently;
2060      pass the Laplacian diffusivity (in m^2/s) diffKh as a parameter;
2061      also pass fac as a param, which can be 1. (to update the tendency
2062      field) or the time step (to update the field itself).
2063      - seaice_advdiff.F: for multidim, call seaice_diffusion with
2064      e.g. SEAICEdiffKhHeff and with fac=1; for single-dim, call
2065      seaice_diffusion with e.g. SEAICEdiffKhHeff and with fac=time step.
2066      - SEAICE_PARAMS.h, seaice_readparms.F, seaice_check.F :
2067      hooks to handle SEAICEdiffKhHeff, SEAICEdiffKhArea, etc.
2068    o pkg/seaice:
2069      diffusion with centered advection scheme (diffus.F & advect.F):
2070      - simplify S/R DIFFUS (put deltaT & DIFF1 factor outside, move EXCH outside)
2071        to just compute the laplacian of input-field.
2072      - unroll k loop (harmonic,biharmonic diff) in advect.F to save 1 exch call.
2073      - fix flux-form version in diffus.F to conserve tracer.
2074      update output of lab_sea.fd & lab_sea.hb87 (1rst set of modif affects
2075       machine truncation) and lab_sea.salt_plume (conservative flux-form modif)
2076    
2077    checkpoint62y (2011/05/26)
2078    o pkg/seaice:
2079     - seaice_growth.F : in EVOLUTION branch, always include
2080       a_QSWbyATM_cover in qnet (as it should be).
2081     - verification/global_ocean.cs32x15 : update results accordingly
2082       (output.seaice.txt output_adm.seaice.txt).
2083    o pkg/seaice + obcs:
2084     - use maskInW & maskInS in multi-dim advection and biharmonic diffusion:
2085       equivalent of assuming no tracer gradient outside the OB region.
2086       update output of seaice_obcs (uses DIFF1 <>0 => biharmonic diffusion)
2087     - remove calls to OBCS_COPY_TRACER after EXCH calls (no longer needed
2088       after changes above);
2089     - obcs+seaice cleaning: apply seaice-tracer OB values to tracer field
2090       only at OB location (instead of over a band of OLx width).
2091    o pkg/seaice:
2092     - fix wrong indices in old (non Flux-Form) diffusion default S/R diffus.F
2093       (dxG(I+1, ...) changed to dxG(I, ...), no impact on Lat-Lon grid)
2094    o pkg/obcs:
2095      - split header file "OBCS.h" into 4 separated files:
2096        OBCS_PARAMS.h, OBCS_GRID.h, OBCS_FIELDS.h & OBCS_SEAICE.h
2097       Note: OBCS_PARAMS.h & OBCS_GRID.h can be included without OBCS_OPTIONS.h
2098         (contain no conditional statement which depends on OBCS options).
2099      - move "useOBCSYearlyFields" from "data.obcs" (hold in OBCS_PARAMS.h)
2100        to parameter file "data.exf", namelist EXF_NML_OBCS (in EXF_PARAM.h).
2101    o ctrl, cost, grdchk & autodiff pkgs:
2102      - make options file more standard (like other {PKG}_OPTIONS.h file but
2103        with AD_CONFIG.h); clean-up some of the included header files.
2104    o pkg/obcs:
2105      - do not mask tracer when applying OB (tracer == 0 could generate problems)
2106      - apply tracer OB values to tracer field only at OB location (instead of
2107        over a band of OLx width)
2108      - clean-up obcs_apply_w.F & obcs_apply_eta.F (since less calls to these S/R)
2109      - remove OBCS_MULTIDIM_OLD_VERSION code in gad_advection.F and remove
2110        obcs_apply_tloc.F & obcs_apply_sloc.F
2111    o obcs in model/src:
2112      - call OBCS_APPLY_W only if NonHydrostatic.
2113      - call OBCS_APPLY_ETA only if NonLinFreeSurf.
2114      - reset dEtaHdt and wVel to zero outside OB interior region ;
2115      - leave tracer unchanged outside OB interior region: This has no effect
2116        on the solution but just to prevent unrealistic tracer value outside OB.
2117      - zero out velocity outside OB interior region: This has no effect on
2118        the solution but just to prevent unrealistic velocity outside OB.
2119    o obcs and non-lin free-surf:
2120       move call to OBCS_APPLY_R_STAR from update_r_star.F to calc_r_star.F
2121       and call to OBCS_APPLY_SURF_DR from update_surf_dr.F to calc_surf_dr.F
2122       + add argument "etaFld" to OBCS_APPLY_R_STAR & OBCS_APPLY_SURF_DR:
2123       this fixes missing EXCH + get consistent eta OB value (+ fix restart).
2124       update results of test-exp. exp4(nlfs).
2125    o exp4 (nlfs) test-exp:
2126       use OBC for Eta at Western & Eastern OB (to test prescribing Eta
2127       with NonLin-FreeSurf); update output.nlfs.txt
2128    o obcs and 2d/3d solver norm:
2129       use interior masks (maskInC) to cancel out cg2d & cg3d matrix coeff at OB
2130       and outside OB interior region (will allow to place OB further inside the
2131       domain). Depending on the domain, can affects cg2d-Norm (previous
2132       cancellation outside OB was only partial), e.g. in exp4 & obcs_ctrl,
2133       and cg3d-Norm (previous Norm was computed before canceling OB terms),
2134       e.g. in tutorial_plume_on_slope.
2135      - update output of exp.: exp4 (x2), obcs_ctrl and tutorial_plume_on_slope.
2136    o pkg rbcs:
2137      - split RBCS.h into 3 files: RBCS_SIZE.h, RBCS_PARAMS.h & RBCS_FIELDS.h
2138      - add capability to apply relaxation to horizontal velocity uVel & vVel.
2139    o pkg/grdchk: add gradient check for control variable xx_shifwflx
2140    o pkg/shelfice/shelfice_init_fixed.F
2141      fix CPP-flag combinations
2142    o pkg/seaice: Merge iceage code of Pierre Rampal
2143      * update/change/correct ice age calculations
2144      * add age updates for pathological cases
2145      Probably needs more testing...
2146    
2147    checkpoint62x (2011/05/13)
2148    o pkg/mom_vecinv:
2149       high-order vorticity scheme: use interior masks (maskInW & S)
2150       to zero-out (outside OB) gradient of vorticity.
2151    o verification exp.:
2152       turn on "useEnergyConservingCoriolis" (better discretisation) in exp.
2153       hs94.128x64x5 and seaice_obcs ; update results.
2154    o pkg/obcs:
2155      fix bug in OBeta for YZ sections in obcs_exf_load.F
2156    o pkg/ctrl, pkg/shelfice, and optim:
2157      - add new control variable xx_shifwflx (fresh water flux underneath ice
2158        shelves). This is almost as tedious as obcs-ctrl, because the
2159        variables needs its own mask.
2160      - add a cost function term that penalizes the deviation of xx_shifwflx
2161        from the first guess (zero) in analogy to other control variables
2162    o pkg/shelfice:
2163      - start basic adjoint
2164    o pkg/ctrl:
2165      - remove extra 2D field "for good measure" when initializing in
2166        ctrl_set_globfld_[xy/xz/yz].F
2167      - replace hard coded precision 32 (a bug) in ctrl_map_ini_gen by ctrlprec
2168      - improve error messages in ctrl_set_unpack_*
2169    o OBC implementation in momentum:
2170       use interior masks (maskInC,W & S) in momentum S/R:
2171       - multiply divergence, tension and some del^i.u or del^j.v by maskInC
2172       - multiply del2u,del2v by maskInW/S (biharmonic viscosity)
2173       - multiply horiz. grad of vorticity by maskInW/S (in Leith scheme)
2174       - multiply gradient of wVel by maskInW/S in del2w calculation (NonHyd)
2175       Motivation: fix/clean implementation of OBC with biharmonic-viscosity
2176        (and also with Leith/Smagorinsky harmonic-viscosity).
2177       Update output of experiment dome and exp4 (+nlfs).
2178    o exp4 test-exp:
2179      - turn on: nonHydrostatic, exactConserv, viscA4 (with momDissip_In_AB=F)
2180        and prescribe time-varying OB (without pkg/exf) for zonal-velocity
2181        at Western & Eastern Boundaries (+/- 1 per-cent); Also prescribe
2182        time-varying OB at Western-side for wVel (NonHyd); update output.
2183      - add secondary set-up (.nlfs) using NonLin FreeSurf (z*) + mom_vecinv
2184        and biharmonic-viscosity ; also use prescribed time varying OB.
2185    o pkg/obcs:
2186      fix bug in OBWeta,OBWeta indices in obcs_apply_r_star.F
2187    o model/src:
2188      - fix startTime setting when baseTime<>0 & nIter0=0 are specified ;
2189      - initialise startTime & nIter0 with unlikely values: allows to set one
2190        from the other without ambiguity.
2191    o seaice_obcs test-exp.:
2192      add small diffK4T,S to test biharmonic diffusivity with OBCS ; update output.
2193    o pkg/obcs:
2194      - remove calls to OBCS_COPY_TRACER after EXCH for T,S & pTracer:
2195        no longer needed with maskInC,W,S in pkg/generic_advdiff.
2196    o pkg/seaice:
2197      - retired SEAICE_SALINITY and SEAICE_salinity in favor of
2198        SEAICE_VARIABLE_SALINITY and SIsalFRAC, respectively.
2199      - fixed bug in the initialization of sea ice salinity variable HSALT
2200        in seaice_init_varia.F  (removed dependence on ICE2WATR)
2201    o fizhi-cs test exp.:
2202       switch reference output convention for these 2 non-standard test-exp,
2203        from: pgi  6.1-5 on faulks (FC.6, -of linux_ia32_pgf77+authors_fc5)
2204          to: ifort 11.1 on baudelaire (FC.13, -of linux_amd64_ifort11)
2205       reason: faulks might get retired soon and pkg/fizhi has still Pb with gfortran
2206    o model/inc:
2207      - change type of PmEpR array (from _RS to _RL) to fix restart (with "-use_r4")
2208        of exp. global_ocean.90x40x15 (Suncronous time-stepping + Real-FW + NonLin-FS)
2209    o pkg/seaice:
2210      - fix calculation of saltFlux and saltPlumeFlux when using SEAICE_SALINITY
2211    o verification/lab_sea, 1D_ocean_ice_column, seaice_obcs, global_ocean.cs32x15
2212      - updated output*.txt files due to bug fixes in salt, saltPlumeFlux,
2213        and initial HSALT
2214    
2215    checkpoint62w (2011/04/26)
2216    o pkg/mom_fluxform:
2217      - fix calculation of del2u & del2v (no-slip BC) when using Non-Lin Free-Surf.
2218      - use parameter "sideDragFactor" in no-slip BC side-drag part.
2219      - update output of exp. global_ocean.90x40x15
2220    o pkg/mom_vecinv:
2221      mask del2u & del2v (no effect on results, but cleaner & closer to mom_fluxform)
2222    o update seaice exp.:
2223      use more consistent parameter values (remove "backward compatability only":
2224       ICE2WATR, SEAICE_lhSublim, SEAICE_cpAir, SEAICE_rhoAir + set rhoConstFresh)
2225      related to thermodynamics seaice. Update output (fwd+AD) of exp.:
2226       1D_ocean_ice_column (x2), lab_sea (x8), ioffline_exf_seaice (x2) & seaice_obcs
2227    o update test-exp global_ocean.90x40x15:
2228      o use default CD_CODE_OPTIONS file (Adams-Bashforth on CD Mom & Coriolis).
2229      o increase Overlap size from 2 to 3 (to allow to test bi-harmonic Visc.)
2230      o new pickup-files from a 100.yr run with pkg/down_slope (input.dwnslp params)
2231      o turn on zStar & viscA4 in standard set-up (dir input/)
2232        and update output files: output.txt & output.dwnslp.txt
2233    o new AD-test experiment: obcs_ctrl
2234      (From Matt MITgcm_Contrib/SOSE/BoxAdj) to test OBCS as control vector.
2235    o pkg/dic:
2236      fix two bugs in handling water vapour pressure in carbonate chemistry
2237      and air-sea fluxes. Found by Val Bennington and Galen McKinley
2238      (add DIC Option = WATERVAP_BUG to recover old results)
2239      update output of tutorial_global_oce_biogeo (fwd+AD) & tutorial_dic_adjoffline
2240    o adding allowInteriorFreezing option to check for water below freezing point
2241      at depth and bring the negative heat anomaly to the surface level
2242    o pkgs _fields_load:
2243      - extend GET_PERIODIC_INTERVAL to deal with non-periodic case (from pkg/rbcs)
2244      - use new S/R GET_PERIODIC_INTERVAL in pkgs:
2245        bulk_force, cheapaml, cfc, dic, obcs (+ ctrl/ctrl_get_gen_rec), offline and
2246        rbcs to get interpolation weights and time reccord number.
2247      - fix multi-threading in aim_fields_load.F
2248      - apply EXCH to temp arrays [0,1] after reading in dic_fields_load.F
2249    o external_fields_load:
2250      new S/R GET_PERIODIC_INTERVAL to calculate which time-record (and linear
2251       interpolation weights) to use in a periodic time-series ; do not divide by
2252       time-step to convert to integer:
2253       - this fixes case where externForcingPeriod is not multiple of time-step
2254          (Thanks to Christopher L. Wolfe)
2255       - this fixes case where externForcingPeriod is an odd multiple of time-step
2256         (was wrong by half of time-step); update results of tutorial_global_oce_in_p.
2257      store index of time-record which is currently loaded:
2258       - works without any assumption on sequence of calls to EXTERNAL_FIELDS_LOAD ;
2259       - needed for the adjoint but not yet used because of extensive recomputations;
2260         (to be fixed soon)
2261    
2262    checkpoint62v (2011/04/02)
2263    o verification/1D_ocean_ice_column added to test Ian Fenty's
2264      pkg/seaice_growth.F modifications for improving sea ice code differentiability
2265    o update output of exp4, internal_wave, seaice_obcs, tutorial_plume_on_slope
2266      (new velocity statistics after changing maskInW & maskInS definition)
2267    o pkg/generic_advdiff with OBCS:
2268      use maksInW & maskInS in advective flux and in biharmonic diffusion calculation:
2269      equivalent to assumption of no tracer gradient outside the OB region.
2270      This will affect the results if using obcs+biharmonic diffusion.
2271      update output_adm.txt of experiment bottom_ctrl_5x5 (not expected since no obc)
2272    o pkg/obcs:
2273      change definition of maskInW & maskInS: leave OB edges inside (maskIn=1)
2274      (e.g., maskInW(OB_Ie)=1 ) so that velocity normal-component at OB is still
2275      in Interior region. No impact on solution but affects Velocity monitor stats.
2276    o pkg/ptracers (adjoint)
2277      New option AUTODIFF_PTRACERS_SPLIT_FILES for writing separate
2278      tape file for each tracer
2279    o model/inc/src and pkg/autodiff: add parameters that allow to turn
2280      of parts of the adjoint code at run time. For now, there are only
2281      useKPPinAdMode, useGMrediInAdMode, and useSEAICEinAdMode. These
2282      parameters are set in data.pkg.
2283      This is the lazy coward's version of doing this, but still useful for
2284      debugging. In order to do it right, everything needs to be moved to
2285      pkg/autodiff.
2286    o pkg/autodiff: fix global_sum_tile_ad.F by resetting adsumPhi at
2287      the end; this fixes the adjoint balancing code for open boundaries.
2288    o pkg/ctrl:
2289      - change behavior of xx_${varname}period to be analogous to exf-conventions:
2290        xx_${varname}period =   0.,  means time-independent control part
2291        xx_${varname}period = -12., means one-year-periodic monthly control part
2292      - introduce helper routine ctrl_init_rec (part of ctrl_init.F) to
2293        clean up ctrl_init a little, remove unused variables
2294      - ctrl_init: fixed the handling of the start/endrec for obcs-variables
2295      - move "call cal_GetMonthsRec" from s/r ctrl_get_gen to s/r ctrl_get_gen_rec
2296    
2297    checkpoint62u (2011/03/15)
2298    o model/src:
2299      - for the adjoint, change NonLin-FreeSurf initialisation sequence: fill-in
2300        h0Fac from INITIALISE_FIXED and reset hFac to h0Fac in INITIALISE_VARIA ;
2301      - in initialise_varia.F (except for ALLOW_DEPTH_CONTROL) remove 2nd call to
2302        INI_DEPTHS, INI_MASKS_ETC & INI_LINEAR_PHISURF.
2303    o pkg/ctrl/obcs/ecco:
2304      - remove obsolete, unused, and partially broken code:
2305        ctrl_obcsvol/ctrl_obcsbal/ctrl_volflux and code within
2306        ALLOW_CTRL_OBCS_BALANCE
2307      - put a stop statement into ecco/cost_obcsvol.F, but also add
2308        cost_obcsvol to ecco_ad_diff.list
2309    o pkg/ecco: fix counting cost function contributions for obcs (code
2310      by Matt M.) and diffkr for diagnostics
2311    o pkg/ecco, pkg/ctrl, pkg/grdchk:
2312      add cost penalty terms for initial uvel, vvel, eta controls
2313      and I/O for prior error files
2314    o pkg/mdsio:
2315       move mds_check4file.F from eesupp/src to mdsio_check4file.F ; add option
2316       (new argument) to check for tiled file in mdsioLocalDir : this fix the
2317       restart from pickup_som , pickup_dic (& dic_co2atm) with mdsioLocalDir.
2318    o pkg/ctrl:
2319     - ctrl_obcsbal.F, ctrl_obcsvol.F: replace last calls of ctrl_getrec by
2320       ctrl_get_gen_rec, put a stop statement into ctrl_getrec. Remove
2321       unused and superfluous variables
2322     - ctrl_get_gen_rec.F: catch the case of xx_genperiod=0.
2323    o pkg/ecco
2324     - enable adjoint of Stevens OB
2325    o pkg/ctrl/ecco/grdchk:
2326      - remove global declaration of tmpfldx/yz and tmpfldx/yz2.
2327        Fortunately, we do not have any tests for the numerous cpp-flagged
2328        option of "obcs as control parameters" so we will never know
2329        if this is an improvement (but at least now things compile).
2330      - remove an obsolete initialization from ecco_cost_init_barfiles.F
2331      - fix some problems within never used ifdefs to make the code compile
2332    o pkg/obcs:
2333     - Refine Interior mask definition to work with more complex OB (e.g.
2334       if OB_Ie < OB_Iw); In case default setting is not sufficient, allows to
2335       read in Interior mask from file. Check if Interior mask is consistent
2336       with OB list of indices.
2337    o pkg/seaice
2338     - beginning code for a seaice tracer package,
2339       but currently only used for seaice age: SEAICE_AGE
2340       SEAICE_num = 4
2341       iTracer = 1: area-weighted ice age
2342               = 2: volume-weighted ice age
2343               = 3, 4: template for one-year vs. multi-year ice
2344       data.seaice has new namelist SEAICE_PARM03 for arrays related to
2345       SEAICE_num
2346    
2347    checkpoint62t (2011/03/05)
2348    o pkg/obcs:
2349     - obcs_apply_uv.F: change to a 2 steps method, first tangential component;
2350       then normal component. This ensures that the normal component is set
2351       correctly even when it conficts with tangential setting from an other OB.
2352       Affects results of test-experiment seaice_obcs: update the output.txt
2353    o pkg/obcs:
2354     - add code to monitor statistics of dynamical fields at OB.
2355     - take OBCS_BALANCE code out of obcs_calc.F into new S/R OBCS_BALANCE_FLOW :
2356       - fix to OBCS_BALANCE code (right hFac ; deal with simple OB intersection).
2357       - change default: balance the Net inflow through all OB (instead of balancing
2358         each OB separately); keep the old method if setting OBC_balanceFacX < 0.
2359     - switch on useOBCSbalance in dome experiment: only correct Western OB outflow
2360       to match Nortern OB inflow (OBCS_balanceFacN=0).
2361    o pkg/seaice:
2362     - redefined actual sea ice age to be ICEAGE/HEFF ifdef SEAICE_AGE_VOL
2363    o pkg/seaice (seaice_growth v 1.113):
2364     - reverting seaice_growth to v 1.111 in order to have code with exact bit
2365       compatibility with MITgcm_contrib/ifenty/Fenty_seaice_thermo_code_merge
2366       CPP option SEAICE_OCN_MELT_ACT_ON_AREA removed in v 1.112 is reintroduced
2367       runtime flag SEAICEareaFormula is kept but is inactive
2368    o model/src:
2369     - add new param to scale curvilinear grid distance and area when using
2370       a different sphere radius from the grid-files.
2371     - test/check multi-threads EXCH applied to local variable (cg2d_x)
2372    o adjoint:
2373     - enable adjoint of Stevens OB
2374     - add dummy_in_dynamics to enable extraction of ADJrhoinsitu
2375       (a bit delicate because of potentially modified adj. common block structure;
2376       current switch is ALLOW_AUTODIFF_MONITOR_DIAG, could be changed later)
2377    
2378    checkpoint62s (2011/02/15)
2379    o pkg/seaice (seaice_growth v 1.112):
2380     - introduce SEAICEareaFormula run time parameter, which selects the recipe for
2381       computing the ice cover tendency from effective thickness tendencies. Include
2382       Ian Fenty's formula.
2383     - remove 'undef SEAICE_OCN_MELT_ACT_ON_AREA' which may now be achieved using
2384       SEAICEareaFormula.
2385     - simplify notations for the various d_HEFF/d_AREA terms.
2386    o pkg/gmredi:
2387     - add Boundary-Value-Problem bolus transport (Ferrari etal, OM 2010) code
2388       from Christopher Wolfe (UCSD); add partial cell factor in vertical derivative;
2389       add a verification test-run (front_relax.bvp) to test GM_useBVP.
2390    o pkg/seaice (seaice_growth v 1.111):
2391     - for SEAICE_DO_OPEN_WATER_GROWTH, replace Gael's implementation with Ian's.
2392     - the new SEAICE_DO_OPEN_WATER_MELT allows open-water air-sea heat fluxes to
2393       also melt ice.
2394    o pkg/seaice:
2395     - McPhee formula for Ice-Ocean fluxes (provided by Ian Fenty).
2396     - can be used by #define MCPHEE_OCEAN_ICE_HEAT_FLUX in SEAICE_OPTIONS.h
2397    o pkg/cheapaml:
2398     - from Nico Wienders: New version of this package.
2399    o pkg/flt:
2400     - add CPP options to prevent floats to re-enter the opposite side of
2401       a periodic domain (default: keep periodicity)
2402    o pkg/gmredi:
2403     - apply exchange to GM_PsiX,GM_PsiY to get valid values near CS-corners
2404       (needed for multi-dim advection).
2405     - switch on GM Advective form in global_ocean.cs32x15 and update output.txt
2406    o model/src:
2407     - fix wrong re-setting of addMass array (ALLOW_ADDFLUID) for atmospheric run.
2408    o tutorial_tracer_adjsens
2409     - extend to NLFS and replace maskC by hFacC
2410       (change reference output accordingly)
2411    
2412    checkpoint62r (2011/01/24)
2413    o testreport:
2414     - add option -deloutp (-do) to remove output file after successful run
2415     - add option -mfile (-mf) for MPI machile-file and for each test-exp,
2416       extract exact list of procs from this file ; adjust COMMAND by
2417       replacing TR_MFILE & TR_NPROC with local machile-file & Nb of MPI procs.
2418    o pkg/ecco: replace old ineffective way of penalizing deviations from
2419      first guess (of obcs) with code by Matt Mazloff
2420    o pkg/ctrl: add code that allows the use of ALLOW_OBCS?_CONTROL without
2421      exf/cal
2422      - ctrl_init: fix initialisation (computation of diffrec) for obcs-ctrl
2423        and handle case of obcs?period == 0
2424        Not affected by these changes: There is still an inconsistency in
2425        the computation of start/endrec for the obcs variables for ALLOW_CAL
2426        defined (see comment by Menemenlis, 7-Mar-2003)
2427      - make S/R ctrl_get_gen_rec return something meaningful even if
2428        ALLOW_CAL is not defined
2429      - ctrl_getobcs?: simplify code so that it does not need to use
2430                       S/R exf_swapfields
2431    o testreport:
2432       allow to test MPI with different number of processors for each experiment:
2433       create file "SIZE.h.mpi" in each build dir.
2434       Note: update of "-command" argument not yet implemented.
2435    o model/src, pkg/autodiff, pkg/ecco, pkg/seaice:
2436      alleviate the need for additional 3D tapes when using
2437      the non-inear free surface in the adjoint. This is done
2438      by adding an 'update' of hfacc etc. to their current
2439      value at the beginning of forward_step.F.
2440    o pkg/seaice
2441      seaice_lsr: move stress-divergence computations out of outer pseudo-
2442      timestepping loop
2443    o pkg/obcs/obcs_prescribe_read.F: move 'CALL OBCS_EXTERNAL_FIELDS_LOAD'
2444      up, so that the calls of the ctrl_* subroutines are really at the end
2445      of the routine.
2446    o pkg/gmredi:
2447      allow to specify a 2-D horizontal map and a 1-D vertical profil
2448      as scaling factor for Isopycnal diffusivity (Redi) and GM diffusivity.
2449    o pkg/seaice:
2450      move lsr iterations from seaice_dynsolver to seaice_lsr.
2451    o pkg/seaice:
2452      reduce memory footprint of seaice mutldim advection tapes,
2453      by using a 2D tape independent of the generic_advdiff ones,
2454      and setting GAD_AREA=1 etc. rather than GAD_AREA=101 etc.
2455    
2456    checkpoint62q (2010/12/29)
2457    o model/src:
2458      - check horizontal grid-spacing for unset or zero/negative values.
2459      - change AD test hs94.1x64x5 to be truly a 2-D set-up.
2460    o pkg/flt:
2461      - use (recent) mdsio S/R MDS_READVEC_LOC instead of local FLT_MDSREADVECTOR
2462      - precision of input and output files set according to readBinaryPrec
2463        and writeBinaryPrec (previously always 64.b), pickup remains at 64 bits.
2464      - initial float position from tiled file was not converted to index space
2465        (looks like a bug): fixed to make it similar to initial pos. global file.
2466    o global_ocean.cs32x15:
2467       change SIZE.h of AD set-up to get same tiling as with MPI.
2468       Update output_adm, output_adm.thsice (pass@14) & output_adm.seaice (fail@11)
2469    o model/src:
2470       add flag to control printing of domain fields (bathymetry, hFac ...) in
2471       ini_mask_etc (call to plot_fieds_xy*).
2472    o pkg/thsice:
2473       if useEXF, some forcing fields are not valid in overlap: fixed by computing
2474       over the interior only + apply EXCH at the end (like with SEAICE advection).
2475    o pkg/mdsio:
2476      - add 2 arguments to S/R MDS_PASS_R4/8toRL/S for overlap size of buffer
2477        to copy to/from, so that it can be used to replace MDS_PASS_WH_R8toRL/RS.
2478      - change barrier call for safe multi-threads access to 3-D shared buffer.
2479      - MDS_READ/WRITEVEC_LOC use buffers from MDSIO_BUFF_3D.h (instead of local ones)
2480      - replace call to MDS_PASS_WH_R4/8toRL with call to MDS_PASS_R4/8toRL and
2481        remove the 4 S/R MDS_PASS_WH_R4/8toRL/S.
2482    o pkg/flt:
2483      - add fourth-order Runge-Kutta integration
2484      - add basic exch2 support (only 1 facet supported so far!)
2485    o pkg/mdsio+rw:
2486      new S/R to read local (or tile independent) vector (read counterpart of
2487       mds_writevec_loc, and front-end write_glvec_rl/rs).
2488    o global_ocean.cs32x15: additional input_ad.seaice experiment
2489        that uses pkg/seaice rather than pkg/thsice.
2490        (using multidim advection for seaice)
2491    o towards more F95 syntax for array specification in namelist:
2492      - change "data.diagnostics" (data.ptracers was changed before checkpoint62p)
2493        of all verification experiments.
2494           e.g.:    line: fields(1,3)='ETAN    ','ETANSQ  ',
2495          was changed to: fields(1:2,3)='ETAN    ','ETANSQ  ',
2496      - finish adding "-DNML_EXTENDED_F77" to DEFINES list in pgf77 and g77 optfiles
2497    o global_ocean.cs32x15: additional input.seaice experiment
2498        that uses pkg/seaice rather than pkg/thsice.
2499    
2500    checkpoint62p (2010/12/17)
2501    o pkg/thsice: rename (ad tape index) iicekey as ticekey, and move it
2502        to THSICE_SIZE.h to avoid conflict with pkg/seaice.
2503    o pkg/seaice: add seaice_diffusion.f seaice_map_thsice.f to adjoint.
2504        allow for use of multim. advection in seaice adjoint.
2505    o pkg/seaice: add diagnostics for snow precipitation and sublimation flux
2506      - first attempt to close budgets by taking into account the freshwater
2507        flux implied by the sublimation of snow and ice. So far only the
2508        volume budget is closed, turn on with soon-to-be-retired-again CPP-Flag
2509        SEAICE_ADD_SUBLIMATION_TO_FWBUDGET
2510    o eesupp/src:
2511      new S/R with new option (NML_EXTENDED_F77) to change array specification
2512      from F95 standard to commonly accepted extended F77 form.
2513      This would allow to use F95 syntax in namelist (needed with gfortran 4.4.5)
2514      and to revert back to the original syntax (with -DNML_EXTENDED_F77)
2515      for less tolerant f77 compiler (e.g., pgf77, g77).
2516    o globalFiles:
2517      commented out in parameter file "data" since it's not safe with MPI
2518      (e.g., wrong on aces); keep it if useSingleCpuIO=T (but not doing much
2519      in this case); no longer commented out in restart test (tst_2+2).
2520    o add adTapeDir to specify a special directory where adjoint tapes are
2521      written/read (adread_adwrite.F). adTapeDir is specified in data/PARM05
2522      and cannot be used together with mdsioLocalDir.
2523    o nesting pkgs:
2524      - packages_init_variables : put call to OBCS_INIT_VARIABLES in last position
2525      - update Gianmaria's Nesting pkgs (from Contrib/nesting_sannino)
2526      - add parameter files + utils dir + output from short run on beagle.
2527    o pkg/seaice:
2528        fix seaice_growth.F store directives; update results of exp. lab_sea.ad
2529    o pkg/seaice: explicitly store tsurfloc in seaice_solve4temp.F to avoid
2530      unnecessary copying in adjoint code, requires new parameter NMAX_ITER
2531    
2532    checkpoint62o (2010/11/25)
2533    o pkg/exf:
2534      - change CPP option EXF_VERBOSE to run-time logical param exf_verbose.
2535    o pkg/seaice:
2536      - seaice_ocean_stress: split a loop for better vectorization of the
2537        adjoint code
2538      - seaice_growth.F: fix bug in conservation of freshwater connected to
2539        capping of heff, put contribution into d_HEFFbyNEG
2540      - replace irritating parameters SEAICE_latentWater/Ice and SEAICE_sensHeat
2541        by something more sensible (parameters that are what their name implies)
2542      - change some defaults, so that by default exf-parameters are used for
2543        things like rhoAir, cpAir,latent/sensible heat parameters, in order
2544        to reproduce the old results, many data.seaice now contain funny values
2545        for cpAir and latent heat of sublimation
2546    o packages_readparms.F: move exf_readparms up in line so that
2547        exf-parameters are visible for other packages (e.g. seaice)
2548    o debugMode & debugLevel=2:
2549      - differentiate between debugMode & debugLevel=2:
2550        debugMode: controls printing of debug messages (sequence of S/R calls).
2551        debugLevel: controls printing of algorithm intermediate results and stats.
2552      - remove "if debugLevel=2 => debugMode" but keep "debugMode =>  debugLevel=2";
2553        => allows to print debug-stats without all sequence of call messages.
2554      - switch control of debug print from debugLevel to debugMode in many S/R.
2555    o pkg/obcs (obcs-sponge):
2556        fix bug that was introduced on Oct 25 (in dynamics.F v1.151): put back the
2557        call to OBCS_PRESCRIBE_EXCHANGES (need to exch gU,gV when using obcs-sponge)
2558    o pkg/generic_advdiff:
2559      - record overlap minimum size for each advection scheme;
2560      - refine criteria on overlap minimum size;
2561      - check and stop (in gad_check) if overlap size is too small.
2562    o pkg/obcs:
2563      - with ptracers: remove multiple calls to obcs_apply_ptracer (only done
2564        once, in ptracers_implicit.F)
2565      - with seaice: remove test on empty file name in obcs_apply_seaice (always
2566        apply OB values when tile has OB)
2567    o model/src, coriolis setting:
2568      - integer parameter "selectCoriMap" (=0,1,2) replaces 3 logical
2569        useConstantF, useBetaPlaneF, useSphereF ; can now read coriolis from
2570        files (selectCoriMap=3) with any grid.
2571      - add parameter "fPrime" for constant second Coriolis coeff (default=0).
2572    o pkg/seaice/seaice_growth.F:
2573        a few cosmetic changes that reduce the number of lines of code
2574    o pkg/obcs: add boundary conditions following Stevens (1990)
2575      - the code follows old MOM/NAOSIM code
2576      - so far it is only implemented for the eastern and western boundaries
2577        and NOT for pTracers
2578    o pkg/rbcs:
2579      - replace rbcsInIter by rbcsForcingOffset, the time in seconds at the
2580        beginning of the first rbcs forcing period.
2581      - add option rbcsSingleTimeFiles that makes rbcs read forcing data like the
2582        offline package, i.e., one file per time, labeled by iteration number;
2583        deltaTrbcs sets the timestep with which the data was generated;
2584        rbcsIter0 is the forcing iteration corresponding to rbcsForcingOffset.
2585      - rbcsForcingCycle=0 makes forcing non-cyclic.
2586      - make arithmetic safe for negative times and odd forcing periods.
2587    
2588    checkpoint62n (2010/11/09)
2589    o pkg/seaice:
2590        fix masking in free-drift S/R ; update results of exp. lab_sea.fd
2591    o pkg/obcs:
2592       New S/R to copy tracer value from the OB location to narrow band region
2593        (width = same as overlap) beyond the OB: preserve OB value (needed for
2594        high-order scheme) which were overwritten by EXCH call if in overlap
2595        region. Applied to theta, salt, ptracer and advected seaice variables.
2596       With seaice: use maskInC in similar way as in gad_advection.F,
2597        in seaice_advection.F and advect.F.
2598       Update output of experiment seaice_obcs and change exp4 to test OBCS with
2599        4th order Adv.Scheme. for pasive salt and ptracer.
2600    o tools/genmake2:
2601      - when looking for an optfile (not specified), only search for Fortran compiler
2602        (remove sym-link test + setting of CPP + makedepend check + C-compiler check)
2603      - in get_fortran_c_namemangling: use "$CC $CFLAG" to compile C test programm
2604        (instead of "$MAKE genmake_test.o" since an existing Makefile can be wrong)
2605      - set default for CPP to "cpp -traditional -P" (was the case without specifying
2606        an optfile, but otherwise default was just "cpp".
2607      - comment out PLATFORM=$p_PLATFORM (no idea where p_PLATFORM comes from)
2608      - when "CC" is not set in the optfile, look for possible C compiler
2609        (instead of just setting CC=cc)
2610      - put back version v.169 modif (from 2008/02/15), was dropped in v.173 changes:
2611        => add a ".F" to ".o" rule for source files with no "#include" (such as
2612           port_rand.F); otherwise, default ignores FOPTIM and just uses FFLAGS.
2613      - move gfortran before g77 in list of possible Fortran compiler (consistent
2614        with reference compiler switch from g77 to gfortran)
2615    o pkg/seaice:
2616      o remove SEAICE_OLD_AND_BAD_DISCRETIZATION-code, add a test to
2617        seaice_check that stops the model, when the CPP flag is used.
2618      o seaice_growth.F: make capping of ice volume conserving by returning the
2619        capped ice as freshwater to EmPmR. This does not change the verification
2620        experiments but will change runs where the capping is acutally active
2621    o change reference platform+compiler from faulks+g77 to baudelaire+gfortran
2622      (except the 2 fizhi test exp.); update output of exp.: bottom_ctrl_5x5,
2623         global_ocean.cs32x15 (icedyn, thsice, AD thsice), global_ocean_ebm (AD),
2624         lab_sea (fd, hb87, salt_plume), MLAdjust (3/5) and vermix (dd)
2625    o tools/genmake2:
2626      - merge genmake_warnings & genmake_errors into 1 log file: "genmake.log")
2627      - change DUMPSTATE default to false (can use "-ds" option to switch it to T)
2628      - clean previous genmake log files before anything else.
2629      - change Makefile to remove testreport log files (*.tr_log) and genmake log
2630        files only with "CLEAN" target (instead of "Clean");
2631    o pkg/generic_advdiff:
2632      Change OBCS in multiDim advection (gad_advection.F):
2633       Use maskInC to prevent intermediate update of tracer-field in OB regions,
2634       thus keeping current-time-step OB values; and remove the call to OBCS_APPLY
2635       which were applying future time-step OB values.
2636      This way, all explicit calculations use current-time-step OB values
2637       (simpler and more consistent).
2638      Affects results when set-up uses time-varying OBC and multi-dim advection;
2639       update output of experiment seaice_obcs.
2640    o pkg/seaice:
2641      move OPTIONS (formerly locally defined) to SEAICE_OPTIONS.h:
2642       this includes SEAICE_GROWTH_LEGACY (+ SEAICE_DO_OPEN_WATER_GROWTH &
2643         SEAICE_OCN_MELT_ACT_ON_AREA ) and SEAICE_SOLVE4TEMP_LEGACY.
2644      Default (pkg/seaice/SEAICE_OPTIONS.h) is to define SEAICE_SOLVE4TEMP_LEGACY
2645       but leave SEAICE_GROWTH_LEGACY undef ; For now, keep verification exp
2646       unchanged (SEAICE_GROWTH_LEGACY defined in */code*/SEAICE_OPTIONS.h)
2647    o pkg aim (2010/10/26):
2648      - Introduce ALLOW_INSOLATION, moving toward a more general incoming solar radiation
2649        formulation with obliquity, eccentricity, ... as run-time parameters,
2650      - Introduce diagnostics for top-of-the-atmaophere incoming solar radiation and
2651        upward shortwave radition at the surface (all-sky and clear-sky).
2652    o pkg/obcs:
2653      - writing sections with globalFiles=T does not work: switch to tiled-files
2654        when writing sections for OBCS (change pkg/rw/write_rec.F accordingly).
2655      - fix index bug (OB_Ie -> OB_Iw_) in obcs_apply_uvice.F
2656      - apply OBCS_SEAICE_COMPUTE_UVICE to both uice and vice at all obcs
2657    
2658    checkpoint62m (2010/10/21)
2659    o pkg/seaice: vectorize seaice_solve4temp.F
2660      - move iterations loops outside of i/j-loops
2661      - requires 2D arrays for TB and effConduct
2662      - add 2D iceOrNot to replace HICE_ACTUAL.GT.0, as HICE_ACTUAL is
2663        modified in this routine
2664      - a little bit of clean up, adjusting indentation, etc.
2665      - replaced a few TEN**a by exp(a*log(10.)) in new code for better
2666        performance and '**TWO' by '**2' (because TWO is a float),
2667        replaced ONE, ZERO
2668    o eesupp/src:
2669       fix flow dir for exch1_z_RX_cube, exch1_uv_RX_cube & exch1_bg_RX_cube
2670    o pkg/seaice/seaice_growth.F
2671      Revision 1.89 of seaice_growth.F completes the overall october 2010 revision and
2672      merging process. The merged routine has two branches, and one activates the 'evolution'
2673      branch by setting SEAICE_GROWTH_LEGACY to undef (at the top of the routine for now).
2674      In summary, here is what the '10/10 revision' did consist of
2675        part 1: seaice_growth.F revisions 1.71 to 1.75
2676          - Preliminary seaice_growth.F clean-up, keeping test results strictly unchanged.
2677            The emphasis here was on improving readability (e.g. by trying to use meaningful
2678            variable names) and modularity (e.g. by adding arrays to store heff etc. updates).
2679        part 1.5:
2680          - revising the lab_sea experiment to make it a more useful (i.e. stable
2681            and representative of an actual model run). This was done by generating a
2682            (winter) pickup to start from, switching back the main experiment dynamic
2683            solver from evp to lsr, having one of the experiments use the free drift solution.
2684        part 2: seaice_growth.F revisions 1.76 to 1.85
2685          - Sorting out hard-coded constants that prevented heat and fresh water conservation.
2686          - Sorting out the various fields units and sign (set early on and reset at the end)
2687            to avoid numerous scalings/re-scalings. By v1.85 the basic unit for ice, heat and
2688            fresh water stock is 'effective ice meters', and >0 implies more ice/snow.
2689          - Using tendency terms arrays (d_HEFF* etc.) to alleviate remaining code locks,
2690            and simplifying logical expressions to further improve readibility.
2691        part 3: seaice_growth.F revisions 1.86 to 1.89
2692          - Re-organize the blocks of code more logically.
2693          - Merging the '_if.F' pieces that add something new.
2694    o pkg/thsice:
2695      - vectorize thsice_solve4temp and thsice_get_exf.
2696        Problem: thsice_solve4temp has an unvectorizable statement that
2697        might also be problematic for TAF
2698      - thsice_get_exf: add the ALLOW_BULK_LARGEYEAGER04 CPP-flag. This
2699        does not change the verifcation experiment, but will change all
2700        experiments that have this flag undefined (not tested in verification);
2701        a little reorganization to save a few 2D fields and recomputations
2702      - 1st step of revisiting thsice adjoint (major recomp. sorted out)
2703      - 2nd step:  fix some store dirs
2704        o seems to work somewhat, i.e. using ifort but not g77
2705        o likely cause are incomplete init. or recomputation
2706        o start verification/global_ocean.cs32x15/input_ad.thsice
2707    o pkg/obcs: add support for exch2
2708      - the position of the boundary and prescribed values are specified using
2709        a global domain with exch2 facets stacked
2710        - in x for N,S boundaries (like W2_mapIO=-1)
2711        - in y for E,W boundaries (so E,W boundaries do not overlap)
2712    o pkg/mdsio: add support for writing global sections with exch2
2713        file layout is as for obcs described above:
2714        - for x-z sections, facets are stacked in x (like W2_mapIO=-1)
2715        - for y-z sections, facets are stacked in y
2716    o pkg/thsice:
2717       - change a few routines for better vectorization: thsice_albedo.F,
2718         thsice_step_temp.F, and in thsice_calc_thickn.F. Results are
2719         not affected, but in particular the latter routine has changed
2720         dramatically (not necessarily easier to read now).
2721       - re-arrange calculation in THSICE_SOLVE4TEMP: move outside of i,j loops
2722       iteration loop and call to S/R THSICE_GET_BULKF & THSICE_GET_EXF.
2723    o verification/lab_sea:
2724      - overhaul of the forward model experiments. The main motivation
2725        for this revision is that lab_sea has proven quite fragile (when
2726        changing the sea-ice code, and switching platforms) to a point
2727        when failures were very hard to attribute to specific code problems.
2728      - the suspected reason for this fragility is noise amplification by evp so,
2729        to start with, we decided to replace evp with lsr in the main experiment.
2730      - the input.lsr experiment thus became obsolete and was removed.
2731      - it was replaced with the input.fd experiment that uses an
2732        analytical "free drift" solution as the ice velocity field.
2733      - Taken together, input (lsr), input.fd (free drift) and input.hb87 (evp)
2734        will hopefully allow us to discriminate problems due to dynamic solvers
2735        from problems due to the thermodynamic code. input.salt_plume (lsr) allows
2736        us to test additional options, along with the salt plume package.
2737      - Finally a pickup was generated (at the end of a one year run) to
2738        make the tests more representative of an actual model run. Previously
2739        the tests starting point was a 1m thickness of ice everywhere.
2740    o pkg/seaice:
2741      - introducing S\R seaice_freedrift.F that compute the
2742        analytical solution to an approximate ice momentum
2743        equation (i.e. the simple stress/coriolis balance).
2744      - define SEAICE_ALLOW_FREEDRIFT to trigger the computation
2745        of the free drift velocity field, and enable its use.
2746        To actually use the free drift solution as the model ice
2747        velocity field set SEAICEuseFREEDRIFT to .TRUE. in data.seaice.
2748    o move "useOASIS" from PARAMS.h to EEPARAMS.h and read it from "eedata"
2749    
2750    checkpoint62l (2010/10/04)
2751    o pkg/seaice:
2752      -fix the USE_ORIGINAL_SBI version (for variable freezing point);
2753      -use "celsius2K" in SEAICE_VARIABLE_FREEZING_POINT and in new
2754       version (with USE_ORIGINAL_SBI undef);
2755    o add hooks for new packages OASIS, the package will follow
2756      (hooks exclude the seaice pkg for now)
2757    o pkg/autodiff: ALLOW_AUTODIFF_WHTAPEIO
2758      Option to use mdsio_read_whalos.F/mdsio_write_whalos.F,
2759      rather than mdsio_readvector.F/mdsio_writevector.F, within
2760      adread_adwrite.F to read/write adjoint-related tapes to disk.
2761    o eesupp and pkg/mdsio: ALLOW_WHIO
2762      Option to write/read 2D fields to files including tiles halos.
2763      The main purpose is for adjoint related "tape I/O".
2764      The secondary purpose is for debugging phases.
2765      A word on those rather specifically intended purposes.
2766      The code was meant to be stripped down to the bare minimum.
2767      Typically, there is a unique and basic mapping to the global
2768      buffer (tile by tile, then proc by proc, then level by level), and
2769      byteswaps and meta-files are omitted. Indeed the (*_WH*) code is not
2770      meant to generate user friendly outputs of various shapes and forms.
2771      Rather it is intended, for the knowledgeabale developers,
2772      to be largely independent of the many mdsio options, to allow
2773      outputs of tiles+halos in debugging phases and in adjoint runs,
2774      and to allow some flexibility in tuning (adoint) I/O depending on each
2775      file system behavior. With regard to tuning, most of the potential knobs
2776      (to leave files open, to allocate the I/O indep. of usesinglecpuio,
2777      to specify directories, to specify the typical size of I/O calls, etc.)
2778      are not yet included, and will be added if they prove useful.
2779    o pkg/seaice:
2780       fix uninitialised arrays in USE_ORIGINAL_SBI version of seaice_solve4temp.F
2781    o pkg/seaice:
2782       new S/R seaice_solve4temp.F: this is the merged version of Ian Fenty
2783       code (seaice_budget_ice_if.F) which enable to recover old standard
2784       code (seaice_budget_ice.F) when option USE_ORIGINAL_SBI is defined.
2785       temporary: add "#define USE_ORIGINAL_SBI" at the top of seaice_solve4temp.F.
2786    o model/src (rStar):
2787       use simple average (not area weighted) of rStarFac at U,V point when using
2788       vectorInvariant and selectKEscheme=1,3 (consistent with mom. vertical advection)
2789       update output of exp. fizhi-cs-32x32x40 and fizhi-cs-aqualev20.
2790    
2791    checkpoint62k (2010/09/17)
2792    o adjoint
2793       * changed verification/global_ocean.cs32x15 ; adjoint now tests
2794         Adams-Bashforth 3 + NLFS + RSTAR
2795       * some more modifs required for ECCO-GODAE v4
2796    o pkg/seaice
2797       add SEAICE_AGE_VOL option to use volume instead of area for
2798       integrating SEAICE_AGE
2799  o model/src:  o model/src:
2800     first check-in of sigma & hybrid-sigma coordinate code ; also includes     first check-in of sigma & hybrid-sigma coordinate code ; also includes
2801     non-linear free-surface parts ; but pressure-gradient not yet coded.     non-linear free-surface parts ; but pressure-gradient not yet coded.
# Line 273  o tools/build_options: Line 3065  o tools/build_options:
3065      but keep the former optfile for few weeks for smooth transition      but keep the former optfile for few weeks for smooth transition
3066  o pkg/ecco  o pkg/ecco
3067    - allow user defined cost function contributions    - allow user defined cost function contributions
3068          CPP: ALLOW_USERCOST_CONTRIBUTION       CPP: ALLOW_USERCOST_CONTRIBUTION
3069          USAGE: compute contributions in cost_usercost_all.F       USAGE: compute contributions in cost_usercost_all.F
3070    - note: this is identical to what ALLOW_GENCOST_CONTRIBUTION once was.    - note: this is identical to what ALLOW_GENCOST_CONTRIBUTION once was.
3071        the two options are complementary.        the two options are complementary.
3072  o pkg/smooth  o pkg/smooth

Legend:
Removed from v.1.1295  
changed lines
  Added in v.1.1821

  ViewVC Help
Powered by ViewVC 1.1.22