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/trunk/src/OCE – NEMO

Context Navigation

source: NEMO/trunk/src/OCE/nemogcm.F90 @ 13237

Last change on this file since 13237 was 13237, checked in by smasson, 4 years ago
trunk: Mid-year merge, merge back KERNEL-06_techene_e3
Property svn:keywords set to `Id`
File size: 35.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
[13237]	62	#if defined key_qco
	63	USE stepMLF ! NEMO time-stepping (stp_MLF routine)
	64	#else
[6140]	65	USE step ! NEMO time-stepping (stp routine)
[13237]	66	#endif
[12377]	67	USE isfstp ! ice shelf (isf_stp_init routine)
[6140]	68	USE icbini ! handle bergs, initialisation
	69	USE icbstp ! handle bergs, calving, themodynamics and transport
	70	USE cpl_oasis3 ! OASIS3 coupling
	71	USE c1d ! 1D configuration
	72	USE step_c1d ! Time stepping loop for the 1D configuration
	73	USE dyndmp ! Momentum damping
	74	USE stopar ! Stochastic param.: ???
	75	USE stopts ! Stochastic param.: ???
[12377]	76	USE diu_layers ! diurnal bulk SST and coolskin
[7646]	77	USE step_diu ! diurnal bulk SST timestepping (called from here if run offline)
	78	USE crsini ! initialise grid coarsening utility
[12214]	79	USE dia25h ! 25h mean output
[12377]	80	USE diadetide ! Weights computation for daily detiding of model diagnostics
[7646]	81	USE sbc_oce , ONLY : lk_oasis
	82	USE wet_dry ! Wetting and drying setting (wad_init routine)
[1594]	83	#if defined key_top
[6140]	84	USE trcini ! passive tracer initialisation
[1594]	85	#endif
[7646]	86	#if defined key_nemocice_decomp
	87	USE ice_domain_size, only: nx_global, ny_global
	88	#endif
	89	!
