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.
bdy_oce.F90 in branches/2013/dev_r3406_CNRS_LIM3/NEMOGCM/NEMO/OPA_SRC/BDY – NEMO

source: branches/2013/dev_r3406_CNRS_LIM3/NEMOGCM/NEMO/OPA_SRC/BDY/bdy_oce.F90 @ 3938

Last change on this file since 3938 was 3938, checked in by flavoni, 11 years ago

dev_r3406_CNRS_LIM3: update LIM3, see ticket #1116
  • Property svn:keywords set to Id
File size: 8.3 KB
Line 
1MODULE bdy_oce
2   !!======================================================================
3   !!                       ***  MODULE bdy_oce   ***
4   !! Unstructured Open Boundary Cond. :   define related variables
5   !!======================================================================
6   !! History :  1.0  !  2001-05  (J. Chanut, A. Sellar)  Original code
7   !!            3.0  !  2008-04  (NEMO team)  add in the reference version     
8   !!            3.3  !  2010-09  (D. Storkey) add ice boundary conditions
9   !!            3.4  !  2011     (D. Storkey) rewrite in preparation for OBC-BDY merge
10   !!             -   !  2012-01  (C. Rousset) add ice boundary conditions for lim3
11   !!----------------------------------------------------------------------
12#if defined key_bdy 
13   !!----------------------------------------------------------------------
14   !!   'key_bdy'                      Unstructured Open Boundary Condition
15   !!----------------------------------------------------------------------
16   USE par_oce         ! ocean parameters
17   USE bdy_par         ! Unstructured boundary parameters
18   USE lib_mpp         ! distributed memory computing
19
20   IMPLICIT NONE
21   PUBLIC
22
23   TYPE, PUBLIC ::   OBC_INDEX    !: Indices and weights which define the open boundary
24      INTEGER,          DIMENSION(jpbgrd) ::  nblen
25      INTEGER,          DIMENSION(jpbgrd) ::  nblenrim
26      INTEGER, POINTER, DIMENSION(:,:)   ::  nbi
27      INTEGER, POINTER, DIMENSION(:,:)   ::  nbj
28      INTEGER, POINTER, DIMENSION(:,:)   ::  nbr
29      INTEGER, POINTER, DIMENSION(:,:)   ::  nbmap
30      REAL   , POINTER, DIMENSION(:,:)   ::  nbw
31      REAL   , POINTER, DIMENSION(:)     ::  flagu
32      REAL   , POINTER, DIMENSION(:)     ::  flagv
33   END TYPE OBC_INDEX
34
35   TYPE, PUBLIC ::   OBC_DATA     !: Storage for external data
36      REAL, POINTER, DIMENSION(:)     ::  ssh
37      REAL, POINTER, DIMENSION(:)     ::  u2d
38      REAL, POINTER, DIMENSION(:)     ::  v2d
39      REAL, POINTER, DIMENSION(:,:)   ::  u3d
40      REAL, POINTER, DIMENSION(:,:)   ::  v3d
41      REAL, POINTER, DIMENSION(:,:)   ::  tem
42      REAL, POINTER, DIMENSION(:,:)   ::  sal
43#if defined key_lim2
44      REAL, POINTER, DIMENSION(:)     ::  frld
45      REAL, POINTER, DIMENSION(:)     ::  hicif
46      REAL, POINTER, DIMENSION(:)     ::  hsnif
47#elif defined key_lim3
48      REAL, POINTER, DIMENSION(:,:)   ::  a_i   !: now ice leads fraction climatology
49      REAL, POINTER, DIMENSION(:,:)   ::  ht_i  !: Now ice  thickness climatology
50      REAL, POINTER, DIMENSION(:,:)   ::  ht_s  !: now snow thickness
51#endif
52   END TYPE OBC_DATA
53
54   !!----------------------------------------------------------------------
55   !! Namelist variables
56   !!----------------------------------------------------------------------
57   CHARACTER(len=80), DIMENSION(jp_bdy) ::   cn_coords_file !: Name of bdy coordinates file
58   CHARACTER(len=80)                    ::   cn_mask_file   !: Name of bdy mask file
59   !
60   LOGICAL, DIMENSION(jp_bdy) ::   ln_coords_file           !: =T read bdy coordinates from file;
61   !                                                        !: =F read bdy coordinates from namelist
62   LOGICAL                    ::   ln_mask_file             !: =T read bdymask from file
63   LOGICAL                    ::   ln_vol                   !: =T volume correction             
64   !
65   INTEGER                    ::   nb_bdy                   !: number of open boundary sets
66   INTEGER, DIMENSION(jp_bdy) ::   nn_rimwidth              !: boundary rim width for Flow Relaxation Scheme
67   INTEGER                    ::   nn_volctl                !: = 0 the total volume will have the variability of the surface Flux E-P
68   !                                                        !  = 1 the volume will be constant during all the integration.
69   INTEGER, DIMENSION(jp_bdy) ::   nn_dyn2d                 ! Choice of boundary condition for barotropic variables (U,V,SSH)
70   INTEGER, DIMENSION(jp_bdy) ::   nn_dyn2d_dta           !: = 0 use the initial state as bdy dta ;
71                                                            !: = 1 read it in a NetCDF file
72                                                            !: = 2 read tidal harmonic forcing from a NetCDF file
73                                                            !: = 3 read external data AND tidal harmonic forcing from NetCDF files
74   INTEGER, DIMENSION(jp_bdy) ::   nn_dyn3d                 ! Choice of boundary condition for baroclinic velocities
75   INTEGER, DIMENSION(jp_bdy) ::   nn_dyn3d_dta           !: = 0 use the initial state as bdy dta ;
76                                                            !: = 1 read it in a NetCDF file
77   INTEGER, DIMENSION(jp_bdy) ::   nn_tra                   ! Choice of boundary condition for active tracers (T and S)
78   INTEGER, DIMENSION(jp_bdy) ::   nn_tra_dta             !: = 0 use the initial state as bdy dta ;
79                                                            !: = 1 read it in a NetCDF file
80#if ( defined key_lim2 || defined key_lim3 )
81   INTEGER, DIMENSION(jp_bdy) ::   nn_ice_lim               ! Choice of boundary condition for sea ice variables
82   INTEGER, DIMENSION(jp_bdy) ::   nn_ice_lim_dta           !: = 0 use the initial state as bdy dta ;
83                                                            !: = 1 read it in a NetCDF file
84#endif
85   !
86   
87   !!----------------------------------------------------------------------
88   !! Global variables
89   !!----------------------------------------------------------------------
90   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:) ::   bdytmask   !: Mask defining computational domain at T-points
91   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:) ::   bdyumask   !: Mask defining computational domain at U-points
92   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:) ::   bdyvmask   !: Mask defining computational domain at V-points
93
94   REAL(wp)                                    ::   bdysurftot !: Lateral surface of unstructured open boundary
95
96   REAL(wp), POINTER, DIMENSION(:,:)           ::   pssh       !:
97   REAL(wp), POINTER, DIMENSION(:,:)           ::   phur       !:
98   REAL(wp), POINTER, DIMENSION(:,:)           ::   phvr       !: Pointers for barotropic fields
99   REAL(wp), POINTER, DIMENSION(:,:)           ::   pu2d       !:
100   REAL(wp), POINTER, DIMENSION(:,:)           ::   pv2d       !:
101
102   !!----------------------------------------------------------------------
103   !! open boundary data variables
104   !!----------------------------------------------------------------------
105
106   INTEGER,  DIMENSION(jp_bdy)                     ::   nn_dta            !: =0 => *all* data is set to initial conditions
107                                                                          !: =1 => some data to be read in from data files
108   REAL(wp), ALLOCATABLE, DIMENSION(:,:,:), TARGET ::   dta_global        !: workspace for reading in global data arrays
109   TYPE(OBC_INDEX), DIMENSION(jp_bdy), TARGET      ::   idx_bdy           !: bdy indices (local process)
110   TYPE(OBC_DATA) , DIMENSION(jp_bdy)              ::   dta_bdy           !: bdy external data (local process)
111
112   !!----------------------------------------------------------------------
113   !! NEMO/OPA 4.0 , NEMO Consortium (2011)
114   !! $Id$
115   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
116   !!----------------------------------------------------------------------
117CONTAINS
118
119   FUNCTION bdy_oce_alloc()
120      !!----------------------------------------------------------------------
121      USE lib_mpp, ONLY: ctl_warn, mpp_sum
122      !
123      INTEGER :: bdy_oce_alloc
124      !!----------------------------------------------------------------------
125      !
126      ALLOCATE( bdytmask(jpi,jpj) , bdyumask(jpi,jpj), bdyvmask(jpi,jpj),                    & 
127         &      STAT=bdy_oce_alloc )
128         !
129      IF( lk_mpp             )   CALL mpp_sum ( bdy_oce_alloc )
130      IF( bdy_oce_alloc /= 0 )   CALL ctl_warn('bdy_oce_alloc: failed to allocate arrays.')
131      !
132   END FUNCTION bdy_oce_alloc
133
134#else
135   !!----------------------------------------------------------------------
136   !!   Dummy module                NO Unstructured Open Boundary Condition
137   !!----------------------------------------------------------------------
138   LOGICAL ::   ln_tides = .false.  !: =T apply tidal harmonic forcing along open boundaries
139#endif
140
141   !!======================================================================
142END MODULE bdy_oce
143
Note: See TracBrowser for help on using the repository browser.