pkg/autodiff/AUTODIFF_PARAMS.h

C $Header: /u/gcmpack/MITgcm/pkg/autodiff/AUTODIFF_PARAMS.h,v 1.8 2014/06/27 14:18:57 gforget 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
      LOGICAL useSmoothCorrel2DinAdMode, useSmoothCorrel2DinFwdMode

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,
     &       useSmoothCorrel2DinAdMode, useSmoothCorrel2DinFwdMode,
     &       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.
C     SEAICEapproxLevInAd :: level of approximation in seaice adjoint
C       -1 (and .NOT.useSEAICEinAdMode) : use seaice_fake adjoint
C       0 (and .NOT.useSEAICEinAdMode)  : omit all of seaice thermo adjoint 
C       0 (and useSEAICEinAdMode)       : use all of seaice thermo adjoint
C       >= 1 (and useSEAICEinAdMode)    : omit pieces of seaice thermo adjoint 
      INTEGER dumpAdVarExch
      INTEGER mon_AdVarExch
      INTEGER SEAICEapproxLevInAd
      COMMON /AUTODIFF_PARM_I/
     &       dumpAdVarExch, mon_AdVarExch, SEAICEapproxLevInAd

C--   COMMON /AUTODIFF_PARM_R/ "Real" valued parameters used by the pkg.
C     viscFacInAd :: viscosity factor for adjoint
      _RL viscFacInAd
      COMMON /AUTODIFF_PARM_R/ viscFacInAd

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

CEH3 ;;; Local Variables: ***
CEH3 ;;; mode:fortran ***
CEH3 ;;; End: ***
1	C $Header: /u/gcmpack/MITgcm/pkg/autodiff/AUTODIFF_PARAMS.h,v 1.8 2014/06/27 14:18:57 gforget Exp $
2	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	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	LOGICAL useKPPinAdMode, useKPPinFwdMode
27	LOGICAL useGMRediInAdMode, useGMRediInFwdMode
28	LOGICAL useSEAICEinAdMode, useSEAICEinFwdMode
29	LOGICAL useGGL90inAdMode, useGGL90inFwdMode
30	LOGICAL useSALT_PLUMEinAdMode, useSALT_PLUMEInFwdMode
31	LOGICAL SEAICEuseFREEDRIFTswitchInAd, SEAICEuseFREEDRIFTinFwdMode
32	LOGICAL SEAICEuseDYNAMICSswitchInAd, SEAICEuseDYNAMICSinFwdMode
33	LOGICAL useSmoothCorrel2DinAdMode, useSmoothCorrel2DinFwdMode
34
35	C- Logical for ad dump format (if true then write all records
36	C to one file per variable; else write one file per record)
37	LOGICAL dumpAdByRec
38
39	COMMON /AUTODIFF_PARM_L/
40	& inAdMode, inAdTrue, inAdFalse, inAdExact,
41	& useKPPinAdMode, useKPPinFwdMode,
42	& useGMRediInAdMode, useGMRediInFwdMode,
43	& useSEAICEinAdMode, useSEAICEinFwdMode,
44	& useGGL90inAdMode, useGGL90inFwdMode,
45	& useSALT_PLUMEinAdMode, useSALT_PLUMEInFwdMode,
46	& SEAICEuseFREEDRIFTswitchInAd, SEAICEuseFREEDRIFTinFwdMode,
47	& SEAICEuseDYNAMICSswitchInAd, SEAICEuseDYNAMICSinFwdMode,
48	& useSmoothCorrel2DinAdMode, useSmoothCorrel2DinFwdMode,
49	& dumpAdByRec
50
51	C-- COMMON /AUTODIFF_PARM_I/ Integer valued parameters used by the pkg.
52	C dumpAdVarExch :: control ad-variables exchange before dumping output
53	C mon_AdVarExch :: control ad-variables exchange before monitor output
54	C - for both :: =0 : no exch ; =1 : apply adexch ;
55	C *AdVarExch - :: =2 : do adexch on a local copy.
56	C SEAICEapproxLevInAd :: level of approximation in seaice adjoint
57	C -1 (and .NOT.useSEAICEinAdMode) : use seaice_fake adjoint
58	C 0 (and .NOT.useSEAICEinAdMode) : omit all of seaice thermo adjoint
59	C 0 (and useSEAICEinAdMode) : use all of seaice thermo adjoint
60	C >= 1 (and useSEAICEinAdMode) : omit pieces of seaice thermo adjoint
61	INTEGER dumpAdVarExch
62	INTEGER mon_AdVarExch
63	INTEGER SEAICEapproxLevInAd
64	COMMON /AUTODIFF_PARM_I/
65	& dumpAdVarExch, mon_AdVarExch, SEAICEapproxLevInAd
66
67	C-- COMMON /AUTODIFF_PARM_R/ "Real" valued parameters used by the pkg.
68	C viscFacInAd :: viscosity factor for adjoint
69	_RL viscFacInAd
70	COMMON /AUTODIFF_PARM_R/ viscFacInAd
71
72	C-- COMMON /AUTODIFF_PARM_C/ Character valued parameters used by the pkg.
73
74	CEH3 ;;; Local Variables: ***
75	CEH3 ;;; mode:fortran ***
76	CEH3 ;;; End: ***