[12641]	90	USE in_out_manager ! I/O manager
[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	! !-----------------------!
[2715]	147	#if defined key_agrif
[12377]	148	Kbb_a = Nbb; Kmm_a = Nnn; Krhs_a = Nrhs ! agrif_oce module copies of time level indices
[13216]	149	CALL Agrif_Declare_Var ! " " " " " DYN/TRA
[2715]	150	# if defined key_top
[3680]	151	CALL Agrif_Declare_Var_top ! " " " " " TOP
[2715]	152	# endif
	153	#endif
[682]	154	! check that all process are still there... If some process have an error,
	155	! they will never enter in step and other processes will wait until the end of the cpu time!
[10425]	156	CALL mpp_max( 'nemogcm', nstop )
[682]	157
[1593]	158	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
	159
	160	! !-----------------------!
	161	! !== time stepping ==!
	162	! !-----------------------!
[12489]	163	!
	164	! !== set the model time-step ==!
	165	!
[900]	166	istp = nit000
[9210]	167	!
[2236]	168	#if defined key_c1d
[9210]	169	DO WHILE ( istp <= nitend .AND. nstop == 0 ) !== C1D time-stepping ==!
	170	CALL stp_c1d( istp )
	171	istp = istp + 1
	172	END DO
[2236]	173	#else
[9210]	174	!
	175	# if defined key_agrif
	176	! !== AGRIF time-stepping ==!
	177	CALL Agrif_Regrid()
[9213]	178	!
[9780]	179	! Recursive update from highest nested level to lowest:
[12377]	180	Kbb_a = Nbb; Kmm_a = Nnn; Krhs_a = Nrhs ! agrif_oce module copies of time level indices
[9780]	181	CALL Agrif_step_child_adj(Agrif_Update_All)
	182	!
[9210]	183	DO WHILE( istp <= nitend .AND. nstop == 0 )
[13237]	184	#if defined key_qco
	185	CALL stp_MLF
	186	#else
[9210]	187	CALL stp
[13237]	188	#endif
[9210]	189	istp = istp + 1
	190	END DO
	191	!
	192	# else
	193	!
	194	IF( .NOT.ln_diurnal_only ) THEN !== Standard time-stepping ==!
	195	!
	196	DO WHILE( istp <= nitend .AND. nstop == 0 )
[11536]	197
[10425]	198	ncom_stp = istp
[11536]	199	IF( ln_timing ) THEN
	200	zstptiming = MPI_Wtime()
	201	IF ( istp == ( nit000 + 1 ) ) elapsed_time = zstptiming
	202	IF ( istp == nitend ) elapsed_time = zstptiming - elapsed_time
	203	ENDIF
	204
[13237]	205	#if defined key_qco
	206	CALL stp_MLF ( istp )
	207	#else
[9210]	208	CALL stp ( istp )
[13237]	209	#endif
[389]	210	istp = istp + 1
[11536]	211
	212	IF( lwp .AND. ln_timing ) WRITE(numtime,*) 'timing step ', istp-1, ' : ', MPI_Wtime() - zstptiming
	213
[389]	214	END DO
[9210]	215	!
	216	ELSE !== diurnal SST time-steeping only ==!
	217	!
	218	DO WHILE( istp <= nitend .AND. nstop == 0 )
	219	CALL stp_diurnal( istp ) ! time step only the diurnal SST
	220	istp = istp + 1
	221	END DO
	222	!
	223	ENDIF
	224	!
	225	# endif
	226	!
[2236]	227	#endif
[9210]	228	!
[6140]	229	IF( ln_diaobs ) CALL dia_obs_wri
[3609]	230	!
	231	IF( ln_icebergs ) CALL icb_end( nitend )
[3764]	232
[1593]	233	! !------------------------!
	234	! !== finalize the run ==!
	235	! !------------------------!
[7646]	236	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
[1593]	237	!
[7646]	238	IF( nstop /= 0 .AND. lwp ) THEN ! error print
[11536]	239	WRITE(ctmp1,*) ' ==>>> nemo_gcm: a total of ', nstop, ' errors have been found'
[12933]	240	IF( ngrdstop > 0 ) THEN
	241	WRITE(ctmp9,'(i2)') ngrdstop
[13011]	242	WRITE(ctmp2,*) ' E R R O R detected in Agrif grid '//TRIM(ctmp9)
	243	WRITE(ctmp3,) ' Look for "E R R O R" messages in all existing '//TRIM(ctmp9)//'_ocean_output files'
	244	CALL ctl_stop( ' ', ctmp1, ' ', ctmp2, ' ', ctmp3 )
[12933]	245	ELSE
[13011]	246	WRITE(ctmp2,) ' Look for "E R R O R" messages in all existing ocean_output files'
	247	CALL ctl_stop( ' ', ctmp1, ' ', ctmp2 )
[12933]	248	ENDIF
[389]	249	ENDIF
[1593]	250	!
[9124]	251	IF( ln_timing ) CALL timing_finalize
[3294]	252	!
[2496]	253	CALL nemo_closefile
[4990]	254	!
[3769]	255	#if defined key_iomput
[9210]	256	CALL xios_finalize ! end mpp communications with xios
	257	IF( lk_oasis ) CALL cpl_finalize ! end coupling and mpp communications with OASIS
[532]	258	#else
[9210]	259	IF ( lk_oasis ) THEN ; CALL cpl_finalize ! end coupling and mpp communications with OASIS
[13011]	260	ELSEIF( lk_mpp ) THEN ; CALL mppstop ! end mpp communications
[4990]	261	ENDIF
[532]	262	#endif
[900]	263	!
[10436]	264	IF(lwm) THEN
	265	IF( nstop == 0 ) THEN ; STOP 0
[11536]	266	ELSE ; STOP 123
[10436]	267	ENDIF
[10425]	268	ENDIF
	269	!
[2496]	270	END SUBROUTINE nemo_gcm
[389]	271
	272
[2496]	273	SUBROUTINE nemo_init
[389]	274	!!----------------------------------------------------------------------
[2496]	275	!! * ROUTINE nemo_init *
[389]	276	!!
[2496]	277	!! ** Purpose : initialization of the NEMO GCM
[389]	278	!!----------------------------------------------------------------------
[11536]	279	INTEGER :: ios, ilocal_comm ! local integers
[9213]	280	!!
[12377]	281	NAMELIST/namctl/ sn_cfctl, nn_print, nn_ictls, nn_ictle, &
[10570]	282	& nn_isplt , nn_jsplt, nn_jctls, nn_jctle, &
[9019]	283	& ln_timing, ln_diacfl
[9213]	284	NAMELIST/namcfg/ ln_read_cfg, cn_domcfg, ln_closea, ln_write_cfg, cn_domcfg_out, ln_use_jattr
[3]	285	!!----------------------------------------------------------------------
[1593]	286	!
[5407]	287	cxios_context = 'nemo'
[2496]	288	!
[11536]	289	! !-------------------------------------------------!
	290	! ! set communicator & select the local rank !
	291	! ! must be done as soon as possible to get narea !
	292	! !-------------------------------------------------!
[1593]	293	!
[1412]	294	#if defined key_iomput
[2200]	295	IF( Agrif_Root() ) THEN
[5407]	296	IF( lk_oasis ) THEN
[7646]	297	CALL cpl_init( "oceanx", ilocal_comm ) ! nemo local communicator given by oasis
[11536]	298	CALL xios_initialize( "not used" , local_comm =ilocal_comm ) ! send nemo communicator to xios
[4990]	299	ELSE
[11536]	300	CALL xios_initialize( "for_xios_mpi_id", return_comm=ilocal_comm ) ! nemo local communicator given by xios
[4990]	301	ENDIF
[2200]	302	ENDIF
[11536]	303	CALL mpp_start( ilocal_comm )
[532]	304	#else
[5407]	305	IF( lk_oasis ) THEN
[4990]	306	IF( Agrif_Root() ) THEN
[7646]	307	CALL cpl_init( "oceanx", ilocal_comm ) ! nemo local communicator given by oasis
[4990]	308	ENDIF
[11536]	309	CALL mpp_start( ilocal_comm )
[4990]	310	ELSE
[11536]	311	CALL mpp_start( )
[2236]	312	ENDIF
[532]	313	#endif
[11536]	314	!
	315	narea = mpprank + 1 ! mpprank: the rank of proc (0 --> mppsize -1 )
	316	lwm = (narea == 1) ! control of output namelists
	317	!
	318	! !---------------------------------------------------------------!
	319	! ! Open output files, reference and configuration namelist files !
	320	! !---------------------------------------------------------------!
	321	!
	322	! open ocean.output as soon as possible to get all output prints (including errors messages)
	323	IF( lwm ) CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
	324	! open reference and configuration namelist files
[12377]	325	CALL load_nml( numnam_ref, 'namelist_ref', -1, lwm )
	326	CALL load_nml( numnam_cfg, 'namelist_cfg', -1, lwm )
[11536]	327	IF( lwm ) CALL ctl_opn( numond, 'output.namelist.dyn', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
	328	! open /dev/null file to be able to supress output write easily
[12641]	329	IF( Agrif_Root() ) THEN
[11536]	330	CALL ctl_opn( numnul, '/dev/null', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
[12641]	331	#ifdef key_agrif
	332	ELSE
	333	numnul = Agrif_Parent(numnul)
	334	#endif
	335	ENDIF
[11536]	336	! !--------------------!
[12377]	337	! ! Open listing units ! -> need sn_cfctl from namctl to define lwp
[11536]	338	! !--------------------!
	339	!
	340	READ ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
	341	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in reference namelist' )
	342	READ ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
	343	902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namctl in configuration namelist' )
	344	!
[12377]	345	! finalize the definition of namctl variables
[12933]	346	IF( narea < sn_cfctl%procmin .OR. narea > sn_cfctl%procmax .OR. MOD( narea - sn_cfctl%procmin, sn_cfctl%procincr ) /= 0 ) &
	347	& CALL nemo_set_cfctl( sn_cfctl, .FALSE. )
[11536]	348	!
[12377]	349	lwp = (narea == 1) .OR. sn_cfctl%l_oceout ! control of all listing output print
	350	!
[11536]	351	IF(lwp) THEN ! open listing units
[1593]	352	!
[11536]	353	IF( .NOT. lwm ) & ! alreay opened for narea == 1
	354	& CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE., narea )
[1593]	355	!
[1579]	356	WRITE(numout,*)
[11536]	357	WRITE(numout,*) ' CNRS - NERC - Met OFFICE - MERCATOR-ocean - CMCC'
[1593]	358	WRITE(numout,*) ' NEMO team'
[1579]	359	WRITE(numout,*) ' Ocean General Circulation Model'
[10510]	360	WRITE(numout,*) ' NEMO version 4.0 (2019) '
[1579]	361	WRITE(numout,*)
[10510]	362	WRITE(numout,*) " ._ ._ ._ ._ ._ "
	363	WRITE(numout,*) " _.-._)`\_.-._)`\_.-._)`\_.-._)`\_.-._)`\_ "
[1579]	364	WRITE(numout,*)
[10510]	365	WRITE(numout,*) " o _, _, "
	366	WRITE(numout,*) " o .' ( .-' / "
	367	WRITE(numout,*) " o _/..._'. .' / "
	368	WRITE(numout,*) " ( o .-'` ` '-./ _.' "
	369	WRITE(numout,*) " ) ( o) ;= <_ ( "
	370	WRITE(numout,*) " ( '-.,\\__ __.-;`\ '. ) "
	371	WRITE(numout,*) " ) ) \) \|`\ \) '. \ ( ( "
	372	WRITE(numout,*) " ( ( \_/ '-._\ ) ) "
[10583]	373	WRITE(numout,*) " ) ) jgs ` ( ( "
[10510]	374	WRITE(numout,*) " ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ "
	375	WRITE(numout,*)
[13226]	376
	377	! Print the working precision to ocean.output
	378	IF (wp == dp) THEN
	379	WRITE(numout,*) "Working precision = double-precision"
	380	ELSE
	381	WRITE(numout,*) "Working precision = single-precision"
	382	ENDIF
	383	WRITE(numout,*)
[1593]	384	!
[7646]	385	WRITE(numout,cform_aaa) ! Flag AAAAAAA
	386	!
[473]	387	ENDIF
[10425]	388	!
[11536]	389	IF(lwm) WRITE( numond, namctl )
	390	!
	391	! !------------------------------------!
	392	! ! Set global domain size parameters !
	393	! !------------------------------------!
	394	!
	395	READ ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
	396	903 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in reference namelist' )
	397	READ ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
	398	904 IF( ios > 0 ) CALL ctl_nam ( ios , 'namcfg in configuration namelist' )
	399	!
	400	IF( ln_read_cfg ) THEN ! Read sizes in domain configuration file
	401	CALL domain_cfg ( cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
	402	ELSE ! user-defined namelist
	403	CALL usr_def_nam( cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
	404	ENDIF
	405	!
	406	IF(lwm) WRITE( numond, namcfg )
	407	!
	408	! !-----------------------------------------!
	409	! ! mpp parameters and domain decomposition !
	410	! !-----------------------------------------!
	411	CALL mpp_init
[2715]	412
[7646]	413	! Now we know the dimensions of the grid and numout has been set: we can allocate arrays
[2715]	414	CALL nemo_alloc()
	415
[12377]	416	! Initialise time level indices
	417	Nbb = 1; Nnn = 2; Naa = 3; Nrhs = Naa
[13216]	418	#if defined key_agrif
	419	Kbb_a = Nbb; Kmm_a = Nnn; Krhs_a = Nrhs ! agrif_oce module copies of time level indices
	420	#endif
[2496]	421	! !-------------------------------!
	422	! ! NEMO general initialization !
	423	! !-------------------------------!
[473]	424
[7646]	425	CALL nemo_ctl ! Control prints
[2382]	426	!
[9213]	427	! ! General initialization
	428	IF( ln_timing ) CALL timing_init ! timing
	429	IF( ln_timing ) CALL timing_start( 'nemo_init')
[3294]	430	!
[9367]	431	CALL phy_cst ! Physical constants
	432	CALL eos_init ! Equation of state
	433	IF( lk_c1d ) CALL c1d_init ! 1D column configuration
	434	CALL wad_init ! Wetting and drying options
[13216]	435
	436	#if defined key_agrif
	437	CALL Agrif_Declare_Var_ini ! " " " " " DOM
	438	#endif
[12377]	439	CALL dom_init( Nbb, Nnn, Naa, "OPA") ! Domain
	440	IF( ln_crs ) CALL crs_init( Nnn ) ! coarsened grid: domain initialization
	441	IF( sn_cfctl%l_prtctl ) &
	442	& CALL prt_ctl_init ! Print control
[6140]	443
[12377]	444	CALL diurnal_sst_bulk_init ! diurnal sst
[9213]	445	IF( ln_diurnal ) CALL diurnal_sst_coolskin_init ! cool skin
	446	!
[12377]	447	IF( ln_diurnal_only ) THEN ! diurnal only: a subset of the initialisation routines
	448	CALL istate_init( Nbb, Nnn, Naa ) ! ocean initial state (Dynamics and tracers)
	449	CALL sbc_init( Nbb, Nnn, Naa ) ! Forcings : surface module
	450	CALL tra_qsr_init ! penetrative solar radiation qsr
	451	IF( ln_diaobs ) THEN ! Observation & model comparison
	452	CALL dia_obs_init( Nnn ) ! Initialize observational data
	453	CALL dia_obs( nit000 - 1, Nnn ) ! Observation operator for restart
[6140]	454	ENDIF
[12377]	455	IF( lk_asminc ) CALL asm_inc_init( Nbb, Nnn, Nrhs ) ! Assimilation increments
[9213]	456	!
	457	RETURN ! end of initialization
[6140]	458	ENDIF
[12377]	459	!
[13216]	460
[12377]	461	CALL istate_init( Nbb, Nnn, Naa ) ! ocean initial state (Dynamics and tracers)
[3651]	462
[5836]	463	! ! external forcing
[12377]	464	CALL tide_init ! tidal harmonics
	465	CALL sbc_init( Nbb, Nnn, Naa ) ! surface boundary conditions (including sea-ice)
	466	CALL bdy_init ! Open boundaries initialisation
[9019]	467
[5836]	468	! ! Ocean physics
[12377]	469	CALL zdf_phy_init( Nnn ) ! Vertical physics
[9019]	470
[2082]	471	! ! Lateral physics
[9019]	472	CALL ldf_tra_init ! Lateral ocean tracer physics
	473	CALL ldf_eiv_init ! eddy induced velocity param.
	474	CALL ldf_dyn_init ! Lateral ocean momentum physics
[2082]	475
[9019]	476	! ! Active tracers
	477	IF( ln_traqsr ) CALL tra_qsr_init ! penetrative solar radiation qsr
	478	CALL tra_bbc_init ! bottom heat flux
[10350]	479	CALL tra_bbl_init ! advective (and/or diffusive) bottom boundary layer scheme
[9019]	480	CALL tra_dmp_init ! internal tracer damping
	481	CALL tra_adv_init ! horizontal & vertical advection
	482	CALL tra_ldf_init ! lateral mixing
[2027]	483
[9019]	484	! ! Dynamics
[12377]	485	IF( lk_c1d ) CALL dyn_dmp_init ! internal momentum damping
	486	CALL dyn_adv_init ! advection (vector or flux form)
	487	CALL dyn_vor_init ! vorticity term including Coriolis
	488	CALL dyn_ldf_init ! lateral mixing
	489	CALL dyn_hpg_init( Nnn ) ! horizontal gradient of Hydrostatic pressure
	490	CALL dyn_spg_init ! surface pressure gradient
[3764]	491
[5836]	492	#if defined key_top
	493	! ! Passive tracers
[12377]	494	CALL trc_init( Nbb, Nnn, Naa )
[5836]	495	#endif
[9019]	496	IF( l_ldfslp ) CALL ldf_slp_init ! slope of lateral mixing
[5836]	497
	498	! ! Icebergs
[12489]	499	CALL icb_init( rn_Dt, nit000) ! initialise icebergs instance
[5836]	500
[12377]	501	! ice shelf
	502	CALL isf_init( Nbb, Nnn, Naa )
	503
[5836]	504	! ! Misc. options
[9019]	505	CALL sto_par_init ! Stochastic parametrization
	506	IF( ln_sto_eos ) CALL sto_pts_init ! RRandom T/S fluctuations
[4147]	507
[5836]	508	! ! Diagnostics
[12377]	509	CALL flo_init( Nnn ) ! drifting Floats
[9019]	510	IF( ln_diacfl ) CALL dia_cfl_init ! Initialise CFL diagnostics
[12377]	511	! CALL dia_ptr_init ! Poleward TRansports initialization
[11536]	512	CALL dia_dct_init ! Sections tranports
[12377]	513	CALL dia_hsb_init( Nnn ) ! heat content, salt content and volume budgets
	514	CALL trd_init( Nnn ) ! Mixed-layer/Vorticity/Integral constraints trends
	515	CALL dia_obs_init( Nnn ) ! Initialize observational data
	516	CALL dia_25h_init( Nbb ) ! 25h mean outputs
	517	CALL dia_detide_init ! Weights computation for daily detiding of model diagnostics
	518	IF( ln_diaobs ) CALL dia_obs( nit000-1, Nnn ) ! Observation operator for restart
	519	CALL dia_mlr_init ! Initialisation of IOM context management for multiple-linear-regression analysis
[6140]	520
[9019]	521	! ! Assimilation increments
[12377]	522	IF( lk_asminc ) CALL asm_inc_init( Nbb, Nnn, Nrhs ) ! Initialize assimilation increments
[1593]	523	!
[9213]	524	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
	525	!
	526	IF( ln_timing ) CALL timing_stop( 'nemo_init')
	527	!
[2496]	528	END SUBROUTINE nemo_init
[467]	529
	530
[2496]	531	SUBROUTINE nemo_ctl
[467]	532	!!----------------------------------------------------------------------
[2496]	533	!! * ROUTINE nemo_ctl *
[467]	534	!!
[3764]	535	!! ** Purpose : control print setting
[467]	536	!!
[11536]	537	!! ** Method : - print namctl and namcfg information and check some consistencies
[467]	538	!!----------------------------------------------------------------------
[2442]	539	!
[2496]	540	IF(lwp) THEN ! control print
[531]	541	WRITE(numout,*)
[7646]	542	WRITE(numout,*) 'nemo_ctl: Control prints'
[9213]	543	WRITE(numout,*) '~~~~~~~~'
[1593]	544	WRITE(numout,*) ' Namelist namctl'
[10570]	545	WRITE(numout,*) ' sn_cfctl%l_runstat = ', sn_cfctl%l_runstat
	546	WRITE(numout,*) ' sn_cfctl%l_trcstat = ', sn_cfctl%l_trcstat
	547	WRITE(numout,*) ' sn_cfctl%l_oceout = ', sn_cfctl%l_oceout
	548	WRITE(numout,*) ' sn_cfctl%l_layout = ', sn_cfctl%l_layout
[12377]	549	WRITE(numout,*) ' sn_cfctl%l_prtctl = ', sn_cfctl%l_prtctl
	550	WRITE(numout,*) ' sn_cfctl%l_prttrc = ', sn_cfctl%l_prttrc
	551	WRITE(numout,*) ' sn_cfctl%l_oasout = ', sn_cfctl%l_oasout
[10570]	552	WRITE(numout,*) ' sn_cfctl%procmin = ', sn_cfctl%procmin
	553	WRITE(numout,*) ' sn_cfctl%procmax = ', sn_cfctl%procmax
	554	WRITE(numout,*) ' sn_cfctl%procincr = ', sn_cfctl%procincr
	555	WRITE(numout,*) ' sn_cfctl%ptimincr = ', sn_cfctl%ptimincr
[1601]	556	WRITE(numout,*) ' level of print nn_print = ', nn_print
	557	WRITE(numout,*) ' Start i indice for SUM control nn_ictls = ', nn_ictls
	558	WRITE(numout,*) ' End i indice for SUM control nn_ictle = ', nn_ictle
	559	WRITE(numout,*) ' Start j indice for SUM control nn_jctls = ', nn_jctls
	560	WRITE(numout,*) ' End j indice for SUM control nn_jctle = ', nn_jctle
	561	WRITE(numout,*) ' number of proc. following i nn_isplt = ', nn_isplt
	562	WRITE(numout,*) ' number of proc. following j nn_jsplt = ', nn_jsplt
[9019]	563	WRITE(numout,*) ' timing by routine ln_timing = ', ln_timing
	564	WRITE(numout,*) ' CFL diagnostics ln_diacfl = ', ln_diacfl
[531]	565	ENDIF
[2442]	566	!
[1601]	567	nprint = nn_print ! convert DOCTOR namelist names into OLD names
	568	nictls = nn_ictls
	569	nictle = nn_ictle
	570	njctls = nn_jctls
	571	njctle = nn_jctle
	572	isplt = nn_isplt
[9213]	573	jsplt = nn_jsplt
[4147]	574
	575	IF(lwp) THEN ! control print
	576	WRITE(numout,*)
	577	WRITE(numout,*) ' Namelist namcfg'
[7646]	578	WRITE(numout,*) ' read domain configuration file ln_read_cfg = ', ln_read_cfg
	579	WRITE(numout,*) ' filename to be read cn_domcfg = ', TRIM(cn_domcfg)
[9213]	580	WRITE(numout,*) ' keep closed seas in the domain (if exist) ln_closea = ', ln_closea
	581	WRITE(numout,*) ' create a configuration definition file ln_write_cfg = ', ln_write_cfg
[7646]	582	WRITE(numout,*) ' filename to be written cn_domcfg_out = ', TRIM(cn_domcfg_out)
	583	WRITE(numout,*) ' use file attribute if exists as i/p j-start ln_use_jattr = ', ln_use_jattr
[4147]	584	ENDIF
[9213]	585	IF( .NOT.ln_read_cfg ) ln_closea = .false. ! dealing possible only with a domcfg file
	586	!
[2442]	587	! ! Parameter control
[1593]	588	!
[12377]	589	IF( sn_cfctl%l_prtctl .OR. sn_cfctl%l_prttrc ) THEN ! sub-domain area indices for the control prints
[3294]	590	IF( lk_mpp .AND. jpnij > 1 ) THEN
[2496]	591	isplt = jpni ; jsplt = jpnj ; ijsplt = jpni*jpnj ! the domain is forced to the real split domain
[531]	592	ELSE
	593	IF( isplt == 1 .AND. jsplt == 1 ) THEN
[1593]	594	CALL ctl_warn( ' - isplt & jsplt are equal to 1', &
	595	& ' - the print control will be done over the whole domain' )
[531]	596	ENDIF
[1593]	597	ijsplt = isplt * jsplt ! total number of processors ijsplt
[531]	598	ENDIF
	599	IF(lwp) WRITE(numout,*)' - The total number of processors over which the'
	600	IF(lwp) WRITE(numout,*)' print control will be done is ijsplt : ', ijsplt
[1593]	601	!
	602	! ! indices used for the SUM control
	603	IF( nictls+nictle+njctls+njctle == 0 ) THEN ! print control done over the default area
[3764]	604	lsp_area = .FALSE.
[1593]	605	ELSE ! print control done over a specific area
[531]	606	lsp_area = .TRUE.
	607	IF( nictls < 1 .OR. nictls > jpiglo ) THEN
	608	CALL ctl_warn( ' - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
	609	nictls = 1
	610	ENDIF
	611	IF( nictle < 1 .OR. nictle > jpiglo ) THEN
	612	CALL ctl_warn( ' - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
	613	nictle = jpiglo
	614	ENDIF
	615	IF( njctls < 1 .OR. njctls > jpjglo ) THEN
	616	CALL ctl_warn( ' - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
	617	njctls = 1
	618	ENDIF
	619	IF( njctle < 1 .OR. njctle > jpjglo ) THEN
	620	CALL ctl_warn( ' - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
	621	njctle = jpjglo
	622	ENDIF
[1593]	623	ENDIF
	624	ENDIF
[2442]	625	!
[9213]	626	IF( 1._wp /= SIGN(1._wp,-0._wp) ) CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows f2003 standard.', &
[10425]	627	& 'Compile with key_nosignedzero enabled:', &
	628	& '--> add -Dkey_nosignedzero to the definition of %CPP in your arch file' )
[3764]	629	!
[9023]	630	#if defined key_agrif
[9124]	631	IF( ln_timing ) CALL ctl_stop( 'AGRIF not implemented with ln_timing = true')
[9023]	632	#endif
	633	!
[2496]	634	END SUBROUTINE nemo_ctl
[467]	635
	636
[2496]	637	SUBROUTINE nemo_closefile
[467]	638	!!----------------------------------------------------------------------
[2496]	639	!! * ROUTINE nemo_closefile *
[467]	640	!!
	641	!! ** Purpose : Close the files
	642	!!----------------------------------------------------------------------
[1593]	643	!
	644	IF( lk_mpp ) CALL mppsync
	645	!
[1685]	646	CALL iom_close ! close all input/output files managed by iom_*
[1593]	647	!
[4147]	648	IF( numstp /= -1 ) CLOSE( numstp ) ! time-step file
[9019]	649	IF( numrun /= -1 ) CLOSE( numrun ) ! run statistics file
[4624]	650	IF( lwm.AND.numond /= -1 ) CLOSE( numond ) ! oce output namelist
	651	IF( lwm.AND.numoni /= -1 ) CLOSE( numoni ) ! ice output namelist
[4147]	652	IF( numevo_ice /= -1 ) CLOSE( numevo_ice ) ! ice variables (temp. evolution)
	653	IF( numout /= 6 ) CLOSE( numout ) ! standard model output file
	654	IF( numdct_vol /= -1 ) CLOSE( numdct_vol ) ! volume transports
	655	IF( numdct_heat /= -1 ) CLOSE( numdct_heat ) ! heat transports
	656	IF( numdct_salt /= -1 ) CLOSE( numdct_salt ) ! salt transports
[1593]	657	!
[2442]	658	numout = 6 ! redefine numout in case it is used after this point...
	659	!
[2496]	660	END SUBROUTINE nemo_closefile
[467]	661
[2715]	662
	663	SUBROUTINE nemo_alloc
	664	!!----------------------------------------------------------------------
	665	!! * ROUTINE nemo_alloc *
	666	!!
	667	!! ** Purpose : Allocate all the dynamic arrays of the OPA modules
	668	!!
	669	!! ** Method :
	670	!!----------------------------------------------------------------------
[9213]	671	USE diawri , ONLY : dia_wri_alloc
	672	USE dom_oce , ONLY : dom_oce_alloc
	673	USE trc_oce , ONLY : trc_oce_alloc
	674	USE bdy_oce , ONLY : bdy_oce_alloc
[2715]	675	!
	676	INTEGER :: ierr
	677	!!----------------------------------------------------------------------
	678	!
[9213]	679	ierr = oce_alloc () ! ocean
	680	ierr = ierr + dia_wri_alloc()
	681	ierr = ierr + dom_oce_alloc() ! ocean domain
	682	ierr = ierr + zdf_oce_alloc() ! ocean vertical physics
	683	ierr = ierr + trc_oce_alloc() ! shared TRC / TRA arrays
	684	ierr = ierr + bdy_oce_alloc() ! bdy masks (incl. initialization)
[2715]	685	!
[10425]	686	CALL mpp_sum( 'nemogcm', ierr )
[9213]	687	IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'nemo_alloc: unable to allocate standard ocean arrays' )
[2715]	688	!
	689	END SUBROUTINE nemo_alloc
	690
[11536]	691
[12933]	692	SUBROUTINE nemo_set_cfctl(sn_cfctl, setto )
[10570]	693	!!----------------------------------------------------------------------
	694	!! * ROUTINE nemo_set_cfctl *
	695	!!
	696	!! ** Purpose : Set elements of the output control structure to setto.
	697	!!
	698	!! ** Method : Note this routine can be used to switch on/off some
[12933]	699	!! types of output for selected areas.
[10570]	700	!!----------------------------------------------------------------------
[12933]	701	TYPE(sn_ctl), INTENT(inout) :: sn_cfctl
	702	LOGICAL , INTENT(in ) :: setto
[10570]	703	!!----------------------------------------------------------------------
[12933]	704	sn_cfctl%l_runstat = setto
	705	sn_cfctl%l_trcstat = setto
[10570]	706	sn_cfctl%l_oceout = setto
	707	sn_cfctl%l_layout = setto
[12377]	708	sn_cfctl%l_prtctl = setto
	709	sn_cfctl%l_prttrc = setto
	710	sn_cfctl%l_oasout = setto
[10570]	711	END SUBROUTINE nemo_set_cfctl
	712
[3]	713	!!======================================================================
[2496]	714	END MODULE nemogcm

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

Download in other formats: