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 NEMO/branches/2020/dev_r12527_Gurvan_ShallowWater/src/SWE – NEMO

Context Navigation

source: NEMO/branches/2020/dev_r12527_Gurvan_ShallowWater/src/SWE/nemogcm.F90 @ 13151

Last change on this file since 13151 was 13151, checked in by gm, 4 years ago
result from merge with qco r12983
Property svn:keywords set to `Id`
File size: 30.8 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)
[9656]	15	!! 8.2 ! 1999-11 (M. Imbard, H. Goosse) sea-ice model
[3764]	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
[5836]	30	!! - ! 2011-11 (C. Harris) decomposition changes for running with CICE
	31	!! 3.6 ! 2012-05 (C. Calone, J. Simeon, G. Madec, C. Ethe) Add grid coarsening
	32	!! - ! 2014-12 (G. Madec) remove KPP scheme and cross-land advection (cla)
[7646]	33	!! 4.0 ! 2016-10 (G. Madec, S. Flavoni) domain configuration / user defined interface
[1593]	34	!!----------------------------------------------------------------------
[3]	35
	36	!!----------------------------------------------------------------------
[6140]	37	!! nemo_gcm : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice
	38	!! nemo_init : initialization of the NEMO system
	39	!! nemo_ctl : initialisation of the contol print
	40	!! nemo_closefile: close remaining open files
	41	!! nemo_alloc : dynamical allocation
[3]	42	!!----------------------------------------------------------------------
[6140]	43	USE step_oce ! module used in the ocean time stepping module (step.F90)
[7646]	44	USE phycst ! physical constant (par_cst routine)
	45	USE domain ! domain initialization (dom_init & dom_cfg routines)
[9161]	46	USE closea ! treatment of closed seas (for ln_closea)
[7646]	47	USE usrdef_nam ! user defined configuration
[12377]	48	USE tide_mod, ONLY : tide_init ! tidal components initialization (tide_init routine)
[9019]	49	USE bdy_oce, ONLY : ln_bdy
[6140]	50	USE bdyini ! open boundary cond. setting (bdy_init routine)
	51	USE istate ! initial state setting (istate_init routine)
	52	USE ldfdyn ! lateral viscosity setting (ldfdyn_init routine)
	53	USE ldftra ! lateral diffusivity setting (ldftra_init routine)
	54	USE trdini ! dyn/tra trends initialization (trd_init routine)
	55	USE asminc ! assimilation increments
	56	USE asmbkg ! writing out state trajectory
	57	USE diaptr ! poleward transports (dia_ptr_init routine)
	58	USE diadct ! sections transports (dia_dct_init routine)
	59	USE diaobs ! Observation diagnostics (dia_obs_init routine)
	60	USE diacfl ! CFL diagnostics (dia_cfl_init routine)
[12377]	61	USE diamlr ! IOM context management for multiple-linear-regression analysis
[13151]	62	#if defined key_RK3
	63	USE stpRK3
	64	#elif defined key_qco
	65	USE stpLF
	66	#else
[6140]	67	USE step ! NEMO time-stepping (stp routine)
[13151]	68	#endif
[12377]	69	USE isfstp ! ice shelf (isf_stp_init routine)
[6140]	70	USE icbini ! handle bergs, initialisation
	71	USE icbstp ! handle bergs, calving, themodynamics and transport
	72	USE cpl_oasis3 ! OASIS3 coupling
	73	USE c1d ! 1D configuration
	74	USE step_c1d ! Time stepping loop for the 1D configuration
	75	USE dyndmp ! Momentum damping
	76	USE stopar ! Stochastic param.: ???
	77	USE stopts ! Stochastic param.: ???
[12377]	78	USE diu_layers ! diurnal bulk SST and coolskin
[7646]	79	USE crsini ! initialise grid coarsening utility
[12214]	80	USE dia25h ! 25h mean output
[12377]	81	USE diadetide ! Weights computation for daily detiding of model diagnostics
[7646]	82	USE sbc_oce , ONLY : lk_oasis
	83	USE wet_dry ! Wetting and drying setting (wad_init routine)
