source: NEMO/branches/2019/dev_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps/src/TOP/trc.F90 @ 10880

Last change on this file since 10880 was 10880, checked in by davestorkey, 20 months ago

branches/2019/dev_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps:

  1. Move time indices from dom_oce.F90 to step.F90.
  2. Implement time dimension for passive tracers with independent set of time indices in trcstp.F90.
  3. Update all the traadv and trcadv modules.
  • Property svn:keywords set to Id
File size: 11.2 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 ::   numnat_ref = -1   !: reference passive tracer namelist_top_ref
21   INTEGER, PUBLIC ::   numnat_cfg = -1   !: reference passive tracer namelist_top_cfg
22   INTEGER, PUBLIC ::   numont     = -1   !: reference passive tracer namelist output output.namelist.top
23   INTEGER, PUBLIC ::   numtrc_ref = -1   !: reference passive tracer namelist_top_ref
24   INTEGER, PUBLIC ::   numtrc_cfg = -1   !: reference passive tracer namelist_top_cfg
25   INTEGER, PUBLIC ::   numonr     = -1   !: reference passive tracer namelist output output.namelist.top
26   INTEGER, PUBLIC ::   numstr            !: tracer statistics
27   INTEGER, PUBLIC ::   numrtr            !: trc restart (read )
28   INTEGER, PUBLIC ::   numrtw            !: trc restart ( write )
29
30   !! passive tracers fields (before,now,after)
31   !! --------------------------------------------------
32   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:)       ::  trai           !: initial total tracer
33   REAL(wp), PUBLIC                                        ::  areatot        !: total volume
34   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:  ) ::  cvol           !: volume correction -degrad option-
35   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:,:), TARGET ::  tr             !: tracer concentration
36   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:  ) ::  sbc_trc_b      !: Before sbc fluxes for tracers
37   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:  ) ::  sbc_trc        !: Now sbc fluxes for tracers
38
39   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:  ) ::  trc_i          !: prescribed tracer concentration in sea ice for SBC
40   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:  ) ::  trc_o          !: prescribed tracer concentration in ocean for SBC
41   INTEGER             , PUBLIC                            ::  nn_ice_tr      !: handling of sea ice tracers
42
43   !! TEMPORARY POINTERS - TO BE DELETED AFTER IMMERSE DEVELOPMENT COMPLETE
44   REAL(wp), PUBLIC, POINTER, SAVE, DIMENSION(:,:,:,:)   ::  trn            !: tracer concentration for now time step
45   REAL(wp), PUBLIC, POINTER, SAVE, DIMENSION(:,:,:,:)   ::  tra            !: tracer concentration for next time step
46   REAL(wp), PUBLIC, POINTER, SAVE, DIMENSION(:,:,:,:)   ::  trb            !: tracer concentration for before time step
47   !! TEMPORARY POINTERS - TO BE DELETED AFTER IMMERSE DEVELOPMENT COMPLETE
48
49   !! interpolated gradient
50   !!-------------------------------------------------- 
51   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:)   ::  gtru           !: hor. gradient at u-points at bottom ocean level
52   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:)   ::  gtrv           !: hor. gradient at v-points at bottom ocean level
53   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:)   ::  gtrui          !: hor. gradient at u-points at top    ocean level
54   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:)   ::  gtrvi          !: hor. gradient at v-points at top    ocean level
55   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)     ::  qsr_mean        !: daily mean qsr
56   
57   !! passive tracers  (input and output)
58   !! ------------------------------------------ 
59   LOGICAL             , PUBLIC ::   ln_rsttr           !: boolean term for restart i/o for passive tracers (namelist)
60   LOGICAL             , PUBLIC ::   lrst_trc           !: logical to control the trc restart write
61   INTEGER             , PUBLIC ::   nn_writetrc        !: time step frequency for concentration outputs (namelist)
62   INTEGER             , PUBLIC ::   nutwrs             !: output FILE for passive tracers restart
63   INTEGER             , PUBLIC ::   nutrst             !: logical unit for restart FILE for passive tracers
64   INTEGER             , PUBLIC ::   nn_rsttr           !: control of the time step ( 0 or 1 ) for pass. tr.
65   CHARACTER(len = 80) , PUBLIC ::   cn_trcrst_in       !: suffix of pass. tracer restart name (input)
66   CHARACTER(len = 256), PUBLIC ::   cn_trcrst_indir    !: restart input directory
67   CHARACTER(len = 80) , PUBLIC ::   cn_trcrst_out      !: suffix of pass. tracer restart name (output)
68   CHARACTER(len = 256), PUBLIC ::   cn_trcrst_outdir   !: restart output directory
69   REAL(wp)            , PUBLIC ::   rdttrc             !: passive tracer time step
70   REAL(wp)            , PUBLIC ::   r2dttrc            !: = 2*rdttrc except at nit000 (=rdttrc) if neuler=0
71   LOGICAL             , PUBLIC ::   ln_top_euler       !: boolean term for euler integration
72   LOGICAL             , PUBLIC ::   ln_trcdta          !: Read inputs data from files
73   LOGICAL             , PUBLIC ::   ln_trcdmp          !: internal damping flag
74   LOGICAL             , PUBLIC ::   ln_trcdmp_clo      !: internal damping flag on closed seas
75   INTEGER             , PUBLIC ::   nittrc000          !: first time step of passive tracers model
76   LOGICAL             , PUBLIC ::   l_trcdm2dc         !: Diurnal cycle for TOP
77
78   !! Information for the ice module for tracers
79   !! ------------------------------------------
80   TYPE, PUBLIC ::   TRC_I_NML         !: Ice tracer namelist structure
81         REAL(wp)         :: trc_ratio    ! ice-ocean trc ratio
82         REAL(wp)         :: trc_prescr   ! prescribed ice trc cc
83         CHARACTER(len=2) :: ctrc_o       ! choice of ocean trc cc
84   END TYPE
85   !
86   REAL(wp)        , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   trc_ice_ratio    !: ice-ocean tracer ratio
87   REAL(wp)        , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   trc_ice_prescr   !: prescribed ice trc cc
88   CHARACTER(len=2), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   cn_trc_o         !: choice of ocean tracer cc
89
90
91   !! information for outputs
92   !! --------------------------------------------------
93   TYPE, PUBLIC ::   PTRACER        !: Passive tracer type
94      CHARACTER(len=20) ::   clsname   ! short name
95      CHARACTER(len=80) ::   cllname   ! long name
96      CHARACTER(len=20) ::   clunit    ! unit
97      LOGICAL           ::   llinit    ! read in a file or not
98      LOGICAL           ::   llsbc     ! read in a file or not
99      LOGICAL           ::   llcbc     ! read in a file or not
100      LOGICAL           ::   llobc     ! read in a file or not
101   END TYPE PTRACER
102   !
103   CHARACTER(len=20), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   ctrcnm   !: tracer name
104   CHARACTER(len=80), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   ctrcln   !: trccer field long name
105   CHARACTER(len=20), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   ctrcun   !: tracer unit
106   !
107   TYPE, PUBLIC ::   DIAG         !: Passive trcacer ddditional diagnostic type
108      CHARACTER(len=20) ::   sname   ! short name
109      CHARACTER(len=80) ::   lname   ! long name
110      CHARACTER(len=20) ::   units   ! unit
111   END TYPE DIAG
112   !
113   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) ::   trc3d   !: 3D diagnostics for tracers
114   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:,:) ::   trc2d   !: 2D diagnostics for tracers
115
116   !! information for inputs
117   !! --------------------------------------------------
118   LOGICAL , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   ln_trc_ini    !: Initialisation from data input file
119   LOGICAL , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   ln_trc_obc    !: Use open boundary condition data
120   LOGICAL , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   ln_trc_sbc    !: Use surface boundary condition data
121   LOGICAL , PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   ln_trc_cbc    !: Use coastal boundary condition data
122   LOGICAL , PUBLIC                                  ::   ln_rnf_ctl    !: remove runoff dilution on tracers
123   REAL(wp), PUBLIC                                  ::   rn_bc_time    !: Time scaling factor for SBC and CBC data (seconds in a day)
124   !
125   CHARACTER(len=20), PUBLIC, DIMENSION(jp_bdy) :: cn_trc_dflt   ! Default OBC condition for all tracers
126   CHARACTER(len=20), PUBLIC, DIMENSION(jp_bdy) :: cn_trc        ! Choice of boundary condition for tracers
127   INTEGER,           PUBLIC, DIMENSION(jp_bdy) :: nn_trcdmp_bdy !: =T Tracer damping
128   !
129   ! Vertical axis used in the sediment module
130   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) ::   profsed
131!$AGRIF_DO_NOT_TREAT
132   ! External data structure of BDY for TOP. Available elements: cn_obc, ll_trc, trcnow, dmp
133   TYPE(OBC_DATA), PUBLIC, ALLOCATABLE, DIMENSION(:,:), TARGET ::   trcdta_bdy   !: bdy external data (local process)
134!$AGRIF_END_DO_NOT_TREAT
135   !
136   !!----------------------------------------------------------------------
137   !! NEMO/TOP 4.0 , NEMO Consortium (2018)
138   !! $Id$
139   !! Software governed by the CeCILL license (see ./LICENSE)
140   !!----------------------------------------------------------------------
141CONTAINS
142
143   INTEGER FUNCTION trc_alloc()
144      !!-------------------------------------------------------------------
145      !!                    *** ROUTINE trc_alloc ***
146      !!-------------------------------------------------------------------
147      USE lib_mpp, ONLY: ctl_stop
148      !!-------------------------------------------------------------------
149      INTEGER :: ierr(4)
150      !!-------------------------------------------------------------------
151      ierr(:) = 0
152      !
153      ALLOCATE( tr(jpi,jpj,jpk,jptra,jpt)                                             ,       & 
154         &      trc_i(jpi,jpj,jptra)  , trc_o(jpi,jpj,jptra)                          ,       &
155         &      gtru (jpi,jpj,jptra)  , gtrv (jpi,jpj,jptra)                          ,       &
156         &      gtrui(jpi,jpj,jptra)  , gtrvi(jpi,jpj,jptra)                          ,       &
157         &      trc_ice_ratio(jptra)  , trc_ice_prescr(jptra) , cn_trc_o(jptra)       ,       &
158         &      sbc_trc_b(jpi,jpj,jptra), sbc_trc(jpi,jpj,jptra)                      ,       & 
159         &      cvol(jpi,jpj,jpk)     , trai(jptra)           , qsr_mean(jpi,jpj)     ,       &
160         &      ctrcnm(jptra)         , ctrcln(jptra)         , ctrcun(jptra)         ,       &
161         &      ln_trc_ini(jptra)     ,                                                       &
162         &      ln_trc_sbc(jptra)     , ln_trc_cbc(jptra)     , ln_trc_obc(jptra)     ,       &
163         &      STAT = ierr(1)  )
164      !
165      IF( ln_bdy       )   ALLOCATE( trcdta_bdy(jptra, jp_bdy)  , STAT = ierr(2) )
166      !
167      IF (jp_dia3d > 0 )   ALLOCATE( trc3d(jpi,jpj,jpk,jp_dia3d), STAT = ierr(3) )
168      !
169      IF (jp_dia2d > 0 )   ALLOCATE( trc2d(jpi,jpj,jpk,jp_dia2d), STAT = ierr(4) )
170      !
171      trc_alloc = MAXVAL( ierr )
172      IF( trc_alloc /= 0 )   CALL ctl_stop( 'STOP', 'trc_alloc: failed to allocate arrays' )
173      !
174   END FUNCTION trc_alloc
175
176   !!======================================================================
177END MODULE trc
Note: See TracBrowser for help on using the repository browser.