source: NEMO/branches/2020/dev_r12377_KERNEL-06_techene_e3/src/OCE/DOM/istate.F90 @ 12732

Last change on this file since 12732 was 12732, checked in by techene, 11 months ago

some cleaning and proper module/routine name, mini bug introduced and corrected in sbcice_cice

  • Property svn:keywords set to Id
File size: 8.9 KB
Line 
1MODULE istate
2   !!======================================================================
3   !!                     ***  MODULE  istate  ***
4   !! Ocean state   :  initial state setting
5   !!=====================================================================
6   !! History :  OPA  !  1989-12  (P. Andrich)  Original code
7   !!            5.0  !  1991-11  (G. Madec)  rewritting
8   !!            6.0  !  1996-01  (G. Madec)  terrain following coordinates
9   !!            8.0  !  2001-09  (M. Levy, M. Ben Jelloul)  istate_eel
10   !!            8.0  !  2001-09  (M. Levy, M. Ben Jelloul)  istate_uvg
11   !!   NEMO     1.0  !  2003-08  (G. Madec, C. Talandier)  F90: Free form, modules + EEL R5
12   !!             -   !  2004-05  (A. Koch-Larrouy)  istate_gyre
13   !!            2.0  !  2006-07  (S. Masson)  distributed restart using iom
14   !!            3.3  !  2010-10  (C. Ethe) merge TRC-TRA
15   !!            3.4  !  2011-04  (G. Madec) Merge of dtatem and dtasal & suppression of tb,tn/sb,sn
16   !!            3.7  !  2016-04  (S. Flavoni) introduce user defined initial state
17   !!----------------------------------------------------------------------
18
19   !!----------------------------------------------------------------------
20   !!   istate_init   : initial state setting
21   !!   istate_uvg    : initial velocity in geostropic balance
22   !!----------------------------------------------------------------------
23   USE oce            ! ocean dynamics and active tracers
24   USE dom_oce        ! ocean space and time domain
25   USE daymod         ! calendar
26   USE divhor         ! horizontal divergence            (div_hor routine)
27   USE dtatsd         ! data temperature and salinity   (dta_tsd routine)
28   USE dtauvd         ! data: U & V current             (dta_uvd routine)
29   USE domvvl          ! varying vertical mesh
30   USE wet_dry         ! wetting and drying (needed for wad_istate)
31   USE usrdef_istate   ! User defined initial state
32   !
33   USE in_out_manager  ! I/O manager
34   USE iom             ! I/O library
35   USE lib_mpp         ! MPP library
36   USE restart         ! restart
37
38   IMPLICIT NONE
39   PRIVATE
40
41   PUBLIC   istate_init   ! routine called by step.F90
42
43   !! * Substitutions
44#  include "do_loop_substitute.h90"
45#  include "domzgr_substitute.h90"
46   !!----------------------------------------------------------------------
47   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
48   !! $Id$
49   !! Software governed by the CeCILL license (see ./LICENSE)
50   !!----------------------------------------------------------------------
51CONTAINS
52
53   SUBROUTINE istate_init( Kbb, Kmm, Kaa )
54      !!----------------------------------------------------------------------
55      !!                   ***  ROUTINE istate_init  ***
56      !!
57      !! ** Purpose :   Initialization of the dynamics and tracer fields.
58      !!----------------------------------------------------------------------
59      INTEGER, INTENT( in )  ::  Kbb, Kmm, Kaa   ! ocean time level indices
60      !
61      INTEGER ::   ji, jj, jk   ! dummy loop indices
62      REAL(wp), DIMENSION(jpi,jpj,jpk) ::   zgdept     ! 3D table  !!st patch to use gdept subtitute
63!!gm see comment further down
64      REAL(wp), ALLOCATABLE, DIMENSION(:,:,:,:) ::   zuvd    ! U & V data workspace
65!!gm end
66      !!----------------------------------------------------------------------
67      !
68      IF(lwp) WRITE(numout,*)
69      IF(lwp) WRITE(numout,*) 'istate_init : Initialization of the dynamics and tracers'
70      IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
71
72!!gm  Why not include in the first call of dta_tsd ? 
73!!gm  probably associated with the use of internal damping...
74                     CALL dta_tsd_init        ! Initialisation of T & S input data
75!!gm to be moved in usrdef of C1D case
76!      IF( lk_c1d )   CALL dta_uvd_init        ! Initialization of U & V input data
77!!gm
78
79      rhd  (:,:,:  ) = 0._wp   ;   rhop (:,:,:  ) = 0._wp      ! set one for all to 0 at level jpk
80      rn2b (:,:,:  ) = 0._wp   ;   rn2  (:,:,:  ) = 0._wp      ! set one for all to 0 at levels 1 and jpk
81      ts  (:,:,:,:,Kaa) = 0._wp                                   ! set one for all to 0 at level jpk
82      rab_b(:,:,:,:) = 0._wp   ;   rab_n(:,:,:,:) = 0._wp      ! set one for all to 0 at level jpk
83#if defined key_agrif
84      uu   (:,:,:  ,Kaa) = 0._wp   ! used in agrif_oce_sponge at initialization
85      vv   (:,:,:  ,Kaa) = 0._wp   ! used in agrif_oce_sponge at initialization   
86#endif
87
88      IF( ln_rstart ) THEN                    ! Restart from a file
89         !                                    ! -------------------
90         CALL rst_read( Kbb, Kmm )            ! Read the restart file
91         CALL day_init                        ! model calendar (using both namelist and restart infos)
92         !
93      ELSE                                    ! Start from rest
94         !                                    ! ---------------
95         numror = 0                           ! define numror = 0 -> no restart file to read
96         l_1st_euler = .true.                 ! Set time-step indicator at nit000 (euler forward)
97         CALL day_init                        ! model calendar (using both namelist and restart infos)
98         !                                    ! Initialization of ocean to zero
99         !
100         IF( ln_tsd_init ) THEN               
101            CALL dta_tsd( nit000, ts(:,:,:,:,Kbb) )       ! read 3D T and S data at nit000
102            !
103            ssh(:,:,Kbb)   = 0._wp               ! set the ocean at rest
104            IF( ll_wd ) THEN
105               ssh(:,:,Kbb) =  -ssh_ref  ! Added in 30 here for bathy that adds 30 as Iterative test CEOD
106               !
107               ! Apply minimum wetdepth criterion
108               !
109               DO_2D_11_11
110                  IF( ht_0(ji,jj) + ssh(ji,jj,Kbb)  < rn_wdmin1 ) THEN
111                     ssh(ji,jj,Kbb) = tmask(ji,jj,1)*( rn_wdmin1 - (ht_0(ji,jj)) )
112                  ENDIF
113               END_2D
114            ENDIF
115            uu  (:,:,:,Kbb) = 0._wp
116            vv  (:,:,:,Kbb) = 0._wp 
117            !
118         ELSE                                 ! user defined initial T and S
119            DO jk = 1, jpkm1
120               zgdept(:,:,jk) = gdept(:,:,jk,Kbb)
121            END DO
122            CALL usr_def_istate( zgdept, tmask, ts(:,:,:,:,Kbb), uu(:,:,:,Kbb), vv(:,:,:,Kbb), ssh(:,:,Kbb)  )         
123         ENDIF
124         ts  (:,:,:,:,Kmm) = ts (:,:,:,:,Kbb)       ! set now values from to before ones
125         ssh (:,:,Kmm)     = ssh(:,:,Kbb)   
126         uu   (:,:,:,Kmm)   = uu  (:,:,:,Kbb)
127         vv   (:,:,:,Kmm)   = vv  (:,:,:,Kbb)
128         hdiv(:,:,jpk) = 0._wp               ! bottom divergence set one for 0 to zero at jpk level
129         CALL div_hor( 0, Kbb, Kmm )         ! compute interior hdiv value 
130!!gm                                    hdiv(:,:,:) = 0._wp
131
132!!gm POTENTIAL BUG :
133!!gm  ISSUE :  if ssh(:,:,Kbb) /= 0  then, in non linear free surface, the e3._n, e3._b should be recomputed
134!!             as well as gdept_ and gdepw_....   !!!!!
135!!      ===>>>>   probably a call to domvvl initialisation here....
136
137
138         !
139!!gm to be moved in usrdef of C1D case
140!         IF ( ln_uvd_init .AND. lk_c1d ) THEN ! read 3D U and V data at nit000
141!            ALLOCATE( zuvd(jpi,jpj,jpk,2) )
142!            CALL dta_uvd( nit000, zuvd )
143!            uu(:,:,:,Kbb) = zuvd(:,:,:,1) ;  uu(:,:,:,Kmm) = uu(:,:,:,Kbb)
144!            vv(:,:,:,Kbb) = zuvd(:,:,:,2) ;  vv(:,:,:,Kmm) = vv(:,:,:,Kbb)
145!            DEALLOCATE( zuvd )
146!         ENDIF
147         !
148!!gm This is to be changed !!!!
149!         ! - ML - ssh(:,:,Kmm) could be modified by istate_eel, so that initialization of e3t(:,:,:,Kbb) is done here
150!         IF( .NOT.ln_linssh ) THEN
151!            DO jk = 1, jpk
152!               e3t(:,:,jk,Kbb) = e3t(:,:,jk,Kmm)
153!            END DO
154!         ENDIF
155!!gm
156         !
157      ENDIF 
158      !
159      ! Initialize "now" and "before" barotropic velocities:
160      ! Do it whatever the free surface method, these arrays being eventually used
161      !
162      uu_b(:,:,Kmm) = 0._wp   ;   vv_b(:,:,Kmm) = 0._wp
163      uu_b(:,:,Kbb) = 0._wp   ;   vv_b(:,:,Kbb) = 0._wp
164      !
165!!gm  the use of umsak & vmask is not necessary below as uu(:,:,:,Kmm), vv(:,:,:,Kmm), uu(:,:,:,Kbb), vv(:,:,:,Kbb) are always masked
166      DO_3D_11_11( 1, jpkm1 )
167         uu_b(ji,jj,Kmm) = uu_b(ji,jj,Kmm) + e3u(ji,jj,jk,Kmm) * uu(ji,jj,jk,Kmm) * umask(ji,jj,jk)
168         vv_b(ji,jj,Kmm) = vv_b(ji,jj,Kmm) + e3v(ji,jj,jk,Kmm) * vv(ji,jj,jk,Kmm) * vmask(ji,jj,jk)
169         !
170         uu_b(ji,jj,Kbb) = uu_b(ji,jj,Kbb) + e3u(ji,jj,jk,Kbb) * uu(ji,jj,jk,Kbb) * umask(ji,jj,jk)
171         vv_b(ji,jj,Kbb) = vv_b(ji,jj,Kbb) + e3v(ji,jj,jk,Kbb) * vv(ji,jj,jk,Kbb) * vmask(ji,jj,jk)
172      END_3D
173      !
174      uu_b(:,:,Kmm) = uu_b(:,:,Kmm) * r1_hu(:,:,Kmm)
175      vv_b(:,:,Kmm) = vv_b(:,:,Kmm) * r1_hv(:,:,Kmm)
176      !
177      uu_b(:,:,Kbb) = uu_b(:,:,Kbb) * r1_hu(:,:,Kbb)
178      vv_b(:,:,Kbb) = vv_b(:,:,Kbb) * r1_hv(:,:,Kbb)
179      !
180   END SUBROUTINE istate_init
181
182   !!======================================================================
183END MODULE istate
Note: See TracBrowser for help on using the repository browser.