source: NEMO/trunk/tests/ICE_ADV2D/MY_SRC/usrdef_hgr.F90 @ 10515

Last change on this file since 10515 was 10515, checked in by clem, 20 months ago

add a demo configuration for a diagonal advection of a patch of ice in a square basin

File size: 9.0 KB
Line 
1MODULE usrdef_hgr
2   !!======================================================================
3   !!                       ***  MODULE  usrdef_hgr  ***
4   !!
5   !!                      ===  ICE_ADV2D 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_ADV2D 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   !!----------------------------------------------------------------------
29   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
30   !! $Id: usrdef_hgr.F90 10074 2018-08-28 16:15:49Z nicolasmartin $
31   !! Software governed by the CeCILL license (see ./LICENSE)
32   !!----------------------------------------------------------------------
33CONTAINS
34
35   SUBROUTINE usr_def_hgr( plamt , plamu , plamv  , plamf  ,   &   ! geographic position (required)
36      &                    pphit , pphiu , pphiv  , pphif  ,   &   !
37      &                    kff   , pff_f , pff_t  ,            &   ! Coriolis parameter  (if domain not on the sphere)
38      &                    pe1t  , pe1u  , pe1v   , pe1f   ,   &   ! scale factors       (required)
39      &                    pe2t  , pe2u  , pe2v   , pe2f   ,   &   !
40      &                    ke1e2u_v      , pe1e2u , pe1e2v     )   ! u- & v-surfaces (if gridsize reduction is used in strait(s))
41      !!----------------------------------------------------------------------
42      !!                  ***  ROUTINE usr_def_hgr  ***
43      !!
44      !! ** Purpose :   user defined mesh and Coriolis parameter
45      !!
46      !! ** Method  :   set all intent(out) argument to a proper value
47      !!                ICE_ADV2D configuration : uniform grid spacing (rn_dx)
48      !!                without Coriolis force (f=0)
49      !!
50      !! ** Action  : - define longitude & latitude of t-, u-, v- and f-points (in degrees)
51      !!              - define coriolis parameter at f-point if the domain in not on the sphere (on beta-plane)
52      !!              - define i- & j-scale factors at t-, u-, v- and f-points (in meters)
53      !!              - define u- & v-surfaces (if gridsize reduction is used in some straits) (in m2)
54      !!----------------------------------------------------------------------
55      REAL(wp), DIMENSION(:,:), INTENT(out) ::   plamt, plamu, plamv, plamf   ! longitude outputs                     [degrees]
56      REAL(wp), DIMENSION(:,:), INTENT(out) ::   pphit, pphiu, pphiv, pphif   ! latitude outputs                      [degrees]
57      INTEGER                 , INTENT(out) ::   kff                          ! =1 Coriolis parameter computed here, =0 otherwise
58      REAL(wp), DIMENSION(:,:), INTENT(out) ::   pff_f, pff_t                 ! Coriolis factor at f-point                [1/s]
59      REAL(wp), DIMENSION(:,:), INTENT(out) ::   pe1t, pe1u, pe1v, pe1f       ! i-scale factors                             [m]
60      REAL(wp), DIMENSION(:,:), INTENT(out) ::   pe2t, pe2u, pe2v, pe2f       ! j-scale factors                             [m]
61      INTEGER                 , INTENT(out) ::   ke1e2u_v                     ! =1 u- & v-surfaces computed here, =0 otherwise
62      REAL(wp), DIMENSION(:,:), INTENT(out) ::   pe1e2u, pe1e2v               ! u- & v-surfaces (if reduction in strait)   [m2]
63      !
64      INTEGER  ::   ji, jj   ! dummy loop indices
65      REAL(wp) ::   zphi0, zlam0, zbeta, zf0
66      REAL(wp) ::   zti, zui, ztj, zvj   ! local scalars
67      !!-------------------------------------------------------------------------------
68      !
69      IF(lwp) WRITE(numout,*)
70      IF(lwp) WRITE(numout,*) 'usr_def_hgr : ICE_ADV2D configuration bassin'
71      IF(lwp) WRITE(numout,*)
72      IF(lwp) WRITE(numout,*) '          f-plane with regular or irregular grid-spacing (+- 10%)'
73      IF(lwp) WRITE(numout,*) '          the max is given by rn_dx and rn_dy' 
74
75      !                          ==========
76      zlam0 = -(jpiglo-1)/2 * 1.e-3 * rn_dx
77      zphi0 = -(jpjglo-1)/2 * 1.e-3 * rn_dy
78
79#if defined key_agrif 
80      IF( .NOT. Agrif_Root() ) THEN
81!clem         zlam0  = Agrif_Parent(zlam0) + (Agrif_ix())*Agrif_Parent(rn_dx) * 1.e-5
82!clem         zphi0  = Agrif_Parent(zphi0) + (Agrif_iy())*Agrif_Parent(rn_dy) * 1.e-5
83         zlam0 = ( 0.5_wp - ( Agrif_parent(jpiglo) - 1 ) / 2 ) * 1.e-3 * Agrif_irhox() * rn_dx  &
84            &  + ( Agrif_Ix() + nbghostcells - 1 ) * Agrif_irhox() * rn_dx * 1.e-3 - ( 0.5_wp + nbghostcells ) * rn_dx * 1.e-3
85         zphi0 = ( 0.5_wp - ( Agrif_parent(jpjglo) - 1 ) / 2 ) * 1.e-3 * Agrif_irhoy() * rn_dy  &
86            &  + ( Agrif_Iy() + nbghostcells - 1 ) * Agrif_irhoy() * rn_dy * 1.e-3 - ( 0.5_wp + nbghostcells ) * rn_dy * 1.e-3
87      ENDIF
88#endif         
89
90      DO jj = 1, jpj
91         DO ji = 1, jpi
92            zti = FLOAT( ji - 1 + nimpp - 1 )          ;  ztj = FLOAT( jj - 1 + njmpp - 1 )
93            zui = FLOAT( ji - 1 + nimpp - 1 ) + 0.5_wp ;  zvj = FLOAT( jj - 1 + njmpp - 1 ) + 0.5_wp
94
95            plamt(ji,jj) = zlam0 + rn_dx * 1.e-3 * zti
96            plamu(ji,jj) = zlam0 + rn_dx * 1.e-3 * zui
97            plamv(ji,jj) = plamt(ji,jj) 
98            plamf(ji,jj) = plamu(ji,jj) 
99   
100            pphit(ji,jj) = zphi0 + rn_dy * 1.e-3 * ztj
101            pphiv(ji,jj) = zphi0 + rn_dy * 1.e-3 * zvj
102            pphiu(ji,jj) = pphit(ji,jj) 
103            pphif(ji,jj) = pphiv(ji,jj) 
104         END DO
105      END DO
106         
107         ! Horizontal scale factors (in meters)
108         !                              ======
109!! ==> EITHER 1) variable scale factors
110!! clem: This can be used with a 1proc simulation but I think it breaks repro when >1procs are used     
111!!         DO jj = 1, jpj
112!!            DO ji = 1, jpi
113!!               !!pe1t(ji,jj) = rn_dx * EXP( -0.8/REAL(jpiglo**2) * (mi0(ji)-REAL(jpiglo+1)*0.5)**2 )  ! gaussian shape
114!!               !!pe2t(ji,jj) = rn_dy * EXP( -0.8/REAL(jpjglo**2) * (mj0(jj)-REAL(jpjglo+1)*0.5)**2 )  ! gaussian shape
115!!               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
116!!               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
117!!            END DO
118!!         END DO
119!!#if defined key_agrif
120!!         IF( .NOT. Agrif_Root() ) THEN ! only works if the zoom is positioned at the center of the parent grid
121!!            DO jj = 1, jpj
122!!               DO ji = 1, jpi
123!!                  pe1t(ji,jj) = rn_dx * ( 1. -0.1 * ABS(REAL(mi0(ji))-REAL(jpiglo+1)*0.5) / (1.-REAL(jpiglo+1)*0.5)  &
124!!                     &                            * REAL(jpiglo) / REAL(Agrif_Parent(jpiglo) * Agrif_Rhox()) )       ! factor to match parent grid
125!!                  pe2t(ji,jj) = rn_dy * ( 1. -0.1 * ABS(REAL(mj0(jj))-REAL(jpjglo+1)*0.5) / (1.-REAL(jpjglo+1)*0.5)  &
126!!                     &                            * REAL(jpjglo) / REAL(Agrif_Parent(jpjglo) * Agrif_Rhoy()) )       ! factor to match parent grid
127!!               END DO
128!!            END DO
129!!         ENDIF
130!!#endif
131!! ==> OR 2) constant scale factors
132         pe1t(:,:) = rn_dx
133         pe2t(:,:) = rn_dy
134!! ==> END
135         
136      pe1u(:,:) = pe1t(:,:)      ;      pe2u(:,:) = pe2t(:,:)
137      pe1v(:,:) = pe1t(:,:)      ;      pe2v(:,:) = pe2t(:,:)
138      pe1f(:,:) = pe1t(:,:)      ;      pe2f(:,:) = pe2t(:,:)
139
140      !                             ! NO reduction of grid size in some straits
141      ke1e2u_v = 0                  !    ==>> u_ & v_surfaces will be computed in dom_ghr routine
142      pe1e2u(:,:) = 0._wp           !    CAUTION: set to zero to avoid error with some compilers that
143      pe1e2v(:,:) = 0._wp           !             require an initialization of INTENT(out) arguments
144      !
145      !
146      !                       !==  Coriolis parameter  ==!
147      kff = 1                       !  indicate not to compute Coriolis parameter afterward
148      !
149      IF( ln_corio ) THEN
150         zbeta = 2._wp * omega * COS( rad * rn_ppgphi0 ) / ra
151         zf0   = 2._wp * omega * SIN( rad * rn_ppgphi0 )
152         pff_f(:,:) = zf0 + zbeta * pphif(:,:) * 1.e+3
153         pff_t(:,:) = zf0 + zbeta * pphit(:,:) * 1.e+3
154      ELSE
155         pff_f(:,:) = 0.
156         pff_t(:,:) = 0.
157      ENDIF
158      !
159   END SUBROUTINE usr_def_hgr
160
161   !!======================================================================
162END MODULE usrdef_hgr
Note: See TracBrowser for help on using the repository browser.