Annotation of /MITgcm_contrib/high_res_cube/README

MITgcm contrib area for work on high-resolution cube configuration. Some items in here are
general for flexible cube tiling and grid generation and will be migrated to the main branch
as they evolve.

The four directories here are

1  code-mods/
    This contains the Wrapper2 point to point communication routines
    that are needed to support general cube tiling in either uni-processor
    or multi-processor forms. The routines include both initialization
    and exectution phase code. Currently they have only been applied to
    cube sphere setups, however the code should also work for cartesian
    cases. 
    To apply the code-mods to verification/global_ocean.cs32x15
    % cd verification/global_ocean.cs32x15
    % cd code
    % cp -pr CODE-MODS/* .
    % cd ..
    % mkdir build
    % cd build
    % ../../../tools/genmake2 -mods=../code -optfile=../../../tools/build_options/linux_ia32_ifc+mpi_cg01
    % make depend
    % make
    % cd ..
    % mkdir run
    % cd run
    % cp -pr TILE-EXAMPLE/tile* .
    % ln -s ../input/* .
    % ../build/mitgcmuv >& output

    Note - CODE-MODS/* refers to the path where the code-mods set is located.
           TILE-EXAMPLE/* refers to the path where the example tile*mitgrid files are located.
           Example in the subdirectory matlab-grid-converter/ is for a CS 32 grid.
    

2  matlab-grid-converter/
    This contains the matlab program for producing cube grid definition 
    tile**.mitgrid files that are read by ini_curvilinear_grid.F.
    This program is run on the output from matlab-grid-generator/

3  matlab-grid-generator/
    This contains matlab programs for generating cube sphere curvilinear grids
    that can be used to tile the sphere. A variety of different allgorithms
    are available for generating grids with a range of tunable parameters.

4  matlab-topology-generator/
    This contains matlab programs for generating cube index space toplogies
    describing the mapping between grid locations in terms of translations
    and rotations.
1	cnh	1.1	MITgcm contrib area for work on high-resolution cube configuration. Some items in here are
2			general for flexible cube tiling and grid generation and will be migrated to the main branch
3			as they evolve.
4
5			The four directories here are
6
7			1 code-mods/
8			This contains the Wrapper2 point to point communication routines
9			that are needed to support general cube tiling in either uni-processor
10			or multi-processor forms. The routines include both initialization
11			and exectution phase code. Currently they have only been applied to
12			cube sphere setups, however the code should also work for cartesian
13			cases.
14			To apply the code-mods to verification/global_ocean.cs32x15
15			% cd verification/global_ocean.cs32x15
16			% cd code
17			% cp -pr CODE-MODS/* .
18			% cd ..
19			% mkdir build
20			% cd build
21			% ../../../tools/genmake2 -mods=../code -optfile=../../../tools/build_options/linux_ia32_ifc+mpi_cg01
22			% make depend
23			% make
24			% cd ..
25			% mkdir run
26			% cd run
27			% cp -pr TILE-EXAMPLE/tile* .
28			% ln -s ../input/* .
29			% ../build/mitgcmuv >& output
30
31			Note - CODE-MODS/* refers to the path where the code-mods set is located.
32			TILE-EXAMPLE/* refers to the path where the example tile*mitgrid files are located.
33			Example in the subdirectory matlab-grid-converter/ is for a CS 32 grid.
34
35
36			2 matlab-grid-converter/
37			This contains the matlab program for producing cube grid definition
38			tile**.mitgrid files that are read by ini_curvilinear_grid.F.
39			This program is run on the output from matlab-grid-generator/
40
41			3 matlab-grid-generator/
42			This contains matlab programs for generating cube sphere curvilinear grids
43			that can be used to tile the sphere. A variety of different allgorithms
44			are available for generating grids with a range of tunable parameters.
45
46			4 matlab-topology-generator/
47			This contains matlab programs for generating cube index space toplogies
48			describing the mapping between grid locations in terms of translations
49			and rotations.