source: branches/2015/dev_r5094_UKMO_ISFCLEAN/NEMOGCM/NEMO/OPA_SRC/SBC/sbcfwb.F90 @ 5098

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

add wmask, wumask, wvmask and restore loop order and add flag to ignore specific isf code if no isf

  • Property svn:keywords set to Id
File size: 11.5 KB
Line 
1MODULE sbcfwb
2   !!======================================================================
3   !!                       ***  MODULE  sbcfwb  ***
4   !! Ocean fluxes   : domain averaged freshwater budget
5   !!======================================================================
6   !! History :  OPA  ! 2001-02  (E. Durand)  Original code
7   !!   NEMO     1.0  ! 2002-06  (G. Madec)  F90: Free form and module
8   !!            3.0  ! 2006-08  (G. Madec)  Surface module
9   !!            3.2  ! 2009-07  (C. Talandier) emp mean s spread over erp area
10   !!            3.6  ! 2014-11  (P. Mathiot  ) add ice shelf melting
11   !!----------------------------------------------------------------------
12
13   !!----------------------------------------------------------------------
14   !!   sbc_fwb      : freshwater budget for global ocean configurations
15   !!                  in free surface and forced mode
16   !!----------------------------------------------------------------------
17   USE oce             ! ocean dynamics and tracers
18   USE dom_oce         ! ocean space and time domain
19   USE sbc_oce         ! surface ocean boundary condition
20   USE phycst          ! physical constants
21   USE sbcrnf          ! ocean runoffs
22   USE sbcisf          ! ice shelf melting contribution
23   USE sbcssr          ! SS damping terms
24   USE in_out_manager  ! I/O manager
25   USE lib_mpp         ! distribued memory computing library
26   USE wrk_nemo        ! work arrays
27   USE timing          ! Timing
28   USE lbclnk          ! ocean lateral boundary conditions
29   USE lib_fortran
30
31   IMPLICIT NONE
32   PRIVATE
33
34   PUBLIC   sbc_fwb    ! routine called by step
35
36   REAL(wp) ::   a_fwb_b   ! annual domain averaged freshwater budget
37   REAL(wp) ::   a_fwb     ! for 2 year before (_b) and before year.
38   REAL(wp) ::   fwfold    ! fwfold to be suppressed
39   REAL(wp) ::   area      ! global mean ocean surface (interior domain)
40
41   !! * Substitutions
42#  include "domzgr_substitute.h90"
43#  include "vectopt_loop_substitute.h90"
44   !!----------------------------------------------------------------------
45   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
46   !! $Id$
47   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
48   !!----------------------------------------------------------------------
49CONTAINS
50
51   SUBROUTINE sbc_fwb( kt, kn_fwb, kn_fsbc )
52      !!---------------------------------------------------------------------
53      !!                  ***  ROUTINE sbc_fwb  ***
54      !!
55      !! ** Purpose :   Control the mean sea surface drift
56      !!
57      !! ** Method  :   several ways  depending on kn_fwb
58      !!                =0 no control
59      !!                =1 global mean of emp set to zero at each nn_fsbc time step
60      !!                =2 annual global mean corrected from previous year
61      !!                =3 global mean of emp set to zero at each nn_fsbc time step
62      !!                   & spread out over erp area depending its sign
63      !! Note: if sea ice is embedded it is taken into account when computing the budget
64      !!----------------------------------------------------------------------
65      INTEGER, INTENT( in ) ::   kt       ! ocean time-step index
66      INTEGER, INTENT( in ) ::   kn_fsbc  !
67      INTEGER, INTENT( in ) ::   kn_fwb   ! ocean time-step index
68      !
69      INTEGER  ::   inum, ikty, iyear     ! local integers
70      REAL(wp) ::   z_fwf, z_fwf_nsrf, zsum_fwf, zsum_erp                ! local scalars
71      REAL(wp) ::   zsurf_neg, zsurf_pos, zsurf_tospread, zcoef          !   -      -
72      REAL(wp), POINTER, DIMENSION(:,:) ::   ztmsk_neg, ztmsk_pos, z_wgt ! 2D workspaces
73      REAL(wp), POINTER, DIMENSION(:,:) ::   ztmsk_tospread, zerp_cor    !   -      -
74      !!----------------------------------------------------------------------
75      !
76      IF( nn_timing == 1 )  CALL timing_start('sbc_fwb')
77      !
78      CALL wrk_alloc( jpi,jpj, ztmsk_neg, ztmsk_pos, ztmsk_tospread, z_wgt, zerp_cor )
79      !
80      IF( kt == nit000 ) THEN
81         IF(lwp) THEN
82            WRITE(numout,*)
83            WRITE(numout,*) 'sbc_fwb : FreshWater Budget correction'
84            WRITE(numout,*) '~~~~~~~'
85            IF( kn_fwb == 1 )   WRITE(numout,*) '          instantaneously set to zero'
86            IF( kn_fwb == 2 )   WRITE(numout,*) '          adjusted from previous year budget'
87            IF( kn_fwb == 3 )   WRITE(numout,*) '          fwf set to zero and spread out over erp area'
88         ENDIF
89         !
90         IF( kn_fwb == 3 .AND. nn_sssr /= 2 )   CALL ctl_stop( 'sbc_fwb: nn_fwb = 3 requires nn_sssr = 2, we stop ' )
91         !
92         area = glob_sum( e1e2t(:,:) )           ! interior global domain surface
93         !
94#if ! defined key_lim2 &&  ! defined key_lim3 && ! defined key_cice
95         snwice_mass_b(:,:) = 0.e0               ! no sea-ice model is being used : no snow+ice mass
96         snwice_mass  (:,:) = 0.e0
97#endif
98         !
99      ENDIF
100     
101
102      SELECT CASE ( kn_fwb )
103      !
104      CASE ( 1 )                             !==  global mean fwf set to zero  ==!
105         !
106         IF( MOD( kt-1, kn_fsbc ) == 0 ) THEN
107            z_fwf = glob_sum( e1e2t(:,:) * ( emp(:,:) - rnf(:,:) + rdivisf * fwfisf(:,:) -  snwice_fmass(:,:) ) ) / area   ! sum over the global domain
108            zcoef = z_fwf * rcp
109            emp(:,:) = emp(:,:) - z_fwf 
110            qns(:,:) = qns(:,:) + zcoef * sst_m(:,:)  ! account for change to the heat budget due to fw correction
111         ENDIF
112         !
113      CASE ( 2 )                             !==  fwf budget adjusted from the previous year  ==!
114         !
115         IF( kt == nit000 ) THEN                      ! initialisation
116            !                                         ! Read the corrective factor on precipitations (fwfold)
117            CALL ctl_opn( inum, 'EMPave_old.dat', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE. )
118            READ ( inum, "(24X,I8,2ES24.16)" ) iyear, a_fwb_b, a_fwb
119            CLOSE( inum )
120            fwfold = a_fwb                            ! current year freshwater budget correction
121            !                                         ! estimate from the previous year budget
122            IF(lwp)WRITE(numout,*)
123            IF(lwp)WRITE(numout,*)'sbc_fwb : year = ',iyear  , ' freshwater budget correction = ', fwfold
124            IF(lwp)WRITE(numout,*)'          year = ',iyear-1, ' freshwater budget read       = ', a_fwb
125            IF(lwp)WRITE(numout,*)'          year = ',iyear-2, ' freshwater budget read       = ', a_fwb_b
126         ENDIF   
127         !                                         ! Update fwfold if new year start
128         ikty = 365 * 86400 / rdttra(1)    !!bug  use of 365 days leap year or 360d year !!!!!!!
129         IF( MOD( kt, ikty ) == 0 ) THEN
130            a_fwb_b = a_fwb                           ! mean sea level taking into account the ice+snow
131                                                      ! sum over the global domain
132            a_fwb   = glob_sum( e1e2t(:,:) * ( sshn(:,:) + snwice_mass(:,:) * r1_rau0 ) )
133            a_fwb   = a_fwb * 1.e+3 / ( area * rday * 365. )     ! convert in Kg/m3/s = mm/s
134!!gm        !                                                      !!bug 365d year
135            fwfold =  a_fwb                           ! current year freshwater budget correction
136            !                                         ! estimate from the previous year budget
137         ENDIF
138         !
139         IF( MOD( kt-1, kn_fsbc ) == 0 ) THEN         ! correct the freshwater fluxes
140            zcoef = fwfold * rcp
141            emp(:,:) = emp(:,:) + fwfold
142            qns(:,:) = qns(:,:) - zcoef * sst_m(:,:)  ! account for change to the heat budget due to fw correction
143         ENDIF
144         !
145         IF( kt == nitend .AND. lwp ) THEN            ! save fwfold value in a file
146            CALL ctl_opn( inum, 'EMPave.dat', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE., narea )
147            WRITE( inum, "(24X,I8,2ES24.16)" ) nyear, a_fwb_b, a_fwb
148            CLOSE( inum )
149         ENDIF
150         !
151      CASE ( 3 )                             !==  global fwf set to zero and spread out over erp area  ==!
152         !
153         IF( MOD( kt-1, kn_fsbc ) == 0 ) THEN
154            ztmsk_pos(:,:) = tmask_i(:,:)                      ! Select <0 and >0 area of erp
155            WHERE( erp < 0._wp )   ztmsk_pos = 0._wp
156            ztmsk_neg(:,:) = tmask_i(:,:) - ztmsk_pos(:,:)
157            !
158            zsurf_neg = glob_sum( e1e2t(:,:)*ztmsk_neg(:,:) )  ! Area filled by <0 and >0 erp
159            zsurf_pos = glob_sum( e1e2t(:,:)*ztmsk_pos(:,:) )
160            !                                                  ! fwf global mean (excluding ocean to ice/snow exchanges)
161            z_fwf     = glob_sum( e1e2t(:,:) * ( emp(:,:) - rnf(:,:) + rdivisf * fwfisf(:,:) - snwice_fmass(:,:) ) ) / area
162            !           
163            IF( z_fwf < 0._wp ) THEN         ! spread out over >0 erp area to increase evaporation
164                zsurf_tospread      = zsurf_pos
165                ztmsk_tospread(:,:) = ztmsk_pos(:,:)
166            ELSE                             ! spread out over <0 erp area to increase precipitation
167                zsurf_tospread      = zsurf_neg
168                ztmsk_tospread(:,:) = ztmsk_neg(:,:)
169            ENDIF
170            !
171            zsum_fwf   = glob_sum( e1e2t(:,:) * z_fwf )         ! fwf global mean over <0 or >0 erp area
172!!gm :  zsum_fwf   = z_fwf * area   ???  it is right?  I think so....
173            z_fwf_nsrf =  zsum_fwf / ( zsurf_tospread + rsmall )
174            !                                                  ! weight to respect erp field 2D structure
175            zsum_erp   = glob_sum( ztmsk_tospread(:,:) * erp(:,:) * e1e2t(:,:) )
176            z_wgt(:,:) = ztmsk_tospread(:,:) * erp(:,:) / ( zsum_erp + rsmall )
177            !                                                  ! final correction term to apply
178            zerp_cor(:,:) = -1. * z_fwf_nsrf * zsurf_tospread * z_wgt(:,:)
179            !
180!!gm   ===>>>>  lbc_lnk should be useless as all the computation is done over the whole domain !
181            CALL lbc_lnk( zerp_cor, 'T', 1. )
182            !
183            emp(:,:) = emp(:,:) + zerp_cor(:,:)
184            qns(:,:) = qns(:,:) - zerp_cor(:,:) * rcp * sst_m(:,:)  ! account for change to the heat budget due to fw correction
185            erp(:,:) = erp(:,:) + zerp_cor(:,:)
186            !
187            IF( nprint == 1 .AND. lwp ) THEN                   ! control print
188               IF( z_fwf < 0._wp ) THEN
189                  WRITE(numout,*)'   z_fwf < 0'
190                  WRITE(numout,*)'   SUM(erp+)     = ', SUM( ztmsk_tospread(:,:)*erp(:,:)*e1e2t(:,:) )*1.e-9,' Sv'
191               ELSE
192                  WRITE(numout,*)'   z_fwf >= 0'
193                  WRITE(numout,*)'   SUM(erp-)     = ', SUM( ztmsk_tospread(:,:)*erp(:,:)*e1e2t(:,:) )*1.e-9,' Sv'
194               ENDIF
195               WRITE(numout,*)'   SUM(empG)     = ', SUM( z_fwf*e1e2t(:,:) )*1.e-9,' Sv'
196               WRITE(numout,*)'   z_fwf         = ', z_fwf      ,' Kg/m2/s'
197               WRITE(numout,*)'   z_fwf_nsrf    = ', z_fwf_nsrf ,' Kg/m2/s'
198               WRITE(numout,*)'   MIN(zerp_cor) = ', MINVAL(zerp_cor) 
199               WRITE(numout,*)'   MAX(zerp_cor) = ', MAXVAL(zerp_cor) 
200            ENDIF
201         ENDIF
202         !
203      CASE DEFAULT                           !==  you should never be there  ==!
204         CALL ctl_stop( 'sbc_fwb : wrong nn_fwb value for the FreshWater Budget correction, choose either 1, 2 or 3' )
205         !
206      END SELECT
207      !
208      CALL wrk_dealloc( jpi,jpj, ztmsk_neg, ztmsk_pos, ztmsk_tospread, z_wgt, zerp_cor )
209      !
210      IF( nn_timing == 1 )  CALL timing_stop('sbc_fwb')
211      !
212   END SUBROUTINE sbc_fwb
213
214   !!======================================================================
215END MODULE sbcfwb
Note: See TracBrowser for help on using the repository browser.