source: NEMO/trunk/tests/DOME/MY_SRC/usrdef_nam.F90 @ 14254

Last change on this file since 14254 was 14254, checked in by jchanut, 4 months ago

#2222, DOME test case: for completeness, add online domain definition. input parameters changes

File size: 6.1 KB
Line 
1MODULE usrdef_nam
2   !!======================================================================
3   !!                       ***  MODULE  usrdef_nam  ***
4   !!
5   !!                      ===  DOME configuration  ===
6   !!
7   !! User defined : set the domain characteristics of a user configuration
8   !!======================================================================
9   !! History :  NEMO ! 2020-12  (J. Chanut)  Original code
10   !!----------------------------------------------------------------------
11
12   !!----------------------------------------------------------------------
13   !!   usr_def_nam   : read user defined namelist and set global domain size
14   !!   usr_def_hgr   : initialize the horizontal mesh
15   !!----------------------------------------------------------------------
16   USE dom_oce
17   USE par_oce        ! ocean space and time domain
18   USE phycst         ! physical constants
19   !
20   USE in_out_manager ! I/O manager
21   USE lib_mpp        ! MPP library
22   USE timing         ! Timing
23   
24   IMPLICIT NONE
25   PRIVATE
26
27   PUBLIC   usr_def_nam   ! called by nemogcm.F90
28
29   !                              !!* namusr_def namelist *!!
30   REAL(wp), PUBLIC ::   rn_dx      ! resolution in meters defining the horizontal domain size
31   REAL(wp), PUBLIC ::   rn_dy      ! resolution in meters defining the horizontal domain size
32   REAL(wp), PUBLIC ::   rn_dz      ! vertical resolution
33   REAL(wp), PUBLIC ::   rn_f0      ! Coriolis frequency
34
35   !!----------------------------------------------------------------------
36   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
37   !! $Id: usrdef_nam.F90 14086 2020-12-04 11:37:14Z cetlod $
38   !! Software governed by the CeCILL license (see ./LICENSE)
39   !!----------------------------------------------------------------------
40CONTAINS
41
42   SUBROUTINE usr_def_nam( cd_cfg, kk_cfg, kpi, kpj, kpk, kperio )
43      !!----------------------------------------------------------------------
44      !!                     ***  ROUTINE dom_nam  ***
45      !!                   
46      !! ** Purpose :   read user defined namelist and define the domain size
47      !!
48      !! ** Method  :   read in namusr_def containing all the user specific namelist parameter
49      !!
50      !!                Here DOME configuration
51      !!
52      !! ** input   : - namusr_def namelist found in namelist_cfg
53      !!----------------------------------------------------------------------
54      CHARACTER(len=*)              , INTENT(out) ::   cd_cfg          ! configuration name
55      INTEGER                       , INTENT(out) ::   kk_cfg          ! configuration resolution
56      INTEGER                       , INTENT(out) ::   kpi, kpj, kpk   ! global domain sizes
57      INTEGER                       , INTENT(out) ::   kperio          ! lateral global domain b.c.
58      !
59      INTEGER ::   ios          ! Local integer
60      REAL(wp)::   zlx, zly, zh ! Local scalars
61      !!
62      NAMELIST/namusr_def/  ln_zco, ln_zps, ln_sco, rn_dx, rn_dz, rn_f0
63      !!----------------------------------------------------------------------
64      !
65      READ  ( numnam_cfg, namusr_def, IOSTAT = ios, ERR = 902 )
66902   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namusr_def in configuration namelist' )
67      !
68      rn_dy = rn_dx
69#if defined key_agrif 
70      ! Domain parameters are taken from parent:
71      IF( .NOT. Agrif_Root() ) THEN
72         rn_dx = Agrif_Parent(rn_dx)/Agrif_Rhox()
73         rn_dy = Agrif_Parent(rn_dy)/Agrif_Rhoy()
74         rn_dz = Agrif_Parent(rn_dz)
75         rn_f0 = Agrif_Parent(rn_f0)
76      ENDIF
77#endif
78      !
79      IF(lwm)   WRITE( numond, namusr_def )
80      !
81      cd_cfg = 'DOME'               ! name & resolution (not used)
82      kk_cfg = nINT( rn_dx )
83      !
84      IF( Agrif_Root() ) THEN       ! Global Domain size:  DOME  global domain is  2000 km x 850 Km x 3600 m
85         kpi = NINT( 2000.e3  / rn_dx ) + 2 
86         kpj = NINT(  850.e3  / rn_dy ) + 2 + 1 
87      ELSE                          ! Global Domain size: add nbghostcells + 1 "land" point on each side
88         kpi  = nbcellsx + 2 * ( nbghostcells + 1 )
89         kpj  = nbcellsy + 2 * ( nbghostcells + 1 )
90!!$         kpi  = nbcellsx + nbghostcells_x   + nbghostcells_x   + 2
91!!$         kpj  = nbcellsy + nbghostcells_y_s + nbghostcells_y_n + 2
92      ENDIF
93      kpk = NINT( 3600._wp / rn_dz ) + 1
94      !
95      zlx = (kpi-2)*rn_dx*1.e-3
96      zly = (kpj-2-1)*rn_dy*1.e-3
97      zh  = (kpk-1)*rn_dz
98      !                             ! Set the lateral boundary condition of the global domain
99      kperio = 0                    ! DOME configuration : closed basin
100      !                             ! control print
101      IF(lwp) THEN
102         WRITE(numout,*) '   '
103         WRITE(numout,*) 'usr_def_nam  : read the user defined namelist (namusr_def) in namelist_cfg'
104         WRITE(numout,*) '~~~~~~~~~~~ '
105         WRITE(numout,*) '   Namelist namusr_def : DOME test case'
106         WRITE(numout,*) '      z-coordinate flag                 ln_zco = ', ln_zco
107         WRITE(numout,*) '      z-partial-step coordinate flag    ln_zps = ', ln_zps 
108         WRITE(numout,*) '      s-coordinate flag                 ln_sco = ', ln_sco 
109         WRITE(numout,*) '      horizontal resolution             rn_dx  = ', rn_dx, ' m'
110         WRITE(numout,*) '      vertical resolution               rn_dz  = ', rn_dz, ' m'
111         WRITE(numout,*) '      resulting global domain size :    Ni0glo = ', kpi
112         WRITE(numout,*) '                                        Nj0glo = ', kpj
113         WRITE(numout,*) '                                        jpkglo = ', kpk
114         WRITE(numout,*) '      DOME domain: '
115         WRITE(numout,*) '         LX [km]: ', zlx
116         WRITE(numout,*) '         LY [km]: ', zly
117         WRITE(numout,*) '          H [m] : ', zh
118         WRITE(numout,*) '      Coriolis frequency                rn_f0 = ', rn_f0, ' s-1'
119         WRITE(numout,*) '   '
120         WRITE(numout,*) '   Lateral boundary condition of the global domain'
121         WRITE(numout,*) '      DOME : closed basin            jperio = ', kperio
122      ENDIF
123      !
124   END SUBROUTINE usr_def_nam
125
126   !!======================================================================
127END MODULE usrdef_nam
Note: See TracBrowser for help on using the repository browser.