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.
sbcssm.F90 in NEMO/trunk/src/OCE/SBC – NEMO

source: NEMO/trunk/src/OCE/SBC/sbcssm.F90 @ 15267

Last change on this file since 15267 was 15145, checked in by smasson, 3 years ago

trunk: pass all sette tests in debug with nn_hls = 2
  • Property svn:keywords set to Id
File size: 13.5 KB
RevLine 
[888]1MODULE sbcssm
2   !!======================================================================
3   !!                       ***  MODULE  sbcssm  ***
4   !! Surface module :  provide time-mean ocean surface variables
5   !!======================================================================
[2715]6   !! History :  9.0  ! 2006-07  (G. Madec)  Original code
[2528]7   !!            3.3  ! 2010-10  (C. Bricaud, G. Madec)  add the Patm forcing for sea-ice
[6140]8   !!            3.7  ! 2015-11  (G. Madec)  non linear free surface by default: e3t_m always computed
[888]9   !!----------------------------------------------------------------------
10
11   !!----------------------------------------------------------------------
[14072]12   !!   sbc_ssm       : calculate sea surface mean currents, temperature,
[6140]13   !!                   and salinity over nn_fsbc time-step
[888]14   !!----------------------------------------------------------------------
[6140]15   USE oce            ! ocean dynamics and tracers
16   USE dom_oce        ! ocean space and time domain
17   USE sbc_oce        ! surface boundary condition: ocean fields
18   USE sbcapr         ! surface boundary condition: atmospheric pressure
19   USE eosbn2         ! equation of state and related derivatives
[10425]20   USE traqsr, ONLY: ln_traqsr
[4990]21   !
[6140]22   USE in_out_manager ! I/O manager
23   USE prtctl         ! Print control
24   USE iom            ! IOM library
[888]25
26   IMPLICIT NONE
27   PRIVATE
28
[6140]29   PUBLIC   sbc_ssm        ! routine called by step.F90
30   PUBLIC   sbc_ssm_init   ! routine called by sbcmod.F90
[4292]31
[6140]32   LOGICAL, SAVE ::   l_ssm_mean = .FALSE.   ! keep track of whether means have been read from restart file
[14072]33
[13237]34#  include "domzgr_substitute.h90"
[888]35   !!----------------------------------------------------------------------
[9598]36   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
[1156]37   !! $Id$
[10068]38   !! Software governed by the CeCILL license (see ./LICENSE)
[888]39   !!----------------------------------------------------------------------
40CONTAINS
41
[12377]42   SUBROUTINE sbc_ssm( kt, Kbb, Kmm )
[888]43      !!---------------------------------------------------------------------
44      !!                     ***  ROUTINE sbc_oce  ***
[14072]45      !!
[888]46      !! ** Purpose :   provide ocean surface variable to sea-surface boundary
[14072]47      !!                condition computation
48      !!
49      !! ** Method  :   compute mean surface velocity (2 components at U and
[7646]50      !!      V-points) [m/s], temperature [Celsius] and salinity [psu] over
[888]51      !!      the periode (kt - nn_fsbc) to kt
[2528]52      !!         Note that the inverse barometer ssh (i.e. ssh associated with Patm)
53      !!      is add to ssh_m when ln_apr_dyn = T. Required for sea-ice dynamics.
[888]54      !!---------------------------------------------------------------------
[2715]55      INTEGER, INTENT(in) ::   kt   ! ocean time step
[12377]56      INTEGER, INTENT(in) ::   Kbb, Kmm   ! ocean time level indices
[888]57      !
[4990]58      INTEGER  ::   ji, jj               ! loop index
[2715]59      REAL(wp) ::   zcoef, zf_sbc       ! local scalar
[4990]60      REAL(wp), DIMENSION(jpi,jpj,jpts) :: zts
[888]61      !!---------------------------------------------------------------------
[6140]62      !
[5120]63      !                                        !* surface T-, U-, V- ocean level variables (T, S, depth, velocity)
[12377]64      zts(:,:,jp_tem) = ts(:,:,1,jp_tem,Kmm)
65      zts(:,:,jp_sal) = ts(:,:,1,jp_sal,Kmm)
[4990]66      !
[888]67         !                                                ! ---------------------------------------- !
[15145]68      IF( nn_fsbc == 1 ) THEN                             !      Instantaneous surface fields        !
69         !                                                ! ---------------------------------------- !
[12377]70         ssu_m(:,:) = uu(:,:,1,Kbb)
71         ssv_m(:,:) = vv(:,:,1,Kbb)
[7753]72         IF( l_useCT )  THEN    ;   sst_m(:,:) = eos_pt_from_ct( zts(:,:,jp_tem), zts(:,:,jp_sal) )
[12377]73         ELSE                   ;   sst_m(:,:) = zts(:,:,jp_tem)
[4990]74         ENDIF
[7753]75         sss_m(:,:) = zts(:,:,jp_sal)
[2528]76         !                          ! removed inverse barometer ssh when Patm forcing is used (for sea-ice dynamics)
[12377]77         IF( ln_apr_dyn ) THEN   ;   ssh_m(:,:) = ssh(:,:,Kmm) - 0.5 * ( ssh_ib(:,:) + ssh_ibb(:,:) )
78         ELSE                    ;   ssh_m(:,:) = ssh(:,:,Kmm)
[2528]79         ENDIF
[888]80         !
[12377]81         e3t_m(:,:) = e3t(:,:,1,Kmm)
[4292]82         !
[7753]83         frq_m(:,:) = fraqsr_1lev(:,:)
[5407]84         !
[888]85      ELSE
[3607]86         !                                                ! ----------------------------------------------- !
[3614]87         IF( kt == nit000 .AND. .NOT. l_ssm_mean ) THEN   !   Initialisation: 1st time-step, no input means !
[3607]88            !                                             ! ----------------------------------------------- !
[888]89            IF(lwp) WRITE(numout,*)
[7646]90            IF(lwp) WRITE(numout,*) 'sbc_ssm : mean fields initialised to instantaneous values'
91            IF(lwp) WRITE(numout,*) '~~~~~~~   '
[3607]92            zcoef = REAL( nn_fsbc - 1, wp )
[12377]93            ssu_m(:,:) = zcoef * uu(:,:,1,Kbb)
94            ssv_m(:,:) = zcoef * vv(:,:,1,Kbb)
[15145]95            IF( l_useCT   )  THEN   ;   sst_m(:,:) = zcoef * eos_pt_from_ct( zts(:,:,jp_tem), zts(:,:,jp_sal) )
[7753]96            ELSE                    ;   sst_m(:,:) = zcoef * zts(:,:,jp_tem)
[4990]97            ENDIF
[7753]98            sss_m(:,:) = zcoef * zts(:,:,jp_sal)
[4990]99            !                          ! removed inverse barometer ssh when Patm forcing is used (for sea-ice dynamics)
[12377]100            IF( ln_apr_dyn ) THEN   ;   ssh_m(:,:) = zcoef * ( ssh(:,:,Kmm) - 0.5 * ( ssh_ib(:,:) + ssh_ibb(:,:) ) )
101            ELSE                    ;   ssh_m(:,:) = zcoef *   ssh(:,:,Kmm)
[888]102            ENDIF
[4990]103            !
[12377]104            e3t_m(:,:) = zcoef * e3t(:,:,1,Kmm)
[7753]105            !
106            frq_m(:,:) = zcoef * fraqsr_1lev(:,:)
[888]107            !                                             ! ---------------------------------------- !
108         ELSEIF( MOD( kt - 2 , nn_fsbc ) == 0 ) THEN      !   Initialisation: New mean computation   !
109            !                                             ! ---------------------------------------- !
[7753]110            ssu_m(:,:) = 0._wp     ! reset to zero ocean mean sbc fields
111            ssv_m(:,:) = 0._wp
112            sst_m(:,:) = 0._wp
113            sss_m(:,:) = 0._wp
114            ssh_m(:,:) = 0._wp
115            e3t_m(:,:) = 0._wp
116            frq_m(:,:) = 0._wp
[888]117         ENDIF
118         !                                                ! ---------------------------------------- !
119         !                                                !        Cumulate at each time step        !
120         !                                                ! ---------------------------------------- !
[12377]121         ssu_m(:,:) = ssu_m(:,:) + uu(:,:,1,Kbb)
122         ssv_m(:,:) = ssv_m(:,:) + vv(:,:,1,Kbb)
[9019]123         IF( l_useCT )  THEN     ;   sst_m(:,:) = sst_m(:,:) + eos_pt_from_ct( zts(:,:,jp_tem), zts(:,:,jp_sal) )
[7753]124         ELSE                    ;   sst_m(:,:) = sst_m(:,:) + zts(:,:,jp_tem)
[4990]125         ENDIF
[7753]126         sss_m(:,:) = sss_m(:,:) + zts(:,:,jp_sal)
[2528]127         !                          ! removed inverse barometer ssh when Patm forcing is used (for sea-ice dynamics)
[12377]128         IF( ln_apr_dyn ) THEN   ;   ssh_m(:,:) = ssh_m(:,:) + ssh(:,:,Kmm) - 0.5 * ( ssh_ib(:,:) + ssh_ibb(:,:) )
129         ELSE                    ;   ssh_m(:,:) = ssh_m(:,:) + ssh(:,:,Kmm)
[2528]130         ENDIF
[4990]131         !
[12377]132         e3t_m(:,:) = e3t_m(:,:) + e3t(:,:,1,Kmm)
[7753]133         !
134         frq_m(:,:) = frq_m(:,:) + fraqsr_1lev(:,:)
[888]135
136         !                                                ! ---------------------------------------- !
137         IF( MOD( kt - 1 , nn_fsbc ) == 0 ) THEN          !   Mean value at each nn_fsbc time-step   !
138            !                                             ! ---------------------------------------- !
139            zcoef = 1. / REAL( nn_fsbc, wp )
[7753]140            sst_m(:,:) = sst_m(:,:) * zcoef     ! mean SST             [Celsius]
141            sss_m(:,:) = sss_m(:,:) * zcoef     ! mean SSS             [psu]
142            ssu_m(:,:) = ssu_m(:,:) * zcoef     ! mean suface current  [m/s]
143            ssv_m(:,:) = ssv_m(:,:) * zcoef     !
144            ssh_m(:,:) = ssh_m(:,:) * zcoef     ! mean SSH             [m]
145            e3t_m(:,:) = e3t_m(:,:) * zcoef     ! mean vertical scale factor [m]
146            frq_m(:,:) = frq_m(:,:) * zcoef     ! mean fraction of solar net radiation absorbed in the 1st T level [-]
[888]147            !
148         ENDIF
149         !                                                ! ---------------------------------------- !
150         IF( lrst_oce ) THEN                              !      Write in the ocean restart file     !
151            !                                             ! ---------------------------------------- !
152            IF(lwp) WRITE(numout,*)
153            IF(lwp) WRITE(numout,*) 'sbc_ssm : sea surface mean fields written in ocean restart file ',   &
154               &                    'at it= ', kt,' date= ', ndastp
155            IF(lwp) WRITE(numout,*) '~~~~~~~'
156            zf_sbc = REAL( nn_fsbc, wp )
[13970]157            CALL iom_rstput( kt, nitrst, numrow, 'nn_fsbc', zf_sbc )    ! sbc frequency
158            CALL iom_rstput( kt, nitrst, numrow, 'ssu_m'  , ssu_m  )    ! sea surface mean fields
159            CALL iom_rstput( kt, nitrst, numrow, 'ssv_m'  , ssv_m  )
160            CALL iom_rstput( kt, nitrst, numrow, 'sst_m'  , sst_m  )
161            CALL iom_rstput( kt, nitrst, numrow, 'sss_m'  , sss_m  )
162            CALL iom_rstput( kt, nitrst, numrow, 'ssh_m'  , ssh_m  )
163            CALL iom_rstput( kt, nitrst, numrow, 'e3t_m'  , e3t_m  )
164            CALL iom_rstput( kt, nitrst, numrow, 'frq_m'  , frq_m  )
[888]165            !
166         ENDIF
167         !
168      ENDIF
169      !
[5407]170      IF( MOD( kt - 1 , nn_fsbc ) == 0 ) THEN          !   Mean value at each nn_fsbc time-step   !
171         CALL iom_put( 'ssu_m', ssu_m )
172         CALL iom_put( 'ssv_m', ssv_m )
173         CALL iom_put( 'sst_m', sst_m )
174         CALL iom_put( 'sss_m', sss_m )
175         CALL iom_put( 'ssh_m', ssh_m )
[6140]176         CALL iom_put( 'e3t_m', e3t_m )
[5407]177         CALL iom_put( 'frq_m', frq_m )
178      ENDIF
179      !
[888]180   END SUBROUTINE sbc_ssm
181
[6140]182
[12377]183   SUBROUTINE sbc_ssm_init( Kbb, Kmm )
[3607]184      !!----------------------------------------------------------------------
185      !!                  ***  ROUTINE sbc_ssm_init  ***
186      !!
187      !! ** Purpose :   Initialisation of the sbc data
188      !!
189      !! ** Action  : - read parameters
190      !!----------------------------------------------------------------------
[12377]191      INTEGER, INTENT(in) ::   Kbb, Kmm   ! ocean time level indices
[6140]192      REAL(wp) ::   zcoef, zf_sbc   ! local scalar
[3607]193      !!----------------------------------------------------------------------
[6140]194      !
[3607]195      IF( nn_fsbc == 1 ) THEN
196         !
197         IF(lwp) WRITE(numout,*)
[7646]198         IF(lwp) WRITE(numout,*) 'sbc_ssm_init : sea surface mean fields, nn_fsbc=1 : instantaneous values'
199         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~ '
[3607]200         !
201      ELSE
[14072]202         !
[3607]203         IF(lwp) WRITE(numout,*)
[7646]204         IF(lwp) WRITE(numout,*) 'sbc_ssm_init : sea surface mean fields'
205         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~ '
[3607]206         !
207         IF( ln_rstart .AND. iom_varid( numror, 'nn_fsbc', ldstop = .FALSE. ) > 0 ) THEN
208            l_ssm_mean = .TRUE.
[13970]209            CALL iom_get( numror            , 'nn_fsbc', zf_sbc )     ! sbc frequency of previous run
210            CALL iom_get( numror, jpdom_auto, 'ssu_m'  , ssu_m, cd_type = 'U', psgn = -1._wp )    ! sea surface mean velocity    (U-point)
211            CALL iom_get( numror, jpdom_auto, 'ssv_m'  , ssv_m, cd_type = 'V', psgn = -1._wp )    !   "         "    velocity    (V-point)
212            CALL iom_get( numror, jpdom_auto, 'sst_m'  , sst_m )    !   "         "    temperature (T-point)
213            CALL iom_get( numror, jpdom_auto, 'sss_m'  , sss_m )    !   "         "    salinity    (T-point)
214            CALL iom_get( numror, jpdom_auto, 'ssh_m'  , ssh_m )    !   "         "    height      (T-point)
215            CALL iom_get( numror, jpdom_auto, 'e3t_m'  , e3t_m )    ! 1st level thickness          (T-point)
[5407]216            ! fraction of solar net radiation absorbed in 1st T level
217            IF( iom_varid( numror, 'frq_m', ldstop = .FALSE. ) > 0 ) THEN
[13970]218               CALL iom_get( numror, jpdom_auto, 'frq_m'  , frq_m  )
[5407]219            ELSE
[7753]220               frq_m(:,:) = 1._wp   ! default definition
[5407]221            ENDIF
[3607]222            !
223            IF( zf_sbc /= REAL( nn_fsbc, wp ) ) THEN      ! nn_fsbc has changed between 2 runs
[14072]224               IF(lwp) WRITE(numout,*) '   restart with a change in the frequency of mean from ', zf_sbc, ' to ', nn_fsbc
225               zcoef = REAL( nn_fsbc - 1, wp ) / zf_sbc
226               ssu_m(:,:) = zcoef * ssu_m(:,:)
[7753]227               ssv_m(:,:) = zcoef * ssv_m(:,:)
228               sst_m(:,:) = zcoef * sst_m(:,:)
229               sss_m(:,:) = zcoef * sss_m(:,:)
230               ssh_m(:,:) = zcoef * ssh_m(:,:)
231               e3t_m(:,:) = zcoef * e3t_m(:,:)
232               frq_m(:,:) = zcoef * frq_m(:,:)
[3607]233            ELSE
[7646]234               IF(lwp) WRITE(numout,*) '   mean fields read in the ocean restart file'
[3607]235            ENDIF
236         ENDIF
237      ENDIF
238      !
[9019]239      IF( .NOT.l_ssm_mean ) THEN   ! default initialisation. needed by iceistate
[5407]240         !
[7646]241         IF(lwp) WRITE(numout,*) '   default initialisation of ss._m arrays'
[12377]242         ssu_m(:,:) = uu(:,:,1,Kbb)
243         ssv_m(:,:) = vv(:,:,1,Kbb)
244         IF( l_useCT )  THEN    ;   sst_m(:,:) = eos_pt_from_ct( ts(:,:,1,jp_tem,Kmm), ts(:,:,1,jp_sal,Kmm) )
245         ELSE                   ;   sst_m(:,:) = ts(:,:,1,jp_tem,Kmm)
[5407]246         ENDIF
[12377]247         sss_m(:,:) = ts  (:,:,1,jp_sal,Kmm)
248         ssh_m(:,:) = ssh(:,:,Kmm)
[15062]249         e3t_m(:,:) = e3t(:,:,1,Kmm)
[7753]250         frq_m(:,:) = 1._wp
[5407]251         !
252      ENDIF
253      !
[14072]254      IF( .NOT. ln_traqsr )   fraqsr_1lev(:,:) = 1._wp   ! default definition: qsr 100% in the fisrt level
[10425]255      !
[3607]256   END SUBROUTINE sbc_ssm_init
257
[888]258   !!======================================================================
259END MODULE sbcssm
Note: See TracBrowser for help on using the repository browser.