model/src/ini_pressure.F

C $Header: 
C $Name:  

#include "CPP_OPTIONS.h"

CBOP
C     !ROUTINE: INI_PRESSURE
C     !INTERFACE:
      SUBROUTINE INI_PRESSURE( myThid )
C     !DESCRIPTION: \bv
C     *==========================================================*
C     | SUBROUTINE INI_PRESSURE
C     | o initialise the pressure field consistently with 
C     |   temperature and salinity
C     |   - needs to be called after ini_theta, ini_salt, and 
C     |     ini_psurf
C     |   - does not include surface pressure loading, because
C     |     that is only available until after 
C     |     CALL packages_init_variables
C     *==========================================================*
C     \ev

C     !USES:
      IMPLICIT NONE
C     == Global variables ==
#include "SIZE.h"
#include "EEPARAMS.h"
#include "PARAMS.h"
#include "EOS.h"
#include "GRID.h"
#include "DYNVARS.h"

C     !INPUT/OUTPUT PARAMETERS:
C     == Routine arguments ==
C     myThid -  Number of this instance of INI_PRESSURE
      INTEGER myThid

C     !LOCAL VARIABLES:
C     == Local variables ==
C     dPhiHydX,Y :: Gradient (X & Y directions) of Hyd. Potential
C     bi,bj  - Loop counters
C     I,J,K
      INTEGER bi, bj
      INTEGER  I,  J, K
      INTEGER  iMin, iMax, jMin, jMax, npiter
      _RL PhiHydF (1-Olx:sNx+Olx,1-Oly:sNy+Oly)
      _RL PhiHydC (1-Olx:sNx+Olx,1-Oly:sNy+Oly)
      _RL dPhiHydX(1-Olx:sNx+Olx,1-Oly:sNy+Oly)
      _RL dPhiHydY(1-Olx:sNx+Olx,1-Oly:sNy+Oly)
      _RL oldPhi  (1-Olx:sNx+Olx,1-Oly:sNy+Oly)
      _RL count, rmspp, rmsppold 

      CHARACTER*(MAX_LEN_MBUF) msgBuf
CEOP
      iMin = 1-OLx
      iMax = sNx+OLx
      jMin = 1-OLy
      jMax = sNy+OLy
      
      WRITE(msgBuf,'(a)')
     &     'Start initial hydrostatic pressure computation'
      CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, 
     &     SQUEEZE_RIGHT , 1)
      DO bj = myByLo(myThid), myByHi(myThid)
       DO bi = myBxLo(myThid), myBxHi(myThid)
        DO k = 1,Nr
         DO j=1-OLy,sNy+OLy
          DO i=1-OLx,sNx+OLx
           totPhiHyd(i,j,k,bi,bj) = 0. _d 0
          ENDDO
         ENDDO
        ENDDO
       ENDDO
      ENDDO

c     IF ( startTime .NE. 0. ) RETURN
c     IF ( buoyancyRelation .EQ. 'OCEANIC' ) THEN
      IF ( useDynP_inEos_Zc ) THEN

       rmspp    = 1. _d 0
       rmsppold = 0. _d 0
       npiter = 0

C     iterate pressure p = integral of (g*rho(p)*dz)
       DO npiter= 1, 15
        rmsppold = rmspp
        rmspp    = 0. _d 0
        count    = 0.
        DO bj = myByLo(myThid), myByHi(myThid)
         DO bi = myBxLo(myThid), myBxHi(myThid)
           DO j=1-OLy,sNy+OLy
            DO i=1-OLx,sNx+OLx
             phiHydF(i,j) = 0. _d 0
            ENDDO
           ENDDO
          DO k = 1, Nr
C     for each level save old pressure and compute new pressure 
           DO j=jMin,jMax
            DO i=iMin,iMax
             oldPhi(i,j) = totPhiHyd(i,j,k,bi,bj)
            ENDDO
           ENDDO
           CALL CALC_PHI_HYD(
     I          bi, bj, iMin, iMax, jMin, jMax, k,
     I          theta, salt, 
     U          phiHydF,
     O          phiHydC, dPhiHydX, dPhiHydY,
     I          startTime, nIter0, myThid)
