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.
trc.F90 in trunk/NEMO/TOP_SRC – NEMO

source: trunk/NEMO/TOP_SRC/trc.F90 @ 331

Last change on this file since 331 was 274, checked in by opalod, 19 years ago

nemo_v1_update_005:RB: update headers for the TOP component.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 7.6 KB
Line 
1MODULE trc
2   !!======================================================================
3   !!                      ***  MODULE  trc  ***
4   !! Passive tracers   :  module for tracers defined
5   !!======================================================================
6   !! History :
7   !!   8.2  !  96-01  (M. Levy)  Original code
8   !!        !  99-07  (M. Levy)  for LOBSTER1 or NPZD model
9   !!        !  00-04  (O. Aumont, M.A. Foujols)  HAMOCC3 and P3ZD
10   !!   9.0  !  04-03  (C. Ethe)  Free form and module
11   !!----------------------------------------------------------------------
12   !!  TOP 1.0,  LOCEAN-IPSL (2005)
13   !! $Header$
14   !! This software is governed by the CeCILL licence see modipsl/doc/NEMO_CeCILL.txt
15   !!----------------------------------------------------------------------
16#if defined key_passivetrc
17   !!----------------------------------------------------------------------
18   !!   'key_passivetrc'   :                               Passive tracer
19   !!---------------------------------------------------------------------
20   !! * Modules used
21   USE par_oce
22   USE par_trc
23   IMPLICIT NONE
24
25   PUBLIC
26
27
28   !! passive tracers names and units (read in namelist)
29   !! --------------------------------------------------
30   CHARACTER(len=12), PUBLIC, DIMENSION(jptra) :: &
31      ctrcnm  ,   &   !!: tracer name
32      ctrcun          !!: tracer unit
33
34   CHARACTER(len=80), PUBLIC, DIMENSION(jptra) :: &
35      ctrcnl          !!: tracer long name
36   
37   
38   !! parameters for the control of passive tracers
39   !! --------------------------------------------------
40   INTEGER, PUBLIC ::  &
41      numnat          !!: the number of the passive tracer NAMELIST
42   
43   LOGICAL, PUBLIC, DIMENSION(jptra) ::   &
44      lutini          !!:  initialisation from FILE or not (NAMELIST)
45
46   INTEGER , PUBLIC, DIMENSION(jptra) :: &
47      nutini          !!: FORTRAN LOGICAL UNIT for initialisation file
48
49   !! passive tracers fields (before,now,after)
50   !! --------------------------------------------------
51   REAL(wp), PUBLIC  ::  &
52      trai            !!: initial total tracer
53
54   REAL(wp), PUBLIC, DIMENSION (jpi,jpj,jpk,jptra) :: &
55      trn     ,   &   !!: traceur concentration for actual time step
56      tra     ,   &   !!: traceur concentration for next time step
57      trb             !!: traceur concentration for before time step
58
59
60   !! numerical parameter (NAMELIST)
61   !! --------------------------------------------------
62   REAL(wp), PUBLIC  ::  &
63      rsc     ,   &   !!: tuning coefficient for anti-diffusion
64      rtrn            !!: value for truncation
65
66   !! namelist parameters
67   !! --------------------------------------------------
68   INTEGER , PUBLIC  ::  & 
69      ncortrc ,   &   !!: number of corrective phases
70      ndttrc  ,   &   !!: frequency of step on passive tracers
71      nittrc000       !!: first time step of passive tracers model 
72
73   LOGICAL, PUBLIC  ::  & 
74      crosster        !!: logical if true computes crossterms
75
76
77   !! isopycnal scheme for passive tracers
78   !! -------------------------------------------------- 
79   REAL(wp), PUBLIC  ::  &
80      ahtrb0  ,   &   !!: background diffusivity coefficient for passive tracer (m2/s)
81      trcrat  ,   &   !!: ratio between passive and active tracer coeff for diffusion
82      ahtrc0  ,   &   !!: horizontal eddy diffusivity for passive tracers (m2/s)
83      aeivtr0         !!: eddy induced velocity coefficient (m2/s)
84   
85   
86   !! passive tracers restart (input and output)
87   !! -------------------------------------------------- 
88   LOGICAL, PUBLIC  ::  &
89      lrsttr          !!: boolean term for restart i/o for passive tracers (namelist)
90   
91   INTEGER , PUBLIC  ::  &
92      nutwrs  ,   &   !!: output FILE for passive tracers restart
93      nutrst  ,   &   !!: logical unit for restart FILE for passive tracers
94      nrsttr          !!: control of the time step ( 0 or 1 ) for pass. tr.
95   
96#if defined key_partial_steps
97   
98   !! interpolated gradient
99   !!-------------------------------------------------- 
100   REAL (wp), PUBLIC, DIMENSION (jpi,jpj,jptra) :: &
101      gtru    ,   &   !!: horizontal gradient at u-points at bottom ocean level
102      gtrv            !!: horizontal gradient at v-points at bottom ocean level
103#else
104   REAL (wp), PUBLIC :: &
105      gtru    ,   &   !!: horizontal gradient at u-points at bottom ocean level
106      gtrv            !!: horizontal gradient at v-points at bottom ocean level
107   
108#endif
109   
110#if defined key_trcldf_eiv && defined key_diaeiv
111   !! The three component of the eddy induced velocity
112   !! --------------------------------------------------
113   REAL(wp), PUBLIC, DIMENSION (jpi,jpj,jpk) :: &
114      u_trc_eiv,  &   !!: u-eiv (m/s)
115      v_trc_eiv,  &   !!: v-eiv (m/s)
116      w_trc_eiv       !!: w-eiv (m/s)
117#endif
118   
119   
120   !! information for outputs
121   !! --------------------------------------------------
122   INTEGER , PUBLIC   ::  & 
123      nwritetrc       !!: time step frequency for concentration outputs (namelist)
124   
125# if defined key_trc_diaadd
126   !! additional 2D/3D outputs namelist
127   !! --------------------------------------------------
128   CHARACTER(len=8), PUBLIC, DIMENSION (jpdia2d) ::  & 
129      ctrc2d  ,   &   !!: 2d output field name
130      ctrc2u          !!: 2d output field unit
131   
132   CHARACTER(len=8), PUBLIC, DIMENSION (jpdia3d) ::  & 
133      ctrc3d ,    &   !!: 3d output field name
134      ctrc3u          !!: 3d output field unit
135   
136   CHARACTER(len=80), PUBLIC, DIMENSION (jpdia2d) ::  & 
137      ctrc2l          !!: 2d output field long name
138   
139   CHARACTER(len=80), PUBLIC, DIMENSION (jpdia3d) ::  & 
140      ctrc3l          !!: 3d output field long name
141   
142   REAL(wp), PUBLIC, DIMENSION (jpi,jpj,jpdia2d) ::  & 
143      trc2d           !!:  additional 2d outputs 
144   
145   REAL(wp), PUBLIC, DIMENSION (jpi,jpj,jpk,jpdia3d) ::  & 
146      trc3d           !!:  additional 3d outputs 
147   
148   
149   !! netcdf files and index common
150   !! --------------------------------------------------
151   INTEGER , PUBLIC :: &
152      nwriteadd     !!: frequency of additional arrays outputs(namelist)
153#endif
154   
155# if defined key_trc_diatrd
156   
157   !!  non conservative trends (biological, ...)
158   !! --------------------------------------------------
159   LOGICAL, PUBLIC, DIMENSION (jptra)  ::  & 
160      luttrd          !!: large trends diagnostic to write or not (namelist)
161   
162   !!  dynamical trends
163   !! trtrd()   : trends of the tracer equations
164   !!           1 : X advection
165   !!           2 : Y advection
166   !!           3 : Z advection
167   !!           4 : X diffusion
168   !!           5 : Y diffusion
169   !!           6 : Z diffusion
170   !!           7 : X gent velocity
171   !!           8 : Y gent velocity
172   !!           9 : Z gent velocity
173   !! --------------------------------------------------
174   
175   
176   REAL(wp), PUBLIC, DIMENSION(jpi,jpj,jpk,jptra,jpdiatrc) :: &
177      trtrd           !!: trends of the tracer equations
178   
179   !! netcdf files and index common
180   !! --------------------------------------------------
181   INTEGER , PUBLIC :: &
182      nwritetrd       !!: frequency of additional arrays outputs(namelist)
183   
184#endif 
185   
186   !! passive tracers data read and at given time_step
187   !! --------------------------------------------------
188#if defined key_trc_dta
189   
190   INTEGER , PUBLIC, DIMENSION(jptra) :: &
191      numtr          !!: logical unit for passive tracers data
192   
193#endif
194
195   !! Contral/debugging
196   !! -----------------
197   REAL(wp), PUBLIC, DIMENSION(jptra) ::  & 
198      tra_ctl         !!: sum of tra trend
199#else
200   !!======================================================================
201   !!  Empty module : No passive tracer
202   !!======================================================================
203#endif
204
205END MODULE trc
Note: See TracBrowser for help on using the repository browser.