| 1 | MODULE usrdef_nam |
|---|
| 2 | !!====================================================================== |
|---|
| 3 | !! *** MODULE usrdef_nam *** |
|---|
| 4 | !! |
|---|
| 5 | !! === OVERFLOW configuration === |
|---|
| 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 dom_oce , ONLY: ln_zco, ln_zps, ln_sco ! flag of type of coordinate |
|---|
| 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 | USE timing ! Timing |
|---|
| 24 | |
|---|
| 25 | IMPLICIT NONE |
|---|
| 26 | PRIVATE |
|---|
| 27 | |
|---|
| 28 | PUBLIC usr_def_nam ! called by nemogcm.F90 |
|---|
| 29 | |
|---|
| 30 | ! !!* namusr_def namelist *!! |
|---|
| 31 | REAL(wp), PUBLIC :: rn_dx ! resolution in meters defining the horizontal domain size |
|---|
| 32 | REAL(wp), PUBLIC :: rn_dz ! resolution in meters defining the vertical domain size |
|---|
| 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, 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 | !! |
|---|
| 49 | !! Here OVERFLOW configuration |
|---|
| 50 | !! |
|---|
| 51 | !! ** input : - namusr_def namelist found in namelist_cfg |
|---|
| 52 | !!---------------------------------------------------------------------- |
|---|
| 53 | CHARACTER(len=*), DIMENSION(:), INTENT(out) :: ldtxt, ldnam ! stored print information |
|---|
| 54 | INTEGER , INTENT(out) :: kpi, kpj, kpk ! global domain sizes |
|---|
| 55 | INTEGER , INTENT(out) :: kperio ! lateral global domain b.c. |
|---|
| 56 | ! |
|---|
| 57 | INTEGER :: ios, ii ! Local integer |
|---|
| 58 | !! |
|---|
| 59 | NAMELIST/namusr_def/ ln_zco, ln_zps, ln_sco, rn_dx, rn_dz |
|---|
| 60 | !!---------------------------------------------------------------------- |
|---|
| 61 | ! |
|---|
| 62 | ii = 1 |
|---|
| 63 | ! |
|---|
| 64 | REWIND( numnam_cfg ) ! Namelist namusr_def (exist in namelist_cfg only) |
|---|
| 65 | READ ( numnam_cfg, namusr_def, IOSTAT = ios, ERR = 902 ) |
|---|
| 66 | 902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namusr_def in configuration namelist', .TRUE. ) |
|---|
| 67 | ! |
|---|
| 68 | WRITE( ldnam(:), namusr_def ) |
|---|
| 69 | ! |
|---|
| 70 | ! Global Domain size: OVERFLOW domain is 200 km x 3 grid-points x 2000 m |
|---|
| 71 | kpi = INT( 200.e3 / rn_dx ) + 2 |
|---|
| 72 | kpj = 3 |
|---|
| 73 | kpk = INT( 2000. / rn_dz ) + 1 |
|---|
| 74 | ! |
|---|
| 75 | ! ! control print |
|---|
| 76 | WRITE(ldtxt(ii),*) ' ' ; ii = ii + 1 |
|---|
| 77 | WRITE(ldtxt(ii),*) 'usr_def_nam : read the user defined namelist (namusr_def) in namelist_cfg' ; ii = ii + 1 |
|---|
| 78 | WRITE(ldtxt(ii),*) '~~~~~~~~~~~ ' ; ii = ii + 1 |
|---|
| 79 | WRITE(ldtxt(ii),*) ' Namelist namusr_def : OVERFLOW test case' ; ii = ii + 1 |
|---|
| 80 | WRITE(ldtxt(ii),*) ' type of vertical coordinate : ' ; ii = ii + 1 |
|---|
| 81 | WRITE(ldtxt(ii),*) ' z-coordinate flag ln_zco = ', ln_zco ; ii = ii + 1 |
|---|
| 82 | WRITE(ldtxt(ii),*) ' z-partial-step coordinate flag ln_zps = ', ln_zps ; ii = ii + 1 |
|---|
| 83 | WRITE(ldtxt(ii),*) ' s-coordinate flag ln_sco = ', ln_sco ; ii = ii + 1 |
|---|
| 84 | WRITE(ldtxt(ii),*) ' horizontal resolution rn_dx = ', rn_dx, ' meters' ; ii = ii + 1 |
|---|
| 85 | WRITE(ldtxt(ii),*) ' vertical resolution rn_dz = ', rn_dz, ' meters' ; ii = ii + 1 |
|---|
| 86 | WRITE(ldtxt(ii),*) ' OVERFLOW domain = 200 km x 3 grid-points x 2000 m' ; ii = ii + 1 |
|---|
| 87 | WRITE(ldtxt(ii),*) ' resulting global domain size : jpiglo = ', kpi ; ii = ii + 1 |
|---|
| 88 | WRITE(ldtxt(ii),*) ' jpjglo = ', kpj ; ii = ii + 1 |
|---|
| 89 | WRITE(ldtxt(ii),*) ' jpkglo = ', kpk ; ii = ii + 1 |
|---|
| 90 | ! |
|---|
| 91 | ! ! Set the lateral boundary condition of the global domain |
|---|
| 92 | kperio = 0 ! OVERFLOW configuration : close basin |
|---|
| 93 | ! |
|---|
| 94 | WRITE(ldtxt(ii),*) ' ' ; ii = ii + 1 |
|---|
| 95 | WRITE(ldtxt(ii),*) ' Lateral boundary condition of the global domain' ; ii = ii + 1 |
|---|
| 96 | WRITE(ldtxt(ii),*) ' OVERFLOW : closed basin jperio = ', kperio ; ii = ii + 1 |
|---|
| 97 | ! |
|---|
| 98 | END SUBROUTINE usr_def_nam |
|---|
| 99 | |
|---|
| 100 | !!====================================================================== |
|---|
| 101 | END MODULE usrdef_nam |
|---|
