| 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 lbclnk ! lateal boundary condition / mpp exchanges |
|---|
| 36 | USE restart ! restart |
|---|
| 37 | |
|---|
| 38 | #if defined key_agrif |
|---|
| 39 | USE agrif_oce ! initial state interpolation |
|---|
| 40 | USE agrif_oce_interp |
|---|
| 41 | #endif |
|---|
| 42 | |
|---|
| 43 | IMPLICIT NONE |
|---|
| 44 | PRIVATE |
|---|
| 45 | |
|---|
| 46 | PUBLIC istate_init ! routine called by nemogcm.F90 |
|---|
| 47 | |
|---|
| 48 | !! * Substitutions |
|---|
| 49 | # include "do_loop_substitute.h90" |
|---|
| 50 | # include "domzgr_substitute.h90" |
|---|
| 51 | !!---------------------------------------------------------------------- |
|---|
| 52 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
|---|
| 53 | !! $Id$ |
|---|
| 54 | !! Software governed by the CeCILL license (see ./LICENSE) |
|---|
| 55 | !!---------------------------------------------------------------------- |
|---|
| 56 | CONTAINS |
|---|
| 57 | |
|---|
| 58 | SUBROUTINE istate_init( Kbb, Kmm, Kaa ) |
|---|
| 59 | !!---------------------------------------------------------------------- |
|---|
| 60 | !! *** ROUTINE istate_init *** |
|---|
| 61 | !! |
|---|
| 62 | !! ** Purpose : Initialization of the dynamics and tracer fields. |
|---|
| 63 | !! |
|---|
| 64 | !! ** Method : |
|---|
| 65 | !!---------------------------------------------------------------------- |
|---|
| 66 | INTEGER, INTENT( in ) :: Kbb, Kmm, Kaa ! ocean time level indices |
|---|
| 67 | ! |
|---|
| 68 | INTEGER :: ji, jj, jk ! dummy loop indices |
|---|
| 69 | REAL(wp), DIMENSION(jpi,jpj,jpk) :: zgdept ! 3D table for qco substitute |
|---|
| 70 | !!gm see comment further down |
|---|
| 71 | REAL(wp), ALLOCATABLE, DIMENSION(:,:,:,:) :: zuvd ! U & V data workspace |
|---|
| 72 | !!gm end |
|---|
| 73 | !!---------------------------------------------------------------------- |
|---|
| 74 | ! |
|---|
| 75 | IF(lwp) WRITE(numout,*) |
|---|
| 76 | IF(lwp) WRITE(numout,*) 'istate_init : Initialization of the dynamics and tracers' |
|---|
| 77 | IF(lwp) WRITE(numout,*) '~~~~~~~~~~~' |
|---|
| 78 | |
|---|
| 79 | CALL dta_tsd_init ! Initialisation of T & S input data |
|---|
| 80 | IF( ln_c1d) CALL dta_uvd_init ! Initialisation of U & V input data (c1d only) |
|---|
| 81 | |
|---|
| 82 | rhd (:,:,: ) = 0._wp ; rhop (:,:,: ) = 0._wp ! set one for all to 0 at level jpk |
|---|
| 83 | rn2b (:,:,: ) = 0._wp ; rn2 (:,:,: ) = 0._wp ! set one for all to 0 at levels 1 and jpk |
|---|
| 84 | ts (:,:,:,:,Kaa) = 0._wp ! set one for all to 0 at level jpk |
|---|
| 85 | rab_b(:,:,:,: ) = 0._wp ; rab_n(:,:,:,:) = 0._wp ! set one for all to 0 at level jpk |
|---|
| 86 | #if defined key_agrif |
|---|
| 87 | uu (:,:,: ,Kaa) = 0._wp ! used in agrif_oce_sponge at initialization |
|---|
| 88 | vv (:,:,: ,Kaa) = 0._wp ! used in agrif_oce_sponge at initialization |
|---|
| 89 | #endif |
|---|
| 90 | |
|---|
| 91 | #if defined key_agrif |
|---|
| 92 | IF ( .NOT.Agrif_root() .AND. ln_init_chfrpar ) THEN |
|---|
| 93 | numror = 0 ! define numror = 0 -> no restart file to read |
|---|
| 94 | ln_1st_euler = .true. ! Set time-step indicator at nit000 (euler forward) |
|---|
| 95 | CALL day_init |
|---|
| 96 | CALL agrif_istate_oce( Kbb, Kmm, Kaa ) ! Interp from parent |
|---|
| 97 | ! |
|---|
| 98 | ts (:,:,:,:,Kmm) = ts (:,:,:,:,Kbb) |
|---|
| 99 | uu (:,:,: ,Kmm) = uu (:,:,: ,Kbb) |
|---|
| 100 | vv (:,:,: ,Kmm) = vv (:,:,: ,Kbb) |
|---|
| 101 | ELSE |
|---|
| 102 | #endif |
|---|
| 103 | IF( ln_rstart ) THEN ! Restart from a file |
|---|
| 104 | ! ! ------------------- |
|---|
| 105 | CALL rst_read( Kbb, Kmm ) ! Read the restart file |
|---|
| 106 | CALL day_init ! model calendar (using both namelist and restart infos) |
|---|
| 107 | ! |
|---|
| 108 | ELSE ! Start from rest |
|---|
| 109 | ! ! --------------- |
|---|
| 110 | numror = 0 ! define numror = 0 -> no restart file to read |
|---|
| 111 | l_1st_euler = .true. ! Set time-step indicator at nit000 (euler forward) |
|---|
| 112 | CALL day_init ! model calendar (using both namelist and restart infos) |
|---|
| 113 | ! ! Initialization of ocean to zero |
|---|
| 114 | ! |
|---|
| 115 | IF( ln_tsd_init ) THEN |
|---|
| 116 | CALL dta_tsd( nit000, ts(:,:,:,:,Kbb) ) ! read 3D T and S data at nit000 |
|---|
| 117 | ENDIF |
|---|
| 118 | ! |
|---|
| 119 | IF( ln_uvd_init .AND. ln_c1d ) THEN |
|---|
| 120 | CALL dta_uvd( nit000, Kbb, uu(:,:,:,Kbb), vv(:,:,:,Kbb) ) ! read 3D U and V data at nit000 |
|---|
| 121 | ELSE |
|---|
| 122 | uu (:,:,:,Kbb) = 0._wp ! set the ocean at rest |
|---|
| 123 | vv (:,:,:,Kbb) = 0._wp |
|---|
| 124 | ENDIF |
|---|
| 125 | ! |
|---|
| 126 | ! |
|---|
| 127 | IF( .NOT. ln_tsd_init .AND. .NOT. ln_uvd_init ) THEN |
|---|
| 128 | DO jk = 1, jpk |
|---|
| 129 | zgdept(:,:,jk) = gdept(:,:,jk,Kbb) |
|---|
| 130 | END DO |
|---|
| 131 | CALL usr_def_istate( zgdept, tmask, ts(:,:,:,:,Kbb), uu(:,:,:,Kbb), vv(:,:,:,Kbb) ) |
|---|
| 132 | ! make sure that periodicities are properly applied |
|---|
| 133 | CALL lbc_lnk( 'istate', ts(:,:,:,jp_tem,Kbb), 'T', 1._wp, ts(:,:,:,jp_sal,Kbb), 'T', 1._wp, & |
|---|
| 134 | & uu(:,:,:, Kbb), 'U', -1._wp, vv(:,:,:, Kbb), 'V', -1._wp ) |
|---|
| 135 | ENDIF |
|---|
| 136 | ts (:,:,:,:,Kmm) = ts (:,:,:,:,Kbb) ! set now values from to before ones |
|---|
| 137 | uu (:,:,:,Kmm) = uu (:,:,:,Kbb) |
|---|
| 138 | vv (:,:,:,Kmm) = vv (:,:,:,Kbb) |
|---|
| 139 | |
|---|
| 140 | ENDIF |
|---|
| 141 | #if defined key_agrif |
|---|
| 142 | ENDIF |
|---|
| 143 | #endif |
|---|
| 144 | ! |
|---|
| 145 | ! Initialize "now" and "before" barotropic velocities: |
|---|
| 146 | ! Do it whatever the free surface method, these arrays being eventually used |
|---|
| 147 | ! |
|---|
| 148 | uu_b(:,:,Kmm) = 0._wp ; vv_b(:,:,Kmm) = 0._wp |
|---|
| 149 | uu_b(:,:,Kbb) = 0._wp ; vv_b(:,:,Kbb) = 0._wp |
|---|
| 150 | ! |
|---|
| 151 | !!gm the use of umsak & vmask is not necessary below as uu(:,:,:,Kmm), vv(:,:,:,Kmm), uu(:,:,:,Kbb), vv(:,:,:,Kbb) are always masked |
|---|
| 152 | DO_3D( nn_hls, nn_hls, nn_hls, nn_hls, 1, jpkm1 ) |
|---|
| 153 | uu_b(ji,jj,Kmm) = uu_b(ji,jj,Kmm) + e3u(ji,jj,jk,Kmm) * uu(ji,jj,jk,Kmm) * umask(ji,jj,jk) |
|---|
| 154 | vv_b(ji,jj,Kmm) = vv_b(ji,jj,Kmm) + e3v(ji,jj,jk,Kmm) * vv(ji,jj,jk,Kmm) * vmask(ji,jj,jk) |
|---|
| 155 | ! |
|---|
| 156 | uu_b(ji,jj,Kbb) = uu_b(ji,jj,Kbb) + e3u(ji,jj,jk,Kbb) * uu(ji,jj,jk,Kbb) * umask(ji,jj,jk) |
|---|
| 157 | vv_b(ji,jj,Kbb) = vv_b(ji,jj,Kbb) + e3v(ji,jj,jk,Kbb) * vv(ji,jj,jk,Kbb) * vmask(ji,jj,jk) |
|---|
| 158 | END_3D |
|---|
| 159 | ! |
|---|
| 160 | uu_b(:,:,Kmm) = uu_b(:,:,Kmm) * r1_hu(:,:,Kmm) |
|---|
| 161 | vv_b(:,:,Kmm) = vv_b(:,:,Kmm) * r1_hv(:,:,Kmm) |
|---|
| 162 | ! |
|---|
| 163 | uu_b(:,:,Kbb) = uu_b(:,:,Kbb) * r1_hu(:,:,Kbb) |
|---|
| 164 | vv_b(:,:,Kbb) = vv_b(:,:,Kbb) * r1_hv(:,:,Kbb) |
|---|
| 165 | ! |
|---|
| 166 | END SUBROUTINE istate_init |
|---|
| 167 | |
|---|
| 168 | !!====================================================================== |
|---|
| 169 | END MODULE istate |
|---|
