Context Navigation

nemogcm.F90 @ 8517

Last change on this file since 8517 was 8306, checked in by clem, 7 years ago
step1: remove LIM2 from the code
Property svn:keywords set to `Id`
File size: 40.7 KB

Rev	Line
[2496]	1	MODULE nemogcm
[2442]	2	!!======================================================================
[2496]	3	!! * MODULE nemogcm *
	4	!! Ocean system : NEMO GCM (ocean dynamics, on-line tracers, biochemistry and sea-ice)
[2442]	5	!!======================================================================
[1593]	6	!! History : OPA ! 1990-10 (C. Levy, G. Madec) Original code
	7	!! 7.0 ! 1991-11 (M. Imbard, C. Levy, G. Madec)
[3764]	8	!! 7.1 ! 1993-03 (M. Imbard, C. Levy, G. Madec, O. Marti, M. Guyon, A. Lazar,
	9	!! P. Delecluse, C. Perigaud, G. Caniaux, B. Colot, C. Maes) release 7.1
[1593]	10	!! - ! 1992-06 (L.Terray) coupling implementation
[3764]	11	!! - ! 1993-11 (M.A. Filiberti) IGLOO sea-ice
	12	!! 8.0 ! 1996-03 (M. Imbard, C. Levy, G. Madec, O. Marti, M. Guyon, A. Lazar,
[2104]	13	!! P. Delecluse, L.Terray, M.A. Filiberti, J. Vialar, A.M. Treguier, M. Levy) release 8.0
[1593]	14	!! 8.1 ! 1997-06 (M. Imbard, G. Madec)
[3764]	15	!! 8.2 ! 1999-11 (M. Imbard, H. Goosse) LIM sea-ice model
	16	!! ! 1999-12 (V. Thierry, A-M. Treguier, M. Imbard, M-A. Foujols) OPEN-MP
[1593]	17	!! ! 2000-07 (J-M Molines, M. Imbard) Open Boundary Conditions (CLIPPER)
	18	!! NEMO 1.0 ! 2002-08 (G. Madec) F90: Free form and modules
	19	!! - ! 2004-06 (R. Redler, NEC CCRLE, Germany) add OASIS[3/4] coupled interfaces
	20	!! - ! 2004-08 (C. Talandier) New trends organization
	21	!! - ! 2005-06 (C. Ethe) Add the 1D configuration possibility
	22	!! - ! 2005-11 (V. Garnier) Surface pressure gradient organization
	23	!! - ! 2006-03 (L. Debreu, C. Mazauric) Agrif implementation
	24	!! - ! 2006-04 (G. Madec, R. Benshila) Step reorganization
	25	!! - ! 2007-07 (J. Chanut, A. Sellar) Unstructured open boundaries (BDY)
	26	!! 3.2 ! 2009-08 (S. Masson) open/write in the listing file in mpp
[3764]	27	!! 3.3 ! 2010-05 (K. Mogensen, A. Weaver, M. Martin, D. Lea) Assimilation interface
[2236]	28	!! - ! 2010-10 (C. Ethe, G. Madec) reorganisation of initialisation phase
[3294]	29	!! 3.3.1! 2011-01 (A. R. Porter, STFC Daresbury) dynamical allocation
[5836]	30	!! 3.4 ! 2011-10 (A. C. Coward, NOCS & J. Donners, PRACE) add nemo_northcomms
	31	!! - ! 2011-11 (C. Harris) decomposition changes for running with CICE
	32	!! 3.6 ! 2012-05 (C. Calone, J. Simeon, G. Madec, C. Ethe) Add grid coarsening
	33	!! - ! 2013-06 (I. Epicoco, S. Mocavero, CMCC) nemo_northcomms: setup avoiding MPI communication
	34	!! - ! 2014-12 (G. Madec) remove KPP scheme and cross-land advection (cla)
[7646]	35	!! 4.0 ! 2016-10 (G. Madec, S. Flavoni) domain configuration / user defined interface
[1593]	36	!!----------------------------------------------------------------------
[3]	37
	38	!!----------------------------------------------------------------------
[6140]	39	!! nemo_gcm : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice
	40	!! nemo_init : initialization of the NEMO system
	41	!! nemo_ctl : initialisation of the contol print
	42	!! nemo_closefile: close remaining open files
	43	!! nemo_alloc : dynamical allocation
	44	!! nemo_partition: calculate MPP domain decomposition
	45	!! factorise : calculate the factors of the no. of MPI processes
[3]	46	!!----------------------------------------------------------------------
[6140]	47	USE step_oce ! module used in the ocean time stepping module (step.F90)
[7646]	48	USE phycst ! physical constant (par_cst routine)
	49	USE domain ! domain initialization (dom_init & dom_cfg routines)
	50	USE usrdef_nam ! user defined configuration
[6140]	51	USE tideini ! tidal components initialization (tide_ini routine)
[7646]	52	USE bdy_oce, ONLY: ln_bdy
[6140]	53	USE bdyini ! open boundary cond. setting (bdy_init routine)
	54	USE istate ! initial state setting (istate_init routine)
	55	USE ldfdyn ! lateral viscosity setting (ldfdyn_init routine)
	56	USE ldftra ! lateral diffusivity setting (ldftra_init routine)
	57	USE zdfini ! vertical physics setting (zdf_init routine)
	58	USE trdini ! dyn/tra trends initialization (trd_init routine)
	59	USE asminc ! assimilation increments
	60	USE asmbkg ! writing out state trajectory
	61	USE diaptr ! poleward transports (dia_ptr_init routine)
	62	USE diadct ! sections transports (dia_dct_init routine)
	63	USE diaobs ! Observation diagnostics (dia_obs_init routine)
	64	USE diacfl ! CFL diagnostics (dia_cfl_init routine)
	65	USE step ! NEMO time-stepping (stp routine)
	66	USE icbini ! handle bergs, initialisation
	67	USE icbstp ! handle bergs, calving, themodynamics and transport
	68	USE cpl_oasis3 ! OASIS3 coupling
	69	USE c1d ! 1D configuration
	70	USE step_c1d ! Time stepping loop for the 1D configuration
	71	USE dyndmp ! Momentum damping
	72	USE stopar ! Stochastic param.: ???
	73	USE stopts ! Stochastic param.: ???