[1594]	84	#if defined key_top
[6140]	85	USE trcini ! passive tracer initialisation
[1594]	86	#endif
[7646]	87	#if defined key_nemocice_decomp
	88	USE ice_domain_size, only: nx_global, ny_global
	89	#endif
	90	!
[6140]	91	USE lib_mpp ! distributed memory computing
[7646]	92	USE mppini ! shared/distributed memory setting (mpp_init routine)
[9213]	93	USE lbcnfd , ONLY : isendto, nsndto, nfsloop, nfeloop ! Setup of north fold exchanges
[7646]	94	USE lib_fortran ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
[1412]	95	#if defined key_iomput
[6140]	96	USE xios ! xIOserver
[1359]	97	#endif
[9780]	98	#if defined key_agrif
	99	USE agrif_all_update ! Master Agrif update
	100	#endif
[268]	101
[2715]	102	IMPLICIT NONE
[3]	103	PRIVATE
	104
[2496]	105	PUBLIC nemo_gcm ! called by model.F90
	106	PUBLIC nemo_init ! needed by AGRIF
[3764]	107	PUBLIC nemo_alloc ! needed by TAM
[467]	108
[2498]	109	CHARACTER(lc) :: cform_aaa="( /, 'AAAAAAAA', / ) " ! flag for output listing
[1593]	110
[10425]	111	#if defined key_mpp_mpi
[11536]	112	! need MPI_Wtime
[10425]	113	INCLUDE 'mpif.h'
	114	#endif
	115
[3]	116	!!----------------------------------------------------------------------
[9570]	117	!! NEMO/OCE 4.0 , NEMO Consortium (2018)
[2392]	118	!! $Id$
[10068]	119	!! Software governed by the CeCILL license (see ./LICENSE)
[3]	120	!!----------------------------------------------------------------------
	121	CONTAINS
	122
[2496]	123	SUBROUTINE nemo_gcm
[3]	124	!!----------------------------------------------------------------------
[2496]	125	!! * ROUTINE nemo_gcm *
[3]	126	!!
[3764]	127	!! ** Purpose : NEMO solves the primitive equations on an orthogonal
[1593]	128	!! curvilinear mesh on the sphere.
[3]	129	!!
	130	!! ** Method : - model general initialization
	131	!! - launch the time-stepping (stp routine)
[1593]	132	!! - finalize the run by closing files and communications
[3]	133	!!
[2715]	134	!! References : Madec, Delecluse, Imbard, and Levy, 1997: internal report, IPSL.
[1593]	135	!! Madec, 2008, internal report, IPSL.
[3]	136	!!----------------------------------------------------------------------
[7646]	137	INTEGER :: istp ! time step index
[11536]	138	REAL(wp):: zstptiming ! elapsed time for 1 time step
[389]	139	!!----------------------------------------------------------------------
[2382]	140	!
[392]	141	#if defined key_agrif
[1593]	142	CALL Agrif_Init_Grids() ! AGRIF: set the meshes
[389]	143	#endif
[1593]	144	! !-----------------------!
[2496]	145	CALL nemo_init !== Initialisations ==!
[1593]	146	! !-----------------------!
[12614]	147
[2715]	148	#if defined key_agrif
[12377]	149	Kbb_a = Nbb; Kmm_a = Nnn; Krhs_a = Nrhs ! agrif_oce module copies of time level indices
[3680]	150	CALL Agrif_Declare_Var_dom ! AGRIF: set the meshes for DOM
	151	CALL Agrif_Declare_Var ! " " " " " DYN/TRA
[2715]	152	# if defined key_top
[3680]	153	CALL Agrif_Declare_Var_top ! " " " " " TOP
[2715]	154	# endif
[9570]	155	# if defined key_si3
[9611]	156	CALL Agrif_Declare_Var_ice ! " " " " " Sea ice
[7646]	157	# endif
[2715]	158	#endif
[682]	159	! check that all process are still there... If some process have an error,
	160	! they will never enter in step and other processes will wait until the end of the cpu time!
[10425]	161	CALL mpp_max( 'nemogcm', nstop )
[682]	162
[1593]	163	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
	164
	165	! !-----------------------!
	166	! !== time stepping ==!
	167	! !-----------------------!
