/[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.1626 by jmc, Sun Mar 18 23:29:55 2012 UTC revision 1.1839 by mlosch, Thu Mar 7 08:34:26 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/seaice:
8      modify lsr-algorithm so that it vectorizes AND converges by using a
9      "zebra" method: split vector loop into two with step size 2; this
10      solves a general convergence problem for the JFNK solver on a vector
11      computer. It has the potential to even improve convergence for
12      non-vector machines, but it does change the results so it is turned
13      off by default. To turn on define CPP-flags SEAICE_VECTORIZE_LSR and
14      SEAICE_VECTORIZE_LSR_ZEBRA in SEAICE_OPTIONS.h
15    
16    checkpoint64e (2013/03/05)
17    o pkg/ecco and several verification experiments:
18       Remove special versions of the_model_main.F, the_main_loop.F, forward_step.F
19       from ecco package, and revert to unified routine in model/src/
20       Adjust verification experiments accordingly, especially gloal_oce_llc90
21       Should conclude long-standing work by Gael to reconsile the_main_loop with
22       ECCO and will enable OpenAD's revolve loop in ECCO setup.
23    o pkg/generic_advdiff:
24      - implement compressible flow method for multi-dim advection (similar to
25        gad_som_advect.F); add new option "GAD_MULTIDIM_COMPRESSIBLE" (since
26        TAF generates many recomputations) to use it; no yet coded with implicit
27        vertical advection.
28      - change experiment advect_cs (new output) and advect_xy (same output)
29        to test compressible flow multi-dim advection.
30    o pkg/generic_advdiff:
31      - fix SOM advection for unusual cases (linear Free-Surf in r*, other
32        cases where linear Free-Surf is not @ k=1, e.g., useShelfIce)
33    o pkg/seaice:
34      - fix bug in the no-slip implementation in seaice_calc_strainrates.F, this
35        bug affects two verification experiments (lab_sea and lab_sea.hb87),
36        recover old (wrong) results by setting noSlipFac = 2. in
37        seaice_calc_strainrates.F;
38      - add another averaging method for etaZ (etaZmethod=3), a mix of 2 and 0
39      - add runtime parameter SEAICE_JFNKepsilon for that finite difference
40        gradient in the Jacobian times vector operation (s/r seaice_jacvec)
41      - fix line search in seaice_jfnk.F (s/r seaice_jfnk_update)
42    o pkg/seaice: reorganize seaice_lsr.F to be able to reuse more code:
43      - new subroutines seaice_lsr_tridiagu/v
44      - introduce loop bounds i/jmin/max to be able to use a restricted
45        additive Schwarz method, but not used for now.
46      - rename SEAICE_CALC_LSR_COEFFS into SEAICE_LSR_CALC_COEFFS
47      - use new subroutines seaice_lsr_tridiagu/v in s/r seaice_preconditioner
48    o OpenAD support
49       Reorganize S/R call for overall time-stepping loop to facilitate
50       OpenAD revolve loop replacement
51       (new S/R main_do_loop.F)
52    o model/src:
53      - add 3-D array 3rd dimension to argument list of S/R ADAMS_BASHFORTH2/3;
54      - pkg/cheapaml: remove local S/R ADAMS2d and use instead standard S/R
55        ADAMS_BASHFORTH2.
56    o pkg/cheapaml:
57      - add new parameter (default=F, same as before) to disable full domain
58        (including land) periodicity in X & Y dir.
59      - new S/R CHEAPAML_COPY_EDGES to copy relaxation field into edges of
60        prognostics field ; merge the 2 S/R cycle_2d_tracer and timestep_2d_tracer
61        into single S/R CHEAPAML_TIMESTEP.
62    
63    checkpoint64d (2013/02/17)
64    o pkg/monitor (angular momentum):
65      - do not add Eta contribution to the total AM if using rigid-lid;
66      - correct for Adams-Bashforth in zonal-wind part (instead of in AM_eta).
67      - horizontal discretisation: compute Zonal wind contribution separately for
68        each component (instead of from cell centered averaged) and use the 4
69        grid-cell corner averaged value of Omega*(R*cos_Phi)^2 in AM_eta part.
70      - Check that AM is conserved with linear dynamics (momAdvection=F and linear
71        FreeSurf) if using vectorInvariant momentum.
72    o model/src (horizontal grid):
73      - move initialisation of all horizontal grid arrays to null value
74        from specific horizontal grid S/R to main S/R INI_GRID;
75      - add 2 new arrays to project model C-grid velocity on to zonal direction
76        (similar to AngleCosC & -AngleSinC but at U and V point location) and
77        compute them in S/R CALC_GRID_ANGLES.
78    o pkg/seaice: replace a hard coded parameter by a runtime parameter
79        SEAICE_JFNK_tolIter
80    o pkg/seaice: introduce a restricted additive Schwarz (RAS) method in
81        preconditioner for JFNK (run LSR into the overlaps as far as possible,
82        i.e OLx/y-2, but overwrite the solution in the overlaps)
83      - extend loop range in seaice_calc_viscosity
84      - add new parameters SEAICE_OLx/y (default = OLx/y-2)
85      - add flexible loop ranges to seaice_preconditioner, seaice_calc_lsr_coeffs
86      - slightly modify loops in tridiagonal solver lsr-preconditioner
87      - by default remove the extra exchange in seaice_preconditioner with a
88        replacement of an undocumented CPP flag by SEAICE_PRECOND_EXTRA_EXCHANGE
89      - modify offline_exf_seaice so that old results without RAS are reproduced
90        for output.dyn_jfnk.txt
91      in seaice_fgmres.F (unrelated to RAS)
92      - add a cpp-flag option for a re-ordered mapping (potentially more
93        efficient), but because this changes the results, turn it off by
94        default
95      - replace the save statement by local common blocks
96    o utils/matlab:
97      - fix tile-offset in rdmnc.m when output was produced using EXCH2.
98      - update cs_grid/bk_line scripts to use load_grid.m (in utils/matlab)
99        instead of local script "load_cs.m".
100    o pkg/seaice:
101      - fix a serious bug in seaice_fgmres.F, s/r seaice_scalprod, connected
102        to the scalarProductMetric and the unrolling. By chance this does not
103        change the verification experiment, because of the particular domain
104        decomposition
105    o pkg/diagnostics:
106      - change default missing_value from UNSET_RL to -999.
107    o pkg/layers: improve vectorization of layers_fluxcalc.F
108      - step 1: split loops, make TatU/V 2D arrays. This alone reduces the cpu
109        time spent in this routine by more than a factor of 3 on an NEC-SX8
110      - step 2: replace search algorithm by a bisection algorithm found in
111        Press et al. Numerical Recipes in Fortran. This algorithm can be
112        vectorized and finds the correct bin in approx. log2(Nlayers) steps.
113        For now, use this algorithm only for TARGET_NEC_SX defined.
114      - moved the search algorithm into a separate subroutine, that is kept
115        within the same file for automatic inlining.
116      - modified catching potential errors
117    o pkg/ecco:
118      - add compile switches ALLOW_SHALLOW_ALTIMETRY and ALLOW_HIGHLAT_ALTIMETRY.
119    o model/src, pkg/autodiff, pkg/ctrl, pkg/grdchk :
120      - modifications for ALLOW_GENTIM2D_CONTROL
121      -- forward_step.F, the_main_loop.F : pass options and arrays for adjoint tapes.
122      -- load_fields_driver.F : add call to CTRL_MAP_GENTIM2D( myTime, myIter, myThid )
123      -- add xx_gentim2d0/1 in ctrl_ad_check_lev1_dir.h checkpoint_lev1_directives.h etc
124      -- use ctrl_swapffields.F (new) instead of exf_SwapFFields.F in ctrl_get_gen.F
125    o model/src:
126      - account for moist thermodynamics in (dry) potential temperature equation;
127        update results of experiments: aim.5l_cs (x2), fizhi-cs (std + aqualev)
128        and cpl_aim+ocn.
129      - also switch to standard compiler (gfortran, was using ifort previously)
130        for fizhi-cs experiments reference output.
131    o pkg/ctrl:
132      - 1st step toward generic time-varying control variable (2D) via CPP option
133        ALLOW_GENTIM2D_CONTROL
134      - note new namelist ctrl_nml_genarr in data.ctrl
135    o verification/global_ocean.cs32x15:
136      - switch off OLD_THSICE_CALL_SEQUENCE (both forward and AD code) to use new
137        thsice calling sequence and update "output.icedyn.txt" output file.
138    o pkg/ptracers:
139      - from Ryan A.: code to allow to restart a tracer at regular time interval
140        specifying a reset frequency and a reset-phase (for each tracers).
141    o pkg/thsice:
142      - implement new sequence of calls for thsice+seaice:
143          previously:   ice-Dyn,ice-Advect,ice-Thermo(thsice)
144          new sequence: ice-Thermo(thsice),ice-Dyn,ice-Advect
145      - allows (with temporary CPP option "#define OLD_THSICE_CALL_SEQUENCE"
146        in CPP_OPTIONS.h) to recover old sequence;
147      - update diagnostics for Intermediate State thsice diagnostics: now filled
148        just before advection (instead of just after advection in old sequence);
149      - update output of experiment offline_exf_seaice (standard test);
150      - in global_ocean.cs32x15 exp., postpone output.icedyn.txt update
151        by setting #define OLD_THSICE_CALL_SEQUENCE in CPP_OPTIONS.h
152    o pkg/aim_v23:
153      - use tiled array for aim_CO2 and surface wind speed for export to coupler;
154      - use standard pkg/mdsio routines to read & write CO2 pickup file;
155      - in-line S/R AIM_AIM2DYN_EXCHANGES in aim_do_physics.F;
156      - Implement new sequence of calls for seaice advection (with thsice and
157        seaice diffusion): do ice advection after ice-Thermodynamic (previously
158        was done before); change aim_do_physics.F (split the bi,bj loops block);
159      - use same CPP option (OLD_THSICE_CALL_SEQUENCE) to recover old sequence;
160    o pkg/thsice:
161      - add a missing EXCH of sIceLoad in thsice_main.F (ocean set-up) for the case
162        where just seaice diffusion is used without seaice-dynamics.
163    
164    checkpoint64c (2013/01/18)
165    o pkg/seaice:
166      - add a parameter JFNKres_tFac that can replace JFNKres_t
167        (= JFNKres_tFac*JFNKresidual before JFNK solver)
168      - add a line search option to the JFNK solver
169      - move update of u/vIce and computation of initial residual into a separate
170        routine (same file); makes the code a little easier to read (?)
171      - the line search requires computation of the residual and for some reason
172        I cannot do the update of u/vIce at the beginning of the Newton loop
173        without changing the results, so we move computation of the new residual
174        also to the end of the Newton loop, even without the line search
175    o pkg/mdsio:
176      - write missing value (corresponding to undefined array value) to meta files;
177        skip this if missing value is one (UNSET_RL would be a better value for the
178        case of undefined missing value but it's current the default missing-value);
179        Also update mdsio_read_meta.F (reading timeInterval & missing-value).
180    o pkg/exf & thsice:
181      - for diagnostics purpose, fill-up and update Qsw array (+ fill the
182        diagnostics) even when SHORTWAVE_HEATING is #undef;
183    o verification/cfc_example:
184      - turn on pkg/layers with pkg/diagnostics (to test pkg/layers and to
185        illustrate how to use it).
186    o verification/offline_exf_seaice:
187      in input: add SEAICErestoreUnderIce=.TRUE., and reduce size of forcing
188        files to only one time-record.
189      in input.thermo: narrow the 2 bands of low initial ice-concentration near
190        N & S edges; switch on SEAICErestoreUnderIce=T; use pkg/diagnostics for
191        snapshot output; same mcPheePiston value as in thsice with
192        surf-current=0.2m/s.
193      in input.thsice: similar set-up as in input.thermo (channel with same seaice
194        initial conditions).
195    o verification/cfc_example:
196      - update file "data" with more standard choice (default rotationPeriod,
197        exactConserv=T, reduce ivdc_kappa to 10, remove multiDimAdvection=F,
198        set deltaTFreeSurf to deltaTtracer) and update the output.
199    o pkg/layers:
200      - fix bolus part so that it compiles with #undef GM_BOLUS_ADVEC;
201      - ensure that "layers_bolus" is switched to False when useGMRedi=False.
202    o verification/offline_exf_seaice:
203      - set all {field}period to zero for constant-in-time forcing (not tested
204        anywhere else).
205    o verification/offline_exf_seaice:
206      - dyn_lsr  : use pkg/seaice S/R (instead of pkg/thsice) to advect sea-ice;
207      - dyn_jfnk : use pkg/thsice S/R (instead of pkg/seaice) to advect sea-ice.
208    o model/src:
209      - implement Finite-Volume method for (hydrostatic) presure gradient
210        from S.-J. Lin (QJRMS 1997), for atmosphere using sigma-coordinate.
211    o pkg/seaice: implement EVP* by Lemieux et al. (2012).
212      - In order to be compatible with the default EVP code, this requires changing
213        the EVP code around a little; and because any small change immediately
214        breaks the lab_sea.hb87 verification experiment, the reference output is
215        updated two times (each time the remaining aggrement was only 2 digits):
216        - after replacing 1/dt by 1*recip_dt with a precomputed recip_dt
217        - after replacing 1/(1+0.5*dt/tau) by a/(a+1), with a=2*tau/dt
218        The adjoint test lab_sea.evp also needed to be updated.
219      - Turn on EVP* by setting SEAICE_deltaTevp as before, and setting
220        SEAICEuseEVPstar=.true.; for EVP* SEAICE_deltaTevp does not need to be
221        a factor of SEAICE_deltaTdyn, and you can set the number of EVP steps
222        explicitly with SEAICEnEVPstarSteps (thereby overriding the default of
223        INT(SEAICE_deltaTdyn/SEAICE_deltaTevp)). Controlling EVP* is deliberately
224        kept obscure, because I need to test it a little more.
225    o pkg/cheapaml:
226      - fix few incorrect type (_RL/_RS) in subroutine calls.
227    o pkg/seaice:
228      - new S/R SEAICE_MAP_RS2VEC (similar to SEAICE_MAP2VEC) to map _RS arrays
229        to _RL vector; this fixes JFNK code when compiling with "-use_r4" option.
230    o model/src:
231      - add a warning if using select_rStar=2 with nonlinFreeSurf <> 4;
232        change (in input_ad*/data) select_rStar from 2 to 1 for AD verification
233        experiments global_ocean.cs32x15 & tutorial_tracer_adjsens (+ update output)
234    o pkg/cheapaml:
235      - replace "273.1 _d 0" by celsius2K in pkg/cheapaml/cheapaml.F and
236        update output of experiment cheapAML_box.
237      - store in CHEAPAML.h coeffs ssq[0:2] for saturation specific humidity,
238        and set them only in one place (cheapaml_readparms.F).
239      - replace "273.16 _d 0" by celsius2K & replace "3.14159 _d 0" by constant "PI"
240      - remove re-setting of main-model parameter "celsius2K" (in cheapaml_readparms)
241        and re-setting of cheapAML params "lath" & "p0" (in cheapaml_init_varia).
242    o model/src/the_main_loop.F:
243      - fix revision 129 : need both ALLOW_ECCO and ALLOW_ECCO_EVOLUTION.
244    o pkg/seaice:
245      - remove legacy branch code.
246      - retire SEAICE_GROWTH_LEGACY and SEAICE_CAP_HEFF accordingly.
247    o verification/*/code*/SEAICE_OPTIONS.h:
248      - remove documentation for retired CPP flags (SEAICE_GROWTH_LEGACY,
249        SEAICE_CAP_HEFF).
250    o pkg/cheapaml:
251      - use standard routine (S/R GET_PERIODIC_INTERVAL) to decide when it is time
252        to load new forcing fields.
253      - add missing "_d 0" where it's needed; + some editing (improve indentation).
254      - remove switch to "-r8" compiler option (no longer needed) in verification
255        cheapAML_box, keep same output (small trucation error differences).
256    o verification/offline_exf_seaice:
257      - add thermodynamics only test.
258    o verification/cheapAML_box:
259      - split the domain in 8 (2x4) tiles; add MPI and multi-threaded test;
260        keep same output (same 14 digits for cg2d).
261      - switch on "-r8" compiler option (some numerical values are missing
262        the "_d 0") and update output (only 6 digits for cg2d were preserved).
263    
264    checkpoint64b (2012/12/24)
265    o pkg/cheapaml:
266      - remove un-used variables (Qnet,EmPmR) from pickup files.
267      - store tendency of advected variables into cheapaml pickup file
268        and fix the AB-2 restart.
269    o verification/offline_exf_seaice and lab_sea adjoint:
270      - switch to new code (#undef SEAICE_GROWTH_LEGACY).
271      - switch to 4 time steps in offline, consistent with lab_sea.
272      - match parameters from SEAICE_GROWTH_LEGACY branch in data.seaice.
273      - update results after change of experiment seaice.
274    o pkg/seaice:
275      - remove option SEAICE_MULTICATEGORY; has been replaced with run-time
276        parameter SEAICE_multDim. Issue a warning if SEAICE_MULTICATEGORY is
277        still defined since SEAICE_multDim needs to be set to MULTDIM value (from
278        SEAICE_SIZE.h) to recover previous #define SEAICE_MULTICATEGORY default.
279    o model/src:
280      - add run-time parameter to select CG2D solver minimum-residual solution
281        (in case of a poor convergence).
282    o pkg/seaice/seaice_lsr.F
283      - move calculation of matrix coefficients into new
284        S/R SEAICE_CALC_LSR_COEFFS; for now this routine remains in the same
285        file; the main purpose of this change is to be able to reuse the code
286        in S/R SEAICE_PRECONDITIONER
287      - modify the computation of the residual so that the mass of sea-ice
288        is not used twice; this simplifies the calculations, but since
289        the residual is never used except when LSR_mixIniGuess.ge.4---and this is
290        not tested in testreport---this does not affect the testreport results.
291    o verification/seaice_obcs:
292      - disable SEAICE_GROWTH_LEGACY; reset input files to match those of
293        verification/lab_sea/input.salt_plume; changes results/output.txt*
294    o model/src:
295      - adapt quasi-hydrostatic formulation to work with p or p* coordinate.
296    o pkg/seaice:
297      - improve description of parameters in seaice_fgmres.F and start
298        cleaning up the code
299      - change name of SCALPROD to SEAICE_SCALPROD and modify meaning of
300        second argument
301      - add a metric based on grid cell area to SEAICE_SCALPROD; update
302        results of offline_exf_seaice.dyn_jfnk
303      - compute initial residual norm in seaice_jfnk based on SEAICE_SCALPROD
304    o pkg/aim_v23:
305      - fix an other bug in dissipation heating (grid-cell area was missing).
306    o model/src + pkg/seaice:
307      - add global (multi-tile) linear solver for pair of tri-diagonal system
308        along X and Y lines, respectively for U and V component.
309        Note: 1) MPI and cube-exchange not yet coded.
310            2) probably not accurate for poorly conditioned / large size problem.
311      - add option for SEAICE_LSR to use global (multi-tile) tri-diagonal solver;
312        default: not compiled and not used.
313    o pkg/seaice:
314      - first attempt at a multi-threaded fgmres solver for the JFNK solver:
315        introduce bi/bj loops and use global_sum_tile_rl instead of
316        mpi_allreduce in seaice_fgmres.F
317      - improve diagnostics output for fgmres solver (seaice_fgmres.F)
318      - replace a few unnecessary goto statements by if-blocks  (seaice_fgmres.F)
319      - add a verification experiment for JFNK in offline_exf_seaice
320    o verification:
321      - change (for now, only fwd test) offline_exf_seaice experiment:
322        use a re-entrant channel with idealized coastline (trapezoidal shape)
323        at southern boundary to explore seaice dynamics and thermodynamics
324        with simple forcing. Main set-up has dynamics+thermo and SST relaxation;
325        secondary test (input.thsice) use thermodynamics only with SST relaxation.
326      - add seaice-dynamics only secondary test using LSR and pkg/thsice advection.
327    o pkg/exf:
328      - disable "sstExtrapol" when Nr=1
329    o verification:
330      - add new experiment "cheapAML_box" (simple 1 layer set-up from Bruno Deremble)
331        to test pkg/cheapaml.
332    o pkg/aim_v23 & pkg/shap_filt:
333      - fix dissipation heating (erroneous gravity multiplication factor).
334    o pkg/seaice:
335      - remove unused field pressPre from jfnk solver
336      - rename two subroutines in seaice_preconditioner.F
337    o eesupp/src:
338       - S/R MDSFINDUNIT avoids reserved unit numbers (scrUnit1, eeDataUnit ...)
339    o pkg/seaice/seaice_preconditioner.F: fix preconditioner once again
340       - remove wrong parts of the rhs and the lhs (were in there
341         because I did not understand the concept of this preconditioner)
342       - add an exchange between u- and v-sweep. This increases communication
343         by a factor of two but improves the convergence of jfnk. Ideally,
344         one would like the u- and v-sweep to be independent. So far within
345         undocumented ifdefs
346       - reorganize the extra computations for printing the residuals
347    o tools/genmake2:
348      - comment out the "mpif.h" include in NetCDF test programm (for MPI built)
349        since it's not necessary (and was preventing to use MNC in some cases).
350    
351    checkpoint64a (2012/11/16)
352    o pkg/autodiff:
353      - improve pkg-internal logical parameter switch (inAd/inFwd mode) so that
354        autodiff_readparms.F no longer depends on calling order (within
355        packages_readparms.F) and no longer requires to include ${PKG}_PARMS.h):
356        rename param turnFreeDriftInAdMode to SEAICEuseFREEDRIFTswitchInAd
357        and change param SEAICEuseDYNAMICSinAdMode to SEAICEuseDYNAMICSswitchInAd.
358    o pkg/obcs:
359      - adding tidal velocity forcing capability to obcs
360        for usage example, see verification/seaice_obcs/input.tides
361    o pkg/seaice:
362      - turn the LSR-relaxation parameters WFAU/V into runtime parameters
363        SEAICE_LSRrelaxU/V
364      - introduce runtime parameter SEAICEetaZmethod (=0 by default)
365    o pkg/aim_v23:
366      - implement heating from friction (bottom friction and stratospheric drag).
367    o pkg/shap_filt:
368      - fix diagnostic "SHAP_dKE" (was 2 time smaller); implement heating from
369        dissipation but only for Shap_funct=2, active when addFrictionHeating=T.
370    o model/src:
371      - move AddMass common block from DYNVARS.h to FFIELDS.h; allow to read-in
372        time-constant addMass field from file (addMassFile);
373      - support for heating due to friction (and Kinetic Energy dissipation):
374        add option, run-time switch and 3-D field array + support code ; each pkg
375        or S/R can add heating contribution (if there is a sink of KE); the sum is
376        accounted for as a Temperature tendency term (EXTERNAL_FORCING_T).
377    o pkg/seaice:
378      - complete merge of ITD code into seaice_growth.F
379        from MITgcm_contrib/torge/itd/code/
380        no verification so far, but Torge Martin tested
381        "1-D test case and Beaufort set up;
382        deliver okay results after 1 model year."
383      - complete merge of SEAICE_SIZE.h into all relevant routines
384      - move computation of eta at Z-points into calc_viscosities
385        + introduce global field etaZ
386        + add different methods for computing etaZ, for now the old
387          method (simple averages of eta to Z-points) is hardwired
388        + replace etaMeanZ by etaZ in seaice_lsr, seaice_calc_residual,
389          seaice_preconditioner
390      - simplify computations for SEAICE_ZETA_SMOOTHREG
391      - seaice_preconditioner:
392        + replace one remaining press by pressLoc (mistake)
393        + adjust printing of residuals
394      - improve I/O of diagnostics of JFNK in seaice_jfnk.F:
395        + add (SEAICE.h) and rename some counters (initiliased in
396          seaice_init_fixed.F)
397        + add _BEGIN/END_MASTER (myThid)  around print statements
398        + print total number of iterations and failures over SEAICE_monFreq
399          interval to STDOUT
400      - move control over output-messages by fgmres to seaice_jfnk to save
401        some operations
402      - move resetting initial guess for fgmres outside of seaice_fgmres_driver
403        in order to make restarts with sol .ne. zero (fgmres with restarts)
404        (seaice_jfnk.F, seaice_fgmres.F)
405      - seaice_calc_l/rhs.F: replace maskW/S by maskInW/S; this fixes
406        a serious convergence problem when open boundaries are involved
407    o pkg/ggl90: fix computation of control volumes for the case of
408      ALLOW_GGL90_HORIZDIFF (probably not used very often): move control volumes
409      up half a grid cell from C-centered to W-centered (pointed out by C. Eden)
410    o pkg/seaice: simplify seaice_evp by avoiding use of extra fields u/vIceC
411    o pkg/autodiff
412      - Add inAdMode switch for SEAICEuseDYNAMICS:
413        SEAICEuseDYNAMICSinAdMode
414        (extend logic in ADAUTODIFF_INADMODE_SET)
415    o pkg/seaice
416      - Step 1 of merging ice-thickness distribution (ITD) code from
417        MITgcm_contrib/torge/itd/ (author: Torge Martin)
418        The code implements concept laid out in Thorndike et al. (1975);
419        code is enabled via CPP flag SEAICE_ITD
420        nITD (in SEAICE_SIZE.h) defines number of ice thickness categories;
421        code is not complete yet!!
422      - SEAICE_SIZE.h now included in almost all seaice routines
423    o verification (using seaice):
424      - switch back seaice-dynamics (+ lower SOLV_MAX_ITERS) in ADM exp.
425        global_ocean.cs32x15.seaice ; update results.
426      - compile B-grid dynamics in FW test exp 1D_ocean_ice_column ;
427      - compile C-grid dynamics with #define SEAICE_ALLOW_JFNK in FW test exp
428        offline_exf_seaice (previously compiling B-grid).
429    o pkg/exf:
430      - fix some STOP conditions in exf_check.F (from Aug 28, modifs did not allow
431        to specify neither just 1 comp of wind or wind-stress, nor no surface momentum
432        forcing): just replace CPP option ALLOW_ATM_WIND with run-time param useAtmWind.
433    o pkg/layers (adjust changes from Sept 19):
434      - do snap-shot output and fill diagnostics from inside iLa loop (layers_calc.F)
435        this allows to remove "layers_maxNum" dimension from all layers arrays.
436    o pkg/layers (adjust changes from Sept 19):
437      - remove ALLOW_LAYERS_OUTPUT ; fix snap-shot and time-ave output ;
438      - snap-shot extended to all type of layers (not just the 1rst type);
439      - remove layers variables when corresponding CPP option is undef.
440    o pkg/layers:
441      - rename pkg/layers variable and add new output (layer exist & un-weighted
442        velocity in layer)
443    o pkg/seaice:
444      - simplify (?) ocean-drag coefficent computations by using
445        the same routine in all three solvers (saves some code lines)
446      - remove global fields DRAGA and DRAGS from C-grid code and
447        declare them locally in lsr.F (the only place where they are
448        still used)
449      - update AD output of lab_sea.evp (very sensitive anyway).
450    o pkg/seaice: add Jacobian-free Newton Krylov solver for ice dynamics
451      (Lemieux et al. 2010, 2012). Turn on with the usual SEAICE_ALLOW_JFNK
452      and SEAICEuseJFNK=.true. A few things to note:
453      - involves a FGMRES, that is parallel but very inefficient,
454        because of many scalar products (global sums) in the Gram-Schmidt
455        orthogonalization method. Needs to be replaced. Original code
456        from J.-F. Lemieux
457      - preconditioner for FGMRES is a stripped down version of LSOR
458      - SOLV_MAX_ITERS is now used for LSOR as a solver and as a
459        preconditioner. For the preconditioner, the default is set to 10.
460      - Jacobian times vector is computed with finite differences
461      - marginally related to JFNK-solver: add a smooth regularization for
462        zeta with tanh that will improve convergence (Lemieux and Tremblay,
463        2009) for any implicit solver (not implemented for EVP because EVP
464        does not need this regularization in the first place). Define
465        SEAICE_ZETA_SMOOTHREG in SEAICE_OPTIONS.h to use.
466    o eesupp/src:
467      - check in genmake2 that intrinsic S/R flush is available.
468      - add S/R to flush IO unit (if intrinsic S/R flush is available)
469      - flush standard & error msg unit before MPI termination
470      - if debugMode, flush IO unit after printing msg
471    o pkg/ctrl:
472      - ctrl_unpack.F, ALLOW_GENARR3D_CONTROL code: fix missing argument in call
473        to ctrl_set_unpack_xyz.
474    
475    checkpoint64 (2012/10/09)
476    o pkg/shelfice
477      - in mom_fluxform.F, mom_vecinv.F:
478        CALL SHELFICE_V_DRAG(bi,bj,k,vFld,KE,KappaRU,vF,myThid)
479        Bug fix KappaRU -> KappaRV
480        does not change verification/isomip but may change other setups
481        (presumably constant KappaRU=KappaRV)
482      - fix diagnostics SHIU/Vdrag (thanks to Tom Millgate)
483    o pkg/obcs:
484      - fixed some indexing bugs in obcs_seaice_sponge.F
485      - added obcs relaxation subroutines for HSALT and HSNOW
486      - changes verification/seaice_obcs/results/obcs_seaice_sponge.F
487    o pkg/seaice:
488      - add "multicategory" parameterization for snow in analogy to ice,
489        default is off for now.
490    o pkg/obcs:
491      - added obcs_seaice_sponge.F for obcs relaxation of seaice variables;
492        see verification/seaice_obcs/input.seaiceSponge for example application.
493      - remove local commom bloc "OBCS_GLOBAL" in obcs_readparms.F and do all the OB
494        index setting by master-thread. This fix multi-threads Pb in previous modifs.
495    o pkg/layers :
496      - add diagnostics to pkg/layers
497      - move the meat of pkg/layers from layers_calc.F to layers_fluxcalc.F
498        (from R.Tulloch). Layers_calc.F now calls layers_fluxcalc.F accordingly.
499    o pkg/generic_advdiff/gad_implicit_r.F :
500      - fix ADVr diagnostics in case of both implicit vertical advection and diffusion.
501    o pkg/seaice/seaice_growth.F:
502      - fix SItflux diagnostics in virtual salt flux + balanceEmpmr case.
503    o pkg/obcs:
504      - change default setting of OBCS_UVICE_OLD from defined to undef;
505      - use new parameter OB_indexNone for null index value (instead of hard-coded 0)
506        in all pkg/obcs code and in other pkgs; remove k loop in obcs_check_depths.F;
507      - pass OB_indexNone as (new) argument to S/R CTRL_MASK_SET_[X,Y]Z;
508      - change OB null index value (OB_indexNone) to -99 ; this fix the problem
509        with Southern & Western OB at a tile edge (at least in a simple set-up).
510    o pkg/obcs:
511      - change settings of OB index in case OB coincides with tile edge (shared by
512        2 tiles), so that common OB location is registered by both tiles (instead of
513        only 1). However, for Southern and Western OB, index value = 0 is not
514        recognized as valid OB index (=default null value) and needs to be fixed.
515      - modify accordingly OBCS_BALANCE_FLOW and OBCS_MONITOR (avoid double counting)
516      - new parameter "OB_indexNone" for null index value (for now, still zero)
517        to replace hard-coded null index value of zero.
518    o pkg/exch2:
519      - improve W2_USE_E2_SAFEMODE (faster) and W2_E2_DEBUG_ON:
520        always check buffer-size (but outside the loop); move checking for valid
521        index from W2_USE_E2_SAFEMODE to W2_E2_DEBUG_ON; in W2_E2_DEBUG_ON,
522        print each tile and point connection only if |W2_printMsg|>= 2 and 3.
523    o pkg/ctrl (pack & unpack):
524      - in ctrl_pack.F & ctrl_unpack.F, use the same local file-name variable
525        (locally defined) for different variables (+ remove the variable-specific
526        file name in CTRL_GENARR.h). For now, only implemented for GENARR2/3D_CONTROL
527        (to be extended to other local file names in ctrl.h).
528    o pkg/flt:
529      - add a FLT_Iter0 option (similar to PTRACERS_Iter0).
530    o pkg/mdsio:
531      - fix missing STOP in mdsio_readvec_loc.F (case ioUnit=0) when file is missing
532    o tools/genmake2:
533      - add similar dependences for target EXE_AD & EXE_FTL as we have for EXECUTABLE
534        (added by Alistair in version 1.51 for building without make depend);
535      - remove Header files list (H_SRC_FILES) from the dependence of targets
536         ad_input_code.f & ftl_input_code.f (not clear why it was added in the first
537        place in version 1.23): this save going through staf when unrelated header
538        file has been modified.
539       Note: for an intermediate target (e.g., ad_input_code.f or adtaf) without
540        "make depend" step, still need to do "make links" before "make adtaf".
541    o eesupp/src (+ few pkg src files) & genmake2:
542      - finish to remove ALWAYS_USE_MPI in source code that TAF does not see;
543      - no longer set ALWAYS_USE_MPI in Makefile (was done by genmake2).
544      - improve genmake2 checking for ALLOW_${PKG} in CPP_OPTIONS.h files (distinguish
545         upper/lower case ; account for space between "#" and undef/define)
546    o pkg/flt (with exch2):
547      - cleaning: fix so that it compiles; move remaining MPI calls out of flt_exch2.F;
548      - simplify threads synchronisation; fix (many issues) multi-threaded with MPI.
549    
550    checkpoint63s (2012/09/05)
551    o pkg/ecco:
552      - remove #ifdef ALLOW_SMOOTH_CORREL3D brackets.
553      - add more relevant #ifdef ALLOW_SMOOTH ones.
554      - sort out useAtmWind, useSMOOTH, ctrlSmoothCorrel2D.
555    o pkg/ctrl:
556      - CTRL_OPTIONS.h : document CPPs related to smoothing; ALLOW_SMOOTH_CORREL2D/3D,
557        ALLOW_CTRL_SMOOTH, ALLOW_SMOOTH_CTRL2D, ALLOW_SMOOTH_CTRL3D.
558      - ctrl.h : document run time params doInitXX, doMainPack, doMainUnpack, doPackDiag,
559        doSinglePrecTapelev (audodiff param!), ctrlSmoothCorrel2D (new) and
560        ctrlSmoothCorrel3D (new).
561        The added ctrlSmoothCorrel2D/3D replace the old ALLOW_SMOOTH_CORREL2D/3D CPP.
562      - ctrl_readparms.F : initialise ctrlSmoothCorrel2D/3D and read from namelist.
563      - ctrl_init.F ctrl_pack.F ctrl_unpack.F : switch off ustress/vstress
564        controls when useAtmWind, and vice versa.
565      - ctrl_map_ini_ecco.F : UVEL0, VVEL0, edtaux, edtauy cannot be smoothed as tracers.
566      - ctrl_get_gen.F : replace #ifdef ALLOW_SMOOTH_CORREL2D with
567          #ifdef ALLOW_SMOOTH, IF ctrlSmoothCorrel2D, IF useSMOOTH.
568      - ctrl_map_ini_gen.F : replace #ifdef ALLOW_SMOOTH_CORREL3D with
569          #ifdef ALLOW_SMOOTH, IF ctrlSmoothCorrel3D, IF useSMOOTH.
570      - ctrl_set_pack_xy[z].F, ctrl_set_unpack_xy[z].F:
571        replace ALLOW_SMOOTH_CORREL2D/3D brackets with ctrlSmoothCorrel2D/3D.
572    o pkg/smooth:
573      - remove un-necessary includes.
574      - remove ALLOW_SMOOTH*D and ALLOW_SMOOTH_CORREL*D brakets.
575        Those CPP options were never defined, and not necessary.
576    o model/src:
577      - fix CPP brackets in ini_mixing.F (GM_background_K belongs to gmredi).
578      - standard treatment of useSMOOTH.
579    o pkg/autodiff:
580      - add LOGICAL useGGL90inAdMode, useGGL90inFwdMode, useSALT_PLUMEinAdMode,
581        useSALT_PLUMEInFwdMode allowing to switch off ggl90 and salt_plume adjoint.
582    o pkg/exch2:
583      - add "if usingMPI" where it was missing (in exch2_rx?_cube*.template)
584        + start to remove ALWAYS_USE_MPI in source code that TAF does not see.
585      - make new S/R W2_MAP_PROCS out of w2_eeboot.F to setup exch2 CommonFlag
586        and tiles to process mapping.
587      - re-arrange 3 header files (W2_EXCH2_PARAMS.h, _BUFFER.h & _TOPOLOGY.h)
588        moving /EXCH2_FILLVAL_RX/ & /W2_EXCH2_COMMFLAG/ to W2_EXCH2_TOPOLOGY.h;
589        rename "exch2_tProc" to "W2_tileProc" and move seting of e2FillValue_RX
590        from w2_eeboot.F to w2_readparms.F.
591    o eesupp/src:
592      - set exchNeedsMemsync & exchUsesBarrier according to "usingMPI" (instead of
593        ALWAYS_USE_MPI) + moved from ini_communication_patterns.F to eeset_parms.F;
594        also move setting of exchCollectStatistics from exch_init.F to eeset_parms.F
595      - in eedie.F and all_proc_die.F, always call MPI_FINALIZE when ALLOW_USE_MPI
596        is defined (remove condition on usingMPI) to match cases where MPI_INIT
597        has been called.
598      - fix bug I put in previous modif of exch_sm_3d_rx.template (not much used);
599      - change default (non-MPI) value of myPid (from 1 to 0) to match MPI settings
600        (so that on 1 proc, get same myPid independently of usingMPI)
601      - add a stop if multi-procs but usingMPI=F ; stop also if usingMPI=T and
602        useCubedSphereExchange with EXCH-1 (safer).
603      - add "if usingMPI" where it was missing (+ start to remove ALWAYS_USE_MPI).
604    o pkg/ggl90:
605      - fix bug in filling corner mask array "mskCor" (FILL_CS_CORNER_TR_RL call)
606        used in ALLOW_GGL90_SMOOTH code.
607    o pkg/flt:
608      - fix typo in FLT_WITHOUT_Y_PERIODICITY (the effect was to ignore stopping
609        floats at the Southern end of the domain).
610    o eesupp/inc:
611      - add a list of CPP-options which can be set by Makefile (DEF_IN_MAKEFILE.h);
612        but not used (and not to be used) anywhere, just for documentation.
613    o pkg/autodiff, exf, ptracers & seaice (AD & TL output):
614      - comment out the very nasty "writeBinaryPrec = writeStatePrec" line, since:
615        a) can damage previously written records in any other multi-record files.
616        b) if needed, can easily do it cleanly, by calling S/R WRITE_REC_3D_RL/S.
617    o tools/genmake2:
618      - define variable MAKE within Makefile and use it in place of 'make';
619      - update AD_CONFIG.h (if needed) before building any of the executable
620        (forward, adjoint or tangent-lin); this involves a 2nd invocation of make;
621        and add the usual #ifndef/#define AD_CONFIG_H in AD_CONFIG.h;
622      - always print usual warning comment 'this file is automatically generated'
623        from script convert_cpp_cmd2defines (+ remove this warning from genmake2).
624    o pkg/cheapaml:
625      - updated to correspond to the code used in accepted paper (Nico Wienders).
626    o pkg/exf:
627        added run time switch useAtmWind to replace ALLOW_ATM_WIND cpp switch.
628        ALLOW_ATM_WIND now just sets the useAtmWind default (see exf_readparms.F)
629        and force defines ALLOW_BULKFORMULAE (EXF_OPTIONS.h).
630    o pkg/exf, autodiff, ctrl, ecco and seaice:
631        remove ALLOW_ATM_WIND brackets, or replace them with useAtmWind ones.
632    o pkg/ctrl, ecco:
633        allow to compile both ALLOW_U/VSTRESS_CONTROL and ALLOW_U/VWIND_CONTROL.
634        Depending on useAtmWind, one is inactive, and the other is active (see
635        exf_getffields.F/exf_getsurfacefluxes.F).
636    o tools/genmake2:
637      - improve error msg when failing in 2nd test of check_for_broken_Ff
638      - fix option '-makefile' short-name (-mf according to genmake2 -help)
639      - source local config file "genmake_local" just after processing the genmake2
640        command arguments (previously done before processing arg).
641    o pkg/grdchk:
642      - add a call to TURNOFF_MODEL_IO for Tangent-Linear run (in this case, call
643        to this routine from cost_final has been dropped in g_cost_final)
644      - improve printed information (more explicit msg, no longer using "print *,"
645         fix fcpertminus printed value).
646    o model/src:
647      - move call to COST_INIT_VARIA out of packages_init_variables.F directly
648        into initialise_varia.F (just after calling PACKAGES_INIT_VARIABLES):
649        this prevents getting cost-funct reset in adinitialise_varia recomputations.
650    o pkg/dic:
651      - move initialisation of "freefe" array from from dic_biotic_forcing.F to
652        fe_chem.F: this prevents TAF from dropping this initialisation in TLM code.
653    o pkg/grdchk:
654      - grdchk_main.F : added CALL GLOBAL_SUM_INT( ierr , myThid )
655      - grdchk_getadxx.F etc. : omit I/O if ierr.EQ.0
656    o pkg/autodiff/ctrl/grdchk :
657      - attempt to sort out what works and what does not,
658        with regard to I/O, and to warn/stop accordingly.
659    o pkg/grdchk:
660      - attempt to fix grdchk in the case of useSingleCpuIO.
661      - "if ( myProcId .EQ. grdchkwhichproc .AND. ierr .EQ. 0 )"
662       statements were moved from grdchk_main.F and into
663       grdchk_getadxx.F grdchk_getxx.F grdchk_setxx.F.
664      - a global sum is applied to record numbers icvrec/layer
665       out of grdchk_loc so that they be passed to I/O routines.
666    o pkg/smooth:
667      - fix recomputation that appeared with nlfs : use smooth_recip_hFacC,
668        smooth_hFacW, smooth_hFacS (copied at init_fixed) in 3d case.
669    o verification/testreport:
670      - add option '-tlm' for Tangent-Linear test (-adm,-oad,-tlm are all exclusive);
671      - can also use compressed (gzip) reference output file;
672      - change format (in pkg/grdchk) of TLM output (+ add forward gradient)
673        to be easier to collect by testreport.
674      - update existing TLM output (half out-of-date by more than 3 yrs).
675      - report NETCDF & LAPACK settings (from genmake2) in output dir.
676      - report run-time in each individual summary (previously only for AD test);
677        for TLM test, add also TAF version.
678      - add daily TLM test on (old) aces cluster + weekly test on baudelaire.
679    
680    checkpoint63r (2012/08/15)
681    o tools/genmake2:
682      - fix Makefile for target ftlall (+ update files to clean after make ftlall)
683    o pkg/ecco/ecco_cost_final.F :
684      - fix fc print statements (to stdout and costfunction0000) so
685        that the printed value is always after the global sum.
686    o pkg/seaice/seaice_dynsolver.F :
687      - fix ice strength assymptote at SEAICE_area_max<1
688        (no change for the standard case of SEAICE_area_max=1)
689    o some cleaning:
690      - pkg source files: ensure that all *.F files from each pkg included the
691        corresponding ${PKG}_OPTIONS.h file (except stand-alone src file which
692        only includes CPP_EEOPTIONS.h); fix S/R CTRL_SMOOTH ; update AD experiment
693        code_ad/*.F src files; add new option-file in pkg/admtlm + corresponding
694        includes;
695      - model/src: add PACKAGES_CONFIG.h wherever ALLOW_AUTODIFF[_TAMC] is used.
696      - ALLOW_DIFFKR_CONTROL: add a stop in S/R CTRL_CHECK in case ALLOW_3D_DIFFKR
697        is undef; also define /DYNVARS_DIFFKR/ common block in DYNVARS.h when
698        ALLOW_DIFFKR_CONTROL is defined, to allow to compile and reach this stop.
699      - update option-file CPP_OPTIONS.h of all AD experiments:
700        * no longer include PACKAGES_CONFIG.h ;
701        * includes ECCO_CPPOPTIONS.h if PACKAGES_CONFIG.h has been included ;
702        * def/undef ALLOW_3D_DIFFKR independently of ALLOW_DIFFKR_CONTROL (before
703          including ECCO_CPPOPTIONS.h).
704    o pkg/cost, pkg/ctrl, pkg/ecco option-file:
705      - clean-up and split content of old pkg/ecco/ECCO_CPPOPTIONS.h file into
706        separated pkg option-file (done according to old doc from ECCO_CPPOPTIONS.h,
707        not necessary accurate).
708      - add a template for option-file ECCO_CPPOPTIONS.h, mostly empty, in
709        pkg/autodiff, i.e., the 1rst pkg to compile for adjoint built, with lines to
710        deliberately break compilation (a remainder that it needs to be customized)
711      - in pkg/ecco, includes ECCO_OPTIONS.h instead of COST_OPTIONS.h
712      - rename COST_CPPOPTIONS.h to COST_OPTIONS.h
713      - rename CTRL_CPPOPTIONS.h to CTRL_OPTIONS.h
714    o tools/genamke2:
715      - check for lapack.
716    o pkg/cost and pkg/ecco : attempt to sort out some of the limiting intricacies.
717      - pkg/cost.cost_final.F : allow for use of pkg/ecco and pkg/cost cost functions
718        jointly. The exclusive ifdefs were removed, to add costs terms (when defined)
719        from both packages.
720      - the fc global sum in pkg/ecco/ecco_cost_final.F was removed accordingly.
721      - for objf_atl we use either the pkg/ecco or the pkg/cost term depending on CPPs.
722      - pkg/ecco and model/src : add CPP brackets around pkg/cost and pkg/ctrl includes
723        of "CTRL_SIZE.h" "ctrl.h" "ctrl_dummy.h" "optim.h" / "cost.h" accordingly.
724    o pkg/cost : add comments to explain special and/or untested setups.
725    o pkg/exf:
726      - use EXF_OPTIONS.h to set pkg/exf options except if done in ECCO_CPPOPTIONS.h
727        (previously, ALLOW_AUTODIFF_TAMC was controling this switch).
728    o verification/*/code_ad:
729      mimimal cleaning of AD experiments ECCO_CPPOPTIONS.h option-file:
730      - reccord when this file is included (define ECCO_CPPOPTIONS_H)
731      - remove the most obvious obsolete features (e.g., #define ALLOW_COST not
732        allowed since Oct 2003 in any option-file except in PACKAGES_CONFIG.h)
733    o pkg/seaice :
734      - added possibility to change ice strength/PRESS0 relationship to
735        HEFF, according to the following run time parameters
736        SEAICEpresPow0 :: HEFF exponent for ice strength below SEAICEpresH0 (integer, >0)
737        SEAICEpresPow1 :: HEFF exponent for ice strength above SEAICEpresH0 (integer, >0)
738        SEAICEpresH0   :: HEFF threshold for ice strength            (m)
739    o pkg/ggl90 :
740      - added run time flag mxlSurfFlag to include the code that ensure
741        mixing between first and second level (previously included as a comment)
742    o verification/1D_ocean_ice_column/input_ad/data.autodiff :
743      - add test of newly added dumpAdByRec=T option where
744        we write all records to one file per variable.
745    o verification/global_ocean.cs32x15/code_ad/CPP_OPTIONS.h :
746      - switch to #define ALLOW_BALANCE_RELAX and ALLOW_BALANCE_FLUXES
747        to check that this code is ok with taf and compiles in adjoint.
748    o pkg/autodiff :
749      - added run time param dumpAdByRec : ad dump format switch.
750        If true then write all records to one file per variable.
751        Else write one file per record (remains the default).
752      - revise seaice_ad_dump.F and exf_adjoint_snapshots_ad.F accordingly.
753    o pkg/seaice:
754     - Added SEAICEuseTILT run time switch : if set to
755       false then omit the tilt term in seaice dynamics.
756     - Fix free drift calculation.
757    o pkg/shelfice:
758      When initializing SHELFICEDragQuadratic, set default to be
759      consistent with shiCdrag in case SHELFICEuseGammaFrict is used,
760      but retain option to set it independently
761      (inconsistenty spotted by Veronique Dansereau)
762    o eesupp/inc:
763      - in EEPARAMS.h, add real-type constant for some frequently used simple number
764         (0,1,2,1/2), with name explicitly referring to RS/RL type.
765    o model/src:
766      - move balancing of relaxation terms to new S/R balance_relax.F.
767    o pkg/autodiff:
768      re-write active I/O high-level (control) S/R:
769      - rename  S/R ACTIVE_READ/WRITE_RL to ACTIVE_READ/WRITE_3D_RL
770      - add 1 more argument (useCurrentDir) to replace the "_LOC" 2nd set of S/R.
771      - use standard pkg/mdsio I/O routines (MDS_READ/WRITE_SEC_XZ/YZ  and
772        MDS_READ/WRITE_FIELD); change loops to multi-threads.
773      - update and merge active_file_control_slice.flow into active_file_control.flow
774      - update the calls in lower level S/R (active_file.F, active_file_g.F and
775        active_file_ad.F) keeping the argument list and function unchanged.
776      - also update lower-level "_LOC" version (call same S/R with "useCurrentDir
777        =.TRUE.") and remove high-level (control) _loc version (not called anymore).
778      - new low-level active I/O routines, one for each type (RL/RS), for active var
779        of various (XY,XZ,YZ) shape and level number (arguments: arrShape, myNr);
780        fix ctrl_init_wet.F & ecco_cost_weights.F by calling the new S/R with the
781        right type.
782    o autodiff and RS=real*4:
783      - call the right type (_RS instead of _RL) of S/R in few output S/R (pkg/exf
784        ad-monitor and snapshots); disable arrType='RS' in mdsio_gl*.F ;
785      - change argument type of 3-D mask argument to _RS to match type in the call
786        (in seaice_cost*.F, ctrl_*_gen.F and *ctrl_bound.F); to be continued.
787    o pkg/thsice:
788      - re-anable balanceEmPmR when useSEAICE=T with useThSIce=T.
789      - option to correct ocean fresh-water flux for imbalance of Atmos+Land
790        fresh-water flux: uniform correction or proportional to local precip.
791    o pkg/ctrl:
792      - new header file CTRL_SIZE.h for parameters maxCtrlArr2D, maxCtrlArr3D
793      - redefine CPP option ALLOW_BOTTOMDRAG_CONTROL to
794                            ALLOW_BOTTOMDRAG_CONTROL_NONGENERIC
795      - verification/hs94.1x64x5/ tests ALLOW_GENARR{2D,3D}_CONTROL
796    
797    checkpoint63q (2012/07/30)
798    o pkg/autodiff:
799      note about monitor and snap-shot of ad-variables:
800      a) need to apply ADEXCH before monitor or output of ad-vars to include
801       overlap contributions (was done for adjDump but missing for monitor).
802      b) since ADEXCH implies adding overlap values to interior array, machine
803       truncation error is expected when adding an ADEXCH call in the middle of
804       the time-stepping (although mathematically identical).
805      modifs:
806      - fix some incorrect type (RL/RS, UV/scalar) in ADEXCH calls and ad-vars
807        declaration (adEddyPsiX,adEddyPsiY in adcommon.h).
808      - add new run-time params (dumpAdVarExch & mon_AdVarExch) to select how  to
809        apply ADEXCH before monitor or snap-shot of ad-variables:
810           =0 : no ADEXCH ; =1 : do ADEXCH ; =2 : apply ADEXCH on a local copy.
811      - implement new method (copy+adexch) for snap-shot and monitor of main model
812        ad-vars (initially not used by default -> output unchanged).
813      - change default (set to 2) to use new method and update few output_adm.txt
814        with accurate ad-monitor (global_ocean.90x40x15, tutorial_global_oce_biogeo
815        and both tutorial_tracer_adjsens tests).
816      - switch 2 global_ocean.cs32x15 AD-tests to AB-2 (seaice_dynmix & thsice)
817        and turn off momDissip_In_AB in the 2 other (needed for stable AB-3).
818    o pkg/ctrl:
819      enable the use of a variable number (maxCtrlArr2D, maxCtrlArr3D) of
820      generic control variables via
821      #define ALLOW_GENARR2D_CONTROL and/or #define ALLOW_GENARR3D_CONTROL
822      Only required customization should be S/R ctrl_map_ini_genarr.F
823      (routine in repository contains example)
824    o pkg/exf:
825      - fix and refine checking of surface-relaxation setting when using EXF
826    o verification (adjoint exp):
827      - reduce length of simulation by half for experiment global_ocean.cs32x15
828        (std, seaice & seaice_dynmix) and exp tutorial_dic_adjoffline; update output.
829    o pkg/mom_common (mom_u/v_bottomdrag), pkg/shelfice (shelfice_u/v_drag)
830      - replace if statements KE.ne.0 with KE.gt.0 to avoid sqrt of negative numbers
831        of KE that can occur with aggressive optimization
832      + put quadratic bottom drag calculation in separated loops (only done if
833        using bottomDragQuadratic)
834    o model/src: CG2D_NSA
835      - clean-up:  stop if cg2dNormaliseRHS=T and AUTODIFF
836         and replace GLOBAL_SUM calls with GLOBAL_SUM_TILE.
837      - in test-exp that uses CG2D_NSA (bottom_ctrl & tutorial_tracer_adjsens),
838         change cg2d residual target to be expressed in Wunits (=> do not normalise
839         RHS ; this fix global_max Pb with TAF); update output.
840    o verification/tutorial_tracer_adjsens:
841       improve parameter consistency (and get rid of warnings):
842       - use deltaTFreeSurf=deltaTtracer (better with NonLin FreeSurf);
843       - switch Temp Adv Scheme from 81 to 80 (no limiter since theta < 0 is physical)
844       - use staggerTimeStep (for stability) in som81; use default rotation period.
845    o pkg/exch2:
846      - with empty facet: fix compact-format (W2_mapIO=1) definition (was previously
847        reset to 0 = 1 long line in X)
848    o pkg/mdsio:
849      - fix reading of dimensions from meta file for large-size domain
850    o model/src:
851      - fix saltIsActiveTr setting for IdealGas eosType (eosType is 6 character long);
852      - to refine CS-grid check, add logical flag "hasWetCSCorners": true if using
853        Cubed-Sphere Exch with CS-corners inside the domain;
854        make new S/R INI_GLOBAL_DOMAIN from code in ini_linear_phisurf.F to calculate
855        globalArea and to set hasWetCSCorners.
856      - add warning if usingCurvilinearGrid and momAdvection in flux-form (missing
857        metric terms); stop if hasWetCSCorners=T and momAdvection in flux-form.
858      - re-activate the stop if useCDscheme and hasWetCSCorners=T (previously if
859        useCDscheme and useCubedSphereExchange).
860    o pkg/seaice/seaice_growth.F :
861      - compute the SEAICE_DISABLE_HEATCONSFIX term accordingly
862        for the (.NOT.useRealFreshWaterFlux).OR.(nonlinFreeSurf.EQ.0)
863        when the previous code was not correct.
864      - in all cases diagnoze the boundary condition mismatch to SIaaflux
865      - in the case of useRealFreshWaterFlux.AND.(nonlinFreeSurf.GT.0) add
866        that term to QNET (essentially to set the melt/freeze water to 0degC).
867        when SEAICEheatConsFix is true, so that the ocean+ice budget heat is closed.
868    o verification/global_ocean.cs32x15/input.seaice :
869      - add SEAICEheatConsFix in data.seaice, ensuring closed ocean+ice heat budget.
870      - add diagnostics (commented out) for budget test using my matlab codes (gcmfaces).
871      - update results (output.seaice.txt) accordingly.
872    o verification/lab_sea/input/data.seaice :
873      - remove SEAICEheatConsFix, which is now be tested
874        in global_ocean.cs32x15. The presently coded fix
875        is only consistent with real fresh water + nlfs.
876      - update results (output.txt) accordingly.
877    o pkg/salt_plume: added diagnotic for salt tendency (oceSPtnd).
878    o AD_CONFIG.h file:
879      - in genmake2: remove "#undef ALLOW_ECCO_OPTIMIZATION" from AD_CONFIG.h;
880      - remove #include "AD_CONFIG.h" from all included OPTIONS files and
881        add it explicitly in each fortran src file where it is needed.
882        motivation: header file AD_CONFIG.h is generated/modified after "make depend"
883        thus introducing potentially wrong dependency; therefore, better to include
884        it only where it's really needed, and after any other included OPTIONS file
885        (less tempting to bring conditional includes according to ALLOW_ADJOINT_RUN
886        or ALLOW_TANGENTLINEAR_RUN).
887    
888    checkpoint63p (2012/07/06)
889    o pkg/autodiff:
890      - rename S/R INI_AUTODIFF to AUTODIFF_INIT_VARIA ;
891      - create new header file "AUTODIFF_PARAMS.h" for pkg/autodiff parameters
892        which are now read from new parameter file "data.autodiff" (inAdExact
893        previously in "data", use{KPP/GMRedi/SEAICE}inAdMode previously in data.pkg)
894      - add file "data.autodiff" in all verification/*/input_ad/ directories.
895      - add run-time parameter to turn On/Off SEAICEuseFREEDRIFT in adjoint/forward
896        mode (used in global_ocean.cs32x15.seaice_dynmix test exp.)
897    o verification/tutorial_tracer_adjsens/
898      - add extra sub-verification which uses "SOM" advection scheme
899        (2nd Order-Moment Advection Scheme, Prather Limiter) with
900          #define GAD_ALLOW_TS_SOM_ADV in GAD_OPTIONS.h
901        and in data:
902          multiDimAdvection=.TRUE.,
903          tempAdvScheme=81,
904          saltAdvScheme=81,
905    o model/src:
906      - introduce ALLOW_BALANCE_RELAX which allow the removal
907       of the global mean of relaxation terms by setting
908       balanceThetaClimRelax and balanceSaltClimRelax
909      - disable balanceEmPmR and balanceQnet in the case when useSeaice.
910       This case is now treated appropriately in seaice_growth.F
911    o pkg/seaice:
912      - do balanceEmPmR and balanceQnet based on the net fluxes
913        (SItflux) that enter the ocean+ice system rather than QNET
914        and EMPMR. Works best in real fresh water.
915      - SIatmFW, SIatmQnet, and SItflux computations had to be moved
916        out of the diagnotics bloc, and stored in global arrays.
917    
918    checkpoint63o (2012/06/29)
919    o vertical mixing schemes:
920      - remove unused S/R CALC_BUOYANCY (left from branch-atmos merging)
921      - replace computation of density (in Function STATE1, opps_calc.F) by a call
922        to S/R FIND_RHO_SCALAR
923      - pass sigmaR to S/R PP81_CALC, MY82_CALC (but not yet used) and to GGL90_CALC
924        and use it for N^2 calculation in ggl90_calc.F (save 2 density computations);
925        affects output (vermix.ggl90) at truncation level.
926    o testreport:
927      - change adjustment of SIZE.h for mpi+mth testing: preserve enough tiles
928        (nSx,nSy) for the number of threads (from eedata.mth)
929    o model/src:
930      - remove 2nd set of calls at the top of initialise_varia.F (Adjoint part)
931        related to Non_Lin Free-Surf or Bottom-Control (but not longer necessary).
932    o verification/tutorial_tracer_adjsens/
933      - compile with ALLOW_CG2D_NSA
934      - run with nonlinFreeSurf=3
935      - update reference output_adm.txt
936    o tools/genmake2:
937      - add "-DHAVE_NETCDF" to the DEFINES list when NetCDF is available ;
938        refine usePROFILES switching off (only when NetCDF is not available).
939    o verification (atmospheric set-up):
940      - change eosType='IDEALGAS' to eosType='IDEALG' to match variable declaration
941    o pkg/profiles : refine profiles and files handling.
942    o model/src and pkg/ecco : introduce run-time switch usePROFILES.
943    o model/src/the_main_loop.F, forward_step.F and pkg/exf/EXF_OPTIONS.h :
944      - changes to use model/src/the_main_loop.F rather than the ecco version
945        in ecco type adjoint runs.
946    o model/src:
947      - move computation of recip of grid distance & area from INI_MASKS_ETC to INI_GRID
948      - move setting of h0Fac[C,W,S] from INI_LINEAR_PHISURF to INI_MASKS_ETC
949      - update_masks_etc.F: rename SMOOTH*_R4,R8 function to the corresponding type (RS,RL)
950    o model/src:
951      - fix S/R UPDATE_CG2D for ALLOW_DEPTH_CONTROL case (was empty before);
952        update output of test experiment bottom_ctrl_5x5.
953    o pkg/generic_advdiff:
954      - implement vertical bi-harmonic diffusion (for now, only for T & S and
955        only explicitly).
956    o verification/bottom_ctrl_5x5/
957      update reference output (results changed quite some time ago,
958      not sure when; but new reference results look ok in terms of grdchk)
959    o verification/1D_ocean_ice_column/
960      For verification purposes, the exact adjoint rather than an approx.
961      should be used (e.g., to comare against F.D. or TLM).
962      removed autodiff_inadmode*_ad.F routines in code_ad/
963      Update results/ accordingly.
964    o pkg/cal:
965      - change cal_getdate.F so that output date is function of input time only
966        (less ambiguous, not mixed up with input iteration number).
967      - fix calendarDumps for non-zero phase-lag (S/R CAL_TIME2DUMP).
968    o pkg/diagnostics:
969      - implement calendarDumps also for stats-diags
970      - implement calendarDumps also for snap-shot output (negative freq)
971      - for now, ignores calendarDumps if non-zero phase-lag.
972    
973    checkpoint63n (2012/06/04)
974    o model/src:
975      - recompute rSurfW & S to ensure consistent column thickness (needed for rStar)
976        between Sum_k(hFac*drF) and rSurf-rLow, for now only when using pkg/shelfice;
977      - use h0FacC, W & S to compute hFac_surfC, W & S in calc_surf_dr.F (more
978        similar to calc_r_star.F); update results of experiment internal_wave and
979        tutorial_global_oce_in_p (affected @ truncation level).
980    o pkg/shelfice:
981      - add parameterisation of advective-diffusive flux into the ice shelf
982        according to Holland and Jenkins (1999), eq.22-33, as suggested by Jan De Ryd
983      - simply eps3/3a computation
984    o eesupp:
985     - add new CPP option (DISCONNECTED_TILES) to disconnect tiles (no exchange
986       between tiles, just fill-in edges assuming locally periodic subdomain) and
987       add corresponding exchange subroutines (EXCH0);
988     - new CG-solver version (_EX0) for disconnected-tiles special case.
989    o model/src (CG-solvers):
990     - modify Single-Reduction version (CG2D_SR) in case cg2dMaxIters is reached
991       (similar final residual output and max-Iter number as with standard version);
992     - allows to store and use lowest-residual solution (standard & _SR versions);
993     - cleaning up (remove old, commented out code, LETS_MAKE_JAM ...).
994     - by default, also compile CG2D_SR version (define ALLOW_SRCG in CPP_OPTIONS.h)
995    o eesup/src:
996     - global_vec_sum.F cleaning: add a BARRIER ; update comments ; remove ndef
997       ALWAYS_USE_MPI (no longer needed after fixing usingMPI settings - March 2012)
998    o pkg/salt_plume added to lab_sea/input_ad.noseaicedyn
999    
1000    checkpoint63m (2012/04/27)
1001    o pkg/shelfice:
1002     - account for partical cells in surface level below ice-shelf for hydrostatic
1003       pressure calculion (set uniformFreeSurfLev to F); update isomip experiments.
1004    o ad test experiments:
1005     - update and rename to "ad_optfile.local" local AD-optfile specific to a
1006       particular adjoint verification experiment (in verification/*/code_ad/)
1007    o pkg/seaice & pkg/exf:
1008     - Part two of ECCO-CLIVAR code merges.
1009       Completes merge of seaice area relax. code.
1010       Requires unified CPP option EXF_ALLOW_SEAICE_RELAX
1011       to be set in EXF_OPTIONS.h since this pkg controls its I/O
1012       (and avoids second CPP option in SEAICE_OPTIONS.h)
1013     - change default value of costIceStart & costIceEnd to a valid date.
1014     - add snowPrecip to HSNOW in seaice_growth
1015    o pkg/ptracers:
1016     - move ptracers summary and setup check into separated S/R ; add a check for
1017       valid PTRACERS_Iter0 value (error+stop or just warning).
1018    o pkg/cal (+ pkg/ecco):
1019     - avoid calling a S/R with 2 times the same arg (FWD: unless both are only used
1020       as input; and for AD, unless both are not differentiable (e.g., k index)).
1021    o model/src:
1022     - define internal flag "uniformFreeSurfLev" (=T when free-surface level-index
1023       is everywhere k=1) to speed-up some calculations (by pass kSurf reference);
1024       temporary set to usingZCoords value (to be changed to F when using shelfice).
1025     - hydrostatic pressure: implement partial cell near the surface also for
1026       Z-coordinates (for the case where uniformFreeSurfLev=F); replace test on
1027       usingZCoords with test on uniformFreeSurfLev where needed (in NonHyd code).
1028    o pkg/ctrl/ctrl_init.F:
1029     - add a formal parameter to s/r ctrl_init_rec to print
1030       xx_$(ctrl_valiable)_file for easier debugging
1031     - move call of cal_* routines into the if-block where they are really
1032       needed so that xx_$(ctrl_variable)_period can be 0 or -12 without having
1033       to specify a startdate
1034    o pkg/seaice:
1035     - update comments in SEAICE_OPTIONS.h (+ similar update of lab_sea/code and
1036       global_ocean.cs32x15/code versions).
1037     - turn on seaice Multi-category (in data.seaice, SEAICE_multDim=7) for
1038       verification experiment global_ocean.cs32x15.seaice and update results.
1039    o pkg/exf:
1040     - new S/R EXF_GETFIELD_START to return starting-time of a forcing field
1041       (according to useExfYearlyFields).
1042    o pkg/cal:
1043     - move calendar setting & summary (previously in cal_readparams.F) into new
1044       S/R CAL_INIT_FIXED to be called later in the initialisation process, once
1045       length of the simulation is set (after SET_PARMS call); This is an attempt
1046       to fix Pb when, e.g.: pkg/longstep, modifies the length of the run.
1047     - For safety: keep a record of pkg/cal parameter settings status
1048               to allow to STOP if one pkg/cal S/R is called too early.
1049     - add a stop in all basic pkg/cal subroutines if called before setting is done.
1050     - modify cal_getdate.F: stop when nothing was returned;
1051       if called with myIter=-1, simply retrun modelBaseDate (1,2 = startDate_1,_2);
1052       this allows to remove "cal.h" from seaice_read_parms.F & init_mnc_vars.F.
1053    
1054    checkpoint63l (2012/04/04)
1055    o pkg/bbl:
1056      - fix call to FIND_RHO_2D in bbl_calc_rho.F (case multi-tiles per proc);
1057        update global_with_exf output.yearly.txt file.
1058    o pkg/cal:
1059      - start to clean-up cal_set.F ; fix for the case where baseTime is non-zero.
1060      - remove 2 unsused and very short (1 line only) functions ;
1061      - remove unsused subroutines from AD-Diff list.
1062    o model/src:
1063      - start to implement clean wait to stop in initialization S/R (config_check.F,
1064         packages_check.F, ini_parms.F and pkg/obcs/obcs_check.F + pkg/mypackage)
1065    o folowing PRINT_MESSAGE changes:
1066      - remove reminder multiple print to the same file (STDOUT) when multi-threads.
1067    o pkg/bbl:
1068      - modification so it can work with z*
1069      - replace deltaT with dTtracerLev(k) for asynchronous time stepping
1070      - global_with_exf/input.yearly verification; changes output.yearly.txt
1071    o eesupp/src:
1072      - PRINT_MESSAGE: use OpenMP critical instruction (similar to PRINT_ERROR);
1073        writing to unit 0 (if unit=errorMessageUnit) extended to the case myThid=1
1074      - CHECK_THREADS: specific code if using OpenMP threading: improve checking of
1075        # of threads across processors (e.g., different env OMP_NUM_THREADS setting)
1076      - improve special preliminary call to EESET_PARMS (if eedata is read 2 times).
1077      - when using MPI, always set usingMPI=T ; set default accordingly and stop
1078        if not consistent.
1079      - ALL_PROC_DIE: add a BARRIER after MPI_FINALIZE call ; skip this when thread
1080        argument is zero (in case called within single-thread section).
1081    o pkg/fizhi:
1082        clean-up turbulence cold-start switch: decided in fizhi_init_vars.F, stored
1083        in common bloc (fizhi_coms.h) and then passed as argument up to S/R TURBIO.
1084    o pkg/exch2:
1085      - add argument "updateCorners" to S/R exch2_get_uv_bounds (enable to
1086        activate EXCH_IGNORE_CORNERS in vector EXCH S/R).
1087      - switch 1rst EXCH call to IGNORE_CORNERS (instead of UPDATE_CORNERS)
1088        but keep the 2nd with UPDATE_CORNERS: this prevents overwriting good data
1089        with bad ones coming from a not-yet-updated halo.
1090        This should fix the problem when sNx <> sNy and GCD(sNx,sNy) < 2*Olx.
1091    o pkg/frazil:
1092        move FrzForcT diag from frazil_diagnostics_state.F to frazil_calc_rhs.F
1093        http://mitgcm.org/pipermail/mitgcm-devel/2012-March/005384.html
1094    o model/src/config_check.F: add a check for OLx>sNx/OLy>sNy
1095    o verification/lab_sea
1096      * #undef SEAICE_EXCLUDE_FOR_EXACT_AD_TESTING
1097      * #define ALLOW_SST_CONTROL & ALLOW_SST_CONTROL
1098      * nTimeSteps 3 -> 4
1099      * changed reference output accordingly
1100    o pkg/ctrl:
1101      * fix ctrl_get_gen for xx_sst, xx_sss
1102    o pkg/fizhi:
1103      - fix 2 calls to S/R GRD2MSC (argument igrd) in update_earth_exports.F
1104        update results of exp. fizhi-cs-32x32x40 (fail with only 6 digits for cg2d)
1105      - by default, use new version of S/R GETPWHERE (#define TRY_NEW_GETPWHERE);
1106        fix few out-of-bounds indices in referencing vars (initialise igrd to 1);
1107        clean-up fizhi_turb.F (remove unused & uninitialised qdiaglsm array).
1108    o pkg/gmredi:
1109      - add diagnostic of Redi (main diagnonal) vertical diffusive flux of Temp
1110    o pkg/fizhi:
1111      - fix few initialisation and multi-tile Pb: aqualev & gridalt now pass the
1112        (old)aces open64 tuv test.
1113    o pkg/icefront: fix bug and reorder loop in icefront_init_varia.F
1114    o pkg/mom_vecinv:
1115      - fix 1 loop range in mom_vecinv.F to be like all the other loops which
1116        set/update gu,gv/Diss (fix Pb of uninitialised fVerUkp in admom_vecinv
1117        with non-lin free-surf).
1118    o model/src: move k-loop outside of i/j-loops when (re-)computing R_low
1119      in ini/update_masks_etc.F in order to avoid -O3 optimization problems with
1120      some compilers (gfortran 4.6.0 on MacOS)
1121  o momentum:  o momentum:
1122    - separate fVer?(:,:,kUp) & fVer?(:,:,kDown) in argument list of MOM_FLUXFORM    - separate fVer?(:,:,kUp) & fVer?(:,:,kDown) in argument list of MOM_FLUXFORM
1123      & MOM_VECINV subroutines (to help TAF). This fixes Pb of uninitialised      & MOM_VECINV subroutines (to help TAF). This fixes Pb of uninitialised
Legend:
Removed from v.1.1626  
changed lines
  Added in v.1.1839
  ViewVC Help
Powered by ViewVC 1.1.22