source: NEMO/trunk/tests/ICE_AGRIF/MY_SRC/usrdef_hgr.F90 @ 14223

Last change on this file since 14223 was 14223, checked in by smasson, 9 months ago

trunk: remove patch for compatibility with the old trunk

  • Property svn:keywords set to Id
File size: 9.0 KB
Line 
1MODULE usrdef_hgr
2   !!======================================================================
3   !!                       ***  MODULE  usrdef_hgr  ***
4   !!
5   !!                      ===  ICE_AGRIF configuration  ===
6   !!
7   !! User defined :   mesh and Coriolis parameter of a user configuration
8   !!======================================================================
9   !! History :  NEMO  ! 2016-08  (S. Flavoni, G. Madec)  Original code
10   !!----------------------------------------------------------------------
11
12   !!----------------------------------------------------------------------
13   !!   usr_def_hgr    : initialize the horizontal mesh for ICE_AGRIF configuration
14   !!----------------------------------------------------------------------
15   USE dom_oce         ! ocean space and time domain
16   USE par_oce         ! ocean space and time domain
17   USE phycst          ! physical constants
18   USE usrdef_nam, ONLY: rn_dx, rn_dy, ln_corio, rn_ppgphi0   ! horizontal resolution in meters
19   !                                                            coriolis and reference latitude
20   USE in_out_manager  ! I/O manager
21   USE lib_mpp         ! MPP library
22   
23   IMPLICIT NONE
24   PRIVATE
25
26   PUBLIC   usr_def_hgr   ! called by domhgr.F90
27
28   !! * Substitutions
29#  include "do_loop_substitute.h90"
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_hgr( plamt , plamu , plamv  , plamf  ,   &   ! geographic position (required)
38      &                    pphit , pphiu , pphiv  , pphif  ,   &   !
39      &                    kff   , pff_f , pff_t  ,            &   ! Coriolis parameter  (if domain not on the sphere)
40      &                    pe1t  , pe1u  , pe1v   , pe1f   ,   &   ! scale factors       (required)
41      &                    pe2t  , pe2u  , pe2v   , pe2f   ,   &   !
42      &                    ke1e2u_v      , pe1e2u , pe1e2v     )   ! u- & v-surfaces (if gridsize reduction is used in strait(s))
43      !!----------------------------------------------------------------------
44      !!                  ***  ROUTINE usr_def_hgr  ***
45      !!
46      !! ** Purpose :   user defined mesh and Coriolis parameter
47      !!
48      !! ** Method  :   set all intent(out) argument to a proper value
49      !!                ICE_AGRIF configuration : uniform grid spacing (rn_dx)
50      !!                without Coriolis force (f=0)
51      !!
52      !! ** Action  : - define longitude & latitude of t-, u-, v- and f-points (in degrees)
53      !!              - define coriolis parameter at f-point if the domain in not on the sphere (on beta-plane)
54      !!              - define i- & j-scale factors at t-, u-, v- and f-points (in meters)
55      !!              - define u- & v-surfaces (if gridsize reduction is used in some straits) (in m2)
56      !!----------------------------------------------------------------------
57      REAL(wp), DIMENSION(:,:), INTENT(out) ::   plamt, plamu, plamv, plamf   ! longitude outputs                     [degrees]
58      REAL(wp), DIMENSION(:,:), INTENT(out) ::   pphit, pphiu, pphiv, pphif   ! latitude outputs                      [degrees]
59      INTEGER                 , INTENT(out) ::   kff                          ! =1 Coriolis parameter computed here, =0 otherwise
60      REAL(wp), DIMENSION(:,:), INTENT(out) ::   pff_f, pff_t                 ! Coriolis factor at f-point                [1/s]
61      REAL(wp), DIMENSION(:,:), INTENT(out) ::   pe1t, pe1u, pe1v, pe1f       ! i-scale factors                             [m]
62      REAL(wp), DIMENSION(:,:), INTENT(out) ::   pe2t, pe2u, pe2v, pe2f       ! j-scale factors                             [m]
63      INTEGER                 , INTENT(out) ::   ke1e2u_v                     ! =1 u- & v-surfaces computed here, =0 otherwise
64      REAL(wp), DIMENSION(:,:), INTENT(out) ::   pe1e2u, pe1e2v               ! u- & v-surfaces (if reduction in strait)   [m2]
65      !
66      INTEGER  ::   ji, jj     ! dummy loop indices
67      REAL(wp) ::   zphi0, zlam0, zbeta, zf0
68      REAL(wp) ::   zti, ztj   ! local scalars
69      !!-------------------------------------------------------------------------------
70      !
71      IF(lwp) WRITE(numout,*)
72      IF(lwp) WRITE(numout,*) 'usr_def_hgr : ICE_AGRIF configuration bassin'
73      IF(lwp) WRITE(numout,*)
74      IF(lwp) WRITE(numout,*) '          f-plane with irregular grid-spacing (+- 10%)'
75      IF(lwp) WRITE(numout,*) '          the max is given by rn_dx and rn_dy' 
76
77      !                          ==========
78#if defined key_agrif 
79      IF( Agrif_Root() ) THEN
80#endif
81         zlam0 = -REAL(Ni0glo, wp) * 0.5 * 1.e-3 * rn_dx
82         zphi0 = -REAL(Nj0glo, wp) * 0.5 * 1.e-3 * rn_dy
83#if defined key_agrif 
84      ELSE
85         ! ! let lower left longitude and latitude from parent
86!clem         zlam0  = Agrif_Parent(zlam0) + (Agrif_ix())*Agrif_Parent(rn_dx) * 1.e-5
87!clem         zphi0  = Agrif_Parent(zphi0) + (Agrif_iy())*Agrif_Parent(rn_dy) * 1.e-5
88         zlam0 = ( 0.5_wp - REAL(Ni0glo, wp) * 0.5 ) * 1.e-3 * Agrif_irhox() * rn_dx  &
89            &  + ( Agrif_Ix() + nbghostcells - 1 ) * Agrif_irhox() * rn_dx * 1.e-3 - ( 0.5_wp + nbghostcells ) * rn_dx * 1.e-3
90         zphi0 = ( 0.5_wp - REAL(Nj0glo, wp) * 0.5 ) * 1.e-3 * Agrif_irhoy() * rn_dy  &
91            &  + ( Agrif_Iy() + nbghostcells - 1 ) * Agrif_irhoy() * rn_dy * 1.e-3 - ( 0.5_wp + nbghostcells ) * rn_dy * 1.e-3
92      ENDIF
93#endif         
94
95      DO_2D( nn_hls, nn_hls, nn_hls, nn_hls )
96         zti = REAL( mig0(ji), wp ) - 0.5_wp  ! start at i=0.5 in the global grid without halos
97         ztj = REAL( mjg0(jj), wp ) - 0.5_wp  ! start at j=0.5 in the global grid without halos
98         
99         plamt(ji,jj) = zlam0 + rn_dx * 1.e-3 *   zti
100         plamu(ji,jj) = zlam0 + rn_dx * 1.e-3 * ( zti + 0.5_wp )
101         plamv(ji,jj) = plamt(ji,jj) 
102         plamf(ji,jj) = plamu(ji,jj) 
103         
104         pphit(ji,jj) = zphi0 + rn_dy * 1.e-3 *   ztj
105         pphiv(ji,jj) = zphi0 + rn_dy * 1.e-3 * ( ztj + 0.5_wp )
106         pphiu(ji,jj) = pphit(ji,jj) 
107         pphif(ji,jj) = pphiv(ji,jj) 
108      END_2D
109         
110         ! Horizontal scale factors (in meters)
111         !                              ======
112!! ==> EITHER 1) variable scale factors
113!! clem: This can be used with a 1proc simulation but I think it breaks repro when >1procs are used     
114!!         DO jj = 1, jpj
115!!            DO ji = 1, jpi
116!!               !!pe1t(ji,jj) = rn_dx * EXP( -0.8/REAL(jpiglo**2) * (mi0(ji)-REAL(jpiglo+1)*0.5)**2 )  ! gaussian shape
117!!               !!pe2t(ji,jj) = rn_dy * EXP( -0.8/REAL(jpjglo**2) * (mj0(jj)-REAL(jpjglo+1)*0.5)**2 )  ! gaussian shape
118!!               pe1t(ji,jj) = rn_dx * ( 1. -0.1 * ABS(REAL(mi0(ji))-REAL(jpiglo+1)*0.5) / (1.-REAL(jpiglo+1)*0.5) ) ! linear shape
119!!               pe2t(ji,jj) = rn_dy * ( 1. -0.1 * ABS(REAL(mj0(jj))-REAL(jpjglo+1)*0.5) / (1.-REAL(jpjglo+1)*0.5) ) ! linear shape
120!!            END DO
121!!         END DO
122!!#if defined key_agrif
123!!         IF( .NOT. Agrif_Root() ) THEN ! only works if the zoom is positioned at the center of the parent grid
124!!            DO jj = 1, jpj
125!!               DO ji = 1, jpi
126!!                  pe1t(ji,jj) = rn_dx * ( 1. -0.1 * ABS(REAL(mi0(ji))-REAL(jpiglo+1)*0.5) / (1.-REAL(jpiglo+1)*0.5)  &
127!!                     &                            * REAL(jpiglo) / REAL(Agrif_Parent(jpiglo) * Agrif_Rhox()) )       ! factor to match parent grid
128!!                  pe2t(ji,jj) = rn_dy * ( 1. -0.1 * ABS(REAL(mj0(jj))-REAL(jpjglo+1)*0.5) / (1.-REAL(jpjglo+1)*0.5)  &
129!!                     &                            * REAL(jpjglo) / REAL(Agrif_Parent(jpjglo) * Agrif_Rhoy()) )       ! factor to match parent grid
130!!               END DO
131!!            END DO
132!!         ENDIF
133!!#endif
134!! ==> OR 2) constant scale factors
135         pe1t(:,:) = rn_dx
136         pe2t(:,:) = rn_dy
137!! ==> END
138         
139      pe1u(:,:) = pe1t(:,:)      ;      pe2u(:,:) = pe2t(:,:)
140      pe1v(:,:) = pe1t(:,:)      ;      pe2v(:,:) = pe2t(:,:)
141      pe1f(:,:) = pe1t(:,:)      ;      pe2f(:,:) = pe2t(:,:)
142
143      !                             ! NO reduction of grid size in some straits
144      ke1e2u_v = 0                  !    ==>> u_ & v_surfaces will be computed in dom_ghr routine
145      pe1e2u(:,:) = 0._wp           !    CAUTION: set to zero to avoid error with some compilers that
146      pe1e2v(:,:) = 0._wp           !             require an initialization of INTENT(out) arguments
147      !
148      !
149      !                       !==  Coriolis parameter  ==!
150      kff = 1                       !  indicate not to compute Coriolis parameter afterward
151      !
152      IF( ln_corio ) THEN
153         zbeta = 2._wp * omega * COS( rad * rn_ppgphi0 ) / ra
154         zf0   = 2._wp * omega * SIN( rad * rn_ppgphi0 )
155         pff_f(:,:) = zf0 + zbeta * pphif(:,:) * 1.e+3
156         pff_t(:,:) = zf0 + zbeta * pphit(:,:) * 1.e+3
157      ELSE
158         pff_f(:,:) = 0.
159         pff_t(:,:) = 0.
160      ENDIF
161      !
162   END SUBROUTINE usr_def_hgr
163
164   !!======================================================================
165END MODULE usrdef_hgr
Note: See TracBrowser for help on using the repository browser.