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

Legend:
Removed from v.1.1271  
changed lines
  Added in v.1.1914

  ViewVC Help
Powered by ViewVC 1.1.22