| 1 | MODULE usrdef_nam |
|---|
| 2 | !!====================================================================== |
|---|
| 3 | !! *** MODULE usrdef_nam *** |
|---|
| 4 | !! |
|---|
| 5 | !! === WAD_TEST_CASES 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 | !!---------------------------------------------------------------------- |
|---|
| 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 par_oce ! ocean space and time domain |
|---|
| 17 | USE phycst ! physical constants |
|---|
| 18 | ! |
|---|
| 19 | USE in_out_manager ! I/O manager |
|---|
| 20 | USE lib_mpp ! MPP library |
|---|
| 21 | USE timing ! Timing |
|---|
| 22 | |
|---|
| 23 | IMPLICIT NONE |
|---|
| 24 | PRIVATE |
|---|
| 25 | |
|---|
| 26 | PUBLIC usr_def_nam ! called by nemogcm.F90 |
|---|
| 27 | |
|---|
| 28 | ! !!* namusr_def namelist *!! |
|---|
| 29 | REAL(wp), PUBLIC :: rn_dx ! resolution in meters defining the horizontal domain size |
|---|
| 30 | REAL(wp), PUBLIC :: rn_dz ! resolution in meters defining the vertical domain size |
|---|
| 31 | INTEGER , PUBLIC :: nn_wad_test ! resolution in meters defining the vertical domain size |
|---|
| 32 | |
|---|
| 33 | !!---------------------------------------------------------------------- |
|---|
| 34 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
|---|
| 35 | !! $Id$ |
|---|
| 36 | !! Software governed by the CeCILL license (see ./LICENSE) |
|---|
| 37 | !!---------------------------------------------------------------------- |
|---|
| 38 | CONTAINS |
|---|
| 39 | |
|---|
| 40 | SUBROUTINE usr_def_nam( cd_cfg, kk_cfg, kpi, kpj, kpk, ldIperio, ldJperio, ldNFold, cdNFtype ) |
|---|
| 41 | !!---------------------------------------------------------------------- |
|---|
| 42 | !! *** ROUTINE dom_nam *** |
|---|
| 43 | !! |
|---|
| 44 | !! ** Purpose : read user defined namelist and define the domain size |
|---|
| 45 | !! |
|---|
| 46 | !! ** Method : read in namusr_def containing all the user specific namelist parameter |
|---|
| 47 | !! |
|---|
| 48 | !! Here WAD_TEST_CASES configuration |
|---|
| 49 | !! |
|---|
| 50 | !! ** input : - namusr_def namelist found in namelist_cfg |
|---|
| 51 | !!---------------------------------------------------------------------- |
|---|
| 52 | CHARACTER(len=*), INTENT(out) :: cd_cfg ! configuration name |
|---|
| 53 | INTEGER , INTENT(out) :: kk_cfg ! configuration resolution |
|---|
| 54 | INTEGER , INTENT(out) :: kpi, kpj, kpk ! global domain sizes |
|---|
| 55 | LOGICAL , INTENT(out) :: ldIperio, ldJperio ! i- and j- periodicity |
|---|
| 56 | LOGICAL , INTENT(out) :: ldNFold ! North pole folding |
|---|
| 57 | CHARACTER(len=1), INTENT(out) :: cdNFtype ! Folding type: T or F |
|---|
| 58 | ! |
|---|
| 59 | INTEGER :: ios ! Local integer |
|---|
| 60 | !! |
|---|
| 61 | NAMELIST/namusr_def/ rn_dx, rn_dz, nn_wad_test |
|---|
| 62 | !!---------------------------------------------------------------------- |
|---|
| 63 | ! |
|---|
| 64 | READ ( numnam_cfg, namusr_def, IOSTAT = ios, ERR = 902 ) |
|---|
| 65 | 902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namusr_def in configuration namelist' ) |
|---|
| 66 | ! |
|---|
| 67 | IF(lwm) WRITE( numond, namusr_def ) |
|---|
| 68 | ! |
|---|
| 69 | ! |
|---|
| 70 | cd_cfg = 'wad' ! name & resolution (not used) |
|---|
| 71 | nn_cfg = nn_wad_test |
|---|
| 72 | kk_cfg = nn_wad_test |
|---|
| 73 | ! |
|---|
| 74 | ! Global Domain size: WAD_TEST_CASES domain is 52 km x 34 km x 10 m |
|---|
| 75 | kpi = INT( 50.e3 / rn_dx ) + 2 |
|---|
| 76 | kpj = INT( 32.e3 / rn_dx ) + 2 |
|---|
| 77 | kpk = INT( 10. / rn_dz ) + 1 |
|---|
| 78 | ! ! Set the lateral boundary condition of the global domain |
|---|
| 79 | ldIperio = .FALSE. ; ldJperio = .FALSE. ! WAD_TEST_CASES configuration : closed domain |
|---|
| 80 | ldNFold = .FALSE. ; cdNFtype = '-' |
|---|
| 81 | IF( nn_wad_test == 8 ) THEN |
|---|
| 82 | ldIperio = .TRUE. ; ldJperio = .TRUE. ! WAD_TEST_CASES configuration : bi-periodic |
|---|
| 83 | kpi = kpi - 2 ! no closed boundary |
|---|
| 84 | kpj = kpj - 2 ! no closed boundary |
|---|
| 85 | ENDIF |
|---|
| 86 | ! |
|---|
| 87 | ! ! control print |
|---|
| 88 | IF(lwp) THEN |
|---|
| 89 | WRITE(numout,*) ' ' |
|---|
| 90 | WRITE(numout,*) 'usr_def_nam : read the user defined namelist (namusr_def) in namelist_cfg' |
|---|
| 91 | WRITE(numout,*) '~~~~~~~~~~~ ' |
|---|
| 92 | WRITE(numout,*) ' Namelist namusr_def : WAD_TEST_CASES test case' |
|---|
| 93 | WRITE(numout,*) ' horizontal resolution rn_dx = ', rn_dx, ' meters' |
|---|
| 94 | WRITE(numout,*) ' vertical resolution rn_dz = ', rn_dz, ' meters' |
|---|
| 95 | WRITE(numout,*) ' WAD_TEST_CASES domain = 52 km x 34 km x 10 m' |
|---|
| 96 | WRITE(numout,*) ' resulting global domain size : jpiglo = ', kpi |
|---|
| 97 | WRITE(numout,*) ' jpjglo = ', kpj |
|---|
| 98 | WRITE(numout,*) ' jpkglo = ', kpk |
|---|
| 99 | WRITE(numout,*) ' ' |
|---|
| 100 | ENDIF |
|---|
| 101 | ! |
|---|
| 102 | END SUBROUTINE usr_def_nam |
|---|
| 103 | |
|---|
| 104 | !!====================================================================== |
|---|
| 105 | END MODULE usrdef_nam |
|---|
