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

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.

nemogcm.F90 in branches/2016/dev_v3_6_STABLE_OMP/NEMOGCM/NEMO/OPA_SRC – NEMO

Context Navigation

source: branches/2016/dev_v3_6_STABLE_OMP/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 6712

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

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

Download in other formats: