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

Context Navigation

source: NEMO/trunk/src/TOP/trcnam.F90 @ 10351

Last change on this file since 10351 was 10068, checked in by nicolasmartin, 6 years ago
First part of modifications to have a common default header : fix typos and SVN keywords properties
Property svn:keywords set to `Id`
File size: 14.4 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	!!----------------------------------------------------------------------
[9169]	20	USE oce_trc ! shared variables between ocean and passive tracers
	21	USE trc ! passive tracers common variables
	22	USE trd_oce !
	23	USE trdtrc_oce !
	24	USE iom ! I/O manager
[2038]	25
	26	IMPLICIT NONE
	27	PRIVATE
	28
[9169]	29	PUBLIC trc_nam_run ! called in trcini
	30	PUBLIC trc_nam ! called in trcini
[2038]	31
[9169]	32	TYPE(PTRACER), DIMENSION(jpmaxtrc), PUBLIC :: sn_tracer !: type of tracer for saving if not key_iomput
[7646]	33
[2038]	34	!!----------------------------------------------------------------------
[10067]	35	!! NEMO/TOP 4.0 , NEMO Consortium (2018)
[5341]	36	!! $Id$
[10068]	37	!! Software governed by the CeCILL license (see ./LICENSE)
[2038]	38	!!----------------------------------------------------------------------
	39	CONTAINS
	40
	41	SUBROUTINE trc_nam
	42	!!---------------------------------------------------------------------
	43	!! * ROUTINE trc_nam *
	44	!!
	45	!! ** Purpose : READ and PRINT options for the passive tracer run (namelist)
	46	!!
	47	!! ** Method : - read passive tracer namelist
	48	!! - read namelist of each defined SMS model
