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/2015/dev_r5218_CNRS17_coupling/NEMOGCM/NEMO/OPA_SRC/SBC – NEMO

source: branches/2015/dev_r5218_CNRS17_coupling/NEMOGCM/NEMO/OPA_SRC/SBC/sbcssm.F90 @ 5223

Last change on this file since 5223 was 5223, checked in by smasson, 9 years ago

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