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.

trcnam.F90 in trunk/NEMOGCM/NEMO/TOP_SRC – NEMO

Context Navigation

source: trunk/NEMOGCM/NEMO/TOP_SRC/trcnam.F90 @ 3294

Last change on this file since 3294 was 3294, checked in by rblod, 12 years ago
Merge of 3.4beta into the trunk
Property svn:keywords set to `Id`
File size: 11.6 KB

Rev	Line
[2038]	1	MODULE trcnam
	2	!!======================================================================
	3	!! * MODULE trcnam *
	4	!! TOP : Read and print options for the passive tracer run (namelist)
	5	!!======================================================================
	6	!! History : - ! 1996-11 (M.A. Foujols, M. Levy) original code
	7	!! - ! 1998-04 (M.A Foujols, L. Bopp) ahtrb0 for isopycnal mixing
	8	!! - ! 1999-10 (M.A. Foujols, M. Levy) separation of sms
	9	!! - ! 2000-07 (A. Estublier) add TVD and MUSCL : Tests on ndttrc
	10	!! - ! 2000-11 (M.A Foujols, E Kestenare) trcrat, ahtrc0 and aeivtr0
	11	!! - ! 2001-01 (E Kestenare) suppress ndttrc=1 for CEN2 and TVD schemes
	12	!! 1.0 ! 2005-03 (O. Aumont, A. El Moussaoui) F90
	13	!!----------------------------------------------------------------------
	14	#if defined key_top
	15	!!----------------------------------------------------------------------
	16	!! 'key_top' TOP models
	17	!!----------------------------------------------------------------------
	18	!! trc_nam : Read and print options for the passive tracer run (namelist)
	19	!!----------------------------------------------------------------------
[3294]	20	USE oce_trc ! shared variables between ocean and passive tracers
	21	USE trc ! passive tracers common variables
[2038]	22	USE trcnam_trp ! Transport namelist
	23	USE trcnam_lobster ! LOBSTER namelist
	24	USE trcnam_pisces ! PISCES namelist
	25	USE trcnam_cfc ! CFC SMS namelist
	26	USE trcnam_c14b ! C14 SMS namelist
	27	USE trcnam_my_trc ! MY_TRC SMS namelist
[3294]	28	USE trdmod_oce
[2038]	29	USE trdmod_trc_oce
[3294]	30	USE iom ! I/O manager
[2038]	31
	32	IMPLICIT NONE
	33	PRIVATE
	34
	35	PUBLIC trc_nam ! called in trcini
	36
	37	!! * Substitutions
	38	# include "top_substitute.h90"
	39	!!----------------------------------------------------------------------