C     compute convergence criterion
           DO j=jMin,jMax
            DO i=iMin,iMax
             rmspp = rmspp 
     &            + (totPhiHyd(i,j,k,bi,bj)-oldPhi(i,j))**2
             count = count + maskC(i,j,k,bi,bj)
            ENDDO
           ENDDO
C --      end k loop
          ENDDO
         ENDDO
        ENDDO
Cml        WRITE(msgBuf,'(I10.10)') npiter
Cml        CALL WRITE_FLD_XYZ_RL( 'POLD.',msgBuf,pold,npiter,myThid)
Cml        CALL WRITE_FLD_XYZ_RL( 'PINI.',msgBuf,pressure,npiter,myThid)
        _GLOBAL_SUM_R8( rmspp, myThid )
        _GLOBAL_SUM_R8( count, myThid )  
        IF ( count .EQ. 0. ) THEN
           rmspp = 0. _d 0
        ELSE
           rmspp = sqrt(rmspp/count)
        ENDIF
        WRITE(msgBuf,'(a,i2,a,e20.13)')
     &       'Iteration ', npiter, ', RMS-difference = ', rmspp
        CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, 
     &       SQUEEZE_RIGHT , 1)

C --   end npiter loop
       ENDDO
C     print some diagnostics    
       IF ( rmspp .ne. 0. ) THEN
        IF ( rmspp .EQ. rmsppold ) THEN
         WRITE(msgBuf,'(A)')
     &      'Initial hydrostatic pressure did not converge perfectly,' 
         CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, 
     &        SQUEEZE_RIGHT , 1)
         WRITE(msgBuf,'(A)')
     &      'but the RMS-difference is constant, indicating that the'
         CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, 
     &        SQUEEZE_RIGHT , 1)
         WRITE(msgBuf,'(A)')
     &      'algorithm converged within machine precision.'    
         CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, 
     &        SQUEEZE_RIGHT , 1)
        ELSE
         WRITE(msgBuf,'(A,I2,A)')
     &       'Initial hydrostatic pressure did not converge after ', 
     &          npiter-1, ' steps'
         CALL PRINT_ERROR( msgBuf, myThid )
         STOP 'ABNORMAL END: S/R INI_PRESSURE'
        ENDIF
       ENDIF
       WRITE(msgBuf,'(A)')
     &     'Initial hydrostatic pressure converged.' 
       CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, 
     &      SQUEEZE_RIGHT , 1)

      ELSE
C     print a message and DO nothing
       WRITE(msgBuf,'(A,A)')
     &        'Pressure is predetermined for buoyancyRelation ',
     &        buoyancyRelation(1:11)
       CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, 
     &      SQUEEZE_RIGHT , 1)

      ENDIF

      WRITE(msgBuf,'(A)') ' '
      CALL PRINT_MESSAGE( msgBuf, standardMessageUnit, 
     &     SQUEEZE_RIGHT , 1)

      RETURN 
      END
