MODULE nemogcm !!====================================================================== !! *** MODULE nemogcm *** !! Ocean system : NEMO GCM (ocean dynamics, on-line tracers, biochemistry and sea-ice) !!====================================================================== !! History : 3.6 ! 2015-12 (A. Ryan) Original code (from OCE/) !! 4.0 ! 2016-11 (G. Madec, S. Flavoni) domain configuration / user defined interface !!---------------------------------------------------------------------- !!---------------------------------------------------------------------- !! 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 !!---------------------------------------------------------------------- USE step_oce ! module used in the ocean time stepping module (step.F90) USE domain ! domain initialization (dom_init & dom_cfg routines) USE istate ! initial state setting (istate_init routine) USE phycst ! physical constant (par_cst routine) USE step ! NEMO time-stepping (stp routine) USE cpl_oasis3 ! OASIS3 coupling USE diaobs ! Observation diagnostics (dia_obs_init routine) #if defined key_nemocice_decomp USE ice_domain_size, only: nx_global, ny_global #endif ! ! Stand Alone Observation operator modules USE sao_data USE sao_intp ! USE lib_mpp ! distributed memory computing USE mppini ! shared/distributed memory setting (mpp_init routine) USE lbcnfd , ONLY : isendto, nsndto, nfsloop, nfeloop ! Setup of north fold exchanges USE lib_fortran ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined) #if defined key_iomput USE xios ! xIOserver #endif 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 !!---------------------------------------------------------------------- !! NEMO/OCE 4.0 , NEMO Consortium (2018) !! $Id$ !! Software governed by the CeCILL license (see ./LICENSE) !!---------------------------------------------------------------------- CONTAINS SUBROUTINE nemo_gcm !!---------------------------------------------------------------------- !! *** SUBROUTINE offline_obs_oper *** !! !! ** Purpose : To use NEMO components to interpolate model fields !! to observation space. !! !! ** Method : 1. Initialise NEMO !! 2. Initialise offline obs_oper !! 3. Cycle through match ups !! 4. Write results to file !!---------------------------------------------------------------------- ! CALL nemo_init ! Initialise NEMO ! CALL sao_data_init ! Initialise Stand Alone Observation operator data ! CALL dia_obs_init ! Initialise obs_operator ! CALL sao_interp ! Interpolate to observation space ! CALL dia_obs_wri ! Pipe to output files ! CALL dia_obs_dealloc ! Reset the obs_oper between ! IF(lk_mpp) CALL mppstop ! Safely stop MPI (end mpp communications) ! 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 integer CHARACTER(len=120), DIMENSION(30) :: cltxt, cltxt2, clnam ! NAMELIST/namctl/ ln_ctl , nn_print, nn_ictls, nn_ictle, & & nn_isplt , nn_jsplt, nn_jctls, nn_jctle, & & ln_timing, ln_diacfl NAMELIST/namcfg/ ln_read_cfg, cn_domcfg, ln_closea, ln_write_cfg, cn_domcfg_out, ln_use_jattr !!---------------------------------------------------------------------- ! cltxt = '' cltxt2 = '' clnam = '' cxios_context = 'nemo' ! ! ! 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 : Control prints 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 : Control prints 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 : Control prints & Benchmark READ ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 ) 904 IF( ios > 0 ) CALL ctl_nam ( ios , 'namcfg in configuration namelist', .TRUE. ) ! !--------------------------! ! ! Set global domain size ! (control print return in cltxt2) ! !--------------------------! IF( ln_read_cfg ) THEN ! Read sizes in domain configuration file CALL domain_cfg ( cltxt2, cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio ) ! ELSE ! user-defined namelist CALL usr_def_nam( cltxt2, clnam, cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio ) ENDIF ! ! ! !--------------------------------------------! ! ! set communicator & select the local node ! ! ! NB: mynode also opens output.namelist.dyn ! ! ! on unit number numond on first proc ! ! !--------------------------------------------! #if defined key_iomput IF( Agrif_Root() ) THEN IF( lk_oasis ) THEN CALL cpl_init( "oceanx", ilocal_comm ) ! nemo local communicator given by oasis CALL xios_initialize( "not used",local_comm=ilocal_comm ) ! send nemo communicator to xios ELSE CALL xios_initialize( "for_xios_mpi_id",return_comm=ilocal_comm ) ! nemo local communicator given by xios ENDIF ENDIF ! Nodes selection (control print return in cltxt) narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm ) #else IF( lk_oasis ) THEN IF( Agrif_Root() ) THEN CALL cpl_init( "oceanx", ilocal_comm ) ! nemo local communicator given by oasis ENDIF ! Nodes selection (control print return in cltxt) narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm ) ELSE ilocal_comm = 0 ! Nodes selection (control print return in cltxt) narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop ) ENDIF #endif 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 ) IF( .NOT.ln_read_cfg ) THEN DO ji = 1, SIZE(clnam) IF( TRIM(clnam(ji)) /= '' ) WRITE(numond, * ) clnam(ji) ! namusr_def print END DO ENDIF 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,*) ' Stand Alone Observation operator' WRITE(numout,*) ' NEMO version 4.0 (2017) ' WRITE(numout,*) WRITE(numout,*) DO ji = 1, SIZE(cltxt) IF( TRIM(cltxt (ji)) /= '' ) WRITE(numout,*) cltxt(ji) ! control print of mynode END DO WRITE(numout,*) WRITE(numout,*) DO ji = 1, SIZE(cltxt2) IF( TRIM(cltxt2(ji)) /= '' ) WRITE(numout,*) cltxt2(ji) ! control print of domain size END DO ! WRITE(numout,cform_aaa) ! Flag AAAAAAA ! ENDIF ! ! Domain decomposition CALL mpp_init ! MPP ! 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 ! ! ! General initialization IF( ln_timing ) CALL timing_init ! timing IF( ln_timing ) CALL timing_start( 'nemo_init') ! CALL phy_cst ! Physical constants CALL eos_init ! Equation of state CALL dom_init('SAO') ! Domain IF( ln_ctl ) CALL prt_ctl_init ! Print control CALL istate_init ! ocean initial state (Dynamics and tracers) 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,*) ' 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(lwp) THEN ! control print WRITE(numout,*) WRITE(numout,*) 'namcfg : configuration initialization through namelist read' WRITE(numout,*) '~~~~~~~ ' WRITE(numout,*) ' Namelist namcfg' WRITE(numout,*) ' read domain configuration file ln_read_cfg = ', ln_read_cfg WRITE(numout,*) ' filename to be read cn_domcfg = ', TRIM(cn_domcfg) WRITE(numout,*) ' keep closed seas in the domain (if exist) ln_closea = ', ln_closea WRITE(numout,*) ' write configuration definition file ln_write_cfg = ', ln_write_cfg WRITE(numout,*) ' filename to be written cn_domcfg_out = ', TRIM(cn_domcfg_out) WRITE(numout,*) ' use file attribute if exists as i/p j-start ln_use_jattr = ', ln_use_jattr ENDIF 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' ) ! 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( numrun /= -1 ) CLOSE( numrun ) ! run statistics 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 diawri , ONLY: dia_wri_alloc USE dom_oce , ONLY: dom_oce_alloc ! INTEGER :: ierr !!---------------------------------------------------------------------- ! ierr = oce_alloc () ! ocean ierr = ierr + dia_wri_alloc () 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