1 | MODULE 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 |
---|
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 | !!---------------------------------------------------------------------- |
---|
40 | CONTAINS |
---|
41 | |
---|
42 | SUBROUTINE usr_def_nam( cd_cfg, kk_cfg, kpi, kpj, kpk, ldIperio, ldJperio, ldNFold, cdNFtype ) |
---|
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 | LOGICAL , INTENT(out) :: ldIperio, ldJperio ! i- and j- periodicity |
---|
58 | LOGICAL , INTENT(out) :: ldNFold ! North pole folding |
---|
59 | CHARACTER(len=1), INTENT(out) :: cdNFtype ! Folding type: T or F |
---|
60 | ! |
---|
61 | INTEGER :: ios ! Local integer |
---|
62 | INTEGER :: ighost_n, ighost_s, ighost_w, ighost_e |
---|
63 | REAL(wp):: zlx, zly, zh ! Local scalars |
---|
64 | !! |
---|
65 | NAMELIST/namusr_def/ rn_dx, rn_dy, rn_dz, rn_ppgphi0 |
---|
66 | !!---------------------------------------------------------------------- |
---|
67 | ! |
---|
68 | READ ( numnam_cfg, namusr_def, IOSTAT = ios, ERR = 902 ) |
---|
69 | 902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namusr_def in configuration namelist' ) |
---|
70 | ! |
---|
71 | #if defined key_agrif |
---|
72 | ! Domain parameters are taken from parent: |
---|
73 | IF( .NOT. Agrif_Root() ) THEN |
---|
74 | rn_dx = Agrif_Parent(rn_dx)/Agrif_Rhox() |
---|
75 | rn_dy = Agrif_Parent(rn_dy)/Agrif_Rhoy() |
---|
76 | ! rn_dz = Agrif_Parent(rn_dz) |
---|
77 | rn_ppgphi0 = Agrif_Parent(rn_ppgphi0) |
---|
78 | ENDIF |
---|
79 | #endif |
---|
80 | ! |
---|
81 | IF(lwm) WRITE( numond, namusr_def ) |
---|
82 | ! |
---|
83 | cd_cfg = 'VORTEX' ! name & resolution (not used) |
---|
84 | kk_cfg = nINT( rn_dx ) |
---|
85 | ! |
---|
86 | #if defined key_agrif |
---|
87 | IF( Agrif_Root() ) THEN ! Global Domain size: VORTEX global domain is 1800 km x 1800 Km x 5000 m |
---|
88 | #endif |
---|
89 | kpi = NINT( 1800.e3 / rn_dx ) + 3 |
---|
90 | kpj = NINT( 1800.e3 / rn_dy ) + 3 |
---|
91 | #if defined key_agrif |
---|
92 | ELSE ! Global Domain size: add nbghostcells + 1 "land" point on each side |
---|
93 | ! At this stage, child ghosts have not been set |
---|
94 | ighost_w = nbghostcells |
---|
95 | ighost_e = nbghostcells |
---|
96 | ighost_s = nbghostcells |
---|
97 | ighost_n = nbghostcells |
---|
98 | |
---|
99 | ! In case one sets zoom boundaries over domain edges: |
---|
100 | IF ( Agrif_Ix() == 2 - Agrif_Parent(nbghostcells_x_w) ) ighost_w = 1 |
---|
101 | IF ( Agrif_Ix() + nbcellsx/AGRIF_Irhox() == Agrif_Parent(Ni0glo) - Agrif_Parent(nbghostcells_x_w) ) ighost_e = 1 |
---|
102 | IF ( Agrif_Iy() == 2 - Agrif_Parent(nbghostcells_y_s) ) ighost_s = 1 |
---|
103 | IF ( Agrif_Iy() + nbcellsy/AGRIF_Irhoy() == Agrif_Parent(Nj0glo) - Agrif_Parent(nbghostcells_y_s) ) ighost_n = 1 |
---|
104 | ! kpi = nbcellsx + 2 * ( nbghostcells + 1 ) |
---|
105 | ! kpj = nbcellsy + 2 * ( nbghostcells + 1 ) |
---|
106 | kpi = nbcellsx + ighost_w + ighost_e |
---|
107 | kpj = nbcellsy + ighost_s + ighost_n |
---|
108 | ENDIF |
---|
109 | #endif |
---|
110 | kpk = NINT( 5000._wp / rn_dz ) + 1 |
---|
111 | ! |
---|
112 | zlx = (kpi-2)*rn_dx*1.e-3 |
---|
113 | zly = (kpj-2)*rn_dy*1.e-3 |
---|
114 | zh = (kpk-1)*rn_dz |
---|
115 | ! ! Set the lateral boundary condition of the global domain |
---|
116 | ldIperio = .FALSE. ; ldJperio = .FALSE. ! VORTEX configuration : closed domain |
---|
117 | ldNFold = .FALSE. ; cdNFtype = '-' |
---|
118 | ! |
---|
119 | ! ! control print |
---|
120 | IF(lwp) THEN |
---|
121 | WRITE(numout,*) ' ' |
---|
122 | WRITE(numout,*) 'usr_def_nam : read the user defined namelist (namusr_def) in namelist_cfg' |
---|
123 | WRITE(numout,*) '~~~~~~~~~~~ ' |
---|
124 | WRITE(numout,*) ' Namelist namusr_def : VORTEX test case' |
---|
125 | WRITE(numout,*) ' horizontal resolution rn_dx = ', rn_dx, ' m' |
---|
126 | WRITE(numout,*) ' horizontal resolution rn_dy = ', rn_dy, ' m' |
---|
127 | WRITE(numout,*) ' vertical resolution rn_dz = ', rn_dz, ' m' |
---|
128 | WRITE(numout,*) ' resulting global domain size : Ni0glo = ', kpi |
---|
129 | WRITE(numout,*) ' Nj0glo = ', kpj |
---|
130 | WRITE(numout,*) ' jpkglo = ', kpk |
---|
131 | WRITE(numout,*) ' VORTEX domain: ' |
---|
132 | WRITE(numout,*) ' LX [km]: ', zlx |
---|
133 | WRITE(numout,*) ' LY [km]: ', zly |
---|
134 | WRITE(numout,*) ' H [m] : ', zh |
---|
135 | WRITE(numout,*) ' Reference latitude rn_ppgphi0 = ', rn_ppgphi0 |
---|
136 | WRITE(numout,*) ' ' |
---|
137 | ENDIF |
---|
138 | ! |
---|
139 | END SUBROUTINE usr_def_nam |
---|
140 | |
---|
141 | !!====================================================================== |
---|
142 | END MODULE usrdef_nam |
---|