pkg/obcs/OBCS_GRID.h

C $Header: /u/gcmpack/MITgcm/pkg/obcs/OBCS_GRID.h,v 1.1 2011/05/24 14:22:40 jmc Exp $
C $Name:  $

#ifdef ALLOW_OBCS

CBOP
C     !ROUTINE: OBCS_GRID.h
C     !INTERFACE:
C     #include "OBCS_GRID.h"

C     !DESCRIPTION:
C     *==========================================================*
C     | OBCS_GRID.h
C     | o Header file containing OBCS location on the grid
C     *==========================================================*
C     | o Note: does not (and should not) contain any conditional
C     |   statement that depends on OBCS options ; therefore
C     |   can be safely included without OBCS_OPTIONS.h
C     *==========================================================*
CEOP

C tileHasOB[N,S,E,W] :: this tile has OB at Northern/Southern/Eastern/Western edge
C   OB_Jn, OB_Js     :: indices of Northern & Southern OB location (cell center pt)
C   OB_Ie, OB_Iw     :: indices of  Eastern & Western  OB location (cell center pt)
C OBCS_insideMask    :: Inside OB region mask (zero beyond OB).

      COMMON /OBCS_ACTIVE_TILES/
     &  tileHasOBN, tileHasOBS, tileHasOBE, tileHasOBW
      LOGICAL tileHasOBN(nSx,nSy)
      LOGICAL tileHasOBS(nSx,nSy)
      LOGICAL tileHasOBE(nSx,nSy)
      LOGICAL tileHasOBW(nSx,nSy)

      COMMON /OBCS_GRID_INDICES/
     &  OB_Jn, OB_Js, OB_Ie, OB_Iw
      INTEGER OB_Jn(1-Olx:sNx+Olx,nSx,nSy)
      INTEGER OB_Js(1-Olx:sNx+Olx,nSx,nSy)
      INTEGER OB_Ie(1-Oly:sNy+Oly,nSx,nSy)
      INTEGER OB_Iw(1-Oly:sNy+Oly,nSx,nSy)

      COMMON /OBCS_MASK_RS/
     &  OBCS_insideMask
      _RS OBCS_insideMask(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)

#endif /* ALLOW_OBCS */
1	jmc	1.2	C $Header: /u/gcmpack/MITgcm/pkg/obcs/OBCS_GRID.h,v 1.1 2011/05/24 14:22:40 jmc Exp $
2	jmc	1.1	C $Name: $
3
4			#ifdef ALLOW_OBCS
5
6			CBOP
7			C !ROUTINE: OBCS_GRID.h
8			C !INTERFACE:
9			C #include "OBCS_GRID.h"
10
11			C !DESCRIPTION:
12			C ==========================================================
13			C \| OBCS_GRID.h
14			C \| o Header file containing OBCS location on the grid
15			C ==========================================================
16			C \| o Note: does not (and should not) contain any conditional
17			C \| statement that depends on OBCS options ; therefore
18			C \| can be safely included without OBCS_OPTIONS.h
19			C ==========================================================
20			CEOP
21
22			C tileHasOB[N,S,E,W] :: this tile has OB at Northern/Southern/Eastern/Western edge
23	jmc	1.2	C OB_Jn, OB_Js :: indices of Northern & Southern OB location (cell center pt)
24			C OB_Ie, OB_Iw :: indices of Eastern & Western OB location (cell center pt)
25			C OBCS_insideMask :: Inside OB region mask (zero beyond OB).
26	jmc	1.1
27			COMMON /OBCS_ACTIVE_TILES/
28			& tileHasOBN, tileHasOBS, tileHasOBE, tileHasOBW
29			LOGICAL tileHasOBN(nSx,nSy)
30			LOGICAL tileHasOBS(nSx,nSy)
31			LOGICAL tileHasOBE(nSx,nSy)
32			LOGICAL tileHasOBW(nSx,nSy)
33
34			COMMON /OBCS_GRID_INDICES/
35	jmc	1.2	& OB_Jn, OB_Js, OB_Ie, OB_Iw
36	jmc	1.1	INTEGER OB_Jn(1-Olx:sNx+Olx,nSx,nSy)
37			INTEGER OB_Js(1-Olx:sNx+Olx,nSx,nSy)
38			INTEGER OB_Ie(1-Oly:sNy+Oly,nSx,nSy)
39			INTEGER OB_Iw(1-Oly:sNy+Oly,nSx,nSy)
40
41	jmc	1.2	COMMON /OBCS_MASK_RS/
42			& OBCS_insideMask
43			_RS OBCS_insideMask(1-OLx:sNx+OLx,1-OLy:sNy+OLy,nSx,nSy)
44
45	jmc	1.1	#endif /* ALLOW_OBCS */