[7646]	74	USE diurnal_bulk ! diurnal bulk SST
	75	USE step_diu ! diurnal bulk SST timestepping (called from here if run offline)
	76	USE crsini ! initialise grid coarsening utility
	77	USE diatmb ! Top,middle,bottom output
	78	USE dia25h ! 25h mean output
	79	USE sbc_oce , ONLY : lk_oasis
	80	USE wet_dry ! Wetting and drying setting (wad_init routine)
[1594]	81	#if defined key_top
[6140]	82	USE trcini ! passive tracer initialisation
[1594]	83	#endif
[7646]	84	#if defined key_nemocice_decomp
	85	USE ice_domain_size, only: nx_global, ny_global
	86	#endif
	87	!
[6140]	88	USE lib_mpp ! distributed memory computing
[7646]	89	USE mppini ! shared/distributed memory setting (mpp_init routine)
	90	USE lbcnfd , ONLY : isendto, nsndto, nfsloop, nfeloop ! Setup of north fold exchanges
	91	USE lib_fortran ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
[1412]	92	#if defined key_iomput
[6140]	93	USE xios ! xIOserver
[1359]	94	#endif
[268]	95
[2715]	96	IMPLICIT NONE
[3]	97	PRIVATE
	98
[2496]	99	PUBLIC nemo_gcm ! called by model.F90
	100	PUBLIC nemo_init ! needed by AGRIF
[3764]	101	PUBLIC nemo_alloc ! needed by TAM
[467]	102
[2498]	103	CHARACTER(lc) :: cform_aaa="( /, 'AAAAAAAA', / ) " ! flag for output listing
[1593]	104
[3]	105	!!----------------------------------------------------------------------
[7646]	106	!! NEMO/OPA 3.7 , NEMO Consortium (2016)
[2392]	107	!! $Id$
[2329]	108	!! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
[3]	109	!!----------------------------------------------------------------------
	110	CONTAINS
	111
[2496]	112	SUBROUTINE nemo_gcm
[3]	113	!!----------------------------------------------------------------------
[2496]	114	!! * ROUTINE nemo_gcm *
[3]	115	!!
[3764]	116	!! ** Purpose : NEMO solves the primitive equations on an orthogonal
[1593]	117	!! curvilinear mesh on the sphere.
[3]	118	!!
	119	!! ** Method : - model general initialization
	120	!! - launch the time-stepping (stp routine)
[1593]	121	!! - finalize the run by closing files and communications
[3]	122	!!
[2715]	123	!! References : Madec, Delecluse, Imbard, and Levy, 1997: internal report, IPSL.
[1593]	124	!! Madec, 2008, internal report, IPSL.
[3]	125	!!----------------------------------------------------------------------
[7646]	126	INTEGER :: istp ! time step index
[389]	127	!!----------------------------------------------------------------------
[2382]	128	!
[392]	129	#if defined key_agrif
[1593]	130	CALL Agrif_Init_Grids() ! AGRIF: set the meshes
[389]	131	#endif
[7646]	132	!
[1593]	133	! !-----------------------!
[2496]	134	CALL nemo_init !== Initialisations ==!
[1593]	135	! !-----------------------!
[2715]	136	#if defined key_agrif
[3680]	137	CALL Agrif_Declare_Var_dom ! AGRIF: set the meshes for DOM
	138	CALL Agrif_Declare_Var ! " " " " " DYN/TRA
[2715]	139	# if defined key_top
[3680]	140	CALL Agrif_Declare_Var_top ! " " " " " TOP
[2715]	141	# endif
[7646]	142	# if defined key_lim3
	143	CALL Agrif_Declare_Var_lim3 ! " " " " " LIM3
	144	# endif
[2715]	145	#endif
[682]	146	! check that all process are still there... If some process have an error,
	147	! they will never enter in step and other processes will wait until the end of the cpu time!
[900]	148	IF( lk_mpp ) CALL mpp_max( nstop )
[682]	149
[1593]	150	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
	151
	152	! !-----------------------!
	153	! !== time stepping ==!
	154	! !-----------------------!
[900]	155	istp = nit000
[2236]	156	#if defined key_c1d
[389]	157	DO WHILE ( istp <= nitend .AND. nstop == 0 )
[900]	158	CALL stp_c1d( istp )
[389]	159	istp = istp + 1
	160	END DO
[2236]	161	#else
	162	IF( lk_asminc ) THEN
	163	IF( ln_bkgwri ) CALL asm_bkg_wri( nit000 - 1 ) ! Output background fields
	164	IF( ln_asmdin ) THEN ! Direct initialization
	165	IF( ln_trainc ) CALL tra_asm_inc( nit000 - 1 ) ! Tracers
[3764]	166	IF( ln_dyninc ) CALL dyn_asm_inc( nit000 - 1 ) ! Dynamics
[2236]	167	IF( ln_sshinc ) CALL ssh_asm_inc( nit000 - 1 ) ! SSH
	168	ENDIF
	169	ENDIF
[3764]	170
[5656]	171	#if defined key_agrif
	172	CALL Agrif_Regrid()
	173	#endif
	174
[389]	175	DO WHILE ( istp <= nitend .AND. nstop == 0 )
[392]	176	#if defined key_agrif
[5656]	177	CALL stp ! AGRIF: time stepping
[389]	178	#else
[6140]	179	IF ( .NOT. ln_diurnal_only ) THEN
	180	CALL stp( istp ) ! standard time stepping
	181	ELSE
	182	CALL stp_diurnal( istp ) ! time step only the diurnal SST
	183	ENDIF
[389]	184	#endif
	185	istp = istp + 1
[900]	186	IF( lk_mpp ) CALL mpp_max( nstop )
[389]	187	END DO
[2236]	188	#endif
	189
