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

Context Navigation

source: branches/2011/dev_NEMO_MERGE_2011/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 3274

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

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

Download in other formats: