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 branches/2017/dev_r8600_xios_read/NEMOGCM/NEMO/OPA_SRC/SBC – NEMO

source: branches/2017/dev_r8600_xios_read/NEMOGCM/NEMO/OPA_SRC/SBC/sbcssm.F90 @ 8612

Last change on this file since 8612 was 8612, checked in by andmirek, 6 years ago

#1953 read single file restart with XIOS

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