source: branches/2017/dev_r8183_ICEMODEL/NEMOGCM/NEMO/SAS_SRC/sbcssm.F90 @ 8291

Last change on this file since 8291 was 8291, checked in by clem, 4 years ago

correct last commit changes. This is the start version for the modifications of the ice model. All sette tests passed except restartability for agrif and sas (though sas_biper is restartable). Configurations CREG, SPITZ, FER & SASBIPER are running.

  • Property svn:keywords set to Id
File size: 15.5 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            IF( .NOT. ln_linssh ) THEN
91               e3t_m(:,:) = sf_ssm_3d(jf_e3t)%fnow(:,:,1) * tmask(:,:,1) ! vertical scale factor
92            ELSE
93               e3t_m(:,:) = e3t_0(:,:,1)                                 ! vertical scale factor
94            ENDIF
95            ssu_m(:,:) = sf_ssm_3d(jf_usp)%fnow(:,:,1) * umask(:,:,1)    ! u-velocity
96            ssv_m(:,:) = sf_ssm_3d(jf_vsp)%fnow(:,:,1) * vmask(:,:,1)    ! v-velocity
97         ELSE
98            IF( .NOT. ln_linssh ) THEN
99               e3t_m(:,:) = sf_ssm_2d(jf_e3t)%fnow(:,:,1) * tmask(:,:,1) ! vertical scale factor
100            ELSE
101               e3t_m(:,:) = e3t_0(:,:,1)                                 ! vertical scale factor
102            ENDIF
103            ssu_m(:,:) = sf_ssm_2d(jf_usp)%fnow(:,:,1) * umask(:,:,1)    ! u-velocity
104            ssv_m(:,:) = sf_ssm_2d(jf_vsp)%fnow(:,:,1) * vmask(:,:,1)    ! v-velocity
105         ENDIF
106         !
107         sst_m(:,:) = sf_ssm_2d(jf_tem)%fnow(:,:,1) * tmask(:,:,1)    ! temperature
108         sss_m(:,:) = sf_ssm_2d(jf_sal)%fnow(:,:,1) * tmask(:,:,1)    ! salinity
109         ssh_m(:,:) = sf_ssm_2d(jf_ssh)%fnow(:,:,1) * tmask(:,:,1)    ! sea surface height
110         IF( ln_read_frq ) THEN
111            frq_m(:,:) = sf_ssm_2d(jf_frq)%fnow(:,:,1) * tmask(:,:,1) ! solar penetration
112         ELSE
113            frq_m(:,:) = 1._wp
114         ENDIF
115      ELSE
116         sst_m(:,:) = 0._wp
117         sss_m(:,:) = 35._wp
118         ssu_m(:,:) = 0._wp
119         ssv_m(:,:) = 0._wp
120         ssh_m(:,:) = 0._wp
121         IF( .NOT. ln_linssh ) e3t_m(:,:) = e3t_0(:,:,1) !clem: necessary at least for sas2D
122         frq_m(:,:) = 1._wp                              !              - -
123         sshn (:,:) = 0._wp                              !              - -
124      ENDIF
125     
126      IF ( nn_ice == 1 ) THEN
127         tsn(:,:,1,jp_tem) = sst_m(:,:)
128         tsn(:,:,1,jp_sal) = sss_m(:,:)
129         tsb(:,:,1,jp_tem) = sst_m(:,:)
130         tsb(:,:,1,jp_sal) = sss_m(:,:)
131      ENDIF
132      ub (:,:,1) = ssu_m(:,:)
133      vb (:,:,1) = ssv_m(:,:)
134 
135      IF(ln_ctl) THEN                  ! print control
136         CALL prt_ctl(tab2d_1=sst_m, clinfo1=' sst_m   - : ', mask1=tmask, ovlap=1   )
137         CALL prt_ctl(tab2d_1=sss_m, clinfo1=' sss_m   - : ', mask1=tmask, ovlap=1   )
138         CALL prt_ctl(tab2d_1=ssu_m, clinfo1=' ssu_m   - : ', mask1=umask, ovlap=1   )
139         CALL prt_ctl(tab2d_1=ssv_m, clinfo1=' ssv_m   - : ', mask1=vmask, ovlap=1   )
140         CALL prt_ctl(tab2d_1=ssh_m, clinfo1=' ssh_m   - : ', mask1=tmask, ovlap=1   )
141         IF( .NOT.ln_linssh )   CALL prt_ctl(tab2d_1=ssh_m, clinfo1=' e3t_m   - : ', mask1=tmask, ovlap=1   )
142         IF( ln_read_frq    )   CALL prt_ctl(tab2d_1=frq_m, clinfo1=' frq_m   - : ', mask1=tmask, ovlap=1   )
143      ENDIF
144      !
145      IF( l_initdone ) THEN          !   Mean value at each nn_fsbc time-step   !
146         CALL iom_put( 'ssu_m', ssu_m )
147         CALL iom_put( 'ssv_m', ssv_m )
148         CALL iom_put( 'sst_m', sst_m )
149         CALL iom_put( 'sss_m', sss_m )
150         CALL iom_put( 'ssh_m', ssh_m )
151         IF( .NOT.ln_linssh )   CALL iom_put( 'e3t_m', e3t_m )
152         IF( ln_read_frq    )   CALL iom_put( 'frq_m', frq_m )
153      ENDIF
154      !
155      IF( nn_timing == 1 )  CALL timing_stop( 'sbc_ssm')
156      !
157   END SUBROUTINE sbc_ssm
158
159
160   SUBROUTINE sbc_ssm_init
161      !!----------------------------------------------------------------------
162      !!                  ***  ROUTINE sbc_ssm_init  ***
163      !!
164      !! ** Purpose :   Initialisation of the dynamical data     
165      !! ** Method  : - read the data namsbc_ssm namelist
166      !!
167      !! ** Action  : - read parameters
168      !!----------------------------------------------------------------------
169      INTEGER  :: ierr, ierr0, ierr1, ierr2, ierr3   ! return error code
170      INTEGER  :: ifpr                               ! dummy loop indice
171      INTEGER  :: inum, idv, idimv, jpm              ! local integer
172      INTEGER  ::   ios                              ! Local integer output status for namelist read
173      !!
174      CHARACTER(len=100)                     ::  cn_dir       ! Root directory for location of core files
175      TYPE(FLD_N), ALLOCATABLE, DIMENSION(:) ::  slf_3d       ! array of namelist information on the fields to read
176      TYPE(FLD_N), ALLOCATABLE, DIMENSION(:) ::  slf_2d       ! array of namelist information on the fields to read
177      TYPE(FLD_N) :: sn_tem, sn_sal                     ! information about the fields to be read
178      TYPE(FLD_N) :: sn_usp, sn_vsp
179      TYPE(FLD_N) :: sn_ssh, sn_e3t, sn_frq
180      !
181      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
182      !!----------------------------------------------------------------------
183
184      IF( ln_rstart .AND. nn_components == jp_iam_sas ) RETURN
185     
186      REWIND( numnam_ref )              ! Namelist namsbc_sas in reference namelist : Input fields
187      READ  ( numnam_ref, namsbc_sas, IOSTAT = ios, ERR = 901)
188901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc_sas in reference namelist', lwp )
189
190      REWIND( numnam_cfg )              ! Namelist namsbc_sas in configuration namelist : Input fields
191      READ  ( numnam_cfg, namsbc_sas, IOSTAT = ios, ERR = 902 )
192902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc_sas in configuration namelist', lwp )
193      IF(lwm) WRITE ( numond, namsbc_sas )
194
195      !                                         ! store namelist information in an array
196      !                                         ! Control print
197      IF(lwp) THEN
198         WRITE(numout,*)
199         WRITE(numout,*) 'sbc_sas : standalone surface scheme '
200         WRITE(numout,*) '~~~~~~~~~~~ '
201         WRITE(numout,*) '   Namelist namsbc_sas'
202         WRITE(numout,*) '      Initialisation using an input file  = ',l_sasread 
203         WRITE(numout,*) '      Are we supplying a 3D u,v and e3 field                             ln_3d_uve   = ', ln_3d_uve
204         WRITE(numout,*) '      Are we reading frq (fraction of qsr absorbed in the 1st T level)   ln_read_frq = ', ln_read_frq
205         WRITE(numout,*)
206      ENDIF
207      !
208      !! switch off stuff that isn't sensible with a standalone module
209      !! note that we need sbc_ssm called first in sbc
210      !
211      IF( ln_apr_dyn ) THEN
212         IF( lwp ) WRITE(numout,*) 'No atmospheric gradient needed with StandAlone Surface scheme'
213         ln_apr_dyn = .FALSE.
214      ENDIF
215      IF( ln_rnf ) THEN
216         IF( lwp ) WRITE(numout,*) 'No runoff needed with StandAlone Surface scheme'
217         ln_rnf = .FALSE.
218      ENDIF
219      IF( ln_ssr ) THEN
220         IF( lwp ) WRITE(numout,*) 'No surface relaxation needed with StandAlone Surface scheme'
221         ln_ssr = .FALSE.
222      ENDIF
223      IF( nn_fwb > 0 ) THEN
224         IF( lwp ) WRITE(numout,*) 'No freshwater budget adjustment needed with StandAlone Surface scheme'
225         nn_fwb = 0
226      ENDIF
227      IF( nn_closea > 0 ) THEN
228         IF( lwp ) WRITE(numout,*) 'No closed seas adjustment needed with StandAlone Surface scheme'
229         nn_closea = 0
230      ENDIF
231      IF (l_sasread) THEN
232      !
233      !! following code is a bit messy, but distinguishes between when u,v are 3d arrays and
234      !! when we have other 3d arrays that we need to read in
235      !! so if a new field is added i.e. jf_new, just give it the next integer in sequence
236      !! for the corresponding dimension (currently if ln_3d_uve is true, 4 for 2d and 3 for 3d,
237      !! alternatively if ln_3d_uve is false, 6 for 2d and 1 for 3d), reset nfld_3d, nfld_2d,
238      !! and the rest of the logic should still work
239      !
240      jf_tem = 1 ; jf_sal = 2 ; jf_ssh = 3 ; jf_frq = 4   ! default 2D fields index
241      !
242      IF( ln_3d_uve ) THEN
243         jf_usp = 1 ; jf_vsp = 2 ; jf_e3t = 3      ! define 3D fields index
244         nfld_3d  = 2 + COUNT( (/.NOT.ln_linssh/) )        ! number of 3D fields to read
245         nfld_2d  = 3 + COUNT( (/ln_read_frq/) )   ! number of 2D fields to read
246      ELSE
247         jf_usp = 4 ; jf_vsp = 5 ; jf_e3t = 6 ; jf_frq = 6 + COUNT( (/.NOT.ln_linssh/) )   ! update 2D fields index
248         nfld_3d  = 0                                                              ! no 3D fields to read
249         nfld_2d  = 5 + COUNT( (/.NOT.ln_linssh/) ) + COUNT( (/ln_read_frq/) )             ! number of 2D fields to read
250      ENDIF
251
252      IF( nfld_3d > 0 ) THEN
253         ALLOCATE( slf_3d(nfld_3d), STAT=ierr )         ! set slf structure
254         IF( ierr > 0 ) THEN
255            CALL ctl_stop( 'sbc_ssm_init: unable to allocate slf 3d structure' )   ;   RETURN
256         ENDIF
257         slf_3d(jf_usp) = sn_usp
258         slf_3d(jf_vsp) = sn_vsp
259         IF( .NOT.ln_linssh )   slf_3d(jf_e3t) = sn_e3t
260      ENDIF
261
262      IF( nfld_2d > 0 ) THEN
263         ALLOCATE( slf_2d(nfld_2d), STAT=ierr )         ! set slf structure
264         IF( ierr > 0 ) THEN
265            CALL ctl_stop( 'sbc_ssm_init: unable to allocate slf 2d structure' )   ;   RETURN
266         ENDIF
267         slf_2d(jf_tem) = sn_tem ; slf_2d(jf_sal) = sn_sal ; slf_2d(jf_ssh) = sn_ssh
268         IF( ln_read_frq )   slf_2d(jf_frq) = sn_frq
269         IF( .NOT. ln_3d_uve ) THEN
270            slf_2d(jf_usp) = sn_usp ; slf_2d(jf_vsp) = sn_vsp
271            IF( .NOT.ln_linssh )   slf_2d(jf_e3t) = sn_e3t
272         ENDIF
273      ENDIF
274      !
275      ierr1 = 0    ! default definition if slf_?d(ifpr)%ln_tint = .false.
276      IF( nfld_3d > 0 ) THEN
277         ALLOCATE( sf_ssm_3d(nfld_3d), STAT=ierr )         ! set sf structure
278         IF( ierr > 0 ) THEN
279            CALL ctl_stop( 'sbc_ssm_init: unable to allocate sf structure' )   ;   RETURN
280         ENDIF
281         DO ifpr = 1, nfld_3d
282                                       ALLOCATE( sf_ssm_3d(ifpr)%fnow(jpi,jpj,jpk)    , STAT=ierr0 )
283            IF( slf_3d(ifpr)%ln_tint ) ALLOCATE( sf_ssm_3d(ifpr)%fdta(jpi,jpj,jpk,2)  , STAT=ierr1 )
284            IF( ierr0 + ierr1 > 0 ) THEN
285               CALL ctl_stop( 'sbc_ssm_init : unable to allocate sf_ssm_3d array structure' )   ;   RETURN
286            ENDIF
287         END DO
288         !                                         ! fill sf with slf_i and control print
289         CALL fld_fill( sf_ssm_3d, slf_3d, cn_dir, 'sbc_ssm_init', '3D Data in file', 'namsbc_ssm' )
290      ENDIF
291
292      IF( nfld_2d > 0 ) THEN
293         ALLOCATE( sf_ssm_2d(nfld_2d), STAT=ierr )         ! set sf structure
294         IF( ierr > 0 ) THEN
295            CALL ctl_stop( 'sbc_ssm_init: unable to allocate sf 2d structure' )   ;   RETURN
296         ENDIF
297         DO ifpr = 1, nfld_2d
298                                       ALLOCATE( sf_ssm_2d(ifpr)%fnow(jpi,jpj,1)    , STAT=ierr0 )
299            IF( slf_2d(ifpr)%ln_tint ) ALLOCATE( sf_ssm_2d(ifpr)%fdta(jpi,jpj,1,2)  , STAT=ierr1 )
300            IF( ierr0 + ierr1 > 0 ) THEN
301               CALL ctl_stop( 'sbc_ssm_init : unable to allocate sf_ssm_2d array structure' )   ;   RETURN
302            ENDIF
303         END DO
304         !
305         CALL fld_fill( sf_ssm_2d, slf_2d, cn_dir, 'sbc_ssm_init', '2D Data in file', 'namsbc_ssm' )
306      ENDIF
307      !
308      ! finally tidy up
309
310      IF( nfld_3d > 0 ) DEALLOCATE( slf_3d, STAT=ierr )
311      IF( nfld_2d > 0 ) DEALLOCATE( slf_2d, STAT=ierr )
312
313   ENDIF
314 
315      CALL sbc_ssm( nit000 )   ! need to define ss?_m arrays used in limistate
316      l_initdone = .TRUE.
317      !
318   END SUBROUTINE sbc_ssm_init
319
320   !!======================================================================
321END MODULE sbcssm
Note: See TracBrowser for help on using the repository browser.