Annotation of /MITgcm_contrib/high_res_cube/code-mods/README

The following files have currently been added or customized for general topology communications.

TBD 
  o for general _RS _RL support the .template forms of exch_ and exch2_ need modifying/creating.
  o MDS based I/O needs to be modified to use tile base coodinates and not to assume a funcional relationship
    between nsx, snx etc...

w2_e2setup.F                   # Does main setting of topology arrays
                               # File is generated from matlab

W2_EXCH2_TOPOLOGY.h            # Holds topology arrays
                               # File is generated from matlab

exch2_xyz_rl.F                 # Does parallel communication for W2 topology
exch2_xy_rl.F                  # Does parallel communication for W2 topology
exch2_uv_xyz_rl.F              # Does parallel communication for W2 topology
exch2_uv_xy_rl.F               # Does parallel communication for W2 topology
exch2_rl2_cube.F               # Does parallel communication for W2 topology
exch2_rl1_cube.F               # Does parallel communication for W2 topology
exch2_get_send_bounds.F        # Does parallel communication for W2 topology
exch2_get_recv_bounds.F        # Does parallel communication for W2 topology
eeboot.F                       # Modified to call W2 toplogy setup
w2_print_comm_sequence.F       # Prints out comms defined by a topology
W2_EXCH2_PARAMS.h              # Mapping between topology and tiled arrays in MITgcm
W2_OPTIONS.h                   # Debug options
CPP_EEMACROS.h                 # Changed to map exch_ to exch2_
EEPARAMS.h                     # Buffer sized modded for debugging and testing
SIZE.h                         # Modified to match topology
                               # Needs to be consistent with
                               # W2_EXCH2_TOPOLOGY.h and
                               # w2_e2setup.F

CPP_EEOPTIONS.h
w2_eeboot.F                    # Drives setting of topology arrays
ini_curvilinear_grid.F         # Reads multi-domain grid definition including overlap 
                               # point at index maxima (i.e. snx+1, sny+1)

exch_uv_xy_rs.F                # call exch2_
exch_uv_xyz_rs.F               # call exch2_
exch_uv_xyz_rl.F               # call exch2_
exch_uv_xy_rl.F                # call exch2_
exch_xy_rl.F                   # call exch2_
exch2_send_rl1.F               # Does parallel communication for W2 topology
exch2_send_rl2.F               # Does parallel communication for W2 topology
exch2_recv_rl1.F               # Does parallel communication for W2 topology
exch2_recv_rl2.F               # Does parallel communication for W2 topology
mom_vi_calc_relvort3.F         # Vorticity switched off for testing

Directories holding example SIZE.h, w2_e2setup.F and W2_EXCH2_TOPOLOGY.h are
as follows. Examples are all for a cs32 index space with different tile sizes.
Until mdsio is fixed to understand tiling only s6t_32x32/, 
s24t_8x32/ and s12t_16x32/ are allowed for runs that rely on global
datasets for input (bathymetry, forcing, pickups etc..) because the cube
global file mode only looks like the cartesian form when sny is the same as
the cube size. However, it is possible to arbitrary size tile runs when using 
tiled input files.

s12t_16x32/                   # 12 tiles of size 16x32
s24t_16x16/                   # 24 tiles of size 16x16 (I/O not available)
s24t_32x8/                    # 24 tiles of size 32x8  (I/O not available)
s24t_8x32/                    # 24 tiles of size  8x32 
s6t_32x32/                    #  6 tiles of size 32x32
s60t_51x510                   # 60 tiles of size 51x510

s216t_85x85      - 216 tiles of 85x85. There are no "skipped" tiles for
                   this configuration.
                   Old style bathymetry file needs to be 85x85x216.

s205t_85x85      - 205 tiles of 85x85. List of "skipped" tiles is in 
                   blanklist.txt.
                   Old style bathymetry file needs to be 85x85x205.

s1500t_17x51     - 1500 tiles of 17x51. List of skipped tiles relative to
                   full 1800 tile topology is in "blanklist.txt".
                   Old style bathymetry file needs to be 17x51x500.

s1800t_17x51     - 1800 tiles of 17x51. There are no "skipped" tiles for
                   this configuration.
                   Old style bathymetry file needs to be 17x51x1800.
