pkg/monitor/mon_ke.F

C $Header: /u/gcmpack/MITgcm/pkg/monitor/mon_ke.F,v 1.18 2009/11/28 20:52:54 jmc Exp $
C $Name:  $

#include "MONITOR_OPTIONS.h"

C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
CBOP
C     !ROUTINE: MON_KE

C     !INTERFACE:
      SUBROUTINE MON_KE(
     I     myIter, myThid )

C     !DESCRIPTION:
C     Calculates stats for Kinetic energy

C     !USES:
      IMPLICIT NONE
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "DYNVARS.h"
#include "MONITOR.h"
#include "GRID.h"
#include "SURFACE.h"

C     !INPUT PARAMETERS:
      INTEGER myIter, myThid
CEOP

C     !LOCAL VARIABLES:
      INTEGER bi,bj,i,j,k,kp1
      _RL numPnts,theVol,tmpVal, mskp1, msk_1
      _RL theMax,theMean,theVolMean,potEnMean
      _RL tileMean(nSx,nSy)
      _RL tileVlAv(nSx,nSy)
      _RL tilePEav(nSx,nSy)
      _RL tileVol (nSx,nSy)
#ifdef ALLOW_NONHYDROSTATIC
      _RL tmpWke
#endif

      numPnts=0.
      theVol=0.
      theMax=0.
      theMean=0.
      theVolMean=0.
      potEnMean =0.

      DO bj=myByLo(myThid),myByHi(myThid)
       DO bi=myBxLo(myThid),myBxHi(myThid)
        tileVol(bi,bj)  = 0. _d 0
        tileMean(bi,bj) = 0. _d 0
        tileVlAv(bi,bj) = 0. _d 0
        tilePEav(bi,bj) = 0. _d 0
        DO k=1,Nr
         kp1 = MIN(k+1,Nr)
         mskp1 = 1.
         IF ( k.GE.Nr ) mskp1 = 0.
C- Note: Present NH implementation does not account for D.w/dt at k=1.
C        Consequently, wVel(k=1) does not contribute to NH KE (msk_1=0).
         msk_1 = 1.
         IF ( k.EQ. 1 ) msk_1 = 0.
         DO j=1,sNy
          DO i=1,sNx
           tileVol(bi,bj) = tileVol(bi,bj)
     &                    + rA(i,j,bi,bj)*deepFac2C(k)
     &                     *rhoFacC(k)*drF(k)*_hFacC(i,j,k,bi,bj)

C- Vector Invariant form (like in pkg/mom_vecinv/mom_vi_calc_ke.F)
c          tmpVal=0.25*( uVel( i , j ,k,bi,bj)*uVel( i , j ,k,bi,bj)
c    &                  +uVel(i+1, j ,k,bi,bj)*uVel(i+1, j ,k,bi,bj)
c    &                  +vVel( i , j ,k,bi,bj)*vVel( i , j ,k,bi,bj)
c    &                  +vVel( i ,j+1,k,bi,bj)*vVel( i ,j+1,k,bi,bj) )
c          tileVlAv(bi,bj) = tileVlAv(bi,bj)
c    &              +tmpVal*rA(i,j,bi,bj)*drF(k)*hFacC(i,j,k,bi,bj)

C- Energy conservative form (like in pkg/mom_fluxform/mom_calc_ke.F)
C    this is the safe way to check the energy conservation
C    with no assumption on how grid spacing & area are defined.
           tmpVal=0.25*(
     &       uVel( i ,j,k,bi,bj)*uVel( i ,j,k,bi,bj)
     &         *dyG( i ,j,bi,bj)*dxC( i ,j,bi,bj)*_hFacW( i ,j,k,bi,bj)
     &      +uVel(i+1,j,k,bi,bj)*uVel(i+1,j,k,bi,bj)
     &         *dyG(i+1,j,bi,bj)*dxC(i+1,j,bi,bj)*_hFacW(i+1,j,k,bi,bj)
     &      +vVel(i, j ,k,bi,bj)*vVel(i, j ,k,bi,bj)
     &         *dxG(i, j ,bi,bj)*dyC(i, j ,bi,bj)*_hFacS(i, j ,k,bi,bj)
     &      +vVel(i,j+1,k,bi,bj)*vVel(i,j+1,k,bi,bj)
     &         *dxG(i,j+1,bi,bj)*dyC(i,j+1,bi,bj)*_hFacS(i,j+1,k,bi,bj)
     &        )
           tileVlAv(bi,bj) = tileVlAv(bi,bj)
     &                     + tmpVal*deepFac2C(k)*rhoFacC(k)*drF(k)
           tmpVal= tmpVal*_recip_hFacC(i,j,k,bi,bj)*recip_rA(i,j,bi,bj)

