source: branches/UKMO/r6232_collate_bgc_diagnostics/NEMOGCM/NEMO/OPA_SRC/SBC/sbcflx.F90 @ 11134

Last change on this file since 11134 was 11134, checked in by jcastill, 18 months ago

Full set of changes as in the original branch

File size: 13.8 KB
Line 
1MODULE sbcflx
2   !!======================================================================
3   !!                       ***  MODULE  sbcflx  ***
4   !! Ocean forcing:  momentum, heat and freshwater flux formulation
5   !!=====================================================================
6   !! History :  1.0  !  2006-06  (G. Madec)  Original code
7   !!            3.3  !  2010-10  (S. Masson)  add diurnal cycle
8   !!----------------------------------------------------------------------
9
10   !!----------------------------------------------------------------------
11   !!   namflx   : flux formulation namlist
12   !!   sbc_flx  : flux formulation as ocean surface boundary condition (forced mode, fluxes read in NetCDF files)
13   !!----------------------------------------------------------------------
14   USE oce             ! ocean dynamics and tracers
15   USE dom_oce         ! ocean space and time domain
16   USE sbc_oce         ! surface boundary condition: ocean fields
17   USE sbcdcy          ! surface boundary condition: diurnal cycle on qsr
18   USE phycst          ! physical constants
19   USE fldread         ! read input fields
20   USE iom             ! IOM library
21   USE in_out_manager  ! I/O manager
22   USE lib_mpp         ! distribued memory computing library
23   USE lbclnk          ! ocean lateral boundary conditions (or mpp link)
24   USE wrk_nemo        ! work arrays
25
26   IMPLICIT NONE
27   PRIVATE
28
29   PUBLIC sbc_flx       ! routine called by step.F90
30
31   INTEGER , PARAMETER ::   jpfld   = 6   ! maximum number of files to read
32   INTEGER , PARAMETER ::   jp_utau = 1   ! index of wind stress (i-component) file
33   INTEGER , PARAMETER ::   jp_vtau = 2   ! index of wind stress (j-component) file
34   INTEGER , PARAMETER ::   jp_qtot = 3   ! index of total (non solar+solar) heat file
35   INTEGER , PARAMETER ::   jp_qsr  = 4   ! index of solar heat file
36   INTEGER , PARAMETER ::   jp_emp  = 5   ! index of evaporation-precipation file
37   INTEGER , PARAMETER ::   jp_press = 6  ! index of pressure for UKMO shelf fluxes
38   TYPE(FLD), ALLOCATABLE, DIMENSION(:) ::   sf    ! structure of input fields (file informations, fields read)
39   LOGICAL , PUBLIC    ::   ln_shelf_flx = .FALSE. ! UKMO SHELF specific flux flag
40   LOGICAL , PUBLIC    ::   ln_rel_wind = .FALSE.  ! UKMO SHELF specific flux flag - relative winds
41   REAL(wp)            ::   rn_wfac                ! multiplication factor for ice/ocean velocity in the calculation of wind stress (clem)
42   INTEGER             ::   jpfld_local   ! maximum number of files to read (locally modified depending on ln_shelf_flx)
43
44   !! * Substitutions
45#  include "domzgr_substitute.h90"
46#  include "vectopt_loop_substitute.h90"
47   !!----------------------------------------------------------------------
48   !! NEMO/OPA 3.3 , NEMO-consortium (2010)
49   !! $Id$
50   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
51   !!----------------------------------------------------------------------
52CONTAINS
53
54   SUBROUTINE sbc_flx( kt )
55      !!---------------------------------------------------------------------
56      !!                    ***  ROUTINE sbc_flx  ***
57      !!                   
58      !! ** Purpose :   provide at each time step the surface ocean fluxes
59      !!                (momentum, heat, freshwater and runoff)
60      !!
61      !! ** Method  : - READ each fluxes in NetCDF files:
62      !!                   i-component of the stress              utau  (N/m2)
63      !!                   j-component of the stress              vtau  (N/m2)
64      !!                   net downward heat flux                 qtot  (watt/m2)
65      !!                   net downward radiative flux            qsr   (watt/m2)
66      !!                   net upward freshwater (evapo - precip) emp   (kg/m2/s)
67      !!
68      !!      CAUTION :  - never mask the surface stress fields
69      !!                 - the stress is assumed to be in the (i,j) mesh referential
70      !!
71      !! ** Action  :   update at each time-step
72      !!              - utau, vtau  i- and j-component of the wind stress
73      !!              - taum        wind stress module at T-point
74      !!              - wndm        10m wind module at T-point
75      !!              - qns         non solar heat flux including heat flux due to emp
76      !!              - qsr         solar heat flux
77      !!              - emp         upward mass flux (evap. - precip.)
78      !!              - sfx         salt flux; set to zero at nit000 but possibly non-zero
79      !!                            if ice is present (computed in limsbc(_2).F90)
80      !!----------------------------------------------------------------------
81      INTEGER, INTENT(in) ::   kt   ! ocean time step
82      !!
83      INTEGER  ::   ji, jj, jf            ! dummy indices
84      INTEGER  ::   ierror                ! return error code
85      INTEGER  ::   ios                   ! Local integer output status for namelist read
86      REAL(wp) ::   zfact                 ! temporary scalar
87      REAL(wp) ::   zrhoa  = 1.22         ! Air density kg/m3
88      REAL(wp) ::   zcdrag = 1.5e-3       ! drag coefficient
89      REAL(wp) ::   ztx, zty, zmod, zcoef ! temporary variables
90      REAL     ::   cs                    ! UKMO SHELF: Friction co-efficient at surface
91      REAL     ::   totwindspd            ! UKMO SHELF: Magnitude of wind speed vector
92      REAL(wp), DIMENSION(:,:), POINTER ::   zwnd_i, zwnd_j    ! wind speed components at T-point
93
94      REAL(wp) ::   rhoa  = 1.22         ! Air density kg/m3
95      REAL(wp) ::   cdrag = 1.5e-3       ! drag coefficient
96      !!
97      CHARACTER(len=100) ::  cn_dir                               ! Root directory for location of flx files
98      TYPE(FLD_N), DIMENSION(jpfld) ::   slf_i                    ! array of namelist information structures
99      TYPE(FLD_N) ::   sn_utau, sn_vtau, sn_qtot, sn_qsr, sn_emp, sn_press  !  informations about the fields to be read
100      LOGICAL     ::   ln_foam_flx  = .FALSE.                     ! UKMO FOAM specific flux flag
101      NAMELIST/namsbc_flx/ cn_dir, sn_utau, sn_vtau, sn_qtot, sn_qsr, sn_emp,   & 
102      &                    ln_foam_flx, sn_press, ln_shelf_flx, ln_rel_wind,    &
103      &                    rn_wfac
104      !!---------------------------------------------------------------------
105      !
106      IF( kt == nit000 ) THEN                ! First call kt=nit000 
107         ! set file information
108         REWIND( numnam_ref )              ! Namelist namsbc_flx in reference namelist : Files for fluxes
109         READ  ( numnam_ref, namsbc_flx, IOSTAT = ios, ERR = 901)
110901      IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc_flx in reference namelist', lwp )
111
112         REWIND( numnam_cfg )              ! Namelist namsbc_flx in configuration namelist : Files for fluxes
113         READ  ( numnam_cfg, namsbc_flx, IOSTAT = ios, ERR = 902 )
114902      IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc_flx in configuration namelist', lwp )
115         IF(lwm) WRITE ( numond, namsbc_flx ) 
116         !
117         !                                         ! check: do we plan to use ln_dm2dc with non-daily forcing?
118         IF( ln_dm2dc .AND. sn_qsr%nfreqh /= 24 )   &
119            &   CALL ctl_stop( 'sbc_blk_core: ln_dm2dc can be activated only with daily short-wave forcing' ) 
120         !
121         !                                         ! store namelist information in an array
122         slf_i(jp_utau) = sn_utau   ;   slf_i(jp_vtau) = sn_vtau
123         slf_i(jp_qtot) = sn_qtot   ;   slf_i(jp_qsr ) = sn_qsr 
124         slf_i(jp_emp ) = sn_emp
125         !
126            ALLOCATE( sf(jpfld), STAT=ierror )        ! set sf structure
127            IF( ln_shelf_flx ) slf_i(jp_press) = sn_press
128   
129            ! define local jpfld depending on shelf_flx logical
130            IF( ln_shelf_flx ) THEN
131               jpfld_local = jpfld
132            ELSE
133               jpfld_local = jpfld-1
134            ENDIF
135            !
136         IF( ierror > 0 ) THEN   
137            CALL ctl_stop( 'sbc_flx: unable to allocate sf structure' )   ;   RETURN 
138         ENDIF
139         DO ji= 1, jpfld_local
140            ALLOCATE( sf(ji)%fnow(jpi,jpj,1) )
141            IF( slf_i(ji)%ln_tint ) ALLOCATE( sf(ji)%fdta(jpi,jpj,1,2) )
142         END DO
143         !                                         ! fill sf with slf_i and control print
144         CALL fld_fill( sf, slf_i, cn_dir, 'sbc_flx', 'flux formulation for ocean surface boundary condition', 'namsbc_flx' )
145         !
146         sfx(:,:) = 0.0_wp                         ! salt flux due to freezing/melting (non-zero only if ice is present; set in limsbc(_2).F90)
147         !
148      ENDIF
149
150      CALL fld_read( kt, nn_fsbc, sf )                            ! input fields provided at the current time-step
151     
152      IF( MOD( kt-1, nn_fsbc ) == 0 ) THEN                        ! update ocean fluxes at each SBC frequency
153
154         !!UKMO SHELF wind speed relative to surface currents - put here to allow merging with coupling branch
155         IF( ln_shelf_flx ) THEN
156            CALL wrk_alloc( jpi,jpj, zwnd_i, zwnd_j )
157
158            IF( ln_rel_wind ) THEN
159               DO jj = 1, jpj
160                  DO ji = 1, jpi
161                     zwnd_i(ji,jj) = sf(jp_utau)%fnow(ji,jj,1) - rn_wfac * ssu_m(ji,jj)
162                     zwnd_j(ji,jj) = sf(jp_vtau)%fnow(ji,jj,1) - rn_wfac * ssv_m(ji,jj)
163                  END DO
164               END DO
165            ELSE
166               zwnd_i(:,:) = sf(jp_utau)%fnow(:,:,1)
167               zwnd_j(:,:) = sf(jp_vtau)%fnow(:,:,1)
168            ENDIF
169         ENDIF
170
171         IF( ln_dm2dc ) THEN   ;   qsr(:,:) = sbc_dcy( sf(jp_qsr)%fnow(:,:,1) )   ! modify now Qsr to include the diurnal cycle
172         ELSE                  ;   qsr(:,:) =          sf(jp_qsr)%fnow(:,:,1)
173         ENDIF
174!CDIR COLLAPSE
175            !!UKMO SHELF effect of atmospheric pressure on SSH
176            ! If using ln_apr_dyn, this is done there so don't repeat here.
177            IF( ln_shelf_flx .AND. .NOT. ln_apr_dyn) THEN
178               DO jj = 1, jpjm1
179                  DO ji = 1, jpim1
180                     apgu(ji,jj) = (-1.0/rau0)*(sf(jp_press)%fnow(ji+1,jj,1)-sf(jp_press)%fnow(ji,jj,1))/e1u(ji,jj)
181                     apgv(ji,jj) = (-1.0/rau0)*(sf(jp_press)%fnow(ji,jj+1,1)-sf(jp_press)%fnow(ji,jj,1))/e2v(ji,jj)
182                  END DO
183               END DO
184            ENDIF ! ln_shelf_flx
185
186         DO jj = 1, jpj                                           ! set the ocean fluxes from read fields
187            DO ji = 1, jpi
188                   IF( ln_shelf_flx ) THEN
189                      !! UKMO SHELF - need atmospheric pressure to calculate Haney forcing
190                      pressnow(ji,jj) = sf(jp_press)%fnow(ji,jj,1)
191                      !! UKMO SHELF flux files contain wind speed not wind stress
192                      totwindspd = sqrt(zwnd_i(ji,jj)*zwnd_i(ji,jj) + zwnd_j(ji,jj)*zwnd_j(ji,jj))
193                      cs = 0.63 + (0.066 * totwindspd)
194                      utau(ji,jj) = cs * (rhoa/rau0) * zwnd_i(ji,jj) * totwindspd
195                      vtau(ji,jj) = cs * (rhoa/rau0) * zwnd_j(ji,jj) * totwindspd
196                   ELSE
197                      utau(ji,jj) = sf(jp_utau)%fnow(ji,jj,1)
198                      vtau(ji,jj) = sf(jp_vtau)%fnow(ji,jj,1)
199                   ENDIF
200                   qsr (ji,jj) = sf(jp_qsr )%fnow(ji,jj,1)
201                   IF( ln_foam_flx .OR. ln_shelf_flx ) THEN
202                      !! UKMO FOAM flux files contain non-solar heat flux (qns) rather than total heat flux (qtot)
203                      qns (ji,jj) = sf(jp_qtot)%fnow(ji,jj,1)
204                      !! UKMO FOAM flux files contain the net DOWNWARD freshwater flux P-E rather then E-P
205                      emp (ji,jj) = -1. * sf(jp_emp )%fnow(ji,jj,1)
206                   ELSE
207                      qns (ji,jj) = sf(jp_qtot)%fnow(ji,jj,1) - sf(jp_qsr)%fnow(ji,jj,1)
208                      emp (ji,jj) = sf(jp_emp )%fnow(ji,jj,1)
209                   ENDIF
210            END DO
211         END DO
212         !                                                        ! add to qns the heat due to e-p
213         qns(:,:) = qns(:,:) - emp(:,:) * sst_m(:,:) * rcp        ! mass flux is at SST
214         !
215   
216            !! UKMO FOAM wind fluxes need lbc_lnk calls owing to a bug in interp.exe
217            IF( ln_foam_flx ) THEN
218               CALL lbc_lnk( utau(:,:), 'U', -1. )
219               CALL lbc_lnk( vtau(:,:), 'V', -1. )
220            ENDIF
221   
222         !                                                        ! module of wind stress and wind speed at T-point
223         zcoef = 1. / ( zrhoa * zcdrag )
224!CDIR NOVERRCHK
225         DO jj = 2, jpjm1
226!CDIR NOVERRCHK
227            DO ji = fs_2, fs_jpim1   ! vect. opt.
228               ztx = utau(ji-1,jj  ) + utau(ji,jj) 
229               zty = vtau(ji  ,jj-1) + vtau(ji,jj) 
230               zmod = 0.5 * SQRT( ztx * ztx + zty * zty )
231               taum(ji,jj) = zmod
232               wndm(ji,jj) = SQRT( zmod * zcoef )
233            END DO
234         END DO
235         taum(:,:) = taum(:,:) * tmask(:,:,1) ; wndm(:,:) = wndm(:,:) * tmask(:,:,1)
236         CALL lbc_lnk( taum(:,:), 'T', 1. )   ;   CALL lbc_lnk( wndm(:,:), 'T', 1. )
237
238         IF( nitend-nit000 <= 100 .AND. lwp ) THEN                ! control print (if less than 100 time-step asked)
239            WRITE(numout,*) 
240            WRITE(numout,*) '        read daily momentum, heat and freshwater fluxes OK'
241            DO jf = 1, jpfld_local
242               IF( jf == jp_utau .OR. jf == jp_vtau )   zfact =     1.
243               IF( jf == jp_qtot .OR. jf == jp_qsr  )   zfact =     0.1
244               IF( jf == jp_emp                     )   zfact = 86400.
245               WRITE(numout,*) 
246               WRITE(numout,*) ' day: ', ndastp , TRIM(sf(jf)%clvar), ' * ', zfact
247               CALL prihre( sf(jf)%fnow, jpi, jpj, 1, jpi, 20, 1, jpj, 10, zfact, numout )
248            END DO
249            CALL FLUSH(numout)
250         ENDIF
251         !
252         IF( ln_shelf_flx ) THEN
253            CALL wrk_dealloc( jpi,jpj, zwnd_i, zwnd_j )
254         ENDIF
255         !
256      ENDIF
257      !
258   END SUBROUTINE sbc_flx
259
260   !!======================================================================
261END MODULE sbcflx
Note: See TracBrowser for help on using the repository browser.