pkg/monitor/mon_ke.F

C $Header: /u/gcmpack/MITgcm/pkg/monitor/mon_ke.F,v 1.20 2009/12/21 00:06:03 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

C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-|--+----|

      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)
     &                     *maskInC(i,j,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)
     &        )*maskInC(i,j,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)*maskInC(i,j,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)
     &                    *maskInC(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)*maskInC(i,j,bi,bj)
          ENDDO
         ENDDO
C- end bi,bj loops
       ENDDO
      ENDDO
      _GLOBAL_SUM_RL(numPnts,myThid)
      _GLOBAL_MAX_RL(theMax,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
1	jmc	1.21	C $Header: /u/gcmpack/MITgcm/pkg/monitor/mon_ke.F,v 1.20 2009/12/21 00:06:03 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.21	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.21	C---+----1----+----2----+----3----+----4----+----5----+----6----+----7-\|--+----\|
44
45	jmc	1.10	numPnts=0.
46			theVol=0.
47	adcroft	1.1	theMax=0.
48			theMean=0.
49	jmc	1.8	theVolMean=0.
50	jmc	1.10	potEnMean =0.
51	adcroft	1.1
52			DO bj=myByLo(myThid),myByHi(myThid)
53			DO bi=myBxLo(myThid),myBxHi(myThid)
54	jmc	1.16	tileVol(bi,bj) = 0. _d 0
55			tileMean(bi,bj) = 0. _d 0
56			tileVlAv(bi,bj) = 0. _d 0
57			tilePEav(bi,bj) = 0. _d 0
58			DO k=1,Nr
59	jmc	1.18	kp1 = MIN(k+1,Nr)
60			mskp1 = 1.
61	jmc	1.19	IF ( k.GE.Nr ) mskp1 = 0.
62			C- Note: Present NH implementation does not account for D.w/dt at k=1.
63			C Consequently, wVel(k=1) does not contribute to NH KE (msk_1=0).
64			msk_1 = 1.
65			IF ( k.EQ. 1 ) msk_1 = 0.
66	jmc	1.16	DO j=1,sNy
67			DO i=1,sNx
68			tileVol(bi,bj) = tileVol(bi,bj)
69			& + rA(i,j,bi,bj)*deepFac2C(k)
70			& rhoFacC(k)drF(k)*_hFacC(i,j,k,bi,bj)
71	jmc	1.21	& *maskInC(i,j,bi,bj)
72	jmc	1.9
73			C- Vector Invariant form (like in pkg/mom_vecinv/mom_vi_calc_ke.F)
74	jmc	1.16	c tmpVal=0.25( uVel( i , j ,k,bi,bj)uVel( i , j ,k,bi,bj)
75			c & +uVel(i+1, j ,k,bi,bj)*uVel(i+1, j ,k,bi,bj)
76			c & +vVel( i , j ,k,bi,bj)*vVel( i , j ,k,bi,bj)
77			c & +vVel( i ,j+1,k,bi,bj)*vVel( i ,j+1,k,bi,bj) )
78			c tileVlAv(bi,bj) = tileVlAv(bi,bj)
79			c & +tmpValrA(i,j,bi,bj)drF(k)*hFacC(i,j,k,bi,bj)
80	jmc	1.9
81			C- Energy conservative form (like in pkg/mom_fluxform/mom_calc_ke.F)
82			C this is the safe way to check the energy conservation
83			C with no assumption on how grid spacing & area are defined.
84			tmpVal=0.25*(
85			& uVel( i ,j,k,bi,bj)*uVel( i ,j,k,bi,bj)
86	heimbach	1.15	& dyG( i ,j,bi,bj)dxC( i ,j,bi,bj)*_hFacW( i ,j,k,bi,bj)
87	jmc	1.9	& +uVel(i+1,j,k,bi,bj)*uVel(i+1,j,k,bi,bj)
88	heimbach	1.15	& dyG(i+1,j,bi,bj)dxC(i+1,j,bi,bj)*_hFacW(i+1,j,k,bi,bj)
89	jmc	1.9	& +vVel(i, j ,k,bi,bj)*vVel(i, j ,k,bi,bj)
90	heimbach	1.15	& dxG(i, j ,bi,bj)dyC(i, j ,bi,bj)*_hFacS(i, j ,k,bi,bj)
91	jmc	1.9	& +vVel(i,j+1,k,bi,bj)*vVel(i,j+1,k,bi,bj)
92	heimbach	1.15	& dxG(i,j+1,bi,bj)dyC(i,j+1,bi,bj)*_hFacS(i,j+1,k,bi,bj)
93	jmc	1.21	& )*maskInC(i,j,bi,bj)
94	jmc	1.16	tileVlAv(bi,bj) = tileVlAv(bi,bj)
95			& + tmpValdeepFac2C(k)rhoFacC(k)*drF(k)
96	heimbach	1.15	tmpVal= tmpVal_recip_hFacC(i,j,k,bi,bj)recip_rA(i,j,bi,bj)
97	jmc	1.9
98	jmc	1.18	#ifdef ALLOW_NONHYDROSTATIC
99			IF ( nonHydrostatic ) THEN
100			tmpWke = 0.25*
101	jmc	1.19	& ( wVel(i,j, k, bi,bj)wVel(i,j, k, bi,bj)msk_1
102	jmc	1.18	& deepFac2F( k )rhoFacF( k )
103			& +wVel(i,j,kp1,bi,bj)wVel(i,j,kp1,bi,bj)mskp1
104			& deepFac2F(kp1)rhoFacF(kp1)
105	jmc	1.21	& )maskC(i,j,k,bi,bj)maskInC(i,j,bi,bj)
106	jmc	1.18	tileVlAv(bi,bj) = tileVlAv(bi,bj)
107			& + tmpWkerA(i,j,bi,bj)drF(k)*_hFacC(i,j,k,bi,bj)
108			tmpVal = tmpVal
109			& + tmpWkerecip_deepFac2C(k)recip_rhoFacC(k)
110			ENDIF
111			#endif
112
113	jmc	1.16	theMax=MAX(theMax,tmpVal)
114	adcroft	1.1	IF (tmpVal.NE.0.) THEN
115	jmc	1.16	tileMean(bi,bj)=tileMean(bi,bj)+tmpVal
116	jmc	1.10	numPnts=numPnts+1.
117	adcroft	1.1	ENDIF
118	jmc	1.9
119	adcroft	1.1	ENDDO
120			ENDDO
121			ENDDO
122	jmc	1.10	C- Potential Energy (external mode):
123	jmc	1.16	DO j=1,sNy
124			DO i=1,sNx
125	jmc	1.10	tmpVal = 0.5 _d 0*Bo_surf(i,j,bi,bj)
126			& etaN(i,j,bi,bj)etaN(i,j,bi,bj)
127			C- jmc: if geoid not flat (phi0surf), needs to add this term.
128			C not sure for atmos/ocean in P ; or atmos. loading in ocean-Z
129			tmpVal = tmpVal
130			& + phi0surf(i,j,bi,bj)*etaN(i,j,bi,bj)
131	jmc	1.16	tilePEav(bi,bj) = tilePEav(bi,bj)
132	jmc	1.20	& + tmpValrA(i,j,bi,bj)deepFac2F(1)
133			& *maskInC(i,j,bi,bj)
134	jmc	1.10	c tmpVal = etaN(i,j,bi,bj)
135			c & + phi0surf(i,j,bi,bj)*recip_Bo(i,j,bi,bj)
136	jmc	1.16	c tilePEav(bi,bj) = tilePEav(bi,bj)
137	jmc	1.10	c & + 0.5 _d 0Bo_surf(i,j,bi,bj)tmpVal*tmpVal
138	jmc	1.20	c & rA(i,j,bi,bj)maskInC(i,j,bi,bj)
139	jmc	1.10	ENDDO
140			ENDDO
141			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	jmc	1.16	CALL GLOBAL_SUM_TILE_RL( tileMean, theMean , myThid )
147			CALL GLOBAL_SUM_TILE_RL( tileVol , theVol , myThid )
148			CALL GLOBAL_SUM_TILE_RL( tileVlAv, theVolMean, myThid )
149			CALL GLOBAL_SUM_TILE_RL( tilePEav, potEnMean , myThid )
150	jmc	1.10	IF (numPnts.NE.0.) theMean=theMean/numPnts
151			IF (theVol.NE.0.) THEN
152			theVolMean=theVolMean/theVol
153			potEnMean = potEnMean/theVol
154			ENDIF
155
156			C-- Print stats for (barotropic) Potential Energy:
157			CALL MON_SET_PREF('pe_b',myThid)
158			CALL MON_OUT_RL(mon_string_none,potEnMean,
159			& mon_foot_mean,myThid)
160	adcroft	1.1
161	jmc	1.10	C-- Print stats for KE
162			CALL MON_SET_PREF('ke',myThid)
163	jmc	1.8	CALL MON_OUT_RL(mon_string_none,theMax,mon_foot_max,myThid)
164	jmc	1.10	c CALL MON_OUT_RL(mon_string_none,theMean,mon_foot_mean,myThid)
165	jmc	1.8	CALL MON_OUT_RL(mon_string_none,theVolMean,
166	jmc	1.10	& mon_foot_mean,myThid)
167	jmc	1.9	CALL MON_OUT_RL(mon_string_none,theVol,
168			& mon_foot_vol,myThid)
169	adcroft	1.1
170			RETURN
171			END