New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
usrdef_nam.F90 in NEMO/trunk/src/OCE/USR – NEMO

source: NEMO/trunk/src/OCE/USR/usrdef_nam.F90 @ 14433

Last change on this file since 14433 was 14433, checked in by smasson, 3 years ago

trunk: merge dev_r14312_MPI_Interface into the trunk, #2598

  • Property svn:keywords set to Id
File size: 5.1 KB
Line 
1MODULE usrdef_nam
2   !!======================================================================
3   !!                     ***  MODULE usrdef_nam   ***
4   !!
5   !!                     ===  GYRE configuration  ===
6   !!
7   !! User defined : set the domain characteristics of a user configuration
8   !!======================================================================
9   !! History :  4.0  ! 2016-03  (S. Flavoni, G. Madec)  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
23   IMPLICIT NONE
24   PRIVATE
25
26   PUBLIC   usr_def_nam   ! called in nemogcm.F90 module
27
28   !                              !!* namusr_def namelist *!!
29   LOGICAL, PUBLIC ::   ln_bench   ! =T benchmark test with gyre: the gridsize is constant (no need to adjust timestep or viscosity)
30   INTEGER, PUBLIC ::   nn_GYRE    ! 1/nn_GYRE = the resolution chosen in degrees and thus defining the horizontal domain size
31
32   !!----------------------------------------------------------------------
33   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
34   !! $Id$
35   !! Software governed by the CeCILL license (see ./LICENSE)
36   !!----------------------------------------------------------------------
37CONTAINS
38
39   SUBROUTINE usr_def_nam( cd_cfg, kk_cfg, kpi, kpj, kpk, ldIperio, ldJperio, ldNFold, cdNFtype )
40      !!----------------------------------------------------------------------
41      !!                     ***  ROUTINE dom_nam  ***
42      !!
43      !! ** Purpose :   read user defined namelist and define the domain size
44      !!
45      !! ** Method  :   read in namusr_def containing all the user specific namelist parameter
46      !!
47      !!                Here GYRE configuration
48      !!
49      !! ** input   : - namusr_def namelist found in namelist_cfg
50      !!----------------------------------------------------------------------
51      CHARACTER(len=*), INTENT(out) ::   cd_cfg               ! configuration name
52      INTEGER         , INTENT(out) ::   kk_cfg               ! configuration resolution
53      INTEGER         , INTENT(out) ::   kpi, kpj, kpk        ! global domain sizes
54      LOGICAL         , INTENT(out) ::   ldIperio, ldJperio   ! i- and j- periodicity
55      LOGICAL         , INTENT(out) ::   ldNFold              ! North pole folding
56      CHARACTER(len=1), INTENT(out) ::   cdNFtype             ! Folding type: T or F
57      !
58      INTEGER ::   ios   ! Local integer
59      !!
60      NAMELIST/namusr_def/ nn_GYRE, ln_bench, jpkglo
61      !!----------------------------------------------------------------------
62      !
63      READ  ( numnam_cfg, namusr_def, IOSTAT = ios, ERR = 902 )
64902   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namusr_def in configuration namelist' )
65      !
66      IF(lwm)   WRITE( numond, namusr_def )
67      !
68      cd_cfg = 'GYRE'               ! name & resolution (not used)
69#if defined key_agrif
70      IF (.NOT.Agrif_root()) nn_GYRE = Agrif_parent(nn_GYRE) * Agrif_irhox()
71#endif
72      kk_cfg = nn_GYRE
73      !
74      kpi = 30 * nn_GYRE + 2       !
75      kpj = 20 * nn_GYRE + 2
76#if defined key_agrif
77      IF( .NOT.Agrif_Root() ) THEN         ! Global Domain size: add 1 land point on each side
78         kpi  = nbcellsx + 2 * ( nbghostcells + 1 )
79         kpj  = nbcellsy + 2 * ( nbghostcells + 1 )
80!!$         kpi  = nbcellsx + nbghostcells_x   + nbghostcells_x   + 2
81!!$         kpj  = nbcellsy + nbghostcells_y_s + nbghostcells_y_n + 2
82      ENDIF
83#endif
84      kpk = jpkglo
85      !                             ! Set the lateral boundary condition of the global domain
86      ldIperio = .FALSE.   ;   ldJperio = .FALSE.   ! GYRE configuration : closed domain
87      ldNFold  = .FALSE.   ;   cdNFtype = '-'
88      !
89      !                             ! control print
90      IF(lwp) THEN
91         WRITE(numout,*) '   '
92         WRITE(numout,*) 'usr_def_nam  : read the user defined namelist (namusr_def) in namelist_cfg'
93         WRITE(numout,*) '~~~~~~~~~~~ '
94         WRITE(numout,*) '   Namelist namusr_def : GYRE case'
95         WRITE(numout,*) '      GYRE used as Benchmark (=T)                      ln_bench  = ', ln_bench
96         WRITE(numout,*) '      inverse resolution & implied domain size         nn_GYRE   = ', nn_GYRE
97#if defined key_agrif
98         IF( Agrif_Root() ) THEN
99#endif
100         WRITE(numout,*) '      Ni0glo = 30*nn_GYRE                              Ni0glo = ', kpi
101         WRITE(numout,*) '      Nj0glo = 20*nn_GYRE                              Nj0glo = ', kpj
102#if defined key_agrif
103         ENDIF
104#endif
105         WRITE(numout,*) '      number of model levels                           jpkglo = ', kpk
106         WRITE(numout,*) '   '
107      ENDIF
108      !
109   END SUBROUTINE usr_def_nam
110
111   !!======================================================================
112END MODULE usrdef_nam
Note: See TracBrowser for help on using the repository browser.