#ifdef ALLOW_NONHYDROSTATIC
           IF ( nonHydrostatic ) THEN
            tmpWke = 0.25*
     &        ( wVel(i,j, k, bi,bj)*wVel(i,j, k, bi,bj)*msk_1
     &                             *deepFac2F( k )*rhoFacF( k )
     &         +wVel(i,j,kp1,bi,bj)*wVel(i,j,kp1,bi,bj)*mskp1
     &                             *deepFac2F(kp1)*rhoFacF(kp1)
     &        )*maskC(i,j,k,bi,bj)
            tileVlAv(bi,bj) = tileVlAv(bi,bj)
     &             + tmpWke*rA(i,j,bi,bj)*drF(k)*_hFacC(i,j,k,bi,bj)
            tmpVal = tmpVal
     &             + tmpWke*recip_deepFac2C(k)*recip_rhoFacC(k)
           ENDIF
#endif

           theMax=MAX(theMax,tmpVal)
           IF (tmpVal.NE.0.) THEN
            tileMean(bi,bj)=tileMean(bi,bj)+tmpVal
            numPnts=numPnts+1.
           ENDIF

          ENDDO
         ENDDO
        ENDDO
C- Potential Energy (external mode):
         DO j=1,sNy
          DO i=1,sNx
           tmpVal = 0.5 _d 0*Bo_surf(i,j,bi,bj)
     &                      *etaN(i,j,bi,bj)*etaN(i,j,bi,bj)
C- jmc: if geoid not flat (phi0surf), needs to add this term.
C       not sure for atmos/ocean in P ; or atmos. loading in ocean-Z
           tmpVal = tmpVal
     &            + phi0surf(i,j,bi,bj)*etaN(i,j,bi,bj)
           tilePEav(bi,bj) = tilePEav(bi,bj)
     &            + tmpVal*rA(i,j,bi,bj)*deepFac2F(1)*maskH(i,j,bi,bj)
c          tmpVal = etaN(i,j,bi,bj)
c    &            + phi0surf(i,j,bi,bj)*recip_Bo(i,j,bi,bj)
c          tilePEav(bi,bj) = tilePEav(bi,bj)
c    &        + 0.5 _d 0*Bo_surf(i,j,bi,bj)*tmpVal*tmpVal
c    &                  *rA(i,j,bi,bj)*maskH(i,j,bi,bj)
          ENDDO
         ENDDO
c        theMean    = theMean    + tileMean(bi,bj)
c        theVol     = theVol     + tileVol(bi,bj)
c        theVolMean = theVolMean + tileVlAv(bi,bj)
c        potEnMean  = potEnMean  + tilePEav(bi,bj)
C- end bi,bj loops
       ENDDO
      ENDDO
      _GLOBAL_SUM_RL(numPnts,myThid)
      _GLOBAL_MAX_RL(theMax,myThid)
c     _GLOBAL_SUM_RL(theMean,myThid)
c     _GLOBAL_SUM_RL(theVol,myThid)
c     _GLOBAL_SUM_RL(theVolMean,myThid)
c     _GLOBAL_SUM_RL(potEnMean, myThid)
      CALL GLOBAL_SUM_TILE_RL( tileMean, theMean   , myThid )
      CALL GLOBAL_SUM_TILE_RL( tileVol , theVol    , myThid )
      CALL GLOBAL_SUM_TILE_RL( tileVlAv, theVolMean, myThid )
      CALL GLOBAL_SUM_TILE_RL( tilePEav, potEnMean , myThid )
      IF (numPnts.NE.0.) theMean=theMean/numPnts
      IF (theVol.NE.0.) THEN
        theVolMean=theVolMean/theVol
        potEnMean = potEnMean/theVol
      ENDIF

