verification/adjustment.cs-32x32x1/README

Simple 1 layer, Barotropic adjustment on the Sphere, using the
                cubed-sphere grid 32x32x32
Contains also a "minimal" test case (just compile eesupp/src + pkgs)
                that does not do much.
=================================================================

General Description:
* using the same executable, 2 set-up can be tested, corresponding
  to input dir. "input" and "input.nlfs".
* Default set-up (input & parameter files in dir "input"):
  Oceanic set-up with flat bottom and a large quasi-rectangular
  continent is initially at rest. An initial free-surface large-scale
  anomaly centered at the equator triggers a barotropic adjustment
  and generates External Inertial-Gravity waves (Poincare waves).
  Use linear Free-Surface and linear dynamics (no momentum advection)
* Additional set-up (input & parameter files in dir "input.nlfs"):
  Atmospheric set-up, without orography, initially at rest.
  An initial large-scale surface pressure anomaly generated pure
  external gravity waves.
  Use non-linear Free-Surface, linear dynamics (no momentum advection)
  without rotation.

IMPORTANT: For the purpose of testing multiple tiles and "blank-tiles":
* Use multiple tiles (8) per cube-face (tile size: 16x8),
  which results in a total of 48 tiles:
    code/SIZE.h
    code/W2_EXCH2_TOPOLOGY.h : to replace pkg/exch2/W2_EXCH2_TOPOLOGY.h
                               ( = 6-tiles default version )
    code/w2_e2setup.F        : to replace pkg/exch2/W2_EXCH2_TOPOLOGY.h
  the last 2 files ave been generated with matlab script:
        MITgcm/utils/exch2/matlab-topology-generator/driver.m
* The oceanic-set-up contains 4 empty tiles (tiles: 11,12,13,14)
  associated with the large continent.
  This gives the opportunity to test the "blank-tiles" option of
  the EXCH2 pkg. An MPI version of this set-up is available to
  test this "blank-tiles" option:
    code/SIZE.h_mpi          : to replace code/SIZE.h
    code/W2_EXCH2_TOPOLOGY.h : to replace pkg/exch2/W2_EXCH2_TOPOLOGY.h
    code/w2_e2setup.F_mpi    : to replace code/CPP_EEOPTIONS.h_mpi
      generated with matlab script:
        MITgcm/utils/exch2/matlab-topology-generator/driver.m
      using the blank-list file: code/blanklist.txt
    code/CPP_EEOPTIONS.h_mpi : to replace eesupp/inc/CPP_EEOPTIONS.h
  However, this particular (MPI) executable cannot be used for the
  atmospheric set-up (input.nlfs) and, in this case, an error
  from S/R EXCH2_CHECK_DEPTHS will stop the execution.

Forcing : none
Input Files (initial conditions) :

Comments:

=================================================================
"minimal" test case:
 provide an example of a minimal set-up which only compiles eesupp/src
 and the 2 pkgs (exch2 & debug) which don't need model/src & inc.

code_min:
  CPP_OPTIONS.h (standard version, needed here since model/inc is not linked)
  packages.conf (2 pkgs: exch2 & debug)
  main.F        (copied from eesupp/src, but skip the call to THE_MODEL_MAIN)
  SIZE.h        (same as code/SIZE.h)
  SIZE.h_mpi    (same as code/SIZE.h_mpi)

input_min
  eedataa       (standard version)
  eedata.mth    (to test running 2 threads)
  data.exch2.mpi (to test blank-tiles with exch2 and MPI built)

to build:
 in order not to compile model/src, need to:
 either put (in build dir) a "genmake_local" file:
 % cat > genmake_local <<EOF
  STANDARDDIRS="eesupp"
EOF
 - or -
 use genmake2 command line: "genmake2 -standarddirs eesupp -mods ../code_min"

=================================================================
1	jmc	1.2	Simple 1 layer, Barotropic adjustment on the Sphere, using the
2			cubed-sphere grid 32x32x32
3			Contains also a "minimal" test case (just compile eesupp/src + pkgs)
4			that does not do much.
5	jmc	1.1	=================================================================
6
7			General Description:
8	jmc	1.2	* using the same executable, 2 set-up can be tested, corresponding
9	jmc	1.1	to input dir. "input" and "input.nlfs".
10			* Default set-up (input & parameter files in dir "input"):
11	jmc	1.2	Oceanic set-up with flat bottom and a large quasi-rectangular
12			continent is initially at rest. An initial free-surface large-scale
13			anomaly centered at the equator triggers a barotropic adjustment
14	jmc	1.1	and generates External Inertial-Gravity waves (Poincare waves).
15			Use linear Free-Surface and linear dynamics (no momentum advection)
16			* Additional set-up (input & parameter files in dir "input.nlfs"):
17	jmc	1.2	Atmospheric set-up, without orography, initially at rest.
18	jmc	1.1	An initial large-scale surface pressure anomaly generated pure
19			external gravity waves.
20			Use non-linear Free-Surface, linear dynamics (no momentum advection)
21			without rotation.
22
23			IMPORTANT: For the purpose of testing multiple tiles and "blank-tiles":
24			* Use multiple tiles (8) per cube-face (tile size: 16x8),
25			which results in a total of 48 tiles:
26	jmc	1.2	code/SIZE.h
27	jmc	1.1	code/W2_EXCH2_TOPOLOGY.h : to replace pkg/exch2/W2_EXCH2_TOPOLOGY.h
28			( = 6-tiles default version )
29			code/w2_e2setup.F : to replace pkg/exch2/W2_EXCH2_TOPOLOGY.h
30			the last 2 files ave been generated with matlab script:
31			MITgcm/utils/exch2/matlab-topology-generator/driver.m
32			* The oceanic-set-up contains 4 empty tiles (tiles: 11,12,13,14)
33			associated with the large continent.
34	jmc	1.2	This gives the opportunity to test the "blank-tiles" option of
35			the EXCH2 pkg. An MPI version of this set-up is available to
36	jmc	1.1	test this "blank-tiles" option:
37			code/SIZE.h_mpi : to replace code/SIZE.h
38			code/W2_EXCH2_TOPOLOGY.h : to replace pkg/exch2/W2_EXCH2_TOPOLOGY.h
39			code/w2_e2setup.F_mpi : to replace code/CPP_EEOPTIONS.h_mpi
40	jmc	1.2	generated with matlab script:
41	jmc	1.1	MITgcm/utils/exch2/matlab-topology-generator/driver.m
42			using the blank-list file: code/blanklist.txt
43			code/CPP_EEOPTIONS.h_mpi : to replace eesupp/inc/CPP_EEOPTIONS.h
44	jmc	1.2	However, this particular (MPI) executable cannot be used for the
45			atmospheric set-up (input.nlfs) and, in this case, an error
46	jmc	1.1	from S/R EXCH2_CHECK_DEPTHS will stop the execution.
47	jmc	1.2
48	jmc	1.1	Forcing : none
49			Input Files (initial conditions) :
50
51			Comments:
52	jmc	1.2
53			=================================================================
54			"minimal" test case:
55			provide an example of a minimal set-up which only compiles eesupp/src
56			and the 2 pkgs (exch2 & debug) which don't need model/src & inc.
57
58			code_min:
59			CPP_OPTIONS.h (standard version, needed here since model/inc is not linked)
60			packages.conf (2 pkgs: exch2 & debug)
61			main.F (copied from eesupp/src, but skip the call to THE_MODEL_MAIN)
62			SIZE.h (same as code/SIZE.h)
63			SIZE.h_mpi (same as code/SIZE.h_mpi)
64
65			input_min
66			eedataa (standard version)
67			eedata.mth (to test running 2 threads)
68			data.exch2.mpi (to test blank-tiles with exch2 and MPI built)
69
70			to build:
71			in order not to compile model/src, need to:
72	jmc	1.3	either put (in build dir) a "genmake_local" file:
73			% cat > genmake_local <<EOF
74			STANDARDDIRS="eesupp"
75			EOF
76	jmc	1.2	- or -
77	jmc	1.3	use genmake2 command line: "genmake2 -standarddirs eesupp -mods ../code_min"
78	jmc	1.2
79			=================================================================