[12489]	168	!
	169	! !== set the model time-step ==!
	170	!
[900]	171	istp = nit000
[9210]	172	!
[12614]	173	! !== Standard time-stepping ==!
[9210]	174	!
	175	DO WHILE( istp <= nitend .AND. nstop == 0 )
[12614]	176
	177	ncom_stp = istp
	178	IF( ln_timing ) THEN
	179	zstptiming = MPI_Wtime()
	180	IF ( istp == ( nit000 + 1 ) ) elapsed_time = zstptiming
	181	IF ( istp == nitend ) elapsed_time = zstptiming - elapsed_time
	182	ENDIF
[13151]	183	#if defined key_RK3
	184	CALL stp_RK3 ( istp )
	185	#elif defined key_qco
	186	CALL stp_LF ( istp )
	187	#else
	188	CALL stp ( istp )
	189	#endif
[9210]	190	istp = istp + 1
[11536]	191
[12614]	192	IF( lwp .AND. ln_timing ) WRITE(numtime,*) 'timing step ', istp-1, ' : ', MPI_Wtime() - zstptiming
[11536]	193
[12614]	194	END DO
[9210]	195	!
	196	!
[1593]	197	! !------------------------!
	198	! !== finalize the run ==!
	199	! !------------------------!
[7646]	200	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
[1593]	201	!
[7646]	202	IF( nstop /= 0 .AND. lwp ) THEN ! error print
[11536]	203	WRITE(ctmp1,*) ' ==>>> nemo_gcm: a total of ', nstop, ' errors have been found'
	204	CALL ctl_stop( ctmp1 )
[389]	205	ENDIF
[1593]	206	!
[9124]	207	IF( ln_timing ) CALL timing_finalize
[3294]	208	!
[2496]	209	CALL nemo_closefile
[4990]	210	!
[3769]	211	#if defined key_iomput
[12614]	212	CALL xios_finalize ! end mpp communications with xios
[532]	213	#else
[12614]	214	IF( lk_mpp ) CALL mppstop ! end mpp communications
[532]	215	#endif
[900]	216	!
[10436]	217	IF(lwm) THEN
	218	IF( nstop == 0 ) THEN ; STOP 0
[11536]	219	ELSE ; STOP 123
[10436]	220	ENDIF
[10425]	221	ENDIF
	222	!
[2496]	223	END SUBROUTINE nemo_gcm
[389]	224
	225
[2496]	226	SUBROUTINE nemo_init
[389]	227	!!----------------------------------------------------------------------
[2496]	228	!! * ROUTINE nemo_init *
[389]	229	!!
[2496]	230	!! ** Purpose : initialization of the NEMO GCM
[389]	231	!!----------------------------------------------------------------------
[11536]	232	INTEGER :: ios, ilocal_comm ! local integers
[9213]	233	!!
[12377]	234	NAMELIST/namctl/ sn_cfctl, nn_print, nn_ictls, nn_ictle, &
[10570]	235	& nn_isplt , nn_jsplt, nn_jctls, nn_jctle, &
[9019]	236	& ln_timing, ln_diacfl
[9213]	237	NAMELIST/namcfg/ ln_read_cfg, cn_domcfg, ln_closea, ln_write_cfg, cn_domcfg_out, ln_use_jattr
[3]	238	!!----------------------------------------------------------------------
[1593]	239	!
[5407]	240	cxios_context = 'nemo'
[2496]	241	!
[11536]	242	! !-------------------------------------------------!
	243	! ! set communicator & select the local rank !
	244	! ! must be done as soon as possible to get narea !
	245	! !-------------------------------------------------!
