model/src/ini_masks_etc.F

C $Header: /u/gcmpack/models/MITgcmUV/model/src/ini_masks_etc.F,v 1.14 1998/12/10 00:16:16 adcroft Exp $

#include "CPP_OPTIONS.h"

CStartOfInterface
      SUBROUTINE INI_MASKS_ETC( myThid )
C     /==========================================================\
C     | SUBROUTINE INI_MASKS_ETC                                 |
C     | o Initialise masks and topography factors                |
C     |==========================================================|
C     | These arrays are used throughout the code and describe   |
C     | the topography of the domain through masks (0s and 1s)   |
C     | and fractional height factors (0<hFac<1). The latter     |
C     | distinguish between the lopped-cell and full-step        |
C     | topographic representations.                             |
C     \==========================================================/
      IMPLICIT NONE

C     === Global variables ===
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "GRID.h"

C     == Routine arguments ==
C     myThid -  Number of this instance of INI_MASKS_ETC
      INTEGER myThid
CEndOfInterface

C     == Local variables ==
C     bi,bj  - Loop counters
C     I,J,K
      INTEGER bi, bj
      INTEGER  I, J, K
#ifdef ALLOW_NONHYDROSTATIC
      INTEGER Km1
      _RL hFacUpper,hFacLower
#endif

C     Calculate quantities derived from XY depth map
      DO bj = myByLo(myThid), myByHi(myThid)
       DO bi = myBxLo(myThid), myBxHi(myThid)
        DO J=1,sNy
         DO I=1,sNx
C         Inverse of depth
          IF ( h(i,j,bi,bj) .EQ. 0. _d 0 ) THEN
           recip_H(i,j,bi,bj) = 0. _d 0
          ELSE
           recip_H(i,j,bi,bj) = 1. _d 0 /  abs( H(i,j,bi,bj) )
          ENDIF
          depthInK(i,j,bi,bj) = 0.
         ENDDO
        ENDDO
       ENDDO
      ENDDO
      _EXCH_XY_R4(   recip_H, myThid )

C     Calculate lopping factor hFacC
      DO bj=myByLo(myThid), myByHi(myThid)
       DO bi=myBxLo(myThid), myBxHi(myThid)
        DO K=1, Nr
         DO J=1,sNy
          DO I=1,sNx
C          Round depths within a small fraction of layer depth to that
C          layer depth.
           IF ( ABS(H(I,J,bi,bj)-rF(K)) .LT. 
     &          1. _d -6*ABS(rF(K)) .AND.
     &          ABS(H(I,J,bi,bj)-rF(K)) .LT. 
     &          1. _d -6*ABS(H(I,J,bi,bj)) )THEN
            H(I,J,bi,bj) = rF(K)
           ENDIF
           IF     ( H(I,J,bi,bj)*rkFac .GE. rF(K)*rkFac ) THEN
C           Top of cell is below base of domain
            hFacC(I,J,K,bi,bj) = 0.
           ELSEIF ( H(I,J,bi,bj)*rkFac .LE. rF(K+1)*rkFac ) THEN
C           Base of domain is below bottom of this cell
            hFacC(I,J,K,bi,bj) = 1.
           ELSE
C           Base of domain is in this cell
C           Set hFac to the fraction of the cell that is open.
            hFacC(I,J,K,bi,bj) =
     &       (rF(K)*rkFac-H(I,J,bi,bj)*rkFac)*recip_drF(K)
           ENDIF
C Impose minimum fraction
           IF (hFacC(I,J,K,bi,bj).LT.hFacMin) THEN
            IF (hFacC(I,J,K,bi,bj).LT.hFacMin*0.5) THEN
             hFacC(I,J,K,bi,bj)=0.
            ELSE
             hFacC(I,J,K,bi,bj)=hFacMin
            ENDIF
           ENDIF
C Impose minimum size (dimensional)
           IF (drF(k)*hFacC(I,J,K,bi,bj).LT.hFacMinDr) THEN
            IF (drF(k)*hFacC(I,J,K,bi,bj).LT.hFacMinDr*0.5) THEN
             hFacC(I,J,K,bi,bj)=0.
            ELSE
             hFacC(I,J,K,bi,bj)=hFacMinDr*recip_drF(k)
            ENDIF
           ENDIF
           depthInK(i,j,bi,bj) = depthInK(i,j,bi,bj) 
     &                          +hFacC(i,j,k,bi,bj)
          ENDDO
         ENDDO
        ENDDO
       ENDDO
      ENDDO
      _EXCH_XYZ_R4(hFacC , myThid )
      _EXCH_XY_R4( depthInK, myThid )

      CALL PLOT_FIELD_XYRS( depthInK, 
     & 'Model Depths K Index' , 1, myThid )

