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

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

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

Download in other formats: