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

Last change on this file since 3952 was 3769, checked in by smasson, 11 years ago
dev_MERGE_2012: xios+agrif+oasis compliant
Property svn:keywords set to `Id`
File size: 37.2 KB

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

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

Download in other formats: