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.
sbcwave.F90 in branches/UKMO/dev_r5518_GO6_under_ice_relax_dr_hook/NEMOGCM/NEMO/OPA_SRC/SBC – NEMO

source: branches/UKMO/dev_r5518_GO6_under_ice_relax_dr_hook/NEMOGCM/NEMO/OPA_SRC/SBC/sbcwave.F90 @ 11738

Last change on this file since 11738 was 11738, checked in by marc, 5 years ago

The Dr Hook changes from my perl code.
File size: 10.5 KB
Line 
1MODULE sbcwave
2   !!======================================================================
3   !!                       ***  MODULE  sbcwave  ***
4   !! Wave module
5   !!======================================================================
6   !! History :  3.3.1  !   2011-09  (Adani M)  Original code: Drag Coefficient
7   !!         :  3.4    !   2012-10  (Adani M)                 Stokes Drift
8   !!----------------------------------------------------------------------
9   USE iom             ! I/O manager library
10   USE in_out_manager  ! I/O manager
11   USE lib_mpp         ! distribued memory computing library
12   USE fldread        ! read input fields
13   USE oce
14   USE sbc_oce        ! Surface boundary condition: ocean fields
15   USE domvvl
16
17   
18   !!----------------------------------------------------------------------
19   !!   sbc_wave       : read drag coefficient from wave model in netcdf files
20   !!----------------------------------------------------------------------
21
22   USE yomhook, ONLY: lhook, dr_hook
23   USE parkind1, ONLY: jprb, jpim
24
25   IMPLICIT NONE
26   PRIVATE
27
28   PUBLIC   sbc_wave    ! routine called in sbc_blk_core or sbc_blk_mfs
29   
30   INTEGER , PARAMETER ::   jpfld  = 3           ! maximum number of files to read for srokes drift
31   INTEGER , PARAMETER ::   jp_usd = 1           ! index of stokes drift  (i-component) (m/s)    at T-point
32   INTEGER , PARAMETER ::   jp_vsd = 2           ! index of stokes drift  (j-component) (m/s)    at T-point
33   INTEGER , PARAMETER ::   jp_wn  = 3           ! index of wave number                 (1/m)    at T-point
34   TYPE(FLD), ALLOCATABLE, DIMENSION(:)  :: sf_cd    ! structure of input fields (file informations, fields read) Drag Coefficient
35   TYPE(FLD), ALLOCATABLE, DIMENSION(:)  :: sf_sd    ! structure of input fields (file informations, fields read) Stokes Drift
36   REAL(wp),PUBLIC,ALLOCATABLE,DIMENSION (:,:)       :: cdn_wave 
37   REAL(wp),ALLOCATABLE,DIMENSION (:,:)              :: usd2d,vsd2d,uwavenum,vwavenum 
38   REAL(wp),PUBLIC,ALLOCATABLE,DIMENSION (:,:,:)     :: usd3d,vsd3d,wsd3d 
39
40   !! * Substitutions
41#  include "domzgr_substitute.h90"
42   !!----------------------------------------------------------------------
43   !! NEMO/OPA 4.0 , NEMO Consortium (2011)
44   !! $Id$
45   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
46   !!----------------------------------------------------------------------
47CONTAINS
48
49   SUBROUTINE sbc_wave( kt )
50      !!---------------------------------------------------------------------
51      !!                     ***  ROUTINE sbc_apr  ***
52      !!
53      !! ** Purpose :   read drag coefficient from wave model  in netcdf files.
54      !!
55      !! ** Method  : - Read namelist namsbc_wave
56      !!              - Read Cd_n10 fields in netcdf files
57      !!              - Read stokes drift 2d in netcdf files
58      !!              - Read wave number      in netcdf files
59      !!              - Compute 3d stokes drift using monochromatic
60      !! ** action  :   
61      !!               
62      !!---------------------------------------------------------------------
63      USE oce,  ONLY : un,vn,hdivn,rotn
64      USE divcur
65      USE wrk_nemo
66#if defined key_bdy
67      USE bdy_oce, ONLY : bdytmask
68#endif
69      INTEGER, INTENT( in  ) ::  kt       ! ocean time step
70      INTEGER                ::  ierror   ! return error code
71      INTEGER                ::  ifpr, jj,ji,jk 
72      INTEGER                ::   ios     ! Local integer output status for namelist read
73      REAL(wp),DIMENSION(:,:,:),POINTER             ::  udummy,vdummy,hdivdummy,rotdummy
74      REAL                                          ::  z2dt,z1_2dt
75      TYPE(FLD_N), DIMENSION(jpfld) ::   slf_i     ! array of namelist informations on the fields to read
76      CHARACTER(len=100)     ::  cn_dir                          ! Root directory for location of drag coefficient files
77      TYPE(FLD_N)            ::  sn_cdg, sn_usd, sn_vsd, sn_wn   ! informations about the fields to be read
78      !!---------------------------------------------------------------------
79      NAMELIST/namsbc_wave/  sn_cdg, cn_dir, sn_usd, sn_vsd, sn_wn
80      INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
81      INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
82      REAL(KIND=jprb)               :: zhook_handle
83
84      CHARACTER(LEN=*), PARAMETER :: RoutineName='SBC_WAVE'
85
86      IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
87
88      !!---------------------------------------------------------------------
89
90      !!----------------------------------------------------------------------
91      !
92      !
93      !                                         ! -------------------- !
94      IF( kt == nit000 ) THEN                   ! First call kt=nit000 !
95         !                                      ! -------------------- !
96         REWIND( numnam_ref )              ! Namelist namsbc_wave in reference namelist : File for drag coeff. from wave model
97         READ  ( numnam_ref, namsbc_wave, IOSTAT = ios, ERR = 901)
98901      IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc_wave in reference namelist', lwp )
99
100         REWIND( numnam_cfg )              ! Namelist namsbc_wave in configuration namelist : File for drag coeff. from wave model
101         READ  ( numnam_cfg, namsbc_wave, IOSTAT = ios, ERR = 902 )
102902      IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc_wave in configuration namelist', lwp )
103         IF(lwm) WRITE ( numond, namsbc_wave )
104         !
105
106         IF ( ln_cdgw ) THEN
107            ALLOCATE( sf_cd(1), STAT=ierror )           !* allocate and fill sf_wave with sn_cdg
108            IF( ierror > 0 )   CALL ctl_stop( 'STOP', 'sbc_wave: unable to allocate sf_wave structure' )
109            !
110                                   ALLOCATE( sf_cd(1)%fnow(jpi,jpj,1)   )
111            IF( sn_cdg%ln_tint )   ALLOCATE( sf_cd(1)%fdta(jpi,jpj,1,2) )
112            CALL fld_fill( sf_cd, (/ sn_cdg /), cn_dir, 'sbc_wave', 'Wave module ', 'namsbc_wave' )
113            ALLOCATE( cdn_wave(jpi,jpj) )
114            cdn_wave(:,:) = 0.0
115        ENDIF
116         IF ( ln_sdw ) THEN
117            slf_i(jp_usd) = sn_usd ; slf_i(jp_vsd) = sn_vsd; slf_i(jp_wn) = sn_wn
118            ALLOCATE( sf_sd(3), STAT=ierror )           !* allocate and fill sf_wave with sn_cdg
119            IF( ierror > 0 )   CALL ctl_stop( 'STOP', 'sbc_wave: unable to allocate sf_wave structure' )
120            !
121            DO ifpr= 1, jpfld
122               ALLOCATE( sf_sd(ifpr)%fnow(jpi,jpj,1) )
123               IF( slf_i(ifpr)%ln_tint )   ALLOCATE( sf_sd(ifpr)%fdta(jpi,jpj,1,2) )
124            END DO
125            CALL fld_fill( sf_sd, slf_i, cn_dir, 'sbc_wave', 'Wave module ', 'namsbc_wave' )
126            ALLOCATE( usd2d(jpi,jpj),vsd2d(jpi,jpj),uwavenum(jpi,jpj),vwavenum(jpi,jpj) )
127            ALLOCATE( usd3d(jpi,jpj,jpk),vsd3d(jpi,jpj,jpk),wsd3d(jpi,jpj,jpk) )
128            usd2d(:,:) = 0.0 ;  vsd2d(:,:) = 0.0 ; uwavenum(:,:) = 0.0 ; vwavenum(:,:) = 0.0
129            usd3d(:,:,:) = 0.0 ;vsd3d(:,:,:) = 0.0 ; wsd3d(:,:,:) = 0.0
130         ENDIF
131      ENDIF
132         !
133         !
134      IF ( ln_cdgw ) THEN
135         CALL fld_read( kt, nn_fsbc, sf_cd )      !* read drag coefficient from external forcing
136         cdn_wave(:,:) = sf_cd(1)%fnow(:,:,1)
137      ENDIF
138      IF ( ln_sdw )  THEN
139          CALL fld_read( kt, nn_fsbc, sf_sd )      !* read drag coefficient from external forcing
140
141         ! Interpolate wavenumber, stokes drift into the grid_V and grid_V
142         !-------------------------------------------------
143
144         DO jj = 1, jpjm1
145            DO ji = 1, jpim1
146               uwavenum(ji,jj)=0.5 * ( 2. - umask(ji,jj,1) ) * ( sf_sd(3)%fnow(ji,jj,1) * tmask(ji,jj,1) &
147               &                                + sf_sd(3)%fnow(ji+1,jj,1) * tmask(ji+1,jj,1) )
148
149               vwavenum(ji,jj)=0.5 * ( 2. - vmask(ji,jj,1) ) * ( sf_sd(3)%fnow(ji,jj,1) * tmask(ji,jj,1) &
150               &                                + sf_sd(3)%fnow(ji,jj+1,1) * tmask(ji,jj+1,1) )
151
152               usd2d(ji,jj) = 0.5 * ( 2. - umask(ji,jj,1) ) * ( sf_sd(1)%fnow(ji,jj,1) * tmask(ji,jj,1) &
153               &                                + sf_sd(1)%fnow(ji+1,jj,1) * tmask(ji+1,jj,1) )
154
155               vsd2d(ji,jj) = 0.5 * ( 2. - vmask(ji,jj,1) ) * ( sf_sd(2)%fnow(ji,jj,1) * tmask(ji,jj,1) &
156               &                                + sf_sd(2)%fnow(ji,jj+1,1) * tmask(ji,jj+1,1) )
157            END DO
158         END DO
159
160          !Computation of the 3d Stokes Drift
161          DO jk = 1, jpk
162             DO jj = 1, jpj-1
163                DO ji = 1, jpi-1
164                   usd3d(ji,jj,jk) = usd2d(ji,jj)*exp(2.0*uwavenum(ji,jj)*(-MIN( gdept_0(ji,jj,jk) , gdept_0(ji+1,jj  ,jk))))
165                   vsd3d(ji,jj,jk) = vsd2d(ji,jj)*exp(2.0*vwavenum(ji,jj)*(-MIN( gdept_0(ji,jj,jk) , gdept_0(ji  ,jj+1,jk))))
166                END DO
167             END DO
168             usd3d(jpi,:,jk) = usd2d(jpi,:)*exp( 2.0*uwavenum(jpi,:)*(-gdept_0(jpi,:,jk)) )
169             vsd3d(:,jpj,jk) = vsd2d(:,jpj)*exp( 2.0*vwavenum(:,jpj)*(-gdept_0(:,jpj,jk)) )
170          END DO
171
172          CALL wrk_alloc( jpi,jpj,jpk,udummy,vdummy,hdivdummy,rotdummy)
173         
174          udummy(:,:,:)=un(:,:,:)
175          vdummy(:,:,:)=vn(:,:,:)
176          hdivdummy(:,:,:)=hdivn(:,:,:)
177          rotdummy(:,:,:)=rotn(:,:,:)
178          un(:,:,:)=usd3d(:,:,:)
179          vn(:,:,:)=vsd3d(:,:,:)
180          CALL div_cur(kt)
181      !                                           !------------------------------!
182      !                                           !     Now Vertical Velocity    !
183      !                                           !------------------------------!
184          z2dt = 2._wp * rdt                              ! set time step size (Euler/Leapfrog)
185
186          z1_2dt = 1.e0 / z2dt
187          DO jk = jpkm1, 1, -1                             ! integrate from the bottom the hor. divergence
188             ! - ML - need 3 lines here because replacement of fse3t by its expression yields too long lines otherwise
189             wsd3d(:,:,jk) = wsd3d(:,:,jk+1) -   fse3t_n(:,:,jk) * hdivn(:,:,jk)        &
190                &                      - ( fse3t_a(:,:,jk) - fse3t_b(:,:,jk) )    &
191                &                         * tmask(:,:,jk) * z1_2dt
192#if defined key_bdy
193             wsd3d(:,:,jk) = wsd3d(:,:,jk) * bdytmask(:,:)
194#endif
195          END DO
196          hdivn(:,:,:)=hdivdummy(:,:,:)
197          rotn(:,:,:)=rotdummy(:,:,:)
198          vn(:,:,:)=vdummy(:,:,:)
199          un(:,:,:)=udummy(:,:,:)
200          CALL wrk_dealloc( jpi,jpj,jpk,udummy,vdummy,hdivdummy,rotdummy)
201      ENDIF
202      IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
203   END SUBROUTINE sbc_wave
204     
205   !!======================================================================
206END MODULE sbcwave
Note: See TracBrowser for help on using the repository browser.