[6140]	190	IF( ln_diaobs ) CALL dia_obs_wri
[3609]	191	!
	192	IF( ln_icebergs ) CALL icb_end( nitend )
[3764]	193
[1593]	194	! !------------------------!
	195	! !== finalize the run ==!
	196	! !------------------------!
[7646]	197	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
[1593]	198	!
[7646]	199	IF( nstop /= 0 .AND. lwp ) THEN ! error print
[682]	200	WRITE(numout,cform_err)
[3764]	201	WRITE(numout,*) nstop, ' error have been found'
[389]	202	ENDIF
[1593]	203	!
[3294]	204	#if defined key_agrif
[8306]	205	IF( .NOT. Agrif_Root() ) THEN
[6140]	206	CALL Agrif_ParentGrid_To_ChildGrid()
	207	IF( ln_diaobs ) CALL dia_obs_wri
[5536]	208	IF( nn_timing == 1 ) CALL timing_finalize
[5836]	209	CALL Agrif_ChildGrid_To_ParentGrid()
[8306]	210	ENDIF
[3294]	211	#endif
	212	IF( nn_timing == 1 ) CALL timing_finalize
	213	!
[2496]	214	CALL nemo_closefile
[4990]	215	!
[3769]	216	#if defined key_iomput
[7646]	217	CALL xios_finalize ! end mpp communications with xios
	218	IF( lk_oasis ) CALL cpl_finalize ! end coupling and mpp communications with OASIS
[532]	219	#else
[5407]	220	IF( lk_oasis ) THEN
[7646]	221	CALL cpl_finalize ! end coupling and mpp communications with OASIS
[4990]	222	ELSE
[7646]	223	IF( lk_mpp ) CALL mppstop ! end mpp communications
[4990]	224	ENDIF
[532]	225	#endif
[900]	226	!
[2496]	227	END SUBROUTINE nemo_gcm
[389]	228
	229
[2496]	230	SUBROUTINE nemo_init
[389]	231	!!----------------------------------------------------------------------
[2496]	232	!! * ROUTINE nemo_init *
[389]	233	!!
[2496]	234	!! ** Purpose : initialization of the NEMO GCM
[389]	235	!!----------------------------------------------------------------------
[7646]	236	INTEGER :: ji ! dummy loop indices
	237	INTEGER :: ios, ilocal_comm ! local integer
	238	CHARACTER(len=120), DIMENSION(30) :: cltxt, cltxt2, clnam
[4990]	239	!
[7646]	240	NAMELIST/namctl/ ln_ctl , nn_print, nn_ictls, nn_ictle, &
	241	& nn_isplt , nn_jsplt, nn_jctls, nn_jctle, &
	242	& nn_timing, nn_diacfl
	243	NAMELIST/namcfg/ ln_read_cfg, cn_domcfg, ln_write_cfg, cn_domcfg_out, ln_use_jattr
[3]	244	!!----------------------------------------------------------------------
[1593]	245	!
[7646]	246	cltxt = ''
	247	cltxt2 = ''
	248	clnam = ''
