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.
sbcssr.F90 in branches/UKMO/test_moci_test_suite_namelist_read/NEMOGCM/NEMO/OPA_SRC/SBC – NEMO

source: branches/UKMO/test_moci_test_suite_namelist_read/NEMOGCM/NEMO/OPA_SRC/SBC/sbcssr.F90 @ 9383

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

#2050 fixes and changes
File size: 13.6 KB
Line 
1MODULE sbcssr
2   !!======================================================================
3   !!                       ***  MODULE  sbcssr  ***
4   !! Surface module :  heat and fresh water fluxes a restoring term toward observed SST/SSS
5   !!======================================================================
6   !! History :  3.0  !  2006-06  (G. Madec)  Original code
7   !!            3.2  !  2009-04  (B. Lemaire)  Introduce iom_put
8   !!----------------------------------------------------------------------
9
10   !!----------------------------------------------------------------------
11   !!   sbc_ssr       : add to sbc a restoring term toward SST/SSS climatology
12   !!   sbc_ssr_init  : initialisation of surface restoring
13   !!----------------------------------------------------------------------
14   USE oce            ! ocean dynamics and tracers
15   USE dom_oce        ! ocean space and time domain
16   USE sbc_oce        ! surface boundary condition
17   USE phycst         ! physical constants
18   USE sbcrnf         ! surface boundary condition : runoffs
19   !
20   USE fldread        ! read input fields
21   USE iom            ! I/O manager
22   USE in_out_manager ! I/O manager
23   USE lib_mpp        ! distribued memory computing library
24   USE lbclnk         ! ocean lateral boundary conditions (or mpp link)
25   USE timing         ! Timing
26   USE lib_fortran    ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined) 
27
28   IMPLICIT NONE
29   PRIVATE
30
31   PUBLIC   sbc_ssr        ! routine called in sbcmod
32   PUBLIC   sbc_ssr_init   ! routine called in sbcmod
33   PRIVATE  ssr_namelist
34
35   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   erp   !: evaporation damping   [kg/m2/s]
36   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) ::   qrp   !: heat flux damping        [w/m2]
37
38   !                                   !!* Namelist namsbc_ssr *
39   INTEGER, PUBLIC ::   nn_sstr         ! SST/SSS restoring indicator
40   INTEGER, PUBLIC ::   nn_sssr         ! SST/SSS restoring indicator
41   REAL(wp)        ::   rn_dqdt         ! restoring factor on SST and SSS
42   REAL(wp)        ::   rn_deds         ! restoring factor on SST and SSS
43   LOGICAL         ::   ln_sssr_bnd     ! flag to bound erp term
44   REAL(wp)        ::   rn_sssr_bnd     ! ABS(Max./Min.) value of erp term [mm/day]
45   LOGICAL         ::   ln_ssr_sio      ! single processor read flag
46
47   REAL(wp) , ALLOCATABLE, DIMENSION(:) ::   buffer   ! Temporary buffer for exchange
48   TYPE(FLD), ALLOCATABLE, DIMENSION(:) ::   sf_sst   ! structure of input SST (file informations, fields read)
49   TYPE(FLD), ALLOCATABLE, DIMENSION(:) ::   sf_sss   ! structure of input SSS (file informations, fields read)
50
51   !! * Substitutions
52#  include "domzgr_substitute.h90"
53   !!----------------------------------------------------------------------
54   !! NEMO/OPA 4.0 , NEMO Consortium (2011)
55   !! $Id$
56   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
57   !!----------------------------------------------------------------------
58CONTAINS
59
60   SUBROUTINE sbc_ssr( kt )
61      !!---------------------------------------------------------------------
62      !!                     ***  ROUTINE sbc_ssr  ***
63      !!
64      !! ** Purpose :   Add to heat and/or freshwater fluxes a damping term
65      !!                toward observed SST and/or SSS.
66      !!
67      !! ** Method  : - Read namelist namsbc_ssr
68      !!              - Read observed SST and/or SSS
69      !!              - at each nscb time step
70      !!                   add a retroaction term on qns    (nn_sstr = 1)
71      !!                   add a damping term on sfx        (nn_sssr = 1)
72      !!                   add a damping term on emp        (nn_sssr = 2)
73      !!---------------------------------------------------------------------
74      INTEGER, INTENT(in   ) ::   kt   ! ocean time step
75      !!
76      INTEGER  ::   ji, jj   ! dummy loop indices
77      REAL(wp) ::   zerp     ! local scalar for evaporation damping
78      REAL(wp) ::   zqrp     ! local scalar for heat flux damping
79      REAL(wp) ::   zsrp     ! local scalar for unit conversion of rn_deds factor
80      REAL(wp) ::   zerp_bnd ! local scalar for unit conversion of rn_epr_max factor
81      INTEGER  ::   ierror   ! return error code
82      !!
83      CHARACTER(len=100) ::  cn_dir          ! Root directory for location of ssr files
84      TYPE(FLD_N) ::   sn_sst, sn_sss        ! informations about the fields to be read
85      !!----------------------------------------------------------------------
86      !
87      IF( nn_timing == 1 )  CALL timing_start('sbc_ssr')
88      !
89      IF( nn_sstr + nn_sssr /= 0 ) THEN
90         !
91         lspr = ln_ssr_sio
92         IF( nn_sstr == 1)   CALL fld_read( kt, nn_fsbc, sf_sst )   ! Read SST data and provides it at kt
93         IF( nn_sssr >= 1)   CALL fld_read( kt, nn_fsbc, sf_sss )   ! Read SSS data and provides it at kt
94         lspr = .false.
95         !
96         !                                         ! ========================= !
97         IF( MOD( kt-1, nn_fsbc ) == 0 ) THEN      !    Add restoring term     !
98            !                                      ! ========================= !
99            !
100            IF( nn_sstr == 1 ) THEN                                   !* Temperature restoring term
101               DO jj = 1, jpj
102                  DO ji = 1, jpi
103                     zqrp = rn_dqdt * ( sst_m(ji,jj) - sf_sst(1)%fnow(ji,jj,1) )
104                     qns(ji,jj) = qns(ji,jj) + zqrp
105                     qrp(ji,jj) = zqrp
106                  END DO
107               END DO
108               CALL iom_put( "qrp", qrp )                             ! heat flux damping
109            ENDIF
110            !
111            IF( nn_sssr == 1 ) THEN                                   !* Salinity damping term (salt flux only (sfx))
112               zsrp = rn_deds / rday                                  ! from [mm/day] to [kg/m2/s]
113!CDIR COLLAPSE
114               DO jj = 1, jpj
115                  DO ji = 1, jpi
116                     zerp = zsrp * ( 1. - 2.*rnfmsk(ji,jj) )   &      ! No damping in vicinity of river mouths
117                        &        * ( sss_m(ji,jj) - sf_sss(1)%fnow(ji,jj,1) ) 
118                     sfx(ji,jj) = sfx(ji,jj) + zerp                 ! salt flux
119                     erp(ji,jj) = zerp / MAX( sss_m(ji,jj), 1.e-20 ) ! converted into an equivalent volume flux (diagnostic only)
120                  END DO
121               END DO
122               CALL iom_put( "erp", erp )                             ! freshwater flux damping
123               !
124            ELSEIF( nn_sssr == 2 ) THEN                               !* Salinity damping term (volume flux (emp) and associated heat flux (qns)
125               zsrp = rn_deds / rday                                  ! from [mm/day] to [kg/m2/s]
126               zerp_bnd = rn_sssr_bnd / rday                          !       -              -   
127!CDIR COLLAPSE
128               DO jj = 1, jpj
129                  DO ji = 1, jpi                           
130                     zerp = zsrp * ( 1. - 2.*rnfmsk(ji,jj) )   &      ! No damping in vicinity of river mouths
131                        &        * ( sss_m(ji,jj) - sf_sss(1)%fnow(ji,jj,1) )   &
132                        &        / MAX(  sss_m(ji,jj), 1.e-20   )
133                     IF( ln_sssr_bnd )   zerp = SIGN( 1., zerp ) * MIN( zerp_bnd, ABS(zerp) )
134                     emp(ji,jj) = emp (ji,jj) + zerp
135                     qns(ji,jj) = qns(ji,jj) - zerp * rcp * sst_m(ji,jj)
136                     erp(ji,jj) = zerp
137                  END DO
138               END DO
139               CALL iom_put( "erp", erp )                             ! freshwater flux damping
140            ENDIF
141            !
142         ENDIF
143         !
144      ENDIF
145      !
146      IF( nn_timing == 1 )  CALL timing_stop('sbc_ssr')
147      !
148   END SUBROUTINE sbc_ssr
149
150 
151   SUBROUTINE sbc_ssr_init
152      !!---------------------------------------------------------------------
153      !!                  ***  ROUTINE sbc_ssr_init  ***
154      !!
155      !! ** Purpose :   initialisation of surface damping term
156      !!
157      !! ** Method  : - Read namelist namsbc_ssr
158      !!              - Read observed SST and/or SSS if required
159      !!---------------------------------------------------------------------
160      INTEGER  ::   ji, jj   ! dummy loop indices
161      REAL(wp) ::   zerp     ! local scalar for evaporation damping
162      REAL(wp) ::   zqrp     ! local scalar for heat flux damping
163      REAL(wp) ::   zsrp     ! local scalar for unit conversion of rn_deds factor
164      REAL(wp) ::   zerp_bnd ! local scalar for unit conversion of rn_epr_max factor
165      INTEGER  ::   ierror   ! return error code
166      !!
167      CHARACTER(len=100) ::  cn_dir          ! Root directory for location of ssr files
168      TYPE(FLD_N) ::   sn_sst, sn_sss        ! informations about the fields to be read
169      NAMELIST/namsbc_ssr/ cn_dir, nn_sstr, nn_sssr, rn_dqdt, rn_deds, sn_sst, sn_sss, ln_sssr_bnd, rn_sssr_bnd, &
170      &                    ln_ssr_sio
171      INTEGER     ::  ios
172      !!----------------------------------------------------------------------
173      !
174 
175      ln_ssr_sio = .FALSE.
176      IF(lwm) THEN
177         REWIND( numnam_ref )              ! Namelist namsbc_ssr in reference namelist :
178         READ  ( numnam_ref, namsbc_ssr, IOSTAT = ios, ERR = 901)
179901      CONTINUE
180      ENDIF
181      call mpp_bcast(ios)
182      IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc_ssr in reference namelist', lwp )
183      IF(lwm) THEN
184         REWIND( numnam_cfg )              ! Namelist namsbc_ssr in configuration namelist :
185         READ  ( numnam_cfg, namsbc_ssr, IOSTAT = ios, ERR = 902 )
186902      CONTINUE
187      ENDIF
188      call mpp_bcast(ios)
189      IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc_ssr in configuration namelist', lwp )
190
191      IF(lwm) WRITE ( numond, namsbc_ssr )
192
193      CALL ssr_namelist(cn_dir, sn_sst, sn_sss)
194
195      IF(lwp) THEN                 !* control print
196         WRITE(numout,*)
197         WRITE(numout,*) 'sbc_ssr : SST and/or SSS damping term '
198         WRITE(numout,*) '~~~~~~~ '
199         WRITE(numout,*) '   Namelist namsbc_ssr :'
200         WRITE(numout,*) '      SST restoring term (Yes=1)             nn_sstr     = ', nn_sstr
201         WRITE(numout,*) '      SSS damping term (Yes=1, salt flux)    nn_sssr     = ', nn_sssr
202         WRITE(numout,*) '                       (Yes=2, volume flux) '
203         WRITE(numout,*) '      dQ/dT (restoring magnitude on SST)     rn_dqdt     = ', rn_dqdt, ' W/m2/K'
204         WRITE(numout,*) '      dE/dS (restoring magnitude on SST)     rn_deds     = ', rn_deds, ' mm/day'
205         WRITE(numout,*) '      flag to bound erp term                 ln_sssr_bnd = ', ln_sssr_bnd
206         WRITE(numout,*) '      ABS(Max./Min.) erp threshold           rn_sssr_bnd = ', rn_sssr_bnd, ' mm/day'
207      ENDIF
208      !
209      !                            !* Allocate erp and qrp array
210      ALLOCATE( qrp(jpi,jpj), erp(jpi,jpj), STAT=ierror )
211      IF( ierror > 0 )   CALL ctl_stop( 'STOP', 'sbc_ssr: unable to allocate erp and qrp array' )
212      !
213      IF( nn_sstr == 1 ) THEN      !* set sf_sst structure & allocate arrays
214         !
215         ALLOCATE( sf_sst(1), STAT=ierror )
216         IF( ierror > 0 )   CALL ctl_stop( 'STOP', 'sbc_ssr: unable to allocate sf_sst structure' )
217         ALLOCATE( sf_sst(1)%fnow(jpi,jpj,1), STAT=ierror )
218         IF( ierror > 0 )   CALL ctl_stop( 'STOP', 'sbc_ssr: unable to allocate sf_sst now array' )
219         !
220         ! fill sf_sst with sn_sst and control print
221         CALL fld_fill( sf_sst, (/ sn_sst /), cn_dir, 'sbc_ssr', 'SST restoring term toward SST data', 'namsbc_ssr' )
222         IF( sf_sst(1)%ln_tint )   ALLOCATE( sf_sst(1)%fdta(jpi,jpj,1,2), STAT=ierror )
223         IF( ierror > 0 )   CALL ctl_stop( 'STOP', 'sbc_ssr: unable to allocate sf_sst data array' )
224         !
225      ENDIF
226      !
227      IF( nn_sssr >= 1 ) THEN      !* set sf_sss structure & allocate arrays
228         !
229         ALLOCATE( sf_sss(1), STAT=ierror )
230         IF( ierror > 0 )   CALL ctl_stop( 'STOP', 'sbc_ssr: unable to allocate sf_sss structure' )
231         ALLOCATE( sf_sss(1)%fnow(jpi,jpj,1), STAT=ierror )
232         IF( ierror > 0 )   CALL ctl_stop( 'STOP', 'sbc_ssr: unable to allocate sf_sss now array' )
233         !
234         ! fill sf_sss with sn_sss and control print
235         CALL fld_fill( sf_sss, (/ sn_sss /), cn_dir, 'sbc_ssr', 'SSS restoring term toward SSS data', 'namsbc_ssr' )
236         IF( sf_sss(1)%ln_tint )   ALLOCATE( sf_sss(1)%fdta(jpi,jpj,1,2), STAT=ierror )
237         IF( ierror > 0 )   CALL ctl_stop( 'STOP', 'sbc_ssr: unable to allocate sf_sss data array' )
238         !
239      ENDIF
240      !
241      !                            !* Initialize qrp and erp if no restoring
242      IF( nn_sstr /= 1                   )   qrp(:,:) = 0._wp
243      IF( nn_sssr /= 1 .OR. nn_sssr /= 2 )   erp(:,:) = 0._wp
244      !
245   END SUBROUTINE sbc_ssr_init
246
247   SUBROUTINE ssr_namelist(cd_dir, sd_sst, sd_sss)
248     !!---------------------------------------------------------------------
249     !!                   ***  ROUTINE ssr_namelist  ***
250     !!                     
251     !! ** Purpose :   Broadcast namelist variables read by procesor lwm
252     !!
253     !! ** Method  :   use lib_mpp
254     !!----------------------------------------------------------------------
255      CHARACTER(len=100) ::  cd_dir          ! Root directory for location of ssr files
256      TYPE(FLD_N) ::   sd_sst, sd_sss        ! informations about the fields to be read
257#if defined key_mpp_mpi
258      CALL mpp_bcast(cd_dir, 100)
259      CALL mpp_bcast(nn_sstr)
260      CALL mpp_bcast(nn_sssr)
261      CALL mpp_bcast(rn_dqdt)
262      CALL mpp_bcast(rn_deds)
263      CALL fld_n_bcast(sd_sst)
264      CALL fld_n_bcast(sd_sss)
265      CALL mpp_bcast(ln_sssr_bnd)
266      CALL mpp_bcast(rn_sssr_bnd)
267      CALL mpp_bcast(ln_ssr_sio)
268#endif
269   END SUBROUTINE ssr_namelist     
270   !!======================================================================
271END MODULE sbcssr
Note: See TracBrowser for help on using the repository browser.