| 1 | MODULE 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 dtatsd ! data temperature and salinity (dta_tsd routine) |
|---|
| 27 | USE dtauvd ! data: U & V current (dta_uvd routine) |
|---|
| 28 | USE domvvl ! varying vertical mesh |
|---|
| 29 | USE wet_dry ! wetting and drying (needed for wad_istate) |
|---|
| 30 | USE usrdef_istate ! User defined initial state |
|---|
| 31 | ! |
|---|
| 32 | USE in_out_manager ! I/O manager |
|---|
| 33 | USE iom ! I/O library |
|---|
| 34 | USE lib_mpp ! MPP library |
|---|
| 35 | USE restart ! restart |
|---|
| 36 | #if defined key_agrif |
|---|
| 37 | USE agrif_oce_interp |
|---|
| 38 | USE agrif_oce |
|---|
| 39 | #endif |
|---|
| 40 | |
|---|
| 41 | IMPLICIT NONE |
|---|
| 42 | PRIVATE |
|---|
| 43 | |
|---|
| 44 | PUBLIC istate_init ! routine called by step.F90 |
|---|
| 45 | |
|---|
| 46 | !! * Substitutions |
|---|
| 47 | # include "do_loop_substitute.h90" |
|---|
| 48 | !!---------------------------------------------------------------------- |
|---|
| 49 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
|---|
| 50 | !! $Id$ |
|---|
| 51 | !! Software governed by the CeCILL license (see ./LICENSE) |
|---|
| 52 | !!---------------------------------------------------------------------- |
|---|
| 53 | CONTAINS |
|---|
| 54 | |
|---|
| 55 | SUBROUTINE istate_init( Kbb, Kmm, Kaa ) |
|---|
| 56 | !!---------------------------------------------------------------------- |
|---|
| 57 | !! *** ROUTINE istate_init *** |
|---|
| 58 | !! |
|---|
| 59 | !! ** Purpose : Initialization of the dynamics and tracer fields. |
|---|
| 60 | !!---------------------------------------------------------------------- |
|---|
| 61 | INTEGER, INTENT( in ) :: Kbb, Kmm, Kaa ! ocean time level indices |
|---|
| 62 | ! |
|---|
| 63 | INTEGER :: ji, jj, jk ! dummy loop indices |
|---|
| 64 | !!gm see comment further down |
|---|
| 65 | REAL(wp), ALLOCATABLE, DIMENSION(:,:,:,:) :: zuvd ! U & V data workspace |
|---|
| 66 | !!gm end |
|---|
| 67 | !!---------------------------------------------------------------------- |
|---|
| 68 | ! |
|---|
| 69 | IF(lwp) WRITE(numout,*) |
|---|
| 70 | IF(lwp) WRITE(numout,*) 'istate_init : Initialization of the dynamics and tracers' |
|---|
| 71 | IF(lwp) WRITE(numout,*) '~~~~~~~~~~~' |
|---|
| 72 | |
|---|
| 73 | !!gm Why not include in the first call of dta_tsd ? |
|---|
| 74 | !!gm probably associated with the use of internal damping... |
|---|
| 75 | CALL dta_tsd_init ! Initialisation of T & S input data |
|---|
| 76 | !!gm to be moved in usrdef of C1D case |
|---|
| 77 | ! IF( lk_c1d ) CALL dta_uvd_init ! Initialization of U & V input data |
|---|
| 78 | !!gm |
|---|
| 79 | |
|---|
| 80 | rhd (:,:,: ) = 0._wp ; rhop (:,:,: ) = 0._wp ! set one for all to 0 at level jpk |
|---|
| 81 | rn2b (:,:,: ) = 0._wp ; rn2 (:,:,: ) = 0._wp ! set one for all to 0 at levels 1 and jpk |
|---|
| 82 | ts (:,:,:,:,Kaa) = 0._wp ! set one for all to 0 at level jpk |
|---|
| 83 | rab_b(:,:,:,:) = 0._wp ; rab_n(:,:,:,:) = 0._wp ! set one for all to 0 at level jpk |
|---|
| 84 | #if defined key_agrif |
|---|
| 85 | uu (:,:,: ,Kaa) = 0._wp ! used in agrif_oce_sponge at initialization |
|---|
| 86 | vv (:,:,: ,Kaa) = 0._wp ! used in agrif_oce_sponge at initialization |
|---|
| 87 | #endif |
|---|
| 88 | |
|---|
| 89 | #if defined key_agrif |
|---|
| 90 | IF ( (.NOT.Agrif_root()).AND.ln_init_chfrpar ) THEN |
|---|
| 91 | numror = 0 ! define numror = 0 -> no restart file to read |
|---|
| 92 | ln_1st_euler = .true. ! Set time-step indicator at nit000 (euler forward) |
|---|
| 93 | CALL day_init |
|---|
| 94 | CALL agrif_istate( Kbb, Kmm, Kaa ) ! Interp from parent |
|---|
| 95 | ! |
|---|
| 96 | ts (:,:,:,:,Kmm) = ts (:,:,:,:,Kbb) |
|---|
| 97 | ssh (:,:,Kmm) = ssh(:,:,Kbb) |
|---|
| 98 | uu (:,:,:,Kmm) = uu (:,:,:,Kbb) |
|---|
| 99 | vv (:,:,:,Kmm) = vv (:,:,:,Kbb) |
|---|
| 100 | ELSE |
|---|
| 101 | #endif |
|---|
| 102 | IF( ln_rstart ) THEN ! Restart from a file |
|---|
| 103 | ! ! ------------------- |
|---|
| 104 | CALL rst_read( Kbb, Kmm ) ! Read the restart file |
|---|
| 105 | CALL day_init ! model calendar (using both namelist and restart infos) |
|---|
| 106 | ! |
|---|
| 107 | ELSE ! Start from rest |
|---|
| 108 | ! ! --------------- |
|---|
| 109 | numror = 0 ! define numror = 0 -> no restart file to read |
|---|
| 110 | l_1st_euler = .true. ! Set time-step indicator at nit000 (euler forward) |
|---|
| 111 | CALL day_init ! model calendar (using both namelist and restart infos) |
|---|
| 112 | ! ! Initialization of ocean to zero |
|---|
| 113 | ! |
|---|
| 114 | IF( ln_tsd_init ) THEN |
|---|
| 115 | CALL dta_tsd( nit000, ts(:,:,:,:,Kbb) ) ! read 3D T and S data at nit000 |
|---|
| 116 | ! |
|---|
| 117 | ssh(:,:,Kbb) = 0._wp ! set the ocean at rest |
|---|
| 118 | uu (:,:,:,Kbb) = 0._wp |
|---|
| 119 | vv (:,:,:,Kbb) = 0._wp |
|---|
| 120 | ! |
|---|
| 121 | IF( ll_wd ) THEN |
|---|
| 122 | ssh(:,:,Kbb) = -ssh_ref ! Added in 30 here for bathy that adds 30 as Iterative test CEOD |
|---|
| 123 | ! |
|---|
| 124 | ! Apply minimum wetdepth criterion |
|---|
| 125 | ! |
|---|
| 126 | DO_2D_11_11 |
|---|
| 127 | IF( ht_0(ji,jj) + ssh(ji,jj,Kbb) < rn_wdmin1 ) THEN |
|---|
| 128 | ssh(ji,jj,Kbb) = tmask(ji,jj,1)*( rn_wdmin1 - (ht_0(ji,jj)) ) |
|---|
| 129 | ENDIF |
|---|
| 130 | END_2D |
|---|
| 131 | ENDIF |
|---|
| 132 | ! |
|---|
| 133 | ELSE ! user defined initial T and S |
|---|
| 134 | CALL usr_def_istate( gdept(:,:,:,Kbb), tmask, ts(:,:,:,:,Kbb), uu(:,:,:,Kbb), vv(:,:,:,Kbb), ssh(:,:,Kbb) ) |
|---|
| 135 | ENDIF |
|---|
| 136 | ts (:,:,:,:,Kmm) = ts (:,:,:,:,Kbb) ! set now values from to before ones |
|---|
| 137 | ssh (:,:,Kmm) = ssh(:,:,Kbb) |
|---|
| 138 | uu (:,:,:,Kmm) = uu (:,:,:,Kbb) |
|---|
| 139 | vv (:,:,:,Kmm) = vv (:,:,:,Kbb) |
|---|
| 140 | |
|---|
| 141 | !!gm POTENTIAL BUG : |
|---|
| 142 | !!gm ISSUE : if ssh(:,:,Kbb) /= 0 then, in non linear free surface, the e3._n, e3._b should be recomputed |
|---|
| 143 | !! as well as gdept and gdepw.... !!!!! |
|---|
| 144 | !! ===>>>> probably a call to domvvl initialisation here.... |
|---|
| 145 | |
|---|
| 146 | |
|---|
| 147 | ! |
|---|
| 148 | !!gm to be moved in usrdef of C1D case |
|---|
| 149 | ! IF ( ln_uvd_init .AND. lk_c1d ) THEN ! read 3D U and V data at nit000 |
|---|
| 150 | ! ALLOCATE( zuvd(jpi,jpj,jpk,2) ) |
|---|
| 151 | ! CALL dta_uvd( nit000, zuvd ) |
|---|
| 152 | ! uu(:,:,:,Kbb) = zuvd(:,:,:,1) ; uu(:,:,:,Kmm) = uu(:,:,:,Kbb) |
|---|
| 153 | ! vv(:,:,:,Kbb) = zuvd(:,:,:,2) ; vv(:,:,:,Kmm) = vv(:,:,:,Kbb) |
|---|
| 154 | ! DEALLOCATE( zuvd ) |
|---|
| 155 | ! ENDIF |
|---|
| 156 | ! |
|---|
| 157 | !!gm This is to be changed !!!! |
|---|
| 158 | ! ! - ML - ssh(:,:,Kmm) could be modified by istate_eel, so that initialization of e3t(:,:,:,Kbb) is done here |
|---|
| 159 | ! IF( .NOT.ln_linssh ) THEN |
|---|
| 160 | ! DO jk = 1, jpk |
|---|
| 161 | ! e3t(:,:,jk,Kbb) = e3t(:,:,jk,Kmm) |
|---|
| 162 | ! END DO |
|---|
| 163 | ! ENDIF |
|---|
| 164 | !!gm |
|---|
| 165 | ! |
|---|
| 166 | ENDIF |
|---|
| 167 | #if defined key_agrif |
|---|
| 168 | ENDIF |
|---|
| 169 | #endif |
|---|
| 170 | ! |
|---|
| 171 | ! Initialize "now" and "before" barotropic velocities: |
|---|
| 172 | ! Do it whatever the free surface method, these arrays being eventually used |
|---|
| 173 | ! |
|---|
| 174 | uu_b(:,:,Kmm) = 0._wp ; vv_b(:,:,Kmm) = 0._wp |
|---|
| 175 | uu_b(:,:,Kbb) = 0._wp ; vv_b(:,:,Kbb) = 0._wp |
|---|
| 176 | ! |
|---|
| 177 | !!gm the use of umsak & vmask is not necessary below as uu(:,:,:,Kmm), vv(:,:,:,Kmm), uu(:,:,:,Kbb), vv(:,:,:,Kbb) are always masked |
|---|
| 178 | DO_3D_11_11( 1, jpkm1 ) |
|---|
| 179 | uu_b(ji,jj,Kmm) = uu_b(ji,jj,Kmm) + e3u(ji,jj,jk,Kmm) * uu(ji,jj,jk,Kmm) * umask(ji,jj,jk) |
|---|
| 180 | vv_b(ji,jj,Kmm) = vv_b(ji,jj,Kmm) + e3v(ji,jj,jk,Kmm) * vv(ji,jj,jk,Kmm) * vmask(ji,jj,jk) |
|---|
| 181 | ! |
|---|
| 182 | uu_b(ji,jj,Kbb) = uu_b(ji,jj,Kbb) + e3u(ji,jj,jk,Kbb) * uu(ji,jj,jk,Kbb) * umask(ji,jj,jk) |
|---|
| 183 | vv_b(ji,jj,Kbb) = vv_b(ji,jj,Kbb) + e3v(ji,jj,jk,Kbb) * vv(ji,jj,jk,Kbb) * vmask(ji,jj,jk) |
|---|
| 184 | END_3D |
|---|
| 185 | ! |
|---|
| 186 | uu_b(:,:,Kmm) = uu_b(:,:,Kmm) * r1_hu(:,:,Kmm) |
|---|
| 187 | vv_b(:,:,Kmm) = vv_b(:,:,Kmm) * r1_hv(:,:,Kmm) |
|---|
| 188 | ! |
|---|
| 189 | uu_b(:,:,Kbb) = uu_b(:,:,Kbb) * r1_hu(:,:,Kbb) |
|---|
| 190 | vv_b(:,:,Kbb) = vv_b(:,:,Kbb) * r1_hv(:,:,Kbb) |
|---|
| 191 | ! |
|---|
| 192 | END SUBROUTINE istate_init |
|---|
| 193 | |
|---|
| 194 | !!====================================================================== |
|---|
| 195 | END MODULE istate |
|---|