[3680]	49	!! ( (PISCES, CFC, MY_TRC )
[2038]	50	!!---------------------------------------------------------------------
[9169]	51	INTEGER :: jn ! dummy loop indice
	52	!!---------------------------------------------------------------------
[7646]	53	!
	54	IF( .NOT.l_offline ) CALL trc_nam_run ! Parameters of the run
[5836]	55	!
[9169]	56	CALL trc_nam_trc ! passive tracer informations
[5836]	57	!
[9169]	58	IF( ln_rsttr ) ln_trcdta = .FALSE. ! restart : no need of clim data
[4152]	59	!
[9169]	60	IF( ln_trcdmp .OR. ln_trcdmp_clo ) ln_trcdta = .TRUE. ! damping : need to have clim data
[5836]	61	!
[9169]	62	!
[5836]	63	IF(lwp) THEN ! control print
[3294]	64	IF( ln_rsttr ) THEN
	65	WRITE(numout,*)
[9169]	66	WRITE(numout,*) ' ==>>> Read a restart file for passive tracer : ', TRIM( cn_trcrst_in )
[3294]	67	ENDIF
[4148]	68	IF( ln_trcdta .AND. .NOT.ln_rsttr ) THEN
	69	WRITE(numout,*)
[9169]	70	WRITE(numout,*) ' ==>>> Some of the passive tracers are initialised from climatologies '
[4148]	71	ENDIF
	72	IF( .NOT.ln_trcdta ) THEN
	73	WRITE(numout,*)
[9169]	74	WRITE(numout,*) ' ==>>> All the passive tracers are initialised with constant values '
[4148]	75	ENDIF
[3294]	76	ENDIF
[7646]	77	!
	78	rdttrc = rdt * FLOAT( nn_dttrc ) ! passive tracer time-step
	79	!
	80	IF(lwp) THEN ! control print
[4152]	81	WRITE(numout,*)
[9169]	82	WRITE(numout,) ' ==>>> Passive Tracer time step rdttrc = nn_dttrcrdt = ', rdttrc
[4152]	83	ENDIF
[2038]	84	!
[7646]	85	IF( l_trdtrc ) CALL trc_nam_trd ! Passive tracer trends
	86	!
[2038]	87	END SUBROUTINE trc_nam
	88
[5836]	89
[4152]	90	SUBROUTINE trc_nam_run
	91	!!---------------------------------------------------------------------
	92	!! * ROUTINE trc_nam *
	93	!!
	94	!! ** Purpose : read options for the passive tracer run (namelist)
	95	!!
	96	!!---------------------------------------------------------------------
[9169]	97	INTEGER :: ios ! Local integer
	98	!!
[7646]	99	NAMELIST/namtrc_run/ nn_dttrc, ln_rsttr, nn_rsttr, ln_top_euler, &
[5341]	100	& cn_trcrst_indir, cn_trcrst_outdir, cn_trcrst_in, cn_trcrst_out
[4152]	101	!!---------------------------------------------------------------------
[5836]	102	!
[9169]	103	IF(lwp) WRITE(numout,*)
[6140]	104	IF(lwp) WRITE(numout,*) 'trc_nam_run : read the passive tracer namelists'
[9169]	105	IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
	106	!
[4290]	107	CALL ctl_opn( numnat_ref, 'namelist_top_ref' , 'OLD' , 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE. )
	108	CALL ctl_opn( numnat_cfg, 'namelist_top_cfg' , 'OLD' , 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE. )
[4624]	109	IF(lwm) CALL ctl_opn( numont, 'output.namelist.top', 'UNKNOWN', 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE., 1 )
[9169]	110	!
[4152]	111	REWIND( numnat_ref ) ! Namelist namtrc in reference namelist : Passive tracer variables
	112	READ ( numnat_ref, namtrc_run, IOSTAT = ios, ERR = 901)
[9169]	113	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc in reference namelist', lwp )
[4152]	114	REWIND( numnat_cfg ) ! Namelist namtrc in configuration namelist : Passive tracer variables
	115	READ ( numnat_cfg, namtrc_run, IOSTAT = ios, ERR = 902 )
[9169]	116	902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namtrc in configuration namelist', lwp )
	117	IF(lwm) WRITE( numont, namtrc_run )
[4152]	118
[9169]	119	nittrc000 = nit000 + nn_dttrc - 1 ! first time step of tracer model
[4152]	120
	121	IF(lwp) THEN ! control print
[9169]	122	WRITE(numout,*) ' Namelist : namtrc_run'
	123	WRITE(numout,*) ' time step freq. for passive tracer nn_dttrc = ', nn_dttrc
	124	WRITE(numout,*) ' restart for passive tracer ln_rsttr = ', ln_rsttr
	125	WRITE(numout,*) ' control of time step for passive tracer nn_rsttr = ', nn_rsttr
	126	WRITE(numout,*) ' first time step for pass. trac. nittrc000 = ', nittrc000
	127	WRITE(numout,*) ' Use euler integration for TRC (y/n) ln_top_euler = ', ln_top_euler
[4152]	128	ENDIF
	129	!
	130	END SUBROUTINE trc_nam_run
	131
[9169]	132
[4152]	133	SUBROUTINE trc_nam_trc
	134	!!---------------------------------------------------------------------
	135	!! * ROUTINE trc_nam *
	136	!!
	137	!! ** Purpose : read options for the passive tracer run (namelist)
	138	!!
	139	!!---------------------------------------------------------------------
[9169]	140	INTEGER :: ios, ierr, icfc ! Local integer
[4152]	141	!!
[7646]	142	NAMELIST/namtrc/jp_bgc, ln_pisces, ln_my_trc, ln_age, ln_cfc11, ln_cfc12, ln_sf6, ln_c14, &
	143	& sn_tracer, ln_trcdta, ln_trcdmp, ln_trcdmp_clo, jp_dia3d, jp_dia2d
[4152]	144	!!---------------------------------------------------------------------
[7646]	145	! Dummy settings to fill tracers data structure
	146	! ! name ! title ! unit ! init ! sbc ! cbc ! obc !
	147	sn_tracer = PTRACER( 'NONAME' , 'NOTITLE' , 'NOUNIT' , .false. , .false. , .false. , .false.)
	148	!
[4152]	149	IF(lwp) WRITE(numout,*)
[6140]	150	IF(lwp) WRITE(numout,*) 'trc_nam_trc : read the passive tracer namelists'
[9169]	151	IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
[4152]	152
	153	REWIND( numnat_ref ) ! Namelist namtrc in reference namelist : Passive tracer variables
	154	READ ( numnat_ref, namtrc, IOSTAT = ios, ERR = 901)
[9169]	155	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc in reference namelist', lwp )
[4152]	156	REWIND( numnat_cfg ) ! Namelist namtrc in configuration namelist : Passive tracer variables
	157	READ ( numnat_cfg, namtrc, IOSTAT = ios, ERR = 902 )
[9169]	158	902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namtrc in configuration namelist', lwp )
	159	IF(lwm) WRITE( numont, namtrc )
[4152]	160
[7646]	161	! Control settings
	162	IF( ln_pisces .AND. ln_my_trc ) CALL ctl_stop( 'Choose only ONE BGC model - PISCES or MY_TRC' )
	163	IF( .NOT. ln_pisces .AND. .NOT. ln_my_trc ) jp_bgc = 0
	164	ll_cfc = ln_cfc11 .OR. ln_cfc12 .OR. ln_sf6
[5836]	165	!
[7646]	166	jptra = 0
	167	jp_pisces = 0 ; jp_pcs0 = 0 ; jp_pcs1 = 0
	168	jp_my_trc = 0 ; jp_myt0 = 0 ; jp_myt1 = 0
	169	jp_cfc = 0 ; jp_cfc0 = 0 ; jp_cfc1 = 0
	170	jp_age = 0 ; jp_c14 = 0
	171	!
	172	IF( ln_pisces ) THEN
	173	jp_pisces = jp_bgc
	174	jp_pcs0 = 1
	175	jp_pcs1 = jp_pisces
	176	ENDIF
	177	IF( ln_my_trc ) THEN
	178	jp_my_trc = jp_bgc
	179	jp_myt0 = 1
	180	jp_myt1 = jp_my_trc
	181	ENDIF
	182	!
	183	jptra = jp_bgc
	184	!
	185	IF( ln_age ) THEN
	186	jptra = jptra + 1
	187	jp_age = jptra
	188	ENDIF
	189	IF( ln_cfc11 ) jp_cfc = jp_cfc + 1
	190	IF( ln_cfc12 ) jp_cfc = jp_cfc + 1
	191	IF( ln_sf6 ) jp_cfc = jp_cfc + 1
	192	IF( ll_cfc ) THEN
	193	jptra = jptra + jp_cfc
	194	jp_cfc0 = jptra - jp_cfc + 1
	195	jp_cfc1 = jptra
	196	ENDIF
	197	IF( ln_c14 ) THEN
	198	jptra = jptra + 1
	199	jp_c14 = jptra
	200	ENDIF
	201	!
	202	IF( jptra == 0 ) CALL ctl_stop( 'All TOP tracers disabled: change namtrc setting or check if key_top is active' )
	203	!
	204	IF(lwp) THEN ! control print
[9169]	205	WRITE(numout,*) ' Namelist : namtrc'
	206	WRITE(numout,*) ' Total number of passive tracers jptra = ', jptra
	207	WRITE(numout,*) ' Total number of BGC tracers jp_bgc = ', jp_bgc
	208	WRITE(numout,*) ' Simulating PISCES model ln_pisces = ', ln_pisces
	209	WRITE(numout,*) ' Simulating MY_TRC model ln_my_trc = ', ln_my_trc
	210	WRITE(numout,*) ' Simulating water mass age ln_age = ', ln_age
	211	WRITE(numout,*) ' Simulating CFC11 passive tracer ln_cfc11 = ', ln_cfc11
	212	WRITE(numout,*) ' Simulating CFC12 passive tracer ln_cfc12 = ', ln_cfc12
	213	WRITE(numout,*) ' Simulating SF6 passive tracer ln_sf6 = ', ln_sf6
	214	WRITE(numout,*) ' Total number of CFCs tracers jp_cfc = ', jp_cfc
	215	WRITE(numout,*) ' Simulating C14 passive tracer ln_c14 = ', ln_c14
	216	WRITE(numout,*) ' Read inputs data from file (y/n) ln_trcdta = ', ln_trcdta
	217	WRITE(numout,*) ' Damping of passive tracer (y/n) ln_trcdmp = ', ln_trcdmp
	218	WRITE(numout,*) ' Restoring of tracer on closed seas ln_trcdmp_clo = ', ln_trcdmp_clo
[7646]	219	ENDIF
	220	!
	221	IF( ll_cfc .OR. ln_c14 ) THEN
	222	! ! Open namelist files
	223	CALL ctl_opn( numtrc_ref, 'namelist_trc_ref' , 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE. )
	224	CALL ctl_opn( numtrc_cfg, 'namelist_trc_cfg' , 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE. )
	225	IF(lwm) CALL ctl_opn( numonr, 'output.namelist.trc', 'UNKNOWN', 'FORMATTED', 'SEQUENTIAL', -1, numout, .FALSE. )
	226	!
	227	ENDIF
[9169]	228	!
[5836]	229	END SUBROUTINE trc_nam_trc
[4152]	230
[9169]	231
[7646]	232	SUBROUTINE trc_nam_trd
[4152]	233	!!---------------------------------------------------------------------
	234	!! * ROUTINE trc_nam_dia *
	235	!!
	236	!! ** Purpose : read options for the passive tracer diagnostics
	237	!!
	238	!! ** Method : - read passive tracer namelist
	239	!! - read namelist of each defined SMS model
	240	!! ( (PISCES, CFC, MY_TRC )
	241	!!---------------------------------------------------------------------
[7646]	242	#if defined key_trdmxl_trc \|\| defined key_trdtrc
[9169]	243	INTEGER :: ios, ierr ! Local integer
[5836]	244	!!
[4152]	245	NAMELIST/namtrc_trd/ nn_trd_trc, nn_ctls_trc, rn_ucf_trc, &
[4990]	246	& ln_trdmxl_trc_restart, ln_trdmxl_trc_instant, &
[4152]	247	& cn_trdrst_trc_in, cn_trdrst_trc_out, ln_trdtrc
	248	!!---------------------------------------------------------------------
[9169]	249	!
[4152]	250	IF(lwp) WRITE(numout,*)
[7646]	251	IF(lwp) WRITE(numout,*) 'trc_nam_trd : read the passive tracer diagnostics options'
[9169]	252	IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
[7646]	253	!
	254	ALLOCATE( ln_trdtrc(jptra) )
	255	!
	256	REWIND( numnat_ref ) ! Namelist namtrc_trd in reference namelist : Passive tracer trends
	257	READ ( numnat_ref, namtrc_trd, IOSTAT = ios, ERR = 905)
[9169]	258	905 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_trd in reference namelist', lwp )
[7646]	259	REWIND( numnat_cfg ) ! Namelist namtrc_trd in configuration namelist : Passive tracer trends
	260	READ ( numnat_cfg, namtrc_trd, IOSTAT = ios, ERR = 906 )
[9169]	261	906 IF( ios > 0 ) CALL ctl_nam ( ios , 'namtrc_trd in configuration namelist', lwp )
	262	IF(lwm) WRITE( numont, namtrc_trd )
[4152]	263
	264	IF(lwp) THEN
[9169]	265	WRITE(numout,*) ' Namelist : namtrc_trd '
	266	WRITE(numout,*) ' frequency of trends diagnostics nn_trd_trc = ', nn_trd_trc
	267	WRITE(numout,*) ' control surface type nn_ctls_trc = ', nn_ctls_trc
	268	WRITE(numout,*) ' restart for ML diagnostics ln_trdmxl_trc_restart = ', ln_trdmxl_trc_restart
	269	WRITE(numout,*) ' instantantaneous or mean trends ln_trdmxl_trc_instant = ', ln_trdmxl_trc_instant
	270	WRITE(numout,*) ' unit conversion factor rn_ucf_trc = ', rn_ucf_trc
[7646]	271	DO jn = 1, jptra
[9169]	272	IF( ln_trdtrc(jn) ) WRITE(numout,*) ' compute ML trends for tracer number :', jn
[7646]	273	END DO
[4152]	274	ENDIF
[7646]	275	#endif
[4152]	276	!
[7646]	277	END SUBROUTINE trc_nam_trd
[4152]	278
[2038]	279	#else
	280	!!----------------------------------------------------------------------
	281	!! Dummy module : No passive tracer
	282	!!----------------------------------------------------------------------
	283	CONTAINS
	284	SUBROUTINE trc_nam ! Empty routine
	285	END SUBROUTINE trc_nam
[4152]	286	SUBROUTINE trc_nam_run ! Empty routine
	287	END SUBROUTINE trc_nam_run
[2038]	288	#endif
	289
	290	!!======================================================================
[5656]	291	END MODULE trcnam

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

Download in other formats: