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

source: NEMO/trunk/src/TOP/trc.F90 @ 14558

Last change on this file since 14558 was 14558, checked in by lovato, 3 years ago

include TOP optical module (#2489)
  • Property svn:keywords set to Id
File size: 12.3 KB
Line 
1MODULE trc
2   !!======================================================================
3   !!                      ***  MODULE  trc  ***
4   !! Passive tracers   :  module for tracers defined
5   !!======================================================================
6   !! History :   OPA  !  1996-01  (M. Levy)  Original code
7   !!              -   !  2000-04  (O. Aumont, M.A. Foujols)  HAMOCC3 and P3ZD
8   !!   NEMO      1.0  !  2004-03  (C. Ethe)  Free form and module
9   !!----------------------------------------------------------------------
10   USE par_oce
11   USE par_trc
12   USE bdy_oce, only: jp_bdy, ln_bdy, nb_bdy, OBC_DATA
13   
14   IMPLICIT NONE
15   PUBLIC
16
17   PUBLIC   trc_alloc   ! called by nemogcm.F90
18
19   !                                     !!- logical units of passive tracers
20   INTEGER, PUBLIC ::   numont     = -1   !: reference passive tracer namelist output output.namelist.top
21   INTEGER, PUBLIC ::   numonr     = -1   !: reference passive tracer namelist output output.namelist.top
22   INTEGER, PUBLIC ::   numstr            !: tracer statistics
23   CHARACTER(:), ALLOCATABLE, PUBLIC ::   numnat_ref   !: character buffer for reference passive tracer namelist_top_ref
24   CHARACTER(:), ALLOCATABLE, PUBLIC ::   numnat_cfg   !: character buffer for configuration specific passive tracer namelist_top_cfg
25   CHARACTER(:), ALLOCATABLE, PUBLIC ::   numtrc_ref   !: character buffer for reference passive tracer namelist_trc_ref
26   CHARACTER(:), ALLOCATABLE, PUBLIC ::   numtrc_cfg   !: character buffer for configuration specific passive tracer namelist_trc_cfg
27
28   !! passive tracers fields (before,now,after)
29   !! --------------------------------------------------
30   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:)       ::  trai           !: initial total tracer
31   REAL(wp), PUBLIC                                        ::  areatot        !: total volume
32   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:  ) ::  cvol           !: volume correction -degrad option-
33   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:,:) ::  tr           !: tracer concentration
34   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:  ) ::  sbc_trc_b      !: Before sbc fluxes for tracers
35   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:  ) ::  sbc_trc        !: Now sbc fluxes for tracers
36
37   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:  ) ::  trc_i          !: prescribed tracer concentration in sea ice for SBC
38   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:  ) ::  trc_o          !: prescribed tracer concentration in ocean for SBC
39   INTEGER             , PUBLIC                            ::  nn_ice_tr      !: handling of sea ice tracers
40   INTEGER             , PUBLIC                            ::  nn_ais_tr      !: handling of Antarctic Ice Sheet tracers
41
42   !! interpolated gradient
43   !!-------------------------------------------------- 
44   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:)   ::  gtru           !: hor. gradient at u-points at bottom ocean level
45   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:)   ::  gtrv           !: hor. gradient at v-points at bottom ocean level
46   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:)   ::  gtrui          !: hor. gradient at u-points at top    ocean level
47   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:)   ::  gtrvi          !: hor. gradient at v-points at top    ocean level
48   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)     ::  qsr_mean        !: daily mean qsr
49   
50   !! passive tracers  (input and output)
51   !! ------------------------------------------ 
52   LOGICAL             , PUBLIC ::   ln_rsttr           !: boolean term for restart i/o for passive tracers (namelist)
53   LOGICAL             , PUBLIC ::   lrst_trc           !: logical to control the trc restart write
54   INTEGER             , PUBLIC ::   nn_writetrc        !: time step frequency for concentration outputs (namelist)
55   INTEGER             , PUBLIC ::   nutwrs             !: output FILE for passive tracers restart
56   INTEGER             , PUBLIC ::   nutrst             !: logical unit for restart FILE for passive tracers
57   INTEGER             , PUBLIC ::   nn_rsttr           !: control of the time step ( 0 or 1 ) for pass. tr.
58   CHARACTER(len = 80) , PUBLIC ::   cn_trcrst_in       !: suffix of pass. tracer restart name (input)
59   CHARACTER(len = 256), PUBLIC ::   cn_trcrst_indir    !: restart input directory
60   CHARACTER(len = 80) , PUBLIC ::   cn_trcrst_out      !: suffix of pass. tracer restart name (output)
61   CHARACTER(len = 256), PUBLIC ::   cn_trcrst_outdir   !: restart output directory
62   REAL(wp)            , PUBLIC ::   rDt_trc            !: = 2*rn_Dt except at nit000 (=rn_Dt) if l_1st_euler=.true.
63   LOGICAL             , PUBLIC ::   ln_top_euler       !: boolean term for euler integration
64   LOGICAL             , PUBLIC ::   ln_trcdta          !: Read inputs data from files
65   LOGICAL             , PUBLIC ::   ln_trcbc           !: Enable surface, lateral or open boundaries conditions
66   LOGICAL             , PUBLIC ::   ln_trcais          !: Enable Antarctic Ice Sheet nutrient supply
67   LOGICAL             , PUBLIC ::   ln_trcdmp          !: internal damping flag
68   LOGICAL             , PUBLIC ::   ln_trcdmp_clo      !: internal damping flag on closed seas
69   INTEGER             , PUBLIC ::   nittrc000          !: first time step of passive tracers model
70   LOGICAL             , PUBLIC ::   l_trcdm2dc         !: Diurnal cycle for TOP
71
72   !! Information for the ice module for tracers
73   !! ------------------------------------------
74   TYPE, PUBLIC ::   TRC_I_NML         !: Ice tracer namelist structure
75         REAL(wp)         :: trc_ratio    ! ice-ocean trc ratio
76         REAL(wp)         :: trc_prescr   ! prescribed ice trc cc
77         CHARACTER(len=2) :: ctrc_o       ! choice of ocean trc cc
78   END TYPE
79   !
80   REAL(wp)        , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   trc_ice_ratio    !: ice-ocean tracer ratio
81   REAL(wp)        , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   trc_ice_prescr   !: prescribed ice trc cc
82   CHARACTER(len=2), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   cn_trc_o         !: choice of ocean tracer cc
83
84   !! Information for the optics module
85   !! ---------------------------------
86   INTEGER , ALLOCATABLE, SAVE, DIMENSION(:,:)   ::  neln       !: number of T-levels + 1 in the euphotic layer
87   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:)   ::  heup       !: euphotic layer depth
88   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:)   ::  heup_01    !: Absolute euphotic layer depth
89   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::  etot       !: par (photosynthetic available radiation)
90   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::  etot_ndcy  !: PAR over 24h in case of diurnal cycle
91
92
93   !! information for outputs
94   !! --------------------------------------------------
95   TYPE, PUBLIC ::   PTRACER        !: Passive tracer type
96      CHARACTER(len=20) ::   clsname   ! short name
97      CHARACTER(len=80) ::   cllname   ! long name
98      CHARACTER(len=20) ::   clunit    ! unit
99      LOGICAL           ::   llinit    ! read in a file or not
100      LOGICAL           ::   llsbc     ! read in a file or not
101      LOGICAL           ::   llcbc     ! read in a file or not
102      LOGICAL           ::   llobc     ! read in a file or not
103      LOGICAL           ::   llais     ! read in a file or not
104   END TYPE PTRACER
105   !
106   CHARACTER(len=20), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   ctrcnm   !: tracer name
107   CHARACTER(len=80), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   ctrcln   !: trccer field long name
108   CHARACTER(len=20), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   ctrcun   !: tracer unit
109   !
110   TYPE, PUBLIC ::   DIAG         !: Passive trcacer ddditional diagnostic type
111      CHARACTER(len=20) ::   sname   ! short name
112      CHARACTER(len=80) ::   lname   ! long name
113      CHARACTER(len=20) ::   units   ! unit
114   END TYPE DIAG
115   !
116   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) ::   trc3d   !: 3D diagnostics for tracers
117   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) ::   trc2d   !: 2D diagnostics for tracers
118
119   !! information for inputs
120   !! --------------------------------------------------
121   LOGICAL , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   ln_trc_ini    !: Initialisation from data input file
122   LOGICAL , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   ln_trc_obc    !: Use open boundary condition data
123   LOGICAL , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   ln_trc_sbc    !: Use surface boundary condition data
124   LOGICAL , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   ln_trc_cbc    !: Use coastal boundary condition data
125   LOGICAL , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   ln_trc_ais    !: Use Antarctic Ice Sheet boundary condition data
126   LOGICAL , PUBLIC                                  ::   ln_rnf_ctl    !: remove runoff dilution on tracers
127   REAL(wp), PUBLIC                                  ::   rn_sbc_time   !: Time scaling factor for SBC data (seconds in a day)
128   REAL(wp), PUBLIC                                  ::   rn_cbc_time   !: Time scaling factor for CBC data (seconds in a day)
129   LOGICAL , PUBLIC                                  ::   lltrcbc       !: Applying one of the boundary conditions
130   !
131   CHARACTER(len=20), PUBLIC, DIMENSION(jp_bdy) :: cn_trc_dflt   ! Default OBC condition for all tracers
132   CHARACTER(len=20), PUBLIC, DIMENSION(jp_bdy) :: cn_trc        ! Choice of boundary condition for tracers
133   INTEGER,           PUBLIC, DIMENSION(jp_bdy) :: nn_trcdmp_bdy !: =T Tracer damping
134   !
135   ! Vertical axis used in the sediment module
136   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   profsed
137!$AGRIF_DO_NOT_TREAT
138   ! External data structure of BDY for TOP. Available elements: cn_obc, ll_trc, trcnow, dmp
139   TYPE(OBC_DATA), PUBLIC, ALLOCATABLE, DIMENSION(:,:), TARGET ::   trcdta_bdy   !: bdy external data (local process)
140!$AGRIF_END_DO_NOT_TREAT
141   !
142   !! Substitutions
143#include "do_loop_substitute.h90"
144   !!----------------------------------------------------------------------
145   !! NEMO/TOP 4.0 , NEMO Consortium (2018)
146   !! $Id$
147   !! Software governed by the CeCILL license (see ./LICENSE)
148   !!----------------------------------------------------------------------
149CONTAINS
150
151   INTEGER FUNCTION trc_alloc()
152      !!-------------------------------------------------------------------
153      !!                    *** ROUTINE trc_alloc ***
154      !!-------------------------------------------------------------------
155      USE lib_mpp, ONLY: ctl_stop
156      !!-------------------------------------------------------------------
157      INTEGER :: ierr(4)
158      !!-------------------------------------------------------------------
159      ierr(:) = 0
160      !
161      ALLOCATE( tr(jpi,jpj,jpk,jptra,jpt)                                             ,       & 
162         &      trc_i(jpi,jpj,jptra)  , trc_o(jpi,jpj,jptra)                          ,       &
163         &      gtru (jpi,jpj,jptra)  , gtrv (jpi,jpj,jptra)                          ,       &
164         &      gtrui(jpi,jpj,jptra)  , gtrvi(jpi,jpj,jptra)                          ,       &
165         &      trc_ice_ratio(jptra)  , trc_ice_prescr(jptra) , cn_trc_o(jptra)       ,       &
166         &      neln(jpi,jpj)         , heup(jpi,jpj)         , heup_01(jpi,jpj)      ,       &
167         &      etot(jpi,jpj,jpk)     , etot_ndcy(jpi,jpj,jpk)                        ,       &
168         &      sbc_trc_b(jpi,jpj,jptra), sbc_trc(jpi,jpj,jptra)                      ,       & 
169         &      cvol(jpi,jpj,jpk)     , trai(jptra)           , qsr_mean(jpi,jpj)     ,       &
170         &      ctrcnm(jptra)         , ctrcln(jptra)         , ctrcun(jptra)         ,       &
171         &      ln_trc_ini(jptra)     ,                                                       &
172         &      ln_trc_sbc(jptra)     , ln_trc_cbc(jptra)     , ln_trc_obc(jptra)     ,       &
173         &      ln_trc_ais(jptra)     ,                                                       &
174         &      STAT = ierr(1)  )
175      !
176      IF( ln_bdy       )   ALLOCATE( trcdta_bdy(jptra, jp_bdy)  , STAT = ierr(2) )
177      !
178      IF (jp_dia3d > 0 )   ALLOCATE( trc3d(jpi,jpj,jpk,jp_dia3d), STAT = ierr(3) )
179      !
180      IF (jp_dia2d > 0 )   ALLOCATE( trc2d(jpi,jpj,jpk,jp_dia2d), STAT = ierr(4) )
181      !
182      trc_alloc = MAXVAL( ierr )
183      IF( trc_alloc /= 0 )   CALL ctl_stop( 'STOP', 'trc_alloc: failed to allocate arrays' )
184      !
185   END FUNCTION trc_alloc
186
187   !!======================================================================
188END MODULE trc
Note: See TracBrowser for help on using the repository browser.