/[MITgcm]/manual/manual_todo.txt
ViewVC logotype

Contents of /manual/manual_todo.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.38 - (show annotations) (download)
Wed Jun 28 15:36:02 2006 UTC (17 years, 10 months ago) by cnh
Branch: MAIN
Changes since 1.37: +1 -0 lines
File MIME type: text/plain
Add note on Davids donut movie

1 Editors
2
3 Overall - JM, AM, PH, CNH, EH3
4
5 Front content - EH3
6
7 Chapter 1 - CNH
8
9 Chapter 2 - JMC
10
11 Chapter 3 - AM
12
13 Chapter 4 - CNH
14
15 Chapter 5 - PH
16
17 Chapter 6 - AM
18
19 Chapter 7 - EH3
20
21 Chapter 8 - PH
22
23 Chapter 9 - CNH (Applications)
24
25 Chapter 10 - JMC (Under development chapter)
26
27 Biblio - EH3
28
29 Rebuild and set to do cron build - DONE on hugo
30
31 To do
32
33 - where to put under development links?
34 JMC would like to have some mention of unfinished things (checked in
35 but not that tested e.g. AB3)
36 Add an "Under development, chapter" - shortish description of what
37 is available (last chapter)
38
39 - add in example latex for formatting author names in different pieces.
40 this aknowledges peoples contributions and gives ref for who
41 to talk to.
42
43 o HTML, scripts and front content
44
45 - pick a URL
46 TBD
47
48 - mitgcm.org/r2_web_testing/latest
49 o add another short-cut for quick download
50
51 o add another short-cut
52 About
53 Installation
54 Contents
55 Overview
56 Tutorials (broken)
57 Browse Code
58
59 o words on http://mitgcm.org/r2_web_testing/latest
60 change to
61 "access on-line Auser manual/A and Atable of contents/A
62 and browse the Aoverview section/A"
63
64 o finite-volume doesn't leap to FV figure
65
66 o have another go at pnmcrop et al.
67
68 o Need an empty package as part of distribution. Check out atm_common
69
70 o Latex
71
72 Chapter 1 - CNH
73 o single kernel diagram -
74 add reference to MWR paper
75
76 o non-hydro
77 add reference to 1995 and 1999 papers
78 pdf of 1995 paper
79
80 o FV
81 add references to 1997 papers.
82
83 o Tangent linear/adjoint add reference to
84 Heimbach papers, Marotzke, 1998 ECMWF, Bugi etc...
85
86 o platforms
87 Add reference to SC article and Scientific Programming article
88
89 o List of key papers needs to be updated and reformatted
90
91 o Global atmosphere: `Held Suarez',
92 update Adcroft reference
93 fix up ingrid link and frame (ingrid movies seem to be broken?)
94 Held and Suarez reference is not a link.
95
96 o Ocean Gyres
97 fix up frame link
98 make "lopped cell" a link to referenced paper.
99 add references (ask Steph/Mick)
100 online/offline paper
101
102 o Convection and mixing over topography
103 add in Legg references for convection and mixing over topography
104 and external link to CPT-GCE etc...
105
106 o Boundary forced internal waves
107 add in Legg references, obc's reference
108
109 o Parameter sensitivity
110 add in Bugnion references, Boyin references, Steph references
111
112 o State estimation
113 add in references from Patrick/Carl/Ichiro/Detlef etc...
114 update links to point to latest ECCO results
115 ECCO ingrid results have been moved
116 add forward links to "ECCO state estimation" chapter in manual
117
118 o Ocean biogeochemical cycles
119 add in references from Mick/Galen etc...
120 fix ingrid link ( date to date thing does not appear to work)
121 figure url does not have a "target=idontexist" entry
122
123 o Simulations of laboratory experiments
124 reference Wardle and Karsten papers
125 update links to include DDDAS "PIAB" page
126 cylindrical polar coordinates
127
128 o Continuos equations in ''r'' coordinates
129 add references to iso paper
130 no mention of z* and p* - forward reference to z*/p* in 2.
131 add that coupling also manifests through F, Q
132 add tracer transport
133
134 o Kinematic boundary conditions
135
136 o Hydrostatic, Quasi-hydrostatic, Quasi-nonhydrostatic and
137 Non-hydrostatic forms
138 need to tidy up discussion of shallow-atmosphere to be
139 consistent with the code or change code to be consistent
140 with the discussion!
141 make references hyperlinks
142 add stuff too
143 JMC remove QNH atmosphere
144 need to sort out calc_gw for deep atmosphere
145
146 o Finding the pressure field
147 make references hyperlinks
148 add forward references to manual algorithm section
149 change Elliptic to "elliptic"
150
151 o Forcing and dissipation
152 make "physics packages" refer to chapter 6.
153 should we move "external forcing" et. al to a
154 generic_forcing_driver package?
155
156 viscosities
157 update to mention Smag/Leith (Ah and A4 not constant)
158 and to have forward references to numerical section
159 tracers
160 forward references to numerical section, reddy, GM etc...
161 add references to literature
162
163 o 1.3.8 Vector invariant form
164 forward references to numerical section
165
166 o 1.3.9 Adjoint
167 add a little more here + some hyperlink to chapter 5.
168
169 o 1.4 Appendix ATMOSPHERE
170
171 add some introductory words
172
173 o 1.6 Coordinate systems
174 o only has some words on spherical polar. add some brief words
175 to cover all of
176 - cartesian
177 - spherical
178 - cylindrical
179 - general orthogonal curvilinear (vector invariant)
180
181 o Equation of state options
182 add some discussion
183 can't remember what we said we were going to do here
184 PH to do something
185
186
187 Change hydrodynamical to "dynamical"
188
189 Examples
190
191 - extra "in action" cases
192
193 o high res ocean with diurnal atmospheric state forcing
194 - links to ingrid output
195 CNH/Dimitris
196
197 o realistic FIZHI from Andrea
198 - links to ingrid output
199 from AM
200
201 o with seaice on high res cube
202 - links to ingrid output
203 CNH/Dimitris
204
205 o coupled aqua, ridge world etc...
206 - links to ingrid output
207 get stuff from Daniel
208 Davids donut movie
209
210 o constrained lab simulation
211 - links to ingrid output for model and lab
212 fields
213 get stuff from Sai/Andrew
214
215 o sensitivity wrt to iron
216
217 o optimization
218 - update to link to latest ECCO sites and GF
219 related material
220
221 o eddy diffusivity transport application
222
223 o Gas giant?
224
225
226 >>>> from JM
227
228
229 manual, section.2 :
230
231 In general:
232 - add more refences/links to S/R & variable name
233 - would be nice to have an active link to the fortran-file
234 for all the S/R & eq.Number in the "calling-tree" boxes
235 - search for CALC_MOM_RHS and replace it by the appropriate S/R
236 (mom_flux_form, mom_vecinv, dynamics)
237 - Problem with notation: in section.1 \vec{\bf v_h} (or \vec{\mathbf{v}}_{h})
238 was used for the horizontal velocity vector, and the 3.D vector was \vec{\mathbf{v}}
239 in section.2, \vec{\bf v} is used instead and 3.D velocity vector is
240 simply written \vec{v}.
241 I would suggest to keep the notation as they are (since they are consistent
242 inside each section) but may be to move the "notation.tex" piece
243 at the beginning of section.2 and to mention clearly the changes between
244 the 2 sections.
245
246 in content: Horizontal Dissipation: 2 times in vector-invariant section
247
248 2.1 time-stepping (part2/time_stepping.tex)
249
250 - this is not clear to me:
251
252 >> In all the above configurations it is also possible to substitute the
253 >> Adams-Bashforth with an alternative time-stepping scheme for terms
254 >> evaluated explicitly in time
255
256
257 2.2 rigid-lid:
258
259 - At some point, would be better to replace "g \eta" with "\Phi_s (cg2d_x)"
260 to stay closer to the code.
261 - mention section 2.5 implicit-Time-stepping (for vertical viscosity)
262
263 2.3 linear free-surface:
264 - add ref(+link) to S/R names:
265 - add ref(+link) to Crank-Nickelson section 2.9.1
266
267 2.4 Adams-Bashforth
268 - add stability diagrams (I have some figures that I can put)
269 - add link for var. forcing_In_AB
270 - add S/R link for S/R ADAMS_BASHFORTH2
271
272 2.5 Implicit time-stepping
273 - add name of S/R: IMPLDIFF, GAD_IMPLICIT_R, MOM_U_IMPLICIT_R
274 SOLVE_TRIDIAGONAL, SOLVE_PENTADIAGONAL
275 - update: also used for vertical advection
276
277 2.6 Synchronous time-stepping:
278 - add link for S/R THERMODYNAMICS, DYNAMCIS, SOLVE_FOR_PRESSURE,
279 MOMENTUM_CORRECTION_STEP.
280
281 2.7 Stagger baroclinic time-stepping
282 - mention AB(T,S) instead of AB(Gt,Gs) (in development) at the end
283
284 2.8 NH
285 - add link & S/R names: CALC_GW, SOLVE_FOR_PRESSURE, CG3D
286
287 2.9 Variants on Free-Surface
288 - Delta.t mis-written (eq.2.73)
289 - Eq.Num missing (has been fixed since)
290 - u* is stored in gU (and not in gUnm1)
291 - Phi_nh in NH_VARS.h
292 - add link to S/R file: SOLVE_FOR_PRESSURE, CALC_DIV_GHAT, CG2D, CG3D,
293 INI_CG2D, INI_CG3D
294
295 2.9.1 Crank-Nickelson
296 - link for variable: implicSurfPress, implicDiv2DFlow, useRealFreshWater
297
298 2.9.2 NLFS
299 - eq.Nb are wrong in html
300 - 2.9.2.4 : set of eq. appears wrong in html (but right in .dvi)
301
302 2.10.1 Notation
303 - Area definition is not really used like this
304
305 >> Ao : Area of the face orthogonal to "o" direction (o=u,v,w)
306
307 Instead, in the following section, Ac,Aw,As,A_zeta (= corresponding to
308 the model variables) are used (e.g., see section 2.10.5)
309
310 2.10.5 Horizontal grid:
311 - fig.2.8 : should use Aw,As consistently in this figure description,
312 in the figure itself, as it is in the text.
313 - curvilinear:
314 to add: mention the angle of the grid direction relative to
315 Eastward, Northward direction.
316 + mention horizGridFile= in file "data" (PARM04)
317 - add cylindrical polar grid description
318 need to do a better job of relating model variables to this diagram
319
320
321 2.11 Continuity & Horizontal Pressure gradient terms
322 - mention that d.Phi/dr|s =g if using z coordinate
323 - eq. 2.90 not clear regarding \delta_k(P-E)
324 better to add the free surface eq: d.eta/dt = w_s + P-E
325
326 2.12 Hydrostatic balance
327 - add ref to Atmosphere Appendix section (1.4) since Adcroft 2002
328 is hard to find
329 - add ref to section 1.3.4 (Hydrostatic, Quasi-Hydrostatic & Non-H)
330 and in section 1.3.4: remove the 1.3.4.3.2 subsection:
331 Quasi-nonhydrostatic Atmosphere
332
333 2.13.2 Coriolis terms
334 - note: the discretization used when useEnergyConservingCoriolis=T
335 has no hFac and no Area and is still different from the form
336 described here (with Area & hFac);
337
338 2.13.5 Lateral dissipation
339 - add description of how to use cosFactor & cosPower
340 - add the parameter correspondence: Ah <-> viscAh ; A4 <-> viscA4
341 o need to relate c11, c12 etc.. to COSFAC, USE_COS etc... flags
342 in code need to explain why cos()3/2 turns out to be
343 scaling (not cos()2)
344 - need to reference the smag/leith section.
345
346 2.13.6 Vertical dissipation
347 - mention the implicit vertical viscosity option and ref to section 2.5
348 - add the parameter correspondence: Av <-> viscAr (and might change also
349 the notation to Ar)
350
351 2.14 Vector invariant momentum equations
352 - indicate that the NH pieces (vertical momentum eq) are not yet coded
353 and that the NH code uses the flux form.
354
355 2.14.6 Horizontal dissipation -> Horizontal Divergence
356
357 2.14.7 Horizontal dissipation
358 - add the parameter correspondence: A_D,A_z <-> viscAhD,viscAhZ
359 and A_D4,A_z4 <-> viscA4D,viscA4Z
360
361 2.16 & 2.17 & 2.18 :
362 - add 1rst Order upwind option & DST-2 (Lax-Wendroff) options
363 - fix equations 2.202 & 2.203 (thanks to Martin)
364
365 2.20.2 mercator, non-dimensional Equations:
366 - does not use std notation
367 - would be better as an appendix of section 2.20:
368 (e.g changing the tile to:
369 - talk to Baylor
370 Appendix: non-dimensional Equations on Spherical-Polar grid.)
371
372
373 Diagrams of grid locations etc.... and what variables and output files
374 and/or netcdf variable names are not very easy to figure out and follow.
375 It would be good to redo and extend these diagrams and align with GRID.h
376 content.
377
378
379 JM
380
381
382 >>>> From Andrea
383
384 Chapter 3
385 --------
386
387 Almost all of the 'math mode' text is dropped down as subscripts
388
389 3.1 - don't need a link to the outside of the document (remove it)
390 - link to htdig is broken
391
392 3.2.1 - link at bottom to source code points to section 3.2.1
393 (ie, to itself) - link should point to cvs code archive
394
395 3.2.2.1 - ('upgrading from an earlier version') belongs under
396 the cvs part, ie, should be 3.2.1.1
397
398 3.3 - remove reference to 'diags' section under MITgcm
399 - remove reference to 'exe' and 'bin' sections also
400 (remove the .cvsignore file under these directories in cvs)
401 - add a 'jobs' section, and a description as examples of run scripts
402 - add 'lsopt', 'optim' and 'tutorial examples' with brief descriptions
403 - under 'tools' add a reference to 'build_options'. refer to the 'optfiles'
404 - under 'tools' the adjoint points to section 5 - this is now section 8
405 (but should be a floating reference)
406 - under 'utils' add a reference to exch2 - stuff for different resolutions
407 - the description of the pkg section refers directly to
408 section 3. should be section 6 (actually should be a floating reference)
409
410 3.4 - refer to sections 3.8 - 3.18 (now says 3.8 - 3.10)
411 3.4.1 - links to the following experiments don't exist or are broken:
412 exp2 - should link to section 3.9
413 hs94.cs-32x32x5 - link to section 3.12
414 add 'convection' to the list, link to section 3.13
415 add 'plume on slope` to the list, link to section 3.14
416 add '??' link to section 3.15
417 add 'dic_example on slope` to the list, link to section 3.16
418 add '??' link to section 3.17
419 add 'offline' and link to section 3.18
420 clean up others and make links where they are needed
421 3.4.2 - text suggests to see section 2 for details about what is in the 'code'
422 and 'input' directories - should refer to the examples in this section
423 - add 'build' bullet - this is where the model is compiled and exectuable lives
424
425 3.5 - add some little text when talking about 'optfiles' to refer to the tools/build_options
426 as the place where they live (add a link?)
427
428 3.6.1 - Add some general 'approach' text - ie, output is controlled either by the
429 'data' file in the input directory or by the data.[pkg name] file for any
430 package running. And there is some default behavior when the 'state' dumps
431 are written.
432 3.6.1.2 - needs to be moved to inside section 3.6.2
433
434 All the 'overview' sections need some reference to the name of the experiment in
435 the verification directory
436
437 3.10 - in title, 4 degrees - degree symbol is a subscript, not a superscript
438 - is this experiment in the list from section 3.4???
439 3.10.3.1 - refers to figures and equations, links are broken
440
441 3.11.3.2 - line 43: link to equation is broken
442 - line 51-53: link to equation is broken
443 - there is some mess of text hanging around the end of this section. remove? reformat?
444
445 3.12.4.1 - line 34 - link to equation is broken
446 - lines 60,61 - 1st (take out the 'r' in the superscript)
447
448 3.13.2 - link to theta-equation is broken
449 3.13.5.4 -- ALL of the bold links to variable names are broken
450 line 34: link to equation is broken
451
452 3.15.1 - reference to 'fourth experiment' should be removed
453
454 3.16.4 - strange formatting, presence of '>' symbols - remove them
455
456 3.17.3 - unknown verification directory pointed to - also: no link from list in sec 3.4
457 3.17.3.1 - nothing filled in under file input/data - needs description
458
459 3.18.2 - point to section 2 for details - need hyperlink
460
461 3.19.1 - text (2 places) says that section 3.5 called for compile in 'input' directory - not true!
462 section 3.5 has the 'build' directory in the example
463
464 3.20.1 - link to doc at end of section points to this section
465 3.20.2 - link to doc at end of section points to this section
466
467 offline - duplicate inputs, what is it, tidy up cfc v.
468 other offline. JM thinks these need tidying up.
469
470 Which of the following are which tutorial?
471 adjustment.128x64x1
472 adjustment.cs-32x32x1
473 advect_cs
474 advect_xy
475 advect_xz
476 aim.5l_cs
477 aim.5l_Equatorial_Channel
478 aim.5l_LatLon
479 biogeo
480 bottom_ctrl_5x5
481 cfc_example
482 cpl_aim+ocn
483 dome
484 exp2
485 exp4
486 exp5
487 fizhi-cs-32x32x10
488 fizhi-cs-aqualev20
489 fizhi-gridalt-hs
490 flt_example
491 front_relax
492 global1x1_tot
493 global2x2_tot
494 global_ocean.90x40x15
495 global_ocean.cs32x15
496 global_ocean.cubed32x32x30
497 global_ocean_ebm
498 global_with_exf
499 hs94.128x64x5
500 hs94.1x64x5
501 hs94.cs-32x32x5
502 ideal_2D_oce
503 internal_wave
504 inverted_barometer
505 lab_sea
506 matrix_example
507 MLAdjust
508 natl_box
509 natl_box_adjoint
510 OpenAD
511 rotating_tank
512 solid-body.cs-32x32x1
513 tidal_basin_2d
514 tutorial_baroclinic_gyre
515 tutorial_barotropic_gyre
516 tutorial_cfc_offline
517 tutorial_deep_convection
518 tutorial_global_oce_biogeo
519 tutorial_global_oce_in_p
520 tutorial_global_oce_latlon
521 tutorial_global_oce_optim
522 tutorial_held_suarez_cs
523 tutorial_offline
524 tutorial_plume_on_slope
525 tutorial_tracer_adjsens
526 vermix
527
528 >>>> From Ed
529
530 Here are the remaining bits for Chap 4 :
531
532 - missing references (if you point me towards URLs, I'll add them
533 to the bibliography):
534 \ref{ref hoe and hill, ecmwf}
535 \ref{magicgarden}
536 \ref{IBMLAPI}
537 \ref{Memorychannel}
538 \ref{hoe-hill:99}
539
540 - There are a few empty sub-sections at the end of Chap 4 that
541 should either be commented out or fleshed out.
542
543 and thats about it for Chap 4.
544
545
546 Add more to quick links on front page
547
548 Chapter 6
549
550 the master package diagram does not appear in the document
551
552 Master list of packages (add this to beginning of chap 6)
553
554 admtlm/ - autodiff (chapter 5)
555 aim/ - retired
556 aim_compon_interf/ - 6.6 (no content yet)(Daniel + JM)
557 aim_ocn_coupler/ - 6.6 (no content yet)
558 aim_v23/ - 6.4.1 (content needs fixing - JM to do)
559 atm_common/ - nothing in this package (6.4.1 related)
560 autodiff/ - autodiff (chapter 5)
561 bulk_force/ - 6.3.3
562 cal/ - 6.3.5
563 cd_code/ - chapter 2 (JM check add a reference to paper,
564 mention parameter in data)
565 cfc/ - not sure (CNH to talk to Steph and Helen)
566 chronos/ - AM to check (not being used - Andrea to kill it)
567 compon_communic/ - 6.6 (no content yet)(Daniel + JM)
568 cost/ - not sure, check with PH
569 ctrl/ - not sure, check with PH
570 debug/ - JM may do something in chapter 7 (utilities)
571 diagnostics/ - 7.1
572 dic/ - 6.7.2
573 ebm/ - (check with PH)
574 ecco/ - chapter 8
575 embed_files/ - add something to chapter 7
576 exch2/ - 6.2.2
577 exf/ - 6.3.4
578 fizhi/ - 6.4.3
579 flt/ - (PH check)
580 gchem/ - 6.7.1
581 generic_advdiff/ - in chapter 2 (JM check)
582 ggl90/ - nothing, (Martin?)
583 gmredi/ - in chapter 2 (JM check). also need
584 Ferrari & Mc transition zone stuff (Samar doing this)
585 get dfer to read this
586 grdchk/ - grdchk (chapter 5 - check with PH)
587 gridalt/ - 6.2.4
588 kpp/ - 6.3.2
589 land/ - 6.4.2 (not connected to code Rong's notes - JM to fix)
590 matrix/ - Samar
591 mdsio/ - 7.3.1
592 mnc/ - 7.2.1
593 mom_common/ - in chapter 2 (JM check)
594 mom_fluxform/ - in chapter 2 (JM check)
595 mom_vecinv/ - in chapter 2 (JM check)
596 monitor/ - 7.4
597 my82/ - nothing, (martin?)
598 obcs/ - 6.3 (needs a check - ask PH to read)
599 ocn_compon_interf/ - 6.6 (no content yet)
600 offline/ - nothing, tutorials that need work but no package section entry
601 trivial to document (CNH to do)
602 opps/ - nothing, (martin?)
603 pp81/ - nothing, (martin?)
604 profiles/ - GAEL
605 ptracers/ - JM + SD + Martin to write something (nothing for this
606 at the moment)
607 AM has diagnostics table for this.
608 rbcs/ - CNH to talk to steph
609 runclock/ - runclock - CNH
610 rw/ - not sure - going to stay says JMC. quick IO calls
611 JMC to write a quick note for that.
612 sbo/ - text in sbo_descruption.tex but not linked into
613 part6 - CNH
614 seaice/ - 6.5.2 - no equations, dimitris has promised some
615 shap_filt/ - chapter 2, JM to check
616 shelfice/ - nothing yet (martin?)
617 solver/ - empty (go away?)
618 sphere/ - chapter 5 or 8 (PH to check)
619 therm_seaice/ - empty (go away?)
620 thsice/ - 6.5.1 (JM to update?)
621 timeave/ - retiring......
622 zonal_filt/ - chapter 2 (JM to check)
623
624 list an expeiment which uses package? CNH
625
626 6.3.1.7 Tapering: Large, Danabasoglu and Doney, JPO 1997
627 Figure 6.8 is missing
628
629
630 ===== Chapter 7 ===== [EH3 editing] :
631
632 7.1.x - JMC: please add description of:
633 - diagstat
634 - new temporal averaging feature
635
636 7.5.1 - add Graphix to the list of stuff in utils/matlab (Daniel)
637
638 7.5.2 - get bathymetry pre-processing stuff from Patrick
639 and then describe it
640
641 add something on spgrid mesh generator (maybe)?
642
643
644 andrea
645
646
647 9. Publications using MITgcm --> "Previous Applications of MITgcm"
648 Spall, Gianmaria, Legg, Dewar, Cessi, Cournelle, Follows, Adcroft, etc...
649 (check in support for more names)
650
651 10. Under development
652
653 Constantinos LCML
654
655
656 Bibliography
657
658 tidy up from misc - .tex

  ViewVC Help
Powered by ViewVC 1.1.22