MODULE sbcssr !!====================================================================== !! *** MODULE sbcssr *** !! Surface module : add to heat and fresh water fluxes a restoring term !! toward observed SST/SSS !!====================================================================== !! History : 9.0 ! 06-06 (G. Madec) Original code !!---------------------------------------------------------------------- !!---------------------------------------------------------------------- !! sbc_ssr : add to sbc a restoring term toward SST/SSS climatology !!---------------------------------------------------------------------- USE oce ! ocean dynamics and tracers USE dom_oce ! ocean space and time domain USE sbc_oce ! surface boundary condition USE phycst ! physical constants USE daymod ! calendar USE sbcrnf ! surface boundary condition : runoffs USE fldread ! read input fields USE iom ! I/O manager USE in_out_manager ! I/O manager USE lib_mpp ! distribued memory computing library USE lbclnk ! ocean lateral boundary conditions (or mpp link) IMPLICIT NONE PRIVATE PUBLIC sbc_ssr ! routine called in sbcmod REAL(wp), ALLOCATABLE, DIMENSION(:) :: buffer ! Temporary buffer for exchange TYPE(FLD), ALLOCATABLE, DIMENSION(:) :: sf_sst ! structure of input SST (file informations, fields read) TYPE(FLD), ALLOCATABLE, DIMENSION(:) :: sf_sss ! structure of input SSS (file informations, fields read) REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: erp !: evaporation damping [kg/m2/s] REAL(wp), PUBLIC, DIMENSION(jpi,jpj) :: qrp !: heat flux damping [w/m2] !! * Namelist namsbc_ssr INTEGER :: nn_sstr, nn_sssr ! SST/SSS indicator REAL(wp) :: dqdt , deds ! restoring term factor !! * Substitutions # include "domzgr_substitute.h90" !!---------------------------------------------------------------------- !! OPA 9.0 , LOCEAN-IPSL (2006) !! $ Id: $ !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt) !!---------------------------------------------------------------------- CONTAINS SUBROUTINE sbc_ssr( kt ) !!--------------------------------------------------------------------- !! *** ROUTINE sbc_ssr *** !! !! ** Purpose : Add to heat and/or freshwater fluxes a damping term !! toward observed SST and/or SSS. !! !! ** Method : - Read namelist namsbc_ssr !! - Read observed SST and/or SSS !! - at each nscb time step !! add a retroaction term on qns (nn_sstr = 1) !! add a damping term on emps (nn_sssr = 1) !! add a damping term on emp & emps (nn_sssr = 2) !!--------------------------------------------------------------------- INTEGER, INTENT(in ) :: kt ! ocean time step !! INTEGER :: ji, jj ! dummy loop indices REAL(wp) :: zerp ! local scalar for evaporation damping REAL(wp) :: zqrp ! local scalar for heat flux damping REAL(wp) :: zsrp ! local scalar for unit conversion of deds factor INTEGER :: ierror ! return error code !! CHARACTER(len=100) :: cn_dir ! Root directory for location of ssr files TYPE(FLD_N) :: sn_sst, sn_sss ! informations about the fields to be read NAMELIST/namsbc_ssr/ cn_dir, nn_sstr, nn_sssr, dqdt, deds, sn_sst, sn_sss !!---------------------------------------------------------------------- ! ! -------------------- ! IF( kt == nit000 ) THEN ! First call kt=nit000 ! ! ! -------------------- ! ! ! set file information nn_sstr = 0 nn_sssr = 0 dqdt = -40.e0 deds = -27.70 cn_dir = './' ! directory in which the model is executed ! ... default values (NB: frequency positive => hours, negative => months) ! ! file ! frequency ! variable ! time intep ! clim ! 'yearly' or ! ! ! name ! (hours) ! name ! (T/F) ! (T/F) ! 'monthly' ! sn_sst = FLD_N( 'sst' , 24. , 'sst' , .false. , .false. , 'yearly' ) sn_sss = FLD_N( 'sss' , -1. , 'sss' , .true. , .false. , 'yearly' ) REWIND ( numnam ) ! ... read in namlist namflx READ( numnam, namsbc_ssr ) IF(lwp) THEN ! control print WRITE(numout,*) WRITE(numout,*) 'sbc_ssr : SST and/or SSS damping term ' WRITE(numout,*) '~~~~~~~ ' WRITE(numout,*) ' SST restoring term (Yes=1) nn_sstr = ', nn_sstr WRITE(numout,*) ' SSS damping term (Yes=1, salt flux) nn_sssr = ', nn_sssr WRITE(numout,*) ' (Yes=2, volume flux) ' WRITE(numout,*) ' dQ/dT (restoring magnitude on SST) dqdt = ', dqdt, ' W/m2/K' WRITE(numout,*) ' dE/dS (restoring magnitude on SST) deds = ', deds, ' mm/day' ENDIF IF( nn_sstr == 1 ) THEN ! set sf_sst structure ! ALLOCATE( sf_sst(1), STAT=ierror ) IF( ierror > 0 ) THEN CALL ctl_stop( 'sbc_ssr: unable to allocate sf_sst structure' ) ; RETURN ENDIF ! fill sf_sst with sn_sst and control print CALL fld_fill( sf_sst, (/ sn_sst /), cn_dir, 'sbc_ssr', 'SST restoring term toward SST data', 'namsbc_ssr' ) ENDIF ! IF( nn_sssr == 1 ) THEN ! set sf_sss structure ! ALLOCATE( sf_sss(1), STAT=ierror ) IF( ierror > 0 ) THEN CALL ctl_stop( 'sbc_ssr: unable to allocate sf_sss structure' ) ; RETURN ENDIF ! fill sf_sss with sn_sss and control print CALL fld_fill( sf_sss, (/ sn_sss /), cn_dir, 'sbc_ssr', 'SSS restoring term toward SSS data', 'namsbc_ssr' ) ENDIF ! ! Initialize qrp and erp if no restoring IF( nn_sstr /= 1 ) qrp(:,:) = 0.e0 IF( nn_sssr /= 1 .OR. nn_sssr /= 2 ) erp(:,:) = 0.e0 ENDIF IF( nn_sstr + nn_sssr /= 0 ) THEN IF( nn_sstr == 1) CALL fld_read( kt, nn_fsbc, sf_sst ) ! Read SST data and provides it ! ! at the current time-step IF( nn_sssr == 1) CALL fld_read( kt, nn_fsbc, sf_sss ) ! Read SSS data and provides it ! ! at the current time-step ! ! ========================= ! IF( MOD( kt-1, nn_fsbc ) == 0 ) THEN ! Add restoring term ! ! ! ========================= ! ! IF( nn_sstr == 1 ) THEN ! Temperature restoring term !CDIR COLLAPSE ! use zqrp scalar to optimize memory access (speedup the loop) DO jj = 1, jpj DO ji = 1, jpi zqrp = dqdt * ( sst_m(ji,jj) - sf_sst(1)%fnow(ji,jj) ) qns(ji,jj) = qns(ji,jj) + zqrp qrp(ji,jj) = zqrp END DO END DO ENDIF ! IF( nn_sssr == 1 ) THEN ! Salinity damping term (salt flux, emps only) !CDIR COLLAPSE ! use zerp scalar to optimize memory access (speedup the loop) DO jj = 1, jpj DO ji = 1, jpi zsrp = deds / rday ! from [mm/day] to [kg/m2/s] zerp = zsrp * ( 1. - 2.*rnfmsk(ji,jj) ) & ! No damping in vicinity of river mouths & * ( sss_m(ji,jj) - sf_sss(1)%fnow(ji,jj) ) & & / ( sss_m(ji,jj) + 1.e-20 ) emps(ji,jj) = emps(ji,jj) + zerp erp( ji,jj) = zerp END DO END DO ELSEIF( nn_sssr == 2 ) THEN ! Salinity damping term (volume flux, emp and emps) !CDIR COLLAPSE ! use zerp scalar to optimize memory access (speedup the loop) DO jj = 1, jpj DO ji = 1, jpi zsrp = deds / rday ! from [mm/day] to [kg/m2/s] zerp = zsrp * ( 1. - 2.*rnfmsk(ji,jj) ) & ! No damping in vicinity of river mouths & * ( sss_m(ji,jj) - sf_sss(1)%fnow(ji,jj) ) & & / ( sss_m(ji,jj) + 1.e-20 ) emp (ji,jj) = emp (ji,jj) + zerp emps(ji,jj) = emps(ji,jj) + zerp erp (ji,jj) = zerp END DO END DO ENDIF ! ENDIF ! ENDIF !!gm ... to be written ! Output sbc fields (using IOM) ! prevoir comment obtenir l info sst sss ssr ! END SUBROUTINE sbc_ssr !!====================================================================== END MODULE sbcssr