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 trunk/NEMOGCM/NEMO/OPA_SRC – NEMO

Context Navigation

source: trunk/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 3497

Last change on this file since 3497 was 3352, checked in by rblod, 12 years ago
Correct a bug in timing + some cleaning, see ticket #925
Property svn:keywords set to `Id`
File size: 36.0 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)
	8	!! 7.1 ! 1993-03 (M. Imbard, C. Levy, G. Madec, O. Marti, M. Guyon, A. Lazar,
[2104]	9	!! P. Delecluse, C. Perigaud, G. Caniaux, B. Colot, C. Maes) release 7.1
[1593]	10	!! - ! 1992-06 (L.Terray) coupling implementation
	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)
	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
	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
[2236]	27	!! 3.3 ! 2010-05 (K. Mogensen, A. Weaver, M. Martin, D. Lea) Assimilation interface
	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
[1593]	31	!!----------------------------------------------------------------------
[3]	32
	33	!!----------------------------------------------------------------------
[2496]	34	!! nemo_gcm : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice
	35	!! nemo_init : initialization of the NEMO system
	36	!! nemo_ctl : initialisation of the contol print
	37	!! nemo_closefile : close remaining open files
[2715]	38	!! nemo_alloc : dynamical allocation
	39	!! nemo_partition : calculate MPP domain decomposition
	40	!! factorise : calculate the factors of the no. of MPI processes
[3]	41	!!----------------------------------------------------------------------
[2382]	42	USE step_oce ! module used in the ocean time stepping module
[888]	43	USE sbc_oce ! surface boundary condition: ocean
[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)
	48	USE obcini ! open boundary cond. initialization (obc_ini routine)
[3294]	49	USE bdyini ! open boundary cond. initialization (bdy_init routine)
	50	USE bdydta ! open boundary cond. initialization (bdy_dta_init routine)
	51	USE bdytides ! open boundary cond. initialization (tide_init routine)
[3]	52	USE istate ! initial state setting (istate_init routine)
	53	USE ldfdyn ! lateral viscosity setting (ldfdyn_init routine)
	54	USE ldftra ! lateral diffusivity setting (ldftra_init routine)
[2392]	55	USE zdfini ! vertical physics setting (zdf_init routine)
[3]	56	USE phycst ! physical constant (par_cst routine)
[2236]	57	USE trdmod ! momentum/tracers trends (trd_mod_init routine)
	58	USE asmtrj ! writing out state trajectory
	59	USE diaptr ! poleward transports (dia_ptr_init routine)
[3294]	60	USE diadct ! sections transports (dia_dct_init routine)
[2236]	61	USE diaobs ! Observation diagnostics (dia_obs_init routine)
[2496]	62	USE step ! NEMO time-stepping (stp routine)
[532]	63	#if defined key_oasis3
[1359]	64	USE cpl_oasis3 ! OASIS3 coupling
[599]	65	#elif defined key_oasis4
[1359]	66	USE cpl_oasis4 ! OASIS4 coupling (not working)
[532]	67	#endif
[900]	68	USE c1d ! 1D configuration
	69	USE step_c1d ! Time stepping loop for the 1D configuration
[1594]	70	#if defined key_top
[1593]	71	USE trcini ! passive tracer initialisation
[1594]	72	#endif
[1593]	73	USE lib_mpp ! distributed memory computing
[1412]	74	#if defined key_iomput
	75	USE mod_ioclient
[1359]	76	#endif
[268]	77
[2715]	78	IMPLICIT NONE
[3]	79	PRIVATE
	80
[2496]	81	PUBLIC nemo_gcm ! called by model.F90
	82	PUBLIC nemo_init ! needed by AGRIF
[467]	83
[2498]	84	CHARACTER(lc) :: cform_aaa="( /, 'AAAAAAAA', / ) " ! flag for output listing
[1593]	85
[3]	86	!!----------------------------------------------------------------------
[2715]	87	!! NEMO/OPA 4.0 , NEMO Consortium (2011)
[2392]	88	!! $Id$
[2329]	89	!! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
[3]	90	!!----------------------------------------------------------------------
	91	CONTAINS
	92
[2496]	93	SUBROUTINE nemo_gcm
[3]	94	!!----------------------------------------------------------------------
[2496]	95	!! * ROUTINE nemo_gcm *
[3]	96	!!
[2496]	97	!! ** Purpose : NEMO solves the primitive equations on an orthogonal
[1593]	98	!! curvilinear mesh on the sphere.
[3]	99	!!
	100	!! ** Method : - model general initialization
	101	!! - launch the time-stepping (stp routine)
[1593]	102	!! - finalize the run by closing files and communications
[3]	103	!!
[2715]	104	!! References : Madec, Delecluse, Imbard, and Levy, 1997: internal report, IPSL.
[1593]	105	!! Madec, 2008, internal report, IPSL.
[3]	106	!!----------------------------------------------------------------------
	107	INTEGER :: istp ! time step index
[389]	108	!!----------------------------------------------------------------------
[2382]	109	!
[392]	110	#if defined key_agrif
[1593]	111	CALL Agrif_Init_Grids() ! AGRIF: set the meshes
[389]	112	#endif
	113
[1593]	114	! !-----------------------!
[2496]	115	CALL nemo_init !== Initialisations ==!
[1593]	116	! !-----------------------!
[2715]	117	#if defined key_agrif
	118	CALL Agrif_Declare_Var ! AGRIF: set the meshes
	119	# if defined key_top
	120	CALL Agrif_Declare_Var_Top ! AGRIF: set the meshes
	121	# endif
	122	#endif
[682]	123	! check that all process are still there... If some process have an error,
	124	! they will never enter in step and other processes will wait until the end of the cpu time!
[900]	125	IF( lk_mpp ) CALL mpp_max( nstop )
[682]	126
[1593]	127	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
	128
	129	! !-----------------------!
	130	! !== time stepping ==!
	131	! !-----------------------!
[900]	132	istp = nit000
[2236]	133	#if defined key_c1d
[389]	134	DO WHILE ( istp <= nitend .AND. nstop == 0 )
[900]	135	CALL stp_c1d( istp )
[389]	136	istp = istp + 1
	137	END DO
[2236]	138	#else
	139	IF( lk_asminc ) THEN
	140	IF( ln_bkgwri ) CALL asm_bkg_wri( nit000 - 1 ) ! Output background fields
	141	IF( ln_trjwri ) CALL asm_trj_wri( nit000 - 1 ) ! Output trajectory fields
	142	IF( ln_asmdin ) THEN ! Direct initialization
	143	IF( ln_trainc ) CALL tra_asm_inc( nit000 - 1 ) ! Tracers
	144	IF( ln_dyninc ) THEN
	145	CALL dyn_asm_inc( nit000 - 1 ) ! Dynamics
	146	IF ( ln_asmdin ) CALL ssh_wzv ( nit000 - 1 ) ! update vertical velocity
	147	ENDIF
	148	IF( ln_sshinc ) CALL ssh_asm_inc( nit000 - 1 ) ! SSH
	149	ENDIF
	150	ENDIF
	151
[389]	152	DO WHILE ( istp <= nitend .AND. nstop == 0 )
[392]	153	#if defined key_agrif
[1593]	154	CALL Agrif_Step( stp ) ! AGRIF: time stepping
[389]	155	#else
[1593]	156	CALL stp( istp ) ! standard time stepping
[389]	157	#endif
	158	istp = istp + 1
[900]	159	IF( lk_mpp ) CALL mpp_max( nstop )
[389]	160	END DO
[2236]	161	#endif
	162
	163	IF( lk_diaobs ) CALL dia_obs_wri
[1593]	164
	165	! !------------------------!
	166	! !== finalize the run ==!
	167	! !------------------------!
	168	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
	169	!
	170	IF( nstop /= 0 .AND. lwp ) THEN ! error print
[682]	171	WRITE(numout,cform_err)
	172	WRITE(numout,*) nstop, ' error have been found'
[389]	173	ENDIF
[1593]	174	!
[3294]	175	#if defined key_agrif
	176	CALL Agrif_ParentGrid_To_ChildGrid()
	177	IF( lk_diaobs ) CALL dia_obs_wri
	178	IF( nn_timing == 1 ) CALL timing_finalize
	179	CALL Agrif_ChildGrid_To_ParentGrid()
	180	#endif
	181	IF( nn_timing == 1 ) CALL timing_finalize
	182	!
[2496]	183	CALL nemo_closefile
[532]	184	#if defined key_oasis3 \|\| defined key_oasis4
[1976]	185	CALL cpl_prism_finalize ! end coupling and mpp communications with OASIS
[532]	186	#else
[1593]	187	IF( lk_mpp ) CALL mppstop ! end mpp communications
[532]	188	#endif
[900]	189	!
[2496]	190	END SUBROUTINE nemo_gcm
[389]	191
	192
[2496]	193	SUBROUTINE nemo_init
[389]	194	!!----------------------------------------------------------------------
[2496]	195	!! * ROUTINE nemo_init *
[389]	196	!!
[2496]	197	!! ** Purpose : initialization of the NEMO GCM
[389]	198	!!----------------------------------------------------------------------
[2715]	199	INTEGER :: ji ! dummy loop indices
	200	INTEGER :: ilocal_comm ! local integer
	201	CHARACTER(len=80), DIMENSION(16) :: cltxt
[1593]	202	!!
[1601]	203	NAMELIST/namctl/ ln_ctl , nn_print, nn_ictls, nn_ictle, &
[3294]	204	& nn_isplt, nn_jsplt, nn_jctls, nn_jctle, &
	205	& nn_bench, nn_timing
[3]	206	!!----------------------------------------------------------------------
[1593]	207	!
[2496]	208	cltxt = ''
	209	!
