[14254] | 1 | MODULE 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 | !!---------------------------------------------------------------------- |
---|
| 40 | CONTAINS |
---|
| 41 | |
---|
[14433] | 42 | SUBROUTINE usr_def_nam( cd_cfg, kk_cfg, kpi, kpj, kpk, ldIperio, ldJperio, ldNFold, cdNFtype ) |
---|
[14254] | 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 | !!---------------------------------------------------------------------- |
---|
[14433] | 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 |
---|
[14254] | 60 | ! |
---|
| 61 | INTEGER :: ios ! Local integer |
---|
[15548] | 62 | INTEGER :: ighost_w, ighost_e, ighost_s, ighost_n |
---|
[14254] | 63 | REAL(wp):: zlx, zly, zh ! Local scalars |
---|
| 64 | !! |
---|
| 65 | NAMELIST/namusr_def/ ln_zco, ln_zps, ln_sco, rn_dx, rn_dz, rn_f0 |
---|
| 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 | rn_dy = rn_dx |
---|
| 72 | #if defined key_agrif |
---|
| 73 | ! Domain parameters are taken from parent: |
---|
| 74 | IF( .NOT. Agrif_Root() ) THEN |
---|
| 75 | rn_dx = Agrif_Parent(rn_dx)/Agrif_Rhox() |
---|
| 76 | rn_dy = Agrif_Parent(rn_dy)/Agrif_Rhoy() |
---|
| 77 | rn_f0 = Agrif_Parent(rn_f0) |
---|
| 78 | ENDIF |
---|
| 79 | #endif |
---|
| 80 | ! |
---|
| 81 | IF(lwm) WRITE( numond, namusr_def ) |
---|
| 82 | ! |
---|
| 83 | cd_cfg = 'DOME' ! name & resolution (not used) |
---|
| 84 | kk_cfg = nINT( rn_dx ) |
---|
| 85 | ! |
---|
[15548] | 86 | #if defined key_agrif |
---|
[14254] | 87 | IF( Agrif_Root() ) THEN ! Global Domain size: DOME global domain is 2000 km x 850 Km x 3600 m |
---|
[15548] | 88 | #endif |
---|
[14254] | 89 | kpi = NINT( 2000.e3 / rn_dx ) + 2 |
---|
| 90 | kpj = NINT( 850.e3 / rn_dy ) + 2 + 1 |
---|
[15548] | 91 | #if defined key_agrif |
---|
[14254] | 92 | ELSE ! Global Domain size: add nbghostcells + 1 "land" point on each side |
---|
[15548] | 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 | ! In case one sets zoom boundaries over domain edges: |
---|
| 99 | IF ( Agrif_Ix() == 2 - Agrif_Parent(nbghostcells_x_w) ) ighost_w = 1 |
---|
| 100 | IF ( Agrif_Ix() + nbcellsx/AGRIF_Irhox() == Agrif_Parent(Ni0glo)-Agrif_Parent(nbghostcells_x_w) ) ighost_e = 1 |
---|
| 101 | IF ( Agrif_Iy() == 2 - Agrif_Parent(nbghostcells_y_s) ) ighost_s = 1 |
---|
| 102 | IF ( Agrif_Iy() + nbcellsy/AGRIF_Irhoy() == Agrif_Parent(Nj0glo)-Agrif_Parent(nbghostcells_y_s) ) ighost_n = 1 |
---|
| 103 | kpi = nbcellsx + ighost_w + ighost_e |
---|
| 104 | kpj = nbcellsy + ighost_s + ighost_n |
---|
| 105 | !! JC: number of ghosts are unknown at this stage ! |
---|
| 106 | !!$ kpi = nbcellsx + nbghostcells_x_w + nbghostcells_x_e |
---|
| 107 | !!$ kpj = nbcellsy + nbghostcells_y_s + nbghostcells_y_n |
---|
[14254] | 108 | ENDIF |
---|
[15548] | 109 | #endif |
---|
[14254] | 110 | kpk = NINT( 3600._wp / rn_dz ) + 1 |
---|
| 111 | ! |
---|
| 112 | zlx = (kpi-2)*rn_dx*1.e-3 |
---|
| 113 | zly = (kpj-2-1)*rn_dy*1.e-3 |
---|
| 114 | zh = (kpk-1)*rn_dz |
---|
| 115 | ! ! Set the lateral boundary condition of the global domain |
---|
[14433] | 116 | ldIperio = .FALSE. ; ldJperio = .FALSE. ! DOME configuration : closed domain |
---|
| 117 | ldNFold = .FALSE. ; cdNFtype = '-' |
---|
| 118 | ! |
---|
[14254] | 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 : DOME test case' |
---|
| 125 | WRITE(numout,*) ' z-coordinate flag ln_zco = ', ln_zco |
---|
| 126 | WRITE(numout,*) ' z-partial-step coordinate flag ln_zps = ', ln_zps |
---|
| 127 | WRITE(numout,*) ' s-coordinate flag ln_sco = ', ln_sco |
---|
| 128 | WRITE(numout,*) ' horizontal resolution rn_dx = ', rn_dx, ' m' |
---|
| 129 | WRITE(numout,*) ' vertical resolution rn_dz = ', rn_dz, ' m' |
---|
| 130 | WRITE(numout,*) ' resulting global domain size : Ni0glo = ', kpi |
---|
| 131 | WRITE(numout,*) ' Nj0glo = ', kpj |
---|
| 132 | WRITE(numout,*) ' jpkglo = ', kpk |
---|
| 133 | WRITE(numout,*) ' DOME domain: ' |
---|
| 134 | WRITE(numout,*) ' LX [km]: ', zlx |
---|
| 135 | WRITE(numout,*) ' LY [km]: ', zly |
---|
| 136 | WRITE(numout,*) ' H [m] : ', zh |
---|
| 137 | WRITE(numout,*) ' Coriolis frequency rn_f0 = ', rn_f0, ' s-1' |
---|
| 138 | WRITE(numout,*) ' ' |
---|
| 139 | ENDIF |
---|
| 140 | ! |
---|
| 141 | END SUBROUTINE usr_def_nam |
---|
| 142 | |
---|
| 143 | !!====================================================================== |
---|
| 144 | END MODULE usrdef_nam |
---|