Warning, /verification/global_oce_latlon/README.md is written in an unsupported language. File is not indexed.
view on githubraw file Latest commit 7fe51dd4 on 2025-03-14 19:25:07 UTC
7fe51dd492 Jean*0001 # Global Ocean Simulation at 4 degree Resolution, Adjoint Set-Up
0002 First configuration to use OpenAD, started on 2005-08-19
0003 by heimbach@mit.edu, utke@mcs.anl.gov, cnh@mit.edu
0004 ***Note*** this experiment was previously named "OpenAD".
0005
0006 ### Overview:
0007 This experiment is derived from `tutorial_global_oce_latlon` (see also `global_ocean.90x40x15`
0008 and `global_ocean_ebm`) but with different combinations of pkgs or options from
0009 `global_ocean.90x40x15` adjoint test exp.
0010 It provides adjoint settings for 3 AD compilers, OpenAD, TAF and Tapenade, with primary
0011 test input files in `input_oad/`, `input_ad/` and `input_tap/` respectively, but also
0012 several secondary test setting with each of the AD compilers.
0013
0014 ## Part 1, using OpenAD Adjoint Compiler:
0015
0016 The built process needed to be modified, and some routines
0017 needed changes. Most changes were commited to default routines,
0018 the remaining changes are kept in `code_oad/` for now.
0019
0020 ### Instructions:
0021 Configure and compile the code:
0022 ```
0023 cd build
0024 ../../../tools/genmake2 -mods ../code_oad [-of my_platform_optionFile]
0025 [make Clean]
0026 make adAll
0027 cd ..
0028 ```
0029
0030 ***Note:*** might want to split the full single step above (make adAll) in
0031 several intermediate steps such as:
0032 ```
0033 make cb2m
0034 make makefile
0035 make small_f
0036 make allmods
0037 make adAll
0038 ```
0039 where the first step (cb2m) invoke script to convert COMMON block headers
0040 (e.g.. FILE.h) to MODULE headers (FILE_mod.h) and create new module file
0041 (FILE_mod.F90); the second step (makefile) re-generate makefile which takes
0042 into account newly created files FILE_mod.h, FILE_mod.F90 ; the third step
0043 (small_f) generate `.f` and `.f90` files. The fourth step (allmods)
0044 compiles all module files .f90 ; and the fifth and last step complile all f90
0045 src files.
0046
0047 To run primary test:
0048 ```
0049 cd run
0050 ln -s ../input_oad/* .
0051 ../input_oad/prepare_run
0052 ../build/mitgcmuv_ad > output_oadm.txt
0053 cd ..
0054 ```
0055
0056 There is comparison output in the directory:
0057 `results/output_oadm.txt`
0058
0059 To run any of secondary `$st` test (`$st` in: `ggl90`, `kpp`):
0060 ```
0061 cd run
0062 rm *
0063 ln -s ../input_oad.$st/* .
0064 ln -s ../input_oad/* .
0065 ./prepare_run
0066 ../build/mitgcmuv_ad > output_oadm.txt
0067 ```
0068
0069 There is comparison output in the directory:
0070 `results/output_oadm.$st.txt`
0071
0072 ## Part 2, using TAF Adjoint Compiler:
0073 similar to above but using set-up specific code from `code_ad/` and input files from `input_ad/`
0074
0075 ### Instructions:
0076 Configure and compile the code:
0077 ```
0078 cd build
0079 ../../../tools/genmake2 -mods ../code_ad [-of my_platform_optionFile]
0080 [make Clean]
0081 make depend
0082 make adall
0083 cd ..
0084 ```
0085
0086 To run primary test:
0087 ```
0088 cd run
0089 ln -s ../input_ad/* .
0090 ../input_ad/prepare_run
0091 ../build/mitgcmuv_ad > output_adm.txt
0092 cd ..
0093 ```
0094
0095 There is comparison output in the directory:
0096 `results/output_adm.txt`
0097
0098 To run any of secondary `$st` test (`$st` in: `ggl90`, `w_exf`):
0099 ```
0100 cd run
0101 rm *
0102 ln -s ../input_ad.$st/* .
0103 ln -s ../input_ad/* .
0104 ./prepare_run
0105 ../build/mitgcmuv_ad > output_adm.txt
0106 ```
0107
0108 There is comparison output in the directory:
0109 `results/output_adm.$st.txt`
0110
0111 ***Notes:*** `input_ad.w_exf` set-up has been moved (in PR #830)
0112 from `verification/global_with_exf/input_ad`
0113
0114 ## Part 3, using Tapenade Adjoint Compiler:
0115 similar to above but using set-up specific code from `code_tap/` and input files from `input_tap/`
0116