[1593]	210	! ! open Namelist file
[1581]	211	CALL ctl_opn( numnam, 'namelist', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
[1593]	212	!
	213	READ( numnam, namctl ) ! Namelist namctl : Control prints & Benchmark
	214	!
	215	! !--------------------------------------------!
	216	! ! set communicator & select the local node !
	217	! !--------------------------------------------!
[1412]	218	#if defined key_iomput
[2200]	219	IF( Agrif_Root() ) THEN
[1412]	220	# if defined key_oasis3 \|\| defined key_oasis4
[2715]	221	CALL cpl_prism_init( ilocal_comm ) ! nemo local communicator given by oasis
[1412]	222	# endif
[2715]	223	CALL init_ioclient( ilocal_comm ) ! exchange io_server nemo local communicator with the io_server
[2200]	224	ENDIF
[2715]	225	narea = mynode( cltxt, numnam, nstop, ilocal_comm ) ! Nodes selection
[532]	226	#else
[1412]	227	# if defined key_oasis3 \|\| defined key_oasis4
[2236]	228	IF( Agrif_Root() ) THEN
[2715]	229	CALL cpl_prism_init( ilocal_comm ) ! nemo local communicator given by oasis
[2236]	230	ENDIF
[2715]	231	narea = mynode( cltxt, numnam, nstop, ilocal_comm ) ! Nodes selection (control print return in cltxt)
[1412]	232	# else
[2082]	233	ilocal_comm = 0
[2715]	234	narea = mynode( cltxt, numnam, nstop ) ! Nodes selection (control print return in cltxt)
[1412]	235	# endif
[532]	236	#endif
[2715]	237	narea = narea + 1 ! mynode return the rank of proc (0 --> jpnij -1 )
[3]	238
[2715]	239	lwp = (narea == 1) .OR. ln_ctl ! control of all listing output print
[1579]	240
[2715]	241	! If dimensions of processor grid weren't specified in the namelist file
	242	! then we calculate them here now that we have our communicator size
	243	IF( (jpni < 1) .OR. (jpnj < 1) )THEN
	244	#if defined key_mpp_mpi
	245	IF( Agrif_Root() ) CALL nemo_partition(mppsize)
	246	#else
	247	jpni = 1
	248	jpnj = 1
	249	jpnij = jpni*jpnj
	250	#endif
	251	END IF
	252
	253	! Calculate domain dimensions given calculated jpni and jpnj
	254	! This used to be done in par_oce.F90 when they were parameters rather
	255	! than variables
	256	IF( Agrif_Root() ) THEN
	257	jpi = ( jpiglo-2jpreci + (jpni-1) ) / jpni + 2jpreci ! first dim.
[3294]	258	#if defined key_nemocice_decomp
	259	jpj = ( jpjglo+1-2jprecj + (jpnj-1) ) / jpnj + 2jprecj ! second dim.
	260	#else
[2715]	261	jpj = ( jpjglo-2jprecj + (jpnj-1) ) / jpnj + 2jprecj ! second dim.
[3294]	262	#endif
[2715]	263	jpk = jpkdta ! third dim
	264	jpim1 = jpi-1 ! inner domain indices
	265	jpjm1 = jpj-1 ! " "
	266	jpkm1 = jpk-1 ! " "
	267	jpij = jpi*jpj ! jpi x j
	268	ENDIF
	269
[1593]	270	IF(lwp) THEN ! open listing units
	271	!
[1581]	272	CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea )
[1593]	273	!
[1579]	274	WRITE(numout,*)
[3294]	275	WRITE(numout,*) ' CNRS - NERC - Met OFFICE - MERCATOR-ocean - INGV - CMCC'
[1593]	276	WRITE(numout,*) ' NEMO team'
[1579]	277	WRITE(numout,*) ' Ocean General Circulation Model'
[3294]	278	WRITE(numout,*) ' version 3.4 (2011) '
[1579]	279	WRITE(numout,*)
	280	WRITE(numout,*)
[1593]	281	DO ji = 1, SIZE(cltxt)
	282	IF( TRIM(cltxt(ji)) /= '' ) WRITE(numout,*) cltxt(ji) ! control print of mynode
[1579]	283	END DO
[1593]	284	WRITE(numout,cform_aaa) ! Flag AAAAAAA
	285	!
[473]	286	ENDIF
[2715]	287
	288	! Now we know the dimensions of the grid and numout has been set we can
	289	! allocate arrays
	290	CALL nemo_alloc()
	291
[2496]	292	! !-------------------------------!
	293	! ! NEMO general initialization !
	294	! !-------------------------------!
[473]	295
[2496]	296	CALL nemo_ctl ! Control prints & Benchmark
[531]	297
[2082]	298	! ! Domain decomposition
[1593]	299	IF( jpni*jpnj == jpnij ) THEN ; CALL mpp_init ! standard cutting out
	300	ELSE ; CALL mpp_init2 ! eliminate land processors
[3]	301	ENDIF
[2382]	302	!
[3294]	303	IF( nn_timing == 1 ) CALL timing_init
	304	!