[1593]	246	!
[1412]	247	#if defined key_iomput
[2200]	248	IF( Agrif_Root() ) THEN
[5407]	249	IF( lk_oasis ) THEN
[7646]	250	CALL cpl_init( "oceanx", ilocal_comm ) ! nemo local communicator given by oasis
[11536]	251	CALL xios_initialize( "not used" , local_comm =ilocal_comm ) ! send nemo communicator to xios
[4990]	252	ELSE
[11536]	253	CALL xios_initialize( "for_xios_mpi_id", return_comm=ilocal_comm ) ! nemo local communicator given by xios
[4990]	254	ENDIF
[2200]	255	ENDIF
[11536]	256	CALL mpp_start( ilocal_comm )
[532]	257	#else
[5407]	258	IF( lk_oasis ) THEN
[4990]	259	IF( Agrif_Root() ) THEN
[7646]	260	CALL cpl_init( "oceanx", ilocal_comm ) ! nemo local communicator given by oasis
[4990]	261	ENDIF
[11536]	262	CALL mpp_start( ilocal_comm )
[4990]	263	ELSE
[11536]	264	CALL mpp_start( )
[2236]	265	ENDIF
[532]	266	#endif
[11536]	267	!
	268	narea = mpprank + 1 ! mpprank: the rank of proc (0 --> mppsize -1 )
	269	lwm = (narea == 1) ! control of output namelists
	270	!
	271	! !---------------------------------------------------------------!
	272	! ! Open output files, reference and configuration namelist files !
	273	! !---------------------------------------------------------------!
	274	!
	275	! open ocean.output as soon as possible to get all output prints (including errors messages)
	276	IF( lwm ) CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
	277	! open reference and configuration namelist files
[12377]	278	CALL load_nml( numnam_ref, 'namelist_ref', -1, lwm )
	279	CALL load_nml( numnam_cfg, 'namelist_cfg', -1, lwm )
