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.
usrdef_istate.F90 in NEMO/trunk/tests/VORTEX/MY_SRC – NEMO

source: NEMO/trunk/tests/VORTEX/MY_SRC/usrdef_istate.F90 @ 14117

Last change on this file since 14117 was 14086, checked in by cetlod, 3 years ago

Adding AGRIF branches into the trunk
  • Property svn:keywords set to Id
File size: 7.2 KB
Line 
1MODULE usrdef_istate
2   !!======================================================================
3   !!                     ***  MODULE usrdef_istate   ***
4   !!
5   !!                      ===  VORTEX configuration  ===
6   !!
7   !! User defined : set the initial state of a user configuration
8   !!======================================================================
9   !! History :  NEMO ! 2017-11  (J. Chanut) Original code
10   !!                 ! 2020-11  (S. Techene, G. Madec) separate tsuv from ssh
11   !!----------------------------------------------------------------------
12
13   !!----------------------------------------------------------------------
14   !!  usr_def_istate : initial state in Temperature and salinity
15   !!----------------------------------------------------------------------
16   USE par_oce        ! ocean space and time domain
17   USE dom_oce , ONLY : glamt, gphit, glamu, gphiu, glamv, gphiv 
18   USE phycst         ! physical constants
19   !
20   USE in_out_manager ! I/O manager
21   USE lib_mpp        ! MPP library
22   USE lbclnk         ! ocean lateral boundary conditions (or mpp link)
23   !   
24   USE usrdef_nam, ONLY : rn_ppgphi0  ! Reference latitude   
25   
26   IMPLICIT NONE
27   PRIVATE
28
29   PUBLIC   usr_def_istate       ! called by istate.F90
30   PUBLIC   usr_def_istate_ssh   ! called by domqco.F90
31
32   !! * Substitutions
33#  include "do_loop_substitute.h90"
34   !!----------------------------------------------------------------------
35   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
36   !! $Id$
37   !! Software governed by the CeCILL license (see ./LICENSE)
38   !!----------------------------------------------------------------------
39CONTAINS
40 
41   SUBROUTINE usr_def_istate( pdept, ptmask, pts, pu, pv )
42      !!----------------------------------------------------------------------
43      !!                   ***  ROUTINE usr_def_istate  ***
44      !!
45      !! ** Purpose :   Initialization of the dynamics and tracers
46      !!                Here VORTEX configuration
47      !!
48      !! ** Method  :   Set a gaussian anomaly of pressure and associated
49      !!                geostrophic velocities
50      !!----------------------------------------------------------------------
51      REAL(wp), DIMENSION(jpi,jpj,jpk)     , INTENT(in   ) ::   pdept   ! depth of t-point               [m]
52      REAL(wp), DIMENSION(jpi,jpj,jpk)     , INTENT(in   ) ::   ptmask  ! t-point ocean mask             [m]
53      REAL(wp), DIMENSION(jpi,jpj,jpk,jpts), INTENT(  out) ::   pts     ! T & S fields      [Celsius ; g/kg]
54      REAL(wp), DIMENSION(jpi,jpj,jpk)     , INTENT(  out) ::   pu      ! i-component of the velocity  [m/s]
55      REAL(wp), DIMENSION(jpi,jpj,jpk)     , INTENT(  out) ::   pv      ! j-component of the velocity  [m/s]
56      !
57      INTEGER  :: ji, jj, jk  ! dummy loop indices
58      REAL(wp) :: zx, zy, zP0, zumax, zlambda, zn2, zf0, zH, zrho1, za, zf
59      REAL(wp) :: zdt, zdu, zdv
60      !!----------------------------------------------------------------------
61      !
62      IF(lwp) WRITE(numout,*)
63      IF(lwp) WRITE(numout,*) 'usr_def_istate : VORTEX configuration, analytical definition of initial state'
64      IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~~~   '
65      !
66      !
67      !
68      zf0   = 2._wp * omega * SIN( rad * rn_ppgphi0 )
69      zumax = 1._wp * SIGN(1._wp, zf0) ! Here Anticyclonic: set zumax=-1 for cyclonic
70      zlambda = SQRT(2._wp)*60.e3      ! Horizontal scale in meters
71      zn2 = 3.e-3**2
72      zH = 0.5_wp * 5000._wp
73      !
74      zP0 = rho0 * zf0 * zumax * zlambda * SQRT(EXP(1._wp)/2._wp)
75      !
76      ! temperature:         
77      DO_2D( 1, 1, 1, 1 )
78         zx = glamt(ji,jj) * 1.e3
79         zy = gphit(ji,jj) * 1.e3
80         DO jk=1,jpk
81            zdt =  pdept(ji,jj,jk) 
82            zrho1 = rho0 * (1._wp + zn2*zdt/grav)
83            IF (zdt < zH) THEN
84               zrho1 = zrho1 - zP0 * (1._wp-EXP(zdt-zH)) &
85                  & * EXP(-(zx**2+zy**2)/zlambda**2) / (grav*(zH -1._wp + EXP(-zH)));
86            ENDIF
87            pts(ji,jj,jk,jp_tem) = (20._wp + (rho0-zrho1) / 0.28_wp) * ptmask(ji,jj,jk)
88         END DO
89      END_2D
90      !
91      ! salinity: 
92      pts(:,:,:,jp_sal) = 35._wp * ptmask(:,:,:) 
93      !
94      ! velocities:
95      za = 2._wp * zP0 / (zf0 * rho0 * zlambda**2)
96      DO_2D( 0, 0, 0, 0 )
97         zx = glamu(ji,jj) * 1.e3
98         zy = gphiu(ji,jj) * 1.e3
99         DO jk=1, jpk
100            zdu = 0.5_wp * (pdept(ji  ,jj,jk) + pdept(ji+1,jj,jk))
101            IF (zdu < zH) THEN
102               zf = (zH-1._wp-zdu+EXP(zdu-zH)) / (zH-1._wp+EXP(-zH))
103               pu(ji,jj,jk) = (za * zf * zy * EXP(-(zx**2+zy**2)/zlambda**2)) * ptmask(ji,jj,jk) * ptmask(ji+1,jj,jk)
104            ELSE
105               pu(ji,jj,jk) = 0._wp
106            ENDIF
107         END DO
108      END_2D
109      !
110      DO_2D( 0, 0, 0, 0 )
111         zx = glamv(ji,jj) * 1.e3
112         zy = gphiv(ji,jj) * 1.e3
113         DO jk=1, jpk
114            zdv = 0.5_wp * (pdept(ji  ,jj,jk) + pdept(ji,jj+1,jk))
115            IF (zdv < zH) THEN
116               zf = (zH-1._wp-zdv+EXP(zdv-zH)) / (zH-1._wp+EXP(-zH))
117               pv(ji,jj,jk) = -(za * zf * zx * EXP(-(zx**2+zy**2)/zlambda**2)) * ptmask(ji,jj,jk) * ptmask(ji,jj+1,jk)
118            ELSE
119               pv(ji,jj,jk) = 0._wp
120            ENDIF
121         END DO
122      END_2D
123      !
124      CALL lbc_lnk_multi( 'usrdef_istate', pu, 'U', -1., pv, 'V', -1. )
125      !   
126   END SUBROUTINE usr_def_istate
127
128
129   SUBROUTINE usr_def_istate_ssh( ptmask, pssh )
130      !!----------------------------------------------------------------------
131      !!                   ***  ROUTINE usr_def_istate  ***
132      !!
133      !! ** Purpose :   Initialization of ssh
134      !!                Here VORTEX configuration
135      !!
136      !! ** Method  :   Set ssh according to a gaussian anomaly of pressure and associated
137      !!                geostrophic velocities
138      !!----------------------------------------------------------------------
139      REAL(wp), DIMENSION(jpi,jpj,jpk)     , INTENT(in   ) ::   ptmask  ! t-point ocean mask   [m]
140      REAL(wp), DIMENSION(jpi,jpj)         , INTENT(  out) ::   pssh    ! sea-surface height   [m]
141      !
142      INTEGER  :: ji, jj ! dummy loop indices
143      REAL(wp) :: zx, zy, zP0, zumax, zlambda, zf0, zH, zrho1, za
144      !!----------------------------------------------------------------------
145      !
146      IF(lwp) WRITE(numout,*)
147      IF(lwp) WRITE(numout,*) 'usr_def_istate_ssh : VORTEX configuration, analytical definition of initial state'
148      IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~~~   '
149      !
150      !
151      !
152      zf0   = 2._wp * omega * SIN( rad * rn_ppgphi0 )
153      zumax = 1._wp * SIGN(1._wp, zf0) ! Here Anticyclonic: set zumax=-1 for cyclonic
154      zlambda = SQRT(2._wp)*60.e3      ! Horizontal scale in meters
155      zH = 0.5_wp * 5000._wp
156      !
157      zP0 = rho0 * zf0 * zumax * zlambda * SQRT(EXP(1._wp)/2._wp)
158      !
159      ! Sea level:
160      za = -zP0 * (1._wp-EXP(-zH)) / (grav*(zH-1._wp + EXP(-zH)))
161      DO_2D( 1, 1, 1, 1 )
162         zx = glamt(ji,jj) * 1.e3
163         zy = gphit(ji,jj) * 1.e3
164         zrho1 = rho0 + za * EXP(-(zx**2+zy**2)/zlambda**2)
165         pssh(ji,jj) = zP0 * EXP(-(zx**2+zy**2)/zlambda**2)/(zrho1*grav) * ptmask(ji,jj,1)
166      END_2D
167     
168   END SUBROUTINE usr_def_istate_ssh
169
170   !!======================================================================
171END MODULE usrdef_istate
Note: See TracBrowser for help on using the repository browser.