[5407]	249	cxios_context = 'nemo'
[2496]	250	!
[4147]	251	! ! Open reference namelist and configuration namelist files
	252	CALL ctl_opn( numnam_ref, 'namelist_ref', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
	253	CALL ctl_opn( numnam_cfg, 'namelist_cfg', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
[1593]	254	!
[7646]	255	REWIND( numnam_ref ) ! Namelist namctl in reference namelist : Control prints
[4147]	256	READ ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
[4289]	257	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in reference namelist', .TRUE. )
[7646]	258	!
	259	REWIND( numnam_cfg ) ! Namelist namctl in confguration namelist
[4147]	260	READ ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
[4289]	261	902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in configuration namelist', .TRUE. )
[1593]	262	!
[7646]	263	REWIND( numnam_ref ) ! Namelist namcfg in reference namelist : Control prints
[4147]	264	READ ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
[4289]	265	903 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in reference namelist', .TRUE. )
[4147]	266
	267	REWIND( numnam_cfg ) ! Namelist namcfg in confguration namelist : Control prints & Benchmark
	268	READ ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
[4289]	269	904 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in configuration namelist', .TRUE. )
[4309]	270
[7646]	271	! !--------------------------!
	272	! ! Set global domain size ! (control print return in cltxt2)
	273	! !--------------------------!
	274	IF( ln_read_cfg ) THEN ! Read sizes in domain configuration file
	275	CALL domain_cfg ( cltxt2, cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
	276	!
	277	ELSE ! user-defined namelist
	278	CALL usr_def_nam( cltxt2, clnam, cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
	279	ENDIF
	280	!
	281	jpk = jpkglo
	282	!
[4147]	283	#if defined key_agrif
[7646]	284	IF( .NOT. Agrif_Root() ) THEN ! AGRIF children: specific setting (cf. agrif_user.F90)
	285	jpiglo = nbcellsx + 2 + 2*nbghostcells
	286	jpjglo = nbcellsy + 2 + 2*nbghostcells
	287	jpi = ( jpiglo-2jpreci + (jpni-1+0) ) / jpni + 2jpreci
	288	jpj = ( jpjglo-2jprecj + (jpnj-1+0) ) / jpnj + 2jprecj
	289	nperio = 0
	290	jperio = 0
	291	ln_use_jattr = .false.
	292	ENDIF
[4147]	293	#endif
	294	!
[1593]	295	! !--------------------------------------------!
	296	! ! set communicator & select the local node !
[4624]	297	! ! NB: mynode also opens output.namelist.dyn !
	298	! ! on unit number numond on first proc !
[1593]	299	! !--------------------------------------------!
[1412]	300	#if defined key_iomput
[2200]	301	IF( Agrif_Root() ) THEN
[5407]	302	IF( lk_oasis ) THEN
[7646]	303	CALL cpl_init( "oceanx", ilocal_comm ) ! nemo local communicator given by oasis
	304	CALL xios_initialize( "not used" ,local_comm= ilocal_comm ) ! send nemo communicator to xios
[4990]	305	ELSE
[7646]	306	CALL xios_initialize( "for_xios_mpi_id",return_comm=ilocal_comm ) ! nemo local communicator given by xios
[4990]	307	ENDIF
[2200]	308	ENDIF
[5407]	309	! Nodes selection (control print return in cltxt)
	310	narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm )
[532]	311	#else
[5407]	312	IF( lk_oasis ) THEN
[4990]	313	IF( Agrif_Root() ) THEN
[7646]	314	CALL cpl_init( "oceanx", ilocal_comm ) ! nemo local communicator given by oasis
[4990]	315	ENDIF
[5407]	316	! Nodes selection (control print return in cltxt)
	317	narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm )
[4990]	318	ELSE
[7646]	319	ilocal_comm = 0 ! Nodes selection (control print return in cltxt)
[5407]	320	narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop )
[2236]	321	ENDIF
[532]	322	#endif
[7646]	323
[2715]	324	narea = narea + 1 ! mynode return the rank of proc (0 --> jpnij -1 )
[3]	325
[4624]	326	lwm = (narea == 1) ! control of output namelists
[2715]	327	lwp = (narea == 1) .OR. ln_ctl ! control of all listing output print
[1579]	328
[7646]	329	IF(lwm) THEN ! write merged namelists from earlier to output namelist
	330	! ! now that the file has been opened in call to mynode.
	331	! ! NB: nammpp has already been written in mynode (if lk_mpp_mpi)
[4624]	332	WRITE( numond, namctl )
	333	WRITE( numond, namcfg )
[7646]	334	IF( .NOT.ln_read_cfg ) THEN
	335	DO ji = 1, SIZE(clnam)
	336	IF( TRIM(clnam(ji)) /= '' ) WRITE(numond, * ) clnam(ji) ! namusr_def print
	337	END DO
	338	ENDIF
[4624]	339	ENDIF
	340
[3764]	341	! If dimensions of processor grid weren't specified in the namelist file
[2715]	342	! then we calculate them here now that we have our communicator size
[5836]	343	IF( jpni < 1 .OR. jpnj < 1 ) THEN
[2715]	344	#if defined key_mpp_mpi
[5836]	345	IF( Agrif_Root() ) CALL nemo_partition( mppsize )
[2715]	346	#else
	347	jpni = 1
	348	jpnj = 1
	349	jpnij = jpni*jpnj
	350	#endif
[5836]	351	ENDIF
[2715]	352
[7646]	353	IF( Agrif_Root() ) THEN ! AGRIF mother: specific setting from jpni and jpnj
[3294]	354	#if defined key_nemocice_decomp
[5836]	355	jpi = ( nx_global+2-2jpreci + (jpni-1) ) / jpni + 2jpreci ! first dim.
	356	jpj = ( ny_global+2-2jprecj + (jpnj-1) ) / jpnj + 2jprecj ! second dim.
[3294]	357	#else
[5836]	358	jpi = ( jpiglo -2jpreci + (jpni-1) ) / jpni + 2jpreci ! first dim.
	359	jpj = ( jpjglo -2jprecj + (jpnj-1) ) / jpnj + 2jprecj ! second dim.
[3294]	360	#endif
[7646]	361	ENDIF
	362
	363	!!gm ??? why here it has already been done in line 301 !
	364	jpk = jpkglo ! third dim
	365	!!gm end
	366
[5656]	367	#if defined key_agrif
[7646]	368	! simple trick to use same vertical grid as parent but different number of levels:
	369	! Save maximum number of levels in jpkglo, then define all vertical grids with this number.
	370	! Suppress once vertical online interpolation is ok
	371	IF(.NOT.Agrif_Root()) jpkglo = Agrif_Parent( jpkglo )
[5656]	372	#endif
[7646]	373	jpim1 = jpi-1 ! inner domain indices
	374	jpjm1 = jpj-1 ! " "
[7761]	375	jpkm1 = MAX( 1, jpk-1 ) ! " "
[7646]	376	jpij = jpi*jpj ! jpi x j
[2715]	377
[1593]	378	IF(lwp) THEN ! open listing units
	379	!
[1581]	380	CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea )
[1593]	381	!
[1579]	382	WRITE(numout,*)
[3294]	383	WRITE(numout,*) ' CNRS - NERC - Met OFFICE - MERCATOR-ocean - INGV - CMCC'
[1593]	384	WRITE(numout,*) ' NEMO team'
[1579]	385	WRITE(numout,*) ' Ocean General Circulation Model'
[7646]	386	WRITE(numout,*) ' NEMO version 3.7 (2016) '
[1579]	387	WRITE(numout,*)
	388	WRITE(numout,*)
[3764]	389	DO ji = 1, SIZE(cltxt)
[7646]	390	IF( TRIM(cltxt (ji)) /= '' ) WRITE(numout,*) cltxt(ji) ! control print of mynode
[1579]	391	END DO
[7646]	392	WRITE(numout,*)
	393	WRITE(numout,*)
	394	DO ji = 1, SIZE(cltxt2)
	395	IF( TRIM(cltxt2(ji)) /= '' ) WRITE(numout,*) cltxt2(ji) ! control print of domain size
	396	END DO
[1593]	397	!
[7646]	398	WRITE(numout,cform_aaa) ! Flag AAAAAAA
	399	!
[473]	400	ENDIF
[2715]	401
[7646]	402	! Now we know the dimensions of the grid and numout has been set: we can allocate arrays
[2715]	403	CALL nemo_alloc()
	404
[2496]	405	! !-------------------------------!
	406	! ! NEMO general initialization !
	407	! !-------------------------------!
[473]	408
[7646]	409	CALL nemo_ctl ! Control prints
[531]	410
[2082]	411	! ! Domain decomposition
[1593]	412	IF( jpni*jpnj == jpnij ) THEN ; CALL mpp_init ! standard cutting out
	413	ELSE ; CALL mpp_init2 ! eliminate land processors
[3]	414	ENDIF
[2382]	415	!
[3294]	416	IF( nn_timing == 1 ) CALL timing_init
	417	!