1	cnh	1.1	The following files have currently been added or customized for general topology communications.
2
3			TBD
4			o for general _RS _RL support the .template forms of exch_ and exch2_ need modifying/creating.
5			o MDS based I/O needs to be modified to use tile base coodinates and not to assume a funcional relationship
6			between nsx, snx etc...
7
8			w2_e2setup.F # Does main setting of topology arrays
9			# File is generated from matlab
10
11			W2_EXCH2_TOPOLOGY.h # Holds topology arrays
12			# File is generated from matlab
13
14			exch2_xyz_rl.F # Does parallel communication for W2 topology
15			exch2_xy_rl.F # Does parallel communication for W2 topology
16			exch2_uv_xyz_rl.F # Does parallel communication for W2 topology
17			exch2_uv_xy_rl.F # Does parallel communication for W2 topology
18			exch2_rl2_cube.F # Does parallel communication for W2 topology
19			exch2_rl1_cube.F # Does parallel communication for W2 topology
20			exch2_get_send_bounds.F # Does parallel communication for W2 topology
21			exch2_get_recv_bounds.F # Does parallel communication for W2 topology
22			eeboot.F # Modified to call W2 toplogy setup
23			w2_print_comm_sequence.F # Prints out comms defined by a topology
24			W2_EXCH2_PARAMS.h # Mapping between topology and tiled arrays in MITgcm
25			W2_OPTIONS.h # Debug options
26			CPP_EEMACROS.h # Changed to map exch_ to exch2_
27			EEPARAMS.h # Buffer sized modded for debugging and testing
28			SIZE.h # Modified to match topology
29			# Needs to be consistent with
30			# W2_EXCH2_TOPOLOGY.h and
31			# w2_e2setup.F
32
33			CPP_EEOPTIONS.h
34			w2_eeboot.F # Drives setting of topology arrays
35			ini_curvilinear_grid.F # Reads multi-domain grid definition including overlap
36			# point at index maxima (i.e. snx+1, sny+1)
37
38			exch_uv_xy_rs.F # call exch2_
39			exch_uv_xyz_rs.F # call exch2_
40			exch_uv_xyz_rl.F # call exch2_
41			exch_uv_xy_rl.F # call exch2_
42			exch_xy_rl.F # call exch2_
43			exch2_send_rl1.F # Does parallel communication for W2 topology
44			exch2_send_rl2.F # Does parallel communication for W2 topology
45			exch2_recv_rl1.F # Does parallel communication for W2 topology
46			exch2_recv_rl2.F # Does parallel communication for W2 topology
47			mom_vi_calc_relvort3.F # Vorticity switched off for testing
48
49			Directories holding example SIZE.h, w2_e2setup.F and W2_EXCH2_TOPOLOGY.h are
50			as follows. Examples are all for a cs32 index space with different tile sizes.
51			Until mdsio is fixed to understand tiling only s6t_32x32/,
52			s24t_8x32/ and s12t_16x32/ are allowed for runs that rely on global
53			datasets for input (bathymetry, forcing, pickups etc..) because the cube
54			global file mode only looks like the cartesian form when sny is the same as
55			the cube size. However, it is possible to arbitrary size tile runs when using
56			tiled input files.
57
58			s12t_16x32/ # 12 tiles of size 16x32
59			s24t_16x16/ # 24 tiles of size 16x16 (I/O not available)
60			s24t_32x8/ # 24 tiles of size 32x8 (I/O not available)
61			s24t_8x32/ # 24 tiles of size 8x32
62			s6t_32x32/ # 6 tiles of size 32x32
63			s60t_51x510 # 60 tiles of size 51x510
64
65	dimitri	1.2	s216t_85x85 - 216 tiles of 85x85. There are no "skipped" tiles for
66			this configuration.
67			Old style bathymetry file needs to be 85x85x216.
68
69			s205t_85x85 - 205 tiles of 85x85. List of "skipped" tiles is in
70			blanklist.txt.
71			Old style bathymetry file needs to be 85x85x205.
72
73			s1500t_17x51 - 1500 tiles of 17x51. List of skipped tiles relative to
74			full 1800 tile topology is in "blanklist.txt".
75			Old style bathymetry file needs to be 17x51x500.
76
77			s1800t_17x51 - 1800 tiles of 17x51. There are no "skipped" tiles for
78			this configuration.
79			Old style bathymetry file needs to be 17x51x1800.