source: NEMO/branches/2019/dev_r10984_HPC-13_IRRMANN_BDY_optimization/tests/VORTEX/MY_SRC/usrdef_nam.F90 @ 11317

Last change on this file since 11317 was 11317, checked in by smasson, 14 months ago

dev_r10984_HPC-13 : improve error handling, see #2307 and #2285

  • Property svn:keywords set to Id
File size: 5.5 KB
Line 
1MODULE usrdef_nam
2   !!======================================================================
3   !!                       ***  MODULE  usrdef_nam  ***
4   !!
5   !!                      ===  VORTEX configuration  ===
6   !!
7   !! User defined : set the domain characteristics of a user configuration
8   !!======================================================================
9   !! History :  NEMO ! 2017-10  (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  , ONLY: nimpp , njmpp            ! i- & j-indices of the local domain
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_ppgphi0 ! reference latitude for beta-plane
34
35   !!----------------------------------------------------------------------
36   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
37   !! $Id$
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 VORTEX 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/  rn_dx, rn_dy, rn_dz, rn_ppgphi0
63      !!----------------------------------------------------------------------
64      !
65      REWIND( numnam_cfg )          ! Namelist namusr_def (exist in namelist_cfg only)
66      READ  ( numnam_cfg, namusr_def, IOSTAT = ios, ERR = 902 )
67902   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namusr_def in configuration namelist' )
68      !
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_ppgphi0 = Agrif_Parent(rn_ppgphi0)
76      ENDIF
77#endif
78      !
79      WRITE( numond, namusr_def )
80      !
81      cd_cfg = 'VORTEX'             ! name & resolution (not used)
82      kk_cfg = INT( rn_dx )
83      !
84      ! Global Domain size:  VORTEX global domain is  1800 km x 1800 Km x 5000 m
85      kpi = INT( 1800.e3  / rn_dx ) + 3 
86      kpj = INT( 1800.e3  / rn_dy ) + 3 
87      kpk = INT( 5000._wp / rn_dz ) + 1
88#if defined key_agrif
89      IF( .NOT. Agrif_Root() ) THEN
90         kpi  = nbcellsx + 2 + 2*nbghostcells
91         kpj  = nbcellsy + 2 + 2*nbghostcells
92      ENDIF
93#endif
94      !
95      zlx = (kpi-2)*rn_dx*1.e-3
96      zly = (kpj-2)*rn_dy*1.e-3
97      zh  = (kpk-1)*rn_dz
98      !                             ! control print
99      WRITE(numout,*) '   '
100      WRITE(numout,*) 'usr_def_nam  : read the user defined namelist (namusr_def) in namelist_cfg'
101      WRITE(numout,*) '~~~~~~~~~~~ '
102      WRITE(numout,*) '   Namelist namusr_def : VORTEX test case'
103      WRITE(numout,*) '      horizontal resolution             rn_dx  = ', rn_dx, ' m'
104      WRITE(numout,*) '      horizontal resolution             rn_dy  = ', rn_dy, ' m'
105      WRITE(numout,*) '      vertical resolution               rn_dz  = ', rn_dz, ' m'
106      WRITE(numout,*) '      VORTEX domain: '
107      WRITE(numout,*) '         LX [km]: ', zlx
108      WRITE(numout,*) '         LY [km]: ', zly
109      WRITE(numout,*) '          H [m] : ', zh
110      WRITE(numout,*) '      Reference latitude            rn_ppgphi0 = ', rn_ppgphi0
111      !
112      !                             ! Set the lateral boundary condition of the global domain
113      kperio = 0                    ! VORTEX configuration : closed basin
114      !
115      WRITE(numout,*) '   '
116      WRITE(numout,*) '   Lateral boundary condition of the global domain'
117      WRITE(numout,*) '      VORTEX : closed basin            jperio = ', kperio
118      !
119   END SUBROUTINE usr_def_nam
120
121   !!======================================================================
122END MODULE usrdef_nam
Note: See TracBrowser for help on using the repository browser.