offline_exf_seaice/code_ad/ECCO_CPPOPTIONS.h

C $Header: /u/gcmpack/MITgcm/verification/offline_exf_seaice/code_ad/ECCO_CPPOPTIONS.h,v 1.11 2014/10/01 16:06:55 gforget Exp $
C $Name:  $

#ifndef ECCO_CPPOPTIONS_H
#define ECCO_CPPOPTIONS_H
c#include "PACKAGES_CONFIG.h"
c#include "CPP_OPTIONS.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 ********************************************************************
C ***                         ECCO Package                         ***
C ********************************************************************
C

C allow use of legacy ecco/ctrl codes
#define ECCO_CTRL_DEPRECATED

C       >>> Do a long protocol.
#undef ECCO_VERBOSE
C       >>> use model/src/forward_step.F
#define ALLOW_ECCO_EVOLUTION

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

#define ALLOW_AUTODIFF_TAMC

C       >>> Checkpointing as handled by TAMC
#define ALLOW_TAMC_CHECKPOINTING

C       >>> DO 2-level checkpointing instead of 3-level
#undef AUTODIFF_2_LEVEL_CHECKPOINT

C       >>> Extract adjoint state
#define ALLOW_AUTODIFF_MONITOR

C o use divided adjoint to split adjoint computations
#undef ALLOW_DIVIDED_ADJOINT

c#define ALLOW_AUTODIFF_WHTAPEIO
c#define ALLOW_PACKUNPACK_METHOD2
c#define AUTODIFF_USE_OLDSTORE_2D
c#define AUTODIFF_USE_OLDSTORE_3D
c#define EXCLUDE_WHIO_GLOBUFF_2D
c#define ALLOW_INIT_WHTAPEIO

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

C       >>> Cost function contributions
#define ALLOW_ECCO_OLD_FC_PRINT

C       >>> Initial values.
#define ALLOW_THETA0_COST_CONTRIBUTION

C       >>> Atmospheric state and radiation.
#define ALLOW_ATEMP_COST_CONTRIBUTION
#define ALLOW_SWDOWN_COST_CONTRIBUTION

#define ALLOW_THSICE_COST_TEST

C ********************************************************************
C ***               Control vector Package                         ***
C ********************************************************************
C
#define  CTRL_SET_PREC_32
#define  ALLOW_NONDIMENSIONAL_CONTROL_IO

C       >>> Initial values.
#define ALLOW_THETA0_CONTROL

C       >>> Atmospheric state and radiation.
#define  ALLOW_ATEMP_CONTROL
#define  ALLOW_SWDOWN_CONTROL

C ********************************************************************
C ***             External forcing Package                         ***
C ********************************************************************

C   Bulk formulae related flags.
#define  ALLOW_ATM_TEMP
#define  ALLOW_ATM_WIND
#define  ALLOW_DOWNWARD_RADIATION
#define  ALLOW_RUNOFF
#if (defined (ALLOW_ATM_TEMP) || defined (ALLOW_ATM_WIND))
# define ALLOW_BULKFORMULAE
# undef  ALLOW_BULK_LARGEYEAGER04
#endif

C   Zenith Angle/Albedo related flags.
#ifdef ALLOW_DOWNWARD_RADIATION
# undef ALLOW_ZENITHANGLE
#endif

C   Use ocean_emissivity*lwdwon in lwFlux. This flag should be define
C   unless to reproduce old results (obtained with inconsistent old code)
#ifdef ALLOW_DOWNWARD_RADIATION
# define EXF_LWDOWN_WITH_EMISSIVITY
#endif

C   Relaxation to monthly climatologies.
#define ALLOW_CLIMSST_RELAXATION
#define ALLOW_CLIMSSS_RELAXATION

C   Use spatial interpolation to interpolate
C   forcing files from input grid to model grid.
#undef USE_EXF_INTERPOLATION
C   for interpolated vector fields, rotate towards model-grid axis
C   using old rotation formulae (instead of grid-angles)
#undef EXF_USE_OLD_VEC_ROTATION
C   for interpolation around N & S pole, use the old formulation
C   (no pole symmetry, single vector-comp interp, reset to 0 zonal-comp @ N.pole)
#undef EXF_USE_OLD_INTERP_POLE

#define EXF_INTERP_USE_DYNALLOC
#if ( defined (EXF_INTERP_USE_DYNALLOC) && defined (USING_THREADS) )
# define EXF_IREAD_USE_GLOBAL_POINTER
#endif

