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/test_moci_test_suite_namelist_read/NEMOGCM/NEMO/OPA_SRC/SBC – NEMO

source: branches/UKMO/test_moci_test_suite_namelist_read/NEMOGCM/NEMO/OPA_SRC/SBC/sbcwave.F90 @ 9366

Last change on this file since 9366 was 9366, checked in by andmirek, 6 years ago

#2050 first version. Compiled OK in moci test suite

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