1	mlosch	1.1	C $Header:
2			C $Name:
3
4			#include "CPP_OPTIONS.h"
5
6			CBOP
7			C !ROUTINE: INI_PRESSURE
8			C !INTERFACE:
9	jmc	1.3	SUBROUTINE INI_PRESSURE( myThid )
10	mlosch	1.1	C !DESCRIPTION: \bv
11			C ==========================================================
12			C \| SUBROUTINE INI_PRESSURE
13			C \| o initialise the pressure field consistently with
14			C \| temperature and salinity
15			C \| - needs to be called after ini_theta, ini_salt, and
16			C \| ini_psurf
17			C \| - does not include surface pressure loading, because
18			C \| that is only available until after
19	jmc	1.3	C \| CALL packages_init_variables
20	mlosch	1.1	C ==========================================================
21			C \ev
22
23			C !USES:
24	jmc	1.3	IMPLICIT NONE
25	mlosch	1.1	C == Global variables ==
26			#include "SIZE.h"
27			#include "EEPARAMS.h"
28			#include "PARAMS.h"
29			#include "EOS.h"
30			#include "GRID.h"
31			#include "DYNVARS.h"
32
33			C !INPUT/OUTPUT PARAMETERS:
34			C == Routine arguments ==
35			C myThid - Number of this instance of INI_PRESSURE
36			INTEGER myThid
37
38			C !LOCAL VARIABLES:
39			C == Local variables ==
40	jmc	1.3	C dPhiHydX,Y :: Gradient (X & Y directions) of Hyd. Potential
41	mlosch	1.1	C bi,bj - Loop counters
42			C I,J,K
43			INTEGER bi, bj
44			INTEGER I, J, K
45	jmc	1.4	INTEGER iMin, iMax, jMin, jMax, npiter
46			_RL PhiHydF (1-Olx:sNx+Olx,1-Oly:sNy+Oly)
47			_RL PhiHydC (1-Olx:sNx+Olx,1-Oly:sNy+Oly)
48	jmc	1.3	_RL dPhiHydX(1-Olx:sNx+Olx,1-Oly:sNy+Oly)
49			_RL dPhiHydY(1-Olx:sNx+Olx,1-Oly:sNy+Oly)
50	jmc	1.4	_RL oldPhi (1-Olx:sNx+Olx,1-Oly:sNy+Oly)
51			_RL count, rmspp, rmsppold
52	mlosch	1.1
53			CHARACTER*(MAX_LEN_MBUF) msgBuf
54	mlosch	1.2	CEOP
55	mlosch	1.1	iMin = 1-OLx
56			iMax = sNx+OLx
57			jMin = 1-OLy
58			jMax = sNy+OLy
59
60	jmc	1.3	WRITE(msgBuf,'(a)')
61	mlosch	1.1	& 'Start initial hydrostatic pressure computation'
62			CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
63			& SQUEEZE_RIGHT , 1)
64	jmc	1.3	DO bj = myByLo(myThid), myByHi(myThid)
65			DO bi = myBxLo(myThid), myBxHi(myThid)
66			DO k = 1,Nr
67			DO j=1-OLy,sNy+OLy
68			DO i=1-OLx,sNx+OLx
69	jmc	1.4	totPhiHyd(i,j,k,bi,bj) = 0. _d 0
70	jmc	1.3	ENDDO
71			ENDDO
72			ENDDO
73			ENDDO
74			ENDDO
75	mlosch	1.1
76	jmc	1.4	c IF ( startTime .NE. 0. ) RETURN
77			c IF ( buoyancyRelation .EQ. 'OCEANIC' ) THEN
78			IF ( useDynP_inEos_Zc ) THEN
79	mlosch	1.1
80			rmspp = 1. _d 0
81			rmsppold = 0. _d 0
82			npiter = 0
83
84			C iterate pressure p = integral of (grho(p)dz)
85	jmc	1.4	DO npiter= 1, 15
86	mlosch	1.1	rmsppold = rmspp
87			rmspp = 0. _d 0
88	jmc	1.4	count = 0.
89	jmc	1.3	DO bj = myByLo(myThid), myByHi(myThid)
90			DO bi = myBxLo(myThid), myBxHi(myThid)
91	jmc	1.4	DO j=1-OLy,sNy+OLy
92			DO i=1-OLx,sNx+OLx
93			phiHydF(i,j) = 0. _d 0
94			ENDDO
95			ENDDO
96	jmc	1.3	DO k = 1, Nr
97	mlosch	1.1	C for each level save old pressure and compute new pressure
98	jmc	1.3	DO j=jMin,jMax
99			DO i=iMin,iMax
100	jmc	1.4	oldPhi(i,j) = totPhiHyd(i,j,k,bi,bj)
101	jmc	1.3	ENDDO
102			ENDDO
103			CALL CALC_PHI_HYD(
104			I bi, bj, iMin, iMax, jMin, jMax, k,
105			I theta, salt,
106	jmc	1.4	U phiHydF,
107			O phiHydC, dPhiHydX, dPhiHydY,
108	jmc	1.3	I startTime, nIter0, myThid)
109	mlosch	1.1	C compute convergence criterion
110	jmc	1.3	DO j=jMin,jMax
111			DO i=iMin,iMax
112	mlosch	1.1	rmspp = rmspp
113	jmc	1.4	& + (totPhiHyd(i,j,k,bi,bj)-oldPhi(i,j))**2
114			count = count + maskC(i,j,k,bi,bj)
115	jmc	1.3	ENDDO
116			ENDDO
117	jmc	1.4	C -- end k loop
118	jmc	1.3	ENDDO
119			ENDDO
120			ENDDO
121	mlosch	1.1	Cml WRITE(msgBuf,'(I10.10)') npiter
122			Cml CALL WRITE_FLD_XYZ_RL( 'POLD.',msgBuf,pold,npiter,myThid)
123			Cml CALL WRITE_FLD_XYZ_RL( 'PINI.',msgBuf,pressure,npiter,myThid)
124	jmc	1.4	_GLOBAL_SUM_R8( rmspp, myThid )
125			_GLOBAL_SUM_R8( count, myThid )
126			IF ( count .EQ. 0. ) THEN
127	mlosch	1.1	rmspp = 0. _d 0
128	jmc	1.3	ELSE
129	jmc	1.4	rmspp = sqrt(rmspp/count)
130	jmc	1.3	ENDIF
131			WRITE(msgBuf,'(a,i2,a,e20.13)')
132	mlosch	1.1	& 'Iteration ', npiter, ', RMS-difference = ', rmspp
133			CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
134			& SQUEEZE_RIGHT , 1)
135
136	jmc	1.4	C -- end npiter loop
137	jmc	1.3	ENDDO
138	mlosch	1.1	C print some diagnostics
139	jmc	1.3	IF ( rmspp .ne. 0. ) THEN
140			IF ( rmspp .EQ. rmsppold ) THEN
141	jmc	1.4	WRITE(msgBuf,'(A)')
142	mlosch	1.1	& 'Initial hydrostatic pressure did not converge perfectly,'
143			CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
144			& SQUEEZE_RIGHT , 1)
145	jmc	1.4	WRITE(msgBuf,'(A)')
146	mlosch	1.1	& 'but the RMS-difference is constant, indicating that the'
147			CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
148			& SQUEEZE_RIGHT , 1)
149	jmc	1.4	WRITE(msgBuf,'(A)')
150	mlosch	1.1	& 'algorithm converged within machine precision.'
151			CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
152			& SQUEEZE_RIGHT , 1)
153	jmc	1.3	ELSE
154	jmc	1.4	WRITE(msgBuf,'(A,I2,A)')
155	mlosch	1.1	& 'Initial hydrostatic pressure did not converge after ',
156			& npiter-1, ' steps'
157			CALL PRINT_ERROR( msgBuf, myThid )
158			STOP 'ABNORMAL END: S/R INI_PRESSURE'
159	jmc	1.3	ENDIF
160			ENDIF
161	jmc	1.4	WRITE(msgBuf,'(A)')
162	mlosch	1.1	& 'Initial hydrostatic pressure converged.'
163			CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
164			& SQUEEZE_RIGHT , 1)
165
166	jmc	1.3	ELSE
167			C print a message and DO nothing
168	jmc	1.4	WRITE(msgBuf,'(A,A)')
169	mlosch	1.1	& 'Pressure is predetermined for buoyancyRelation ',
170			& buoyancyRelation(1:11)
171			CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
172			& SQUEEZE_RIGHT , 1)
173
174	jmc	1.3	ENDIF
175	mlosch	1.1
176	jmc	1.4	WRITE(msgBuf,'(A)') ' '
177	mlosch	1.1	CALL PRINT_MESSAGE( msgBuf, standardMessageUnit,
178			& SQUEEZE_RIGHT , 1)
179
180	jmc	1.3	RETURN
181			END