| 4 |
Notes on tags used in MITgcmUV |
Notes on tags used in MITgcmUV |
| 5 |
============================== |
============================== |
| 6 |
|
|
| 7 |
|
o verification/testreport: |
| 8 |
|
- add option '-tlm' for Tangent-Linear test (-adm,-oad,-tlm are all exclusive); |
| 9 |
|
- can also use compressed (gzip) reference output file; |
| 10 |
|
- change format (in pkg/grdchk) of TLM output (+ add forward gradient) |
| 11 |
|
to be easier to collect by testreport. |
| 12 |
|
- update existing TLM output (half out-of-date by more than 3 yrs). |
| 13 |
|
|
| 14 |
|
checkpoint63r (2012/08/15) |
| 15 |
|
o tools/genmake2: |
| 16 |
|
- fix Makefile for target ftlall (+ update files to clean after make ftlall) |
| 17 |
|
o pkg/ecco/ecco_cost_final.F : |
| 18 |
|
- fix fc print statements (to stdout and costfunction0000) so |
| 19 |
|
that the printed value is always after the global sum. |
| 20 |
|
o pkg/seaice/seaice_dynsolver.F : |
| 21 |
|
- fix ice strength assymptote at SEAICE_area_max<1 |
| 22 |
|
(no change for the standard case of SEAICE_area_max=1) |
| 23 |
|
o some cleaning: |
| 24 |
|
- pkg source files: ensure that all *.F files from each pkg included the |
| 25 |
|
corresponding ${PKG}_OPTIONS.h file (except stand-alone src file which |
| 26 |
|
only includes CPP_EEOPTIONS.h); fix S/R CTRL_SMOOTH ; update AD experiment |
| 27 |
|
code_ad/*.F src files; add new option-file in pkg/admtlm + corresponding |
| 28 |
|
includes; |
| 29 |
|
- model/src: add PACKAGES_CONFIG.h wherever ALLOW_AUTODIFF[_TAMC] is used. |
| 30 |
|
- ALLOW_DIFFKR_CONTROL: add a stop in S/R CTRL_CHECK in case ALLOW_3D_DIFFKR |
| 31 |
|
is undef; also define /DYNVARS_DIFFKR/ common block in DYNVARS.h when |
| 32 |
|
ALLOW_DIFFKR_CONTROL is defined, to allow to compile and reach this stop. |
| 33 |
|
- update option-file CPP_OPTIONS.h of all AD experiments: |
| 34 |
|
* no longer include PACKAGES_CONFIG.h ; |
| 35 |
|
* includes ECCO_CPPOPTIONS.h if PACKAGES_CONFIG.h has been included ; |
| 36 |
|
* def/undef ALLOW_3D_DIFFKR independently of ALLOW_DIFFKR_CONTROL (before |
| 37 |
|
including ECCO_CPPOPTIONS.h). |
| 38 |
|
o pkg/cost, pkg/ctrl, pkg/ecco option-file: |
| 39 |
|
- clean-up and split content of old pkg/ecco/ECCO_CPPOPTIONS.h file into |
| 40 |
|
separated pkg option-file (done according to old doc from ECCO_CPPOPTIONS.h, |
| 41 |
|
not necessary accurate). |
| 42 |
|
- add a template for option-file ECCO_CPPOPTIONS.h, mostly empty, in |
| 43 |
|
pkg/autodiff, i.e., the 1rst pkg to compile for adjoint built, with lines to |
| 44 |
|
deliberately break compilation (a remainder that it needs to be customized) |
| 45 |
|
- in pkg/ecco, includes ECCO_OPTIONS.h instead of COST_OPTIONS.h |
| 46 |
|
- rename COST_CPPOPTIONS.h to COST_OPTIONS.h |
| 47 |
|
- rename CTRL_CPPOPTIONS.h to CTRL_OPTIONS.h |
| 48 |
|
o tools/genamke2: |
| 49 |
|
- check for lapack. |
| 50 |
|
o pkg/cost and pkg/ecco : attempt to sort out some of the limiting intricacies. |
| 51 |
|
- pkg/cost.cost_final.F : allow for use of pkg/ecco and pkg/cost cost functions |
| 52 |
|
jointly. The exclusive ifdefs were removed, to add costs terms (when defined) |
| 53 |
|
from both packages. |
| 54 |
|
- the fc global sum in pkg/ecco/ecco_cost_final.F was removed accordingly. |
| 55 |
|
- for objf_atl we use either the pkg/ecco or the pkg/cost term depending on CPPs. |
| 56 |
|
- pkg/ecco and model/src : add CPP brackets around pkg/cost and pkg/ctrl includes |
| 57 |
|
of "CTRL_SIZE.h" "ctrl.h" "ctrl_dummy.h" "optim.h" / "cost.h" accordingly. |
| 58 |
|
o pkg/cost : add comments to explain special and/or untested setups. |
| 59 |
|
o pkg/exf: |
| 60 |
|
- use EXF_OPTIONS.h to set pkg/exf options except if done in ECCO_CPPOPTIONS.h |
| 61 |
|
(previously, ALLOW_AUTODIFF_TAMC was controling this switch). |
| 62 |
|
o verification/*/code_ad: |
| 63 |
|
mimimal cleaning of AD experiments ECCO_CPPOPTIONS.h option-file: |
| 64 |
|
- reccord when this file is included (define ECCO_CPPOPTIONS_H) |
| 65 |
|
- remove the most obvious obsolete features (e.g., #define ALLOW_COST not |
| 66 |
|
allowed since Oct 2003 in any option-file except in PACKAGES_CONFIG.h) |
| 67 |
|
o pkg/seaice : |
| 68 |
|
- added possibility to change ice strength/PRESS0 relationship to |
| 69 |
|
HEFF, according to the following run time parameters |
| 70 |
|
SEAICEpresPow0 :: HEFF exponent for ice strength below SEAICEpresH0 (integer, >0) |
| 71 |
|
SEAICEpresPow1 :: HEFF exponent for ice strength above SEAICEpresH0 (integer, >0) |
| 72 |
|
SEAICEpresH0 :: HEFF threshold for ice strength (m) |
| 73 |
|
o pkg/ggl90 : |
| 74 |
|
- added run time flag mxlSurfFlag to include the code that ensure |
| 75 |
|
mixing between first and second level (previously included as a comment) |
| 76 |
|
o verification/1D_ocean_ice_column/input_ad/data.autodiff : |
| 77 |
|
- add test of newly added dumpAdByRec=T option where |
| 78 |
|
we write all records to one file per variable. |
| 79 |
|
o verification/global_ocean.cs32x15/code_ad/CPP_OPTIONS.h : |
| 80 |
|
- switch to #define ALLOW_BALANCE_RELAX and ALLOW_BALANCE_FLUXES |
| 81 |
|
to check that this code is ok with taf and compiles in adjoint. |
| 82 |
|
o pkg/autodiff : |
| 83 |
|
- added run time param dumpAdByRec : ad dump format switch. |
| 84 |
|
If true then write all records to one file per variable. |
| 85 |
|
Else write one file per record (remains the default). |
| 86 |
|
- revise seaice_ad_dump.F and exf_adjoint_snapshots_ad.F accordingly. |
| 87 |
|
o pkg/seaice: |
| 88 |
|
- Added SEAICEuseTILT run time switch : if set to |
| 89 |
|
false then omit the tilt term in seaice dynamics. |
| 90 |
|
- Fix free drift calculation. |
| 91 |
|
o pkg/shelfice: |
| 92 |
|
When initializing SHELFICEDragQuadratic, set default to be |
| 93 |
|
consistent with shiCdrag in case SHELFICEuseGammaFrict is used, |
| 94 |
|
but retain option to set it independently |
| 95 |
|
(inconsistenty spotted by Veronique Dansereau) |
| 96 |
|
o eesupp/inc: |
| 97 |
|
- in EEPARAMS.h, add real-type constant for some frequently used simple number |
| 98 |
|
(0,1,2,1/2), with name explicitly referring to RS/RL type. |
| 99 |
|
o model/src: |
| 100 |
|
- move balancing of relaxation terms to new S/R balance_relax.F. |
| 101 |
|
o pkg/autodiff: |
| 102 |
|
re-write active I/O high-level (control) S/R: |
| 103 |
|
- rename S/R ACTIVE_READ/WRITE_RL to ACTIVE_READ/WRITE_3D_RL |
| 104 |
|
- add 1 more argument (useCurrentDir) to replace the "_LOC" 2nd set of S/R. |
| 105 |
|
- use standard pkg/mdsio I/O routines (MDS_READ/WRITE_SEC_XZ/YZ and |
| 106 |
|
MDS_READ/WRITE_FIELD); change loops to multi-threads. |
| 107 |
|
- update and merge active_file_control_slice.flow into active_file_control.flow |
| 108 |
|
- update the calls in lower level S/R (active_file.F, active_file_g.F and |
| 109 |
|
active_file_ad.F) keeping the argument list and function unchanged. |
| 110 |
|
- also update lower-level "_LOC" version (call same S/R with "useCurrentDir |
| 111 |
|
=.TRUE.") and remove high-level (control) _loc version (not called anymore). |
| 112 |
|
- new low-level active I/O routines, one for each type (RL/RS), for active var |
| 113 |
|
of various (XY,XZ,YZ) shape and level number (arguments: arrShape, myNr); |
| 114 |
|
fix ctrl_init_wet.F & ecco_cost_weights.F by calling the new S/R with the |
| 115 |
|
right type. |
| 116 |
|
o autodiff and RS=real*4: |
| 117 |
|
- call the right type (_RS instead of _RL) of S/R in few output S/R (pkg/exf |
| 118 |
|
ad-monitor and snapshots); disable arrType='RS' in mdsio_gl*.F ; |
| 119 |
|
- change argument type of 3-D mask argument to _RS to match type in the call |
| 120 |
|
(in seaice_cost*.F, ctrl_*_gen.F and *ctrl_bound.F); to be continued. |
| 121 |
|
o pkg/thsice: |
| 122 |
|
- re-anable balanceEmPmR when useSEAICE=T with useThSIce=T. |
| 123 |
|
- option to correct ocean fresh-water flux for imbalance of Atmos+Land |
| 124 |
|
fresh-water flux: uniform correction or proportional to local precip. |
| 125 |
|
o pkg/ctrl: |
| 126 |
|
- new header file CTRL_SIZE.h for parameters maxCtrlArr2D, maxCtrlArr3D |
| 127 |
|
- redefine CPP option ALLOW_BOTTOMDRAG_CONTROL to |
| 128 |
|
ALLOW_BOTTOMDRAG_CONTROL_NONGENERIC |
| 129 |
|
- verification/hs94.1x64x5/ tests ALLOW_GENARR{2D,3D}_CONTROL |
| 130 |
|
|
| 131 |
|
checkpoint63q (2012/07/30) |
| 132 |
|
o pkg/autodiff: |
| 133 |
|
note about monitor and snap-shot of ad-variables: |
| 134 |
|
a) need to apply ADEXCH before monitor or output of ad-vars to include |
| 135 |
|
overlap contributions (was done for adjDump but missing for monitor). |
| 136 |
|
b) since ADEXCH implies adding overlap values to interior array, machine |
| 137 |
|
truncation error is expected when adding an ADEXCH call in the middle of |
| 138 |
|
the time-stepping (although mathematically identical). |
| 139 |
|
modifs: |
| 140 |
|
- fix some incorrect type (RL/RS, UV/scalar) in ADEXCH calls and ad-vars |
| 141 |
|
declaration (adEddyPsiX,adEddyPsiY in adcommon.h). |
| 142 |
|
- add new run-time params (dumpAdVarExch & mon_AdVarExch) to select how to |
| 143 |
|
apply ADEXCH before monitor or snap-shot of ad-variables: |
| 144 |
|
=0 : no ADEXCH ; =1 : do ADEXCH ; =2 : apply ADEXCH on a local copy. |
| 145 |
|
- implement new method (copy+adexch) for snap-shot and monitor of main model |
| 146 |
|
ad-vars (initially not used by default -> output unchanged). |
| 147 |
|
- change default (set to 2) to use new method and update few output_adm.txt |
| 148 |
|
with accurate ad-monitor (global_ocean.90x40x15, tutorial_global_oce_biogeo |
| 149 |
|
and both tutorial_tracer_adjsens tests). |
| 150 |
|
- switch 2 global_ocean.cs32x15 AD-tests to AB-2 (seaice_dynmix & thsice) |
| 151 |
|
and turn off momDissip_In_AB in the 2 other (needed for stable AB-3). |
| 152 |
|
o pkg/ctrl: |
| 153 |
|
enable the use of a variable number (maxCtrlArr2D, maxCtrlArr3D) of |
| 154 |
|
generic control variables via |
| 155 |
|
#define ALLOW_GENARR2D_CONTROL and/or #define ALLOW_GENARR3D_CONTROL |
| 156 |
|
Only required customization should be S/R ctrl_map_ini_genarr.F |
| 157 |
|
(routine in repository contains example) |
| 158 |
|
o pkg/exf: |
| 159 |
|
- fix and refine checking of surface-relaxation setting when using EXF |
| 160 |
|
o verification (adjoint exp): |
| 161 |
|
- reduce length of simulation by half for experiment global_ocean.cs32x15 |
| 162 |
|
(std, seaice & seaice_dynmix) and exp tutorial_dic_adjoffline; update output. |
| 163 |
|
o pkg/mom_common (mom_u/v_bottomdrag), pkg/shelfice (shelfice_u/v_drag) |
| 164 |
|
- replace if statements KE.ne.0 with KE.gt.0 to avoid sqrt of negative numbers |
| 165 |
|
of KE that can occur with aggressive optimization |
| 166 |
|
+ put quadratic bottom drag calculation in separated loops (only done if |
| 167 |
|
using bottomDragQuadratic) |
| 168 |
|
o model/src: CG2D_NSA |
| 169 |
|
- clean-up: stop if cg2dNormaliseRHS=T and AUTODIFF |
| 170 |
|
and replace GLOBAL_SUM calls with GLOBAL_SUM_TILE. |
| 171 |
|
- in test-exp that uses CG2D_NSA (bottom_ctrl & tutorial_tracer_adjsens), |
| 172 |
|
change cg2d residual target to be expressed in Wunits (=> do not normalise |
| 173 |
|
RHS ; this fix global_max Pb with TAF); update output. |
| 174 |
|
o verification/tutorial_tracer_adjsens: |
| 175 |
|
improve parameter consistency (and get rid of warnings): |
| 176 |
|
- use deltaTFreeSurf=deltaTtracer (better with NonLin FreeSurf); |
| 177 |
|
- switch Temp Adv Scheme from 81 to 80 (no limiter since theta < 0 is physical) |
| 178 |
|
- use staggerTimeStep (for stability) in som81; use default rotation period. |
| 179 |
|
o pkg/exch2: |
| 180 |
|
- with empty facet: fix compact-format (W2_mapIO=1) definition (was previously |
| 181 |
|
reset to 0 = 1 long line in X) |
| 182 |
|
o pkg/mdsio: |
| 183 |
|
- fix reading of dimensions from meta file for large-size domain |
| 184 |
|
o model/src: |
| 185 |
|
- fix saltIsActiveTr setting for IdealGas eosType (eosType is 6 character long); |
| 186 |
|
- to refine CS-grid check, add logical flag "hasWetCSCorners": true if using |
| 187 |
|
Cubed-Sphere Exch with CS-corners inside the domain; |
| 188 |
|
make new S/R INI_GLOBAL_DOMAIN from code in ini_linear_phisurf.F to calculate |
| 189 |
|
globalArea and to set hasWetCSCorners. |
| 190 |
|
- add warning if usingCurvilinearGrid and momAdvection in flux-form (missing |
| 191 |
|
metric terms); stop if hasWetCSCorners=T and momAdvection in flux-form. |
| 192 |
|
- re-activate the stop if useCDscheme and hasWetCSCorners=T (previously if |
| 193 |
|
useCDscheme and useCubedSphereExchange). |
| 194 |
|
o pkg/seaice/seaice_growth.F : |
| 195 |
|
- compute the SEAICE_DISABLE_HEATCONSFIX term accordingly |
| 196 |
|
for the (.NOT.useRealFreshWaterFlux).OR.(nonlinFreeSurf.EQ.0) |
| 197 |
|
when the previous code was not correct. |
| 198 |
|
- in all cases diagnoze the boundary condition mismatch to SIaaflux |
| 199 |
|
- in the case of useRealFreshWaterFlux.AND.(nonlinFreeSurf.GT.0) add |
| 200 |
|
that term to QNET (essentially to set the melt/freeze water to 0degC). |
| 201 |
|
when SEAICEheatConsFix is true, so that the ocean+ice budget heat is closed. |
| 202 |
|
o verification/global_ocean.cs32x15/input.seaice : |
| 203 |
|
- add SEAICEheatConsFix in data.seaice, ensuring closed ocean+ice heat budget. |
| 204 |
|
- add diagnostics (commented out) for budget test using my matlab codes (gcmfaces). |
| 205 |
|
- update results (output.seaice.txt) accordingly. |
| 206 |
|
o verification/lab_sea/input/data.seaice : |
| 207 |
|
- remove SEAICEheatConsFix, which is now be tested |
| 208 |
|
in global_ocean.cs32x15. The presently coded fix |
| 209 |
|
is only consistent with real fresh water + nlfs. |
| 210 |
|
- update results (output.txt) accordingly. |
| 211 |
|
o pkg/salt_plume: added diagnotic for salt tendency (oceSPtnd). |
| 212 |
|
o AD_CONFIG.h file: |
| 213 |
|
- in genmake2: remove "#undef ALLOW_ECCO_OPTIMIZATION" from AD_CONFIG.h; |
| 214 |
|
- remove #include "AD_CONFIG.h" from all included OPTIONS files and |
| 215 |
|
add it explicitly in each fortran src file where it is needed. |
| 216 |
|
motivation: header file AD_CONFIG.h is generated/modified after "make depend" |
| 217 |
|
thus introducing potentially wrong dependency; therefore, better to include |
| 218 |
|
it only where it's really needed, and after any other included OPTIONS file |
| 219 |
|
(less tempting to bring conditional includes according to ALLOW_ADJOINT_RUN |
| 220 |
|
or ALLOW_TANGENTLINEAR_RUN). |
| 221 |
|
|
| 222 |
|
checkpoint63p (2012/07/06) |
| 223 |
|
o pkg/autodiff: |
| 224 |
|
- rename S/R INI_AUTODIFF to AUTODIFF_INIT_VARIA ; |
| 225 |
|
- create new header file "AUTODIFF_PARAMS.h" for pkg/autodiff parameters |
| 226 |
|
which are now read from new parameter file "data.autodiff" (inAdExact |
| 227 |
|
previously in "data", use{KPP/GMRedi/SEAICE}inAdMode previously in data.pkg) |
| 228 |
|
- add file "data.autodiff" in all verification/*/input_ad/ directories. |
| 229 |
|
- add run-time parameter to turn On/Off SEAICEuseFREEDRIFT in adjoint/forward |
| 230 |
|
mode (used in global_ocean.cs32x15.seaice_dynmix test exp.) |
| 231 |
|
o verification/tutorial_tracer_adjsens/ |
| 232 |
|
- add extra sub-verification which uses "SOM" advection scheme |
| 233 |
|
(2nd Order-Moment Advection Scheme, Prather Limiter) with |
| 234 |
|
#define GAD_ALLOW_TS_SOM_ADV in GAD_OPTIONS.h |
| 235 |
|
and in data: |
| 236 |
|
multiDimAdvection=.TRUE., |
| 237 |
|
tempAdvScheme=81, |
| 238 |
|
saltAdvScheme=81, |
| 239 |
|
o model/src: |
| 240 |
|
- introduce ALLOW_BALANCE_RELAX which allow the removal |
| 241 |
|
of the global mean of relaxation terms by setting |
| 242 |
|
balanceThetaClimRelax and balanceSaltClimRelax |
| 243 |
|
- disable balanceEmPmR and balanceQnet in the case when useSeaice. |
| 244 |
|
This case is now treated appropriately in seaice_growth.F |
| 245 |
|
o pkg/seaice: |
| 246 |
|
- do balanceEmPmR and balanceQnet based on the net fluxes |
| 247 |
|
(SItflux) that enter the ocean+ice system rather than QNET |
| 248 |
|
and EMPMR. Works best in real fresh water. |
| 249 |
|
- SIatmFW, SIatmQnet, and SItflux computations had to be moved |
| 250 |
|
out of the diagnotics bloc, and stored in global arrays. |
| 251 |
|
|
| 252 |
|
checkpoint63o (2012/06/29) |
| 253 |
|
o vertical mixing schemes: |
| 254 |
|
- remove unused S/R CALC_BUOYANCY (left from branch-atmos merging) |
| 255 |
|
- replace computation of density (in Function STATE1, opps_calc.F) by a call |
| 256 |
|
to S/R FIND_RHO_SCALAR |
| 257 |
|
- pass sigmaR to S/R PP81_CALC, MY82_CALC (but not yet used) and to GGL90_CALC |
| 258 |
|
and use it for N^2 calculation in ggl90_calc.F (save 2 density computations); |
| 259 |
|
affects output (vermix.ggl90) at truncation level. |
| 260 |
|
o testreport: |
| 261 |
|
- change adjustment of SIZE.h for mpi+mth testing: preserve enough tiles |
| 262 |
|
(nSx,nSy) for the number of threads (from eedata.mth) |
| 263 |
|
o model/src: |
| 264 |
|
- remove 2nd set of calls at the top of initialise_varia.F (Adjoint part) |
| 265 |
|
related to Non_Lin Free-Surf or Bottom-Control (but not longer necessary). |
| 266 |
o verification/tutorial_tracer_adjsens/ |
o verification/tutorial_tracer_adjsens/ |
| 267 |
- compile with ALLOW_CG2D_NSA |
- compile with ALLOW_CG2D_NSA |
| 268 |
- run with nonlinFreeSurf=3 |
- run with nonlinFreeSurf=3 |
Parent Directory
| 
Revision Log
| 
Revision Graph
| 
Patch