source: NEMO/branches/2019/ENHANCE-02_ISF_nemo/tests/ISOMIP+/MY_SRC/istate.F90 @ 11889

Last change on this file since 11889 was 11889, checked in by mathiot, 9 months ago

ENHANCE-02_ISF_nemo: add ISOMIP+ test case configuration

File size: 8.5 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 "vectopt_loop_substitute.h90"
45   !!----------------------------------------------------------------------
46   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
47   !! $Id: istate.F90 11423 2019-08-08 14:02:49Z mathiot $
48   !! Software governed by the CeCILL license (see ./LICENSE)
49   !!----------------------------------------------------------------------
50CONTAINS
51
52   SUBROUTINE istate_init
53      !!----------------------------------------------------------------------
54      !!                   ***  ROUTINE istate_init  ***
55      !!
56      !! ** Purpose :   Initialization of the dynamics and tracer fields.
57      !!----------------------------------------------------------------------
58      INTEGER ::   ji, jj, jk   ! dummy loop indices
59!!gm see comment further down
60      REAL(wp), ALLOCATABLE, DIMENSION(:,:,:,:) ::   zuvd    ! U & V data workspace
61!!gm end
62      !!----------------------------------------------------------------------
63      !
64      IF(lwp) WRITE(numout,*)
65      IF(lwp) WRITE(numout,*) 'istate_init : Initialization of the dynamics and tracers'
66      IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
67
68!!gm  Why not include in the first call of dta_tsd ? 
69!!gm  probably associated with the use of internal damping...
70                     CALL dta_tsd_init        ! Initialisation of T & S input data
71!!gm to be moved in usrdef of C1D case
72!      IF( lk_c1d )   CALL dta_uvd_init        ! Initialization of U & V input data
73!!gm
74
75      rhd  (:,:,:  ) = 0._wp   ;   rhop (:,:,:  ) = 0._wp      ! set one for all to 0 at level jpk
76      rn2b (:,:,:  ) = 0._wp   ;   rn2  (:,:,:  ) = 0._wp      ! set one for all to 0 at levels 1 and jpk
77      tsa  (:,:,:,:) = 0._wp                                   ! set one for all to 0 at level jpk
78      rab_b(:,:,:,:) = 0._wp   ;   rab_n(:,:,:,:) = 0._wp      ! set one for all to 0 at level jpk
79#if defined key_agrif
80      ua   (:,:,:  ) = 0._wp   ! used in agrif_oce_sponge at initialization
81      va   (:,:,:  ) = 0._wp   ! used in agrif_oce_sponge at initialization   
82#endif
83
84      IF( ln_rstart ) THEN                    ! Restart from a file
85         !                                    ! -------------------
86         CALL rst_read                        ! Read the restart file
87         CALL day_init                        ! model calendar (using both namelist and restart infos)
88         !
89      ELSE                                    ! Start from rest
90         !                                    ! ---------------
91         numror = 0                           ! define numror = 0 -> no restart file to read
92         neuler = 0                           ! Set time-step indicator at nit000 (euler forward)
93         CALL day_init                        ! model calendar (using both namelist and restart infos)
94         !                                    ! Initialization of ocean to zero
95         !
96         IF( ln_tsd_init ) THEN               
97            CALL dta_tsd( nit000, 'ini', tsb )       ! read 3D T and S data at nit000
98            !
99            sshb(:,:)   = 0._wp               ! set the ocean at rest
100            IF( ll_wd ) THEN
101               sshb(:,:) =  -ssh_ref  ! Added in 30 here for bathy that adds 30 as Iterative test CEOD
102               !
103               ! Apply minimum wetdepth criterion
104               !
105               DO jj = 1,jpj
106                  DO ji = 1,jpi
107                     IF( ht_0(ji,jj) + sshb(ji,jj)  < rn_wdmin1 ) THEN
108                        sshb(ji,jj) = tmask(ji,jj,1)*( rn_wdmin1 - (ht_0(ji,jj)) )
109                     ENDIF
110                  END DO
111               END DO
112            ENDIF
113            ub  (:,:,:) = 0._wp
114            vb  (:,:,:) = 0._wp 
115            !
116         ELSE                                 ! user defined initial T and S
117            CALL usr_def_istate( gdept_b, tmask, tsb, ub, vb, sshb  )         
118         ENDIF
119         tsn  (:,:,:,:) = tsb (:,:,:,:)       ! set now values from to before ones
120         sshn (:,:)     = sshb(:,:)   
121         un   (:,:,:)   = ub  (:,:,:)
122         vn   (:,:,:)   = vb  (:,:,:)
123         hdivn(:,:,jpk) = 0._wp               ! bottom divergence set one for 0 to zero at jpk level
124         CALL div_hor( 0 )                    ! compute interior hdivn value 
125!!gm                                    hdivn(:,:,:) = 0._wp
126
127!!gm POTENTIAL BUG :
128!!gm  ISSUE :  if sshb /= 0  then, in non linear free surface, the e3._n, e3._b should be recomputed
129!!             as well as gdept and gdepw....   !!!!!
130!!      ===>>>>   probably a call to domvvl initialisation here....
131
132
133         !
134!!gm to be moved in usrdef of C1D case
135!         IF ( ln_uvd_init .AND. lk_c1d ) THEN ! read 3D U and V data at nit000
136!            ALLOCATE( zuvd(jpi,jpj,jpk,2) )
137!            CALL dta_uvd( nit000, zuvd )
138!            ub(:,:,:) = zuvd(:,:,:,1) ;  un(:,:,:) = ub(:,:,:)
139!            vb(:,:,:) = zuvd(:,:,:,2) ;  vn(:,:,:) = vb(:,:,:)
140!            DEALLOCATE( zuvd )
141!         ENDIF
142         !
143!!gm This is to be changed !!!!
144!         ! - ML - sshn could be modified by istate_eel, so that initialization of e3t_b is done here
145!         IF( .NOT.ln_linssh ) THEN
146!            DO jk = 1, jpk
147!               e3t_b(:,:,jk) = e3t_n(:,:,jk)
148!            END DO
149!         ENDIF
150!!gm
151         !
152      ENDIF 
153      !
154      ! Initialize "now" and "before" barotropic velocities:
155      ! Do it whatever the free surface method, these arrays being eventually used
156      !
157      un_b(:,:) = 0._wp   ;   vn_b(:,:) = 0._wp
158      ub_b(:,:) = 0._wp   ;   vb_b(:,:) = 0._wp
159      !
160!!gm  the use of umsak & vmask is not necessary below as un, vn, ub, vb are always masked
161      DO jk = 1, jpkm1
162         DO jj = 1, jpj
163            DO ji = 1, jpi
164               un_b(ji,jj) = un_b(ji,jj) + e3u_n(ji,jj,jk) * un(ji,jj,jk) * umask(ji,jj,jk)
165               vn_b(ji,jj) = vn_b(ji,jj) + e3v_n(ji,jj,jk) * vn(ji,jj,jk) * vmask(ji,jj,jk)
166               !
167               ub_b(ji,jj) = ub_b(ji,jj) + e3u_b(ji,jj,jk) * ub(ji,jj,jk) * umask(ji,jj,jk)
168               vb_b(ji,jj) = vb_b(ji,jj) + e3v_b(ji,jj,jk) * vb(ji,jj,jk) * vmask(ji,jj,jk)
169            END DO
170         END DO
171      END DO
172      !
173      un_b(:,:) = un_b(:,:) * r1_hu_n(:,:)
174      vn_b(:,:) = vn_b(:,:) * r1_hv_n(:,:)
175      !
176      ub_b(:,:) = ub_b(:,:) * r1_hu_b(:,:)
177      vb_b(:,:) = vb_b(:,:) * r1_hv_b(:,:)
178      !
179   END SUBROUTINE istate_init
180
181   !!======================================================================
182END MODULE istate
Note: See TracBrowser for help on using the repository browser.