[2082]	418	! ! General initialization
[2027]	419	CALL phy_cst ! Physical constants
	420	CALL eos_init ! Equation of state
[4245]	421	IF( lk_c1d ) CALL c1d_init ! 1D column configuration
[6152]	422	CALL wad_init ! Wetting and drying options
[2027]	423	CALL dom_init ! Domain
[5836]	424	IF( ln_crs ) CALL crs_init ! coarsened grid: domain initialization
	425	IF( ln_nnogather ) CALL nemo_northcomms! northfold neighbour lists (must be done after the masks are defined)
[2027]	426	IF( ln_ctl ) CALL prt_ctl_init ! Print control
[6140]	427
	428	CALL diurnal_sst_bulk_init ! diurnal sst
	429	IF ( ln_diurnal ) CALL diurnal_sst_coolskin_init ! cool skin
	430
	431	! IF ln_diurnal_only, then we only want a subset of the initialisation routines
	432	IF ( ln_diurnal_only ) THEN
	433	CALL istate_init ! ocean initial state (Dynamics and tracers)
	434	CALL sbc_init ! Forcings : surface module
	435	CALL tra_qsr_init ! penetrative solar radiation qsr
	436	IF( ln_diaobs ) THEN ! Observation & model comparison
	437	CALL dia_obs_init ! Initialize observational data
	438	CALL dia_obs( nit000 - 1 ) ! Observation operator for restart
	439	ENDIF
	440	! ! Assimilation increments
	441	IF( lk_asminc ) CALL asm_inc_init ! Initialize assimilation increments
	442
	443	IF(lwp) WRITE(numout,*) 'Euler time step switch is ', neuler
	444	RETURN
	445	ENDIF
	446
[3651]	447	CALL istate_init ! ocean initial state (Dynamics and tracers)
	448
[5836]	449	! ! external forcing
	450	!!gm to be added : creation and call of sbc_apr_init
[7646]	451	CALL tide_init ! tidal harmonics
[5836]	452	CALL sbc_init ! surface boundary conditions (including sea-ice)
[7646]	453	CALL bdy_init ! Open boundaries initialisation
[5836]	454	! ! Ocean physics
[2082]	455	! ! Vertical physics
	456	CALL zdf_init ! namelist read
	457	CALL zdf_bfr_init ! bottom friction
	458	IF( lk_zdfric ) CALL zdf_ric_init ! Richardson number dependent Kz
[2329]	459	IF( lk_zdftke ) CALL zdf_tke_init ! TKE closure scheme
	460	IF( lk_zdfgls ) CALL zdf_gls_init ! GLS closure scheme
[2082]	461	IF( lk_zdftmx ) CALL zdf_tmx_init ! tidal vertical mixing
[5836]	462	IF( lk_zdfddm ) CALL zdf_ddm_init ! double diffusive mixing
	463
[2082]	464	! ! Lateral physics
	465	CALL ldf_tra_init ! Lateral ocean tracer physics
[5836]	466	CALL ldf_eiv_init ! eddy induced velocity param.
[2082]	467	CALL ldf_dyn_init ! Lateral ocean momentum physics
	468
[5836]	469	! ! Active tracers
	470	CALL tra_qsr_init ! penetrative solar radiation qsr
	471	CALL tra_bbc_init ! bottom heat flux
	472	IF( lk_trabbl ) CALL tra_bbl_init ! advective (and/or diffusive) bottom boundary layer scheme
	473	CALL tra_dmp_init ! internal tracer damping
	474	CALL tra_adv_init ! horizontal & vertical advection
	475	CALL tra_ldf_init ! lateral mixing
	476	CALL tra_zdf_init ! vertical mixing and after tracer fields
[2027]	477
[5836]	478	! ! Dynamics
	479	IF( lk_c1d ) CALL dyn_dmp_init ! internal momentum damping
	480	CALL dyn_adv_init ! advection (vector or flux form)
	481	CALL dyn_vor_init ! vorticity term including Coriolis
	482	CALL dyn_ldf_init ! lateral mixing
	483	CALL dyn_hpg_init ! horizontal gradient of Hydrostatic pressure
	484	CALL dyn_zdf_init ! vertical diffusion
	485	CALL dyn_spg_init ! surface pressure gradient
[3764]	486
[5836]	487	#if defined key_top
	488	! ! Passive tracers
	489	CALL trc_init
	490	#endif
	491	IF( l_ldfslp ) CALL ldf_slp_init ! slope of lateral mixing
	492
	493	! ! Icebergs
[3609]	494	CALL icb_init( rdt, nit000) ! initialise icebergs instance
[5836]	495
	496	! ! Misc. options
[5329]	497	CALL sto_par_init ! Stochastic parametrization
	498	IF( ln_sto_eos ) CALL sto_pts_init ! RRandom T/S fluctuations
[4147]	499
[5836]	500	! ! Diagnostics
[3294]	501	IF( lk_floats ) CALL flo_init ! drifting Floats
[6140]	502	CALL dia_cfl_init ! Initialise CFL diagnostics
[2027]	503	CALL dia_ptr_init ! Poleward TRansports initialization
[3294]	504	IF( lk_diadct ) CALL dia_dct_init ! Sections tranports
[2148]	505	CALL dia_hsb_init ! heat content, salt content and volume budgets
[4990]	506	CALL trd_init ! Mixed-layer/Vorticity/Integral constraints trends
[2382]	507	CALL dia_obs_init ! Initialize observational data
[6140]	508	IF( ln_diaobs ) CALL dia_obs( nit000 - 1 ) ! Observation operator for restart
	509
	510	! ! Assimilation increments
[2392]	511	IF( lk_asminc ) CALL asm_inc_init ! Initialize assimilation increments
[2382]	512	IF(lwp) WRITE(numout,*) 'Euler time step switch is ', neuler
[6140]	513	CALL dia_tmb_init ! TMB outputs
	514	CALL dia_25h_init ! 25h mean outputs
[1593]	515	!
[2496]	516	END SUBROUTINE nemo_init
[467]	517
	518
