| 1 | MODULE usrdef_zgr |
|---|
| 2 | !!====================================================================== |
|---|
| 3 | !! *** MODULE usrdef_zgr *** |
|---|
| 4 | !! |
|---|
| 5 | !! === LOCK_EXCHANGE case === |
|---|
| 6 | !! |
|---|
| 7 | !! Ocean domain : user defined vertical coordinate system |
|---|
| 8 | !!====================================================================== |
|---|
| 9 | !! History : 4.0 ! 2016-08 (G. Madec, S. Flavoni) Original code |
|---|
| 10 | !!---------------------------------------------------------------------- |
|---|
| 11 | |
|---|
| 12 | !!---------------------------------------------------------------------- |
|---|
| 13 | !! usr_def_zgr : user defined vertical coordinate system (required) |
|---|
| 14 | !!--------------------------------------------------------------------- |
|---|
| 15 | USE oce ! ocean variables |
|---|
| 16 | USE dom_oce , ONLY: ln_zco, ln_zps, ln_sco ! ocean space and time domain |
|---|
| 17 | USE usrdef_nam ! User defined : namelist variables |
|---|
| 18 | ! |
|---|
| 19 | USE in_out_manager ! I/O manager |
|---|
| 20 | USE lbclnk ! ocean lateral boundary conditions (or mpp link) |
|---|
| 21 | USE lib_mpp ! distributed memory computing library |
|---|
| 22 | USE wrk_nemo ! Memory allocation |
|---|
| 23 | USE timing ! Timing |
|---|
| 24 | |
|---|
| 25 | IMPLICIT NONE |
|---|
| 26 | PRIVATE |
|---|
| 27 | |
|---|
| 28 | PUBLIC usr_def_zgr ! called by domzgr.F90 |
|---|
| 29 | |
|---|
| 30 | !! * Substitutions |
|---|
| 31 | # include "vectopt_loop_substitute.h90" |
|---|
| 32 | !!---------------------------------------------------------------------- |
|---|
| 33 | !! NEMO/OPA 4.0 , NEMO Consortium (2016) |
|---|
| 34 | !! $Id$ |
|---|
| 35 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
|---|
| 36 | !!---------------------------------------------------------------------- |
|---|
| 37 | CONTAINS |
|---|
| 38 | |
|---|
| 39 | SUBROUTINE usr_def_zgr( ld_zco , ld_zps , ld_sco , ld_isfcav, & ! type of vertical coordinate |
|---|
| 40 | & pdept_1d, pdepw_1d, pe3t_1d , pe3w_1d , & ! 1D reference vertical coordinate |
|---|
| 41 | & pdept , pdepw , & ! 3D t & w-points depth |
|---|
| 42 | & pe3t , pe3u , pe3v , pe3f , & ! vertical scale factors |
|---|
| 43 | & pe3w , pe3uw , pe3vw, & ! - - - |
|---|
| 44 | & k_top , k_bot ) ! top & bottom ocean level |
|---|
| 45 | !!--------------------------------------------------------------------- |
|---|
| 46 | !! *** ROUTINE usr_def_zgr *** |
|---|
| 47 | !! |
|---|
| 48 | !! ** Purpose : User defined the vertical coordinates |
|---|
| 49 | !! |
|---|
| 50 | !!---------------------------------------------------------------------- |
|---|
| 51 | LOGICAL , INTENT(out) :: ld_zco, ld_zps, ld_sco ! vertical coordinate flags |
|---|
| 52 | LOGICAL , INTENT(out) :: ld_isfcav ! under iceshelf cavity flag |
|---|
| 53 | REAL(wp), DIMENSION(:) , INTENT(out) :: pdept_1d, pdepw_1d ! 1D grid-point depth [m] |
|---|
| 54 | REAL(wp), DIMENSION(:) , INTENT(out) :: pe3t_1d , pe3w_1d ! 1D grid-point depth [m] |
|---|
| 55 | REAL(wp), DIMENSION(:,:,:), INTENT(out) :: pdept, pdepw ! grid-point depth [m] |
|---|
| 56 | REAL(wp), DIMENSION(:,:,:), INTENT(out) :: pe3t , pe3u , pe3v , pe3f ! vertical scale factors [m] |
|---|
| 57 | REAL(wp), DIMENSION(:,:,:), INTENT(out) :: pe3w , pe3uw, pe3vw ! i-scale factors |
|---|
| 58 | INTEGER , DIMENSION(:,:) , INTENT(out) :: k_top, k_bot ! first & last ocean level |
|---|
| 59 | ! |
|---|
| 60 | INTEGER :: jk, k_dz ! dummy indices |
|---|
| 61 | !!---------------------------------------------------------------------- |
|---|
| 62 | ! |
|---|
| 63 | IF(lwp) WRITE(numout,*) |
|---|
| 64 | IF(lwp) WRITE(numout,*) 'usr_def_zgr : SAS_BIPER configuration (slab ocean - advection of an ice patch in a biperiodic square box domain)' |
|---|
| 65 | IF(lwp) WRITE(numout,*) '~~~~~~~~~~~' |
|---|
| 66 | ! |
|---|
| 67 | ! |
|---|
| 68 | ! type of vertical coordinate |
|---|
| 69 | ! --------------------------- |
|---|
| 70 | ld_zco = .TRUE. ! z-full-step coordinate |
|---|
| 71 | ld_zps = .FALSE. ! z-partial-step coordinate |
|---|
| 72 | ld_sco = .FALSE. ! s-coordinate |
|---|
| 73 | ld_isfcav = .FALSE. ! ISF Ice Shelves Flag |
|---|
| 74 | ! |
|---|
| 75 | ! |
|---|
| 76 | ! Build the vertical coordinate system |
|---|
| 77 | ! ------------------------------------ |
|---|
| 78 | ! |
|---|
| 79 | ! !== UNmasked meter bathymetry ==! |
|---|
| 80 | ! |
|---|
| 81 | ! |
|---|
| 82 | k_dz = 1 |
|---|
| 83 | DO jk = 1, jpk |
|---|
| 84 | pdepw_1d(jk) = k_dz |
|---|
| 85 | pdept_1d(jk) = k_dz |
|---|
| 86 | pe3w_1d (jk) = k_dz |
|---|
| 87 | pe3t_1d (jk) = k_dz |
|---|
| 88 | END DO |
|---|
| 89 | ! !== top masked level bathymetry ==! (all coordinates) |
|---|
| 90 | ! |
|---|
| 91 | ! no ocean cavities : top ocean level is ONE, except over land |
|---|
| 92 | k_top(:,:) = 1 |
|---|
| 93 | ! |
|---|
| 94 | ! !== z-coordinate ==! (step-like topography) |
|---|
| 95 | ! !* bottom ocean compute from the depth of grid-points |
|---|
| 96 | jpkm1 = jpk |
|---|
| 97 | k_bot(:,:) = 1 ! here use k_top as a land mask |
|---|
| 98 | ! !* horizontally uniform coordinate (reference z-co everywhere) |
|---|
| 99 | DO jk = 1, jpk |
|---|
| 100 | pdept(:,:,jk) = pdept_1d(jk) |
|---|
| 101 | pdepw(:,:,jk) = pdepw_1d(jk) |
|---|
| 102 | pe3t (:,:,jk) = pe3t_1d (jk) |
|---|
| 103 | pe3u (:,:,jk) = pe3t_1d (jk) |
|---|
| 104 | pe3v (:,:,jk) = pe3t_1d (jk) |
|---|
| 105 | pe3f (:,:,jk) = pe3t_1d (jk) |
|---|
| 106 | pe3w (:,:,jk) = pe3w_1d (jk) |
|---|
| 107 | pe3uw(:,:,jk) = pe3w_1d (jk) |
|---|
| 108 | pe3vw(:,:,jk) = pe3w_1d (jk) |
|---|
| 109 | END DO |
|---|
| 110 | ! |
|---|
| 111 | END SUBROUTINE usr_def_zgr |
|---|
| 112 | |
|---|
| 113 | !!====================================================================== |
|---|
| 114 | END MODULE usrdef_zgr |
|---|