#endif /* ECCO_CPPOPTIONS_H */
1	gforget	1.12	C $Header: /u/gcmpack/MITgcm/verification/offline_exf_seaice/code_ad/ECCO_CPPOPTIONS.h,v 1.11 2014/10/01 16:06:55 gforget Exp $
2	heimbach	1.1	C $Name: $
3
4	jmc	1.4	#ifndef ECCO_CPPOPTIONS_H
5			#define ECCO_CPPOPTIONS_H
6	jmc	1.7	c#include "PACKAGES_CONFIG.h"
7			c#include "CPP_OPTIONS.h"
8
9			C-- Collect here, in a single option-file, options to control which optional
10			C features to compile in packages AUTODIFF, COST, CTRL, ECCO, CAL and EXF.
11			C If used, this option-file needs to be directly included in CPP_OPTIONS.h
12			C Although this method, inherited from ECCO setup, has been traditionally
13			C used for all adjoint built, work is in progess to allow to use the
14			C standard metod (each of the above pkg get its own options from its
15			C specific option-file) also for adjoint built.
16	gforget	1.6	C
17	heimbach	1.1	C ********************************************************************
18			C * ECCO Package *
19			C ********************************************************************
20	gforget	1.6	C
21	gforget	1.12
22			C allow use of legacy ecco/ctrl codes
23			#define ECCO_CTRL_DEPRECATED
24
25	gforget	1.6	C >>> Do a long protocol.
26			#undef ECCO_VERBOSE
27			C >>> use model/src/forward_step.F
28			#define ALLOW_ECCO_EVOLUTION
29	jmc	1.2
30	heimbach	1.1	C ********************************************************************
31			C * Adjoint Support Package *
32			C ********************************************************************
33	jmc	1.2
34	heimbach	1.1	#define ALLOW_AUTODIFF_TAMC
35	jmc	1.7
36	heimbach	1.1	C >>> Checkpointing as handled by TAMC
37			#define ALLOW_TAMC_CHECKPOINTING
38	jmc	1.7
39			C >>> DO 2-level checkpointing instead of 3-level
40	jmc	1.8	#undef AUTODIFF_2_LEVEL_CHECKPOINT
41	jmc	1.7
42	heimbach	1.1	C >>> Extract adjoint state
43	gforget	1.6	#define ALLOW_AUTODIFF_MONITOR
44	jmc	1.7
45	heimbach	1.1	C o use divided adjoint to split adjoint computations
46			#undef ALLOW_DIVIDED_ADJOINT
47	gforget	1.6
48			c#define ALLOW_AUTODIFF_WHTAPEIO
49			c#define ALLOW_PACKUNPACK_METHOD2
50			c#define AUTODIFF_USE_OLDSTORE_2D
51			c#define AUTODIFF_USE_OLDSTORE_3D
52			c#define EXCLUDE_WHIO_GLOBUFF_2D
53			c#define ALLOW_INIT_WHTAPEIO
54	heimbach	1.1
55			C ********************************************************************
56			C * Cost function Package *
57	gforget	1.6	c ********************************************************************
58	jmc	1.8	C
59	gforget	1.6
60			C >>> Cost function contributions
61			#define ALLOW_ECCO_OLD_FC_PRINT
62	jmc	1.4
63	gforget	1.6	C >>> Initial values.
64			#define ALLOW_THETA0_COST_CONTRIBUTION
65	heimbach	1.1
66	gforget	1.6	C >>> Atmospheric state and radiation.
67			#define ALLOW_ATEMP_COST_CONTRIBUTION
68			#define ALLOW_SWDOWN_COST_CONTRIBUTION
69	heimbach	1.1
70	heimbach	1.9	#define ALLOW_THSICE_COST_TEST
71	heimbach	1.1
72			C ********************************************************************
73			C * Control vector Package *
74			C ********************************************************************
75	jmc	1.8	C
76	gforget	1.6	#define CTRL_SET_PREC_32
77			#define ALLOW_NONDIMENSIONAL_CONTROL_IO
78	heimbach	1.1
79			C >>> Initial values.
80	gforget	1.6	#define ALLOW_THETA0_CONTROL
81	heimbach	1.1
82	gforget	1.6	C >>> Atmospheric state and radiation.
83	heimbach	1.1	#define ALLOW_ATEMP_CONTROL
84			#define ALLOW_SWDOWN_CONTROL
85
86	jmc	1.7	C ********************************************************************
87			C * External forcing Package *
88			C ********************************************************************
89
90			C Bulk formulae related flags.
91			#define ALLOW_ATM_TEMP
92			#define ALLOW_ATM_WIND
93			#define ALLOW_DOWNWARD_RADIATION
94			#define ALLOW_RUNOFF
95			#if (defined (ALLOW_ATM_TEMP) \|\| defined (ALLOW_ATM_WIND))
96			# define ALLOW_BULKFORMULAE
97			# undef ALLOW_BULK_LARGEYEAGER04
98			#endif
99
100			C Zenith Angle/Albedo related flags.
101			#ifdef ALLOW_DOWNWARD_RADIATION
102			# undef ALLOW_ZENITHANGLE
103			#endif
104
105			C Use ocean_emissivity*lwdwon in lwFlux. This flag should be define
106			C unless to reproduce old results (obtained with inconsistent old code)
107			#ifdef ALLOW_DOWNWARD_RADIATION
108			# define EXF_LWDOWN_WITH_EMISSIVITY
109			#endif
110
111			C Relaxation to monthly climatologies.
112			#define ALLOW_CLIMSST_RELAXATION
113			#define ALLOW_CLIMSSS_RELAXATION
114
115			C Use spatial interpolation to interpolate
116			C forcing files from input grid to model grid.
117			#undef USE_EXF_INTERPOLATION
118			C for interpolated vector fields, rotate towards model-grid axis
119			C using old rotation formulae (instead of grid-angles)
120			#undef EXF_USE_OLD_VEC_ROTATION
121			C for interpolation around N & S pole, use the old formulation
122			C (no pole symmetry, single vector-comp interp, reset to 0 zonal-comp @ N.pole)
123			#undef EXF_USE_OLD_INTERP_POLE
124
125			#define EXF_INTERP_USE_DYNALLOC
126			#if ( defined (EXF_INTERP_USE_DYNALLOC) && defined (USING_THREADS) )
127			# define EXF_IREAD_USE_GLOBAL_POINTER
128			#endif
129
130	gforget	1.6	#endif /* ECCO_CPPOPTIONS_H */