[2496]	519	SUBROUTINE nemo_ctl
[467]	520	!!----------------------------------------------------------------------
[2496]	521	!! * ROUTINE nemo_ctl *
[467]	522	!!
[3764]	523	!! ** Purpose : control print setting
[467]	524	!!
[2442]	525	!! ** Method : - print namctl information and check some consistencies
[467]	526	!!----------------------------------------------------------------------
[2442]	527	!
[2496]	528	IF(lwp) THEN ! control print
[531]	529	WRITE(numout,*)
[7646]	530	WRITE(numout,*) 'nemo_ctl: Control prints'
[531]	531	WRITE(numout,*) '~~~~~~~ '
[1593]	532	WRITE(numout,*) ' Namelist namctl'
[1601]	533	WRITE(numout,*) ' run control (for debugging) ln_ctl = ', ln_ctl
	534	WRITE(numout,*) ' level of print nn_print = ', nn_print
	535	WRITE(numout,*) ' Start i indice for SUM control nn_ictls = ', nn_ictls
	536	WRITE(numout,*) ' End i indice for SUM control nn_ictle = ', nn_ictle
	537	WRITE(numout,*) ' Start j indice for SUM control nn_jctls = ', nn_jctls
	538	WRITE(numout,*) ' End j indice for SUM control nn_jctle = ', nn_jctle
	539	WRITE(numout,*) ' number of proc. following i nn_isplt = ', nn_isplt
	540	WRITE(numout,*) ' number of proc. following j nn_jsplt = ', nn_jsplt
[3610]	541	WRITE(numout,*) ' timing activated (0/1) nn_timing = ', nn_timing
[531]	542	ENDIF
[2442]	543	!
[1601]	544	nprint = nn_print ! convert DOCTOR namelist names into OLD names
	545	nictls = nn_ictls
	546	nictle = nn_ictle
	547	njctls = nn_jctls
	548	njctle = nn_jctle
	549	isplt = nn_isplt
	550	jsplt = nn_jsplt
[4147]	551
	552	IF(lwp) THEN ! control print
	553	WRITE(numout,*)
[7646]	554	WRITE(numout,*) 'namcfg : configuration initialization through namelist read'
	555	WRITE(numout,*) '~~~~~~ '
[4147]	556	WRITE(numout,*) ' Namelist namcfg'
[7646]	557	WRITE(numout,*) ' read domain configuration file ln_read_cfg = ', ln_read_cfg
	558	WRITE(numout,*) ' filename to be read cn_domcfg = ', TRIM(cn_domcfg)
	559	WRITE(numout,*) ' write configuration definition file ln_write_cfg = ', ln_write_cfg
	560	WRITE(numout,*) ' filename to be written cn_domcfg_out = ', TRIM(cn_domcfg_out)
	561	WRITE(numout,*) ' use file attribute if exists as i/p j-start ln_use_jattr = ', ln_use_jattr
[4147]	562	ENDIF
[2442]	563	! ! Parameter control
[1593]	564	!
	565	IF( ln_ctl ) THEN ! sub-domain area indices for the control prints
[3294]	566	IF( lk_mpp .AND. jpnij > 1 ) THEN
[2496]	567	isplt = jpni ; jsplt = jpnj ; ijsplt = jpni*jpnj ! the domain is forced to the real split domain
[531]	568	ELSE
	569	IF( isplt == 1 .AND. jsplt == 1 ) THEN
[1593]	570	CALL ctl_warn( ' - isplt & jsplt are equal to 1', &
	571	& ' - the print control will be done over the whole domain' )
[531]	572	ENDIF
[1593]	573	ijsplt = isplt * jsplt ! total number of processors ijsplt
[531]	574	ENDIF
	575	IF(lwp) WRITE(numout,*)' - The total number of processors over which the'
	576	IF(lwp) WRITE(numout,*)' print control will be done is ijsplt : ', ijsplt
[1593]	577	!
	578	! ! indices used for the SUM control
	579	IF( nictls+nictle+njctls+njctle == 0 ) THEN ! print control done over the default area
