[MITgcm-devel] Option files for adjoint built

[Jean-Michel Campin]

Hi,

I would like to start some changes in Option (header) files that are 
used for adjoint built (I already talked with Patrick and Gael, but to
collect more feedback).

The goal is to enable an adjoint built without ECCO_CPPOPTIONS.h,
with each pkg (AUTODIFF, COST, CTRL, ECCO, EXF ...) having it's own set of
options defined within it's ${PKG}_OPTIONS.h file (instead of everything
in ECCO_CPPOPTIONS.h, as currently done), like we do for all other pkgs.
But since there might be some ${PKG}_OPTIONS.h missing (not included) in 
some places of the code, this might take some time to get there. 

To start with, I would like to have each CPP option added and documented
(the 1 or 2 lines we have in, e.g, CPP_OPTIONS.h) within the corresponding
${PKG}_OPTIONS.h file (right now, many CPP options in ECCO_CPPOPTIONS.h don't 
have any doc). Will go with a 1rst draft and invite anyone to correct/fix/
improve these option files.
And these added CPP instructions (#define/#undef) will continue to be ignored
as long as ECCO_CPPOPTIONS.h is included (currently within CPP_OPTIONS.h)
I think this could help to find out what is doing what and in which package.

Will start by 
1) updating EXF_OPTIONS.h
2) renaming:
 COST_CPPOPTIONS.h  to:  COST_OPTIONS.h
 CTRL_CPPOPTIONS.h  to:  CTRL_OPTIONS.h
 (currently these 2 option files are mostly empty)
3) create + include "ECCO_OPTIONS.h" in pkg/ecco.
 (should not be back-ward compatibility issue since ECCO_CPPOPTIONS.h will
 still be there, so if someone has few customized/modified pkg/ecco source 
 files, should just work as before without updating these files).

Any comment ?

Cheers,
Jean-Michel