/[MITgcm]/manual/manual_todo.txt

Diff of /manual/manual_todo.txt

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

-revision 1.38 by cnh,
Wed Jun 28 15:36:02 2006 UTC
+revision 1.45 by cnh,
Thu Jun 29 17:45:14 2006 UTC
 Line 233 
 In general:
  - would be nice to have an active link to the fortran-file
    for all the S/R & eq.Number in the "calling-tree" boxes
  - search for CALC_MOM_RHS and replace it by the appropriate S/R
-   (mom_flux_form, mom_vecinv, dynamics)
+   (mom_flux_form, mom_vecinv, dynamics) <- DONE
  - Problem with notation: in section.1 \vec{\bf v_h} (or \vec{\mathbf{v}}_{h})
  was used for the horizontal velocity vector, and the 3.D vector was \vec{\mathbf{v}}
  in section.2, \vec{\bf v} is used instead and 3.D velocity vector is
 Line 244 
 at the beginning of section.2 and to men
  the 2 sections.
  in content: Horizontal Dissipation: 2 times in vector-invariant section
+ <- DONE
 .1 time-stepping (part2/time_stepping.tex)
-Line 252 
 in content: Horizontal Dissipation: 2 ti
+Line 253 
 in content: Horizontal Dissipation: 2 ti
  >> In all the above configurations it is also possible to substitute the
  >> Adams-Bashforth with an alternative time-stepping scheme for terms
  >> evaluated explicitly in time
+ <- Leave it general.
 .2 rigid-lid:
  - At some point, would be better to replace "g \eta" with "\Phi_s (cg2d_x)"
    to stay closer to the code.
- - mention section 2.5 implicit-Time-stepping (for vertical viscosity)
+ - mention section 2.5 implicit-Time-stepping (for vertical viscosity) <- DONE
 .3 linear free-surface:
  - add ref(+link) to S/R names:
- - add ref(+link) to Crank-Nickelson section 2.9.1
+ - add ref(+link) to Crank-Nickelson section 2.9.1 <- DONE
 .4 Adams-Bashforth
- - add stability diagrams (I have some figures that I can put)
+ - add stability diagrams (I have some figures that I can put) <- DONE
- - add link for var. forcing_In_AB
+ - add link for var. forcing_In_AB and epsil_AB <- half DONE
- - add S/R link for S/R ADAMS_BASHFORTH2
+ - add S/R link for S/R ADAMS_BASHFORTH2 <-DONE
 .5 Implicit time-stepping
  - add name of S/R: IMPLDIFF, GAD_IMPLICIT_R, MOM_U_IMPLICIT_R
-Line 285 
 in content: Horizontal Dissipation: 2 ti
+Line 287 
 in content: Horizontal Dissipation: 2 ti
  - add link & S/R names: CALC_GW, SOLVE_FOR_PRESSURE, CG3D
 .9 Variants on Free-Surface
- - Delta.t mis-written (eq.2.73)
+ - Delta.t mis-written (eq.2.73) <- DONE
- - Eq.Num missing (has been fixed since)
+ - Eq.Num missing <- DONE
- - u* is stored in gU (and not in gUnm1)
+ - u* is stored in gU (and not in gUnm1) <- DONE
- - Phi_nh in NH_VARS.h
+ - Phi_nh in NH_VARS.h <- DONE
  - add link to S/R file: SOLVE_FOR_PRESSURE, CALC_DIV_GHAT, CG2D, CG3D,
    INI_CG2D, INI_CG3D
-Line 298 
 in content: Horizontal Dissipation: 2 ti
+Line 300 
 in content: Horizontal Dissipation: 2 ti
 .9.2 NLFS
  - eq.Nb are wrong in html
  - 2.9.2.4 : set of eq. appears wrong in html (but right in .dvi)
+  <- DONE
 .10.1 Notation
  - Area definition is not really used like this
-Line 306 
 in content: Horizontal Dissipation: 2 ti
+Line 309 
 in content: Horizontal Dissipation: 2 ti
    Instead, in the following section, Ac,Aw,As,A_zeta (= corresponding to
    the model variables) are used (e.g., see section 2.10.5)
+ <- DONE
 .10.5 Horizontal grid:
  - fig.2.8 : should use Aw,As consistently in this figure description,
-   in the figure itself, as it is in the text.
+   in the figure itself, as it is in the text. <- DONE
  - curvilinear:
    to add: mention the angle of the grid direction relative to
    Eastward, Northward direction.
-Line 360 
 in content: Horizontal Dissipation: 2 ti
+Line 364 
 in content: Horizontal Dissipation: 2 ti
 .16 & 2.17 & 2.18 :
   - add 1rst Order upwind option & DST-2 (Lax-Wendroff) options
-  - fix equations 2.202 & 2.203 (thanks to Martin)
+  - fix equations 2.202 & 2.203 (thanks to Martin) <- DONE
 .20.2 mercator, non-dimensional Equations:
  - does not use std notation
-Line 368 
 in content: Horizontal Dissipation: 2 ti
+Line 372 
 in content: Horizontal Dissipation: 2 ti
  (e.g changing the tile to:
  - talk to Baylor
   Appendix: non-dimensional Equations on Spherical-Polar grid.)
+  <- No (Chris said)
  Diagrams of grid locations etc.... and what variables and output files
-Line 386 
 Chapter 3
+Line 391 
 Chapter 3
  Almost all of the 'math mode' text is dropped down as subscripts
