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

Last change on this file since 12489 was 12489, checked in by davestorkey, 7 months ago

Preparation for new timestepping scheme #2390.
Main changes:

  1. Initial euler timestep now handled in stp and not in TRA/DYN routines.
  2. Renaming of all timestep parameters. In summary, the namelist parameter is now rn_Dt and the current timestep is rDt (and rDt_ice, rDt_trc etc).
  3. Renaming of a few miscellaneous parameters, eg. atfp → rn_atfp (namelist parameter used everywhere) and rau0 → rho0.

This version gives bit-comparable results to the previous version of the trunk.

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