pkg/autodiff/AUTODIFF_PARAMS.h

C $Header: /u/gcmpack/MITgcm/pkg/autodiff/AUTODIFF_PARAMS.h,v 1.6 2012/10/27 00:38:21 heimbach Exp $
C $Name:  $

CBOP
C     !ROUTINE: AUTODIFF_PARAMS.h
C     !INTERFACE:
C     #include AUTODIFF_PARAMS.h

C     !DESCRIPTION:
C     Header file defining pkg/autodiff "parameters".  The values
C     from the pkg input file are stored into the variables held
C     here. Notes describing the parameters can also be found here.

CEOP

C--   COMMON /AUTODIFF_PARM_L/ Logical valued parameters used by the pkg.
C     inAdMode  :: enable approximate computation in backward sweep
C     inAdTrue  :: value of inAdMode flag during backward sweep
C     inAdFalse :: value of inAdMode flag during forward  sweep
C     inAdExact :: get an exact adjoint (no approximation)
      LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact

C-    Logical flags for turning off parts of the code in adjoint mode
C     SEAICEuseFREEDRIFTswitchInAd :: switch on/off Free-Drift in adjoint mode (def=F)
C     SEAICEuseDYNAMICSswitchInAd  :: switch on/off seaice Dyn in adjoint mode (def=F)
      LOGICAL useKPPinAdMode,    useKPPinFwdMode
      LOGICAL useGMRediInAdMode, useGMRediInFwdMode
      LOGICAL useSEAICEinAdMode, useSEAICEinFwdMode
      LOGICAL useGGL90inAdMode,    useGGL90inFwdMode
      LOGICAL useSALT_PLUMEinAdMode, useSALT_PLUMEInFwdMode
      LOGICAL SEAICEuseFREEDRIFTswitchInAd, SEAICEuseFREEDRIFTinFwdMode
      LOGICAL SEAICEuseDYNAMICSswitchInAd, SEAICEuseDYNAMICSinFwdMode

C-    Logical for ad dump format (if true then write all records
C       to one file per variable; else write one file per record)
      LOGICAL dumpAdByRec

      COMMON /AUTODIFF_PARM_L/
     &       inAdMode, inAdTrue, inAdFalse, inAdExact,
     &       useKPPinAdMode,    useKPPinFwdMode,
     &       useGMRediInAdMode, useGMRediInFwdMode,
     &       useSEAICEinAdMode, useSEAICEinFwdMode,
     &       useGGL90inAdMode,    useGGL90inFwdMode,
     &       useSALT_PLUMEinAdMode, useSALT_PLUMEInFwdMode,
     &       SEAICEuseFREEDRIFTswitchInAd, SEAICEuseFREEDRIFTinFwdMode,
     &       SEAICEuseDYNAMICSswitchInAd, SEAICEuseDYNAMICSinFwdMode,
     &       dumpAdByRec

C--   COMMON /AUTODIFF_PARM_I/ Integer valued parameters used by the pkg.
C     dumpAdVarExch :: control ad-variables exchange before dumping output
C     mon_AdVarExch :: control ad-variables exchange before monitor output
C      - for both   :: =0 : no exch ; =1 : apply adexch ;
C      *AdVarExch - :: =2 : do adexch on a local copy.
      INTEGER dumpAdVarExch
      INTEGER mon_AdVarExch
      COMMON /AUTODIFF_PARM_I/
     &       dumpAdVarExch, mon_AdVarExch

C--   COMMON /AUTODIFF_PARM_R/ "Real" valued parameters used by the pkg.

C--   COMMON /AUTODIFF_PARM_C/ Character valued parameters used by the pkg.

CEH3 ;;; Local Variables: ***
CEH3 ;;; mode:fortran ***
CEH3 ;;; End: ***
1	jmc	1.7	C $Header: /u/gcmpack/MITgcm/pkg/autodiff/AUTODIFF_PARAMS.h,v 1.6 2012/10/27 00:38:21 heimbach Exp $
2	jmc	1.1	C $Name: $
3
4			CBOP
5			C !ROUTINE: AUTODIFF_PARAMS.h
6			C !INTERFACE:
7			C #include AUTODIFF_PARAMS.h
8
9			C !DESCRIPTION:
10			C Header file defining pkg/autodiff "parameters". The values
11			C from the pkg input file are stored into the variables held
12			C here. Notes describing the parameters can also be found here.
13
14			CEOP
15
16			C-- COMMON /AUTODIFF_PARM_L/ Logical valued parameters used by the pkg.
17			C inAdMode :: enable approximate computation in backward sweep
18			C inAdTrue :: value of inAdMode flag during backward sweep
19			C inAdFalse :: value of inAdMode flag during forward sweep
20			C inAdExact :: get an exact adjoint (no approximation)
21			LOGICAL inAdMode, inAdTrue, inAdFalse, inAdExact
22
23			C- Logical flags for turning off parts of the code in adjoint mode
24	jmc	1.7	C SEAICEuseFREEDRIFTswitchInAd :: switch on/off Free-Drift in adjoint mode (def=F)
25			C SEAICEuseDYNAMICSswitchInAd :: switch on/off seaice Dyn in adjoint mode (def=F)
26	jmc	1.1	LOGICAL useKPPinAdMode, useKPPinFwdMode
27			LOGICAL useGMRediInAdMode, useGMRediInFwdMode
28			LOGICAL useSEAICEinAdMode, useSEAICEinFwdMode
29	gforget	1.5	LOGICAL useGGL90inAdMode, useGGL90inFwdMode
30			LOGICAL useSALT_PLUMEinAdMode, useSALT_PLUMEInFwdMode
31	jmc	1.7	LOGICAL SEAICEuseFREEDRIFTswitchInAd, SEAICEuseFREEDRIFTinFwdMode
32			LOGICAL SEAICEuseDYNAMICSswitchInAd, SEAICEuseDYNAMICSinFwdMode
33	jmc	1.1
34	jmc	1.7	C- Logical for ad dump format (if true then write all records
35	gforget	1.4	C to one file per variable; else write one file per record)
36			LOGICAL dumpAdByRec
37
38	jmc	1.1	COMMON /AUTODIFF_PARM_L/
39			& inAdMode, inAdTrue, inAdFalse, inAdExact,
40			& useKPPinAdMode, useKPPinFwdMode,
41			& useGMRediInAdMode, useGMRediInFwdMode,
42	jmc	1.2	& useSEAICEinAdMode, useSEAICEinFwdMode,
43	gforget	1.5	& useGGL90inAdMode, useGGL90inFwdMode,
44			& useSALT_PLUMEinAdMode, useSALT_PLUMEInFwdMode,
45	jmc	1.7	& SEAICEuseFREEDRIFTswitchInAd, SEAICEuseFREEDRIFTinFwdMode,
46			& SEAICEuseDYNAMICSswitchInAd, SEAICEuseDYNAMICSinFwdMode,
47			& dumpAdByRec
48	jmc	1.1
49			C-- COMMON /AUTODIFF_PARM_I/ Integer valued parameters used by the pkg.
50	jmc	1.3	C dumpAdVarExch :: control ad-variables exchange before dumping output
51			C mon_AdVarExch :: control ad-variables exchange before monitor output
52			C - for both :: =0 : no exch ; =1 : apply adexch ;
53			C *AdVarExch - :: =2 : do adexch on a local copy.
54			INTEGER dumpAdVarExch
55			INTEGER mon_AdVarExch
56			COMMON /AUTODIFF_PARM_I/
57			& dumpAdVarExch, mon_AdVarExch
58	jmc	1.1
59			C-- COMMON /AUTODIFF_PARM_R/ "Real" valued parameters used by the pkg.
60
61			C-- COMMON /AUTODIFF_PARM_C/ Character valued parameters used by the pkg.
62
63			CEH3 ;;; Local Variables: ***
64			CEH3 ;;; mode:fortran ***
65			CEH3 ;;; End: ***