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.
istate.F90 in branches/UKMO/dev_r8814_surge_modelling_Nemo4/NEMOGCM/NEMO/OPA_SRC/DOM – NEMO

source: branches/UKMO/dev_r8814_surge_modelling_Nemo4/NEMOGCM/NEMO/OPA_SRC/DOM/istate.F90 @ 9120

Last change on this file since 9120 was 9120, checked in by clne, 6 years ago

Initial work on 2D surge configuration. Works for tide-only, no SBC yet
  • Property svn:keywords set to Id
File size: 8.3 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 iscplrst        ! ice sheet coupling
31   USE wet_dry         ! wetting and drying (needed for wad_istate)
32   USE usrdef_istate   ! User defined initial state
33   !
34   USE in_out_manager  ! I/O manager
35   USE iom             ! I/O library
36   USE lib_mpp         ! MPP library
37   USE restart         ! restart
38   USE wrk_nemo        ! Memory allocation
39   USE timing          ! Timing
40
41   IMPLICIT NONE
42   PRIVATE
43
44   PUBLIC   istate_init   ! routine called by step.F90
45
46   !! * Substitutions
47#  include "vectopt_loop_substitute.h90"
48   !!----------------------------------------------------------------------
49   !! NEMO/OPA 3.7 , NEMO Consortium (2014)
50   !! $Id$
51   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
52   !!----------------------------------------------------------------------
53CONTAINS
54
55   SUBROUTINE istate_init
56      !!----------------------------------------------------------------------
57      !!                   ***  ROUTINE istate_init  ***
58      !!
59      !! ** Purpose :   Initialization of the dynamics and tracer fields.
60      !!----------------------------------------------------------------------
61      INTEGER ::   ji, jj, jk   ! dummy loop indices
62      REAL(wp), POINTER, DIMENSION(:,:,:,:) ::   zuvd    ! U & V data workspace
63      !!----------------------------------------------------------------------
64      !
65      IF( nn_timing == 1 )   CALL timing_start('istate_init')
66      !
67      IF(lwp) WRITE(numout,*)
68      IF(lwp) WRITE(numout,*) 'istate_init : Initialization of the dynamics and tracers'
69      IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
70
71!!gm  Why not include in the first call of dta_tsd ? 
72!!gm  probably associated with the use of internal damping...
73                     CALL dta_tsd_init        ! Initialisation of T & S input data
74!!gm to be moved in usrdef of C1D case
75!      IF( lk_c1d )   CALL dta_uvd_init        ! Initialization of U & V input data
76!!gm
77
78      rhd  (:,:,:  ) = 0._wp   ;   rhop (:,:,:  ) = 0._wp      ! set one for all to 0 at level jpk
79      rn2b (:,:,:  ) = 0._wp   ;   rn2  (:,:,:  ) = 0._wp      ! set one for all to 0 at levels 1 and jpk
80      tsa  (:,:,:,:) = 0._wp                                   ! set one for all to 0 at level jpk
81      rab_b(:,:,:,:) = 0._wp   ;   rab_n(:,:,:,:) = 0._wp      ! set one for all to 0 at level jpk
82
83      IF( ln_rstart ) THEN                    ! Restart from a file
84         !                                    ! -------------------
85         CALL rst_read                        ! Read the restart file
86         IF (ln_iscpl)       CALL iscpl_stp   ! extrapolate restart to wet and dry
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_2d) THEN
97            tsn(:,:,:,:)= 0._wp                ! No tracers
98            sshb(:,:)   = 0._wp               ! set the ocean at rest
99            ub  (:,:,:) = 0._wp
100            vb  (:,:,:) = 0._wp         
101         ELSE IF( ln_tsd_init ) THEN 
102            CALL dta_tsd( nit000, tsb )       ! read 3D T and S data at nit000
103            !
104            sshb(:,:)   = 0._wp               ! set the ocean at rest
105            ub  (:,:,:) = 0._wp
106            vb  (:,:,:) = 0._wp 
107            !
108         ELSE                                 ! user defined initial T and S
109            CALL usr_def_istate( gdept_b, tmask, tsb, ub, vb, sshb  )         
110         ENDIF
111         tsn  (:,:,:,:) = tsb (:,:,:,:)       ! set now values from to before ones
112         sshn (:,:)     = sshb(:,:)   
113         un   (:,:,:)   = ub  (:,:,:)
114         vn   (:,:,:)   = vb  (:,:,:)
115         hdivn(:,:,jpk) = 0._wp               ! bottom divergence set one for 0 to zero at jpk level
116         CALL div_hor( 0 )                    ! compute interior hdivn value 
117!!gm                                    hdivn(:,:,:) = 0._wp
118
119!!gm POTENTIAL BUG :
120!!gm  ISSUE :  if sshb /= 0  then, in non linear free surface, the e3._n, e3._b should be recomputed
121!!             as well as gdept and gdepw....   !!!!!
122!!      ===>>>>   probably a call to domvvl initialisation here....
123
124
125         !
126!!gm to be moved in usrdef of C1D case
127!         IF ( ln_uvd_init .AND. lk_c1d ) THEN ! read 3D U and V data at nit000
128!            CALL wrk_alloc( jpi,jpj,jpk,2,   zuvd )
129!            CALL dta_uvd( nit000, zuvd )
130!            ub(:,:,:) = zuvd(:,:,:,1) ;  un(:,:,:) = ub(:,:,:)
131!            vb(:,:,:) = zuvd(:,:,:,2) ;  vn(:,:,:) = vb(:,:,:)
132!            CALL wrk_dealloc( jpi,jpj,jpk,2,   zuvd )
133!         ENDIF
134         !
135!!gm This is to be changed !!!!
136!         ! - ML - sshn could be modified by istate_eel, so that initialization of e3t_b is done here
137!         IF( .NOT.ln_linssh ) THEN
138!            DO jk = 1, jpk
139!               e3t_b(:,:,jk) = e3t_n(:,:,jk)
140!            END DO
141!         ENDIF
142!!gm
143         !
144      ENDIF 
145      !
146      ! Initialize "now" and "before" barotropic velocities:
147      ! Do it whatever the free surface method, these arrays being eventually used
148      !
149      un_b(:,:) = 0._wp   ;   vn_b(:,:) = 0._wp
150      ub_b(:,:) = 0._wp   ;   vb_b(:,:) = 0._wp
151      !
152!!gm  the use of umsak & vmask is not necessary below as un, vn, ub, vb are always masked
153      DO jk = 1, jpkm1
154         DO jj = 1, jpj
155            DO ji = 1, jpi
156               un_b(ji,jj) = un_b(ji,jj) + e3u_n(ji,jj,jk) * un(ji,jj,jk) * umask(ji,jj,jk)
157               vn_b(ji,jj) = vn_b(ji,jj) + e3v_n(ji,jj,jk) * vn(ji,jj,jk) * vmask(ji,jj,jk)
158               !
159               ub_b(ji,jj) = ub_b(ji,jj) + e3u_b(ji,jj,jk) * ub(ji,jj,jk) * umask(ji,jj,jk)
160               vb_b(ji,jj) = vb_b(ji,jj) + e3v_b(ji,jj,jk) * vb(ji,jj,jk) * vmask(ji,jj,jk)
161            END DO
162         END DO
163      END DO
164      !
165      un_b(:,:) = un_b(:,:) * r1_hu_n(:,:)
166      vn_b(:,:) = vn_b(:,:) * r1_hv_n(:,:)
167      !
168      ub_b(:,:) = ub_b(:,:) * r1_hu_b(:,:)
169      vb_b(:,:) = vb_b(:,:) * r1_hv_b(:,:)
170      !
171      IF( nn_timing == 1 )   CALL timing_stop('istate_init')
172      !
173   END SUBROUTINE istate_init
174
175   !!======================================================================
176END MODULE istate
Note: See TracBrowser for help on using the repository browser.