New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
sbcfwb.F90 on Ticket #465 – Attachment – NEMO

Ticket #465: sbcfwb.F90

File sbcfwb.F90, 10.3 KB (added by rachel.furner, 14 years ago)
Line 
1MODULE sbcfwb
2   !!======================================================================
3   !!                       ***  MODULE  sbcfwb  ***
4   !! Ocean fluxes   : domain averaged freshwater budget
5   !!======================================================================
6   !! History :  8.2  !  01-02  (E. Durand)  Original code
7   !!            8.5  !  02-06  (G. Madec)  F90: Free form and module
8   !!            9.0  !  06-08  (G. Madec)  Surface module
9   !!            9.2  !  09-07  (C. Talandier) emp mean s spread over erp area
10   !!----------------------------------------------------------------------
11
12   !!----------------------------------------------------------------------
13   !!   sbc_fwb      : freshwater budget for global ocean configurations
14   !!                  in free surface and forced mode
15   !!----------------------------------------------------------------------
16   USE oce             ! ocean dynamics and tracers
17   USE dom_oce         ! ocean space and time domain
18   USE sbc_oce         ! surface ocean boundary condition
19   USE phycst          ! physical constants
20   USE sbcrnf          ! ocean runoffs
21   USE sbcssr          ! SS damping terms
22   USE daymod          ! calendar
23   USE in_out_manager  ! I/O manager
24   USE lib_mpp         ! distribued memory computing library
25   USE lbclnk          ! ocean lateral boundary conditions
26
27   IMPLICIT NONE
28   PRIVATE
29
30   PUBLIC   sbc_fwb      ! routine called by step
31
32   REAL(wp) ::   a_fwb_b            ! annual domain averaged freshwater budget
33   REAL(wp) ::   a_fwb              ! for 2 year before (_b) and before year.
34   REAL(wp) ::   fwfold             ! fwfold to be suppressed
35   REAL(wp) ::   area               ! global mean ocean surface (interior domain)
36
37   REAL(wp), DIMENSION(jpi,jpj) ::   e1e2_i    ! area of the interior domain (e1t*e2t*tmask_i)
38
39   !! * Substitutions
40#  include "domzgr_substitute.h90"
41#  include "vectopt_loop_substitute.h90"
42   !!----------------------------------------------------------------------
43   !!  OPA 9.0 , LOCEAN-IPSL (2006)
44   !! $Id: sbcfwb.F90 1218 2008-10-28 09:12:16Z smasson $
45   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
46   !!----------------------------------------------------------------------
47CONTAINS
48
49   SUBROUTINE sbc_fwb( kt, kn_fwb, kn_fsbc )
50      !!---------------------------------------------------------------------
51      !!                  ***  ROUTINE sbc_fwb  ***
52      !!
53      !! ** Purpose :   Control the mean sea surface drift
54      !!
55      !! ** Method  :   several ways  depending on kn_fwb
56      !!                =0 no control
57      !!                =1 global mean of emp set to zero at each nn_fsbc time step
58      !!                =2 annual global mean corrected from previous year
59      !!                =3 global mean of emp set to zero at each nn_fsbc time step
60      !!                   & spread out over erp area depending its sign
61      !!----------------------------------------------------------------------
62      INTEGER, INTENT( in ) ::   kt       ! ocean time-step index
63      INTEGER, INTENT( in ) ::   kn_fsbc  !
64      INTEGER, INTENT( in ) ::   kn_fwb   ! ocean time-step index
65      !!
66      INTEGER  ::   inum                  ! temporary logical unit
67      INTEGER  ::   ikty, iyear           !
68      REAL(wp) ::   z_fwf, z_fwf_nsrf       ! temporary scalars
69      REAL(wp) ::   zsurf_neg, zsurf_pos, zsurf_tospread
70      REAL(wp), DIMENSION(jpi,jpj) ::   ztmsk_neg, ztmsk_pos, ztmsk_tospread
71      REAL(wp), DIMENSION(jpi,jpj) ::   z_wgt, zerp_cor
72      !!----------------------------------------------------------------------
73      !
74      IF( kt == nit000 ) THEN
75         !
76         IF(lwp) THEN
77            WRITE(numout,*)
78            WRITE(numout,*) 'sbc_fwb : FreshWater Budget correction'
79            WRITE(numout,*) '~~~~~~~'
80            IF( kn_fwb == 1 )   WRITE(numout,*) '          instantaneously set to zero'
81            IF( kn_fwb == 2 )   WRITE(numout,*) '          adjusted from previous year budget'
82            IF( kn_fwb == 3 )   WRITE(numout,*) '          fwf set to zero and spread out over erp area'
83            !
84            IF( kn_fwb == 3 .AND. nn_sssr /= 2 )   &
85               &   CALL ctl_stop( 'The option nn_fwb = 3 must be associated to nn_sssr = 2 ' )
86           
87         ENDIF
88         !
89         e1e2_i(:,:) = e1t(:,:) * e2t(:,:) * tmask_i(:,:)
90         area = SUM( e1e2_i(:,:) )
91         IF( lk_mpp )   CALL  mpp_sum( area    )   ! sum over the global domain
92         !
93      ENDIF
94     
95
96      SELECT CASE ( kn_fwb )
97      !
98      CASE ( 0 )                               
99         WRITE(ctmp1,*)'sbc_fwb : nn_fwb = ', kn_fwb, ' is not yet associated to an option, choose either 1/2'
100         CALL ctl_stop( ctmp1 )
101         !
102         
103      !
104      CASE ( 1 )                               ! global mean fwf set to zero
105         IF( MOD( kt-1, kn_fsbc ) == 0 ) THEN
106            z_fwf = SUM( e1e2_i(:,:) * ( emp(:,:)-rnf(:,:) ) ) / area
107            IF( lk_mpp )   CALL  mpp_sum( z_fwf    )   ! sum over the global domain
108            emp (:,:) = emp (:,:) - z_fwf
109            emps(:,:) = emps(:,:) - z_fwf
110         ENDIF
111         !
112      CASE ( 2 )                               ! fwf budget adjusted from the previous year
113         ! initialisation
114         IF( kt == nit000 ) THEN
115            ! Read the corrective factor on precipitations (fwfold)
116            CALL ctl_opn( inum, 'EMPave_old.dat', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE. )
117            READ ( inum, "(24X,I8,2ES24.16)" ) iyear, a_fwb_b, a_fwb
118            CLOSE( inum )
119            fwfold = a_fwb                  ! current year freshwater budget correction
120            !                               ! estimate from the previous year budget
121            IF(lwp)WRITE(numout,*)
122            IF(lwp)WRITE(numout,*)'sbc_fwb : year = ',iyear  , ' freshwater budget correction = ', fwfold
123            IF(lwp)WRITE(numout,*)'          year = ',iyear-1, ' freshwater budget read       = ', a_fwb
124            IF(lwp)WRITE(numout,*)'          year = ',iyear-2, ' freshwater budget read       = ', a_fwb_b
125         ENDIF   
126         !
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
131            a_fwb   = SUM( e1e2_i(:,:) * sshn(:,:) )
132            IF( lk_mpp )   CALL  mpp_sum( a_fwb    )   ! sum over the global domain
133            a_fwb   = a_fwb * 1.e+3 / ( area * 86400. * 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         ! correct the freshwater fluxes
140         IF( MOD( kt-1, kn_fsbc ) == 0 ) THEN
141            emp (:,:) = emp (:,:) + fwfold
142            emps(:,:) = emps(:,:) + fwfold
143         ENDIF
144         !
145         ! save fwfold value in a file
146         IF( kt == nitend .AND. lwp ) THEN
147            CALL ctl_opn( inum, 'EMPave.dat', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE., narea )
148            WRITE( inum, "(24X,I8,2ES24.16)" ) nyear, a_fwb_b, a_fwb
149            CLOSE( inum )
150         ENDIF
151         !
152      CASE ( 3 )                               ! global fwf set to zero and spread out over erp area
153         !
154         IF( MOD( kt-1, kn_fsbc ) == 0 ) THEN
155            ! Select <0 and >0 area of erp
156            ztmsk_pos(:,:) = tmask_i(:,:)
157            WHERE( erp < 0.e0 ) ztmsk_pos = 0.e0
158            ztmsk_neg(:,:) = tmask_i(:,:) - ztmsk_pos(:,:)
159
160            ! Area filled by <0 and >0 erp
161            zsurf_neg = SUM( e1e2_i(:,:)*ztmsk_neg(:,:) )
162            zsurf_pos = SUM( e1e2_i(:,:)*ztmsk_pos(:,:) )
163       
164            ! fwf global mean
165            z_fwf = SUM( e1e2_i(:,:) * ( emp(:,:)-rnf(:,:) ) ) / area
166            !
167            IF( lk_mpp )   CALL  mpp_sum( z_fwf )
168           
169            IF( z_fwf < 0.e0 ) THEN
170                ! to spread out over >0 erp area to increase evaporation damping process
171                zsurf_tospread = zsurf_pos
172                ztmsk_tospread(:,:) = ztmsk_pos(:,:)
173            ELSE
174                ! to spread out over <0 erp area to increase precipitation damping process
175                zsurf_tospread = zsurf_neg
176                ztmsk_tospread(:,:) = ztmsk_neg(:,:)
177            ENDIF
178
179            ! fwf global mean over <0 or >0 erp area
180            z_fwf_nsrf = SUM( e1e2_i(:,:) * z_fwf ) / ( zsurf_tospread + rsmall )
181            ! weight to respect erp field 2D structure
182            z_wgt(:,:) = ztmsk_tospread(:,:) * erp(:,:) / ( SUM( ztmsk_tospread(:,:) * erp(:,:) * e1e2_i(:,:) ) + rsmall )
183            ! final correction term to apply
184            zerp_cor(:,:) = -1. * z_fwf_nsrf * zsurf_tospread * z_wgt(:,:)
185
186            CALL lbc_lnk( zerp_cor, 'T', 1. )
187
188            emp (:,:) = emp (:,:) + zerp_cor(:,:)
189            emps(:,:) = emps(:,:) + zerp_cor(:,:)
190            erp (:,:) = erp (:,:) + zerp_cor(:,:)
191           
192            IF( nprint == 1 .AND. lwp ) THEN
193               IF( z_fwf < 0.e0 ) THEN
194                  WRITE(numout,*)'       z_fwf < 0'
195                  WRITE(numout,*)'       SUM(erp+)        = ', SUM( ztmsk_tospread(:,:)*erp(:,:)*e1e2_i(:,:) )*1.e-3,' m3.s-1'
196               ELSE
197                   WRITE(numout,*)'      z_fwf >= 0'
198                   WRITE(numout,*)'      SUM(erp-)        = ', SUM( ztmsk_tospread(:,:)*erp(:,:)*e1e2_i(:,:) )*1.e-3,' m3.s-1'
199               ENDIF
200               WRITE(numout,*)'      SUM(empG)        = ', SUM( z_fwf*e1e2_i(:,:) )*1.e-3,' m3.s-1'
201               WRITE(numout,*)'      z_fwf            = ', z_fwf      ,' mm.s-1'
202               WRITE(numout,*)'      z_fwf_nsrf       = ', z_fwf_nsrf ,' mm.s-1'
203               WRITE(numout,*)'      MIN(zerp_cor)    = ', MINVAL(zerp_cor) 
204               WRITE(numout,*)'      MAX(zerp_cor)    = ', MAXVAL(zerp_cor) 
205            ENDIF
206            !
207         ENDIF
208         !
209      CASE DEFAULT    ! you should never be there
210         WRITE(ctmp1,*)'sbc_fwb : nn_fwb = ', kn_fwb, ' is not permitted for the FreshWater Budget correction, choose either 1/2'
211         CALL ctl_stop( ctmp1 )
212         !
213      END SELECT
214      !
215   END SUBROUTINE sbc_fwb
216
217   !!======================================================================
218END MODULE sbcfwb