MODULE opa !!============================================================================== !! *** MODULE opa *** !! Ocean system : OPA ocean dynamics (including on-line tracers 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 !!---------------------------------------------------------------------- !!---------------------------------------------------------------------- !! opa_model : solve ocean dynamics, tracer and/or sea-ice !! opa_init : initialization of the opa model !! opa_ctl : initialisation of algorithm flag !! opa_closefile : close remaining files !!---------------------------------------------------------------------- USE step_oce ! module used in the ocean time stepping module USE sbc_oce ! surface boundary condition: ocean USE domcfg ! domain configuration (dom_cfg routine) USE mppini ! shared/distributed memory setting (mpp_init routine) USE domain ! domain initialization (dom_init routine) USE obcini ! open boundary cond. initialization (obc_ini routine) USE bdyini ! unstructured open boundary cond. initialization (bdy_init routine) USE istate ! initial state setting (istate_init routine) USE ldfdyn ! lateral viscosity setting (ldfdyn_init routine) USE ldftra ! lateral diffusivity setting (ldftra_init routine) USE zdfini USE phycst ! physical constant (par_cst routine) USE trdmod ! momentum/tracers trends (trd_mod_init routine) USE asminc ! assimilation increments (asm_inc_init routine) USE asmtrj ! writing out state trajectory USE sshwzv ! vertical velocity used in asm USE diaptr ! poleward transports (dia_ptr_init routine) USE diaobs ! Observation diagnostics (dia_obs_init routine) USE step ! OPA time-stepping (stp routine) #if defined key_oasis3 USE cpl_oasis3 ! OASIS3 coupling #elif defined key_oasis4 USE cpl_oasis4 ! OASIS4 coupling (not working) #endif #if defined key_c1d USE c1d ! 1D configuration USE step_c1d ! Time stepping loop for the 1D configuration #endif #if defined key_top USE trcini ! passive tracer initialisation #endif USE lib_mpp ! distributed memory computing #if defined key_iomput USE mod_ioclient #endif PRIVATE PUBLIC opa_model ! called by model.F90 PUBLIC opa_init ! needed by AGRIF CHARACTER (len=64) :: cform_aaa="( /, 'AAAAAAAA', / ) " ! flag for output listing !!---------------------------------------------------------------------- !! NEMO/OPA 3.3 , NEMO Consortium (2010) !! $Id $ !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) !!---------------------------------------------------------------------- CONTAINS SUBROUTINE opa_model !!---------------------------------------------------------------------- !! *** ROUTINE opa *** !! !! ** Purpose : opa 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 opa_init !== Initialisations ==! ! !-----------------------! ! 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( nstop ) IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA ! !-----------------------! ! !== time stepping ==! ! !-----------------------! istp = nit000 #if defined key_c1d DO WHILE ( istp <= nitend .AND. nstop == 0 ) CALL stp_c1d( istp ) istp = istp + 1 END DO #else IF( lk_asminc ) THEN IF( ln_bkgwri ) CALL asm_bkg_wri( nit000 - 1 ) ! Output background fields IF( ln_trjwri ) CALL asm_trj_wri( nit000 - 1 ) ! Output trajectory fields IF( ln_asmdin ) THEN ! Direct initialization IF( ln_trainc ) CALL tra_asm_inc( nit000 - 1 ) ! Tracers IF( ln_dyninc ) THEN CALL dyn_asm_inc( nit000 - 1 ) ! Dynamics IF ( ln_asmdin ) CALL ssh_wzv ( nit000 - 1 ) ! update vertical velocity ENDIF IF( ln_sshinc ) CALL ssh_asm_inc( nit000 - 1 ) ! SSH ENDIF ENDIF DO WHILE ( istp <= nitend .AND. nstop == 0 ) #if defined key_agrif CALL Agrif_Step( stp ) ! AGRIF: time stepping #else CALL stp( istp ) ! standard time stepping #endif istp = istp + 1 IF( lk_mpp ) CALL mpp_max( nstop ) END DO #endif IF( lk_diaobs ) CALL dia_obs_wri ! !------------------------! ! !== finalize the run ==! ! !------------------------! IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA ! IF( nstop /= 0 .AND. lwp ) THEN ! error print WRITE(numout,cform_err) WRITE(numout,*) nstop, ' error have been found' ENDIF ! CALL opa_closefile #if defined key_oasis3 || defined key_oasis4 CALL cpl_prism_finalize ! end coupling and mpp communications with OASIS #else IF( lk_mpp ) CALL mppstop ! end mpp communications #endif ! END SUBROUTINE opa_model SUBROUTINE opa_init !!---------------------------------------------------------------------- !! *** ROUTINE opa_init *** !! !! ** Purpose : initialization of the opa model !! !!---------------------------------------------------------------------- INTEGER :: ilocal_comm CHARACTER(len=80),dimension(10) :: cltxt = '' INTEGER :: ji ! local loop indices !! NAMELIST/namctl/ ln_ctl , nn_print, nn_ictls, nn_ictle, & & nn_isplt, nn_jsplt, nn_jctls, nn_jctle, nn_bench !!---------------------------------------------------------------------- ! ! ! open Namelist file CALL ctl_opn( numnam, 'namelist', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. ) ! READ( numnam, namctl ) ! Namelist namctl : Control prints & Benchmark ! ! !--------------------------------------------! ! ! set communicator & select the local node ! ! !--------------------------------------------! #if defined key_iomput IF( Agrif_Root() ) THEN # if defined key_oasis3 || defined key_oasis4 CALL cpl_prism_init( ilocal_comm ) ! nemo local communicator given by oasis # endif CALL init_ioclient( ilocal_comm ) ! exchange io_server nemo local communicator with the io_server ENDIF narea = mynode( cltxt, ilocal_comm ) ! Nodes selection #else # if defined key_oasis3 || defined key_oasis4 IF( Agrif_Root() ) THEN CALL cpl_prism_init( ilocal_comm ) ! nemo local communicator given by oasis ENDIF narea = mynode( cltxt, ilocal_comm ) ! Nodes selection (control print return in cltxt) # else ilocal_comm = 0 narea = mynode( cltxt ) ! Nodes selection (control print return in cltxt) # endif #endif narea = narea + 1 ! mynode return the rank of proc (0 --> jpnij -1 ) lwp = (narea == 1) .OR. ln_ctl ! control of all listing output print 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' WRITE(numout,*) ' NEMO team' WRITE(numout,*) ' Ocean General Circulation Model' WRITE(numout,*) ' version 3.3 (2010) ' 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,cform_aaa) ! Flag AAAAAAA ! ENDIF ! !--------------------------------! ! ! Model general initialization ! ! !--------------------------------! CALL opa_ctl ! Control prints & Benchmark ! ! Domain decomposition IF( jpni*jpnj == jpnij ) THEN ; CALL mpp_init ! standard cutting out ELSE ; CALL mpp_init2 ! eliminate land processors ENDIF ! ! ! General initialization CALL phy_cst ! Physical constants CALL eos_init ! Equation of state CALL dom_cfg ! Domain configuration CALL dom_init ! Domain IF( ln_ctl ) CALL prt_ctl_init ! Print control IF( lk_obc ) CALL obc_init ! Open boundaries IF( lk_bdy ) CALL bdy_init ! Unstructured open boundaries IF( ln_zps ) CALL zps_hde_init ! Partial steps: horizontal derivative CALL istate_init ! ocean initial state (Dynamics and tracers) ! ! Ocean physics CALL sbc_init ! Forcings : surface module ! ! Vertical physics CALL zdf_init ! namelist read CALL zdf_bfr_init ! bottom friction IF( lk_zdfric ) CALL zdf_ric_init ! Richardson number dependent Kz IF( lk_zdftke ) CALL zdf_tke_init ! TKE closure scheme IF( lk_zdfgls ) CALL zdf_gls_init ! GLS closure scheme IF( lk_zdfkpp ) CALL zdf_kpp_init ! KPP closure scheme IF( lk_zdftmx ) CALL zdf_tmx_init ! tidal vertical mixing IF( lk_zdfddm .AND. .NOT. lk_zdfkpp ) & & CALL zdf_ddm_init ! double diffusive mixing ! ! Lateral physics CALL ldf_tra_init ! Lateral ocean tracer physics CALL ldf_dyn_init ! Lateral ocean momentum physics IF( lk_ldfslp ) CALL ldf_slp_init ! slope of lateral mixing ! ! Active tracers CALL tra_qsr_init ! penetrative solar radiation qsr CALL tra_bbc_init ! bottom heat flux IF( lk_trabbl ) CALL tra_bbl_init ! advective (and/or diffusive) bottom boundary layer scheme IF( lk_tradmp ) CALL tra_dmp_init ! internal damping trends CALL tra_adv_init ! horizontal & vertical advection IF( n_cla == 1 ) CALL tra_cla_init ! Cross Land Advection (Update Hor. advection) CALL tra_ldf_init ! lateral mixing CALL tra_zdf_init ! vertical mixing and after tracer fields ! ! Dynamics CALL dyn_adv_init ! advection (vector or flux form) CALL dyn_vor_init ! vorticity term including Coriolis CALL dyn_ldf_init ! lateral mixing CALL dyn_hpg_init ! horizontal gradient of Hydrostatic pressure CALL dyn_zdf_init ! vertical diffusion CALL dyn_spg_init ! surface pressure gradient #if defined key_top ! ! Passive tracers CALL trc_init #endif ! ! Diagnostics CALL iom_init ! iom_put initialization IF( lk_floats ) CALL flo_init ! drifting Floats IF( lk_diaar5 ) CALL dia_ar5_init ! ar5 diag CALL dia_ptr_init ! Poleward TRansports initialization CALL dia_hsb_init ! heat content, salt content and volume budgets CALL trd_mod_init ! Mixed-layer/Vorticity/Integral constraints trends IF( lk_diaobs ) THEN ! Observation & model comparison CALL dia_obs_init ! Initialize observational data CALL dia_obs( nit000 - 1 ) ! Observation operator for restart ENDIF ! ! Assimilation increments IF( lk_asminc ) CALL asm_inc_init ! Initialize assimilation increments IF(lwp) WRITE(numout,*) 'Euler time step switch is ', neuler ! END SUBROUTINE opa_init SUBROUTINE opa_ctl !!---------------------------------------------------------------------- !! *** ROUTINE opa *** !! !! ** Purpose : Initialise logical flags that control the choice of !! some algorithm or control print !! !! ** Method : - print namctl information !! - Read in namilist namflg logical flags !!---------------------------------------------------------------------- NAMELIST/namdyn_hpg/ ln_hpg_zco , ln_hpg_zps , ln_hpg_sco, ln_hpg_hel, & & ln_hpg_wdj , ln_hpg_djc , ln_hpg_rot, rn_gamma , & & ln_dynhpg_imp, nn_dynhpg_rst !!---------------------------------------------------------------------- IF(lwp) THEN ! Parameter print WRITE(numout,*) WRITE(numout,*) 'opa_ctl: Control prints & Benchmark' 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,*) ' benchmark parameter (0/1) nn_bench = ', nn_bench 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 nbench = nn_bench ! ! Parameter control ! IF( ln_ctl ) THEN ! sub-domain area indices for the control prints IF( lk_mpp ) THEN isplt = jpni ; jsplt = jpnj ; ijsplt = jpni*jpnj ! the domain is forced to the real splitted 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( nbench == 1 ) THEN ! Benchmark SELECT CASE ( cp_cfg ) CASE ( 'gyre' ) ; CALL ctl_warn( ' The Benchmark is activated ' ) CASE DEFAULT ; CALL ctl_stop( ' The Benchmark is based on the GYRE configuration:', & & ' key_gyre must be used or set nbench = 0' ) END SELECT ENDIF ! END SUBROUTINE opa_ctl SUBROUTINE opa_closefile !!---------------------------------------------------------------------- !! *** ROUTINE opa_closefile *** !! !! ** Purpose : Close the files !!---------------------------------------------------------------------- USE dtatem ! temperature data USE dtasal ! salinity data !!---------------------------------------------------------------------- ! 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( numsol /= -1 ) CLOSE( numsol ) ! solver file IF( numnam /= -1 ) CLOSE( numnam ) ! oce namelist IF( numnam_ice /= -1 ) CLOSE( numnam_ice ) ! ice namelist IF( numevo_ice /= -1 ) CLOSE( numevo_ice ) ! ice variables (temp. evolution) IF( numout /= 6 ) CLOSE( numout ) ! standard model output file numout = 6 ! redefine numout in case it is used after this point... ! END SUBROUTINE opa_closefile !!====================================================================== END MODULE opa