| 4 |
Notes on tags used in MITgcmUV |
Notes on tags used in MITgcmUV |
| 5 |
============================== |
============================== |
| 6 |
|
|
| 7 |
|
o pkg/shelfice |
| 8 |
|
- Implement friction velocity-dependent transfer coefficients following |
| 9 |
|
Holland and Jenkins, JPO, 1999 |
| 10 |
|
Original code by M. Losch with small modifs. |
| 11 |
|
Enable with CPP option SHI_ALLOW_GAMMAFRICT |
| 12 |
|
and runtime flag SHELFICEuseGammaFrict |
| 13 |
|
o verification lab_sea & global_ocean.cs32x15: |
| 14 |
|
- use tools/xmakedepend (instead of cyrus_makedepend, in genmake_local): |
| 15 |
|
does not miss some dependencies (but is slower) and also works with many files |
| 16 |
|
(default makedepend limitation for AD built). |
| 17 |
|
- use cyrus_makedepend in adjustment.128x64x1 (so that it still tested). |
| 18 |
|
o pkg/diagnostics: |
| 19 |
|
- add run-time parameter "useMissingValue" (def=False) to fill land-point |
| 20 |
|
(i.e., where mask=0) with MissingValue ; used only in MNC output file. |
| 21 |
|
This replaces CPP-option DIAGNOSTICS_MISSING_VALUE. |
| 22 |
|
- Extend the use of "missing_value" setting from data.diagnostics for the case |
| 23 |
|
of counter-diagnostics (where fraction-weight is zero). This applies both to |
| 24 |
|
MNC and MDS output files. |
| 25 |
|
o pkg/seaice/seaice_growth.F: |
| 26 |
|
- add 'a priori' cap of latent heat flux based on actual mass considerations |
| 27 |
|
when SEAICE_ADD_SUBLIMATION_TO_FWBUDGET is used in conjunction with the |
| 28 |
|
non-legacy seaice_solve4temp. |
| 29 |
|
- add diagnostic of the residual sublimation freshwater flux (the freshwater |
| 30 |
|
flux taken from the ocean if the total actual latent heat fluxes exceed |
| 31 |
|
the maximum) |
| 32 |
|
- remove the CPP switch around the *_FWbySublim unit change and move diagnostic |
| 33 |
|
fill for SIatmQnt, SIfwSubl, SIatmFW to the end of seaice_growth.F. |
| 34 |
|
- add diagnostic of the actual sublimation freshwater flux (that is 0. ifndef |
| 35 |
|
SEAICE_ADD_SUBLIMATION_TO_FWBUDGET) and of the latent heat flux (evap+sublim). |
| 36 |
|
- bug fix : frWtrAtm needs a_FWbySublim ifdef SEAICE_ADD_SUBLIMATION_TO_FWBUDGET. |
| 37 |
|
- bug fix : missing part to Martin's r_FWbySublim pathological case fix. |
| 38 |
|
o verification 1D_ocean_ice_column: |
| 39 |
|
made model domain truly 1x1x23 instead of 5x5x23 with only center cell (3,3,:) wet |
| 40 |
|
update results |
| 41 |
|
o pkg/diagnostics: |
| 42 |
|
- Implement setting of "Post-Processed" diagnostics (corresponding to gdiag(5)='P') |
| 43 |
|
which are not filled-up but computed from other diags ; In this case, the mate |
| 44 |
|
diag points to the primary (filled-up) diag to used for post processing. |
| 45 |
|
- Update Velocity-potential computation using post-processed diag framework. |
| 46 |
|
==> Change the ordering of fields and time-periods in MDS output file |
| 47 |
|
when using periodic averaging: now writes one time record with the full set |
| 48 |
|
of fields for this time period, then the next time reccord (it used to be |
| 49 |
|
one field with the full set of time records then the next field). |
| 50 |
|
Note: this is now similar to NetCDF (MNC) output file. <== |
| 51 |
|
|
| 52 |
|
checkpoint62z (2011/06/21) |
| 53 |
|
o adjoint monitor: |
| 54 |
|
- Add adjoint monitor output for packages exf, seaice |
| 55 |
|
and update relevant testreport output |
| 56 |
|
o pkg/seaice: |
| 57 |
|
- re-order diags inits so that they appear in order in available_diagnostics.log |
| 58 |
|
- added diags: hsnow thermo. rates of change, area preceeding ridiging process, |
| 59 |
|
area/heff/hsnow preceeding thermodynamic growth/melt. |
| 60 |
|
- modified diag: SIdA; output actual effect, as the description states. |
| 61 |
|
- modified description: SIqneti, SIqneto, SIuheff, SIvheff, SIdAb*, HSNOW. |
| 62 |
|
- retired redundant diags: SIyneg, SIfice, SIsnwice, SIthdgrh. |
| 63 |
|
(SIyneg->SIdHbOCN; SIfice->SIdHbATC; SIsnwice->SIdHbFLO; |
| 64 |
|
and SIthdgrh->SIdHbOCN+SIdHbATC+SIdHbATO) |
| 65 |
|
- modified diags (2) : switch all SIdA*, SIdH*, SIdS* from delta to rates. |
| 66 |
|
- added diagnostics for seaice generic tracers (SItr*). |
| 67 |
|
- added SItrUnit and SItrNameLong run time param (for SItr* diags). |
| 68 |
|
- in diag names, replaced 'PrTh' abbrev. of 'preceeding thermo' with 'PT'. |
| 69 |
|
I. Fenty: 18-Jun-2011: |
| 70 |
|
Minor changes to seaice package: |
| 71 |
|
1) Retired old variables (A22, SEAICE_lhsublim, areaMax, areaMin, hiceMin) and |
| 72 |
|
added some new ones (SEAICE_area_reg, SEAICE_hice_reg, SEAICE_area_floor) |
| 73 |
|
- Differentiated "regularization variables" from "floor variables" |
| 74 |
|
* areaMin became SEAICE_area_reg (old A22) and SEAICE_area_floor |
| 75 |
|
* hiceMin became SEAICE_hice_reg (old hiceMin) |
| 76 |
|
(with _reg meaning regularization variable) |
| 77 |
|
- SEAICE_lhSublim becomes lhSublim, the sum of SEAICE_lhEvap and SEAICE_lhFusion |
| 78 |
|
so as to ensure energy conservation when going between phases |
| 79 |
|
- A22 was not used anywhere |
| 80 |
|
2) Changed regularization procedure for heffActual and hsnowActual to ensure |
| 81 |
|
well-boundedness and smooth adjoint in seaice_growth.F |
| 82 |
|
3) Fixed a bug where seaice_solve4temp would not recognize ice-free grid cells |
| 83 |
|
because the old regularization always set heffActual >= 0.05 cm |
| 84 |
|
4) Changed the model so that the default behavior is to put a small (10^-5) "floor" |
| 85 |
|
on AREA when HEFF > 0. |
| 86 |
|
- went from requiring ALLOW_PRECLUDE_INFINITESIMAL_AREA to be defined to |
| 87 |
|
requiring that DISABLE_AREA_FLOOR *not* be defined |
| 88 |
|
Affected verifications: |
| 89 |
|
- 1D_ocean_ice_column (output.txt output_adm.txt) |
| 90 |
|
- global_ocean.cs32x15 (output.seaice.txt output_adm.seaice.txt) |
| 91 |
|
o pkg/diagnostics: |
| 92 |
|
- move MNC code from diagnostics_out.F into new diagnostics_mnc_out.F (2 S/R). |
| 93 |
|
- rename S/R GETDIAG to DIAGNOSTICS_GET_DIAG and change type of 1rst argument |
| 94 |
|
(was _RL, now integer) with option = 0 to retrieve all levels. |
| 95 |
|
- add pieces of code to compute velocity potential at each level (new diagnostics |
| 96 |
|
PhiVEL, works only when UVELMASS & VVELMASS are also turned on); |
| 97 |
|
for now, using same params as CG2D (target-resisual, max Nb of iter ...). |
| 98 |
|
- fix few issues with counter diagnostics in diagnostics_setdiag.F & |
| 99 |
|
diagstats_setdiag.F (if diagnostic counter is itself a counter diag) |
| 100 |
|
and in diagnostics_fract_fill.F (do not need a valid pointer for the |
| 101 |
|
diagnostics counter-mate); check that definition of counter-diagnostic |
| 102 |
|
includes a valid counter-mate (in diagnostics_set_levels.F). |
| 103 |
|
o model/src (rStar): |
| 104 |
|
- add rStar scaling factor in diags_phi_hyd.F (similar to calc_grad_phi_hyd.F); |
| 105 |
|
affect solution only if z* with full pressure in EOS; |
| 106 |
|
update output of test-exp global_ocean.90x40x15. |
| 107 |
|
o pkg/seaice: |
| 108 |
|
- introduce siEps=1e-5 parameter |
| 109 |
|
- use areaMax in AREA update (part 4), consistent with ridging step (part 2.5). |
| 110 |
|
- re-organize SEAICE_ADD_SUBLIMATION_TO_FWBUDGET code. |
| 111 |
|
- introduce ALLOW_SITRACER and seaice_tracer_phys.F to handle generic seaice tracer. |
| 112 |
|
For now it covers, and was tested for, ice salinity and age (attached to HEFF), |
| 113 |
|
as well as ice cover age and ridging index (attached to AREA). |
| 114 |
|
For now the run time parameters (in data.seaice/SEAICE_PARM03) are |
| 115 |
|
SItrName (e.g. 'age') and SItrMate ('HEFF', which is the default, or 'AREA'). |
| 116 |
|
Up to SItrMaxNum=3 tracers can be used simultaneously. |
| 117 |
|
o pkg/salt_plume: |
| 118 |
|
-introduce SPsalFRAC run time parameter that sets the fraction of the |
| 119 |
|
salt by-product of ice growth (SPsalFRAC*(1-SIsalFRAC)*salt typically) |
| 120 |
|
that gets vertically redistributed (fluxed down) by pkg/salt_plume. |
| 121 |
|
o model debug options: |
| 122 |
|
- Switch reading of debugMode from S/R INI_PARMS (parameter file "data", stored |
| 123 |
|
in PARAMS.h) to S/R EESET_PARMS (parameter file "eedata", stored in EEPARAMS.h). |
| 124 |
|
- Refine debug-msg printing selection (3 new levels): |
| 125 |
|
debugMode : controls printing of debug messages (sequence of S/R calls). |
| 126 |
|
debugLevel : controls printing of algorithm-relevant auxiliary/debug messages |
| 127 |
|
debLevZero = 0 ; /* level of disabled aux. msg printing */ |
| 128 |
|
debLevA = 1 ; /* level of minimum aux. msg printing */ |
| 129 |
|
debLevB = 2 ; /* level of low aux. print (report read-file opening)*/ |
| 130 |
|
debLevC = 3 ; /* level of moderate debug prt (most pkgs debug msg) */ |
| 131 |
|
debLevD = 4 ; /* level of enhanced debug prt (add DEBUG_STATS prt) */ |
| 132 |
|
debLevE = 5 ; /* level of extensive debug printing */ |
| 133 |
|
New debugLevel default: with default debugMode value (=F), |
| 134 |
|
= 2 (debLevB) or = 1 (debLevA) in case ALLOW_AUTODIFF is defined.; |
| 135 |
|
and if debugMode=T, default debugLevel = 4 (debLevD). |
| 136 |
|
Relation with previous settings: |
| 137 |
|
debLevB (=2) corresponds to former debLevA (=1) |
| 138 |
|
debLevD (=4) corresponds to former debLevB (=2) |
| 139 |
|
Note: |
| 140 |
|
a) if debugLevel=0, skip WRITE_GRID call when nIter0 > 0 (same as before); |
| 141 |
|
b) default debugLevel=1 is convenient in AD runs (avoid many file opening msgs); |
| 142 |
|
to recover previous default, set debugLevel=2 (e.g. AD-test hs94.1x64x5) |
| 143 |
|
- Add new parameter (printResidualFreq, read from PARM02 namelist) to print |
| 144 |
|
detailed CG solvers convergence; off (=0) by default, except if debugLevel=5. |
| 145 |
|
o pkg/obcs: |
| 146 |
|
- change OBCSfixTopo default from True to False (should not change the results); |
| 147 |
|
keep OBCSfixTopo=T in verification-exp. seaice_obcs. |
| 148 |
|
o pkg/thsice: |
| 149 |
|
- fix bug in thsice_calc_thickn.F (was introduced in version 1.18) in |
| 150 |
|
2nd layer seaice sublimation (unlikely to happen) |
| 151 |
|
- use Interior mask for OBCS in thsice_advection.F (similar to what is |
| 152 |
|
done in gad_advection & seaice_advection). |
| 153 |
|
o adjoint: |
| 154 |
|
bug fix spotted by Gael Forget: |
| 155 |
|
seaice_advection and thsice_advection still had |
| 156 |
|
legacy CPP options to avoid CS corner updates for adjoint |
| 157 |
|
o pkg/seaice: |
| 158 |
|
=> Change some of the defaults (2011/05/29): |
| 159 |
|
- change SEAICEuseFluxForm default (from False to True) |
| 160 |
|
- change DIFF1 default (from 0.004 m/s to 0. m/s) |
| 161 |
|
And print warnings if DIFF1 is not set in data.seaice and centered |
| 162 |
|
avection scheme is used without any diffusion. |
| 163 |
|
also: |
| 164 |
|
- fix seaice_diffusion calls in default AdvScheme part of seaice_advdiff.F; |
| 165 |
|
- set SEAICEdiffKh[] default in the same way as SEAICEadvSch[] |
| 166 |
|
- stop if DIFF1<>0 with SEAICEadvScheme <> 2, if DIFF1<>0 with any |
| 167 |
|
other non-zero SEAICEdiffKh[] diffusivity, if SEAICEadvSalt=T with |
| 168 |
|
#undef SEAICE_VARIABLE_SALINITY, if SEAICEadvAge=T with #undef SEAICE_AGE. |
| 169 |
|
update results of test exp.: |
| 170 |
|
lab_sea: output.fd (switch to AdvScheme=33 with diffKh=20) |
| 171 |
|
output.hb87, output_adm.evp (SEAICEuseFluxForm=T and diffKh=200) |
| 172 |
|
output_adm.noseaicedyn (SEAICEuseFluxForm=T) |
| 173 |
|
offline_exf_seaice: output.seaicetd, output_adm (SEAICEuseFluxForm=T) |
| 174 |
|
seaice_obcs: output (SEAICEuseFluxForm=T) |
| 175 |
|
and prescribe old default for SEAICEuseFluxForm (=F) and DIFF1 (=0.004) |
| 176 |
|
for standard fwd & AD lab_sea tests (to keep the same output). |
| 177 |
|
o pkg/seaice/seaice_growth.F: |
| 178 |
|
- use Ian Fenty's capping formulas for actual ice |
| 179 |
|
thickness thoughout EVOLUTION branch. |
| 180 |
|
- put treatment pathological case #2) in CPP brackets |
| 181 |
|
(ALLOW_AVOID_INFINITESIMAL_AREA, undef by default). |
| 182 |
|
- update global_ocean.cs32x15 and 1D_ocean_ice_colum results accordingly. |
| 183 |
|
o pkg/seaice: |
| 184 |
|
- seaice_diffusion.F : remove the min(DX,DY) factor permanently; |
| 185 |
|
pass the Laplacian diffusivity (in m^2/s) diffKh as a parameter; |
| 186 |
|
also pass fac as a param, which can be 1. (to update the tendency |
| 187 |
|
field) or the time step (to update the field itself). |
| 188 |
|
- seaice_advdiff.F: for multidim, call seaice_diffusion with |
| 189 |
|
e.g. SEAICEdiffKhHeff and with fac=1; for single-dim, call |
| 190 |
|
seaice_diffusion with e.g. SEAICEdiffKhHeff and with fac=time step. |
| 191 |
|
- SEAICE_PARAMS.h, seaice_readparms.F, seaice_check.F : |
| 192 |
|
hooks to handle SEAICEdiffKhHeff, SEAICEdiffKhArea, etc. |
| 193 |
|
o pkg/seaice: |
| 194 |
|
diffusion with centered advection scheme (diffus.F & advect.F): |
| 195 |
|
- simplify S/R DIFFUS (put deltaT & DIFF1 factor outside, move EXCH outside) |
| 196 |
|
to just compute the laplacian of input-field. |
| 197 |
|
- unroll k loop (harmonic,biharmonic diff) in advect.F to save 1 exch call. |
| 198 |
|
- fix flux-form version in diffus.F to conserve tracer. |
| 199 |
|
update output of lab_sea.fd & lab_sea.hb87 (1rst set of modif affects |
| 200 |
|
machine truncation) and lab_sea.salt_plume (conservative flux-form modif) |
| 201 |
|
|
| 202 |
|
checkpoint62y (2011/05/26) |
| 203 |
|
o pkg/seaice: |
| 204 |
|
- seaice_growth.F : in EVOLUTION branch, always include |
| 205 |
|
a_QSWbyATM_cover in qnet (as it should be). |
| 206 |
|
- verification/global_ocean.cs32x15 : update results accordingly |
| 207 |
|
(output.seaice.txt output_adm.seaice.txt). |
| 208 |
|
o pkg/seaice + obcs: |
| 209 |
|
- use maskInW & maskInS in multi-dim advection and biharmonic diffusion: |
| 210 |
|
equivalent of assuming no tracer gradient outside the OB region. |
| 211 |
|
update output of seaice_obcs (uses DIFF1 <>0 => biharmonic diffusion) |
| 212 |
|
- remove calls to OBCS_COPY_TRACER after EXCH calls (no longer needed |
| 213 |
|
after changes above); |
| 214 |
|
- obcs+seaice cleaning: apply seaice-tracer OB values to tracer field |
| 215 |
|
only at OB location (instead of over a band of OLx width). |
| 216 |
|
o pkg/seaice: |
| 217 |
|
- fix wrong indices in old (non Flux-Form) diffusion default S/R diffus.F |
| 218 |
|
(dxG(I+1, ...) changed to dxG(I, ...), no impact on Lat-Lon grid) |
| 219 |
|
o pkg/obcs: |
| 220 |
|
- split header file "OBCS.h" into 4 separated files: |
| 221 |
|
OBCS_PARAMS.h, OBCS_GRID.h, OBCS_FIELDS.h & OBCS_SEAICE.h |
| 222 |
|
Note: OBCS_PARAMS.h & OBCS_GRID.h can be included without OBCS_OPTIONS.h |
| 223 |
|
(contain no conditional statement which depends on OBCS options). |
| 224 |
|
- move "useOBCSYearlyFields" from "data.obcs" (hold in OBCS_PARAMS.h) |
| 225 |
|
to parameter file "data.exf", namelist EXF_NML_OBCS (in EXF_PARAM.h). |
| 226 |
|
o ctrl, cost, grdchk & autodiff pkgs: |
| 227 |
|
- make options file more standard (like other {PKG}_OPTIONS.h file but |
| 228 |
|
with AD_CONFIG.h); clean-up some of the included header files. |
| 229 |
|
o pkg/obcs: |
| 230 |
|
- do not mask tracer when applying OB (tracer == 0 could generate problems) |
| 231 |
|
- apply tracer OB values to tracer field only at OB location (instead of |
| 232 |
|
over a band of OLx width) |
| 233 |
|
- clean-up obcs_apply_w.F & obcs_apply_eta.F (since less calls to these S/R) |
| 234 |
|
- remove OBCS_MULTIDIM_OLD_VERSION code in gad_advection.F and remove |
| 235 |
|
obcs_apply_tloc.F & obcs_apply_sloc.F |
| 236 |
|
o obcs in model/src: |
| 237 |
|
- call OBCS_APPLY_W only if NonHydrostatic. |
| 238 |
|
- call OBCS_APPLY_ETA only if NonLinFreeSurf. |
| 239 |
|
- reset dEtaHdt and wVel to zero outside OB interior region ; |
| 240 |
|
- leave tracer unchanged outside OB interior region: This has no effect |
| 241 |
|
on the solution but just to prevent unrealistic tracer value outside OB. |
| 242 |
|
- zero out velocity outside OB interior region: This has no effect on |
| 243 |
|
the solution but just to prevent unrealistic velocity outside OB. |
| 244 |
|
o obcs and non-lin free-surf: |
| 245 |
|
move call to OBCS_APPLY_R_STAR from update_r_star.F to calc_r_star.F |
| 246 |
|
and call to OBCS_APPLY_SURF_DR from update_surf_dr.F to calc_surf_dr.F |
| 247 |
|
+ add argument "etaFld" to OBCS_APPLY_R_STAR & OBCS_APPLY_SURF_DR: |
| 248 |
|
this fixes missing EXCH + get consistent eta OB value (+ fix restart). |
| 249 |
|
update results of test-exp. exp4(nlfs). |
| 250 |
|
o exp4 (nlfs) test-exp: |
| 251 |
|
use OBC for Eta at Western & Eastern OB (to test prescribing Eta |
| 252 |
|
with NonLin-FreeSurf); update output.nlfs.txt |
| 253 |
|
o obcs and 2d/3d solver norm: |
| 254 |
|
use interior masks (maskInC) to cancel out cg2d & cg3d matrix coeff at OB |
| 255 |
|
and outside OB interior region (will allow to place OB further inside the |
| 256 |
|
domain). Depending on the domain, can affects cg2d-Norm (previous |
| 257 |
|
cancellation outside OB was only partial), e.g. in exp4 & obcs_ctrl, |
| 258 |
|
and cg3d-Norm (previous Norm was computed before canceling OB terms), |
| 259 |
|
e.g. in tutorial_plume_on_slope. |
| 260 |
|
- update output of exp.: exp4 (x2), obcs_ctrl and tutorial_plume_on_slope. |
| 261 |
|
o pkg rbcs: |
| 262 |
|
- split RBCS.h into 3 files: RBCS_SIZE.h, RBCS_PARAMS.h & RBCS_FIELDS.h |
| 263 |
|
- add capability to apply relaxation to horizontal velocity uVel & vVel. |
| 264 |
|
o pkg/grdchk: add gradient check for control variable xx_shifwflx |
| 265 |
|
o pkg/shelfice/shelfice_init_fixed.F |
| 266 |
|
fix CPP-flag combinations |
| 267 |
|
o pkg/seaice: Merge iceage code of Pierre Rampal |
| 268 |
|
* update/change/correct ice age calculations |
| 269 |
|
* add age updates for pathological cases |
| 270 |
|
Probably needs more testing... |
| 271 |
|
|
| 272 |
|
checkpoint62x (2011/05/13) |
| 273 |
|
o pkg/mom_vecinv: |
| 274 |
|
high-order vorticity scheme: use interior masks (maskInW & S) |
| 275 |
|
to zero-out (outside OB) gradient of vorticity. |
| 276 |
|
o verification exp.: |
| 277 |
|
turn on "useEnergyConservingCoriolis" (better discretisation) in exp. |
| 278 |
|
hs94.128x64x5 and seaice_obcs ; update results. |
| 279 |
|
o pkg/obcs: |
| 280 |
|
fix bug in OBeta for YZ sections in obcs_exf_load.F |
| 281 |
|
o pkg/ctrl, pkg/shelfice, and optim: |
| 282 |
|
- add new control variable xx_shifwflx (fresh water flux underneath ice |
| 283 |
|
shelves). This is almost as tedious as obcs-ctrl, because the |
| 284 |
|
variables needs its own mask. |
| 285 |
|
- add a cost function term that penalizes the deviation of xx_shifwflx |
| 286 |
|
from the first guess (zero) in analogy to other control variables |
| 287 |
|
o pkg/shelfice: |
| 288 |
|
- start basic adjoint |
| 289 |
|
o pkg/ctrl: |
| 290 |
|
- remove extra 2D field "for good measure" when initializing in |
| 291 |
|
ctrl_set_globfld_[xy/xz/yz].F |
| 292 |
|
- replace hard coded precision 32 (a bug) in ctrl_map_ini_gen by ctrlprec |
| 293 |
|
- improve error messages in ctrl_set_unpack_* |
| 294 |
o OBC implementation in momentum: |
o OBC implementation in momentum: |
| 295 |
use interior masks (maskInC,W & S) in momentum S/R: |
use interior masks (maskInC,W & S) in momentum S/R: |
| 296 |
- multiply divergence, tension and some del^i.u or del^j.v by maskInC |
- multiply divergence, tension and some del^i.u or del^j.v by maskInC |