[2082]	305	! ! General initialization
[2027]	306	CALL phy_cst ! Physical constants
	307	CALL eos_init ! Equation of state
	308	CALL dom_cfg ! Domain configuration
	309	CALL dom_init ! Domain
[413]	310
[3294]	311	IF( ln_nnogather ) CALL nemo_northcomms ! Initialise the northfold neighbour lists (must be done after the masks are defined)
	312
[2027]	313	IF( ln_ctl ) CALL prt_ctl_init ! Print control
	314
	315	IF( lk_obc ) CALL obc_init ! Open boundaries
[3294]	316	IF( lk_bdy ) CALL bdy_init ! Open boundaries initialisation
	317	IF( lk_bdy ) CALL bdy_dta_init ! Open boundaries initialisation of external data arrays
	318	IF( lk_bdy ) CALL tide_init ! Open boundaries initialisation of tidal harmonic forcing
[2027]	319
[3294]	320	CALL flush(numout)
	321	CALL dyn_nept_init ! simplified form of Neptune effect
	322	CALL flush(numout)
	323
[2027]	324	CALL istate_init ! ocean initial state (Dynamics and tracers)
	325
[3]	326	! ! Ocean physics
[2104]	327	CALL sbc_init ! Forcings : surface module
[2082]	328	! ! Vertical physics
	329	CALL zdf_init ! namelist read
	330	CALL zdf_bfr_init ! bottom friction
	331	IF( lk_zdfric ) CALL zdf_ric_init ! Richardson number dependent Kz
[2329]	332	IF( lk_zdftke ) CALL zdf_tke_init ! TKE closure scheme
	333	IF( lk_zdfgls ) CALL zdf_gls_init ! GLS closure scheme
	334	IF( lk_zdfkpp ) CALL zdf_kpp_init ! KPP closure scheme
[2082]	335	IF( lk_zdftmx ) CALL zdf_tmx_init ! tidal vertical mixing
[2027]	336	IF( lk_zdfddm .AND. .NOT. lk_zdfkpp ) &
[2082]	337	& CALL zdf_ddm_init ! double diffusive mixing
	338	! ! Lateral physics
	339	CALL ldf_tra_init ! Lateral ocean tracer physics
	340	CALL ldf_dyn_init ! Lateral ocean momentum physics
[2392]	341	IF( lk_ldfslp ) CALL ldf_slp_init ! slope of lateral mixing
[2082]	342
[2027]	343	! ! Active tracers
	344	CALL tra_qsr_init ! penetrative solar radiation qsr
[2325]	345	CALL tra_bbc_init ! bottom heat flux
[2027]	346	IF( lk_trabbl ) CALL tra_bbl_init ! advective (and/or diffusive) bottom boundary layer scheme
[3294]	347	IF( ln_tradmp ) CALL tra_dmp_init ! internal damping trends
[2027]	348	CALL tra_adv_init ! horizontal & vertical advection
	349	CALL tra_ldf_init ! lateral mixing
	350	CALL tra_zdf_init ! vertical mixing and after tracer fields
	351
	352	! ! Dynamics
	353	CALL dyn_adv_init ! advection (vector or flux form)
[2104]	354	CALL dyn_vor_init ! vorticity term including Coriolis
[2027]	355	CALL dyn_ldf_init ! lateral mixing
[2104]	356	CALL dyn_hpg_init ! horizontal gradient of Hydrostatic pressure
[2027]	357	CALL dyn_zdf_init ! vertical diffusion
	358	CALL dyn_spg_init ! surface pressure gradient
[2392]	359
	360	! ! Misc. options
	361	IF( nn_cla == 1 ) CALL cla_init ! Cross Land Advection
	362
[1594]	363	#if defined key_top
[2027]	364	! ! Passive tracers
[2082]	365	CALL trc_init
[1594]	366	#endif
[2382]	367	! ! Diagnostics
[3294]	368	IF( lk_floats ) CALL flo_init ! drifting Floats
[2027]	369	CALL iom_init ! iom_put initialization
[2392]	370	IF( lk_diaar5 ) CALL dia_ar5_init ! ar5 diag
[2027]	371	CALL dia_ptr_init ! Poleward TRansports initialization
[3294]	372	IF( lk_diadct ) CALL dia_dct_init ! Sections tranports
[2148]	373	CALL dia_hsb_init ! heat content, salt content and volume budgets
[2027]	374	CALL trd_mod_init ! Mixed-layer/Vorticity/Integral constraints trends
[2392]	375	IF( lk_diaobs ) THEN ! Observation & model comparison
[2382]	376	CALL dia_obs_init ! Initialize observational data
	377	CALL dia_obs( nit000 - 1 ) ! Observation operator for restart
[2236]	378	ENDIF
[2382]	379	! ! Assimilation increments
[2392]	380	IF( lk_asminc ) CALL asm_inc_init ! Initialize assimilation increments
[2382]	381	IF(lwp) WRITE(numout,*) 'Euler time step switch is ', neuler
[1593]	382	!
[2496]	383	END SUBROUTINE nemo_init
[467]	384
	385