C     hFacW and hFacS (at U and V points)
      DO bj=myByLo(myThid), myByHi(myThid)
       DO bi=myBxLo(myThid), myBxHi(myThid)
        DO K=1, Nr
         DO J=1,sNy
          DO I=1,sNx
           hFacW(I,J,K,bi,bj)=
     &       MIN(hFacC(I,J,K,bi,bj),hFacC(I-1,J,K,bi,bj))
           hFacS(I,J,K,bi,bj)=
     &       MIN(hFacC(I,J,K,bi,bj),hFacC(I,J-1,K,bi,bj))
          ENDDO
         ENDDO
        ENDDO
       ENDDO
      ENDDO
      _EXCH_XYZ_R4(hFacW , myThid )
      _EXCH_XYZ_R4(hFacS , myThid )

C     Masks and reciprocals of hFac[CWS]
      DO bj = myByLo(myThid), myByHi(myThid)
       DO bi = myBxLo(myThid), myBxHi(myThid)
        DO K=1,Nr
         DO J=1,sNy
          DO I=1,sNx
           IF (HFacC(I,J,K,bi,bj) .NE. 0. _d 0 ) THEN
            recip_HFacC(I,J,K,bi,bj) = 1. _d 0 / HFacC(I,J,K,bi,bj)
           ELSE
            recip_HFacC(I,J,K,bi,bj) = 0. _d 0
           ENDIF
           IF (HFacW(I,J,K,bi,bj) .NE. 0. _d 0 ) THEN
            recip_HFacW(I,J,K,bi,bj) = 1. _d 0 / HFacW(I,J,K,bi,bj)
            maskW(I,J,K,bi,bj) = 1. _d 0
           ELSE
            recip_HFacW(I,J,K,bi,bj) = 0. _d 0
            maskW(I,J,K,bi,bj) = 0.0 _d 0
           ENDIF
           IF (HFacS(I,J,K,bi,bj) .NE. 0. _d 0 ) THEN
            recip_HFacS(I,J,K,bi,bj) = 1. _d 0 / HFacS(I,J,K,bi,bj)
            maskS(I,J,K,bi,bj) = 1. _d 0
           ELSE
            recip_HFacS(I,J,K,bi,bj) = 0. _d 0
            maskS(I,J,K,bi,bj) = 0. _d 0
           ENDIF
          ENDDO
         ENDDO
        ENDDO
       ENDDO
      ENDDO
      _EXCH_XYZ_R4(recip_HFacC    , myThid )
      _EXCH_XYZ_R4(recip_HFacW    , myThid )
      _EXCH_XYZ_R4(recip_HFacS    , myThid )
      _EXCH_XYZ_R4(maskW    , myThid )
      _EXCH_XYZ_R4(maskS    , myThid )

C     Calculate recipricols grid lengths
      DO bj = myByLo(myThid), myByHi(myThid)
       DO bi = myBxLo(myThid), myBxHi(myThid)
        DO J=1,sNy
         DO I=1,sNx
          recip_dxG(I,J,bi,bj)=1.d0/dxG(I,J,bi,bj)
          recip_dyG(I,J,bi,bj)=1.d0/dyG(I,J,bi,bj)
          recip_dxC(I,J,bi,bj)=1.d0/dxC(I,J,bi,bj)
          recip_dyC(I,J,bi,bj)=1.d0/dyC(I,J,bi,bj)
          recip_dxF(I,J,bi,bj)=1.d0/dxF(I,J,bi,bj)
          recip_dyF(I,J,bi,bj)=1.d0/dyF(I,J,bi,bj)
          recip_dxV(I,J,bi,bj)=1.d0/dxV(I,J,bi,bj)
          recip_dyU(I,J,bi,bj)=1.d0/dyU(I,J,bi,bj)
         ENDDO
        ENDDO
       ENDDO
      ENDDO
      _EXCH_XY_R4(recip_dxG, myThid )
      _EXCH_XY_R4(recip_dyG, myThid )
      _EXCH_XY_R4(recip_dxC, myThid )
      _EXCH_XY_R4(recip_dyC, myThid )
      _EXCH_XY_R4(recip_dxF, myThid )
      _EXCH_XY_R4(recip_dyF, myThid )
      _EXCH_XY_R4(recip_dxV, myThid )
      _EXCH_XY_R4(recip_dyU, myThid )

#ifdef ALLOW_NONHYDROSTATIC
C--   Calculate the reciprocal hfac distance/volume for W cells
      DO bj = myByLo(myThid), myByHi(myThid)
       DO bi = myBxLo(myThid), myBxHi(myThid)
        DO K=1,Nr
         Km1=max(K-1,1)
         hFacUpper=drF(Km1)/(drF(Km1)+drF(K))
         IF (Km1.EQ.K) hFacUpper=0.
         hFacLower=drF(K)/(drF(Km1)+drF(K))
         DO J=1,sNy
          DO I=1,sNx
           IF (hFacC(I,J,K,bi,bj).NE.0.) THEN
            IF (hFacC(I,J,K,bi,bj).LE.0.5) THEN
            recip_hFacU(I,J,K,bi,bj)=
     &         hFacUpper+hFacLower*hFacC(I,J,K,bi,bj)
            ELSE
             recip_hFacU(I,J,K,bi,bj)=1.
            ENDIF
           ELSE
            recip_hFacU(I,J,K,bi,bj)=0.
           ENDIF
           IF (recip_hFacU(I,J,K,bi,bj).NE.0.)
     &      recip_hFacU(I,J,K,bi,bj)=1./recip_hFacU(I,J,K,bi,bj)
          ENDDO
         ENDDO
        ENDDO
       ENDDO
      ENDDO
      _EXCH_XY_R4(recip_hFacU, myThid )
#endif
C
      RETURN
      END
