source: trunk/NEMOGCM/NEMO/OPA_SRC/OBC/obc_par.F90 @ 23

Last change on this file since 23 was 23, checked in by rblod, 12 years ago

Add possibility to choose where to apply the barotropic correction
File size: 6.6 KB
Line 
1MODULE obc_par
2   !!==============================================================================
3   !!                  ***  MODULE obc_par   ***
4   !! Open Boundary Cond. :   define related parameters
5   !!==============================================================================
6   !! history :  OPA  ! 1991-01 (CLIPPER)  Original code
7   !!   NEMO     1.0  ! 2002-04   (C. Talandier)  modules
8   !!             -   ! 2004/06   (F. Durand) jptobc is defined as a parameter
9   !!----------------------------------------------------------------------
10#if defined key_obc
11   !!----------------------------------------------------------------------
12   !!   'key_obc' :                                 Open Boundary Condition
13   !!----------------------------------------------------------------------
14   USE par_oce         ! ocean parameters
15
16   IMPLICIT NONE
17   PUBLIC
18
19#if ! defined key_agrif
20   LOGICAL, PUBLIC, PARAMETER ::   lk_obc = .TRUE.     !: Ocean Boundary Condition flag
21#else
22   LOGICAL, PUBLIC            ::   lk_obc = .TRUE.     !: Ocean Boundary Condition flag
23#endif
24
25# if defined key_eel_r5
26   !!----------------------------------------------------------------------
27   !!   'key_eel_r5' :                                 EEL R5 configuration
28   !!----------------------------------------------------------------------
29#    include "obc_par_EEL_R5.h90"
30
31# elif defined key_pomme_r025
32   !!----------------------------------------------------------------------
33   !!   'key_pomme_r025' :                         POMME R025 configuration
34   !!----------------------------------------------------------------------
35#    include "obc_par_POMME_R025.h90"
36
37# elif defined key_trop12
38   !!----------------------------------------------------------------------
39   !!   'key_trop12' :                        TROPICAL TROP12 configuration
40   !!----------------------------------------------------------------------
41#    include "obc_par_TROP12.h90"
42
43# elif defined key_bb12
44   !! BB12
45   !!----------------------------------------------------------------------
46   !!   'key_bb12' :                              BENGAL R012 configuration
47   !!----------------------------------------------------------------------
48#    include "obc_par_BB12.h90"
49
50# elif defined key_peru12
51   !! PERU12
52   !!----------------------------------------------------------------------
53   !!   'key_peru12' :                        PERU/CHILI R012 configuration
54   !!----------------------------------------------------------------------
55#    include "obc_par_PERU12.h90"
56
57# else
58   !!---------------------------------------------------------------------
59   !! open boundary parameter
60   !!---------------------------------------------------------------------
61   INTEGER, PARAMETER ::   jptobc      =  2        !: time dimension of the BCS fields on input
62   
63   !! * EAST open boundary
64   LOGICAL, PARAMETER ::   lp_obc_east = .FALSE.   !: to active or not the East open boundary
65   INTEGER   &
66#if !defined key_agrif
67     , PARAMETER   & 
68#endif
69    ::     & 
70      jpieob  = jpiglo-2,    &  !: i-localization of the East open boundary (must be ocean U-point)
71      jpjed   =        2,    &  !: j-starting indice of the East open boundary (must be land T-point)
72      jpjef   = jpjglo-1,    &  !: j-ending   indice of the East open boundary (must be land T-point)
73      jpjedp1 =  jpjed+1,    &  !: first ocean point         "                 "
74      jpjefm1 =  jpjef-1        !: last  ocean point         "                 "
75
76   !! * WEST open boundary
77   LOGICAL, PARAMETER ::   lp_obc_west = .FALSE.   !: to active or not the West open boundary
78   INTEGER   &
79#if !defined key_agrif
80     , PARAMETER   & 
81#endif
82    ::     & 
83      jpiwob  =        2,    &  !: i-localization of the West open boundary (must be ocean U-point)
84      jpjwd   =        2,    &  !: j-starting indice of the West open boundary (must be land T-point)
85      jpjwf   = jpjglo-1,    &  !: j-ending   indice of the West open boundary (must be land T-point)
86      jpjwdp1 =  jpjwd+1,    &  !: first ocean point         "                 "
87      jpjwfm1 =  jpjwf-1        !: last  ocean point         "                 "
88
89   !! * NORTH open boundary
90   LOGICAL, PARAMETER ::   lp_obc_north = .FALSE.   !: to active or not the North open boundary
91     INTEGER   &
92#if !defined key_agrif
93     , PARAMETER   & 
94#endif
95    ::     & 
96      jpjnob  = jpjglo-2,    &  !: j-localization of the North open boundary (must be ocean V-point)
97      jpind   =        2,    &  !: i-starting indice of the North open boundary (must be land T-point)
98      jpinf   = jpiglo-1,    &  !: i-ending   indice of the North open boundary (must be land T-point)
99      jpindp1 =  jpind+1,    &  !: first ocean point         "                 "
100      jpinfm1 =  jpinf-1        !: last  ocean point         "                 "
101
102   !! * SOUTH open boundary
103   LOGICAL, PARAMETER ::   lp_obc_south = .FALSE.   !: to active or not the South open boundary
104     INTEGER   &
105#if !defined key_agrif
106     , PARAMETER   & 
107#endif
108    ::     & 
109      jpjsob  =        2,    &  !: j-localization of the South open boundary (must be ocean V-point)
110      jpisd   =        2,    &  !: i-starting indice of the South open boundary (must be land T-point)
111      jpisf   = jpiglo-1,    &  !: i-ending   indice of the South open boundary (must be land T-point)
112      jpisdp1 =  jpisd+1,    &  !: first ocean point         "                 "
113      jpisfm1 =  jpisf-1        !: last  ocean point         "                 "
114   
115   !! * CHOSE WHERE YOU WANT TO LOCATE THE BAROTROPIC CORRECTION VELOCITY
116   LOGICAL, PARAMETER ::     &  !:
117      lp_obc_east_barotp_corr  = .TRUE.,   & !:
118      lp_obc_west_barotp_corr  = .TRUE.,   & !:
119      lp_obc_north_barotp_corr = .TRUE.,   & !:
120      lp_obc_south_barotp_corr = .TRUE.      !:
121
122   INTEGER, PARAMETER ::   jpnic = 2700   !: maximum number of isolated coastlines points
123
124# endif
125
126#else
127   !!----------------------------------------------------------------------
128   !!   Default option :                         NO open boundary condition
129   !!----------------------------------------------------------------------
130#if ! defined key_agrif
131   LOGICAL, PUBLIC, PARAMETER ::   lk_obc = .FALSE.     !: Ocean Boundary Condition flag
132#else
133   LOGICAL, PUBLIC            ::   lk_obc = .FALSE.     !: Ocean Boundary Condition flag
134#endif
135#endif
136
137   !!----------------------------------------------------------------------
138   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
139   !! $Id: obc_par.F90 3294 2012-01-28 16:44:18Z rblod $
140   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
141   !!======================================================================
142END MODULE obc_par
Note: See TracBrowser for help on using the repository browser.