MODULE nemogcm !!====================================================================== !! *** MODULE nemogcm *** !! Ocean system : NEMO GCM (ocean dynamics, on-line tracers, biochemistry and sea-ice) !!====================================================================== !! History : OPA ! 1990-10 (C. Levy, G. Madec) Original code !! 7.0 ! 1991-11 (M. Imbard, C. Levy, G. Madec) !! 7.1 ! 1993-03 (M. Imbard, C. Levy, G. Madec, O. Marti, M. Guyon, A. Lazar, !! P. Delecluse, C. Perigaud, G. Caniaux, B. Colot, C. Maes) release 7.1 !! - ! 1992-06 (L.Terray) coupling implementation !! - ! 1993-11 (M.A. Filiberti) IGLOO sea-ice !! 8.0 ! 1996-03 (M. Imbard, C. Levy, G. Madec, O. Marti, M. Guyon, A. Lazar, !! P. Delecluse, L.Terray, M.A. Filiberti, J. Vialar, A.M. Treguier, M. Levy) release 8.0 !! 8.1 ! 1997-06 (M. Imbard, G. Madec) !! 8.2 ! 1999-11 (M. Imbard, H. Goosse) LIM sea-ice model !! ! 1999-12 (V. Thierry, A-M. Treguier, M. Imbard, M-A. Foujols) OPEN-MP !! ! 2000-07 (J-M Molines, M. Imbard) Open Boundary Conditions (CLIPPER) !! NEMO 1.0 ! 2002-08 (G. Madec) F90: Free form and modules !! - ! 2004-06 (R. Redler, NEC CCRLE, Germany) add OASIS[3/4] coupled interfaces !! - ! 2004-08 (C. Talandier) New trends organization !! - ! 2005-06 (C. Ethe) Add the 1D configuration possibility !! - ! 2005-11 (V. Garnier) Surface pressure gradient organization !! - ! 2006-03 (L. Debreu, C. Mazauric) Agrif implementation !! - ! 2006-04 (G. Madec, R. Benshila) Step reorganization !! - ! 2007-07 (J. Chanut, A. Sellar) Unstructured open boundaries (BDY) !! 3.2 ! 2009-08 (S. Masson) open/write in the listing file in mpp !! 3.3 ! 2010-05 (K. Mogensen, A. Weaver, M. Martin, D. Lea) Assimilation interface !! - ! 2010-10 (C. Ethe, G. Madec) reorganisation of initialisation phase !! 3.3.1! 2011-01 (A. R. Porter, STFC Daresbury) dynamical allocation !! 3.4 ! 2011-10 (A. C. Coward, NOCS & J. Donners, PRACE) add nemo_northcomms !! - ! 2011-11 (C. Harris) decomposition changes for running with CICE !! 3.6 ! 2012-05 (C. Calone, J. Simeon, G. Madec, C. Ethe) Add grid coarsening !! - ! 2013-06 (I. Epicoco, S. Mocavero, CMCC) nemo_northcomms: setup avoiding MPI communication !! - ! 2014-12 (G. Madec) remove KPP scheme and cross-land advection (cla) !!---------------------------------------------------------------------- !!---------------------------------------------------------------------- !! nemo_gcm : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice !! nemo_init : initialization of the NEMO system !! nemo_ctl : initialisation of the contol print !! nemo_closefile: close remaining open files !! nemo_alloc : dynamical allocation !! nemo_partition: calculate MPP domain decomposition !! factorise : calculate the factors of the no. of MPI processes !!---------------------------------------------------------------------- USE dom_oce ! ocean space and time domain variables USE in_out_manager ! I/O manager USE iom ! USE domcfg ! domain configuration (dom_cfg routine) USE mppini ! shared/distributed memory setting (mpp_init routine) USE domain ! domain initialization (dom_init routine) USE phycst ! physical constant (par_cst routine) USE lib_fortran ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined) USE lib_mpp ! distributed memory computing USE lbcnfd , ONLY : isendto, nsndto, nfsloop, nfeloop ! Setup of north fold exchanges IMPLICIT NONE PRIVATE PUBLIC nemo_gcm ! called by model.F90 PUBLIC nemo_init ! needed by AGRIF PUBLIC nemo_alloc ! needed by TAM CHARACTER(lc) :: cform_aaa="( /, 'AAAAAAAA', / ) " ! flag for output listing #if defined key_agrif external agrif_boundary_connections, agrif_update_all, agrif_recompute_scalefactors #endif !!---------------------------------------------------------------------- !! NEMO/OPA 3.7 , NEMO Consortium (2015) !! $Id: nemogcm.F90 6152 2015-12-21 22:33:57Z acc $ !! Software governed by the CeCILL licence (./LICENSE) !!---------------------------------------------------------------------- CONTAINS SUBROUTINE nemo_gcm !!---------------------------------------------------------------------- !! *** ROUTINE nemo_gcm *** !! !! ** Purpose : NEMO solves the primitive equations on an orthogonal !! curvilinear mesh on the sphere. !! !! ** Method : - model general initialization !! - launch the time-stepping (stp routine) !! - finalize the run by closing files and communications !! !! References : Madec, Delecluse, Imbard, and Levy, 1997: internal report, IPSL. !! Madec, 2008, internal report, IPSL. !!---------------------------------------------------------------------- INTEGER :: istp ! time step index !!---------------------------------------------------------------------- ! #if defined key_agrif CALL Agrif_Init_Grids() ! AGRIF: set the meshes #endif ! !-----------------------! CALL nemo_init !== Initialisations ==! ! !-----------------------! PRINT *, 'end nemo init' #if defined key_agrif CALL Agrif_Regrid() CALL Agrif_Step_Child(agrif_boundary_connections) CALL Agrif_Step_Child_adj(agrif_update_all) CALL Agrif_Step_Child(agrif_recompute_scalefactors) CALL Agrif_Step_Child(cfg_write) #endif ! check that all process are still there... If some process have an error, ! they will never enter in step and other processes will wait until the end of the cpu time! IF( lk_mpp ) CALL mpp_max( 'nemogcm',nstop ) IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA ! !-----------------------! ! !== finalize the run ==! ! !------------------------! ! IF( nstop /= 0 .AND. lwp ) THEN ! error print WRITE(numout,cform_err) WRITE(numout,*) nstop, ' error have been found' ENDIF ! ! PRINT *, 'close file' CALL nemo_closefile PRINT *, 'The end' ! ! END SUBROUTINE nemo_gcm SUBROUTINE nemo_init !!---------------------------------------------------------------------- !! *** ROUTINE nemo_init *** !! !! ** Purpose : initialization of the NEMO GCM !!---------------------------------------------------------------------- INTEGER :: ji ! dummy loop indices INTEGER :: ios, ilocal_comm ! local integers CHARACTER(len=120), DIMENSION(60) :: cltxt, cltxt2, clnam !! NAMELIST/namctl/ ln_ctl , sn_cfctl, nn_print, nn_ictls, nn_ictle, & & nn_isplt , nn_jsplt, nn_jctls, nn_jctle, & & ln_timing, ln_diacfl NAMELIST/namcfg/ ln_e3_dep, & & cp_cfg, cp_cfz, jp_cfg, jpidta, jpjdta, jpkdta, jpiglo, jpjglo, & & jpizoom, jpjzoom, jperio, ln_use_jattr !!---------------------------------------------------------------------- ! cltxt = '' ! ! ! Open reference namelist and configuration namelist files CALL ctl_opn( numnam_ref, 'namelist_ref', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. ) CALL ctl_opn( numnam_cfg, 'namelist_cfg', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. ) ! REWIND( numnam_ref ) ! Namelist namctl in reference namelist READ ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 ) 901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in reference namelist', .TRUE. ) REWIND( numnam_cfg ) ! Namelist namctl in confguration namelist READ ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 ) 902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namctl in configuration namelist', .TRUE. ) ! REWIND( numnam_ref ) ! Namelist namcfg in reference namelist READ ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 ) 903 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in reference namelist', .TRUE. ) REWIND( numnam_cfg ) ! Namelist namcfg in confguration namelist READ ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 ) 904 IF( ios > 0 ) CALL ctl_nam ( ios , 'namcfg in configuration namelist', .TRUE. ) ! Force values for AGRIF zoom (cf. agrif_user.F90) ! ! !--------------------------------------------! ! ! set communicator & select the local node ! ! ! NB: mynode also opens output.namelist.dyn ! ! ! on unit number numond on first proc ! ! !--------------------------------------------! ! Nodes selection (control print return in cltxt) narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop ) narea = narea + 1 ! mynode return the rank of proc (0 --> jpnij -1 ) lwm = (narea == 1) ! control of output namelists lwp = (narea == 1) .OR. ln_ctl ! control of all listing output print IF(lwm) THEN ! write merged namelists from earlier to output namelist now that the ! file has been opened in call to mynode. nammpp has already been ! written in mynode (if lk_mpp_mpi) WRITE( numond, namctl ) WRITE( numond, namcfg ) ENDIF IF(lwp) THEN ! open listing units ! CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea ) ! WRITE(numout,*) WRITE(numout,*) ' CNRS - NERC - Met OFFICE - MERCATOR-ocean - INGV - CMCC' WRITE(numout,*) ' NEMO team' WRITE(numout,*) ' Ocean General Circulation Model' WRITE(numout,*) ' NEMO version 4.0 (2019) ' WRITE(numout,*) WRITE(numout,*) " ._ ._ ._ ._ ._ " WRITE(numout,*) " _.-._)`\_.-._)`\_.-._)`\_.-._)`\_.-._)`\_ " WRITE(numout,*) WRITE(numout,*) " o _, _, " WRITE(numout,*) " o .' ( .-' / " WRITE(numout,*) " o _/..._'. .' / " WRITE(numout,*) " ( o .-'` ` '-./ _.' " WRITE(numout,*) " ) ( o) ;= <_ ( " WRITE(numout,*) " ( '-.,\\__ __.-;`\ '. ) " WRITE(numout,*) " ) ) \) |`\ \) '. \ ( ( " WRITE(numout,*) " ( ( \_/ '-._\ ) ) " WRITE(numout,*) " ) ) ` ( ( " WRITE(numout,*) " ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ " WRITE(numout,*) DO ji = 1, SIZE(cltxt) IF( TRIM(cltxt (ji)) /= '' ) WRITE(numout,*) TRIM(cltxt(ji)) ! control print of mynode END DO WRITE(numout,*) WRITE(numout,*) ! DO ji = 1, SIZE(cltxt2) ! IF( TRIM(cltxt2(ji)) /= '' ) WRITE(numout,*) TRIM(cltxt2(ji)) ! control print of domain size ! END DO ! WRITE(numout,cform_aaa) ! Flag AAAAAAA ! ENDIF ! open /dev/null file to be able to supress output write easily ! CALL ctl_opn( numnul, '/dev/null', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. ) ! ! ! Domain decomposition CALL mpp_init ! MPP ! IF( Agrif_Root() ) THEN ! jpi = ( jpiglo -2*jpreci + (jpni-1) ) / jpni + 2*jpreci ! first dim. ! jpj = ( jpjglo -2*jprecj + (jpnj-1) ) / jpnj + 2*jprecj ! second dim. ! ENDIF jpk = jpkdta ! third dim jpim1 = jpi-1 ! inner domain indices jpjm1 = jpj-1 ! " " jpkm1 = jpk-1 ! " " jpij = jpi*jpj ! jpi x j #if defined key_agrif CALL Agrif_Declare_Var #endif ! Now we know the dimensions of the grid and numout has been set: we can allocate arrays CALL nemo_alloc() ! !-------------------------------! ! ! NEMO general initialization ! ! !-------------------------------! CALL nemo_ctl ! Control prints & Benchmark ! ! Domain decomposition ! ! ! General initialization CALL phy_cst ! Physical constants CALL dom_cfg ! Domain configuration CALL dom_init ! Domain ! END SUBROUTINE nemo_init SUBROUTINE nemo_ctl !!---------------------------------------------------------------------- !! *** ROUTINE nemo_ctl *** !! !! ** Purpose : control print setting !! !! ** Method : - print namctl information and check some consistencies !!---------------------------------------------------------------------- ! IF(lwp) THEN ! control print WRITE(numout,*) WRITE(numout,*) 'nemo_ctl: Control prints' WRITE(numout,*) '~~~~~~~~' WRITE(numout,*) ' Namelist namctl' WRITE(numout,*) ' run control (for debugging) ln_ctl = ', ln_ctl WRITE(numout,*) ' finer control over o/p sn_cfctl%l_config = ', sn_cfctl%l_config WRITE(numout,*) ' sn_cfctl%l_runstat = ', sn_cfctl%l_runstat WRITE(numout,*) ' sn_cfctl%l_trcstat = ', sn_cfctl%l_trcstat WRITE(numout,*) ' sn_cfctl%l_oceout = ', sn_cfctl%l_oceout WRITE(numout,*) ' sn_cfctl%l_layout = ', sn_cfctl%l_layout WRITE(numout,*) ' sn_cfctl%l_mppout = ', sn_cfctl%l_mppout WRITE(numout,*) ' sn_cfctl%l_mpptop = ', sn_cfctl%l_mpptop WRITE(numout,*) ' sn_cfctl%procmin = ', sn_cfctl%procmin WRITE(numout,*) ' sn_cfctl%procmax = ', sn_cfctl%procmax WRITE(numout,*) ' sn_cfctl%procincr = ', sn_cfctl%procincr WRITE(numout,*) ' sn_cfctl%ptimincr = ', sn_cfctl%ptimincr WRITE(numout,*) ' level of print nn_print = ', nn_print WRITE(numout,*) ' Start i indice for SUM control nn_ictls = ', nn_ictls WRITE(numout,*) ' End i indice for SUM control nn_ictle = ', nn_ictle WRITE(numout,*) ' Start j indice for SUM control nn_jctls = ', nn_jctls WRITE(numout,*) ' End j indice for SUM control nn_jctle = ', nn_jctle WRITE(numout,*) ' number of proc. following i nn_isplt = ', nn_isplt WRITE(numout,*) ' number of proc. following j nn_jsplt = ', nn_jsplt WRITE(numout,*) ' timing by routine ln_timing = ', ln_timing WRITE(numout,*) ' CFL diagnostics ln_diacfl = ', ln_diacfl ENDIF ! nprint = nn_print ! convert DOCTOR namelist names into OLD names nictls = nn_ictls nictle = nn_ictle njctls = nn_jctls njctle = nn_jctle isplt = nn_isplt jsplt = nn_jsplt ! IF( .NOT.ln_read_cfg ) ln_closea = .false. ! dealing possible only with a domcfg file ! ! ! Parameter control ! IF( ln_ctl ) THEN ! sub-domain area indices for the control prints IF( lk_mpp .AND. jpnij > 1 ) THEN isplt = jpni ; jsplt = jpnj ; ijsplt = jpni*jpnj ! the domain is forced to the real split domain ELSE IF( isplt == 1 .AND. jsplt == 1 ) THEN CALL ctl_warn( ' - isplt & jsplt are equal to 1', & & ' - the print control will be done over the whole domain' ) ENDIF ijsplt = isplt * jsplt ! total number of processors ijsplt ENDIF IF(lwp) WRITE(numout,*)' - The total number of processors over which the' IF(lwp) WRITE(numout,*)' print control will be done is ijsplt : ', ijsplt ! ! ! indices used for the SUM control IF( nictls+nictle+njctls+njctle == 0 ) THEN ! print control done over the default area lsp_area = .FALSE. ELSE ! print control done over a specific area lsp_area = .TRUE. IF( nictls < 1 .OR. nictls > jpiglo ) THEN CALL ctl_warn( ' - nictls must be 1<=nictls>=jpiglo, it is forced to 1' ) nictls = 1 ENDIF IF( nictle < 1 .OR. nictle > jpiglo ) THEN CALL ctl_warn( ' - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' ) nictle = jpiglo ENDIF IF( njctls < 1 .OR. njctls > jpjglo ) THEN CALL ctl_warn( ' - njctls must be 1<=njctls>=jpjglo, it is forced to 1' ) njctls = 1 ENDIF IF( njctle < 1 .OR. njctle > jpjglo ) THEN CALL ctl_warn( ' - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' ) njctle = jpjglo ENDIF ENDIF ENDIF ! ! IF( 1._wp /= SIGN(1._wp,-0._wp) ) CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows f2003 standard.', & ! & 'Compile with key_nosignedzero enabled:', & ! & '--> add -Dkey_nosignedzero to the definition of %CPP in your arch file' ) ! #if defined key_agrif IF( ln_timing ) CALL ctl_stop( 'AGRIF not implemented with ln_timing = true') #endif ! END SUBROUTINE nemo_ctl SUBROUTINE nemo_closefile !!---------------------------------------------------------------------- !! *** ROUTINE nemo_closefile *** !! !! ** Purpose : Close the files !!---------------------------------------------------------------------- ! IF( lk_mpp ) CALL mppsync ! CALL iom_close ! close all input/output files managed by iom_* ! IF( numstp /= -1 ) CLOSE( numstp ) ! time-step file IF( numnam_ref /= -1 ) CLOSE( numnam_ref ) ! oce reference namelist IF( numnam_cfg /= -1 ) CLOSE( numnam_cfg ) ! oce configuration namelist IF( lwm.AND.numond /= -1 ) CLOSE( numond ) ! oce output namelist IF( numnam_ice_ref /= -1 ) CLOSE( numnam_ice_ref ) ! ice reference namelist IF( numnam_ice_cfg /= -1 ) CLOSE( numnam_ice_cfg ) ! ice configuration namelist IF( lwm.AND.numoni /= -1 ) CLOSE( numoni ) ! ice output namelist IF( numevo_ice /= -1 ) CLOSE( numevo_ice ) ! ice variables (temp. evolution) IF( numout /= 6 ) CLOSE( numout ) ! standard model output file IF( numdct_vol /= -1 ) CLOSE( numdct_vol ) ! volume transports IF( numdct_heat /= -1 ) CLOSE( numdct_heat ) ! heat transports IF( numdct_salt /= -1 ) CLOSE( numdct_salt ) ! salt transports ! numout = 6 ! redefine numout in case it is used after this point... ! END SUBROUTINE nemo_closefile SUBROUTINE nemo_alloc !!---------------------------------------------------------------------- !! *** ROUTINE nemo_alloc *** !! !! ** Purpose : Allocate all the dynamic arrays of the OPA modules !! !! ** Method : !!---------------------------------------------------------------------- USE dom_oce , ONLY: dom_oce_alloc ! INTEGER :: ierr !!---------------------------------------------------------------------- ! ierr = dom_oce_alloc () ! ocean domain ! CALL mpp_sum( 'nemogcm', ierr ) IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'nemo_alloc : unable to allocate standard ocean arrays' ) ! END SUBROUTINE nemo_alloc !!====================================================================== END MODULE nemogcm