1	adcroft	1.15	C $Header: /u/gcmpack/models/MITgcmUV/model/src/ini_masks_etc.F,v 1.14 1998/12/10 00:16:16 adcroft Exp $
2	adcroft	1.1
3	cnh	1.11	#include "CPP_OPTIONS.h"
4	adcroft	1.1
5			CStartOfInterface
6			SUBROUTINE INI_MASKS_ETC( myThid )
7			C /==========================================================\
8			C \| SUBROUTINE INI_MASKS_ETC \|
9			C \| o Initialise masks and topography factors \|
10			C \|==========================================================\|
11			C \| These arrays are used throughout the code and describe \|
12			C \| the topography of the domain through masks (0s and 1s) \|
13			C \| and fractional height factors (0<hFac<1). The latter \|
14			C \| distinguish between the lopped-cell and full-step \|
15			C \| topographic representations. \|
16			C \==========================================================/
17	adcroft	1.13	IMPLICIT NONE
18	adcroft	1.1
19			C === Global variables ===
20			#include "SIZE.h"
21			#include "EEPARAMS.h"
22			#include "PARAMS.h"
23			#include "GRID.h"
24
25			C == Routine arguments ==
26	cnh	1.6	C myThid - Number of this instance of INI_MASKS_ETC
27	adcroft	1.1	INTEGER myThid
28			CEndOfInterface
29
30			C == Local variables ==
31			C bi,bj - Loop counters
32			C I,J,K
33			INTEGER bi, bj
34			INTEGER I, J, K
35	adcroft	1.15	#ifdef ALLOW_NONHYDROSTATIC
36			INTEGER Km1
37			_RL hFacUpper,hFacLower
38			#endif
39	adcroft	1.1
40			C Calculate quantities derived from XY depth map
41			DO bj = myByLo(myThid), myByHi(myThid)
42			DO bi = myBxLo(myThid), myBxHi(myThid)
43			DO J=1,sNy
44			DO I=1,sNx
45			C Inverse of depth
46			IF ( h(i,j,bi,bj) .EQ. 0. _d 0 ) THEN
47	cnh	1.4	recip_H(i,j,bi,bj) = 0. _d 0
48	adcroft	1.1	ELSE
49	cnh	1.4	recip_H(i,j,bi,bj) = 1. _d 0 / abs( H(i,j,bi,bj) )
50	adcroft	1.1	ENDIF
51	cnh	1.7	depthInK(i,j,bi,bj) = 0.
52	adcroft	1.1	ENDDO
53			ENDDO
54			ENDDO
55			ENDDO
56	cnh	1.4	_EXCH_XY_R4( recip_H, myThid )
57	adcroft	1.2
58			C Calculate lopping factor hFacC
59			DO bj=myByLo(myThid), myByHi(myThid)
60			DO bi=myBxLo(myThid), myBxHi(myThid)
61	cnh	1.4	DO K=1, Nr
62	adcroft	1.2	DO J=1,sNy
63			DO I=1,sNx
64	cnh	1.7	C Round depths within a small fraction of layer depth to that
65			C layer depth.
66	cnh	1.9	IF ( ABS(H(I,J,bi,bj)-rF(K)) .LT.
67			& 1. _d -6*ABS(rF(K)) .AND.
68			& ABS(H(I,J,bi,bj)-rF(K)) .LT.
69			& 1. _d -6*ABS(H(I,J,bi,bj)) )THEN
70	cnh	1.7	H(I,J,bi,bj) = rF(K)
71			ENDIF
72	cnh	1.6	IF ( H(I,J,bi,bj)rkFac .GE. rF(K)rkFac ) THEN
73	adcroft	1.3	C Top of cell is below base of domain
74	adcroft	1.2	hFacC(I,J,K,bi,bj) = 0.
75	cnh	1.6	ELSEIF ( H(I,J,bi,bj)rkFac .LE. rF(K+1)rkFac ) THEN
76	adcroft	1.3	C Base of domain is below bottom of this cell
77	adcroft	1.2	hFacC(I,J,K,bi,bj) = 1.
78			ELSE
79			C Base of domain is in this cell
80	adcroft	1.3	C Set hFac to the fraction of the cell that is open.
81	adcroft	1.15	hFacC(I,J,K,bi,bj) =
82			& (rF(K)rkFac-H(I,J,bi,bj)rkFac)*recip_drF(K)
83	adcroft	1.3	ENDIF
84			C Impose minimum fraction
85			IF (hFacC(I,J,K,bi,bj).LT.hFacMin) THEN
86			IF (hFacC(I,J,K,bi,bj).LT.hFacMin*0.5) THEN
87			hFacC(I,J,K,bi,bj)=0.
88			ELSE
89			hFacC(I,J,K,bi,bj)=hFacMin
90			ENDIF
91			ENDIF
92			C Impose minimum size (dimensional)
93	cnh	1.5	IF (drF(k)*hFacC(I,J,K,bi,bj).LT.hFacMinDr) THEN
94			IF (drF(k)hFacC(I,J,K,bi,bj).LT.hFacMinDr0.5) THEN
95	adcroft	1.3	hFacC(I,J,K,bi,bj)=0.
96			ELSE
97	cnh	1.5	hFacC(I,J,K,bi,bj)=hFacMinDr*recip_drF(k)
98	adcroft	1.3	ENDIF
99	adcroft	1.2	ENDIF
100	cnh	1.9	depthInK(i,j,bi,bj) = depthInK(i,j,bi,bj)
101			& +hFacC(i,j,k,bi,bj)
102	adcroft	1.2	ENDDO
103			ENDDO
104			ENDDO
105			ENDDO
106			ENDDO
107			_EXCH_XYZ_R4(hFacC , myThid )
108	cnh	1.7	_EXCH_XY_R4( depthInK, myThid )
109
110	cnh	1.9	CALL PLOT_FIELD_XYRS( depthInK,
111			& 'Model Depths K Index' , 1, myThid )
112	adcroft	1.1
113			C hFacW and hFacS (at U and V points)
114			DO bj=myByLo(myThid), myByHi(myThid)
115			DO bi=myBxLo(myThid), myBxHi(myThid)
116	cnh	1.4	DO K=1, Nr
117	adcroft	1.1	DO J=1,sNy
118			DO I=1,sNx
119			hFacW(I,J,K,bi,bj)=
120			& MIN(hFacC(I,J,K,bi,bj),hFacC(I-1,J,K,bi,bj))
121			hFacS(I,J,K,bi,bj)=
122			& MIN(hFacC(I,J,K,bi,bj),hFacC(I,J-1,K,bi,bj))
123			ENDDO
124			ENDDO
125			ENDDO
126			ENDDO
127			ENDDO
128			_EXCH_XYZ_R4(hFacW , myThid )
129			_EXCH_XYZ_R4(hFacS , myThid )
130
131			C Masks and reciprocals of hFac[CWS]
132			DO bj = myByLo(myThid), myByHi(myThid)
133			DO bi = myBxLo(myThid), myBxHi(myThid)
134	cnh	1.4	DO K=1,Nr
135	adcroft	1.1	DO J=1,sNy
136			DO I=1,sNx
137	cnh	1.10	IF (HFacC(I,J,K,bi,bj) .NE. 0. _d 0 ) THEN
138			recip_HFacC(I,J,K,bi,bj) = 1. _d 0 / HFacC(I,J,K,bi,bj)
139	adcroft	1.1	ELSE
140	cnh	1.10	recip_HFacC(I,J,K,bi,bj) = 0. _d 0
141	adcroft	1.1	ENDIF
142	cnh	1.10	IF (HFacW(I,J,K,bi,bj) .NE. 0. _d 0 ) THEN
143			recip_HFacW(I,J,K,bi,bj) = 1. _d 0 / HFacW(I,J,K,bi,bj)
144			maskW(I,J,K,bi,bj) = 1. _d 0
145	adcroft	1.1	ELSE
146	cnh	1.10	recip_HFacW(I,J,K,bi,bj) = 0. _d 0
147			maskW(I,J,K,bi,bj) = 0.0 _d 0
148	adcroft	1.1	ENDIF
149	cnh	1.10	IF (HFacS(I,J,K,bi,bj) .NE. 0. _d 0 ) THEN
150			recip_HFacS(I,J,K,bi,bj) = 1. _d 0 / HFacS(I,J,K,bi,bj)
151			maskS(I,J,K,bi,bj) = 1. _d 0
152	adcroft	1.1	ELSE
153	cnh	1.10	recip_HFacS(I,J,K,bi,bj) = 0. _d 0
154			maskS(I,J,K,bi,bj) = 0. _d 0
155	adcroft	1.1	ENDIF
156			ENDDO
157			ENDDO
158			ENDDO
159			ENDDO
160			ENDDO
161	cnh	1.4	_EXCH_XYZ_R4(recip_HFacC , myThid )
162			_EXCH_XYZ_R4(recip_HFacW , myThid )
163			_EXCH_XYZ_R4(recip_HFacS , myThid )
164	adcroft	1.1	_EXCH_XYZ_R4(maskW , myThid )
165			_EXCH_XYZ_R4(maskS , myThid )
166
167			C Calculate recipricols grid lengths
168			DO bj = myByLo(myThid), myByHi(myThid)
169			DO bi = myBxLo(myThid), myBxHi(myThid)
170			DO J=1,sNy
171			DO I=1,sNx
172	cnh	1.4	recip_dxG(I,J,bi,bj)=1.d0/dxG(I,J,bi,bj)
173			recip_dyG(I,J,bi,bj)=1.d0/dyG(I,J,bi,bj)
174			recip_dxC(I,J,bi,bj)=1.d0/dxC(I,J,bi,bj)
175			recip_dyC(I,J,bi,bj)=1.d0/dyC(I,J,bi,bj)
176			recip_dxF(I,J,bi,bj)=1.d0/dxF(I,J,bi,bj)
177			recip_dyF(I,J,bi,bj)=1.d0/dyF(I,J,bi,bj)
178			recip_dxV(I,J,bi,bj)=1.d0/dxV(I,J,bi,bj)
179			recip_dyU(I,J,bi,bj)=1.d0/dyU(I,J,bi,bj)
180	adcroft	1.1	ENDDO
181			ENDDO
182			ENDDO
183			ENDDO
184	cnh	1.4	_EXCH_XY_R4(recip_dxG, myThid )
185			_EXCH_XY_R4(recip_dyG, myThid )
186			_EXCH_XY_R4(recip_dxC, myThid )
187			_EXCH_XY_R4(recip_dyC, myThid )
188			_EXCH_XY_R4(recip_dxF, myThid )
189			_EXCH_XY_R4(recip_dyF, myThid )
190			_EXCH_XY_R4(recip_dxV, myThid )
191			_EXCH_XY_R4(recip_dyU, myThid )
192	adcroft	1.1
193	adcroft	1.15	#ifdef ALLOW_NONHYDROSTATIC
194			C-- Calculate the reciprocal hfac distance/volume for W cells
195			DO bj = myByLo(myThid), myByHi(myThid)
196			DO bi = myBxLo(myThid), myBxHi(myThid)
197			DO K=1,Nr
198			Km1=max(K-1,1)
199			hFacUpper=drF(Km1)/(drF(Km1)+drF(K))
200			IF (Km1.EQ.K) hFacUpper=0.
201			hFacLower=drF(K)/(drF(Km1)+drF(K))
202			DO J=1,sNy
203			DO I=1,sNx
204			IF (hFacC(I,J,K,bi,bj).NE.0.) THEN
205			IF (hFacC(I,J,K,bi,bj).LE.0.5) THEN
206			recip_hFacU(I,J,K,bi,bj)=
207			& hFacUpper+hFacLower*hFacC(I,J,K,bi,bj)
208			ELSE
209			recip_hFacU(I,J,K,bi,bj)=1.
210			ENDIF
211			ELSE
212			recip_hFacU(I,J,K,bi,bj)=0.
213			ENDIF
214			IF (recip_hFacU(I,J,K,bi,bj).NE.0.)
215			& recip_hFacU(I,J,K,bi,bj)=1./recip_hFacU(I,J,K,bi,bj)
216			ENDDO
217			ENDDO
218			ENDDO
219			ENDDO
220			ENDDO
221			_EXCH_XY_R4(recip_hFacU, myThid )
222			#endif
223	adcroft	1.1	C
224			RETURN
225			END