[3764]	580	lsp_area = .FALSE.
[1593]	581	ELSE ! print control done over a specific area
[531]	582	lsp_area = .TRUE.
	583	IF( nictls < 1 .OR. nictls > jpiglo ) THEN
	584	CALL ctl_warn( ' - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
	585	nictls = 1
	586	ENDIF
	587	IF( nictle < 1 .OR. nictle > jpiglo ) THEN
	588	CALL ctl_warn( ' - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
	589	nictle = jpiglo
	590	ENDIF
	591	IF( njctls < 1 .OR. njctls > jpjglo ) THEN
	592	CALL ctl_warn( ' - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
	593	njctls = 1
	594	ENDIF
	595	IF( njctle < 1 .OR. njctle > jpjglo ) THEN
	596	CALL ctl_warn( ' - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
	597	njctle = jpjglo
	598	ENDIF
[1593]	599	ENDIF
	600	ENDIF
[2442]	601	!
[3764]	602	IF( 1_wp /= SIGN(1._wp,-0._wp) ) CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows ', &
	603	& 'f2003 standard. ' , &
	604	& 'Compile with key_nosignedzero enabled' )
	605	!
[2496]	606	END SUBROUTINE nemo_ctl
[467]	607
	608
[2496]	609	SUBROUTINE nemo_closefile
[467]	610	!!----------------------------------------------------------------------
[2496]	611	!! * ROUTINE nemo_closefile *
[467]	612	!!
	613	!! ** Purpose : Close the files
	614	!!----------------------------------------------------------------------
[1593]	615	!
	616	IF( lk_mpp ) CALL mppsync
	617	!
[1685]	618	CALL iom_close ! close all input/output files managed by iom_*
[1593]	619	!
[4147]	620	IF( numstp /= -1 ) CLOSE( numstp ) ! time-step file
[8226]	621	IF( numrun /= -1 ) CLOSE( numrun ) ! run statistics file
[4147]	622	IF( numnam_ref /= -1 ) CLOSE( numnam_ref ) ! oce reference namelist
	623	IF( numnam_cfg /= -1 ) CLOSE( numnam_cfg ) ! oce configuration namelist
[4624]	624	IF( lwm.AND.numond /= -1 ) CLOSE( numond ) ! oce output namelist
[4147]	625	IF( numnam_ice_ref /= -1 ) CLOSE( numnam_ice_ref ) ! ice reference namelist
	626	IF( numnam_ice_cfg /= -1 ) CLOSE( numnam_ice_cfg ) ! ice configuration namelist
[4624]	627	IF( lwm.AND.numoni /= -1 ) CLOSE( numoni ) ! ice output namelist
[4147]	628	IF( numevo_ice /= -1 ) CLOSE( numevo_ice ) ! ice variables (temp. evolution)
	629	IF( numout /= 6 ) CLOSE( numout ) ! standard model output file
	630	IF( numdct_vol /= -1 ) CLOSE( numdct_vol ) ! volume transports
	631	IF( numdct_heat /= -1 ) CLOSE( numdct_heat ) ! heat transports
	632	IF( numdct_salt /= -1 ) CLOSE( numdct_salt ) ! salt transports
[1593]	633	!
[2442]	634	numout = 6 ! redefine numout in case it is used after this point...
	635	!
[2496]	636	END SUBROUTINE nemo_closefile
[467]	637
[2715]	638
	639	SUBROUTINE nemo_alloc
	640	!!----------------------------------------------------------------------
	641	!! * ROUTINE nemo_alloc *
	642	!!
	643	!! ** Purpose : Allocate all the dynamic arrays of the OPA modules
	644	!!
	645	!! ** Method :
	646	!!----------------------------------------------------------------------
	647	USE diawri , ONLY: dia_wri_alloc
	648	USE dom_oce , ONLY: dom_oce_alloc
	649	USE trc_oce , ONLY: trc_oce_alloc
[3680]	650	#if defined key_diadct
	651	USE diadct , ONLY: diadct_alloc
	652	#endif
[4354]	653	USE bdy_oce , ONLY: bdy_oce_alloc
[2715]	654	!
	655	INTEGER :: ierr
	656	!!----------------------------------------------------------------------
	657	!
[7646]	658	ierr = oce_alloc () ! ocean
[2715]	659	ierr = ierr + dia_wri_alloc ()
	660	ierr = ierr + dom_oce_alloc () ! ocean domain
	661	ierr = ierr + zdf_oce_alloc () ! ocean vertical physics
	662	!
	663	ierr = ierr + trc_oce_alloc () ! shared TRC / TRA arrays
	664	!
[3680]	665	#if defined key_diadct
	666	ierr = ierr + diadct_alloc () !
	667	#endif
[4354]	668	ierr = ierr + bdy_oce_alloc () ! bdy masks (incl. initialization)
[3680]	669	!
[2715]	670	IF( lk_mpp ) CALL mpp_sum( ierr )
	671	IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'nemo_alloc : unable to allocate standard ocean arrays' )
	672	!
	673	END SUBROUTINE nemo_alloc
	674
	675
	676	SUBROUTINE nemo_partition( num_pes )
	677	!!----------------------------------------------------------------------
	678	!! * ROUTINE nemo_partition *
	679	!!
[3764]	680	!! ** Purpose :
[2715]	681	!!
	682	!! ** Method :
	683	!!----------------------------------------------------------------------
[4990]	684	INTEGER, INTENT(in) :: num_pes ! The number of MPI processes we have
[2715]	685	!
	686	INTEGER, PARAMETER :: nfactmax = 20
	687	INTEGER :: nfact ! The no. of factors returned
	688	INTEGER :: ierr ! Error flag
	689	INTEGER :: ji
	690	INTEGER :: idiff, mindiff, imin ! For choosing pair of factors that are closest in value
	691	INTEGER, DIMENSION(nfactmax) :: ifact ! Array of factors
	692	!!----------------------------------------------------------------------
[4990]	693	!
[2715]	694	ierr = 0
[4990]	695	!
[2715]	696	CALL factorise( ifact, nfactmax, nfact, num_pes, ierr )
[4990]	697	!
[2715]	698	IF( nfact <= 1 ) THEN
	699	WRITE (numout, *) 'WARNING: factorisation of number of PEs failed'
	700	WRITE (numout, *) ' : using grid of ',num_pes,' x 1'
	701	jpnj = 1
	702	jpni = num_pes
	703	ELSE
	704	! Search through factors for the pair that are closest in value
	705	mindiff = 1000000
	706	imin = 1
	707	DO ji = 1, nfact-1, 2
	708	idiff = ABS( ifact(ji) - ifact(ji+1) )
	709	IF( idiff < mindiff ) THEN
	710	mindiff = idiff
	711	imin = ji
	712	ENDIF
	713	END DO
	714	jpnj = ifact(imin)
	715	jpni = ifact(imin + 1)
	716	ENDIF
	717	!
	718	jpnij = jpni*jpnj
	719	!
	720	END SUBROUTINE nemo_partition
	721
	722
	723	SUBROUTINE factorise( kfax, kmaxfax, knfax, kn, kerr )
	724	!!----------------------------------------------------------------------
	725	!! * ROUTINE factorise *
	726	!!
	727	!! ** Purpose : return the prime factors of n.
[3764]	728	!! knfax factors are returned in array kfax which is of
[2715]	729	!! maximum dimension kmaxfax.
	730	!! ** Method :
	731	!!----------------------------------------------------------------------
	732	INTEGER , INTENT(in ) :: kn, kmaxfax
	733	INTEGER , INTENT( out) :: kerr, knfax
	734	INTEGER, DIMENSION(kmaxfax), INTENT( out) :: kfax
	735	!
	736	INTEGER :: ifac, jl, inu
	737	INTEGER, PARAMETER :: ntest = 14
[5836]	738	INTEGER, DIMENSION(ntest) :: ilfax
[5656]	739	!!----------------------------------------------------------------------
[5836]	740	!
[2715]	741	! lfax contains the set of allowed factors.
[5656]	742	ilfax(:) = (/(2**jl,jl=ntest,1,-1)/)
[5836]	743	!
[2715]	744	! Clear the error flag and initialise output vars
[5836]	745	kerr = 0
	746	kfax = 1
[2715]	747	knfax = 0
[5836]	748	!
[2715]	749	! Find the factors of n.
	750	IF( kn == 1 ) GOTO 20
	751
	752	! nu holds the unfactorised part of the number.
	753	! knfax holds the number of factors found.
	754	! l points to the allowed factor list.
	755	! ifac holds the current factor.
[5836]	756	!
[2715]	757	inu = kn
	758	knfax = 0
[5836]	759	!
[2715]	760	DO jl = ntest, 1, -1
	761	!
	762	ifac = ilfax(jl)
	763	IF( ifac > inu ) CYCLE
	764
	765	! Test whether the factor will divide.
	766
	767	IF( MOD(inu,ifac) == 0 ) THEN
	768	!
	769	knfax = knfax + 1 ! Add the factor to the list
	770	IF( knfax > kmaxfax ) THEN
	771	kerr = 6
	772	write (,) 'FACTOR: insufficient space in factor array ', knfax
	773	return
	774	ENDIF
	775	kfax(knfax) = ifac
	776	! Store the other factor that goes with this one
	777	knfax = knfax + 1
	778	kfax(knfax) = inu / ifac
	779	!WRITE (,) 'ARPDBG, factors ',knfax-1,' & ',knfax,' are ', kfax(knfax-1),' and ',kfax(knfax)
	780	ENDIF
	781	!
	782	END DO
[5836]	783	!
[2715]	784	20 CONTINUE ! Label 20 is the exit point from the factor search loop.
	785	!
	786	END SUBROUTINE factorise
	787
[3294]	788	#if defined key_mpp_mpi
[4990]	789
[3294]	790	SUBROUTINE nemo_northcomms
[5836]	791	!!----------------------------------------------------------------------
[3294]	792	!! * ROUTINE nemo_northcomms *
[5836]	793	!! ** Purpose : Setup for north fold exchanges with explicit
	794	!! point-to-point messaging
[3764]	795	!!
[5836]	796	!! ** Method : Initialization of the northern neighbours lists.
[3294]	797	!!----------------------------------------------------------------------
[3764]	798	!! 1.0 ! 2011-10 (A. C. Coward, NOCS & J. Donners, PRACE)
[4230]	799	!! 2.0 ! 2013-06 Setup avoiding MPI communication (I. Epicoco, S. Mocavero, CMCC)
[3294]	800	!!----------------------------------------------------------------------
[4230]	801	INTEGER :: sxM, dxM, sxT, dxT, jn
	802	INTEGER :: njmppmax
[5836]	803	!!----------------------------------------------------------------------
	804	!
[4230]	805	njmppmax = MAXVAL( njmppt )
[5836]	806	!
[4230]	807	!initializes the north-fold communication variables
	808	isendto(:) = 0
[5836]	809	nsndto = 0
	810	!
[4230]	811	!if I am a process in the north
	812	IF ( njmpp == njmppmax ) THEN
	813	!sxM is the first point (in the global domain) needed to compute the
	814	!north-fold for the current process
	815	sxM = jpiglo - nimppt(narea) - nlcit(narea) + 1
	816	!dxM is the last point (in the global domain) needed to compute the
	817	!north-fold for the current process
	818	dxM = jpiglo - nimppt(narea) + 2
[3294]	819
[4230]	820	!loop over the other north-fold processes to find the processes
	821	!managing the points belonging to the sxT-dxT range
[4671]	822
	823	DO jn = 1, jpni
[4230]	824	!sxT is the first point (in the global domain) of the jn
	825	!process
[4671]	826	sxT = nfiimpp(jn, jpnj)
[4230]	827	!dxT is the last point (in the global domain) of the jn
	828	!process
[4671]	829	dxT = nfiimpp(jn, jpnj) + nfilcit(jn, jpnj) - 1
[4230]	830	IF ((sxM .gt. sxT) .AND. (sxM .lt. dxT)) THEN
	831	nsndto = nsndto + 1
[7646]	832	isendto(nsndto) = jn
[4645]	833	ELSEIF ((sxM .le. sxT) .AND. (dxM .ge. dxT)) THEN
[4230]	834	nsndto = nsndto + 1
[7646]	835	isendto(nsndto) = jn
[4230]	836	ELSEIF ((dxM .lt. dxT) .AND. (sxT .lt. dxM)) THEN
	837	nsndto = nsndto + 1
[7646]	838	isendto(nsndto) = jn
	839	ENDIF
[4230]	840	END DO
[4671]	841	nfsloop = 1
	842	nfeloop = nlci
	843	DO jn = 2,jpni-1
	844	IF(nfipproc(jn,jpnj) .eq. (narea - 1)) THEN
	845	IF (nfipproc(jn - 1 ,jpnj) .eq. -1) THEN
	846	nfsloop = nldi
	847	ENDIF
	848	IF (nfipproc(jn + 1,jpnj) .eq. -1) THEN
	849	nfeloop = nlei
	850	ENDIF
	851	ENDIF
	852	END DO
	853
[3294]	854	ENDIF
[4230]	855	l_north_nogather = .TRUE.
[3294]	856	END SUBROUTINE nemo_northcomms
[5836]	857
[3294]	858	#else
	859	SUBROUTINE nemo_northcomms ! Dummy routine
	860	WRITE(,) 'nemo_northcomms: You should not have seen this print! error?'
	861	END SUBROUTINE nemo_northcomms
	862	#endif
[4990]	863
[3]	864	!!======================================================================
[2496]	865	END MODULE nemogcm
[4354]	866

Note: See TracBrowser for help on using the repository browser.

New URL for NEMO forge! http://forge.nemo-ocean.eu

Context Navigation

source: branches/2017/dev_r8183_ICEMODEL/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 8517

Download in other formats: