model/inc/CG2D.h

4c563c2ee9 Chri*0001 CBOP
                0002 C     !ROUTINE: CG2D.h
                0003 C     !INTERFACE:
                0004 C     include "CG2D.h"
                0005 C
                0006 C     !DESCRIPTION:
                0007 C     \bv
                0008 C     *==========================================================*
2e7f378ba9 Jean*0009 C     | CG2D.h
                0010 C     | o Two-dimensional conjugate gradient solver header.
4c563c2ee9 Chri*0011 C     *==========================================================*
2e7f378ba9 Jean*0012 C     | Internal (private) data structures.
4c563c2ee9 Chri*0013 C     *==========================================================*
                0014 C     \ev
                0015 CEOP
aea29c8517 Alis*0016
                0017 C--   COMMON /CG2D_I_L/ cg2dNormaliseRHS
2e7f378ba9 Jean*0018 C     cg2dNormaliseRHS :: flag set to TRUE if normalise RHS in the Solver
aea29c8517 Alis*0019       COMMON /CG2D_I_L/ cg2dNormaliseRHS
                0020       LOGICAL cg2dNormaliseRHS
                0021
e6e223b277 Jean*0022 C--   COMMON /CG2D_I_R/ DEL**2 Laplacian operators
2e7f378ba9 Jean*0023 C     aW2d    :: East-west operator.
                0024 C     aS2d    :: North-south operator.
                0025 C     aC2d    :: 2D operator main diagonal term.
                0026 C     pW      :: East-west off-diagonal term of preconditioner.
                0027 C     pS      :: North-south off-diagonal term of preconditioner.
                0028 C     pC      :: Main diagonal term of preconditioner.
                0029 C     cg2dNorm :: A matrix normalisation factor.
e6e223b277 Jean*0030 C     cg2dTolerance_sq :: square of cg2d solver Tolerance (units depends
                0031 C                 on cg2dNormaliseRHS, solver-unit ^2 = (m2/s2)^2 or no unit)
1c2b1fa3bc Mart*0032       COMMON /CG2D_I_RS/
2e7f378ba9 Jean*0033      &      aW2d, aS2d, aC2d,
1c2b1fa3bc Mart*0034      &      pW, pS, pC
                0035       COMMON /CG2D_I_RL/
e6e223b277 Jean*0036      &      cg2dNorm, cg2dTolerance_sq
aea29c8517 Alis*0037       _RS  aW2d (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
                0038       _RS  aS2d (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
2e7f378ba9 Jean*0039       _RS  aC2d (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
aea29c8517 Alis*0040       _RS  pW   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
                0041       _RS  pS   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
                0042       _RS  pC   (1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
e6e223b277 Jean*0043       _RL  cg2dNorm, cg2dTolerance_sq
aea29c8517 Alis*0044
aecc8b0f47 Mart*0045 C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|