--- MITgcm/doc/tag-index 2012/04/02 04:34:07 1.1641 +++ MITgcm/doc/tag-index 2012/08/06 17:24:37 1.1706 @@ -1,9 +1,314 @@ -$Header: /home/ubuntu/mnt/e9_copy/MITgcm/doc/tag-index,v 1.1641 2012/04/02 04:34:07 dimitri Exp $ +$Header: /home/ubuntu/mnt/e9_copy/MITgcm/doc/tag-index,v 1.1706 2012/08/06 17:24:37 jmc Exp $ $Name: $ Notes on tags used in MITgcmUV ============================== +o eesupp/inc: + - in EEPARAMS.h, add real-type constant for some frequently used simple number + (0,1,2,1/2), with name explicitly referring to RS/RL type. +o model/src: + - move balancing of relaxation terms to new S/R balance_relax.F. +o pkg/autodiff: + re-write active I/O high-level (control) S/R: + - rename S/R ACTIVE_READ/WRITE_RL to ACTIVE_READ/WRITE_3D_RL + - add 1 more argument (useCurrentDir) to replace the "_LOC" 2nd set of S/R. + - use standard pkg/mdsio I/O routines (MDS_READ/WRITE_SEC_XZ/YZ and + MDS_READ/WRITE_FIELD); change loops to multi-threads. + - update and merge active_file_control_slice.flow into active_file_control.flow + - update the calls in lower level S/R (active_file.F, active_file_g.F and + active_file_ad.F) keeping the argument list and function unchanged. + - also update lower-level "_LOC" version (call same S/R with "useCurrentDir + =.TRUE.") and remove high-level (control) _loc version (not called anymore). + - new low-level active I/O routines, one for each type (RL/RS), for active var + of various (XY,XZ,YZ) shape and level number (arguments: arrShape, myNr); + fix ctrl_init_wet.F & ecco_cost_weights.F by calling the new S/R with the + right type. +o autodiff and RS=real*4: + - call the right type (_RS instead of _RL) of S/R in few output S/R (pkg/exf + ad-monitor and snapshots); disable arrType='RS' in mdsio_gl*.F ; + - change argument type of 3-D mask argument to _RS to match type in the call + (in seaice_cost*.F, ctrl_*_gen.F and *ctrl_bound.F); to be continued. +o pkg/thsice: + - re-anable balanceEmPmR when useSEAICE=T with useThSIce=T. + - option to correct ocean fresh-water flux for imbalance of Atmos+Land + fresh-water flux: uniform correction or proportional to local precip. +o pkg/ctrl: + - new header file CTRL_SIZE.h for parameters maxCtrlArr2D, maxCtrlArr3D + - redefine CPP option ALLOW_BOTTOMDRAG_CONTROL to + ALLOW_BOTTOMDRAG_CONTROL_NONGENERIC + - verification/hs94.1x64x5/ tests ALLOW_GENARR{2D,3D}_CONTROL + +checkpoint63q (2012/07/30) +o pkg/autodiff: + note about monitor and snap-shot of ad-variables: + a) need to apply ADEXCH before monitor or output of ad-vars to include + overlap contributions (was done for adjDump but missing for monitor). + b) since ADEXCH implies adding overlap values to interior array, machine + truncation error is expected when adding an ADEXCH call in the middle of + the time-stepping (although mathematically identical). + modifs: + - fix some incorrect type (RL/RS, UV/scalar) in ADEXCH calls and ad-vars + declaration (adEddyPsiX,adEddyPsiY in adcommon.h). + - add new run-time params (dumpAdVarExch & mon_AdVarExch) to select how to + apply ADEXCH before monitor or snap-shot of ad-variables: + =0 : no ADEXCH ; =1 : do ADEXCH ; =2 : apply ADEXCH on a local copy. + - implement new method (copy+adexch) for snap-shot and monitor of main model + ad-vars (initially not used by default -> output unchanged). + - change default (set to 2) to use new method and update few output_adm.txt + with accurate ad-monitor (global_ocean.90x40x15, tutorial_global_oce_biogeo + and both tutorial_tracer_adjsens tests). + - switch 2 global_ocean.cs32x15 AD-tests to AB-2 (seaice_dynmix & thsice) + and turn off momDissip_In_AB in the 2 other (needed for stable AB-3). +o pkg/ctrl: + enable the use of a variable number (maxCtrlArr2D, maxCtrlArr3D) of + generic control variables via + #define ALLOW_GENARR2D_CONTROL and/or #define ALLOW_GENARR3D_CONTROL + Only required customization should be S/R ctrl_map_ini_genarr.F + (routine in repository contains example) +o pkg/exf: + - fix and refine checking of surface-relaxation setting when using EXF +o verification (adjoint exp): + - reduce length of simulation by half for experiment global_ocean.cs32x15 + (std, seaice & seaice_dynmix) and exp tutorial_dic_adjoffline; update output. +o pkg/mom_common (mom_u/v_bottomdrag), pkg/shelfice (shelfice_u/v_drag) + - replace if statements KE.ne.0 with KE.gt.0 to avoid sqrt of negative numbers + of KE that can occur with aggressive optimization + + put quadratic bottom drag calculation in separated loops (only done if + using bottomDragQuadratic) +o model/src: CG2D_NSA + - clean-up: stop if cg2dNormaliseRHS=T and AUTODIFF + and replace GLOBAL_SUM calls with GLOBAL_SUM_TILE. + - in test-exp that uses CG2D_NSA (bottom_ctrl & tutorial_tracer_adjsens), + change cg2d residual target to be expressed in Wunits (=> do not normalise + RHS ; this fix global_max Pb with TAF); update output. +o verification/tutorial_tracer_adjsens: + improve parameter consistency (and get rid of warnings): + - use deltaTFreeSurf=deltaTtracer (better with NonLin FreeSurf); + - switch Temp Adv Scheme from 81 to 80 (no limiter since theta < 0 is physical) + - use staggerTimeStep (for stability) in som81; use default rotation period. +o pkg/exch2: + - with empty facet: fix compact-format (W2_mapIO=1) definition (was previously + reset to 0 = 1 long line in X) +o pkg/mdsio: + - fix reading of dimensions from meta file for large-size domain +o model/src: + - fix saltIsActiveTr setting for IdealGas eosType (eosType is 6 character long); + - to refine CS-grid check, add logical flag "hasWetCSCorners": true if using + Cubed-Sphere Exch with CS-corners inside the domain; + make new S/R INI_GLOBAL_DOMAIN from code in ini_linear_phisurf.F to calculate + globalArea and to set hasWetCSCorners. + - add warning if usingCurvilinearGrid and momAdvection in flux-form (missing + metric terms); stop if hasWetCSCorners=T and momAdvection in flux-form. + - re-activate the stop if useCDscheme and hasWetCSCorners=T (previously if + useCDscheme and useCubedSphereExchange). +o pkg/seaice/seaice_growth.F : + - compute the SEAICE_DISABLE_HEATCONSFIX term accordingly + for the (.NOT.useRealFreshWaterFlux).OR.(nonlinFreeSurf.EQ.0) + when the previous code was not correct. + - in all cases diagnoze the boundary condition mismatch to SIaaflux + - in the case of useRealFreshWaterFlux.AND.(nonlinFreeSurf.GT.0) add + that term to QNET (essentially to set the melt/freeze water to 0degC). + when SEAICEheatConsFix is true, so that the ocean+ice budget heat is closed. +o verification/global_ocean.cs32x15/input.seaice : + - add SEAICEheatConsFix in data.seaice, ensuring closed ocean+ice heat budget. + - add diagnostics (commented out) for budget test using my matlab codes (gcmfaces). + - update results (output.seaice.txt) accordingly. +o verification/lab_sea/input/data.seaice : + - remove SEAICEheatConsFix, which is now be tested + in global_ocean.cs32x15. The presently coded fix + is only consistent with real fresh water + nlfs. + - update results (output.txt) accordingly. +o pkg/salt_plume: added diagnotic for salt tendency (oceSPtnd). +o AD_CONFIG.h file: + - in genmake2: remove "#undef ALLOW_ECCO_OPTIMIZATION" from AD_CONFIG.h; + - remove #include "AD_CONFIG.h" from all included OPTIONS files and + add it explicitly in each fortran src file where it is needed. + motivation: header file AD_CONFIG.h is generated/modified after "make depend" + thus introducing potentially wrong dependency; therefore, better to include + it only where it's really needed, and after any other included OPTIONS file + (less tempting to bring conditional includes according to ALLOW_ADJOINT_RUN + or ALLOW_TANGENTLINEAR_RUN). + +checkpoint63p (2012/07/06) +o pkg/autodiff: + - rename S/R INI_AUTODIFF to AUTODIFF_INIT_VARIA ; + - create new header file "AUTODIFF_PARAMS.h" for pkg/autodiff parameters + which are now read from new parameter file "data.autodiff" (inAdExact + previously in "data", use{KPP/GMRedi/SEAICE}inAdMode previously in data.pkg) + - add file "data.autodiff" in all verification/*/input_ad/ directories. + - add run-time parameter to turn On/Off SEAICEuseFREEDRIFT in adjoint/forward + mode (used in global_ocean.cs32x15.seaice_dynmix test exp.) +o verification/tutorial_tracer_adjsens/ + - add extra sub-verification which uses "SOM" advection scheme + (2nd Order-Moment Advection Scheme, Prather Limiter) with + #define GAD_ALLOW_TS_SOM_ADV in GAD_OPTIONS.h + and in data: + multiDimAdvection=.TRUE., + tempAdvScheme=81, + saltAdvScheme=81, +o model/src: + - introduce ALLOW_BALANCE_RELAX which allow the removal + of the global mean of relaxation terms by setting + balanceThetaClimRelax and balanceSaltClimRelax + - disable balanceEmPmR and balanceQnet in the case when useSeaice. + This case is now treated appropriately in seaice_growth.F +o pkg/seaice: + - do balanceEmPmR and balanceQnet based on the net fluxes + (SItflux) that enter the ocean+ice system rather than QNET + and EMPMR. Works best in real fresh water. + - SIatmFW, SIatmQnet, and SItflux computations had to be moved + out of the diagnotics bloc, and stored in global arrays. + +checkpoint63o (2012/06/29) +o vertical mixing schemes: + - remove unused S/R CALC_BUOYANCY (left from branch-atmos merging) + - replace computation of density (in Function STATE1, opps_calc.F) by a call + to S/R FIND_RHO_SCALAR + - pass sigmaR to S/R PP81_CALC, MY82_CALC (but not yet used) and to GGL90_CALC + and use it for N^2 calculation in ggl90_calc.F (save 2 density computations); + affects output (vermix.ggl90) at truncation level. +o testreport: + - change adjustment of SIZE.h for mpi+mth testing: preserve enough tiles + (nSx,nSy) for the number of threads (from eedata.mth) +o model/src: + - remove 2nd set of calls at the top of initialise_varia.F (Adjoint part) + related to Non_Lin Free-Surf or Bottom-Control (but not longer necessary). +o verification/tutorial_tracer_adjsens/ + - compile with ALLOW_CG2D_NSA + - run with nonlinFreeSurf=3 + - update reference output_adm.txt +o tools/genmake2: + - add "-DHAVE_NETCDF" to the DEFINES list when NetCDF is available ; + refine usePROFILES switching off (only when NetCDF is not available). +o verification (atmospheric set-up): + - change eosType='IDEALGAS' to eosType='IDEALG' to match variable declaration +o pkg/profiles : refine profiles and files handling. +o model/src and pkg/ecco : introduce run-time switch usePROFILES. +o model/src/the_main_loop.F, forward_step.F and pkg/exf/EXF_OPTIONS.h : + - changes to use model/src/the_main_loop.F rather than the ecco version + in ecco type adjoint runs. +o model/src: + - move computation of recip of grid distance & area from INI_MASKS_ETC to INI_GRID + - move setting of h0Fac[C,W,S] from INI_LINEAR_PHISURF to INI_MASKS_ETC + - update_masks_etc.F: rename SMOOTH*_R4,R8 function to the corresponding type (RS,RL) +o model/src: + - fix S/R UPDATE_CG2D for ALLOW_DEPTH_CONTROL case (was empty before); + update output of test experiment bottom_ctrl_5x5. +o pkg/generic_advdiff: + - implement vertical bi-harmonic diffusion (for now, only for T & S and + only explicitly). +o verification/bottom_ctrl_5x5/ + update reference output (results changed quite some time ago, + not sure when; but new reference results look ok in terms of grdchk) +o verification/1D_ocean_ice_column/ + For verification purposes, the exact adjoint rather than an approx. + should be used (e.g., to comare against F.D. or TLM). + removed autodiff_inadmode*_ad.F routines in code_ad/ + Update results/ accordingly. +o pkg/cal: + - change cal_getdate.F so that output date is function of input time only + (less ambiguous, not mixed up with input iteration number). + - fix calendarDumps for non-zero phase-lag (S/R CAL_TIME2DUMP). +o pkg/diagnostics: + - implement calendarDumps also for stats-diags + - implement calendarDumps also for snap-shot output (negative freq) + - for now, ignores calendarDumps if non-zero phase-lag. + +checkpoint63n (2012/06/04) +o model/src: + - recompute rSurfW & S to ensure consistent column thickness (needed for rStar) + between Sum_k(hFac*drF) and rSurf-rLow, for now only when using pkg/shelfice; + - use h0FacC, W & S to compute hFac_surfC, W & S in calc_surf_dr.F (more + similar to calc_r_star.F); update results of experiment internal_wave and + tutorial_global_oce_in_p (affected @ truncation level). +o pkg/shelfice: + - add parameterisation of advective-diffusive flux into the ice shelf + according to Holland and Jenkins (1999), eq.22-33, as suggested by Jan De Ryd + - simply eps3/3a computation +o eesupp: + - add new CPP option (DISCONNECTED_TILES) to disconnect tiles (no exchange + between tiles, just fill-in edges assuming locally periodic subdomain) and + add corresponding exchange subroutines (EXCH0); + - new CG-solver version (_EX0) for disconnected-tiles special case. +o model/src (CG-solvers): + - modify Single-Reduction version (CG2D_SR) in case cg2dMaxIters is reached + (similar final residual output and max-Iter number as with standard version); + - allows to store and use lowest-residual solution (standard & _SR versions); + - cleaning up (remove old, commented out code, LETS_MAKE_JAM ...). + - by default, also compile CG2D_SR version (define ALLOW_SRCG in CPP_OPTIONS.h) +o eesup/src: + - global_vec_sum.F cleaning: add a BARRIER ; update comments ; remove ndef + ALWAYS_USE_MPI (no longer needed after fixing usingMPI settings - March 2012) +o pkg/salt_plume added to lab_sea/input_ad.noseaicedyn + +checkpoint63m (2012/04/27) +o pkg/shelfice: + - account for partical cells in surface level below ice-shelf for hydrostatic + pressure calculion (set uniformFreeSurfLev to F); update isomip experiments. +o ad test experiments: + - update and rename to "ad_optfile.local" local AD-optfile specific to a + particular adjoint verification experiment (in verification/*/code_ad/) +o pkg/seaice & pkg/exf: + - Part two of ECCO-CLIVAR code merges. + Completes merge of seaice area relax. code. + Requires unified CPP option EXF_ALLOW_SEAICE_RELAX + to be set in EXF_OPTIONS.h since this pkg controls its I/O + (and avoids second CPP option in SEAICE_OPTIONS.h) + - change default value of costIceStart & costIceEnd to a valid date. + - add snowPrecip to HSNOW in seaice_growth +o pkg/ptracers: + - move ptracers summary and setup check into separated S/R ; add a check for + valid PTRACERS_Iter0 value (error+stop or just warning). +o pkg/cal (+ pkg/ecco): + - avoid calling a S/R with 2 times the same arg (FWD: unless both are only used + as input; and for AD, unless both are not differentiable (e.g., k index)). +o model/src: + - define internal flag "uniformFreeSurfLev" (=T when free-surface level-index + is everywhere k=1) to speed-up some calculations (by pass kSurf reference); + temporary set to usingZCoords value (to be changed to F when using shelfice). + - hydrostatic pressure: implement partial cell near the surface also for + Z-coordinates (for the case where uniformFreeSurfLev=F); replace test on + usingZCoords with test on uniformFreeSurfLev where needed (in NonHyd code). +o pkg/ctrl/ctrl_init.F: + - add a formal parameter to s/r ctrl_init_rec to print + xx_$(ctrl_valiable)_file for easier debugging + - move call of cal_* routines into the if-block where they are really + needed so that xx_$(ctrl_variable)_period can be 0 or -12 without having + to specify a startdate +o pkg/seaice: + - update comments in SEAICE_OPTIONS.h (+ similar update of lab_sea/code and + global_ocean.cs32x15/code versions). + - turn on seaice Multi-category (in data.seaice, SEAICE_multDim=7) for + verification experiment global_ocean.cs32x15.seaice and update results. +o pkg/exf: + - new S/R EXF_GETFIELD_START to return starting-time of a forcing field + (according to useExfYearlyFields). +o pkg/cal: + - move calendar setting & summary (previously in cal_readparams.F) into new + S/R CAL_INIT_FIXED to be called later in the initialisation process, once + length of the simulation is set (after SET_PARMS call); This is an attempt + to fix Pb when, e.g.: pkg/longstep, modifies the length of the run. + - For safety: keep a record of pkg/cal parameter settings status + to allow to STOP if one pkg/cal S/R is called too early. + - add a stop in all basic pkg/cal subroutines if called before setting is done. + - modify cal_getdate.F: stop when nothing was returned; + if called with myIter=-1, simply retrun modelBaseDate (1,2 = startDate_1,_2); + this allows to remove "cal.h" from seaice_read_parms.F & init_mnc_vars.F. + +checkpoint63l (2012/04/04) +o pkg/bbl: + - fix call to FIND_RHO_2D in bbl_calc_rho.F (case multi-tiles per proc); + update global_with_exf output.yearly.txt file. +o pkg/cal: + - start to clean-up cal_set.F ; fix for the case where baseTime is non-zero. + - remove 2 unsused and very short (1 line only) functions ; + - remove unsused subroutines from AD-Diff list. +o model/src: + - start to implement clean wait to stop in initialization S/R (config_check.F, + packages_check.F, ini_parms.F and pkg/obcs/obcs_check.F + pkg/mypackage) +o folowing PRINT_MESSAGE changes: + - remove reminder multiple print to the same file (STDOUT) when multi-threads. o pkg/bbl: - modification so it can work with z* - replace deltaT with dTtracerLev(k) for asynchronous time stepping