MODULE sbcwave !!====================================================================== !! *** MODULE sbcwave *** !! Wave module !!====================================================================== !! History : 3.3 ! 2011-09 (Adani M) Original code: Drag Coefficient !! : 3.4 ! 2012-10 (Adani M) Stokes Drift !!---------------------------------------------------------------------- !!---------------------------------------------------------------------- !! sbc_wave : read drag coefficient from wave model in netcdf files !!---------------------------------------------------------------------- USE oce ! USE sbc_oce ! Surface boundary condition: ocean fields USE bdy_oce ! USE domvvl ! ! USE iom ! I/O manager library USE in_out_manager ! I/O manager USE lib_mpp ! distribued memory computing library USE fldread ! read input fields USE wrk_nemo ! IMPLICIT NONE PRIVATE PUBLIC sbc_wave ! routine called in sbc_blk_core or sbc_blk_mfs INTEGER , PARAMETER :: jpfld = 3 ! maximum number of files to read for srokes drift INTEGER , PARAMETER :: jp_usd = 1 ! index of stokes drift (i-component) (m/s) at T-point INTEGER , PARAMETER :: jp_vsd = 2 ! index of stokes drift (j-component) (m/s) at T-point INTEGER , PARAMETER :: jp_wn = 3 ! index of wave number (1/m) at T-point TYPE(FLD), ALLOCATABLE, DIMENSION(:) :: sf_cd ! structure of input fields (file informations, fields read) Drag Coefficient TYPE(FLD), ALLOCATABLE, DIMENSION(:) :: sf_sd ! structure of input fields (file informations, fields read) Stokes Drift REAL(wp), PUBLIC, ALLOCATABLE, DIMENSION (:,:) :: cdn_wave REAL(wp), PUBLIC, ALLOCATABLE, DIMENSION (:,:,:) :: usd3d, vsd3d, wsd3d REAL(wp), ALLOCATABLE, DIMENSION (:,:) :: usd2d, vsd2d, uwavenum, vwavenum !! * Substitutions # include "domzgr_substitute.h90" # include "vectopt_loop_substitute.h90" !!---------------------------------------------------------------------- !! NEMO/OPA 3.7 , NEMO Consortium (2014) !! $Id$ !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) !!---------------------------------------------------------------------- CONTAINS SUBROUTINE sbc_wave( kt ) !!--------------------------------------------------------------------- !! *** ROUTINE sbc_apr *** !! !! ** Purpose : read drag coefficient from wave model in netcdf files. !! !! ** Method : - Read namelist namsbc_wave !! - Read Cd_n10 fields in netcdf files !! - Read stokes drift 2d in netcdf files !! - Read wave number in netcdf files !! - Compute 3d stokes drift using monochromatic !! ** action : !!--------------------------------------------------------------------- INTEGER, INTENT( in ) :: kt ! ocean time step ! INTEGER :: ierror ! return error code INTEGER :: ifpr, jj,ji,jk INTEGER :: ios ! Local integer output status for namelist read TYPE(FLD_N), DIMENSION(jpfld) :: slf_i ! array of namelist informations on the fields to read CHARACTER(len=100) :: cn_dir ! Root directory for location of drag coefficient files TYPE(FLD_N) :: sn_cdg, sn_usd, sn_vsd, sn_wn ! informations about the fields to be read REAL(wp), DIMENSION(:,:,:), POINTER :: zusd_t, zvsd_t, ze3hdiv ! 3D workspace !! NAMELIST/namsbc_wave/ sn_cdg, cn_dir, sn_usd, sn_vsd, sn_wn !!--------------------------------------------------------------------- ! ! ! -------------------- ! IF( kt == nit000 ) THEN ! First call kt=nit000 ! ! ! -------------------- ! REWIND( numnam_ref ) ! Namelist namsbc_wave in reference namelist : File for drag coeff. from wave model READ ( numnam_ref, namsbc_wave, IOSTAT = ios, ERR = 901) 901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc_wave in reference namelist', lwp ) REWIND( numnam_cfg ) ! Namelist namsbc_wave in configuration namelist : File for drag coeff. from wave model READ ( numnam_cfg, namsbc_wave, IOSTAT = ios, ERR = 902 ) 902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc_wave in configuration namelist', lwp ) IF(lwm) WRITE ( numond, namsbc_wave ) ! IF ( ln_cdgw ) THEN ALLOCATE( sf_cd(1), STAT=ierror ) !* allocate and fill sf_wave with sn_cdg IF( ierror > 0 ) CALL ctl_stop( 'STOP', 'sbc_wave: unable to allocate sf_wave structure' ) ! ALLOCATE( sf_cd(1)%fnow(jpi,jpj,1) ) IF( sn_cdg%ln_tint ) ALLOCATE( sf_cd(1)%fdta(jpi,jpj,1,2) ) CALL fld_fill( sf_cd, (/ sn_cdg /), cn_dir, 'sbc_wave', 'Wave module ', 'namsbc_wave' ) ALLOCATE( cdn_wave(jpi,jpj) ) cdn_wave(:,:) = 0.0 ENDIF IF ( ln_sdw ) THEN slf_i(jp_usd) = sn_usd ; slf_i(jp_vsd) = sn_vsd; slf_i(jp_wn) = sn_wn ALLOCATE( sf_sd(3), STAT=ierror ) !* allocate and fill sf_wave with sn_cdg IF( ierror > 0 ) CALL ctl_stop( 'STOP', 'sbc_wave: unable to allocate sf_wave structure' ) ! DO ifpr= 1, jpfld ALLOCATE( sf_sd(ifpr)%fnow(jpi,jpj,1) ) IF( slf_i(ifpr)%ln_tint ) ALLOCATE( sf_sd(ifpr)%fdta(jpi,jpj,1,2) ) END DO CALL fld_fill( sf_sd, slf_i, cn_dir, 'sbc_wave', 'Wave module ', 'namsbc_wave' ) ALLOCATE( usd2d(jpi,jpj) , vsd2d(jpi,jpj) , uwavenum(jpi,jpj) , vwavenum(jpi,jpj) ) ALLOCATE( usd3d(jpi,jpj,jpk),vsd3d(jpi,jpj,jpk),wsd3d(jpi,jpj,jpk) ) usd3d(:,:,:) = 0._wp ; usd2d(:,:) = 0._wp ; uwavenum(:,:) = 0._wp vsd3d(:,:,:) = 0._wp ; vsd2d(:,:) = 0._wp ; vwavenum(:,:) = 0._wp wsd3d(:,:,:) = 0._wp ENDIF ENDIF ! IF ( ln_cdgw ) THEN !== Neutral drag coefficient ==! CALL fld_read( kt, nn_fsbc, sf_cd ) ! read from external forcing cdn_wave(:,:) = sf_cd(1)%fnow(:,:,1) ENDIF ! IF ( ln_sdw ) THEN !== Computation of the 3d Stokes Drift ==! ! CALL fld_read( kt, nn_fsbc, sf_sd ) !* read drag coefficient from external forcing ! ! CALL wrk_alloc( jpi,jpj,jpk, zusd_t, zvsd_t, ze3hdiv ) ! !* distribute it on the vertical DO jk = 1, jpkm1 zusd_t(:,:,jk) = sf_sd(jp_usd)%fnow(:,:,1) * EXP( -2._wp * sf_sd(jp_wn)%fnow(:,:,1) * fsdept_n(:,:,jk) ) zvsd_t(:,:,jk) = sf_sd(jp_vsd)%fnow(:,:,1) * EXP( -2._wp * sf_sd(jp_wn)%fnow(:,:,1) * fsdept_n(:,:,jk) ) END DO ! !* interpolate the stokes drift from t-point to u- and v-points DO jk = 1, jpkm1 DO jj = 1, jpjm1 DO ji = 1, jpim1 usd3d(ji,jj,jk) = 0.5_wp * ( zusd_t(ji ,jj,jk) + zusd_t(ji+1,jj,jk) ) * umask(ji,jj,jk) vsd3d(ji,jj,jk) = 0.5_wp * ( zvsd_t(ji ,jj,jk) + zvsd_t(ji,jj+1,jk) ) * vmask(ji,jj,jk) END DO END DO END DO CALL lbc_lnk( usd3d(:,:,:), 'U', -1. ) CALL lbc_lnk( vsd3d(:,:,:), 'V', -1. ) ! DO jk = 1, jpkm1 !* e3t * Horizontal divergence ==! DO jj = 2, jpjm1 DO ji = fs_2, fs_jpim1 ! vector opt. ze3hdiv(ji,jj,jk) = ( e2u(ji ,jj) * fse3u_n(ji ,jj,jk) * usd3d(ji ,jj,jk) & & - e2u(ji-1,jj) * fse3u_n(ji-1,jj,jk) * usd3d(ji-1,jj,jk) & & + e1v(ji,jj ) * fse3v_n(ji,jj ,jk) * vsd3d(ji,jj ,jk) & & - e1v(ji,jj-1) * fse3v_n(ji,jj-1,jk) * vsd3d(ji,jj-1,jk) ) * r1_e1e2t(ji,jj) END DO END DO IF( .NOT. AGRIF_Root() ) THEN IF( nbondi == 1 .OR. nbondi == 2 ) ze3hdiv(nlci-1, : ,jk) = 0._wp ! east IF( nbondi == -1 .OR. nbondi == 2 ) ze3hdiv( 2 , : ,jk) = 0._wp ! west IF( nbondj == 1 .OR. nbondj == 2 ) ze3hdiv( : ,nlcj-1,jk) = 0._wp ! north IF( nbondj == -1 .OR. nbondj == 2 ) ze3hdiv( : , 2 ,jk) = 0._wp ! south ENDIF END DO CALL lbc_lnk( ze3hdiv, 'T', 1. ) ! DO jk = jpkm1, 1, -1 !* integrate from the bottom the e3t * hor. divergence wsd3d(:,:,jk) = wsd3d(:,:,jk+1) - ze3hdiv(:,:,jk) END DO #if defined key_bdy IF( lk_bdy ) THEN DO jk = 1, jpkm1 wsd3d(:,:,jk) = wsd3d(:,:,jk) * bdytmask(:,:) END DO ENDIF #endif CALL wrk_dealloc( jpi,jpj,jpk, zusd_t, zvsd_t, ze3hdiv ) ! ENDIF ! END SUBROUTINE sbc_wave !!====================================================================== END MODULE sbcwave