[2496]	386	SUBROUTINE nemo_ctl
[467]	387	!!----------------------------------------------------------------------
[2496]	388	!! * ROUTINE nemo_ctl *
[467]	389	!!
[2442]	390	!! ** Purpose : control print setting
[467]	391	!!
[2442]	392	!! ** Method : - print namctl information and check some consistencies
[467]	393	!!----------------------------------------------------------------------
[2442]	394	!
[2496]	395	IF(lwp) THEN ! control print
[531]	396	WRITE(numout,*)
[2496]	397	WRITE(numout,*) 'nemo_ctl: Control prints & Benchmark'
[531]	398	WRITE(numout,*) '~~~~~~~ '
[1593]	399	WRITE(numout,*) ' Namelist namctl'
[1601]	400	WRITE(numout,*) ' run control (for debugging) ln_ctl = ', ln_ctl
	401	WRITE(numout,*) ' level of print nn_print = ', nn_print
	402	WRITE(numout,*) ' Start i indice for SUM control nn_ictls = ', nn_ictls
	403	WRITE(numout,*) ' End i indice for SUM control nn_ictle = ', nn_ictle
	404	WRITE(numout,*) ' Start j indice for SUM control nn_jctls = ', nn_jctls
	405	WRITE(numout,*) ' End j indice for SUM control nn_jctle = ', nn_jctle
	406	WRITE(numout,*) ' number of proc. following i nn_isplt = ', nn_isplt
	407	WRITE(numout,*) ' number of proc. following j nn_jsplt = ', nn_jsplt
	408	WRITE(numout,*) ' benchmark parameter (0/1) nn_bench = ', nn_bench
[3352]	409	WRITE(numout,*) ' timing activated (0/1) nn_timing = ', nn_timing
[531]	410	ENDIF
[2442]	411	!
[1601]	412	nprint = nn_print ! convert DOCTOR namelist names into OLD names
	413	nictls = nn_ictls
	414	nictle = nn_ictle
	415	njctls = nn_jctls
	416	njctle = nn_jctle
	417	isplt = nn_isplt
	418	jsplt = nn_jsplt
	419	nbench = nn_bench
[2442]	420	! ! Parameter control
[1593]	421	!
	422	IF( ln_ctl ) THEN ! sub-domain area indices for the control prints
[3294]	423	IF( lk_mpp .AND. jpnij > 1 ) THEN
[2496]	424	isplt = jpni ; jsplt = jpnj ; ijsplt = jpni*jpnj ! the domain is forced to the real split domain
[531]	425	ELSE
	426	IF( isplt == 1 .AND. jsplt == 1 ) THEN
[1593]	427	CALL ctl_warn( ' - isplt & jsplt are equal to 1', &
	428	& ' - the print control will be done over the whole domain' )
[531]	429	ENDIF
[1593]	430	ijsplt = isplt * jsplt ! total number of processors ijsplt
[531]	431	ENDIF
	432	IF(lwp) WRITE(numout,*)' - The total number of processors over which the'
	433	IF(lwp) WRITE(numout,*)' print control will be done is ijsplt : ', ijsplt
[1593]	434	!
	435	! ! indices used for the SUM control
	436	IF( nictls+nictle+njctls+njctle == 0 ) THEN ! print control done over the default area
	437	lsp_area = .FALSE.
	438	ELSE ! print control done over a specific area