C--   Print stats for (barotropic) Potential Energy:
      CALL MON_SET_PREF('pe_b',myThid)
      CALL MON_OUT_RL(mon_string_none,potEnMean,
     &         mon_foot_mean,myThid)

C--   Print stats for KE
      CALL MON_SET_PREF('ke',myThid)
      CALL MON_OUT_RL(mon_string_none,theMax,mon_foot_max,myThid)
c     CALL MON_OUT_RL(mon_string_none,theMean,mon_foot_mean,myThid)
      CALL MON_OUT_RL(mon_string_none,theVolMean,
     &         mon_foot_mean,myThid)
      CALL MON_OUT_RL(mon_string_none,theVol,
     &         mon_foot_vol,myThid)

      RETURN
      END

C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|
1	jmc	1.19	C $Header: /u/gcmpack/MITgcm/pkg/monitor/mon_ke.F,v 1.18 2009/11/28 20:52:54 jmc Exp $
2	adcroft	1.1	C $Name: $
3
4	adcroft	1.11	#include "MONITOR_OPTIONS.h"
5	adcroft	1.1
6	edhill	1.12	C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
7			CBOP
8			C !ROUTINE: MON_KE
9
10			C !INTERFACE:
11	adcroft	1.1	SUBROUTINE MON_KE(
12	edhill	1.12	I myIter, myThid )
13
14			C !DESCRIPTION:
15	jmc	1.16	C Calculates stats for Kinetic energy
16	edhill	1.12
17			C !USES:
18	adcroft	1.1	IMPLICIT NONE
19			#include "SIZE.h"
20			#include "EEPARAMS.h"
21	jmc	1.16	#include "PARAMS.h"
22	adcroft	1.1	#include "DYNVARS.h"
23	cnh	1.5	#include "MONITOR.h"
24	jmc	1.8	#include "GRID.h"
25	jmc	1.10	#include "SURFACE.h"
26	adcroft	1.1
27	edhill	1.12	C !INPUT PARAMETERS:
28	jmc	1.10	INTEGER myIter, myThid
29	edhill	1.12	CEOP
30	adcroft	1.1
31	edhill	1.12	C !LOCAL VARIABLES:
32	jmc	1.18	INTEGER bi,bj,i,j,k,kp1
33	jmc	1.19	_RL numPnts,theVol,tmpVal, mskp1, msk_1
34	jmc	1.10	_RL theMax,theMean,theVolMean,potEnMean
35	jmc	1.16	_RL tileMean(nSx,nSy)
36			_RL tileVlAv(nSx,nSy)
37			_RL tilePEav(nSx,nSy)
38			_RL tileVol (nSx,nSy)
39	jmc	1.18	#ifdef ALLOW_NONHYDROSTATIC
40			_RL tmpWke
41			#endif
42	adcroft	1.1
43	jmc	1.10	numPnts=0.
44			theVol=0.
45	adcroft	1.1	theMax=0.
46			theMean=0.
47	jmc	1.8	theVolMean=0.
48	jmc	1.10	potEnMean =0.
49	adcroft	1.1
50			DO bj=myByLo(myThid),myByHi(myThid)
51			DO bi=myBxLo(myThid),myBxHi(myThid)
52	jmc	1.16	tileVol(bi,bj) = 0. _d 0
53			tileMean(bi,bj) = 0. _d 0
54			tileVlAv(bi,bj) = 0. _d 0
55			tilePEav(bi,bj) = 0. _d 0
56			DO k=1,Nr
57	jmc	1.18	kp1 = MIN(k+1,Nr)
58			mskp1 = 1.
59	jmc	1.19	IF ( k.GE.Nr ) mskp1 = 0.
60			C- Note: Present NH implementation does not account for D.w/dt at k=1.
61			C Consequently, wVel(k=1) does not contribute to NH KE (msk_1=0).
62			msk_1 = 1.
63			IF ( k.EQ. 1 ) msk_1 = 0.
64	jmc	1.16	DO j=1,sNy
65			DO i=1,sNx
66			tileVol(bi,bj) = tileVol(bi,bj)
67			& + rA(i,j,bi,bj)*deepFac2C(k)
68			& rhoFacC(k)drF(k)*_hFacC(i,j,k,bi,bj)
69	jmc	1.9
70			C- Vector Invariant form (like in pkg/mom_vecinv/mom_vi_calc_ke.F)
71	jmc	1.16	c tmpVal=0.25( uVel( i , j ,k,bi,bj)uVel( i , j ,k,bi,bj)
72			c & +uVel(i+1, j ,k,bi,bj)*uVel(i+1, j ,k,bi,bj)
73			c & +vVel( i , j ,k,bi,bj)*vVel( i , j ,k,bi,bj)
74			c & +vVel( i ,j+1,k,bi,bj)*vVel( i ,j+1,k,bi,bj) )
75			c tileVlAv(bi,bj) = tileVlAv(bi,bj)
76			c & +tmpValrA(i,j,bi,bj)drF(k)*hFacC(i,j,k,bi,bj)
77	jmc	1.9
78			C- Energy conservative form (like in pkg/mom_fluxform/mom_calc_ke.F)
79			C this is the safe way to check the energy conservation
80			C with no assumption on how grid spacing & area are defined.
81			tmpVal=0.25*(
82			& uVel( i ,j,k,bi,bj)*uVel( i ,j,k,bi,bj)
83	heimbach	1.15	& dyG( i ,j,bi,bj)dxC( i ,j,bi,bj)*_hFacW( i ,j,k,bi,bj)
84	jmc	1.9	& +uVel(i+1,j,k,bi,bj)*uVel(i+1,j,k,bi,bj)
85	heimbach	1.15	& dyG(i+1,j,bi,bj)dxC(i+1,j,bi,bj)*_hFacW(i+1,j,k,bi,bj)
86	jmc	1.9	& +vVel(i, j ,k,bi,bj)*vVel(i, j ,k,bi,bj)
87	heimbach	1.15	& dxG(i, j ,bi,bj)dyC(i, j ,bi,bj)*_hFacS(i, j ,k,bi,bj)
88	jmc	1.9	& +vVel(i,j+1,k,bi,bj)*vVel(i,j+1,k,bi,bj)
89	heimbach	1.15	& dxG(i,j+1,bi,bj)dyC(i,j+1,bi,bj)*_hFacS(i,j+1,k,bi,bj)
90	jmc	1.9	& )
91	jmc	1.16	tileVlAv(bi,bj) = tileVlAv(bi,bj)
92			& + tmpValdeepFac2C(k)rhoFacC(k)*drF(k)
93	heimbach	1.15	tmpVal= tmpVal_recip_hFacC(i,j,k,bi,bj)recip_rA(i,j,bi,bj)
94	jmc	1.9
95	jmc	1.18	#ifdef ALLOW_NONHYDROSTATIC
96			IF ( nonHydrostatic ) THEN
97			tmpWke = 0.25*
98	jmc	1.19	& ( wVel(i,j, k, bi,bj)wVel(i,j, k, bi,bj)msk_1
99	jmc	1.18	& deepFac2F( k )rhoFacF( k )
100			& +wVel(i,j,kp1,bi,bj)wVel(i,j,kp1,bi,bj)mskp1
101			& deepFac2F(kp1)rhoFacF(kp1)
102			& )*maskC(i,j,k,bi,bj)
103			tileVlAv(bi,bj) = tileVlAv(bi,bj)
104			& + tmpWkerA(i,j,bi,bj)drF(k)*_hFacC(i,j,k,bi,bj)
105			tmpVal = tmpVal
106			& + tmpWkerecip_deepFac2C(k)recip_rhoFacC(k)
107			ENDIF
108			#endif
109
110	jmc	1.16	theMax=MAX(theMax,tmpVal)
111	adcroft	1.1	IF (tmpVal.NE.0.) THEN
112	jmc	1.16	tileMean(bi,bj)=tileMean(bi,bj)+tmpVal
113	jmc	1.10	numPnts=numPnts+1.
114	adcroft	1.1	ENDIF
115	jmc	1.9
116	adcroft	1.1	ENDDO
117			ENDDO
118			ENDDO
119	jmc	1.10	C- Potential Energy (external mode):
120	jmc	1.16	DO j=1,sNy
121			DO i=1,sNx
122	jmc	1.10	tmpVal = 0.5 _d 0*Bo_surf(i,j,bi,bj)
123			& etaN(i,j,bi,bj)etaN(i,j,bi,bj)
124			C- jmc: if geoid not flat (phi0surf), needs to add this term.
125			C not sure for atmos/ocean in P ; or atmos. loading in ocean-Z
126			tmpVal = tmpVal
127			& + phi0surf(i,j,bi,bj)*etaN(i,j,bi,bj)
128	jmc	1.16	tilePEav(bi,bj) = tilePEav(bi,bj)
129			& + tmpValrA(i,j,bi,bj)deepFac2F(1)*maskH(i,j,bi,bj)
130	jmc	1.10	c tmpVal = etaN(i,j,bi,bj)
131			c & + phi0surf(i,j,bi,bj)*recip_Bo(i,j,bi,bj)
132	jmc	1.16	c tilePEav(bi,bj) = tilePEav(bi,bj)
133	jmc	1.10	c & + 0.5 _d 0Bo_surf(i,j,bi,bj)tmpVal*tmpVal
134			c & rA(i,j,bi,bj)maskH(i,j,bi,bj)
135			ENDDO
136			ENDDO
137	jmc	1.16	c theMean = theMean + tileMean(bi,bj)
138			c theVol = theVol + tileVol(bi,bj)
139			c theVolMean = theVolMean + tileVlAv(bi,bj)
140			c potEnMean = potEnMean + tilePEav(bi,bj)
141	jmc	1.10	C- end bi,bj loops
142	adcroft	1.1	ENDDO
143			ENDDO
144	jmc	1.17	_GLOBAL_SUM_RL(numPnts,myThid)
145			_GLOBAL_MAX_RL(theMax,myThid)
146			c _GLOBAL_SUM_RL(theMean,myThid)
147			c _GLOBAL_SUM_RL(theVol,myThid)
148			c _GLOBAL_SUM_RL(theVolMean,myThid)
149			c _GLOBAL_SUM_RL(potEnMean, myThid)
150	jmc	1.16	CALL GLOBAL_SUM_TILE_RL( tileMean, theMean , myThid )
151			CALL GLOBAL_SUM_TILE_RL( tileVol , theVol , myThid )
152			CALL GLOBAL_SUM_TILE_RL( tileVlAv, theVolMean, myThid )
153			CALL GLOBAL_SUM_TILE_RL( tilePEav, potEnMean , myThid )
154	jmc	1.10	IF (numPnts.NE.0.) theMean=theMean/numPnts
155			IF (theVol.NE.0.) THEN
156			theVolMean=theVolMean/theVol
157			potEnMean = potEnMean/theVol
158			ENDIF
159
160			C-- Print stats for (barotropic) Potential Energy:
161			CALL MON_SET_PREF('pe_b',myThid)
162			CALL MON_OUT_RL(mon_string_none,potEnMean,
163			& mon_foot_mean,myThid)
164	adcroft	1.1
165	jmc	1.10	C-- Print stats for KE
166			CALL MON_SET_PREF('ke',myThid)
167	jmc	1.8	CALL MON_OUT_RL(mon_string_none,theMax,mon_foot_max,myThid)
168	jmc	1.10	c CALL MON_OUT_RL(mon_string_none,theMean,mon_foot_mean,myThid)
169	jmc	1.8	CALL MON_OUT_RL(mon_string_none,theVolMean,
170	jmc	1.10	& mon_foot_mean,myThid)
171	jmc	1.9	CALL MON_OUT_RL(mon_string_none,theVol,
172			& mon_foot_vol,myThid)
173	adcroft	1.1
174			RETURN
175			END
176	edhill	1.12
177			C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|