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 @ 3819

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

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

Download in other formats: