1 | MODULE usrdef_nam |
---|
2 | !!====================================================================== |
---|
3 | !! *** MODULE usrdef_nam *** |
---|
4 | !! |
---|
5 | !! === SWG 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 | !! - ! 2020-03 (A. Nasser) Shallow Water Eq. configuration |
---|
11 | !!---------------------------------------------------------------------- |
---|
12 | |
---|
13 | !!---------------------------------------------------------------------- |
---|
14 | !! usr_def_nam : read user defined namelist and set global domain size |
---|
15 | !! usr_def_hgr : initialize the horizontal mesh |
---|
16 | !!---------------------------------------------------------------------- |
---|
17 | USE dom_oce , ONLY: nimpp, njmpp ! ocean space and time domain |
---|
18 | USE par_oce ! ocean space and time domain |
---|
19 | USE phycst ! physical constants |
---|
20 | ! |
---|
21 | USE in_out_manager ! I/O manager |
---|
22 | USE lib_mpp ! MPP library |
---|
23 | |
---|
24 | IMPLICIT NONE |
---|
25 | PRIVATE |
---|
26 | |
---|
27 | PUBLIC usr_def_nam ! called in nemogcm.F90 module |
---|
28 | ! !!* namusr_def namelist *!! |
---|
29 | INTEGER , PUBLIC :: nn_SWG ! 1/nn_SWG = the resolution chosen in degrees and thus defining the horizontal domain size |
---|
30 | REAL(wp), PUBLIC :: rn_theta ! rotation angle (in degree) of the grid |
---|
31 | INTEGER , PUBLIC :: nn_gc ! number of ghostcells |
---|
32 | REAL(wp), PUBLIC :: rn_domsiz ! size of the domain (default 2000km) [m] |
---|
33 | REAL(wp), PUBLIC :: rn_dx ! gridspacing (default 100km) [m] |
---|
34 | REAL(wp), PUBLIC :: rn_tau ! wind stress on the surface [N/m2] |
---|
35 | REAL(wp), PUBLIC :: rn_f0 ! f-plan coriolis parameter [1/s] |
---|
36 | REAL(wp), PUBLIC :: rn_beta ! beta-plan coriolis parameter [1/m.s] |
---|
37 | REAL(wp), PUBLIC :: rn_modified_grav ! modified gravity [m/s2] |
---|
38 | REAL(wp), PUBLIC :: rn_rfr ! layer friction [1/s] |
---|
39 | ! !!* temporary *!! |
---|
40 | INTEGER , PUBLIC :: nn_dynldf_lap_typ ! choose type of laplacian (ideally from namelist) |
---|
41 | ! ! = 1 divrot laplacian |
---|
42 | ! ! = 2 symmetric laplacian (Griffies&Hallberg 2000) |
---|
43 | ! ! = 3 symmetric laplacian (cartesian) |
---|
44 | LOGICAL , PUBLIC :: ln_dynldf_lap_PM ! if True - apply the P.Marchand boundary condition on the laplacian |
---|
45 | ! !!* penalisation *!! |
---|
46 | REAL(wp), PUBLIC :: rn_abp ! alpha boundary parameter [-] |
---|
47 | INTEGER , PUBLIC :: nn_cnp ! number of cell on which is smoothed the porosity (phi) [-] |
---|
48 | REAL(wp), PUBLIC :: rn_fsp ! friction parameter 1/epsilon of the permeability [1/s] |
---|
49 | ! |
---|
50 | REAL(wp), PUBLIC :: r1_abp ! inverse alpha boundary parameter [-] |
---|
51 | ! |
---|
52 | !!---------------------------------------------------------------------- |
---|
53 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
---|
54 | !! $Id: usrdef_nam.F90 11536 2019-09-11 13:54:18Z smasson $ |
---|
55 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
56 | !!---------------------------------------------------------------------- |
---|
57 | CONTAINS |
---|
58 | |
---|
59 | SUBROUTINE usr_def_nam( cd_cfg, kk_cfg, kpi, kpj, kpk, kperio ) |
---|
60 | !!---------------------------------------------------------------------- |
---|
61 | !! *** ROUTINE dom_nam *** |
---|
62 | !! |
---|
63 | !! ** Purpose : read user defined namelist and define the domain size |
---|
64 | !! |
---|
65 | !! ** Method : read in namusr_def containing all the user specific namelist parameter |
---|
66 | !! |
---|
67 | !! Here SWG configuration |
---|
68 | !! |
---|
69 | !! ** input : - namusr_def namelist found in namelist_cfg |
---|
70 | !!---------------------------------------------------------------------- |
---|
71 | CHARACTER(len=*), INTENT(out) :: cd_cfg ! configuration name |
---|
72 | INTEGER , INTENT(out) :: kk_cfg ! configuration resolution |
---|
73 | INTEGER , INTENT(out) :: kpi, kpj, kpk ! global domain sizes |
---|
74 | INTEGER , INTENT(out) :: kperio ! lateral global domain b.c. |
---|
75 | ! |
---|
76 | INTEGER :: ios ! Local integer |
---|
77 | REAL(wp) :: ze1, zgl, zbl ! gridspacing, length of the biggest square |
---|
78 | !! |
---|
79 | NAMELIST/namusr_def/ nn_SWG, rn_theta, jpkglo, & ! |
---|
80 | & nn_gc ,rn_domsiz, rn_dx, & ! domain parameters |
---|
81 | & rn_f0 ,rn_beta, & ! coriolis parameter |
---|
82 | & rn_modified_grav, rn_rfr , rn_tau, & ! reduced gravity, friction, wind |
---|
83 | & nn_dynldf_lap_typ, ln_dynldf_lap_PM, & ! temporary parameter |
---|
84 | & rn_abp, nn_cnp, rn_fsp ! penalisation parameters |
---|
85 | !!---------------------------------------------------------------------- |
---|
86 | ! |
---|
87 | READ ( numnam_cfg, namusr_def, IOSTAT = ios, ERR = 902 ) |
---|
88 | 902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namusr_def in configuration namelist' ) |
---|
89 | ! |
---|
90 | IF(lwm) WRITE( numond, namusr_def ) |
---|
91 | ! |
---|
92 | cd_cfg = 'SWG' ! name & resolution (not used) |
---|
93 | |
---|
94 | #if defined key_agrif |
---|
95 | IF (.NOT.Agrif_root()) nn_SWG = Agrif_parent(nn_SWG) * Agrif_irhox() |
---|
96 | #endif |
---|
97 | |
---|
98 | kk_cfg = nn_SWG |
---|
99 | ! |
---|
100 | ze1 = rn_dx / REAL(nn_SWG, wp) ! [m] gridspacing used |
---|
101 | zgl = rn_domsiz + 2._wp * REAL(nn_gc, wp) * ze1 ! [m] length of the square with ghostcells |
---|
102 | ! rotation |
---|
103 | zbl = zgl * ( COS( rn_theta * rad ) + SIN( rn_theta * rad ) ) ! length side bigger domain [m] |
---|
104 | ! |
---|
105 | kpi = ceiling(zbl / ze1 ) ! Global Domain size + ghost cells |
---|
106 | kpj = ceiling(zbl / ze1 ) ! Global Domain size + ghost cells |
---|
107 | ! |
---|
108 | IF( rn_modified_grav /= 0._wp) grav = rn_modified_grav ! update the gravity |
---|
109 | ! |
---|
110 | kpk = jpkglo |
---|
111 | ! ! Set the lateral boundary condition of the global domain |
---|
112 | kperio = 0 ! SWG configuration : closed domain |
---|
113 | ! |
---|
114 | # if defined key_bvp |
---|
115 | r1_abp = 1._wp / rn_abp |
---|
116 | #endif |
---|
117 | ! ! control print |
---|
118 | IF(lwp) THEN |
---|
119 | WRITE(numout,*) ' ' |
---|
120 | WRITE(numout,*) 'usr_def_nam : read the user defined namelist (namusr_def) in namelist_cfg' |
---|
121 | WRITE(numout,*) '~~~~~~~~~~~ ' |
---|
122 | WRITE(numout,*) ' Namelist namusr_def : SWG case' |
---|
123 | WRITE(numout,*) ' domain size rn_domsiz = ', rn_domsiz, 'm' |
---|
124 | WRITE(numout,*) ' gridspacing rn_dx = ', rn_dx, 'm' |
---|
125 | WRITE(numout,*) ' inverse resolution & implied domain size nn_SWG = ', nn_SWG |
---|
126 | WRITE(numout,*) ' implied gridspacing rn_dx = ', rn_dx, 'm' |
---|
127 | WRITE(numout,*) ' number of ghostcells nn_gc = ', nn_gc |
---|
128 | WRITE(numout,*) ' ' |
---|
129 | WRITE(numout,*) ' rotation angle chosen rn_theta = ', rn_theta, 'deg' |
---|
130 | WRITE(numout,*) ' modified gravity rn_modified_grav = ', rn_modified_grav, 'm2/s' |
---|
131 | WRITE(numout,*) ' number of model levels jpkglo = ', kpk |
---|
132 | WRITE(numout,*) ' ' |
---|
133 | WRITE(numout,*) ' Lateral b.c. of the global domain set to closed jperio = ', kperio |
---|
134 | ENDIF |
---|
135 | ! |
---|
136 | END SUBROUTINE usr_def_nam |
---|
137 | |
---|
138 | !!====================================================================== |
---|
139 | END MODULE usrdef_nam |
---|