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

Context Navigation

source: branches/2013/dev_LOCEAN_CMCC_INGV_2013/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 4769

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

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

Download in other formats: