MITgcm_contrib/nesting_sannino/README.txt

23-Oct-2009
-----------
gianmaria.sannino@enea.it


Initial checkin and first round of merging of two-way nesting code as described in:
Sannino, G., M. Herrmann, A. Carillo, V. Rupolo, V. Ruggiero, V. Artale and P. Heimbach, 2009:
An eddy-permitting model of the Mediterranean Sea with a two-way grid refinement at Gibraltar.
Ocean Modelling, 30(1), 56-72, doi: 10.1016/j.ocemod.2009.06.002

Contents:
--------

code_parent/        header files for a PARENT configuration
code_child/         header files for a CHILD configuration
code_nest_merged/   routines which need to be merged with MITgcm dynamical core and WRAPPER
nest_parent/        package for PARENT code
nest_child/         package for CHILD code
nest_driver/        external fortran routines driving the 2-way nesting

utils/              some useful scripts and information text files

bld_parent/         where to build PARENT - empty -
bld_child/          where to build CHILD  - empty -
bld_driver/         where to build DRIVER - almost empty -

input/              input binary files for simplified nested set-up test
params/             parameter files    for simplified nested set-up test
results/            reference output file from a short nested run

Information on how to build executable: in utils/notes_bld
Information on how to run nested test : in utils/notes_run

==============================================================
 modification list :
==============================================================

------------
27-Nov-2010:

driver:
  split driver_nesting.F into "main.F" and "interpolation_p2c.F":
  -use standard "gemake2" to build driver.
  -change current dir + open & write to (proc specific) log file
  -fix several problems (mostly in driver).

parent & child pkgs:
  -bring nesting code up-to date with MITgcm source code checkpoint62o
  -move nesting code out of eeboot_minimal.F into nest_eeinit.F
  -move nesting arrays out of GRID.h into new header file "NEST_SHARED.h"
  -change current dir to "rankNN"

add parameter files and results of simplified Med_Gib nested set-up test

driver,parent & child: (29 Nov)
  -parent & child send number of nesting steps to driver; stop if mismatch.

code_nest_merged: ( 6 Dec)
  finish merging of nested code into main code: remove the last 2 remaining
  S/R: solve_for_pressure.F & obcs_calc.F
------------
1	sannino	1.2	23-Oct-2009
2	heimbach	1.1	-----------
3			gianmaria.sannino@enea.it
4
5	sannino	1.2
6	heimbach	1.1	Initial checkin and first round of merging of two-way nesting code as described in:
7	jmc	1.3	Sannino, G., M. Herrmann, A. Carillo, V. Rupolo, V. Ruggiero, V. Artale and P. Heimbach, 2009:
8			An eddy-permitting model of the Mediterranean Sea with a two-way grid refinement at Gibraltar.
9	heimbach	1.1	Ocean Modelling, 30(1), 56-72, doi: 10.1016/j.ocemod.2009.06.002
10
11			Contents:
12			--------
13
14			code_parent/ header files for a PARENT configuration
15			code_child/ header files for a CHILD configuration
16			code_nest_merged/ routines which need to be merged with MITgcm dynamical core and WRAPPER
17			nest_parent/ package for PARENT code
18			nest_child/ package for CHILD code
19	jmc	1.3	nest_driver/ external fortran routines driving the 2-way nesting
20	heimbach	1.1
21	jmc	1.3	utils/ some useful scripts and information text files
22	heimbach	1.1
23	jmc	1.3	bld_parent/ where to build PARENT - empty -
24			bld_child/ where to build CHILD - empty -
25			bld_driver/ where to build DRIVER - almost empty -
26	heimbach	1.1
27	jmc	1.3	input/ input binary files for simplified nested set-up test
28			params/ parameter files for simplified nested set-up test
29			results/ reference output file from a short nested run
30	heimbach	1.1
31	jmc	1.3	Information on how to build executable: in utils/notes_bld
32			Information on how to run nested test : in utils/notes_run
33	heimbach	1.1
34	jmc	1.3	==============================================================
35			modification list :
36			==============================================================
37
38			------------
39			27-Nov-2010:
40
41			driver:
42			split driver_nesting.F into "main.F" and "interpolation_p2c.F":
43			-use standard "gemake2" to build driver.
44			-change current dir + open & write to (proc specific) log file
45			-fix several problems (mostly in driver).
46
47			parent & child pkgs:
48			-bring nesting code up-to date with MITgcm source code checkpoint62o
49			-move nesting code out of eeboot_minimal.F into nest_eeinit.F
50			-move nesting arrays out of GRID.h into new header file "NEST_SHARED.h"
51			-change current dir to "rankNN"
52
53			add parameter files and results of simplified Med_Gib nested set-up test
54
55			driver,parent & child: (29 Nov)
56			-parent & child send number of nesting steps to driver; stop if mismatch.
57
58			code_nest_merged: ( 6 Dec)
59			finish merging of nested code into main code: remove the last 2 remaining
60			S/R: solve_for_pressure.F & obcs_calc.F
61			------------