-.1 - don't need a link to the outside of the document (remove it)
+.11.3.1 - refers to figures and equations, links are broken
-     - link to htdig is broken
-.2.1 - link at bottom to source code points to section 3.2.1
+.12.3.2 - line 43: link to equation is broken
-    (ie, to itself) - link should point to cvs code archive
-.2.2.1  - ('upgrading from an earlier version') belongs under
-       the cvs part, ie, should be 3.2.1.1
-.3 - remove reference to 'diags' section under MITgcm
-     - remove reference to 'exe' and 'bin' sections also
-       (remove the .cvsignore file under these directories in cvs)
-     - add a 'jobs' section, and a description as examples of run scripts
-     - add 'lsopt', 'optim' and 'tutorial examples' with brief descriptions
-     - under 'tools' add a reference to 'build_options'. refer to the 'optfiles'
-     - under 'tools' the adjoint points to section 5 - this is now section 8
-       (but should be a floating reference)
-     - under 'utils' add a reference to exch2 - stuff for different resolutions
-     - the description of the pkg section refers directly to
-       section 3. should be section 6 (actually should be a floating reference)
-.4 - refer to sections 3.8 - 3.18 (now says 3.8 - 3.10)
-.4.1 - links to the following experiments don't exist or are broken:
-           exp2 - should link to section 3.9
-           hs94.cs-32x32x5 - link to section 3.12
-           add 'convection' to the list, link to section 3.13
-           add 'plume on slope` to the list, link to section 3.14
-           add '??' link to section 3.15
-           add 'dic_example on slope` to the list, link to section 3.16
-           add '??' link to section 3.17
-           add 'offline' and link to section 3.18
-           clean up others and make links where they are needed
-.4.2 - text suggests to see section 2 for details about what is in the 'code'
-         and 'input' directories - should refer to the examples in this section
-       - add 'build' bullet - this is where the model is compiled and exectuable lives
-.5 - add some little text when talking about 'optfiles' to refer to the tools/build_options
-       as the place where they live (add a link?)
-.6.1 - Add some general 'approach' text - ie, output is controlled either by the
-         'data' file in the input directory or by the data.[pkg name] file for any
-         package running. And there is some default behavior when the 'state' dumps
-         are written.
-.6.1.2 - needs to be moved to inside section 3.6.2
- All the 'overview' sections need some reference to the name of the experiment in
- the verification directory
-.10 - in title, 4 degrees - degree symbol is a subscript, not a superscript
-      - is this experiment in the list from section 3.4???
-.10.3.1 - refers to figures and equations, links are broken
-.11.3.2 - line 43: link to equation is broken
           - line 51-53: link to equation is broken
           - there is some mess of text hanging around the end of this section. remove? reformat?
-.12.4.1 - line 34 - link to equation is broken
+.13.4.1 - line 34 - link to equation is broken
           - lines 60,61 - 1st (take out the 'r' in the superscript)
-.13.2 - link to theta-equation is broken
+.14.2 - link to theta-equation is broken
-.13.5.4 -- ALL of the bold links to variable names are broken
+.14.5.4 -- ALL of the bold links to variable names are broken
              line 34: link to equation is broken
-.15.1 - reference to 'fourth experiment' should be removed
-.16.4 - strange formatting, presence of '>' symbols - remove them
-.17.3 - unknown verification directory pointed to - also: no link from list in sec 3.4
-.17.3.1 - nothing filled in under file input/data - needs description
-.18.2 - point to section 2 for details - need hyperlink
-.19.1 - text (2 places) says that section 3.5 called for compile in 'input' directory - not true!
-          section 3.5 has the 'build' directory in the example
-.20.1 - link to doc at end of section points to this section
-.20.2 - link to doc at end of section points to this section
-      offline - duplicate inputs, what is it, tidy up cfc v.
-                other offline. JM thinks these need tidying up.
- Which of the following are which tutorial?
- adjustment.128x64x1
- adjustment.cs-32x32x1
- advect_cs
- advect_xy
- advect_xz
- aim.5l_cs
- aim.5l_Equatorial_Channel
- aim.5l_LatLon
- biogeo
- bottom_ctrl_5x5
- cfc_example
- cpl_aim+ocn
- dome
- exp2
- exp4
- exp5
- fizhi-cs-32x32x10
- fizhi-cs-aqualev20
- fizhi-gridalt-hs
- flt_example
- front_relax
- global1x1_tot
- global2x2_tot
- global_ocean.90x40x15
- global_ocean.cs32x15
- global_ocean.cubed32x32x30
- global_ocean_ebm
- global_with_exf
- hs94.128x64x5
- hs94.1x64x5
- hs94.cs-32x32x5
- ideal_2D_oce
- internal_wave
- inverted_barometer
- lab_sea
- matrix_example
- MLAdjust
- natl_box
- natl_box_adjoint
- OpenAD
- rotating_tank
- solid-body.cs-32x32x1
- tidal_basin_2d
- tutorial_baroclinic_gyre
- tutorial_barotropic_gyre
- tutorial_cfc_offline
- tutorial_deep_convection
- tutorial_global_oce_biogeo
- tutorial_global_oce_in_p
- tutorial_global_oce_latlon
- tutorial_global_oce_optim
- tutorial_held_suarez_cs
- tutorial_offline
- tutorial_plume_on_slope
- tutorial_tracer_adjsens
- vermix
  >>>> From Ed
  Here are the remaining bits for Chap 4 :
-Line 640 
 list an expeiment which uses package? CN
+Line 519 
 list an expeiment which uses package? CN
  add something on spgrid mesh generator (maybe)?
+ add in gmaze PV calculation scripts plus write up on how it is calculated
+ http://mitgcm.org/cgi-bin/viewcvs.cgi/MITgcm_contrib/gmaze_pv/
  andrea

 Legend:



Removed from v.1.38
 


changed lines


 
Added in v.1.45
 Legend:



Removed from v.1.38
 


changed lines


 
Added in v.1.45
-Removed from v.1.38
+Added in v.1.45

	ViewVC Help
Powered by ViewVC 1.1.22