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

Context Navigation

source: branches/2012/dev_NOC_2012_rev3555/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 3609

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

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

Download in other formats: