[7355] | 1 | MODULE usrdef_nam |
---|
| 2 | !!====================================================================== |
---|
| 3 | !! *** MODULE usrdef_nam *** |
---|
| 4 | !! |
---|
[9789] | 5 | !! === ICEDYN configuration === |
---|
[7355] | 6 | !! |
---|
| 7 | !! User defined : set the domain characteristics of a user configuration |
---|
| 8 | !!====================================================================== |
---|
| 9 | !! History : NEMO ! 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 , 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 | |
---|
[9763] | 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_ppgphi0 ! reference latitude for beta-plane |
---|
[7355] | 33 | |
---|
| 34 | !!---------------------------------------------------------------------- |
---|
| 35 | !! NEMO/OPA 4.0 , NEMO Consortium (2016) |
---|
| 36 | !! $Id$ |
---|
| 37 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
---|
| 38 | !!---------------------------------------------------------------------- |
---|
| 39 | CONTAINS |
---|
| 40 | |
---|
| 41 | SUBROUTINE usr_def_nam( ldtxt, ldnam, cd_cfg, kk_cfg, kpi, kpj, kpk, kperio ) |
---|
| 42 | !!---------------------------------------------------------------------- |
---|
| 43 | !! *** ROUTINE dom_nam *** |
---|
| 44 | !! |
---|
| 45 | !! ** Purpose : read user defined namelist and define the domain size |
---|
| 46 | !! |
---|
| 47 | !! ** Method : read in namusr_def containing all the user specific namelist parameter |
---|
| 48 | !! |
---|
[9789] | 49 | !! Here ICEDYN configuration |
---|
[7355] | 50 | !! |
---|
| 51 | !! ** input : - namusr_def namelist found in namelist_cfg |
---|
| 52 | !!---------------------------------------------------------------------- |
---|
| 53 | CHARACTER(len=*), DIMENSION(:), INTENT(out) :: ldtxt, ldnam ! stored print information |
---|
| 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 | ! |
---|
| 59 | INTEGER :: ios, ii ! Local integer |
---|
[9763] | 60 | REAL(wp):: zlx, zly ! Local scalars |
---|
[7355] | 61 | !! |
---|
[9763] | 62 | NAMELIST/namusr_def/ ln_zco, rn_dx, rn_dy, rn_ppgphi0 |
---|
[7355] | 63 | !!---------------------------------------------------------------------- |
---|
| 64 | ! |
---|
| 65 | ii = 1 |
---|
| 66 | ! |
---|
| 67 | REWIND( numnam_cfg ) ! Namelist namusr_def (exist in namelist_cfg only) |
---|
| 68 | READ ( numnam_cfg, namusr_def, IOSTAT = ios, ERR = 902 ) |
---|
| 69 | 902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namusr_def in configuration namelist', .TRUE. ) |
---|
| 70 | ! |
---|
[9763] | 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_ppgphi0 = Agrif_Parent(rn_ppgphi0) |
---|
| 77 | ENDIF |
---|
| 78 | #endif |
---|
| 79 | ! |
---|
[7355] | 80 | WRITE( ldnam(:), namusr_def ) |
---|
| 81 | ! |
---|
[9789] | 82 | cd_cfg = 'ICEDYN' ! name & resolution (not used) |
---|
[7355] | 83 | kk_cfg = INT( rn_dx ) |
---|
| 84 | ! |
---|
[9789] | 85 | ! Global Domain size: ICEDYN domain is 300 km x 300 Km x 10 m |
---|
[7355] | 86 | kpi = INT( 300.e3 / rn_dx ) -1 |
---|
| 87 | kpj = INT( 300.e3 / rn_dy ) -1 |
---|
[9458] | 88 | #if defined key_agrif |
---|
| 89 | IF( .NOT. Agrif_Root() ) THEN |
---|
| 90 | kpi = nbcellsx + 2 + 2*nbghostcells |
---|
| 91 | kpj = nbcellsy + 2 + 2*nbghostcells |
---|
| 92 | ENDIF |
---|
| 93 | #endif |
---|
[7355] | 94 | kpk = 1 |
---|
| 95 | ! |
---|
[9763] | 96 | !! zlx = (kpi-2)*rn_dx*1.e-3 |
---|
| 97 | !! zly = (kpj-2)*rn_dy*1.e-3 |
---|
| 98 | zlx = kpi*rn_dx*1.e-3 |
---|
| 99 | zly = kpj*rn_dy*1.e-3 |
---|
[7355] | 100 | ! ! control print |
---|
| 101 | WRITE(ldtxt(ii),*) ' ' ; ii = ii + 1 |
---|
| 102 | WRITE(ldtxt(ii),*) 'usr_def_nam : read the user defined namelist (namusr_def) in namelist_cfg' ; ii = ii + 1 |
---|
| 103 | WRITE(ldtxt(ii),*) '~~~~~~~~~~~ ' ; ii = ii + 1 |
---|
[9789] | 104 | WRITE(ldtxt(ii),*) ' Namelist namusr_def : ICEDYN test case' ; ii = ii + 1 |
---|
[7355] | 105 | WRITE(ldtxt(ii),*) ' horizontal resolution rn_dx = ', rn_dx, ' meters' ; ii = ii + 1 |
---|
| 106 | WRITE(ldtxt(ii),*) ' horizontal resolution rn_dy = ', rn_dy, ' meters' ; ii = ii + 1 |
---|
[9789] | 107 | WRITE(ldtxt(ii),*) ' ICEDYN domain = 300 km x 300Km x 1 grid-point ' ; ii = ii + 1 |
---|
[9763] | 108 | WRITE(ldtxt(ii),*) ' LX [km]: ', zlx ; ii = ii + 1 |
---|
| 109 | WRITE(ldtxt(ii),*) ' LY [km]: ', zly ; ii = ii + 1 |
---|
[7355] | 110 | WRITE(ldtxt(ii),*) ' resulting global domain size : jpiglo = ', kpi ; ii = ii + 1 |
---|
| 111 | WRITE(ldtxt(ii),*) ' jpjglo = ', kpj ; ii = ii + 1 |
---|
| 112 | WRITE(ldtxt(ii),*) ' jpkglo = ', kpk ; ii = ii + 1 |
---|
| 113 | ! |
---|
| 114 | ! ! Set the lateral boundary condition of the global domain |
---|
[9789] | 115 | kperio = 7 ! ICEDYN configuration : bi-periodic basin |
---|
[9460] | 116 | #if defined key_agrif |
---|
| 117 | IF( .NOT. Agrif_Root() ) THEN |
---|
| 118 | kperio = 0 |
---|
| 119 | ENDIF |
---|
| 120 | #endif |
---|
[7355] | 121 | ! |
---|
| 122 | WRITE(ldtxt(ii),*) ' ' ; ii = ii + 1 |
---|
| 123 | WRITE(ldtxt(ii),*) ' Lateral boundary condition of the global domain' ; ii = ii + 1 |
---|
[9789] | 124 | WRITE(ldtxt(ii),*) ' ICEDYN : bi-periodic basin jperio = ', kperio ; ii = ii + 1 |
---|
[7355] | 125 | ! |
---|
| 126 | END SUBROUTINE usr_def_nam |
---|
| 127 | |
---|
| 128 | !!====================================================================== |
---|
| 129 | END MODULE usrdef_nam |
---|