source: branches/2015/dev_r5094_UKMO_ISFCLEAN/NEMOGCM/NEMO/OPA_SRC/DIA/diaar5.F90 @ 5111

Last change on this file since 5111 was 5111, checked in by mathiot, 6 years ago

add some missing if ln_isfcav, test of option compatibility with ln_isfcav + small documentation

  • Property svn:keywords set to Id
File size: 11.7 KB
Line 
1MODULE diaar5
2   !!======================================================================
3   !!                       ***  MODULE  diaar5  ***
4   !! AR5 diagnostics
5   !!======================================================================
6   !! History :  3.2  !  2009-11  (S. Masson)  Original code
7   !!            3.3  !  2010-10  (C. Ethe, G. Madec) reorganisation of initialisation phase + merge TRC-TRA
8   !!----------------------------------------------------------------------
9#if defined key_diaar5   || defined key_esopa
10   !!----------------------------------------------------------------------
11   !!   'key_diaar5'  :                           activate ar5 diagnotics
12   !!----------------------------------------------------------------------
13   !!   dia_ar5       : AR5 diagnostics
14   !!   dia_ar5_init  : initialisation of AR5 diagnostics
15   !!----------------------------------------------------------------------
16   USE oce            ! ocean dynamics and active tracers
17   USE dom_oce        ! ocean space and time domain
18   USE eosbn2         ! equation of state                (eos_bn2 routine)
19   USE lib_mpp        ! distribued memory computing library
20   USE iom            ! I/O manager library
21   USE timing         ! preformance summary
22   USE wrk_nemo       ! working arrays
23
24   IMPLICIT NONE
25   PRIVATE
26
27   PUBLIC   dia_ar5        ! routine called in step.F90 module
28   PUBLIC   dia_ar5_init   ! routine called in opa.F90 module
29   PUBLIC   dia_ar5_alloc  ! routine called in nemogcm.F90 module
30
31   LOGICAL, PUBLIC, PARAMETER :: lk_diaar5 = .TRUE.   ! coupled flag
32
33   REAL(wp)                         ::   vol0         ! ocean volume (interior domain)
34   REAL(wp)                         ::   area_tot     ! total ocean surface (interior domain)
35   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:  ) ::   area         ! cell surface (interior domain)
36   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:  ) ::   thick0       ! ocean thickness (interior domain)
37   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   sn0          ! initial salinity
38     
39   !! * Substitutions
40#  include "domzgr_substitute.h90"
41   !!----------------------------------------------------------------------
42   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
43   !! $Id$
44   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
45   !!----------------------------------------------------------------------
46CONTAINS
47
48   FUNCTION dia_ar5_alloc()
49      !!----------------------------------------------------------------------
50      !!                    ***  ROUTINE dia_ar5_alloc  ***
51      !!----------------------------------------------------------------------
52      INTEGER :: dia_ar5_alloc
53      !!----------------------------------------------------------------------
54      !
55      ALLOCATE( area(jpi,jpj), thick0(jpi,jpj) , sn0(jpi,jpj,jpk) , STAT=dia_ar5_alloc )
56      !
57      IF( lk_mpp             )   CALL mpp_sum ( dia_ar5_alloc )
58      IF( dia_ar5_alloc /= 0 )   CALL ctl_warn('dia_ar5_alloc: failed to allocate arrays')
59      !
60   END FUNCTION dia_ar5_alloc
61
62
63   SUBROUTINE dia_ar5( kt )
64      !!----------------------------------------------------------------------
65      !!                    ***  ROUTINE dia_ar5  ***
66      !!
67      !! ** Purpose :   compute and output some AR5 diagnostics
68      !!----------------------------------------------------------------------
69      !
70      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
71      !
72      INTEGER  ::   ji, jj, jk                      ! dummy loop arguments
73      REAL(wp) ::   zvolssh, zvol, zssh_steric, zztmp, zarho, ztemp, zsal, zmass
74      !
75      REAL(wp), POINTER, DIMENSION(:,:)     :: zarea_ssh , zbotpres       ! 2D workspace
76      REAL(wp), POINTER, DIMENSION(:,:,:)   :: zrhd , zrhop               ! 3D workspace
77      REAL(wp), POINTER, DIMENSION(:,:,:,:) :: ztsn                       ! 4D workspace
78      !!--------------------------------------------------------------------
79      IF( nn_timing == 1 )   CALL timing_start('dia_ar5')
80 
81      CALL wrk_alloc( jpi , jpj              , zarea_ssh , zbotpres )
82      CALL wrk_alloc( jpi , jpj , jpk        , zrhd      , zrhop    )
83      CALL wrk_alloc( jpi , jpj , jpk , jpts , ztsn                 )
84
85      CALL iom_put( 'cellthc', fse3t(:,:,:) )
86
87      zarea_ssh(:,:) = area(:,:) * sshn(:,:)
88
89      !                                         ! total volume of liquid seawater
90      zvolssh = SUM( zarea_ssh(:,:) ) 
91      IF( lk_mpp )   CALL mpp_sum( zvolssh )
92      zvol = vol0 + zvolssh
93     
94      CALL iom_put( 'voltot', zvol               )
95      CALL iom_put( 'sshtot', zvolssh / area_tot )
96
97      !                     
98      ztsn(:,:,:,jp_tem) = tsn(:,:,:,jp_tem)                    ! thermosteric ssh
99      ztsn(:,:,:,jp_sal) = sn0(:,:,:)
100      CALL eos( ztsn, zrhd, fsdept_n(:,:,:) )                       ! now in situ density using initial salinity
101      !
102      zbotpres(:,:) = 0._wp                        ! no atmospheric surface pressure, levitating sea-ice
103      DO jk = 1, jpkm1
104         zbotpres(:,:) = zbotpres(:,:) + fse3t(:,:,jk) * zrhd(:,:,jk)
105      END DO
106      IF( .NOT.lk_vvl ) THEN
107         IF ( ln_isfcav ) THEN
108            DO ji=1,jpi
109               DO jj=1,jpj
110                  zbotpres(ji,jj) = zbotpres(ji,jj) + sshn(ji,jj) * zrhd(ji,jj,mikt(ji,jj)) + riceload(ji,jj)
111               END DO
112            END DO
113         ELSE
114            zbotpres(:,:) = zbotpres(:,:) + sshn(:,:) * zrhd(:,:,1)
115         END IF
116      END IF
117      !                                         
118      zarho = SUM( area(:,:) * zbotpres(:,:) ) 
119      IF( lk_mpp )   CALL mpp_sum( zarho )
120      zssh_steric = - zarho / area_tot
121      CALL iom_put( 'sshthster', zssh_steric )
122     
123      !                                         ! steric sea surface height
124      CALL eos( tsn, zrhd, zrhop, fsdept_n(:,:,:) )                 ! now in situ and potential density
125      zrhop(:,:,jpk) = 0._wp
126      CALL iom_put( 'rhop', zrhop )
127      !
128      zbotpres(:,:) = 0._wp                        ! no atmospheric surface pressure, levitating sea-ice
129      DO jk = 1, jpkm1
130         zbotpres(:,:) = zbotpres(:,:) + fse3t(:,:,jk) * zrhd(:,:,jk)
131      END DO
132      IF( .NOT.lk_vvl ) THEN
133         IF ( ln_isfcav ) THEN
134            DO ji=1,jpi
135               DO jj=1,jpj
136                  zbotpres(ji,jj) = zbotpres(ji,jj) + sshn(ji,jj) * zrhd(ji,jj,mikt(ji,jj)) + riceload(ji,jj)
137               END DO
138            END DO
139         ELSE
140            zbotpres(:,:) = zbotpres(:,:) + sshn(:,:) * zrhd(:,:,1)
141         END IF
142      END IF
143      !   
144      zarho = SUM( area(:,:) * zbotpres(:,:) ) 
145      IF( lk_mpp )   CALL mpp_sum( zarho )
146      zssh_steric = - zarho / area_tot
147      CALL iom_put( 'sshsteric', zssh_steric )
148     
149      !                                         ! ocean bottom pressure
150      zztmp = rau0 * grav * 1.e-4_wp               ! recover pressure from pressure anomaly and cover to dbar = 1.e4 Pa
151      zbotpres(:,:) = zztmp * ( zbotpres(:,:) + sshn(:,:) + thick0(:,:) )
152      CALL iom_put( 'botpres', zbotpres )
153
154      !                                         ! Mean density anomalie, temperature and salinity
155      ztemp = 0._wp
156      zsal  = 0._wp
157      DO jk = 1, jpkm1
158         DO jj = 1, jpj
159            DO ji = 1, jpi
160               zztmp = area(ji,jj) * fse3t(ji,jj,jk)
161               ztemp = ztemp + zztmp * tsn(ji,jj,jk,jp_tem)
162               zsal  = zsal  + zztmp * tsn(ji,jj,jk,jp_sal)
163            END DO
164         END DO
165      END DO
166      IF( .NOT.lk_vvl ) THEN
167         IF ( ln_isfcav ) THEN
168            DO ji=1,jpi
169               DO jj=1,jpj
170                  ztemp = ztemp + zarea_ssh(ji,jj) * tsn(ji,jj,mikt(ji,jj),jp_tem) 
171                  zsal  = zsal  + zarea_ssh(ji,jj) * tsn(ji,jj,mikt(ji,jj),jp_sal) 
172               END DO
173            END DO
174         ELSE
175            ztemp = ztemp + zarea_ssh(:,:) * tsn(:,:,1,jp_tem) 
176            zsal  = zsal  + zarea_ssh(:,:) * tsn(:,:,1,jp_sal) 
177         END IF
178      ENDIF
179      IF( lk_mpp ) THEN 
180         CALL mpp_sum( ztemp )
181         CALL mpp_sum( zsal  )
182      END IF
183      !
184      zmass = rau0 * ( zarho + zvol )                 ! total mass of liquid seawater
185      ztemp = ztemp / zvol                            ! potential temperature in liquid seawater
186      zsal  = zsal  / zvol                            ! Salinity of liquid seawater
187      !
188      CALL iom_put( 'masstot', zmass )
189      CALL iom_put( 'temptot', ztemp )
190      CALL iom_put( 'saltot' , zsal  )
191      !
192      CALL wrk_dealloc( jpi , jpj              , zarea_ssh , zbotpres )
193      CALL wrk_dealloc( jpi , jpj , jpk        , zrhd      , zrhop    )
194      CALL wrk_dealloc( jpi , jpj , jpk , jpts , ztsn                 )
195      !
196      IF( nn_timing == 1 )   CALL timing_stop('dia_ar5')
197      !
198   END SUBROUTINE dia_ar5
199
200
201   SUBROUTINE dia_ar5_init
202      !!----------------------------------------------------------------------
203      !!                  ***  ROUTINE dia_ar5_init  ***
204      !!                   
205      !! ** Purpose :   initialization for AR5 diagnostic computation
206      !!----------------------------------------------------------------------
207      INTEGER  ::   inum
208      INTEGER  ::   ik
209      INTEGER  ::   ji, jj, jk  ! dummy loop indices
210      REAL(wp) ::   zztmp 
211      REAL(wp), POINTER, DIMENSION(:,:,:,:) ::   zsaldta   ! Jan/Dec levitus salinity
212      !!----------------------------------------------------------------------
213      !
214      IF( nn_timing == 1 )   CALL timing_start('dia_ar5_init')
215      !
216      CALL wrk_alloc( jpi , jpj , jpk, jpts, zsaldta )
217      !                                      ! allocate dia_ar5 arrays
218      IF( dia_ar5_alloc() /= 0 )   CALL ctl_stop( 'STOP', 'dia_ar5_init : unable to allocate arrays' )
219
220      area(:,:) = e1t(:,:) * e2t(:,:) * tmask_i(:,:)
221
222      area_tot = SUM( area(:,:) )   ;   IF( lk_mpp )   CALL mpp_sum( area_tot )
223
224      vol0        = 0._wp
225      thick0(:,:) = 0._wp
226      DO jk = 1, jpkm1
227         vol0        = vol0        + SUM( area (:,:) * tmask(:,:,jk) * e3t_0(:,:,jk) )
228         thick0(:,:) = thick0(:,:) +    tmask_i(:,:) * tmask(:,:,jk) * e3t_0(:,:,jk)
229      END DO
230      IF( lk_mpp )   CALL mpp_sum( vol0 )
231     
232      CALL iom_open ( 'data_1m_salinity_nomask', inum )
233      CALL iom_get  ( inum, jpdom_data, 'vosaline', zsaldta(:,:,:,1), 1  )
234      CALL iom_get  ( inum, jpdom_data, 'vosaline', zsaldta(:,:,:,2), 12 )
235      CALL iom_close( inum )
236      sn0(:,:,:) = 0.5_wp * ( zsaldta(:,:,:,1) + zsaldta(:,:,:,2) )       
237      sn0(:,:,:) = sn0(:,:,:) * tmask(:,:,:)
238      IF( ln_zps ) THEN               ! z-coord. partial steps
239         DO jj = 1, jpj               ! interpolation of salinity at the last ocean level (i.e. the partial step)
240            DO ji = 1, jpi
241               ik = mbkt(ji,jj)
242               IF( ik > 1 ) THEN
243                  zztmp = ( gdept_1d(ik) - gdept_0(ji,jj,ik) ) / ( gdept_1d(ik) - gdept_1d(ik-1) )
244                  sn0(ji,jj,ik) = ( 1._wp - zztmp ) * sn0(ji,jj,ik) + zztmp * sn0(ji,jj,ik-1)
245               ENDIF
246            END DO
247         END DO
248      ENDIF
249      !
250      CALL wrk_dealloc( jpi , jpj , jpk, jpts, zsaldta )
251      !
252      IF( nn_timing == 1 )   CALL timing_stop('dia_ar5_init')
253      !
254   END SUBROUTINE dia_ar5_init
255
256#else
257   !!----------------------------------------------------------------------
258   !!   Default option :                                         NO diaar5
259   !!----------------------------------------------------------------------
260   LOGICAL, PUBLIC, PARAMETER :: lk_diaar5 = .FALSE.   ! coupled flag
261CONTAINS
262   SUBROUTINE dia_ar5_init    ! Dummy routine
263   END SUBROUTINE dia_ar5_init
264   SUBROUTINE dia_ar5( kt )   ! Empty routine
265      INTEGER ::   kt
266      WRITE(*,*) 'dia_ar5: You should not have seen this print! error?', kt
267   END SUBROUTINE dia_ar5
268#endif
269
270   !!======================================================================
271END MODULE diaar5
Note: See TracBrowser for help on using the repository browser.