[11536]	280	IF( lwm ) CALL ctl_opn( numond, 'output.namelist.dyn', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
	281	! open /dev/null file to be able to supress output write easily
	282	CALL ctl_opn( numnul, '/dev/null', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
	283	!
	284	! !--------------------!
[12377]	285	! ! Open listing units ! -> need sn_cfctl from namctl to define lwp
[11536]	286	! !--------------------!
	287	!
	288	READ ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
	289	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in reference namelist' )
	290	READ ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
	291	902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namctl in configuration namelist' )
	292	!
[12377]	293	! finalize the definition of namctl variables
	294	IF( sn_cfctl%l_allon ) THEN
	295	! Turn on all options.
	296	CALL nemo_set_cfctl( sn_cfctl, .TRUE., .TRUE. )
	297	! Ensure all processors are active
	298	sn_cfctl%procmin = 0 ; sn_cfctl%procmax = 1000000 ; sn_cfctl%procincr = 1
	299	ELSEIF( sn_cfctl%l_config ) THEN
	300	! Activate finer control of report outputs
	301	! optionally switch off output from selected areas (note this only
	302	! applies to output which does not involve global communications)
	303	IF( ( narea < sn_cfctl%procmin .OR. narea > sn_cfctl%procmax ) .OR. &
	304	& ( MOD( narea - sn_cfctl%procmin, sn_cfctl%procincr ) /= 0 ) ) &
	305	& CALL nemo_set_cfctl( sn_cfctl, .FALSE., .FALSE. )
	306	ELSE
	307	! turn off all options.
	308	CALL nemo_set_cfctl( sn_cfctl, .FALSE., .TRUE. )
	309	ENDIF
[11536]	310	!
[12377]	311	lwp = (narea == 1) .OR. sn_cfctl%l_oceout ! control of all listing output print
	312	!
[11536]	313	IF(lwp) THEN ! open listing units
[1593]	314	!
[11536]	315	IF( .NOT. lwm ) & ! alreay opened for narea == 1
	316	& CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE., narea )
[1593]	317	!
[1579]	318	WRITE(numout,*)
[11536]	319	WRITE(numout,*) ' CNRS - NERC - Met OFFICE - MERCATOR-ocean - CMCC'
[1593]	320	WRITE(numout,*) ' NEMO team'
[1579]	321	WRITE(numout,*) ' Ocean General Circulation Model'
[10510]	322	WRITE(numout,*) ' NEMO version 4.0 (2019) '
[1579]	323	WRITE(numout,*)
[10510]	324	WRITE(numout,*) " ._ ._ ._ ._ ._ "
	325	WRITE(numout,*) " _.-._)`\_.-._)`\_.-._)`\_.-._)`\_.-._)`\_ "
[1579]	326	WRITE(numout,*)
[10510]	327	WRITE(numout,*) " o _, _, "
	328	WRITE(numout,*) " o .' ( .-' / "
	329	WRITE(numout,*) " o _/..._'. .' / "
	330	WRITE(numout,*) " ( o .-'` ` '-./ _.' "
	331	WRITE(numout,*) " ) ( o) ;= <_ ( "
	332	WRITE(numout,*) " ( '-.,\\__ __.-;`\ '. ) "
	333	WRITE(numout,*) " ) ) \) \|`\ \) '. \ ( ( "
	334	WRITE(numout,*) " ( ( \_/ '-._\ ) ) "
[10583]	335	WRITE(numout,*) " ) ) jgs ` ( ( "
[10510]	336	WRITE(numout,*) " ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ "
	337	WRITE(numout,*)
[1593]	338	!
[7646]	339	WRITE(numout,cform_aaa) ! Flag AAAAAAA
	340	!
[473]	341	ENDIF
[10425]	342	!
[11536]	343	IF(lwm) WRITE( numond, namctl )
	344	!
	345	! !------------------------------------!
	346	! ! Set global domain size parameters !
	347	! !------------------------------------!
	348	!
	349	READ ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
	350	903 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in reference namelist' )
	351	READ ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
	352	904 IF( ios > 0 ) CALL ctl_nam ( ios , 'namcfg in configuration namelist' )
	353	!
	354	IF( ln_read_cfg ) THEN ! Read sizes in domain configuration file
	355	CALL domain_cfg ( cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
	356	ELSE ! user-defined namelist
	357	CALL usr_def_nam( cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
	358	ENDIF
	359	!
	360	IF(lwm) WRITE( numond, namcfg )
	361	!
	362	! !-----------------------------------------!
	363	! ! mpp parameters and domain decomposition !
	364	! !-----------------------------------------!
	365	CALL mpp_init
[2715]	366
[7646]	367	! Now we know the dimensions of the grid and numout has been set: we can allocate arrays
[2715]	368	CALL nemo_alloc()
	369
[12377]	370	! Initialise time level indices
	371	Nbb = 1; Nnn = 2; Naa = 3; Nrhs = Naa
	372
[2496]	373	! !-------------------------------!
	374	! ! NEMO general initialization !
	375	! !-------------------------------!
[473]	376
[7646]	377	CALL nemo_ctl ! Control prints
[2382]	378	!
[9213]	379	! ! General initialization
	380	IF( ln_timing ) CALL timing_init ! timing
	381	IF( ln_timing ) CALL timing_start( 'nemo_init')
[3294]	382	!
[9367]	383	CALL phy_cst ! Physical constants
[12614]	384
[12377]	385	CALL dom_init( Nbb, Nnn, Naa, "OPA") ! Domain
[12614]	386
[12377]	387	IF( sn_cfctl%l_prtctl ) &
	388	& CALL prt_ctl_init ! Print control
[12614]	389
[12377]	390	CALL istate_init( Nbb, Nnn, Naa ) ! ocean initial state (Dynamics and tracers)
[3651]	391
[5836]	392	! ! external forcing
[12377]	393	CALL tide_init ! tidal harmonics
[12614]	394
[12377]	395	CALL sbc_init( Nbb, Nnn, Naa ) ! surface boundary conditions (including sea-ice)
[12614]	396
[9019]	397
[12614]	398	! ! Ocean physics
[2082]	399	! ! Lateral physics
[9019]	400	CALL ldf_dyn_init ! Lateral ocean momentum physics
[12614]	401
	402
[9019]	403	! ! Dynamics
[12377]	404	CALL dyn_adv_init ! advection (vector or flux form)
[12614]	405
[12377]	406	CALL dyn_vor_init ! vorticity term including Coriolis
[12614]	407
[12377]	408	CALL dyn_ldf_init ! lateral mixing
[12614]	409
[12377]	410	CALL dyn_spg_init ! surface pressure gradient
[3764]	411
[5836]	412	! ! Diagnostics
[12377]	413	CALL flo_init( Nnn ) ! drifting Floats
[12614]	414
[9019]	415	IF( ln_diacfl ) CALL dia_cfl_init ! Initialise CFL diagnostics
[12614]	416
[12377]	417	CALL trd_init( Nnn ) ! Mixed-layer/Vorticity/Integral constraints trends
[6140]	418
[12614]	419
[9213]	420	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
	421	!
	422	IF( ln_timing ) CALL timing_stop( 'nemo_init')
	423	!
[12614]	424
[2496]	425	END SUBROUTINE nemo_init
[467]	426
	427
[2496]	428	SUBROUTINE nemo_ctl
[467]	429	!!----------------------------------------------------------------------
[2496]	430	!! * ROUTINE nemo_ctl *
[467]	431	!!
[3764]	432	!! ** Purpose : control print setting
[467]	433	!!
[11536]	434	!! ** Method : - print namctl and namcfg information and check some consistencies
[467]	435	!!----------------------------------------------------------------------
[2442]	436	!
[2496]	437	IF(lwp) THEN ! control print
[531]	438	WRITE(numout,*)
[7646]	439	WRITE(numout,*) 'nemo_ctl: Control prints'
[9213]	440	WRITE(numout,*) '~~~~~~~~'
[1593]	441	WRITE(numout,*) ' Namelist namctl'
[12377]	442	WRITE(numout,*) ' sn_cfctl%l_glochk = ', sn_cfctl%l_glochk
	443	WRITE(numout,*) ' sn_cfctl%l_allon = ', sn_cfctl%l_allon
[10570]	444	WRITE(numout,*) ' finer control over o/p sn_cfctl%l_config = ', sn_cfctl%l_config
	445	WRITE(numout,*) ' sn_cfctl%l_runstat = ', sn_cfctl%l_runstat
	446	WRITE(numout,*) ' sn_cfctl%l_trcstat = ', sn_cfctl%l_trcstat
	447	WRITE(numout,*) ' sn_cfctl%l_oceout = ', sn_cfctl%l_oceout
	448	WRITE(numout,*) ' sn_cfctl%l_layout = ', sn_cfctl%l_layout
[12377]	449	WRITE(numout,*) ' sn_cfctl%l_prtctl = ', sn_cfctl%l_prtctl
	450	WRITE(numout,*) ' sn_cfctl%l_prttrc = ', sn_cfctl%l_prttrc
	451	WRITE(numout,*) ' sn_cfctl%l_oasout = ', sn_cfctl%l_oasout
[10570]	452	WRITE(numout,*) ' sn_cfctl%procmin = ', sn_cfctl%procmin
	453	WRITE(numout,*) ' sn_cfctl%procmax = ', sn_cfctl%procmax
	454	WRITE(numout,*) ' sn_cfctl%procincr = ', sn_cfctl%procincr
	455	WRITE(numout,*) ' sn_cfctl%ptimincr = ', sn_cfctl%ptimincr
[1601]	456	WRITE(numout,*) ' level of print nn_print = ', nn_print
	457	WRITE(numout,*) ' Start i indice for SUM control nn_ictls = ', nn_ictls
	458	WRITE(numout,*) ' End i indice for SUM control nn_ictle = ', nn_ictle
	459	WRITE(numout,*) ' Start j indice for SUM control nn_jctls = ', nn_jctls
	460	WRITE(numout,*) ' End j indice for SUM control nn_jctle = ', nn_jctle
	461	WRITE(numout,*) ' number of proc. following i nn_isplt = ', nn_isplt
	462	WRITE(numout,*) ' number of proc. following j nn_jsplt = ', nn_jsplt
[9019]	463	WRITE(numout,*) ' timing by routine ln_timing = ', ln_timing
	464	WRITE(numout,*) ' CFL diagnostics ln_diacfl = ', ln_diacfl
[531]	465	ENDIF
[2442]	466	!
[1601]	467	nprint = nn_print ! convert DOCTOR namelist names into OLD names
	468	nictls = nn_ictls
	469	nictle = nn_ictle
	470	njctls = nn_jctls
	471	njctle = nn_jctle
	472	isplt = nn_isplt
[9213]	473	jsplt = nn_jsplt
[4147]	474
	475	IF(lwp) THEN ! control print
	476	WRITE(numout,*)
	477	WRITE(numout,*) ' Namelist namcfg'
[7646]	478	WRITE(numout,*) ' read domain configuration file ln_read_cfg = ', ln_read_cfg
	479	WRITE(numout,*) ' filename to be read cn_domcfg = ', TRIM(cn_domcfg)
[9213]	480	WRITE(numout,*) ' keep closed seas in the domain (if exist) ln_closea = ', ln_closea
	481	WRITE(numout,*) ' create a configuration definition file ln_write_cfg = ', ln_write_cfg
[7646]	482	WRITE(numout,*) ' filename to be written cn_domcfg_out = ', TRIM(cn_domcfg_out)
	483	WRITE(numout,*) ' use file attribute if exists as i/p j-start ln_use_jattr = ', ln_use_jattr
[4147]	484	ENDIF
[9213]	485	IF( .NOT.ln_read_cfg ) ln_closea = .false. ! dealing possible only with a domcfg file
	486	!
[2442]	487	! ! Parameter control
[1593]	488	!
[12377]	489	IF( sn_cfctl%l_prtctl .OR. sn_cfctl%l_prttrc ) THEN ! sub-domain area indices for the control prints
[3294]	490	IF( lk_mpp .AND. jpnij > 1 ) THEN
[2496]	491	isplt = jpni ; jsplt = jpnj ; ijsplt = jpni*jpnj ! the domain is forced to the real split domain
[531]	492	ELSE
	493	IF( isplt == 1 .AND. jsplt == 1 ) THEN
[1593]	494	CALL ctl_warn( ' - isplt & jsplt are equal to 1', &
	495	& ' - the print control will be done over the whole domain' )
[531]	496	ENDIF
[1593]	497	ijsplt = isplt * jsplt ! total number of processors ijsplt
[531]	498	ENDIF
	499	IF(lwp) WRITE(numout,*)' - The total number of processors over which the'
	500	IF(lwp) WRITE(numout,*)' print control will be done is ijsplt : ', ijsplt
[1593]	501	!
	502	! ! indices used for the SUM control
	503	IF( nictls+nictle+njctls+njctle == 0 ) THEN ! print control done over the default area
[3764]	504	lsp_area = .FALSE.
[1593]	505	ELSE ! print control done over a specific area
[531]	506	lsp_area = .TRUE.
	507	IF( nictls < 1 .OR. nictls > jpiglo ) THEN
	508	CALL ctl_warn( ' - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
	509	nictls = 1
	510	ENDIF
	511	IF( nictle < 1 .OR. nictle > jpiglo ) THEN
	512	CALL ctl_warn( ' - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
	513	nictle = jpiglo
	514	ENDIF
	515	IF( njctls < 1 .OR. njctls > jpjglo ) THEN
	516	CALL ctl_warn( ' - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
	517	njctls = 1
	518	ENDIF
	519	IF( njctle < 1 .OR. njctle > jpjglo ) THEN
	520	CALL ctl_warn( ' - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
	521	njctle = jpjglo
	522	ENDIF
[1593]	523	ENDIF
	524	ENDIF
[2442]	525	!
[9213]	526	IF( 1._wp /= SIGN(1._wp,-0._wp) ) CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows f2003 standard.', &
[10425]	527	& 'Compile with key_nosignedzero enabled:', &
	528	& '--> add -Dkey_nosignedzero to the definition of %CPP in your arch file' )
[3764]	529	!
[9023]	530	#if defined key_agrif
[9124]	531	IF( ln_timing ) CALL ctl_stop( 'AGRIF not implemented with ln_timing = true')
[9023]	532	#endif
	533	!
[2496]	534	END SUBROUTINE nemo_ctl
[467]	535
	536
[2496]	537	SUBROUTINE nemo_closefile
[467]	538	!!----------------------------------------------------------------------
[2496]	539	!! * ROUTINE nemo_closefile *
[467]	540	!!
	541	!! ** Purpose : Close the files
	542	!!----------------------------------------------------------------------
[1593]	543	!
	544	IF( lk_mpp ) CALL mppsync
	545	!
[1685]	546	CALL iom_close ! close all input/output files managed by iom_*
[1593]	547	!
[4147]	548	IF( numstp /= -1 ) CLOSE( numstp ) ! time-step file
[9019]	549	IF( numrun /= -1 ) CLOSE( numrun ) ! run statistics file
[4624]	550	IF( lwm.AND.numond /= -1 ) CLOSE( numond ) ! oce output namelist
	551	IF( lwm.AND.numoni /= -1 ) CLOSE( numoni ) ! ice output namelist
[4147]	552	IF( numevo_ice /= -1 ) CLOSE( numevo_ice ) ! ice variables (temp. evolution)
	553	IF( numout /= 6 ) CLOSE( numout ) ! standard model output file
	554	IF( numdct_vol /= -1 ) CLOSE( numdct_vol ) ! volume transports
	555	IF( numdct_heat /= -1 ) CLOSE( numdct_heat ) ! heat transports
	556	IF( numdct_salt /= -1 ) CLOSE( numdct_salt ) ! salt transports
[1593]	557	!
[2442]	558	numout = 6 ! redefine numout in case it is used after this point...
	559	!
[2496]	560	END SUBROUTINE nemo_closefile
[467]	561
[2715]	562
	563	SUBROUTINE nemo_alloc
	564	!!----------------------------------------------------------------------
	565	!! * ROUTINE nemo_alloc *
	566	!!
	567	!! ** Purpose : Allocate all the dynamic arrays of the OPA modules
	568	!!
	569	!! ** Method :
	570	!!----------------------------------------------------------------------
[9213]	571	USE diawri , ONLY : dia_wri_alloc
	572	USE dom_oce , ONLY : dom_oce_alloc
	573	USE trc_oce , ONLY : trc_oce_alloc
	574	USE bdy_oce , ONLY : bdy_oce_alloc
[2715]	575	!
	576	INTEGER :: ierr
	577	!!----------------------------------------------------------------------
	578	!
[9213]	579	ierr = oce_alloc () ! ocean
	580	ierr = ierr + dia_wri_alloc()
	581	ierr = ierr + dom_oce_alloc() ! ocean domain
	582	ierr = ierr + zdf_oce_alloc() ! ocean vertical physics
	583	ierr = ierr + trc_oce_alloc() ! shared TRC / TRA arrays
	584	ierr = ierr + bdy_oce_alloc() ! bdy masks (incl. initialization)
[2715]	585	!
[10425]	586	CALL mpp_sum( 'nemogcm', ierr )
[9213]	587	IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'nemo_alloc: unable to allocate standard ocean arrays' )
[2715]	588	!
	589	END SUBROUTINE nemo_alloc
	590
[11536]	591
[10570]	592	SUBROUTINE nemo_set_cfctl(sn_cfctl, setto, for_all )
	593	!!----------------------------------------------------------------------
	594	!! * ROUTINE nemo_set_cfctl *
	595	!!
	596	!! ** Purpose : Set elements of the output control structure to setto.
	597	!! for_all should be .false. unless all areas are to be
	598	!! treated identically.
	599	!!
	600	!! ** Method : Note this routine can be used to switch on/off some
	601	!! types of output for selected areas but any output types
	602	!! that involve global communications (e.g. mpp_max, glob_sum)
	603	!! should be protected from selective switching by the
	604	!! for_all argument
	605	!!----------------------------------------------------------------------
	606	LOGICAL :: setto, for_all
[10588]	607	TYPE(sn_ctl) :: sn_cfctl
[10570]	608	!!----------------------------------------------------------------------
	609	IF( for_all ) THEN
	610	sn_cfctl%l_runstat = setto
	611	sn_cfctl%l_trcstat = setto
	612	ENDIF
	613	sn_cfctl%l_oceout = setto
	614	sn_cfctl%l_layout = setto
[12377]	615	sn_cfctl%l_prtctl = setto
	616	sn_cfctl%l_prttrc = setto
	617	sn_cfctl%l_oasout = setto
[10570]	618	END SUBROUTINE nemo_set_cfctl
	619
[3]	620	!!======================================================================
[2496]	621	END MODULE nemogcm
[4354]	622

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

Download in other formats: