[8703] | 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 , 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 | !!---------------------------------------------------------------------- |
---|
[10073] | 36 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
---|
[11715] | 37 | !! $Id$ |
---|
[10073] | 38 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
[8703] | 39 | !!---------------------------------------------------------------------- |
---|
| 40 | CONTAINS |
---|
| 41 | |
---|
[11536] | 42 | SUBROUTINE usr_def_nam( cd_cfg, kk_cfg, kpi, kpj, kpk, kperio ) |
---|
[8703] | 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 | ! |
---|
[11536] | 59 | INTEGER :: ios ! Local integer |
---|
[8703] | 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 ) |
---|
[11536] | 67 | 902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namusr_def in configuration namelist' ) |
---|
[8703] | 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 | ! |
---|
[11536] | 79 | IF(lwm) WRITE( numond, namusr_def ) |
---|
[8703] | 80 | ! |
---|
| 81 | cd_cfg = 'VORTEX' ! name & resolution (not used) |
---|
[11536] | 82 | kk_cfg = nINT( rn_dx ) |
---|
[8703] | 83 | ! |
---|
[11536] | 84 | IF( Agrif_Root() ) THEN ! Global Domain size: VORTEX global domain is 1800 km x 1800 Km x 5000 m |
---|
| 85 | kpi = NINT( 1800.e3 / rn_dx ) + 3 |
---|
| 86 | kpj = NINT( 1800.e3 / rn_dy ) + 3 |
---|
| 87 | ELSE |
---|
[8703] | 88 | kpi = nbcellsx + 2 + 2*nbghostcells |
---|
| 89 | kpj = nbcellsy + 2 + 2*nbghostcells |
---|
| 90 | ENDIF |
---|
[11536] | 91 | kpk = NINT( 5000._wp / rn_dz ) + 1 |
---|
[8703] | 92 | ! |
---|
| 93 | zlx = (kpi-2)*rn_dx*1.e-3 |
---|
| 94 | zly = (kpj-2)*rn_dy*1.e-3 |
---|
| 95 | zh = (kpk-1)*rn_dz |
---|
| 96 | ! ! Set the lateral boundary condition of the global domain |
---|
| 97 | kperio = 0 ! VORTEX configuration : closed basin |
---|
[11536] | 98 | ! ! control print |
---|
| 99 | IF(lwp) THEN |
---|
| 100 | WRITE(numout,*) ' ' |
---|
| 101 | WRITE(numout,*) 'usr_def_nam : read the user defined namelist (namusr_def) in namelist_cfg' |
---|
| 102 | WRITE(numout,*) '~~~~~~~~~~~ ' |
---|
| 103 | WRITE(numout,*) ' Namelist namusr_def : VORTEX test case' |
---|
| 104 | WRITE(numout,*) ' horizontal resolution rn_dx = ', rn_dx, ' m' |
---|
| 105 | WRITE(numout,*) ' horizontal resolution rn_dy = ', rn_dy, ' m' |
---|
| 106 | WRITE(numout,*) ' vertical resolution rn_dz = ', rn_dz, ' m' |
---|
| 107 | WRITE(numout,*) ' VORTEX domain: ' |
---|
| 108 | WRITE(numout,*) ' LX [km]: ', zlx |
---|
| 109 | WRITE(numout,*) ' LY [km]: ', zly |
---|
| 110 | WRITE(numout,*) ' H [m] : ', zh |
---|
| 111 | WRITE(numout,*) ' Reference latitude rn_ppgphi0 = ', rn_ppgphi0 |
---|
| 112 | WRITE(numout,*) ' ' |
---|
| 113 | WRITE(numout,*) ' Lateral boundary condition of the global domain' |
---|
| 114 | WRITE(numout,*) ' VORTEX : closed basin jperio = ', kperio |
---|
| 115 | ENDIF |
---|
[8703] | 116 | ! |
---|
| 117 | END SUBROUTINE usr_def_nam |
---|
| 118 | |
---|
| 119 | !!====================================================================== |
---|
| 120 | END MODULE usrdef_nam |
---|