1 |
C $Header: /u/gcmpack/MITgcm/pkg/diagnostics/diagnostics_fract_fill.F,v 1.5 2008/02/05 15:13:01 jmc Exp $ |
2 |
C $Name: $ |
3 |
|
4 |
#include "DIAG_OPTIONS.h" |
5 |
|
6 |
CBOP |
7 |
C !ROUTINE: DIAGNOSTICS_FRACT_FILL |
8 |
C !INTERFACE: |
9 |
SUBROUTINE DIAGNOSTICS_FRACT_FILL( |
10 |
I inpFld, fractFld, scaleFact, power, chardiag, |
11 |
I kLev, nLevs, bibjFlg, biArg, bjArg, myThid ) |
12 |
|
13 |
C !DESCRIPTION: |
14 |
C*********************************************************************** |
15 |
C Wrapper routine to increment the diagnostics arrays with a RL field |
16 |
C using a scaling factor & square option (power=2) |
17 |
C and using a RL fraction-weight (assumed to be the |
18 |
C counter-mate of the current diagnostics) |
19 |
C Note: 1) fraction-weight has to correspond to the diagnostics |
20 |
C counter-mate (filled independently with a call to |
21 |
C DIAGNOSTICS_FILL) |
22 |
C 2) assume for now that inpFld & fractFld are both _RL and |
23 |
C have the same horizontal shape (overlap,bi,bj ...) |
24 |
C*********************************************************************** |
25 |
C !USES: |
26 |
IMPLICIT NONE |
27 |
|
28 |
C == Global variables === |
29 |
#include "EEPARAMS.h" |
30 |
#include "SIZE.h" |
31 |
#include "DIAGNOSTICS_SIZE.h" |
32 |
#include "DIAGNOSTICS.h" |
33 |
|
34 |
C !INPUT PARAMETERS: |
35 |
C*********************************************************************** |
36 |
C Arguments Description |
37 |
C ---------------------- |
38 |
C inpFld :: Field to increment diagnostics array |
39 |
C fractFld :: fraction used for weighted average diagnostics |
40 |
C scaleFact :: scaling factor |
41 |
C power :: option to fill-in with the field square (power=2) |
42 |
C chardiag :: Character expression for diag to fill |
43 |
C kLev :: Integer flag for vertical levels: |
44 |
C > 0 (any integer): WHICH single level to increment in qdiag. |
45 |
C 0,-1 to increment "nLevs" levels in qdiag, |
46 |
C 0 : fill-in in the same order as the input array |
47 |
C -1: fill-in in reverse order. |
48 |
C nLevs :: indicates Number of levels of the input field array |
49 |
C (whether to fill-in all the levels (kLev<1) or just one (kLev>0)) |
50 |
C bibjFlg :: Integer flag to indicate instructions for bi bj loop |
51 |
C 0 indicates that the bi-bj loop must be done here |
52 |
C 1 indicates that the bi-bj loop is done OUTSIDE |
53 |
C 2 indicates that the bi-bj loop is done OUTSIDE |
54 |
C AND that we have been sent a local array (with overlap regions) |
55 |
C 3 indicates that the bi-bj loop is done OUTSIDE |
56 |
C AND that we have been sent a local array |
57 |
C AND that the array has no overlap region (interior only) |
58 |
C NOTE - bibjFlg can be NEGATIVE to indicate not to increment counter |
59 |
C biArg :: X-direction tile number - used for bibjFlg=1-3 |
60 |
C bjArg :: Y-direction tile number - used for bibjFlg=1-3 |
61 |
C myThid :: my thread Id number |
62 |
C*********************************************************************** |
63 |
C NOTE: User beware! If a local (1 tile only) array |
64 |
C is sent here, bibjFlg MUST NOT be set to 0 |
65 |
C or there will be out of bounds problems! |
66 |
C*********************************************************************** |
67 |
_RL inpFld(*) |
68 |
_RL fractFld(*) |
69 |
_RL scaleFact |
70 |
INTEGER power |
71 |
CHARACTER*8 chardiag |
72 |
INTEGER kLev, nLevs, bibjFlg, biArg, bjArg |
73 |
INTEGER myThid |
74 |
CEOP |
75 |
|
76 |
C !LOCAL VARIABLES: |
77 |
C ndId :: diagnostic Id number (in available diagnostics list) |
78 |
INTEGER m, n, j, k, l, bi, bj |
79 |
INTEGER ndId, ipt, iSp |
80 |
INTEGER region2fill(0:nRegions) |
81 |
INTEGER mate, nLevFract |
82 |
CHARACTER*10 gcode |
83 |
CHARACTER*(MAX_LEN_MBUF) msgBuf |
84 |
INTEGER arrType |
85 |
_RS dummyRS(1) |
86 |
C =============== |
87 |
|
88 |
arrType = 0 |
89 |
IF ( bibjFlg.EQ.0 ) THEN |
90 |
bi = myBxLo(myThid) |
91 |
bj = myByLo(myThid) |
92 |
ELSE |
93 |
bi = biArg |
94 |
bj = bjArg |
95 |
ENDIF |
96 |
C-- 2D/3D Diagnostics : |
97 |
C Run through list of active diagnostics to make sure |
98 |
C we are trying to fill a valid diagnostic |
99 |
DO n=1,nlists |
100 |
DO m=1,nActive(n) |
101 |
IF ( chardiag.EQ.flds(m,n) .AND. idiag(m,n).GT.0 ) THEN |
102 |
ipt = idiag(m,n) |
103 |
IF ( ndiag(ipt,bi,bj).GE.0 ) THEN |
104 |
ndId = jdiag(m,n) |
105 |
ipt = ipt + pdiag(n,bi,bj)*kdiag(ndId) |
106 |
C- check for a counter-mate: |
107 |
mate = 0 |
108 |
gcode = gdiag(ndId)(1:10) |
109 |
IF ( gcode(5:5).EQ.'C' ) mate = hdiag(ndId) |
110 |
IF ( mdiag(m,n).EQ.0 ) mate = 0 |
111 |
IF ( mate.LE.0 ) THEN |
112 |
WRITE(msgBuf,'(2A)') 'DIAGNOSTICS_FRACT_FILL: ', |
113 |
& 'did not find a valid counter-mate' |
114 |
CALL PRINT_ERROR( msgBuf , myThid ) |
115 |
WRITE(msgBuf,'(2A,I6,2A)') 'DIAGNOSTICS_FRACT_FILL: ', |
116 |
& 'for diag(#',ndId,' ) :', chardiag |
117 |
CALL PRINT_ERROR( msgBuf , myThid ) |
118 |
STOP 'ABNORMAL END: S/R DIAGNOSTICS_FRACT_FILL' |
119 |
ENDIF |
120 |
C- set the nb of levels of fraction-weight field (not > kdiag(mate)) |
121 |
nLevFract = MIN(nLevs,kdiag(mate)) |
122 |
C- diagnostic is valid & active, has a counter-mate, do the filling: |
123 |
CALL DIAGNOSTICS_FILL_FIELD( |
124 |
I inpFld, fractFld, dummyRS, dummyRS, |
125 |
I scaleFact, power, arrType, nLevFract, |
126 |
I ndId, ipt, kLev, nLevs, |
127 |
I bibjFlg, biArg, bjArg, myThid ) |
128 |
ENDIF |
129 |
ENDIF |
130 |
ENDDO |
131 |
ENDDO |
132 |
|
133 |
C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----| |
134 |
C-- Global/Regional Statistics : |
135 |
|
136 |
C Run through list of active statistics-diagnostics to make sure |
137 |
C we are trying to compute & fill a valid diagnostic |
138 |
|
139 |
DO n=1,diagSt_nbLists |
140 |
DO m=1,diagSt_nbActv(n) |
141 |
IF ( chardiag.EQ.diagSt_Flds(m,n) .AND. iSdiag(m,n).GT.0 ) THEN |
142 |
iSp = iSdiag(m,n) |
143 |
IF ( qSdiag(0,0,iSp,bi,bj).GE.0. ) THEN |
144 |
ndId = jSdiag(m,n) |
145 |
C- check for a counter-mate: |
146 |
mate = 0 |
147 |
gcode = gdiag(ndId)(1:10) |
148 |
c IF ( gcode(5:5).EQ.'C' ) READ(gcode,'(5X,I3)') mate |
149 |
IF ( gcode(5:5).EQ.'C' ) mate = hdiag(ndId) |
150 |
IF ( mSdiag(m,n).EQ.0 ) mate = 0 |
151 |
IF ( mate.LE.0 ) THEN |
152 |
WRITE(msgBuf,'(2A)') 'DIAGNOSTICS_FRACT_FILL: ', |
153 |
& 'did not find a valid counter-mate' |
154 |
CALL PRINT_ERROR( msgBuf , myThid ) |
155 |
WRITE(msgBuf,'(2A,I6,2A)') 'DIAGNOSTICS_FRACT_FILL: ', |
156 |
& 'for diag(#',ndId,' ) :', chardiag |
157 |
CALL PRINT_ERROR( msgBuf , myThid ) |
158 |
STOP 'ABNORMAL END: S/R DIAGNOSTICS_FRACT_FILL' |
159 |
ENDIF |
160 |
C- set the nb of levels of fraction-weight field (not > kdiag(mate)) |
161 |
nLevFract = MIN(nLevs,kdiag(mate)) |
162 |
C- Find list of regions to fill: |
163 |
DO j=0,nRegions |
164 |
region2fill(j) = diagSt_region(j,n) |
165 |
ENDDO |
166 |
C- if this diagnostics appears in several lists (with same freq) |
167 |
C then add regions from other lists |
168 |
DO l=1,diagSt_nbLists |
169 |
DO k=1,diagSt_nbActv(l) |
170 |
IF ( iSdiag(k,l).EQ.-iSp ) THEN |
171 |
DO j=0,nRegions |
172 |
region2fill(j) = MAX(region2fill(j),diagSt_region(j,l)) |
173 |
ENDDO |
174 |
ENDIF |
175 |
ENDDO |
176 |
ENDDO |
177 |
C- diagnostics is valid and Active, has a counter mate: Now do the filling |
178 |
CALL DIAGSTATS_FILL( |
179 |
I inpFld, fractFld, |
180 |
#ifndef REAL4_IS_SLOW |
181 |
I dummyRS, dummyRS, |
182 |
#endif |
183 |
I scaleFact, power, arrType, nLevFract, |
184 |
I ndId, iSp, region2fill, kLev, nLevs, |
185 |
I bibjFlg, biArg, bjArg, myThid ) |
186 |
ENDIF |
187 |
ENDIF |
188 |
ENDDO |
189 |
ENDDO |
190 |
|
191 |
RETURN |
192 |
END |