bottom_ctrl_5x5/code_ad/ECCO_CPPOPTIONS.h

C $Header: /u/gcmpack/MITgcm/verification/bottom_ctrl_5x5/code_ad/ECCO_CPPOPTIONS.h,v 1.2 2007/10/09 02:36:41 jmc Exp $
C $Name:  $

#ifndef ECCO_CPPOPTIONS_H
#define ECCO_CPPOPTIONS_H

C-- Collect here, in a single option-file, options to control which optional
C   features to compile in packages AUTODIFF, COST, CTRL, ECCO, CAL and EXF.
C   If used, this option-file needs to be directly included in CPP_OPTIONS.h
C   Although this method, inherited from ECCO setup, has been traditionally
C   used for all adjoint built, work is in progess to allow to use the
C   standard metod (each of the above pkg get its own options from its
C   specific option-file) also for adjoint built.

C ********************************************************************
C ***                         ECCO Package                         ***
C ********************************************************************

#undef  ALLOW_ECCO_FORWARD_RUN
#undef  ALLOW_ECCO_DIAGNOSTICS_RUN
#undef  ALLOW_ECCO_OPTIMIZATION

C       >>> Do a long protocol.
#undef ECCO_VERBOSE

C ********************************************************************
C ***                  Adjoint Support Package                     ***
C ********************************************************************

C o Include/exclude code in order to be able to automatically
C   differentiate the MITgcmUV by using the Tangent Linear and
C   Adjoint Model Compiler (TAMC).

#define ALLOW_AUTODIFF_TAMC
C       >>> Checkpointing as handled by TAMC
#define ALLOW_TAMC_CHECKPOINTING
C       Include/exclude adjoint monitor routine
#undef ALLOW_AUTODIFF_MONITOR

C       Include/exclude atmosphere-specific code
#undef ALLOW_AUTODIFF_ATMOSPHERE

C ********************************************************************
C ***                     Calendar Package                         ***
C ********************************************************************

C CPP flags controlling which code is included in the files that
C will be compiled.

C ********************************************************************
C ***                Cost function Package                         ***
C ********************************************************************

C       >>> Cost function contributions
#define ALLOW_COST_TEST
Cml#define ALLOW_COST_TRACER
#undef ALLOW_COST_TRACER
#define ALLOW_COST_DEPTH

C ********************************************************************
C ***               Control vector Package                         ***
C ********************************************************************

#undef  ALLOW_NONDIMENSIONAL_CONTROL_IO
C       >>> Initial values.
Cml#define ALLOW_THETA0_CONTROL
Cml#define ALLOW_SALT0_CONTROL
Cml#define ALLOW_TR10_CONTROL
Cml#define ALLOW_TAUU0_CONTROL
Cml#define ALLOW_TAUV0_CONTROL
Cml#define ALLOW_SFLUX0_CONTROL
Cml#define ALLOW_HFLUX0_CONTROL
#undef ALLOW_SSS0_CONTROL
#undef ALLOW_SST0_CONTROL
Cml#define ALLOW_DIFFKR_CONTROL
#undef ALLOW_KAPGM_CONTROL
C o only topography as a control vector
#define ALLOW_DEPTH_CONTROL
#ifdef ALLOW_DEPTH_CONTROL
# define ALLOW_CG2D_NSA
# define USE_SMOOTH_MIN
#endif /* ALLOW_DEPTH_CONTROL */

C ********************************************************************
#endif /* ECCO_CPPOPTIONS_H */
1	jmc	1.3	C $Header: /u/gcmpack/MITgcm/verification/bottom_ctrl_5x5/code_ad/ECCO_CPPOPTIONS.h,v 1.2 2007/10/09 02:36:41 jmc Exp $
2	jmc	1.2	C $Name: $
3
4	jmc	1.3	#ifndef ECCO_CPPOPTIONS_H
5			#define ECCO_CPPOPTIONS_H
6
7			C-- Collect here, in a single option-file, options to control which optional
8			C features to compile in packages AUTODIFF, COST, CTRL, ECCO, CAL and EXF.
9			C If used, this option-file needs to be directly included in CPP_OPTIONS.h
10			C Although this method, inherited from ECCO setup, has been traditionally
11			C used for all adjoint built, work is in progess to allow to use the
12			C standard metod (each of the above pkg get its own options from its
13			C specific option-file) also for adjoint built.
14
15	heimbach	1.1	C ********************************************************************
16			C * ECCO Package *
17			C ********************************************************************
18	jmc	1.3
19	heimbach	1.1	#undef ALLOW_ECCO_FORWARD_RUN
20			#undef ALLOW_ECCO_DIAGNOSTICS_RUN
21			#undef ALLOW_ECCO_OPTIMIZATION
22
23			C >>> Do a long protocol.
24			#undef ECCO_VERBOSE
25
26			C ********************************************************************
27			C * Adjoint Support Package *
28			C ********************************************************************
29
30			C o Include/exclude code in order to be able to automatically
31			C differentiate the MITgcmUV by using the Tangent Linear and
32			C Adjoint Model Compiler (TAMC).
33	jmc	1.3
34	heimbach	1.1	#define ALLOW_AUTODIFF_TAMC
35			C >>> Checkpointing as handled by TAMC
36			#define ALLOW_TAMC_CHECKPOINTING
37			C Include/exclude adjoint monitor routine
38			#undef ALLOW_AUTODIFF_MONITOR
39	jmc	1.3
40	heimbach	1.1	C Include/exclude atmosphere-specific code
41			#undef ALLOW_AUTODIFF_ATMOSPHERE
42
43			C ********************************************************************
44	jmc	1.3	C * Calendar Package *
45	heimbach	1.1	C ********************************************************************
46	jmc	1.3
47	heimbach	1.1	C CPP flags controlling which code is included in the files that
48			C will be compiled.
49
50			C ********************************************************************
51			C * Cost function Package *
52			C ********************************************************************
53	jmc	1.3
54	heimbach	1.1	C >>> Cost function contributions
55			#define ALLOW_COST_TEST
56			Cml#define ALLOW_COST_TRACER
57			#undef ALLOW_COST_TRACER
58			#define ALLOW_COST_DEPTH
59
60			C ********************************************************************
61			C * Control vector Package *
62			C ********************************************************************
63	jmc	1.3
64	heimbach	1.1	#undef ALLOW_NONDIMENSIONAL_CONTROL_IO
65			C >>> Initial values.
66			Cml#define ALLOW_THETA0_CONTROL
67			Cml#define ALLOW_SALT0_CONTROL
68			Cml#define ALLOW_TR10_CONTROL
69			Cml#define ALLOW_TAUU0_CONTROL
70			Cml#define ALLOW_TAUV0_CONTROL
71			Cml#define ALLOW_SFLUX0_CONTROL
72			Cml#define ALLOW_HFLUX0_CONTROL
73			#undef ALLOW_SSS0_CONTROL
74			#undef ALLOW_SST0_CONTROL
75			Cml#define ALLOW_DIFFKR_CONTROL
76			#undef ALLOW_KAPGM_CONTROL
77			C o only topography as a control vector
78	jmc	1.2	#define ALLOW_DEPTH_CONTROL
79	heimbach	1.1	#ifdef ALLOW_DEPTH_CONTROL
80			# define ALLOW_CG2D_NSA
81			# define USE_SMOOTH_MIN
82			#endif /* ALLOW_DEPTH_CONTROL */
83
84	jmc	1.3	C ********************************************************************
85			#endif /* ECCO_CPPOPTIONS_H */