model/inc/CG3D.h

C $Header: /u/u3/gcmpack/MITgcm/model/inc/CG3D.h,v 1.5 2001/09/21 03:54:36 cnh Exp $
C $Name:  $

#include "PACKAGES_CONFIG.h"

#ifdef ALLOW_NONHYDROSTATIC
CBOP
C     !ROUTINE: CG3D.h
C     !INTERFACE: 
C     include "CG3D.h"
C     !DESCRIPTION: \bv
C     *==========================================================*
C     | CG3D.h                                                    
C     | o Three-dimensional conjugate gradient solver header.     
C     *==========================================================*
C     | The common blocks set up here are used in the elliptic    
C     | equation inversion. They are also used as the interface   
C     | to the rest of the model. To set the source term for the  
C     | solver set the appropriate array below. To read the       
C     | solution read from the appropriate array below.           
C     *==========================================================*
C     \ev
CEOP

C--   COMMON /CG3D_R/ DEL**2 Laplacian operators
C     aW3d - East-west operator.
C     aS3d - North-south operator.
C     aV3d - Vertical operator.
C     etaNBuf - Shared buffers for accumulating con. grad vector product.
C     alphaBuf
C     errBuf
C     nrmBuf
C     cg3dNorm - A matrix normalisation factor.
      COMMON /CG3D_R/
     &      aW3d,
     &      aS3d,
     &      aV3d,
     &      zMC, zML, zMU,
     &      cg3dNorm
      _RS  aW3d (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RS  aS3d (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RS  aV3d (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RS  zMC  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RS  zML  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RS  zMU  (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
      _RL  cg3dNorm

C--   COMMON /CG3D_WK_R/  Work array common block
C     cg3d_q - Intermediate matrix-vector product term
C     cg3d_r -   "
C     cg3d_s -   "
C     cg3d_x   Solution vector
C     cg3d_b   Right-hand side vector
      COMMON /CG3D_WK_R/
     & cg3d_q, cg3d_r, cg3d_s
      _RL  cg3d_q(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nR,nSx,nSy)
      _RL  cg3d_r(1-1  :sNx+1  ,1-1  :sNy+1  ,nR,nSx,nSy)
      _RL  cg3d_s(1-1  :sNx+1  ,1-1  :sNy+1  ,nR,nSx,nSy)

#endif /* ALLOW_NONHYDROSTATIC */
1	C $Header: /u/u3/gcmpack/MITgcm/model/inc/CG3D.h,v 1.5 2001/09/21 03:54:36 cnh Exp $
2	C $Name: $
3
4	#include "PACKAGES_CONFIG.h"
5
6	#ifdef ALLOW_NONHYDROSTATIC
7	CBOP
8	C !ROUTINE: CG3D.h
9	C !INTERFACE:
10	C include "CG3D.h"
11	C !DESCRIPTION: \bv
12	C ==========================================================
13	C \| CG3D.h
14	C \| o Three-dimensional conjugate gradient solver header.
15	C ==========================================================
16	C \| The common blocks set up here are used in the elliptic
17	C \| equation inversion. They are also used as the interface
18	C \| to the rest of the model. To set the source term for the
19	C \| solver set the appropriate array below. To read the
20	C \| solution read from the appropriate array below.
21	C ==========================================================
22	C \ev
23	CEOP
24
25	C-- COMMON /CG3D_R/ DEL**2 Laplacian operators
26	C aW3d - East-west operator.
27	C aS3d - North-south operator.
28	C aV3d - Vertical operator.
29	C etaNBuf - Shared buffers for accumulating con. grad vector product.
30	C alphaBuf
31	C errBuf
32	C nrmBuf
33	C cg3dNorm - A matrix normalisation factor.
34	COMMON /CG3D_R/
35	& aW3d,
36	& aS3d,
37	& aV3d,
38	& zMC, zML, zMU,
39	& cg3dNorm
40	_RS aW3d (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
41	_RS aS3d (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
42	_RS aV3d (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
43	_RS zMC (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
44	_RS zML (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
45	_RS zMU (1-OLx:sNx+OLx,1-OLy:sNy+OLy,Nr,nSx,nSy)
46	_RL cg3dNorm
47
48	C-- COMMON /CG3D_WK_R/ Work array common block
49	C cg3d_q - Intermediate matrix-vector product term
50	C cg3d_r - "
51	C cg3d_s - "
52	C cg3d_x Solution vector
53	C cg3d_b Right-hand side vector
54	COMMON /CG3D_WK_R/
55	& cg3d_q, cg3d_r, cg3d_s
56	_RL cg3d_q(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nR,nSx,nSy)
57	_RL cg3d_r(1-1 :sNx+1 ,1-1 :sNy+1 ,nR,nSx,nSy)
58	_RL cg3d_s(1-1 :sNx+1 ,1-1 :sNy+1 ,nR,nSx,nSy)
59
60	#endif /* ALLOW_NONHYDROSTATIC */