MODULE usrdef_nam !!====================================================================== !! *** MODULE usrdef_nam *** !! !! === EW_CANAL configuration === !! !! User defined : set the domain characteristics of a user configuration !!====================================================================== !! History : NEMO ! 2017-10 (J. Chanut) Original code !!---------------------------------------------------------------------- !!---------------------------------------------------------------------- !! usr_def_nam : read user defined namelist and set global domain size !! usr_def_hgr : initialize the horizontal mesh !!---------------------------------------------------------------------- USE dom_oce , ONLY: nimpp , njmpp ! i- & j-indices of the local domain USE par_oce ! ocean space and time domain USE phycst ! physical constants ! USE in_out_manager ! I/O manager USE lib_mpp ! MPP library USE timing ! Timing IMPLICIT NONE PRIVATE PUBLIC usr_def_nam ! called by nemogcm.F90 ! !!* namusr_def namelist *!! REAL(wp) :: rn_domszx = 1800. ! x horizontal size [km] REAL(wp) :: rn_domszy = 1800. ! y horizontal size [km] REAL(wp), PUBLIC :: rn_domszz = 5000. ! z horizontal size [m] REAL(wp), PUBLIC :: rn_dx = 30. ! x horizontal resolution [km] REAL(wp), PUBLIC :: rn_dy = 30. ! y horizontal resolution [km] REAL(wp), PUBLIC :: rn_dz = 500. ! vertical resolution [m] REAL(wp), PUBLIC :: rn_0xratio = 0.5 ! x domain ratio of the 0 REAL(wp), PUBLIC :: rn_0yratio = 0.5 ! x domain ratio of the 0 INTEGER , PUBLIC :: nn_fcase = 1 ! F computation (0:f0, 1:Beta, 2:real) REAL(wp), PUBLIC :: rn_ppgphi0 = 38.5 ! reference latitude for beta-plane REAL(wp), PUBLIC :: rn_u10 = 0. ! 10m wind speed [m/s] REAL(wp), PUBLIC :: rn_windszx = 150. ! longitudinal wind extension [km] REAL(wp), PUBLIC :: rn_windszy = 150. ! latitudinal wind extension [km] REAL(wp), PUBLIC :: rn_uofac = 0. ! Uoce multiplicative factor (0.:absolute or 1.:relative winds) REAL(wp), PUBLIC :: rn_vtxmax = 0. ! initial canal max current [m/s] REAL(wp), PUBLIC :: rn_uzonal = 0. ! initial zonal current [m/s] REAL(wp), PUBLIC :: rn_ujetszx = 150. ! longitudinal jet extension [km] REAL(wp), PUBLIC :: rn_ujetszy = 150. ! latitudinal jet extension [km] INTEGER , PUBLIC :: nn_botcase = 0 ! bottom definition (0:flat, 1:bump) INTEGER , PUBLIC :: nn_initcase= 0 ! initial condition case (0=rest, 1=zonal current, 2=canal) LOGICAL , PUBLIC :: ln_sshnoise=.false. ! add random noise on initial ssh REAL(wp), PUBLIC :: rn_lambda = 50. ! gaussian lambda !!---------------------------------------------------------------------- !! NEMO/OCE 4.0 , NEMO Consortium (2018) !! $Id$ !! Software governed by the CeCILL license (see ./LICENSE) !!---------------------------------------------------------------------- CONTAINS SUBROUTINE usr_def_nam( cd_cfg, kk_cfg, kpi, kpj, kpk, kperio ) !!---------------------------------------------------------------------- !! *** ROUTINE dom_nam *** !! !! ** Purpose : read user defined namelist and define the domain size !! !! ** Method : read in namusr_def containing all the user specific namelist parameter !! !! Here EW_CANAL configuration !! !! ** input : - namusr_def namelist found in namelist_cfg !!---------------------------------------------------------------------- CHARACTER(len=*) , INTENT(out) :: cd_cfg ! configuration name INTEGER , INTENT(out) :: kk_cfg ! configuration resolution INTEGER , INTENT(out) :: kpi, kpj, kpk ! global domain sizes INTEGER , INTENT(out) :: kperio ! lateral global domain b.c. ! INTEGER :: ios ! Local integer REAL(wp):: zh ! Local scalars !! NAMELIST/namusr_def/ rn_domszx, rn_domszy, rn_domszz, rn_dx, rn_dy, rn_dz, rn_0xratio, rn_0yratio & & , nn_fcase, rn_ppgphi0, rn_vtxmax, rn_uzonal, rn_ujetszx, rn_ujetszy & & , rn_u10, rn_windszx, rn_windszy, rn_uofac & & , nn_botcase, nn_initcase, ln_sshnoise, rn_lambda !!---------------------------------------------------------------------- ! REWIND( numnam_cfg ) ! Namelist namusr_def (exist in namelist_cfg only) READ ( numnam_cfg, namusr_def, IOSTAT = ios, ERR = 902 ) 902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namusr_def in configuration namelist' ) ! IF(lwm) WRITE( numond, namusr_def ) ! #if defined key_agrif ! Domain parameters are taken from parent: IF( .NOT. Agrif_Root() ) THEN rn_dx = Agrif_Parent(rn_dx)/Agrif_Rhox() rn_dy = Agrif_Parent(rn_dy)/Agrif_Rhoy() rn_dz = Agrif_Parent(rn_dz) rn_ppgphi0 = Agrif_Parent(rn_ppgphi0) ENDIF rn_0xratio = 0.5 rn_0yratio = 0.5 #endif ! IF(lwm) WRITE( numond, namusr_def ) ! cd_cfg = 'EW_CANAL' ! name & resolution (not used) kk_cfg = INT( rn_dx ) ! ! Global Domain size: EW_CANAL global domain is 1800 km x 1800 Km x 5000 m kpi = NINT( rn_domszx / rn_dx ) + 1 kpj = NINT( rn_domszy / rn_dy ) + 3 kpk = NINT( rn_domszz / rn_dz ) + 1 #if defined key_agrif IF( .NOT. Agrif_Root() ) THEN kpi = nbcellsx + 2 + 2*nbghostcells kpj = nbcellsy + 2 + 2*nbghostcells ENDIF #endif ! zh = (kpk-1)*rn_dz ! ! Set the lateral boundary condition of the global domain kperio = 1 ! EW_CANAL configuration : closed basin ! ! control print IF(lwp) THEN WRITE(numout,*) ' ' WRITE(numout,*) 'usr_def_nam : read the user defined namelist (namusr_def) in namelist_cfg' WRITE(numout,*) '~~~~~~~~~~~ ' WRITE(numout,*) ' Namelist namusr_def : EW_CANAL test case' WRITE(numout,*) ' horizontal domain size-x rn_domszx = ', rn_domszx, ' km' WRITE(numout,*) ' horizontal domain size-y rn_domszy = ', rn_domszy, ' km' WRITE(numout,*) ' vertical domain size-z rn_domszz = ', rn_domszz, ' m' WRITE(numout,*) ' horizontal x-resolution rn_dx = ', rn_dx, ' km' WRITE(numout,*) ' horizontal y-resolution rn_dy = ', rn_dy, ' km' WRITE(numout,*) ' vertical resolution rn_dz = ', rn_dz, ' m' WRITE(numout,*) ' x-domain ratio of the 0 rn_0xratio = ', rn_0xratio WRITE(numout,*) ' y-domain ratio of the 0 rn_0yratio = ', rn_0yratio WRITE(numout,*) ' H [m] : ', zh WRITE(numout,*) ' F computation nn_fcase = ', nn_fcase WRITE(numout,*) ' Reference latitude rn_ppgphi0 = ', rn_ppgphi0 WRITE(numout,*) ' 10m wind speed rn_u10 = ', rn_u10, ' m/s' WRITE(numout,*) ' wind latitudinal extension rn_windszy = ', rn_windszy, ' km' WRITE(numout,*) ' wind longitudinal extension rn_windszx = ', rn_windszx, ' km' WRITE(numout,*) ' Uoce multiplicative factor rn_uofac = ', rn_uofac WRITE(numout,*) ' initial Canal max current rn_vtxmax = ', rn_vtxmax, ' m/s' WRITE(numout,*) ' initial zonal current rn_uzonal = ', rn_uzonal, ' m/s' WRITE(numout,*) ' Jet latitudinal extension rn_ujetszy = ', rn_ujetszy, ' km' WRITE(numout,*) ' Jet longitudinal extension rn_ujetszx = ', rn_ujetszx, ' km' WRITE(numout,*) ' bottom definition (0:flat) nn_botcase = ', nn_botcase WRITE(numout,*) ' initial condition case nn_initcase= ', nn_initcase WRITE(numout,*) ' (0:rest, 1:zonal current, 10:shear)' WRITE(numout,*) ' add random noise on initial ssh ln_sshnoise= ', ln_sshnoise WRITE(numout,*) ' Gaussian lambda parameter rn_lambda = ', rn_lambda WRITE(numout,*) ' ' WRITE(numout,*) ' Lateral boundary condition of the global domain' WRITE(numout,*) ' EW_CANAL : closed basin jperio = ', kperio ENDIF ! END SUBROUTINE usr_def_nam !!====================================================================== END MODULE usrdef_nam