[531]	439	lsp_area = .TRUE.
	440	IF( nictls < 1 .OR. nictls > jpiglo ) THEN
	441	CALL ctl_warn( ' - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
	442	nictls = 1
	443	ENDIF
	444	IF( nictle < 1 .OR. nictle > jpiglo ) THEN
	445	CALL ctl_warn( ' - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
	446	nictle = jpiglo
	447	ENDIF
	448	IF( njctls < 1 .OR. njctls > jpjglo ) THEN
	449	CALL ctl_warn( ' - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
	450	njctls = 1
	451	ENDIF
	452	IF( njctle < 1 .OR. njctle > jpjglo ) THEN
	453	CALL ctl_warn( ' - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
	454	njctle = jpjglo
	455	ENDIF
[1593]	456	ENDIF
	457	ENDIF
[2442]	458	!
	459	IF( nbench == 1 ) THEN ! Benchmark
[531]	460	SELECT CASE ( cp_cfg )
[1593]	461	CASE ( 'gyre' ) ; CALL ctl_warn( ' The Benchmark is activated ' )
	462	CASE DEFAULT ; CALL ctl_stop( ' The Benchmark is based on the GYRE configuration:', &
	463	& ' key_gyre must be used or set nbench = 0' )
[531]	464	END SELECT
	465	ENDIF
[1593]	466	!
[2496]	467	IF( lk_c1d .AND. .NOT.lk_iomput ) CALL ctl_stop( 'nemo_ctl: The 1D configuration must be used ', &
	468	& 'with the IOM Input/Output manager. ' , &
[2442]	469	& 'Compile with key_iomput enabled' )
[2409]	470	!
[2496]	471	END SUBROUTINE nemo_ctl
[467]	472
	473
[2496]	474	SUBROUTINE nemo_closefile
[467]	475	!!----------------------------------------------------------------------
[2496]	476	!! * ROUTINE nemo_closefile *
[467]	477	!!
	478	!! ** Purpose : Close the files
	479	!!----------------------------------------------------------------------
[1593]	480	!
	481	IF( lk_mpp ) CALL mppsync
	482	!
[1685]	483	CALL iom_close ! close all input/output files managed by iom_*
[1593]	484	!
[3294]	485	IF( numstp /= -1 ) CLOSE( numstp ) ! time-step file
	486	IF( numsol /= -1 ) CLOSE( numsol ) ! solver file
	487	IF( numnam /= -1 ) CLOSE( numnam ) ! oce namelist
	488	IF( numnam_ice /= -1 ) CLOSE( numnam_ice ) ! ice namelist
	489	IF( numevo_ice /= -1 ) CLOSE( numevo_ice ) ! ice variables (temp. evolution)
	490	IF( numout /= 6 ) CLOSE( numout ) ! standard model output file
	491	IF( numdct_vol /= -1 ) CLOSE( numdct_vol ) ! volume transports
	492	IF( numdct_heat /= -1 ) CLOSE( numdct_heat ) ! heat transports
	493	IF( numdct_salt /= -1 ) CLOSE( numdct_salt ) ! salt transports
	494
[1593]	495	!
[2442]	496	numout = 6 ! redefine numout in case it is used after this point...
	497	!
[2496]	498	END SUBROUTINE nemo_closefile
[467]	499
[2715]	500
	501	SUBROUTINE nemo_alloc
	502	!!----------------------------------------------------------------------
	503	!! * ROUTINE nemo_alloc *
	504	!!
	505	!! ** Purpose : Allocate all the dynamic arrays of the OPA modules
	506	!!
	507	!! ** Method :
	508	!!----------------------------------------------------------------------
	509	USE diawri , ONLY: dia_wri_alloc
	510	USE dom_oce , ONLY: dom_oce_alloc
	511	USE ldfdyn_oce, ONLY: ldfdyn_oce_alloc
	512	USE ldftra_oce, ONLY: ldftra_oce_alloc
	513	USE trc_oce , ONLY: trc_oce_alloc
	514	!
	515	INTEGER :: ierr
	516	!!----------------------------------------------------------------------
	517	!
	518	ierr = oce_alloc () ! ocean
	519	ierr = ierr + dia_wri_alloc ()
	520	ierr = ierr + dom_oce_alloc () ! ocean domain
	521	ierr = ierr + ldfdyn_oce_alloc() ! ocean lateral physics : dynamics
	522	ierr = ierr + ldftra_oce_alloc() ! ocean lateral physics : tracers
	523	ierr = ierr + zdf_oce_alloc () ! ocean vertical physics
	524	!
	525	ierr = ierr + lib_mpp_alloc (numout) ! mpp exchanges
	526	ierr = ierr + trc_oce_alloc () ! shared TRC / TRA arrays
	527	!
	528	IF( lk_mpp ) CALL mpp_sum( ierr )
	529	IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'nemo_alloc : unable to allocate standard ocean arrays' )
	530	!
	531	END SUBROUTINE nemo_alloc
	532
	533
	534	SUBROUTINE nemo_partition( num_pes )
	535	!!----------------------------------------------------------------------
	536	!! * ROUTINE nemo_partition *
	537	!!
	538	!! ** Purpose :
	539	!!
	540	!! ** Method :
	541	!!----------------------------------------------------------------------
	542	INTEGER, INTENT(in) :: num_pes ! The number of MPI processes we have
	543	!
	544	INTEGER, PARAMETER :: nfactmax = 20
	545	INTEGER :: nfact ! The no. of factors returned
	546	INTEGER :: ierr ! Error flag
	547	INTEGER :: ji
	548	INTEGER :: idiff, mindiff, imin ! For choosing pair of factors that are closest in value
	549	INTEGER, DIMENSION(nfactmax) :: ifact ! Array of factors
	550	!!----------------------------------------------------------------------
	551
	552	ierr = 0
	553
	554	CALL factorise( ifact, nfactmax, nfact, num_pes, ierr )
	555
	556	IF( nfact <= 1 ) THEN
	557	WRITE (numout, *) 'WARNING: factorisation of number of PEs failed'
	558	WRITE (numout, *) ' : using grid of ',num_pes,' x 1'
	559	jpnj = 1
	560	jpni = num_pes
	561	ELSE
	562	! Search through factors for the pair that are closest in value
	563	mindiff = 1000000
	564	imin = 1
	565	DO ji = 1, nfact-1, 2
	566	idiff = ABS( ifact(ji) - ifact(ji+1) )
	567	IF( idiff < mindiff ) THEN
	568	mindiff = idiff
	569	imin = ji
	570	ENDIF
	571	END DO
	572	jpnj = ifact(imin)
	573	jpni = ifact(imin + 1)
	574	ENDIF
	575	!
	576	jpnij = jpni*jpnj
	577	!
	578	END SUBROUTINE nemo_partition
	579
	580
	581	SUBROUTINE factorise( kfax, kmaxfax, knfax, kn, kerr )
	582	!!----------------------------------------------------------------------
	583	!! * ROUTINE factorise *
	584	!!
	585	!! ** Purpose : return the prime factors of n.
	586	!! knfax factors are returned in array kfax which is of
	587	!! maximum dimension kmaxfax.
	588	!! ** Method :
	589	!!----------------------------------------------------------------------
	590	INTEGER , INTENT(in ) :: kn, kmaxfax
	591	INTEGER , INTENT( out) :: kerr, knfax
	592	INTEGER, DIMENSION(kmaxfax), INTENT( out) :: kfax
	593	!
	594	INTEGER :: ifac, jl, inu
	595	INTEGER, PARAMETER :: ntest = 14
	596	INTEGER :: ilfax(ntest)
	597
	598	! lfax contains the set of allowed factors.
	599	data (ilfax(jl),jl=1,ntest) / 16384, 8192, 4096, 2048, 1024, 512, 256, &
	600	& 128, 64, 32, 16, 8, 4, 2 /
	601	!!----------------------------------------------------------------------
	602
	603	! Clear the error flag and initialise output vars
	604	kerr = 0
	605	kfax = 1
	606	knfax = 0
	607
	608	! Find the factors of n.
	609	IF( kn == 1 ) GOTO 20
	610
	611	! nu holds the unfactorised part of the number.
	612	! knfax holds the number of factors found.
	613	! l points to the allowed factor list.
	614	! ifac holds the current factor.
	615
	616	inu = kn
	617	knfax = 0
	618
	619	DO jl = ntest, 1, -1
	620	!
	621	ifac = ilfax(jl)
	622	IF( ifac > inu ) CYCLE
	623
	624	! Test whether the factor will divide.
	625
	626	IF( MOD(inu,ifac) == 0 ) THEN
	627	!
	628	knfax = knfax + 1 ! Add the factor to the list
	629	IF( knfax > kmaxfax ) THEN
	630	kerr = 6
	631	write (,) 'FACTOR: insufficient space in factor array ', knfax
	632	return
	633	ENDIF
	634	kfax(knfax) = ifac
	635	! Store the other factor that goes with this one
	636	knfax = knfax + 1
	637	kfax(knfax) = inu / ifac
	638	!WRITE (,) 'ARPDBG, factors ',knfax-1,' & ',knfax,' are ', kfax(knfax-1),' and ',kfax(knfax)
	639	ENDIF
	640	!
	641	END DO
	642
	643	20 CONTINUE ! Label 20 is the exit point from the factor search loop.
	644	!
	645	END SUBROUTINE factorise
	646
[3294]	647	#if defined key_mpp_mpi
	648	SUBROUTINE nemo_northcomms
	649	!!======================================================================
	650	!! * ROUTINE nemo_northcomms *
	651	!! nemo_northcomms : Setup for north fold exchanges with explicit peer to peer messaging
	652	!!=====================================================================
	653	!!----------------------------------------------------------------------
	654	!!
	655	!! ** Purpose : Initialization of the northern neighbours lists.
	656	!!----------------------------------------------------------------------
	657	!! 1.0 ! 2011-10 (A. C. Coward, NOCS & J. Donners, PRACE)
	658	!!----------------------------------------------------------------------
	659
	660	INTEGER :: ji, jj, jk, ij, jtyp ! dummy loop indices
	661	INTEGER :: ijpj ! number of rows involved in north-fold exchange
	662	INTEGER :: northcomms_alloc ! allocate return status
	663	REAL(wp), ALLOCATABLE, DIMENSION ( :,: ) :: znnbrs ! workspace
	664	LOGICAL, ALLOCATABLE, DIMENSION ( : ) :: lrankset ! workspace
	665
	666	IF(lwp) WRITE(numout,*)
	667	IF(lwp) WRITE(numout,*) 'nemo_northcomms : Initialization of the northern neighbours lists'
	668	IF(lwp) WRITE(numout,*) '~~~~~~~~~~'
	669
	670	!!----------------------------------------------------------------------
	671	ALLOCATE( znnbrs(jpi,jpj), stat = northcomms_alloc )
	672	ALLOCATE( lrankset(jpnij), stat = northcomms_alloc )
	673	IF( northcomms_alloc /= 0 ) THEN
	674	WRITE(numout,cform_war)
	675	WRITE(numout,*) 'northcomms_alloc : failed to allocate arrays'
	676	CALL ctl_stop( 'STOP', 'nemo_northcomms : unable to allocate temporary arrays' )
	677	ENDIF
	678	nsndto = 0
	679	isendto = -1
	680	ijpj = 4
	681	!
	682	! This routine has been called because ln_nnogather has been set true ( nammpp )
	683	! However, these first few exchanges have to use the mpi_allgather method to
	684	! establish the neighbour lists to use in subsequent peer to peer exchanges.
	685	! Consequently, set l_north_nogather to be false here and set it true only after
	686	! the lists have been established.
	687	!
	688	l_north_nogather = .FALSE.
	689	!
	690	! Exchange and store ranks on northern rows
	691
	692	DO jtyp = 1,4
	693
	694	lrankset = .FALSE.
	695	znnbrs = narea
	696	SELECT CASE (jtyp)
	697	CASE(1)
	698	CALL lbc_lnk( znnbrs, 'T', 1. ) ! Type 1: T,W-points
	699	CASE(2)
	700	CALL lbc_lnk( znnbrs, 'U', 1. ) ! Type 2: U-point
	701	CASE(3)
	702	CALL lbc_lnk( znnbrs, 'V', 1. ) ! Type 3: V-point
	703	CASE(4)
	704	CALL lbc_lnk( znnbrs, 'F', 1. ) ! Type 4: F-point
	705	END SELECT
	706
	707	IF ( njmppt(narea) .EQ. MAXVAL( njmppt ) ) THEN
	708	DO jj = nlcj-ijpj+1, nlcj
	709	ij = jj - nlcj + ijpj
	710	DO ji = 1,jpi
	711	IF ( INT(znnbrs(ji,jj)) .NE. 0 .AND. INT(znnbrs(ji,jj)) .NE. narea ) &
	712	& lrankset(INT(znnbrs(ji,jj))) = .true.
	713	END DO
	714	END DO
	715
	716	DO jj = 1,jpnij
	717	IF ( lrankset(jj) ) THEN
	718	nsndto(jtyp) = nsndto(jtyp) + 1
	719	IF ( nsndto(jtyp) .GT. jpmaxngh ) THEN
	720	CALL ctl_stop( ' Too many neighbours in nemo_northcomms ', &
	721	& ' jpmaxngh will need to be increased ')
	722	ENDIF
	723	isendto(nsndto(jtyp),jtyp) = jj-1 ! narea converted to MPI rank
	724	ENDIF
	725	END DO
	726	ENDIF
	727
	728	END DO
	729
	730	!
	731	! Type 5: I-point
	732	!
	733	! ICE point exchanges may involve some averaging. The neighbours list is
	734	! built up using two exchanges to ensure that the whole stencil is covered.
	735	! lrankset should not be reset between these 'J' and 'K' point exchanges
	736
	737	jtyp = 5
	738	lrankset = .FALSE.
	739	znnbrs = narea
	740	CALL lbc_lnk( znnbrs, 'J', 1. ) ! first ice U-V point
	741
	742	IF ( njmppt(narea) .EQ. MAXVAL( njmppt ) ) THEN
	743	DO jj = nlcj-ijpj+1, nlcj
	744	ij = jj - nlcj + ijpj
	745	DO ji = 1,jpi
	746	IF ( INT(znnbrs(ji,jj)) .NE. 0 .AND. INT(znnbrs(ji,jj)) .NE. narea ) &
	747	& lrankset(INT(znnbrs(ji,jj))) = .true.
	748	END DO
	749	END DO
	750	ENDIF
	751
	752	znnbrs = narea
	753	CALL lbc_lnk( znnbrs, 'K', 1. ) ! second ice U-V point
	754
	755	IF ( njmppt(narea) .EQ. MAXVAL( njmppt )) THEN
	756	DO jj = nlcj-ijpj+1, nlcj
	757	ij = jj - nlcj + ijpj
	758	DO ji = 1,jpi
	759	IF ( INT(znnbrs(ji,jj)) .NE. 0 .AND. INT(znnbrs(ji,jj)) .NE. narea ) &
	760	& lrankset( INT(znnbrs(ji,jj))) = .true.
	761	END DO
	762	END DO
	763
	764	DO jj = 1,jpnij
	765	IF ( lrankset(jj) ) THEN
	766	nsndto(jtyp) = nsndto(jtyp) + 1
	767	IF ( nsndto(jtyp) .GT. jpmaxngh ) THEN
	768	CALL ctl_stop( ' Too many neighbours in nemo_northcomms ', &
	769	& ' jpmaxngh will need to be increased ')
	770	ENDIF
	771	isendto(nsndto(jtyp),jtyp) = jj-1 ! narea converted to MPI rank
	772	ENDIF
	773	END DO
	774	!
	775	! For northern row areas, set l_north_nogather so that all subsequent exchanges
	776	! can use peer to peer communications at the north fold
	777	!
	778	l_north_nogather = .TRUE.
	779	!
	780	ENDIF
	781	DEALLOCATE( znnbrs )
	782	DEALLOCATE( lrankset )
	783
	784	END SUBROUTINE nemo_northcomms
	785	#else
	786	SUBROUTINE nemo_northcomms ! Dummy routine
	787	WRITE(,) 'nemo_northcomms: You should not have seen this print! error?'
	788	END SUBROUTINE nemo_northcomms
	789	#endif
[3]	790	!!======================================================================
[2496]	791	END MODULE nemogcm

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

Download in other formats: