pkg/diagnostics/DIAGNOSTICS_CALC.h

C $Header: /u/gcmpack/MITgcm/pkg/diagnostics/DIAGNOSTICS_CALC.h,v 1.3 2011/08/01 20:38:39 jmc Exp $
C $Name:  $

CBOP
C     !ROUTINE: DIAGNOSTICS_CALC.h
C     !INTERFACE:
C     include "DIAGNOSTICS_CALC.h"
C     !DESCRIPTION:
C     \bv
C     *==========================================================*
C     | DIAGNOSTICS_CALC.h
C     | o Hold parameters and variables used in post-processing
C     |   diagnostics
C     *==========================================================*
C     *==========================================================*
C     \ev
CEOP

C     DIAGNOSTICS_CALC common block:
C     prtFirstCall     :: print messages if first call
C-- used in Velocity-Potential calculation:
C     diagCG_maxIters  :: max number of iterations in diag_cg2d solver
C     diagCG_prtResFrq :: frequency for printing residual in CG iterations
C     diagCG_resTarget :: residual target for diag_cg2d solver (no units)
C     diagCG_pcOffDFac :: diag_cg2d preconditioner off-diagonal factor
C-- used in Stream-Function calculation:
C     iPsi0,jPsi0 :: indices of grid-point location where Psi == 0
C     xPsi0,yPsi0 :: grid-point coordinate where Psi == 0

      LOGICAL prtFirstCall
      INTEGER diagCG_maxIters
      INTEGER diagCG_prtResFrq
      INTEGER iPsi0(nSx,nSy)
      INTEGER jPsi0(nSx,nSy)
      _RL     diagCG_resTarget
      _RL     diagCG_pcOffDFac
      _RS     xPsi0, yPsi0
      COMMON / DIAGNOSTICS_CALC_L /
     &     prtFirstCall
      COMMON / DIAGNOSTICS_CALC_I /
     &     diagCG_maxIters, diagCG_prtResFrq,
     &     iPsi0, jPsi0
      COMMON / DIAGNOSTICS_CALC_RL /
     &     diagCG_resTarget, diagCG_pcOffDFac
      COMMON / DIAGNOSTICS_CALC_RS /
     &     xPsi0, yPsi0

C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
1	jmc	1.4	C $Header: /u/gcmpack/MITgcm/pkg/diagnostics/DIAGNOSTICS_CALC.h,v 1.3 2011/08/01 20:38:39 jmc Exp $
2	jmc	1.1	C $Name: $
3
4			CBOP
5			C !ROUTINE: DIAGNOSTICS_CALC.h
6			C !INTERFACE:
7			C include "DIAGNOSTICS_CALC.h"
8			C !DESCRIPTION:
9			C \bv
10			C ==========================================================
11			C \| DIAGNOSTICS_CALC.h
12			C \| o Hold parameters and variables used in post-processing
13			C \| diagnostics
14			C ==========================================================
15			C ==========================================================
16			C \ev
17			CEOP
18
19			C DIAGNOSTICS_CALC common block:
20	jmc	1.3	C prtFirstCall :: print messages if first call
21	jmc	1.2	C-- used in Velocity-Potential calculation:
22			C diagCG_maxIters :: max number of iterations in diag_cg2d solver
23			C diagCG_prtResFrq :: frequency for printing residual in CG iterations
24			C diagCG_resTarget :: residual target for diag_cg2d solver (no units)
25	jmc	1.4	C diagCG_pcOffDFac :: diag_cg2d preconditioner off-diagonal factor
26	jmc	1.1	C-- used in Stream-Function calculation:
27			C iPsi0,jPsi0 :: indices of grid-point location where Psi == 0
28			C xPsi0,yPsi0 :: grid-point coordinate where Psi == 0
29
30	jmc	1.3	LOGICAL prtFirstCall
31	jmc	1.2	INTEGER diagCG_maxIters
32			INTEGER diagCG_prtResFrq
33	jmc	1.1	INTEGER iPsi0(nSx,nSy)
34			INTEGER jPsi0(nSx,nSy)
35	jmc	1.2	_RL diagCG_resTarget
36	jmc	1.4	_RL diagCG_pcOffDFac
37	jmc	1.1	_RS xPsi0, yPsi0
38	jmc	1.3	COMMON / DIAGNOSTICS_CALC_L /
39			& prtFirstCall
40	jmc	1.1	COMMON / DIAGNOSTICS_CALC_I /
41	jmc	1.2	& diagCG_maxIters, diagCG_prtResFrq,
42	jmc	1.1	& iPsi0, jPsi0
43	jmc	1.2	COMMON / DIAGNOSTICS_CALC_RL /
44	jmc	1.4	& diagCG_resTarget, diagCG_pcOffDFac
45	jmc	1.1	COMMON / DIAGNOSTICS_CALC_RS /
46			& xPsi0, yPsi0
47
48			C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|