MODULE sbc_oce !!====================================================================== !! *** MODULE sbc_oce *** !! Surface module : variables defined in core memory !!====================================================================== !! History : 3.0 ! 2006-06 (G. Madec) Original code !! - ! 2008-08 (G. Madec) namsbc moved from sbcmod !! 3.3 ! 2010-04 (M. Leclair, G. Madec) Forcing averaged over 2 time steps !! - ! 2010-11 (G. Madec) ice-ocean stress always computed at each ocean time-step !! 3.3 ! 2010-10 (J. Chanut, C. Bricaud) add the surface pressure forcing !! 4.0 ! 2012-05 (C. Rousset) add attenuation coef for use in ice model !! 4.0 ! 2016-06 (L. Brodeau) new unified bulk routine (based on AeroBulk) !!---------------------------------------------------------------------- !!---------------------------------------------------------------------- !! sbc_oce_alloc : allocation of sbc arrays !! sbc_tau2wnd : wind speed estimated from wind stress !!---------------------------------------------------------------------- USE par_oce ! ocean parameters USE in_out_manager ! I/O manager USE lib_mpp ! MPP library IMPLICIT NONE PRIVATE PUBLIC sbc_oce_alloc ! routine called in sbcmod.F90 PUBLIC sbc_tau2wnd ! routine called in several sbc modules !!---------------------------------------------------------------------- !! Namelist for the Ocean Surface Boundary Condition !!---------------------------------------------------------------------- ! !!* namsbc namelist * LOGICAL , PUBLIC :: ln_usr !: user defined formulation LOGICAL , PUBLIC :: ln_flx !: flux formulation LOGICAL , PUBLIC :: ln_blk !: bulk formulation #if defined key_oasis3 LOGICAL , PUBLIC :: lk_oasis = .TRUE. !: OASIS used #else LOGICAL , PUBLIC :: lk_oasis = .FALSE. !: OASIS unused #endif LOGICAL , PUBLIC :: ln_cpl !: ocean-atmosphere coupled formulation LOGICAL , PUBLIC :: ln_mixcpl !: ocean-atmosphere forced-coupled mixed formulation LOGICAL , PUBLIC :: ln_dm2dc !: Daily mean to Diurnal Cycle short wave (qsr) LOGICAL , PUBLIC :: ln_rnf !: runoffs / runoff mouths LOGICAL , PUBLIC :: ln_isf !: ice shelf melting LOGICAL , PUBLIC :: ln_ssr !: Sea Surface restoring on SST and/or SSS LOGICAL , PUBLIC :: ln_apr_dyn !: Atmospheric pressure forcing used on dynamics (ocean & ice) INTEGER , PUBLIC :: nn_ice !: flag for ice in the surface boundary condition (=0/1/2/3) LOGICAL , PUBLIC :: ln_ice_embd !: flag for levitating/embedding sea-ice in the ocean ! !: =F levitating ice (no presure effect) with mass and salt exchanges ! !: =T embedded sea-ice (pressure effect + mass and salt exchanges) INTEGER , PUBLIC :: nn_components !: flag for sbc module (including sea-ice) coupling mode (see component definition below) INTEGER , PUBLIC :: nn_fwb !: FreshWater Budget: ! !: = 0 unchecked ! !: = 1 global mean of e-p-r set to zero at each nn_fsbc time step ! !: = 2 annual global mean of e-p-r set to zero LOGICAL , PUBLIC :: ln_wave !: true if some coupling with wave model LOGICAL , PUBLIC :: ln_cdgw !: true if neutral drag coefficient from wave model LOGICAL , PUBLIC :: ln_sdw !: true if 3d stokes drift from wave model LOGICAL , PUBLIC :: ln_tauwoc !: true if normalized stress from wave is used LOGICAL , PUBLIC :: ln_tauw !: true if ocean stress components from wave is used LOGICAL , PUBLIC :: ln_stcor !: true if Stokes-Coriolis term is used ! INTEGER , PUBLIC :: nn_sdrift ! type of parameterization to calculate vertical Stokes drift ! LOGICAL , PUBLIC :: ln_icebergs !: Icebergs ! INTEGER , PUBLIC :: nn_lsm !: Number of iteration if seaoverland is applied ! ! !!* namsbc_cpl namelist * INTEGER , PUBLIC :: nn_cats_cpl !: Number of sea ice categories over which the coupling is carried out !!---------------------------------------------------------------------- !! switch definition (improve readability) !!---------------------------------------------------------------------- INTEGER , PUBLIC, PARAMETER :: jp_usr = 1 !: user defined formulation INTEGER , PUBLIC, PARAMETER :: jp_flx = 2 !: flux formulation INTEGER , PUBLIC, PARAMETER :: jp_blk = 3 !: bulk formulation INTEGER , PUBLIC, PARAMETER :: jp_purecpl = 4 !: Pure ocean-atmosphere Coupled formulation INTEGER , PUBLIC, PARAMETER :: jp_none = 5 !: for OPA when doing coupling via SAS module !!---------------------------------------------------------------------- !! Stokes drift parametrization definition !!---------------------------------------------------------------------- INTEGER , PUBLIC, PARAMETER :: jp_breivik_2014 = 0 !: Breivik 2014: v_z=v_0*[exp(2*k*z)/(1-8*k*z)] INTEGER , PUBLIC, PARAMETER :: jp_li_2017 = 1 !: Li et al 2017: Stokes drift based on Phillips spectrum (Breivik 2016) ! with depth averaged profile INTEGER , PUBLIC, PARAMETER :: jp_peakfr = 2 !: Li et al 2017: using the peak wave number read from wave model instead ! of the inverse depth scale LOGICAL , PUBLIC :: ll_st_bv2014 = .FALSE. ! logical indicator, .true. if Breivik 2014 parameterisation is active. LOGICAL , PUBLIC :: ll_st_li2017 = .FALSE. ! logical indicator, .true. if Li 2017 parameterisation is active. LOGICAL , PUBLIC :: ll_st_bv_li = .FALSE. ! logical indicator, .true. if either Breivik or Li parameterisation is active. LOGICAL , PUBLIC :: ll_st_peakfr = .FALSE. ! logical indicator, .true. if using Li 2017 with peak wave number !!---------------------------------------------------------------------- !! component definition !!---------------------------------------------------------------------- INTEGER , PUBLIC, PARAMETER :: jp_iam_nemo = 0 !: Initial single executable configuration ! (no internal OASIS coupling) INTEGER , PUBLIC, PARAMETER :: jp_iam_opa = 1 !: Multi executable configuration - OPA component ! (internal OASIS coupling) INTEGER , PUBLIC, PARAMETER :: jp_iam_sas = 2 !: Multi executable configuration - SAS component ! (internal OASIS coupling) !!---------------------------------------------------------------------- !! Ocean Surface Boundary Condition fields !!---------------------------------------------------------------------- INTEGER , PUBLIC :: ncpl_qsr_freq !: qsr coupling frequency per days from atmosphere ! LOGICAL , PUBLIC :: lhftau = .FALSE. !: HF tau used in TKE: mean(stress module) - module(mean stress) !! !! now ! before !! REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: utau , utau_b !: sea surface i-stress (ocean referential) [N/m2] REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: vtau , vtau_b !: sea surface j-stress (ocean referential) [N/m2] REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: taum !: module of sea surface stress (at T-point) [N/m2] !! wndm is used onmpute surface gases exchanges in ice-free ocean or leads REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: wndm !: wind speed module at T-point (=|U10m-Uoce|) [m/s] REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: qsr !: sea heat flux: solar [W/m2] REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: qns , qns_b !: sea heat flux: non solar [W/m2] REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: qsr_tot !: total solar heat flux (over sea and ice) [W/m2] REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: qns_tot !: total non solar heat flux (over sea and ice) [W/m2] REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: emp , emp_b !: freshwater budget: volume flux [Kg/m2/s] REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: sfx , sfx_b !: salt flux [PSS.kg/m2/s] REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: emp_tot !: total E-P over ocean and ice [Kg/m2/s] REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: fmmflx !: freshwater budget: freezing/melting [Kg/m2/s] REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: rnf , rnf_b !: river runoff [Kg/m2/s] REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: fwfisf , fwfisf_b !: ice shelf melting [Kg/m2/s] REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: fwficb , fwficb_b !: iceberg melting [Kg/m2/s] !! REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: sbc_tsc, sbc_tsc_b !: sbc content trend [K.m/s] jpi,jpj,jpts REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: qsr_hc , qsr_hc_b !: heat content trend due to qsr flux [K.m/s] jpi,jpj,jpk !! !! REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: tprecip !: total precipitation [Kg/m2/s] REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: sprecip !: solid precipitation [Kg/m2/s] REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: fr_i !: ice fraction = 1 - lead fraction (between 0 to 1) REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: atm_co2 !: atmospheric pCO2 [ppm] REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: xcplmask !: coupling mask for ln_mixcpl (warning: allocated in sbccpl) !!---------------------------------------------------------------------- !! Sea Surface Mean fields !!---------------------------------------------------------------------- INTEGER , PUBLIC :: nn_fsbc !: frequency of sbc computation (as well as sea-ice model) REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ssu_m !: mean (nn_fsbc time-step) surface sea i-current (U-point) [m/s] REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ssv_m !: mean (nn_fsbc time-step) surface sea j-current (V-point) [m/s] REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: sst_m !: mean (nn_fsbc time-step) surface sea temperature [Celsius] REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: sss_m !: mean (nn_fsbc time-step) surface sea salinity [psu] REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ssh_m !: mean (nn_fsbc time-step) sea surface height [m] REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: e3t_m !: mean (nn_fsbc time-step) sea surface layer thickness [m] REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: frq_m !: mean (nn_fsbc time-step) fraction of solar net radiation absorbed in the 1st T level [-] !! * Substitutions # include "vectopt_loop_substitute.h90" !!---------------------------------------------------------------------- !! NEMO/OCE 4.0 , NEMO Consortium (2018) !! $Id$ !! Software governed by the CeCILL license (see ./LICENSE) !!---------------------------------------------------------------------- CONTAINS INTEGER FUNCTION sbc_oce_alloc() !!--------------------------------------------------------------------- !! *** FUNCTION sbc_oce_alloc *** !!--------------------------------------------------------------------- INTEGER :: ierr(5) !!--------------------------------------------------------------------- ierr(:) = 0 ! ALLOCATE( utau(jpi,jpj) , utau_b(jpi,jpj) , taum(jpi,jpj) , & & vtau(jpi,jpj) , vtau_b(jpi,jpj) , wndm(jpi,jpj) , STAT=ierr(1) ) ! ALLOCATE( qns_tot(jpi,jpj) , qns (jpi,jpj) , qns_b(jpi,jpj), & & qsr_tot(jpi,jpj) , qsr (jpi,jpj) , & & emp (jpi,jpj) , emp_b(jpi,jpj) , & & sfx (jpi,jpj) , sfx_b(jpi,jpj) , emp_tot(jpi,jpj), fmmflx(jpi,jpj), STAT=ierr(2) ) ! ALLOCATE( fwfisf (jpi,jpj), rnf (jpi,jpj) , sbc_tsc (jpi,jpj,jpts) , qsr_hc (jpi,jpj,jpk) , & & fwfisf_b(jpi,jpj), rnf_b(jpi,jpj) , sbc_tsc_b(jpi,jpj,jpts) , qsr_hc_b(jpi,jpj,jpk) , & & fwficb (jpi,jpj), fwficb_b(jpi,jpj), STAT=ierr(3) ) ! ALLOCATE( tprecip(jpi,jpj) , sprecip(jpi,jpj) , fr_i(jpi,jpj) , & & atm_co2(jpi,jpj) , & & ssu_m (jpi,jpj) , sst_m(jpi,jpj) , frq_m(jpi,jpj) , & & ssv_m (jpi,jpj) , sss_m(jpi,jpj) , ssh_m(jpi,jpj) , STAT=ierr(4) ) ! ALLOCATE( e3t_m(jpi,jpj) , STAT=ierr(5) ) ! sbc_oce_alloc = MAXVAL( ierr ) CALL mpp_sum ( 'sbc_oce', sbc_oce_alloc ) IF( sbc_oce_alloc > 0 ) CALL ctl_warn('sbc_oce_alloc: allocation of arrays failed') ! END FUNCTION sbc_oce_alloc SUBROUTINE sbc_tau2wnd !!--------------------------------------------------------------------- !! *** ROUTINE sbc_tau2wnd *** !! !! ** Purpose : Estimation of wind speed as a function of wind stress !! !! ** Method : |tau|=rhoa*Cd*|U|^2 !!--------------------------------------------------------------------- USE dom_oce ! ocean space and time domain USE lbclnk ! ocean lateral boundary conditions (or mpp link) REAL(wp) :: zrhoa = 1.22 ! Air density kg/m3 REAL(wp) :: zcdrag = 1.5e-3 ! drag coefficient REAL(wp) :: ztx, zty, ztau, zcoef ! temporary variables INTEGER :: ji, jj ! dummy indices !!--------------------------------------------------------------------- zcoef = 0.5 / ( zrhoa * zcdrag ) DO jj = 2, jpjm1 DO ji = fs_2, fs_jpim1 ! vect. opt. ztx = utau(ji-1,jj ) + utau(ji,jj) zty = vtau(ji ,jj-1) + vtau(ji,jj) ztau = SQRT( ztx * ztx + zty * zty ) wndm(ji,jj) = SQRT ( ztau * zcoef ) * tmask(ji,jj,1) END DO END DO CALL lbc_lnk( 'sbc_oce', wndm(:,:) , 'T', 1. ) ! END SUBROUTINE sbc_tau2wnd !!====================================================================== END MODULE sbc_oce