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/2016/dev_v3_6_STABLE_r6506_AGRIF_LIM3/NEMOGCM/NEMO/SAS_SRC – NEMO

source: branches/2016/dev_v3_6_STABLE_r6506_AGRIF_LIM3/NEMOGCM/NEMO/SAS_SRC/sbcssm.F90 @ 6861

Last change on this file since 6861 was 6861, checked in by clevy, 8 years ago

Add north south cyclic boundaries option, see ticket 1761
  • Property svn:keywords set to Id
File size: 14.8 KB
Line 
1MODULE sbcssm
2   !!======================================================================
3   !!                       ***  MODULE  sbcssm  ***
4   !! Off-line : interpolation of the physical fields
5   !!======================================================================
6   !! History :
7   !!   NEMO         3.4  ! 2012-03 First version by S. Alderson
8   !!                     !         Heavily derived from Christian's dtadyn routine
9   !!                     !         in OFF_SRC
10   !!----------------------------------------------------------------------
11
12   !!----------------------------------------------------------------------
13   !!   sbc_ssm_init : initialization, namelist read, and SAVEs control
14   !!   sbc_ssm      : Interpolation of the fields
15   !!----------------------------------------------------------------------
16   USE oce             ! ocean dynamics and tracers variables
17   USE c1d             ! 1D configuration: lk_c1d
18   USE dom_oce         ! ocean domain: variables
19   USE zdf_oce         ! ocean vertical physics: variables
20   USE sbc_oce         ! surface module: variables
21   USE phycst          ! physical constants
22   USE eosbn2          ! equation of state - Brunt Vaisala frequency
23   USE lbclnk          ! ocean lateral boundary conditions (or mpp link)
24   USE zpshde          ! z-coord. with partial steps: horizontal derivatives
25   USE in_out_manager  ! I/O manager
26   USE iom             ! I/O library
27   USE lib_mpp         ! distributed memory computing library
28   USE prtctl          ! print control
29   USE fldread         ! read input fields
30   USE timing          ! Timing
31
32   IMPLICIT NONE
33   PRIVATE
34
35   PUBLIC   sbc_ssm_init   ! called by sbc_init
36   PUBLIC   sbc_ssm        ! called by sbc
37
38   CHARACTER(len=100)   ::   cn_dir        !: Root directory for location of ssm files
39   LOGICAL              ::   ln_3d_uve     !: specify whether input velocity data is 3D
40   LOGICAL              ::   ln_read_frq   !: specify whether we must read frq or not
41   LOGICAL              ::   l_sasread     !: Ice intilisation: read a file (.TRUE.) or anaytical initilaistion in namelist &namsbc_sas
42   LOGICAL              ::   l_initdone = .false.
43   INTEGER     ::   nfld_3d
44   INTEGER     ::   nfld_2d
45
46   INTEGER     ::   jf_tem         ! index of temperature
47   INTEGER     ::   jf_sal         ! index of salinity
48   INTEGER     ::   jf_usp         ! index of u velocity component
49   INTEGER     ::   jf_vsp         ! index of v velocity component
50   INTEGER     ::   jf_ssh         ! index of sea surface height
51   INTEGER     ::   jf_e3t         ! index of first T level thickness
52   INTEGER     ::   jf_frq         ! index of fraction of qsr absorbed in the 1st T level
53
54   TYPE(FLD), ALLOCATABLE, DIMENSION(:) :: sf_ssm_3d  ! structure of input fields (file information, fields read)
55   TYPE(FLD), ALLOCATABLE, DIMENSION(:) :: sf_ssm_2d  ! structure of input fields (file information, fields read)
56
57   !!----------------------------------------------------------------------
58   !! NEMO/OFF 3.3 , NEMO Consortium (2010)
59   !! $Id$
60   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
61   !!----------------------------------------------------------------------
62CONTAINS
63
64   SUBROUTINE sbc_ssm( kt )
65      !!----------------------------------------------------------------------
66      !!                  ***  ROUTINE sbc_ssm  ***
67      !!
68      !! ** Purpose :  Prepares dynamics and physics fields from a NEMO run
69      !!               for an off-line simulation using surface processes only
70      !!
71      !! ** Method : calculates the position of data
72      !!             - interpolates data if needed
73      !!----------------------------------------------------------------------
74      !
75      INTEGER, INTENT(in) ::   kt   ! ocean time-step index
76      !
77      INTEGER  ::   ji, jj     ! dummy loop indices
78      REAL(wp) ::   ztinta     ! ratio applied to after  records when doing time interpolation
79      REAL(wp) ::   ztintb     ! ratio applied to before records when doing time interpolation
80      !!----------------------------------------------------------------------
81     
82      !
83      IF( nn_timing == 1 )  CALL timing_start( 'sbc_ssm')
84
85  IF ( l_sasread ) THEN
86      IF( nfld_3d > 0 ) CALL fld_read( kt, 1, sf_ssm_3d )      !==   read data at kt time step   ==!
87      IF( nfld_2d > 0 ) CALL fld_read( kt, 1, sf_ssm_2d )      !==   read data at kt time step   ==!
88      !
89      IF( ln_3d_uve ) THEN
90         ssu_m(:,:) = sf_ssm_3d(jf_usp)%fnow(:,:,1) * umask(:,:,1)    ! u-velocity
91         ssv_m(:,:) = sf_ssm_3d(jf_vsp)%fnow(:,:,1) * vmask(:,:,1)    ! v-velocity
92         IF( lk_vvl )   e3t_m(:,:) = sf_ssm_3d(jf_e3t)%fnow(:,:,1) * tmask(:,:,1)    ! v-velocity
93      ELSE
94         ssu_m(:,:) = sf_ssm_2d(jf_usp)%fnow(:,:,1) * umask(:,:,1)    ! u-velocity
95         ssv_m(:,:) = sf_ssm_2d(jf_vsp)%fnow(:,:,1) * vmask(:,:,1)    ! v-velocity
96         IF( lk_vvl )   e3t_m(:,:) = sf_ssm_2d(jf_e3t)%fnow(:,:,1) * tmask(:,:,1)    ! v-velocity
97      ENDIF
98      !
99      sst_m(:,:) = sf_ssm_2d(jf_tem)%fnow(:,:,1) * tmask(:,:,1)    ! temperature
100      sss_m(:,:) = sf_ssm_2d(jf_sal)%fnow(:,:,1) * tmask(:,:,1)    ! salinity
101      ssh_m(:,:) = sf_ssm_2d(jf_ssh)%fnow(:,:,1) * tmask(:,:,1)    ! sea surface height
102      IF( ln_read_frq )   frq_m(:,:) = sf_ssm_2d(jf_frq)%fnow(:,:,1) * tmask(:,:,1)    ! sea surface height
103
104   ELSE
105      sst_m(:,:) = 0.
106      sss_m(:,:) = 0.
107      ssu_m(:,:) = 0.
108      ssv_m(:,:) = 0.
109      ssh_m(:,:) = 0.
110   ENDIF
111      !
112      IF ( nn_ice == 1 ) THEN
113         tsn(:,:,1,jp_tem) = sst_m(:,:)
114         tsn(:,:,1,jp_sal) = sss_m(:,:)
115         tsb(:,:,1,jp_tem) = sst_m(:,:)
116         tsb(:,:,1,jp_sal) = sss_m(:,:)
117      ENDIF
118      ub (:,:,1) = ssu_m(:,:)
119      vb (:,:,1) = ssv_m(:,:)
120
121      IF(ln_ctl) THEN                  ! print control
122         CALL prt_ctl(tab2d_1=sst_m, clinfo1=' sst_m   - : ', mask1=tmask, ovlap=1   )
123         CALL prt_ctl(tab2d_1=sss_m, clinfo1=' sss_m   - : ', mask1=tmask, ovlap=1   )
124         CALL prt_ctl(tab2d_1=ssu_m, clinfo1=' ssu_m   - : ', mask1=umask, ovlap=1   )
125         CALL prt_ctl(tab2d_1=ssv_m, clinfo1=' ssv_m   - : ', mask1=vmask, ovlap=1   )
126         CALL prt_ctl(tab2d_1=ssh_m, clinfo1=' ssh_m   - : ', mask1=tmask, ovlap=1   )
127         IF( lk_vvl      )   CALL prt_ctl(tab2d_1=ssh_m, clinfo1=' e3t_m   - : ', mask1=tmask, ovlap=1   )
128         IF( ln_read_frq )   CALL prt_ctl(tab2d_1=frq_m, clinfo1=' frq_m   - : ', mask1=tmask, ovlap=1   )
129      ENDIF
130      !
131      IF( l_initdone ) THEN          !   Mean value at each nn_fsbc time-step   !
132         CALL iom_put( 'ssu_m', ssu_m )
133         CALL iom_put( 'ssv_m', ssv_m )
134         CALL iom_put( 'sst_m', sst_m )
135         CALL iom_put( 'sss_m', sss_m )
136         CALL iom_put( 'ssh_m', ssh_m )
137         IF( lk_vvl      )   CALL iom_put( 'e3t_m', e3t_m )
138         IF( ln_read_frq )   CALL iom_put( 'frq_m', frq_m )
139      ENDIF
140      !
141      IF( nn_timing == 1 )  CALL timing_stop( 'sbc_ssm')
142      !
143   END SUBROUTINE sbc_ssm
144
145
146   SUBROUTINE sbc_ssm_init
147      !!----------------------------------------------------------------------
148      !!                  ***  ROUTINE sbc_ssm_init  ***
149      !!
150      !! ** Purpose :   Initialisation of the dynamical data     
151      !! ** Method  : - read the data namsbc_ssm namelist
152      !!
153      !! ** Action  : - read parameters
154      !!----------------------------------------------------------------------
155      INTEGER  :: ierr, ierr0, ierr1, ierr2, ierr3   ! return error code
156      INTEGER  :: ifpr                               ! dummy loop indice
157      INTEGER  :: inum, idv, idimv, jpm              ! local integer
158      INTEGER  ::   ios                              ! Local integer output status for namelist read
159      !!
160      CHARACTER(len=100)                     ::  cn_dir       ! Root directory for location of core files
161      TYPE(FLD_N), ALLOCATABLE, DIMENSION(:) ::  slf_3d       ! array of namelist information on the fields to read
162      TYPE(FLD_N), ALLOCATABLE, DIMENSION(:) ::  slf_2d       ! array of namelist information on the fields to read
163      TYPE(FLD_N) :: sn_tem, sn_sal                     ! information about the fields to be read
164      TYPE(FLD_N) :: sn_usp, sn_vsp
165      TYPE(FLD_N) :: sn_ssh, sn_e3t, sn_frq
166      !
167      NAMELIST/namsbc_sas/l_sasread, cn_dir, ln_3d_uve, ln_read_frq, sn_tem, sn_sal, sn_usp, sn_vsp, sn_ssh, sn_e3t, sn_frq
168      !!----------------------------------------------------------------------
169
170      IF( ln_rstart .AND. nn_components == jp_iam_sas ) RETURN
171     
172      REWIND( numnam_ref )              ! Namelist namsbc_sas in reference namelist : Input fields
173      READ  ( numnam_ref, namsbc_sas, IOSTAT = ios, ERR = 901)
174901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc_sas in reference namelist', lwp )
175
176      REWIND( numnam_cfg )              ! Namelist namsbc_sas in configuration namelist : Input fields
177      READ  ( numnam_cfg, namsbc_sas, IOSTAT = ios, ERR = 902 )
178902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc_sas in configuration namelist', lwp )
179      IF(lwm) WRITE ( numond, namsbc_sas )
180
181      !                                         ! store namelist information in an array
182      !                                         ! Control print
183      IF(lwp) THEN
184         WRITE(numout,*)
185         WRITE(numout,*) 'sbc_sas : standalone surface scheme '
186         WRITE(numout,*) '~~~~~~~~~~~ '
187         WRITE(numout,*) '   Namelist namsbc_sas'
188         WRITE(numout,*) '      Initialisation using an input file  = ',l_sasread 
189         WRITE(numout,*) '      Are we supplying a 3D u,v and e3 field                             ln_3d_uve   = ', ln_3d_uve
190         WRITE(numout,*) '      Are we reading frq (fraction of qsr absorbed in the 1st T level)   ln_read_frq = ', ln_read_frq
191         WRITE(numout,*)
192      ENDIF
193      !
194      !! switch off stuff that isn't sensible with a standalone module
195      !! note that we need sbc_ssm called first in sbc
196      !
197      IF( ln_apr_dyn ) THEN
198         IF( lwp ) WRITE(numout,*) 'No atmospheric gradient needed with StandAlone Surface scheme'
199         ln_apr_dyn = .FALSE.
200      ENDIF
201      IF( ln_rnf ) THEN
202         IF( lwp ) WRITE(numout,*) 'No runoff needed with StandAlone Surface scheme'
203         ln_rnf = .FALSE.
204      ENDIF
205      IF( ln_ssr ) THEN
206         IF( lwp ) WRITE(numout,*) 'No surface relaxation needed with StandAlone Surface scheme'
207         ln_ssr = .FALSE.
208      ENDIF
209      IF( nn_fwb > 0 ) THEN
210         IF( lwp ) WRITE(numout,*) 'No freshwater budget adjustment needed with StandAlone Surface scheme'
211         nn_fwb = 0
212      ENDIF
213      IF( nn_closea > 0 ) THEN
214         IF( lwp ) WRITE(numout,*) 'No closed seas adjustment needed with StandAlone Surface scheme'
215         nn_closea = 0
216      ENDIF
217      IF (l_sasread) THEN
218      !
219      !! following code is a bit messy, but distinguishes between when u,v are 3d arrays and
220      !! when we have other 3d arrays that we need to read in
221      !! so if a new field is added i.e. jf_new, just give it the next integer in sequence
222      !! for the corresponding dimension (currently if ln_3d_uve is true, 4 for 2d and 3 for 3d,
223      !! alternatively if ln_3d_uve is false, 6 for 2d and 1 for 3d), reset nfld_3d, nfld_2d,
224      !! and the rest of the logic should still work
225      !
226      jf_tem = 1 ; jf_sal = 2 ; jf_ssh = 3 ; jf_frq = 4   ! default 2D fields index
227      !
228      IF( ln_3d_uve ) THEN
229         jf_usp = 1 ; jf_vsp = 2 ; jf_e3t = 3      ! define 3D fields index
230         nfld_3d  = 2 + COUNT( (/lk_vvl/) )        ! number of 3D fields to read
231         nfld_2d  = 3 + COUNT( (/ln_read_frq/) )   ! number of 2D fields to read
232      ELSE
233         jf_usp = 4 ; jf_vsp = 5 ; jf_e3t = 6 ; jf_frq = 6 + COUNT( (/lk_vvl/) )   ! update 2D fields index
234         nfld_3d  = 0                                                              ! no 3D fields to read
235         nfld_2d  = 5 + COUNT( (/lk_vvl/) ) + COUNT( (/ln_read_frq/) )             ! number of 2D fields to read
236      ENDIF
237
238      IF( nfld_3d > 0 ) THEN
239         ALLOCATE( slf_3d(nfld_3d), STAT=ierr )         ! set slf structure
240         IF( ierr > 0 ) THEN
241            CALL ctl_stop( 'sbc_ssm_init: unable to allocate slf 3d structure' )   ;   RETURN
242         ENDIF
243         slf_3d(jf_usp) = sn_usp
244         slf_3d(jf_vsp) = sn_vsp
245         IF( lk_vvl )   slf_3d(jf_e3t) = sn_e3t
246      ENDIF
247
248      IF( nfld_2d > 0 ) THEN
249         ALLOCATE( slf_2d(nfld_2d), STAT=ierr )         ! set slf structure
250         IF( ierr > 0 ) THEN
251            CALL ctl_stop( 'sbc_ssm_init: unable to allocate slf 2d structure' )   ;   RETURN
252         ENDIF
253         slf_2d(jf_tem) = sn_tem ; slf_2d(jf_sal) = sn_sal ; slf_2d(jf_ssh) = sn_ssh
254         IF( ln_read_frq )   slf_2d(jf_frq) = sn_frq
255         IF( .NOT. ln_3d_uve ) THEN
256            slf_2d(jf_usp) = sn_usp ; slf_2d(jf_vsp) = sn_vsp
257            IF( lk_vvl )   slf_2d(jf_e3t) = sn_e3t
258         ENDIF
259      ENDIF
260      !
261      ierr1 = 0    ! default definition if slf_?d(ifpr)%ln_tint = .false.
262      IF( nfld_3d > 0 ) THEN
263         ALLOCATE( sf_ssm_3d(nfld_3d), STAT=ierr )         ! set sf structure
264         IF( ierr > 0 ) THEN
265            CALL ctl_stop( 'sbc_ssm_init: unable to allocate sf structure' )   ;   RETURN
266         ENDIF
267         DO ifpr = 1, nfld_3d
268                                       ALLOCATE( sf_ssm_3d(ifpr)%fnow(jpi,jpj,jpk)    , STAT=ierr0 )
269            IF( slf_3d(ifpr)%ln_tint ) ALLOCATE( sf_ssm_3d(ifpr)%fdta(jpi,jpj,jpk,2)  , STAT=ierr1 )
270            IF( ierr0 + ierr1 > 0 ) THEN
271               CALL ctl_stop( 'sbc_ssm_init : unable to allocate sf_ssm_3d array structure' )   ;   RETURN
272            ENDIF
273         END DO
274         !                                         ! fill sf with slf_i and control print
275         CALL fld_fill( sf_ssm_3d, slf_3d, cn_dir, 'sbc_ssm_init', '3D Data in file', 'namsbc_ssm' )
276      ENDIF
277
278      IF( nfld_2d > 0 ) THEN
279         ALLOCATE( sf_ssm_2d(nfld_2d), STAT=ierr )         ! set sf structure
280         IF( ierr > 0 ) THEN
281            CALL ctl_stop( 'sbc_ssm_init: unable to allocate sf 2d structure' )   ;   RETURN
282         ENDIF
283         DO ifpr = 1, nfld_2d
284                                       ALLOCATE( sf_ssm_2d(ifpr)%fnow(jpi,jpj,1)    , STAT=ierr0 )
285            IF( slf_2d(ifpr)%ln_tint ) ALLOCATE( sf_ssm_2d(ifpr)%fdta(jpi,jpj,1,2)  , STAT=ierr1 )
286            IF( ierr0 + ierr1 > 0 ) THEN
287               CALL ctl_stop( 'sbc_ssm_init : unable to allocate sf_ssm_2d array structure' )   ;   RETURN
288            ENDIF
289         END DO
290         !
291         CALL fld_fill( sf_ssm_2d, slf_2d, cn_dir, 'sbc_ssm_init', '2D Data in file', 'namsbc_ssm' )
292      ENDIF
293      !
294      ! finally tidy up
295
296      IF( nfld_3d > 0 ) DEALLOCATE( slf_3d, STAT=ierr )
297      IF( nfld_2d > 0 ) DEALLOCATE( slf_2d, STAT=ierr )
298
299   ENDIF
300 
301      CALL sbc_ssm( nit000 )   ! need to define ss?_m arrays used in limistate
302      IF( .NOT. ln_read_frq )   frq_m(:,:) = 1.
303      l_initdone = .TRUE.   
304      !
305   END SUBROUTINE sbc_ssm_init
306
307   !!======================================================================
308END MODULE sbcssm
Note: See TracBrowser for help on using the repository browser.