[2287]	40	!! NEMO/TOP 3.3 , NEMO Consortium (2010)
[2281]	41	!! $Id$
[2287]	42	!! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
[2038]	43	!!----------------------------------------------------------------------
	44
	45	CONTAINS
	46
	47	SUBROUTINE trc_nam
	48	!!---------------------------------------------------------------------
	49	!! * ROUTINE trc_nam *
	50	!!
	51	!! ** Purpose : READ and PRINT options for the passive tracer run (namelist)
	52	!!
	53	!! ** Method : - read passive tracer namelist
	54	!! - read namelist of each defined SMS model
	55	!! ( (LOBSTER, PISCES, CFC, MY_TRC )
	56	!!---------------------------------------------------------------------
[3294]	57	INTEGER :: jn, ierr
[2038]	58	! Definition of a tracer as a structure
[3294]	59	TYPE(PTRACER), DIMENSION(jptra) :: sn_tracer ! type of tracer for saving if not key_iomput
[2038]	60	!!
[3294]	61	NAMELIST/namtrc/ nn_dttrc, nn_writetrc, ln_rsttr, nn_rsttr, &
	62	& cn_trcrst_in, cn_trcrst_out, sn_tracer, ln_trcdta
[2038]	63	#if defined key_trdmld_trc \|\| defined key_trdtrc
	64	NAMELIST/namtrc_trd/ nn_trd_trc, nn_ctls_trc, rn_ucf_trc, &
[3294]	65	& ln_trdmld_trc_restart, ln_trdmld_trc_instant, &
	66	& cn_trdrst_trc_in, cn_trdrst_trc_out, ln_trdtrc
[2038]	67	#endif
[3294]	68	NAMELIST/namtrc_dia/ ln_diatrc, ln_diabio, nn_writedia, nn_writebio
[2038]	69
	70	!!---------------------------------------------------------------------
	71
	72	IF(lwp) WRITE(numout,*) 'trc_nam : read the passive tracer namelists'
	73	IF(lwp) WRITE(numout,*) '~~~~~~~'
	74
	75	CALL ctl_opn( numnat, 'namelist_top', 'OLD', 'FORMATTED', 'SEQUENTIAL', 1, numout, .FALSE. )
	76
	77	! Namelist nattrc (files)
	78	! ----------------------------------------------
[3294]	79	nn_dttrc = 1 ! default values
	80	nn_writetrc = 10
	81	ln_rsttr = .FALSE.
	82	nn_rsttr = 0
[2038]	83	cn_trcrst_in = 'restart_trc'
	84	cn_trcrst_out = 'restart_trc'
[3294]	85	!
[2038]	86	DO jn = 1, jptra
[3294]	87	WRITE( sn_tracer(jn)%clsname,'("TR_",I1)' ) jn
	88	WRITE( sn_tracer(jn)%cllname,'("TRACER NUMBER ",I1)') jn
	89	sn_tracer(jn)%clunit = 'mmole/m3'
	90	sn_tracer(jn)%llinit = .FALSE.
	91	sn_tracer(jn)%llsave = .TRUE.
[2038]	92	END DO
[3294]	93	ln_trcdta = .FALSE.
[2038]	94
[3294]	95
[2038]	96	REWIND( numnat ) ! read nattrc
	97	READ ( numnat, namtrc )
	98
	99	DO jn = 1, jptra
[3294]	100	ctrcnm (jn) = TRIM( sn_tracer(jn)%clsname )
	101	ctrcln (jn) = TRIM( sn_tracer(jn)%cllname )
	102	ctrcun (jn) = TRIM( sn_tracer(jn)%clunit )
	103	ln_trc_ini(jn) = sn_tracer(jn)%llinit
	104	ln_trc_wri(jn) = sn_tracer(jn)%llsave
[2038]	105	END DO
	106
[3294]	107	!!KPE computes the first time step of tracer model
	108	nittrc000 = nit000 + nn_dttrc - 1
	109
[2038]	110
	111	IF(lwp) THEN ! control print
	112	WRITE(numout,*)
	113	WRITE(numout,*) ' Namelist : namtrc'
[3294]	114	WRITE(numout,*) ' time step freq. for passive tracer nn_dttrc = ', nn_dttrc
	115	WRITE(numout,*) ' restart for passive tracer ln_rsttr = ', ln_rsttr
	116	WRITE(numout,*) ' control of time step for passive tracer nn_rsttr = ', nn_rsttr
	117	WRITE(numout,*) ' first time step for pass. trac. nittrc000 = ', nittrc000
	118	WRITE(numout,*) ' frequency of outputs for passive tracers nn_writetrc = ', nn_writetrc
	119	WRITE(numout,*) ' Read inputs data from file ln_trcdta = ', ln_trcdta
[2038]	120	WRITE(numout,*) ' '
	121	DO jn = 1, jptra
[3294]	122	WRITE(numout,*) ' tracer nb : ', jn, ' short name : ', ctrcnm(jn)
[2038]	123	END DO
[3294]	124	WRITE(numout,*) ' '
[2038]	125	ENDIF
	126
[2517]	127	rdttrc(:) = rdttra(:) * FLOAT( nn_dttrc ) ! vertical profile of passive tracer time-step
	128
[3294]	129	IF(lwp) THEN ! control print
	130	WRITE(numout,*)
	131	WRITE(numout,*) ' Passive Tracer time step rdttrc = ', rdttrc(1)
	132	WRITE(numout,*)
	133	ENDIF
[2517]	134
[3294]	135	ln_diatrc = .FALSE.
	136	ln_diabio = .FALSE.
	137	nn_writedia = 10
	138	nn_writebio = 10
[2038]	139
	140	REWIND( numnat ) ! namelist namtoptrd : passive tracer trends diagnostic
[3294]	141	READ ( numnat, namtrc_dia )
[2038]	142
[3294]	143	IF(lwp) THEN
[2038]	144	WRITE(numout,*)
[3294]	145	WRITE(numout,*)
	146	WRITE(numout,*) ' Namelist : namtrc_dia'
	147	WRITE(numout,*) ' save additionnal diagnostics arrays ln_diatrc = ', ln_diatrc
	148	WRITE(numout,*) ' save additionnal biology diagnostics arrays ln_diabio = ', ln_diabio
	149	WRITE(numout,*) ' frequency of outputs for additional arrays nn_writedia = ', nn_writedia
	150	WRITE(numout,*) ' frequency of outputs for biological trends nn_writebio = ', nn_writebio
	151	WRITE(numout,*) ' '
[2038]	152	ENDIF
	153
[3294]	154	IF( ln_diatrc .AND. .NOT. lk_iomput ) THEN
	155	ALLOCATE( trc2d(jpi,jpj,jpdia2d), trc3d(jpi,jpj,jpk,jpdia3d), &
	156	& ctrc2d(jpdia2d), ctrc2l(jpdia2d), ctrc2u(jpdia2d) , &
	157	& ctrc3d(jpdia3d), ctrc3l(jpdia3d), ctrc3u(jpdia3d) , STAT = ierr )
	158	IF( ierr > 0 ) CALL ctl_stop( 'STOP', 'trcnam: unable to allocate add. diag. array' )
	159	ENDIF
	160
	161	IF( ( ln_diabio .AND. .NOT. lk_iomput ) .OR. l_trdtrc ) THEN
	162	ALLOCATE( trbio (jpi,jpj,jpk,jpdiabio) , &
	163	& ctrbio(jpdiabio), ctrbil(jpdiabio), ctrbiu(jpdiabio), STAT = ierr )
	164	IF( ierr > 0 ) CALL ctl_stop( 'STOP', 'trcnam: unable to allocate bio. diag. array' )
	165	ENDIF
	166
[2038]	167	! namelist of transport
	168	! ---------------------
	169	CALL trc_nam_trp
	170
	171
[3294]	172	IF( ln_trcdmp .AND. .NOT.ln_trcdta ) THEN
	173	CALL ctl_warn( 'trc_nam: passive tracer damping requires data from files we set ln_trcdta to TRUE' )
	174	ln_trcdta = .TRUE.
	175	ENDIF
	176	!
	177	IF( ln_rsttr .AND. .NOT.ln_trcdmp .AND. ln_trcdta ) THEN
	178	CALL ctl_warn( 'trc_nam: passive tracer restart and data intialisation, ', &
	179	& 'we keep the restart values and set ln_trcdta to FALSE' )
	180	ln_trcdta = .FALSE.
	181	ENDIF
	182	!
	183	IF( .NOT.ln_trcdta ) THEN
	184	ln_trc_ini(:) = .FALSE.
	185	ENDIF
	186
	187	IF(lwp) THEN ! control print
	188	IF( ln_rsttr ) THEN
	189	WRITE(numout,*)
	190	WRITE(numout,*) ' read a restart file for passive tracer : ', TRIM( cn_trcrst_in )
	191	WRITE(numout,*)
	192	ELSE
	193	IF( .NOT.ln_trcdta ) THEN
	194	WRITE(numout,*)
	195	WRITE(numout,*) ' All the passive tracers are initialised with constant values '
	196	WRITE(numout,*)
	197	ENDIF
	198	ENDIF
	199	ENDIF
	200
	201
	202	#if defined key_trdmld_trc \|\| defined key_trdtrc
	203	nn_trd_trc = 20
	204	nn_ctls_trc = 9
	205	rn_ucf_trc = 1.
	206	ln_trdmld_trc_instant = .TRUE.
	207	ln_trdmld_trc_restart =.FALSE.
	208	cn_trdrst_trc_in = "restart_mld_trc"
	209	cn_trdrst_trc_out = "restart_mld_trc"
	210	ln_trdtrc(:) = .FALSE.
	211
	212	REWIND( numnat ) ! namelist namtoptrd : passive tracer trends diagnostic
	213	READ ( numnat, namtrc_trd )
	214
	215	IF(lwp) THEN
	216	WRITE(numout,*)
	217	WRITE(numout,*) ' trd_mld_trc_init : read namelist namtrc_trd '
	218	WRITE(numout,*) ' ~~~~~~~~~~~~~~~~ '
	219	WRITE(numout,) ' frequency of trends diagnostics nn_trd_trc = ', nn_trd_trc
	220	WRITE(numout,) ' control surface type nn_ctls_trc = ', nn_ctls_trc
	221	WRITE(numout,) ' restart for ML diagnostics ln_trdmld_trc_restart = ', ln_trdmld_trc_restart
	222	WRITE(numout,) ' flag to diagnose trends of '
	223	WRITE(numout,*) ' instantantaneous or mean ML T/S ln_trdmld_trc_instant = ', ln_trdmld_trc_instant
	224	WRITE(numout,) ' unit conversion factor rn_ucf_trc = ', rn_ucf_trc
	225	DO jn = 1, jptra
	226	IF( ln_trdtrc(jn) ) WRITE(numout,*) ' compute ML trends for tracer number :', jn
	227	END DO
	228	ENDIF
	229	#endif
	230
	231
[2038]	232	! namelist of SMS
	233	! ---------------
	234	IF( lk_lobster ) THEN ; CALL trc_nam_lobster ! LOBSTER bio-model
	235	ELSE ; IF(lwp) WRITE(numout,*) ' LOBSTER not used'
	236	ENDIF
	237
	238	IF( lk_pisces ) THEN ; CALL trc_nam_pisces ! PISCES bio-model
	239	ELSE ; IF(lwp) WRITE(numout,*) ' PISCES not used'
	240	ENDIF
	241
	242	IF( lk_cfc ) THEN ; CALL trc_nam_cfc ! CFC tracers
	243	ELSE ; IF(lwp) WRITE(numout,*) ' CFC not used'
	244	ENDIF
	245
	246	IF( lk_c14b ) THEN ; CALL trc_nam_c14b ! C14 bomb tracers
	247	ELSE ; IF(lwp) WRITE(numout,*) ' C14 not used'
	248	ENDIF
	249
	250	IF( lk_my_trc ) THEN ; CALL trc_nam_my_trc ! MY_TRC tracers
	251	ELSE ; IF(lwp) WRITE(numout,*) ' MY_TRC not used'
	252	ENDIF
	253	!
	254	END SUBROUTINE trc_nam
	255
	256	#else
	257	!!----------------------------------------------------------------------
	258	!! Dummy module : No passive tracer
	259	!!----------------------------------------------------------------------
	260	CONTAINS
	261	SUBROUTINE trc_nam ! Empty routine
	262	END SUBROUTINE trc_nam
	263	#endif
	264
[2104]	265	!!----------------------------------------------------------------------
[2287]	266	!! NEMO/TOP 3.3 , NEMO Consortium (2010)
[2281]	267	!! $Id$
[2287]	268	!! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
[2038]	269	!!======================================================================
	270	END MODULE trcnam

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

Download in other formats: