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/2013/dev_r3858_NOC_ZTC/NEMOGCM/NEMO/OPA_SRC/SBC – NEMO

source: branches/2013/dev_r3858_NOC_ZTC/NEMOGCM/NEMO/OPA_SRC/SBC/sbcssm.F90 @ 3865

Last change on this file since 3865 was 3865, checked in by acc, 11 years ago

Branch 2013/dev_r3858_NOC_ZTC, #863. Nearly complete port of 2011/dev_r2739_LOCEAN8_ZTC development branch into v3.5aplha base. Compiles and runs but currently unstable after 8 timesteps with ORCA2_LIM reference configuration.
  • Property svn:keywords set to Id
File size: 10.8 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 sbc_oce         ! surface boundary condition: ocean fields
18   USE sbcapr          ! surface boundary condition: atmospheric pressure
19   USE prtctl          ! Print control                    (prt_ctl routine)
20   USE iom
21   USE in_out_manager  ! I/O manager
22
23   IMPLICIT NONE
24   PRIVATE
25
26   PUBLIC   sbc_ssm    ! routine called by step.F90
27
28   LOGICAL, SAVE  ::   l_ssm_mean = .FALSE.       ! keep track of whether means have been read
29                                                  ! from restart file
30   
31   !! * Substitutions
32#  include "domzgr_substitute.h90"
33   !!----------------------------------------------------------------------
34   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
35   !! $Id$
36   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
37   !!----------------------------------------------------------------------
38CONTAINS
39
40   SUBROUTINE sbc_ssm( kt )
41      !!---------------------------------------------------------------------
42      !!                     ***  ROUTINE sbc_oce  ***
43      !!                     
44      !! ** Purpose :   provide ocean surface variable to sea-surface boundary
45      !!                condition computation
46      !!               
47      !! ** Method  :   compute mean surface velocity (2 components at U and
48      !!      V-points) [m/s], temperature [Celcius] and salinity [psu] over
49      !!      the periode (kt - nn_fsbc) to kt
50      !!         Note that the inverse barometer ssh (i.e. ssh associated with Patm)
51      !!      is add to ssh_m when ln_apr_dyn = T. Required for sea-ice dynamics.
52      !!---------------------------------------------------------------------
53      INTEGER, INTENT(in) ::   kt   ! ocean time step
54      !
55      REAL(wp) ::   zcoef, zf_sbc       ! local scalar
56      !!---------------------------------------------------------------------
57      !                                                   ! ---------------------------------------- !
58      IF( nn_fsbc == 1 ) THEN                             !   Instantaneous surface fields        !
59         !                                                ! ---------------------------------------- !
60         ssu_m(:,:) = ub(:,:,1)
61         ssv_m(:,:) = vb(:,:,1)
62         sst_m(:,:) = tsn(:,:,1,jp_tem)
63         sss_m(:,:) = tsn(:,:,1,jp_sal)
64         !                          ! removed inverse barometer ssh when Patm forcing is used (for sea-ice dynamics)
65         IF( ln_apr_dyn ) THEN   ;   ssh_m(:,:) = sshn(:,:) - 0.5 * ( ssh_ib(:,:) + ssh_ibb(:,:) )
66         ELSE                    ;   ssh_m(:,:) = sshn(:,:)
67         ENDIF
68         !
69         IF( lk_vvl )   fse3t_m(:,:) = fse3t_n(:,:,1)
70         !
71      ELSE
72         !                                                ! ----------------------------------------------- !
73         IF( kt == nit000 .AND. .NOT. l_ssm_mean ) THEN   !   Initialisation: 1st time-step, no input means !
74            !                                             ! ----------------------------------------------- !
75            IF(lwp) WRITE(numout,*)
76            IF(lwp) WRITE(numout,*) '~~~~~~~   mean fields initialised to instantaneous values'
77            zcoef = REAL( nn_fsbc - 1, wp )
78            ssu_m(:,:) = zcoef * ub(:,:,1)
79            ssv_m(:,:) = zcoef * vb(:,:,1)
80            sst_m(:,:) = zcoef * tsn(:,:,1,jp_tem)
81            sss_m(:,:) = zcoef * tsn(:,:,1,jp_sal)
82            !                          ! removed inverse barometer ssh when Patm forcing is used
83            IF( ln_apr_dyn ) THEN   ;   ssh_m(:,:) = zcoef * ( sshn(:,:) - 0.5 * ( ssh_ib(:,:) + ssh_ibb(:,:) ) )
84            ELSE                    ;   ssh_m(:,:) = zcoef *   sshn(:,:)
85            ENDIF
86            IF( lk_vvl )   fse3t_m(:,:) = zcoef * fse3t_n(:,:,1)
87            !                                             ! ---------------------------------------- !
88         ELSEIF( MOD( kt - 2 , nn_fsbc ) == 0 ) THEN      !   Initialisation: New mean computation   !
89            !                                             ! ---------------------------------------- !
90            ssu_m(:,:) = 0.e0      ! reset to zero ocean mean sbc fields
91            ssv_m(:,:) = 0.e0
92            sst_m(:,:) = 0.e0
93            sss_m(:,:) = 0.e0
94            ssh_m(:,:) = 0.e0
95            IF( lk_vvl )   fse3t_m(:,:) = 0.e0
96         ENDIF
97         !                                                ! ---------------------------------------- !
98         !                                                !        Cumulate at each time step        !
99         !                                                ! ---------------------------------------- !
100         ssu_m(:,:) = ssu_m(:,:) + ub(:,:,1)
101         ssv_m(:,:) = ssv_m(:,:) + vb(:,:,1)
102         sst_m(:,:) = sst_m(:,:) + tsn(:,:,1,jp_tem)
103         sss_m(:,:) = sss_m(:,:) + tsn(:,:,1,jp_sal)
104         !                          ! removed inverse barometer ssh when Patm forcing is used (for sea-ice dynamics)
105         IF( ln_apr_dyn ) THEN   ;   ssh_m(:,:) = ssh_m(:,:) + sshn(:,:) - 0.5 *  ( ssh_ib(:,:) + ssh_ibb(:,:) )
106         ELSE                    ;   ssh_m(:,:) = ssh_m(:,:) + sshn(:,:)
107         ENDIF
108         IF( lk_vvl )   fse3t_m(:,:) = fse3t_m(:,:) + fse3t_n(:,:,1)
109
110         !                                                ! ---------------------------------------- !
111         IF( MOD( kt - 1 , nn_fsbc ) == 0 ) THEN          !   Mean value at each nn_fsbc time-step   !
112            !                                             ! ---------------------------------------- !
113            zcoef = 1. / REAL( nn_fsbc, wp )
114            sst_m(:,:) = sst_m(:,:) * zcoef           ! mean SST             [Celcius]
115            sss_m(:,:) = sss_m(:,:) * zcoef           ! mean SSS             [psu]
116            ssu_m(:,:) = ssu_m(:,:) * zcoef           ! mean suface current  [m/s]
117            ssv_m(:,:) = ssv_m(:,:) * zcoef           !
118            ssh_m(:,:) = ssh_m(:,:) * zcoef           ! mean SSH             [m]
119            IF( lk_vvl )   fse3t_m(:,:) = fse3t_m(:,:) * zcoef   ! mean vertical scale factor [m]
120            !
121         ENDIF
122         !                                                ! ---------------------------------------- !
123         IF( lrst_oce ) THEN                              !      Write in the ocean restart file     !
124            !                                             ! ---------------------------------------- !
125            IF(lwp) WRITE(numout,*)
126            IF(lwp) WRITE(numout,*) 'sbc_ssm : sea surface mean fields written in ocean restart file ',   &
127               &                    'at it= ', kt,' date= ', ndastp
128            IF(lwp) WRITE(numout,*) '~~~~~~~'
129            zf_sbc = REAL( nn_fsbc, wp )
130            CALL iom_rstput( kt, nitrst, numrow, 'nn_fsbc', zf_sbc )    ! sbc frequency
131            CALL iom_rstput( kt, nitrst, numrow, 'ssu_m'  , ssu_m  )    ! sea surface mean fields
132            CALL iom_rstput( kt, nitrst, numrow, 'ssv_m'  , ssv_m  )
133            CALL iom_rstput( kt, nitrst, numrow, 'sst_m'  , sst_m  )
134            CALL iom_rstput( kt, nitrst, numrow, 'sss_m'  , sss_m  )
135            CALL iom_rstput( kt, nitrst, numrow, 'ssh_m'  , ssh_m  )
136            IF( lk_vvl ) THEN
137               CALL iom_rstput( kt, nitrst, numrow, 'fse3t_m'  , fse3t_m(:,:)  )
138            END IF
139            !
140         ENDIF
141         !
142      ENDIF
143      !
144   END SUBROUTINE sbc_ssm
145
146   SUBROUTINE sbc_ssm_init
147      !!----------------------------------------------------------------------
148      !!                  ***  ROUTINE sbc_ssm_init  ***
149      !!
150      !! ** Purpose :   Initialisation of the sbc data
151      !!
152      !! ** Action  : - read parameters
153      !!----------------------------------------------------------------------
154      REAL(wp) ::   zcoef, zf_sbc       ! local scalar
155      !!----------------------------------------------------------------------
156
157      IF( nn_fsbc == 1 ) THEN
158         !
159         IF(lwp) WRITE(numout,*)
160         IF(lwp) WRITE(numout,*) 'sbc_ssm : sea surface mean fields, nn_fsbc=1 : instantaneous values'
161         IF(lwp) WRITE(numout,*) '~~~~~~~ '
162         !
163      ELSE
164         !               
165         IF(lwp) WRITE(numout,*)
166         IF(lwp) WRITE(numout,*) 'sbc_ssm : sea surface mean fields'
167         IF(lwp) WRITE(numout,*) '~~~~~~~ '
168         !
169         IF( ln_rstart .AND. iom_varid( numror, 'nn_fsbc', ldstop = .FALSE. ) > 0 ) THEN
170            l_ssm_mean = .TRUE.
171            CALL iom_get( numror               , 'nn_fsbc', zf_sbc )   ! sbc frequency of previous run
172            CALL iom_get( numror, jpdom_autoglo, 'ssu_m'  , ssu_m  )   ! sea surface mean velocity    (T-point)
173            CALL iom_get( numror, jpdom_autoglo, 'ssv_m'  , ssv_m  )   !   "         "    velocity    (V-point)
174            CALL iom_get( numror, jpdom_autoglo, 'sst_m'  , sst_m  )   !   "         "    temperature (T-point)
175            CALL iom_get( numror, jpdom_autoglo, 'sss_m'  , sss_m  )   !   "         "    salinity    (T-point)
176            CALL iom_get( numror, jpdom_autoglo, 'ssh_m'  , ssh_m  )   !   "         "    height      (T-point)
177            IF( lk_vvl ) CALL iom_get( numror, jpdom_autoglo, 'fse3t_m', fse3t_m(:,:) )
178            !
179            IF( zf_sbc /= REAL( nn_fsbc, wp ) ) THEN      ! nn_fsbc has changed between 2 runs
180               IF(lwp) WRITE(numout,*) '~~~~~~~   restart with a change in the frequency of mean ',   &
181                  &                    'from ', zf_sbc, ' to ', nn_fsbc 
182               zcoef = REAL( nn_fsbc - 1, wp ) / zf_sbc 
183               ssu_m(:,:) = zcoef * ssu_m(:,:) 
184               ssv_m(:,:) = zcoef * ssv_m(:,:)
185               sst_m(:,:) = zcoef * sst_m(:,:)
186               sss_m(:,:) = zcoef * sss_m(:,:)
187               ssh_m(:,:) = zcoef * ssh_m(:,:)
188               IF( lk_vvl ) fse3t_m(:,:) = zcoef * fse3t_m(:,:)
189            ELSE
190               IF(lwp) WRITE(numout,*) '~~~~~~~   mean fields read in the ocean restart file'
191            ENDIF
192         ENDIF
193      ENDIF
194      !
195   END SUBROUTINE sbc_ssm_init
196
197   !!======================================================================
198END MODULE sbcssm
Note: See TracBrowser for help on using the repository browser.