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_r3891_METO1_MERCATOR6_OBC_BDY_merge/NEMOGCM/NEMO/OPA_SRC/BDY – NEMO

source: branches/2013/dev_r3891_METO1_MERCATOR6_OBC_BDY_merge/NEMOGCM/NEMO/OPA_SRC/BDY/bdy_oce.F90 @ 3900

Last change on this file since 3900 was 3900, checked in by davestorkey, 11 years ago

First sketch of Orlanski implementation (untested).
  • Property svn:keywords set to Id
File size: 8.6 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   !!----------------------------------------------------------------------
11#if defined key_bdy 
12   !!----------------------------------------------------------------------
13   !!   'key_bdy'                      Unstructured Open Boundary Condition
14   !!----------------------------------------------------------------------
15   USE par_oce         ! ocean parameters
16   USE bdy_par         ! Unstructured boundary parameters
17   USE lib_mpp         ! distributed memory computing
18
19   IMPLICIT NONE
20   PUBLIC
21
22   TYPE, PUBLIC ::   OBC_INDEX    !: Indices and weights which define the open boundary
23      INTEGER,          DIMENSION(jpbgrd) ::  nblen
24      INTEGER,          DIMENSION(jpbgrd) ::  nblenrim
25      INTEGER, POINTER, DIMENSION(:,:)   ::  nbi
26      INTEGER, POINTER, DIMENSION(:,:)   ::  nbj
27      INTEGER, POINTER, DIMENSION(:,:)   ::  nbr
28      INTEGER, POINTER, DIMENSION(:,:)   ::  nbmap
29      REAL   , POINTER, DIMENSION(:,:)   ::  nbw
30      REAL   , POINTER, DIMENSION(:,:)   ::  nbd
31      REAL   , POINTER, DIMENSION(:,:)   ::  nbdout
32      REAL   , POINTER, DIMENSION(:,:)   ::  flagu
33      REAL   , POINTER, DIMENSION(:,:)   ::  flagv
34   END TYPE OBC_INDEX
35
36   TYPE, PUBLIC ::   OBC_DATA     !: Storage for external data
37      REAL, POINTER, DIMENSION(:)     ::  ssh
38      REAL, POINTER, DIMENSION(:)     ::  u2d
39      REAL, POINTER, DIMENSION(:)     ::  v2d
40      REAL, POINTER, DIMENSION(:,:)   ::  u3d
41      REAL, POINTER, DIMENSION(:,:)   ::  v3d
42      REAL, POINTER, DIMENSION(:,:)   ::  tem
43      REAL, POINTER, DIMENSION(:,:)   ::  sal
44#if defined key_lim2
45      REAL, POINTER, DIMENSION(:)     ::  frld
46      REAL, POINTER, DIMENSION(:)     ::  hicif
47      REAL, POINTER, DIMENSION(:)     ::  hsnif
48#endif
49   END TYPE OBC_DATA
50
51   !!----------------------------------------------------------------------
52   !! Namelist variables
53   !!----------------------------------------------------------------------
54   CHARACTER(len=80), DIMENSION(jp_bdy) ::   cn_coords_file !: Name of bdy coordinates file
55   CHARACTER(len=80)                    ::   cn_mask_file   !: Name of bdy mask file
56   !
57   LOGICAL, DIMENSION(jp_bdy) ::   ln_coords_file           !: =T read bdy coordinates from file;
58   !                                                        !: =F read bdy coordinates from namelist
59   LOGICAL                    ::   ln_mask_file             !: =T read bdymask from file
60   LOGICAL                    ::   ln_vol                   !: =T volume correction             
61   !
62   INTEGER                    ::   nb_bdy                   !: number of open boundary sets
63   INTEGER, DIMENSION(jp_bdy) ::   nn_rimwidth              !: boundary rim width for Flow Relaxation Scheme
64   INTEGER                    ::   nn_volctl                !: = 0 the total volume will have the variability of the surface Flux E-P
65   !                                                        !  = 1 the volume will be constant during all the integration.
66   CHARACTER(len=20), DIMENSION(jp_bdy) ::   cn_dyn2d       ! Choice of boundary condition for barotropic variables (U,V,SSH)
67   INTEGER, DIMENSION(jp_bdy)           ::   nn_dyn2d_dta   !: = 0 use the initial state as bdy dta ;
68                                                            !: = 1 read it in a NetCDF file
69                                                            !: = 2 read tidal harmonic forcing from a NetCDF file
70                                                            !: = 3 read external data AND tidal harmonic forcing from NetCDF files
71   CHARACTER(len=20), DIMENSION(jp_bdy) ::   cn_dyn3d       ! Choice of boundary condition for baroclinic velocities
72   INTEGER, DIMENSION(jp_bdy)           ::   nn_dyn3d_dta   !: = 0 use the initial state as bdy dta ;
73                                                            !: = 1 read it in a NetCDF file
74   CHARACTER(len=20), DIMENSION(jp_bdy) ::   cn_tra         ! Choice of boundary condition for active tracers (T and S)
75   INTEGER, DIMENSION(jp_bdy)           ::   nn_tra_dta     !: = 0 use the initial state as bdy dta ;
76                                                            !: = 1 read it in a NetCDF file
77   LOGICAL, DIMENSION(jp_bdy) ::   ln_tra_dmp               !: =T Tracer damping
78   LOGICAL, DIMENSION(jp_bdy) ::   ln_dyn3d_dmp             !: =T Baroclinic velocity damping
79   REAL,    DIMENSION(jp_bdy) ::   rn_time_dmp              !: Damping time scale in days
80   REAL,    DIMENSION(jp_bdy) ::   rn_time_dmp_out          !: Damping time scale in days at radiation outflow points
81
82#if defined key_lim2
83   CHARACTER(len=20), DIMENSION(jp_bdy) ::   nn_ice_lim2      ! Choice of boundary condition for sea ice variables
84   INTEGER, DIMENSION(jp_bdy)           ::   nn_ice_lim2_dta  !: = 0 use the initial state as bdy dta ;
85                                                              !: = 1 read it in a NetCDF file
86#endif
87   !
88   
89   !!----------------------------------------------------------------------
90   !! Global variables
91   !!----------------------------------------------------------------------
92   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:) ::   bdytmask   !: Mask defining computational domain at T-points
93   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:) ::   bdyumask   !: Mask defining computational domain at U-points
94   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:) ::   bdyvmask   !: Mask defining computational domain at V-points
95
96   REAL(wp)                                    ::   bdysurftot !: Lateral surface of unstructured open boundary
97
98   REAL(wp), POINTER, DIMENSION(:,:)           ::   pssh           !:
99   REAL(wp), POINTER, DIMENSION(:,:)           ::   phur           !:
100   REAL(wp), POINTER, DIMENSION(:,:)           ::   phvr           !: Pointers for barotropic fields
101   REAL(wp), POINTER, DIMENSION(:,:)           ::   pub2d, pua2d   !:
102   REAL(wp), POINTER, DIMENSION(:,:)           ::   pvb2d, pva2d   !:
103
104   !!----------------------------------------------------------------------
105   !! open boundary data variables
106   !!----------------------------------------------------------------------
107
108   INTEGER,  DIMENSION(jp_bdy)                     ::   nn_dta            !: =0 => *all* data is set to initial conditions
109                                                                          !: =1 => some data to be read in from data files
110   REAL(wp), ALLOCATABLE, DIMENSION(:,:,:), TARGET ::   dta_global        !: workspace for reading in global data arrays (unstr.  bdy)
111   REAL(wp), ALLOCATABLE, DIMENSION(:,:,:), TARGET ::   dta_global2       !: workspace for reading in global data arrays (struct. bdy)
112   TYPE(OBC_INDEX), DIMENSION(jp_bdy), TARGET      ::   idx_bdy           !: bdy indices (local process)
113   TYPE(OBC_DATA) , DIMENSION(jp_bdy)              ::   dta_bdy           !: bdy external data (local process)
114
115   !!----------------------------------------------------------------------
116   !! NEMO/OPA 4.0 , NEMO Consortium (2011)
117   !! $Id$
118   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
119   !!----------------------------------------------------------------------
120CONTAINS
121
122   FUNCTION bdy_oce_alloc()
123      !!----------------------------------------------------------------------
124      USE lib_mpp, ONLY: ctl_warn, mpp_sum
125      !
126      INTEGER :: bdy_oce_alloc
127      !!----------------------------------------------------------------------
128      !
129      ALLOCATE( bdytmask(jpi,jpj) , bdyumask(jpi,jpj), bdyvmask(jpi,jpj),                    & 
130         &      STAT=bdy_oce_alloc )
131         !
132      IF( lk_mpp             )   CALL mpp_sum ( bdy_oce_alloc )
133      IF( bdy_oce_alloc /= 0 )   CALL ctl_warn('bdy_oce_alloc: failed to allocate arrays.')
134      !
135   END FUNCTION bdy_oce_alloc
136
137#else
138   !!----------------------------------------------------------------------
139   !!   Dummy module                NO Unstructured Open Boundary Condition
140   !!----------------------------------------------------------------------
141   LOGICAL ::   ln_tides = .false.  !: =T apply tidal harmonic forcing along open boundaries
142#endif
143
144   !!======================================================================
145END MODULE bdy_oce
146
Note: See TracBrowser for help on using the repository browser.