Annotation of /MITgcm/optim/README


c     expid           - experiment name
c     optimcycle      - optimization no.
c     missing value   - missing value identifier (usually -9999.)
c     ig              - global start index x (zonal)
c     jg              - global start index y (medid.)
c     nsx             - no. of x-subgrids
c     nsy             - no. of y-subgrids

 >>> MISSING: <<<
c     nr              - no. of z-points vertical
c     snx
c     sny
c     nvartype
c     nvarlength
 >>> <<<

c     maxcvars        - Number of control variables
c                       (currently 6; 2 init. + 4 bound.)
      integer     maxcvars
      parameter ( maxcvars = 20 )

c     ncvarindex      - "arbitrary" index to define variable:
c                       * 101: initial temp.
c                       * 102: initial sali.
c                       * 103: heat flux
c                       * 104: freshwater flux
c                       * 105: u stress (zonal)
c                       * 106: v stress (meri.)
      integer ncvarindex    ( maxcvars )

c     ncvarrecs       - no. of records in control vector
c                       * = 1                      for init. temp./sali.
c                       * = endrec - startrec + 1  for fluxes
      integer ncvarrecs     ( maxcvars )

c     ncvarrecstart   - first record:
c                       * NOT DEFINED  for init. temp./sali.
c                       * = startrec   for fluxes
      integer ncvarrecstart ( maxcvars )

c     ncvarrecsend    - last record:
c                       * NOT DEFINED  for init. temp./sali.
c                       * = endrec     for fluxes
      integer ncvarrecsend  ( maxcvars )

c     ncvarxmax       - no. of x-points in subgrid (zonal)
c                       = snx
      integer ncvarxmax     ( maxcvars )

c     ncvarymax       - no. of y-points in subgrid (meri.)
c                       = sny
      integer ncvarymax     ( maxcvars )

c     ncvarnrmax      - no. of z-points (vert.)
c                       * = nr  for init. temp./sali.
c                       * = 1   for fluxes
      integer ncvarnrmax    ( maxcvars )

c     nwet[c/s/w]tile - Number of wet points in a tile for center (c),
c                       south (s), and western (w) mask, resp.
      integer nwetctile     ( nsx, nsy, nr )
      integer nwetstile     ( nsx, nsy, nr )
      integer nwetwtile     ( nsx, nsy, nr )

c     ncvargrd        - position in grid
c                       * = 'c' : (center,center)
c                       * = 's' : (center,south)
c                       * = 'w' : (west,center)
      character*(1) ncvargrd(maxcvars)
1	heimbach	1.1.2.1
2			c expid - experiment name
3			c optimcycle - optimization no.
4			c missing value - missing value identifier (usually -9999.)
5			c ig - global start index x (zonal)
6			c jg - global start index y (medid.)
7			c nsx - no. of x-subgrids
8			c nsy - no. of y-subgrids
9
10			>>> MISSING: <<<
11			c nr - no. of z-points vertical
12			c snx
13			c sny
14			c nvartype
15			c nvarlength
16			>>> <<<
17
18			c maxcvars - Number of control variables
19			c (currently 6; 2 init. + 4 bound.)
20			integer maxcvars
21			parameter ( maxcvars = 20 )
22
23			c ncvarindex - "arbitrary" index to define variable:
24			c * 101: initial temp.
25			c * 102: initial sali.
26			c * 103: heat flux
27			c * 104: freshwater flux
28			c * 105: u stress (zonal)
29			c * 106: v stress (meri.)
30			integer ncvarindex ( maxcvars )
31
32			c ncvarrecs - no. of records in control vector
33			c * = 1 for init. temp./sali.
34			c * = endrec - startrec + 1 for fluxes
35			integer ncvarrecs ( maxcvars )
36
37			c ncvarrecstart - first record:
38			c * NOT DEFINED for init. temp./sali.
39			c * = startrec for fluxes
40			integer ncvarrecstart ( maxcvars )
41
42			c ncvarrecsend - last record:
43			c * NOT DEFINED for init. temp./sali.
44			c * = endrec for fluxes
45			integer ncvarrecsend ( maxcvars )
46
47			c ncvarxmax - no. of x-points in subgrid (zonal)
48			c = snx
49			integer ncvarxmax ( maxcvars )
50
51			c ncvarymax - no. of y-points in subgrid (meri.)
52			c = sny
53			integer ncvarymax ( maxcvars )
54
55			c ncvarnrmax - no. of z-points (vert.)
56			c * = nr for init. temp./sali.
57			c * = 1 for fluxes
58			integer ncvarnrmax ( maxcvars )
59
60			c nwet[c/s/w]tile - Number of wet points in a tile for center (c),
61			c south (s), and western (w) mask, resp.
62			integer nwetctile ( nsx, nsy, nr )
63			integer nwetstile ( nsx, nsy, nr )
64			integer nwetwtile ( nsx, nsy, nr )
65
66			c ncvargrd - position in grid
67			c * = 'c' : (center,center)
68			c * = 's' : (center,south)
69			c * = 'w' : (west,center)
70			character*(1) ncvargrd(maxcvars)