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

source: branches/UKMO/dev_r5518_flux_adjust/NEMOGCM/NEMO/OPA_SRC/SBC/sbcflx_adj.F90 @ 5881

Last change on this file since 5881 was 5881, checked in by timgraham, 8 years ago

Added sbcflx_adj and call to it from sbcmod

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