[888] | 1 | MODULE sbc_oce |
---|
| 2 | !!====================================================================== |
---|
| 3 | !! *** MODULE sbc_oce *** |
---|
| 4 | !! Surface module : variables defined in core memory |
---|
| 5 | !!====================================================================== |
---|
[2528] | 6 | !! History : 3.0 ! 2006-06 (G. Madec) Original code |
---|
| 7 | !! - ! 2008-08 (G. Madec) namsbc moved from sbcmod |
---|
| 8 | !! 3.3 ! 2010-04 (M. Leclair, G. Madec) Forcing averaged over 2 time steps |
---|
| 9 | !! - ! 2010-11 (G. Madec) ice-ocean stress always computed at each ocean time-step |
---|
| 10 | !! 3.3 ! 2010-10 (J. Chanut, C. Bricaud) add the surface pressure forcing |
---|
[4161] | 11 | !! 4.0 ! 2012-05 (C. Rousset) add attenuation coef for use in ice model |
---|
[888] | 12 | !!---------------------------------------------------------------------- |
---|
| 13 | |
---|
[2715] | 14 | !!---------------------------------------------------------------------- |
---|
| 15 | !! sbc_oce_alloc : allocation of sbc arrays |
---|
| 16 | !! sbc_tau2wnd : wind speed estimated from wind stress |
---|
| 17 | !!---------------------------------------------------------------------- |
---|
| 18 | USE par_oce ! ocean parameters |
---|
| 19 | USE in_out_manager ! I/O manager |
---|
| 20 | USE lib_mpp ! MPP library |
---|
| 21 | |
---|
[888] | 22 | IMPLICIT NONE |
---|
| 23 | PRIVATE |
---|
[2715] | 24 | |
---|
| 25 | PUBLIC sbc_oce_alloc ! routine called in sbcmod.F90 |
---|
| 26 | PUBLIC sbc_tau2wnd ! routine called in several sbc modules |
---|
[888] | 27 | |
---|
| 28 | !!---------------------------------------------------------------------- |
---|
[1218] | 29 | !! Namelist for the Ocean Surface Boundary Condition |
---|
| 30 | !!---------------------------------------------------------------------- |
---|
[4147] | 31 | ! !!* namsbc namelist * |
---|
| 32 | LOGICAL , PUBLIC :: ln_ana !: analytical boundary condition flag |
---|
| 33 | LOGICAL , PUBLIC :: ln_flx !: flux formulation |
---|
| 34 | LOGICAL , PUBLIC :: ln_blk_clio !: CLIO bulk formulation |
---|
| 35 | LOGICAL , PUBLIC :: ln_blk_core !: CORE bulk formulation |
---|
| 36 | LOGICAL , PUBLIC :: ln_blk_mfs !: MFS bulk formulation |
---|
[4990] | 37 | #if defined key_oasis3 |
---|
[5407] | 38 | LOGICAL , PUBLIC :: lk_oasis = .TRUE. !: OASIS used |
---|
[4990] | 39 | #else |
---|
[5407] | 40 | LOGICAL , PUBLIC :: lk_oasis = .FALSE. !: OASIS unused |
---|
[4990] | 41 | #endif |
---|
[5407] | 42 | LOGICAL , PUBLIC :: ln_cpl !: ocean-atmosphere coupled formulation |
---|
| 43 | LOGICAL , PUBLIC :: ln_mixcpl !: ocean-atmosphere forced-coupled mixed formulation |
---|
[4147] | 44 | LOGICAL , PUBLIC :: ln_dm2dc !: Daily mean to Diurnal Cycle short wave (qsr) |
---|
[4230] | 45 | LOGICAL , PUBLIC :: ln_rnf !: runoffs / runoff mouths |
---|
[4147] | 46 | LOGICAL , PUBLIC :: ln_ssr !: Sea Surface restoring on SST and/or SSS |
---|
| 47 | LOGICAL , PUBLIC :: ln_apr_dyn !: Atmospheric pressure forcing used on dynamics (ocean & ice) |
---|
| 48 | INTEGER , PUBLIC :: nn_ice !: flag for ice in the surface boundary condition (=0/1/2/3) |
---|
[4990] | 49 | INTEGER , PUBLIC :: nn_isf !: flag for isf in the surface boundary condition (=0/1/2/3/4) |
---|
[4147] | 50 | INTEGER , PUBLIC :: nn_ice_embd !: flag for levitating/embedding sea-ice in the ocean |
---|
[3625] | 51 | ! !: =0 levitating ice (no mass exchange, concentration/dilution effect) |
---|
| 52 | ! !: =1 levitating ice with mass and salt exchange but no presure effect |
---|
| 53 | ! !: =2 embedded sea-ice (full salt and mass exchanges and pressure) |
---|
[5407] | 54 | INTEGER , PUBLIC :: nn_components !: flag for sbc module (including sea-ice) coupling mode (see component definition below) |
---|
| 55 | INTEGER , PUBLIC :: nn_limflx !: LIM3 Multi-category heat flux formulation |
---|
[4990] | 56 | ! !: =-1 Use of per-category fluxes |
---|
| 57 | ! !: = 0 Average per-category fluxes |
---|
| 58 | ! !: = 1 Average then redistribute per-category fluxes |
---|
| 59 | ! !: = 2 Redistribute a single flux over categories |
---|
[4147] | 60 | INTEGER , PUBLIC :: nn_fwb !: FreshWater Budget: |
---|
[1220] | 61 | ! !: = 0 unchecked |
---|
| 62 | ! !: = 1 global mean of e-p-r set to zero at each nn_fsbc time step |
---|
| 63 | ! !: = 2 annual global mean of e-p-r set to zero |
---|
[4147] | 64 | LOGICAL , PUBLIC :: ln_wave !: true if some coupling with wave model |
---|
| 65 | LOGICAL , PUBLIC :: ln_cdgw !: true if neutral drag coefficient from wave model |
---|
| 66 | LOGICAL , PUBLIC :: ln_sdw !: true if 3d stokes drift from wave model |
---|
| 67 | ! |
---|
| 68 | LOGICAL , PUBLIC :: ln_icebergs !: Icebergs |
---|
[4161] | 69 | ! |
---|
[4990] | 70 | INTEGER , PUBLIC :: nn_lsm !: Number of iteration if seaoverland is applied |
---|
[1218] | 71 | !!---------------------------------------------------------------------- |
---|
[4990] | 72 | !! switch definition (improve readability) |
---|
| 73 | !!---------------------------------------------------------------------- |
---|
[5407] | 74 | INTEGER , PUBLIC, PARAMETER :: jp_gyre = 0 !: GYRE analytical formulation |
---|
| 75 | INTEGER , PUBLIC, PARAMETER :: jp_ana = 1 !: analytical formulation |
---|
| 76 | INTEGER , PUBLIC, PARAMETER :: jp_flx = 2 !: flux formulation |
---|
| 77 | INTEGER , PUBLIC, PARAMETER :: jp_clio = 3 !: CLIO bulk formulation |
---|
| 78 | INTEGER , PUBLIC, PARAMETER :: jp_core = 4 !: CORE bulk formulation |
---|
| 79 | INTEGER , PUBLIC, PARAMETER :: jp_purecpl = 5 !: Pure ocean-atmosphere Coupled formulation |
---|
| 80 | INTEGER , PUBLIC, PARAMETER :: jp_mfs = 6 !: MFS bulk formulation |
---|
| 81 | INTEGER , PUBLIC, PARAMETER :: jp_none = 7 !: for OPA when doing coupling via SAS module |
---|
[4990] | 82 | INTEGER , PUBLIC, PARAMETER :: jp_esopa = -1 !: esopa test, ALL formulations |
---|
| 83 | |
---|
| 84 | !!---------------------------------------------------------------------- |
---|
[5407] | 85 | !! component definition |
---|
| 86 | !!---------------------------------------------------------------------- |
---|
| 87 | INTEGER , PUBLIC, PARAMETER :: jp_iam_nemo = 0 !: Initial single executable configuration |
---|
| 88 | ! (no internal OASIS coupling) |
---|
| 89 | INTEGER , PUBLIC, PARAMETER :: jp_iam_opa = 1 !: Multi executable configuration - OPA component |
---|
| 90 | ! (internal OASIS coupling) |
---|
| 91 | INTEGER , PUBLIC, PARAMETER :: jp_iam_sas = 2 !: Multi executable configuration - SAS component |
---|
| 92 | ! (internal OASIS coupling) |
---|
| 93 | !!---------------------------------------------------------------------- |
---|
[888] | 94 | !! Ocean Surface Boundary Condition fields |
---|
| 95 | !!---------------------------------------------------------------------- |
---|
[5385] | 96 | INTEGER , PUBLIC :: ncpl_qsr_freq !: qsr coupling frequency per days from atmosphere |
---|
| 97 | ! |
---|
[2528] | 98 | LOGICAL , PUBLIC :: lhftau = .FALSE. !: HF tau used in TKE: mean(stress module) - module(mean stress) |
---|
| 99 | !! !! now ! before !! |
---|
[2715] | 100 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: utau , utau_b !: sea surface i-stress (ocean referential) [N/m2] |
---|
| 101 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: vtau , vtau_b !: sea surface j-stress (ocean referential) [N/m2] |
---|
| 102 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: taum !: module of sea surface stress (at T-point) [N/m2] |
---|
| 103 | !! wndm is used onmpute surface gases exchanges in ice-free ocean or leads |
---|
| 104 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: wndm !: wind speed module at T-point (=|U10m-Uoce|) [m/s] |
---|
| 105 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: qsr !: sea heat flux: solar [W/m2] |
---|
| 106 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: qns , qns_b !: sea heat flux: non solar [W/m2] |
---|
| 107 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: qsr_tot !: total solar heat flux (over sea and ice) [W/m2] |
---|
| 108 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: qns_tot !: total non solar heat flux (over sea and ice) [W/m2] |
---|
| 109 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: emp , emp_b !: freshwater budget: volume flux [Kg/m2/s] |
---|
[3625] | 110 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: sfx , sfx_b !: salt flux [PSU/m2/s] |
---|
[2715] | 111 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: emp_tot !: total E-P over ocean and ice [Kg/m2/s] |
---|
[4148] | 112 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: fmmflx !: freshwater budget: freezing/melting [Kg/m2/s] |
---|
[5120] | 113 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: rnf , rnf_b !: river runoff [Kg/m2/s] |
---|
| 114 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: fwfisf , fwfisf_b !: ice shelf melting [Kg/m2/s] |
---|
[2528] | 115 | !! |
---|
[2715] | 116 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: sbc_tsc, sbc_tsc_b !: sbc content trend [K.m/s] jpi,jpj,jpts |
---|
| 117 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: qsr_hc , qsr_hc_b !: heat content trend due to qsr flux [K.m/s] jpi,jpj,jpk |
---|
[2528] | 118 | !! |
---|
[4161] | 119 | !! |
---|
[2715] | 120 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: tprecip !: total precipitation [Kg/m2/s] |
---|
| 121 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: sprecip !: solid precipitation [Kg/m2/s] |
---|
| 122 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: fr_i !: ice fraction = 1 - lead fraction (between 0 to 1) |
---|
[1534] | 123 | #if defined key_cpl_carbon_cycle |
---|
[2715] | 124 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: atm_co2 !: atmospheric pCO2 [ppm] |
---|
[1534] | 125 | #endif |
---|
[5407] | 126 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: xcplmask !: coupling mask for ln_mixcpl (warning: allocated in sbccpl) |
---|
[888] | 127 | |
---|
| 128 | !!---------------------------------------------------------------------- |
---|
| 129 | !! Sea Surface Mean fields |
---|
| 130 | !!---------------------------------------------------------------------- |
---|
| 131 | INTEGER , PUBLIC :: nn_fsbc !: frequency of sbc computation (as well as sea-ice model) |
---|
[2715] | 132 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ssu_m !: mean (nn_fsbc time-step) surface sea i-current (U-point) [m/s] |
---|
| 133 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ssv_m !: mean (nn_fsbc time-step) surface sea j-current (V-point) [m/s] |
---|
| 134 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: sst_m !: mean (nn_fsbc time-step) surface sea temperature [Celsius] |
---|
| 135 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: sss_m !: mean (nn_fsbc time-step) surface sea salinity [psu] |
---|
| 136 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: ssh_m !: mean (nn_fsbc time-step) sea surface height [m] |
---|
[4990] | 137 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: e3t_m !: mean (nn_fsbc time-step) sea surface layer thickness [m] |
---|
[5407] | 138 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: frq_m !: mean (nn_fsbc time-step) fraction of solar net radiation absorbed in the 1st T level [-] |
---|
[888] | 139 | |
---|
[2715] | 140 | !! * Substitutions |
---|
| 141 | # include "vectopt_loop_substitute.h90" |
---|
[888] | 142 | !!---------------------------------------------------------------------- |
---|
[2715] | 143 | !! NEMO/OPA 4.0 , NEMO Consortium (2011) |
---|
[2528] | 144 | !! $Id$ |
---|
| 145 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
---|
[2715] | 146 | !!---------------------------------------------------------------------- |
---|
| 147 | CONTAINS |
---|
| 148 | |
---|
| 149 | INTEGER FUNCTION sbc_oce_alloc() |
---|
| 150 | !!--------------------------------------------------------------------- |
---|
| 151 | !! *** FUNCTION sbc_oce_alloc *** |
---|
| 152 | !!--------------------------------------------------------------------- |
---|
[4292] | 153 | INTEGER :: ierr(5) |
---|
[2715] | 154 | !!--------------------------------------------------------------------- |
---|
| 155 | ierr(:) = 0 |
---|
| 156 | ! |
---|
| 157 | ALLOCATE( utau(jpi,jpj) , utau_b(jpi,jpj) , taum(jpi,jpj) , & |
---|
| 158 | & vtau(jpi,jpj) , vtau_b(jpi,jpj) , wndm(jpi,jpj) , STAT=ierr(1) ) |
---|
| 159 | ! |
---|
[3625] | 160 | ALLOCATE( qns_tot(jpi,jpj) , qns (jpi,jpj) , qns_b(jpi,jpj), & |
---|
| 161 | & qsr_tot(jpi,jpj) , qsr (jpi,jpj) , & |
---|
| 162 | & emp (jpi,jpj) , emp_b(jpi,jpj) , & |
---|
[4148] | 163 | & sfx (jpi,jpj) , sfx_b(jpi,jpj) , emp_tot(jpi,jpj), fmmflx(jpi,jpj), STAT=ierr(2) ) |
---|
[2715] | 164 | ! |
---|
[5120] | 165 | ALLOCATE( fwfisf (jpi,jpj), rnf (jpi,jpj) , sbc_tsc (jpi,jpj,jpts) , qsr_hc (jpi,jpj,jpk) , & |
---|
| 166 | & fwfisf_b(jpi,jpj), rnf_b(jpi,jpj) , sbc_tsc_b(jpi,jpj,jpts) , qsr_hc_b(jpi,jpj,jpk) , STAT=ierr(3) ) |
---|
[2715] | 167 | ! |
---|
| 168 | ALLOCATE( tprecip(jpi,jpj) , sprecip(jpi,jpj) , fr_i(jpi,jpj) , & |
---|
| 169 | #if defined key_cpl_carbon_cycle |
---|
| 170 | & atm_co2(jpi,jpj) , & |
---|
| 171 | #endif |
---|
[5407] | 172 | & ssu_m (jpi,jpj) , sst_m(jpi,jpj) , frq_m(jpi,jpj) , & |
---|
| 173 | & ssv_m (jpi,jpj) , sss_m(jpi,jpj) , ssh_m(jpi,jpj) , STAT=ierr(4) ) |
---|
[2715] | 174 | ! |
---|
[4292] | 175 | #if defined key_vvl |
---|
| 176 | ALLOCATE( e3t_m(jpi,jpj) , STAT=ierr(5) ) |
---|
| 177 | #endif |
---|
| 178 | ! |
---|
[2715] | 179 | sbc_oce_alloc = MAXVAL( ierr ) |
---|
| 180 | IF( lk_mpp ) CALL mpp_sum ( sbc_oce_alloc ) |
---|
| 181 | IF( sbc_oce_alloc > 0 ) CALL ctl_warn('sbc_oce_alloc: allocation of arrays failed') |
---|
| 182 | ! |
---|
| 183 | END FUNCTION sbc_oce_alloc |
---|
| 184 | |
---|
| 185 | |
---|
| 186 | SUBROUTINE sbc_tau2wnd |
---|
| 187 | !!--------------------------------------------------------------------- |
---|
| 188 | !! *** ROUTINE sbc_tau2wnd *** |
---|
| 189 | !! |
---|
| 190 | !! ** Purpose : Estimation of wind speed as a function of wind stress |
---|
| 191 | !! |
---|
| 192 | !! ** Method : |tau|=rhoa*Cd*|U|^2 |
---|
| 193 | !!--------------------------------------------------------------------- |
---|
| 194 | USE dom_oce ! ocean space and time domain |
---|
| 195 | USE lbclnk ! ocean lateral boundary conditions (or mpp link) |
---|
| 196 | REAL(wp) :: zrhoa = 1.22 ! Air density kg/m3 |
---|
| 197 | REAL(wp) :: zcdrag = 1.5e-3 ! drag coefficient |
---|
| 198 | REAL(wp) :: ztx, zty, ztau, zcoef ! temporary variables |
---|
| 199 | INTEGER :: ji, jj ! dummy indices |
---|
| 200 | !!--------------------------------------------------------------------- |
---|
| 201 | zcoef = 0.5 / ( zrhoa * zcdrag ) |
---|
| 202 | !CDIR NOVERRCHK |
---|
| 203 | DO jj = 2, jpjm1 |
---|
| 204 | !CDIR NOVERRCHK |
---|
| 205 | DO ji = fs_2, fs_jpim1 ! vect. opt. |
---|
| 206 | ztx = utau(ji-1,jj ) + utau(ji,jj) |
---|
| 207 | zty = vtau(ji ,jj-1) + vtau(ji,jj) |
---|
| 208 | ztau = SQRT( ztx * ztx + zty * zty ) |
---|
| 209 | wndm(ji,jj) = SQRT ( ztau * zcoef ) * tmask(ji,jj,1) |
---|
| 210 | END DO |
---|
| 211 | END DO |
---|
| 212 | CALL lbc_lnk( wndm(:,:) , 'T', 1. ) |
---|
| 213 | ! |
---|
| 214 | END SUBROUTINE sbc_tau2wnd |
---|
| 215 | |
---|
[888] | 216 | !!====================================================================== |
---|
| 217 | END MODULE sbc_oce |
---|