source: NEMO/branches/2019/dev_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps/src/OCE/par_oce.F90 @ 10876

Last change on this file since 10876 was 10876, checked in by davestorkey, 17 months ago

branches/2019/dev_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps : changes to top-level modules.

  • Property svn:keywords set to Id
File size: 5.5 KB
Line 
1MODULE par_oce
2   !!======================================================================
3   !!                        ***  par_oce  ***
4   !! Ocean :   set the ocean parameters
5   !!======================================================================
6   !! History :  OPA  !  1991     (Imbard, Levy, Madec)  Original code
7   !!   NEMO     1.0  !  2004-01  (G. Madec, J.-M. Molines)  Free form and module
8   !!            3.3  !  2010-09  (C. Ethe) TRA-TRC merge: add jpts, jp_tem & jp_sal
9   !!----------------------------------------------------------------------
10   USE par_kind          ! kind parameters
11
12   IMPLICIT NONE
13   PUBLIC
14
15   !!----------------------------------------------------------------------
16   !!                   namcfg namelist parameters
17   !!----------------------------------------------------------------------
18   LOGICAL       ::   ln_read_cfg      !: (=T) read the domain configuration file or (=F) not
19   CHARACTER(lc) ::      cn_domcfg        !: filename the configuration file to be read
20   LOGICAL       ::   ln_write_cfg     !: (=T) create the domain configuration file
21   CHARACTER(lc) ::      cn_domcfg_out    !: filename the configuration file to be read
22   !
23   LOGICAL       ::   ln_use_jattr     !: input file read offset
24   !                                   !  Use file global attribute: open_ocean_jstart to determine start j-row
25   !                                   !  when reading input from those netcdf files that have the
26   !                                   !  attribute defined. This is designed to enable input files associated
27   !                                   !  with the extended grids used in the under ice shelf configurations to
28   !                                   !  be used without redundant rows when the ice shelves are not in use.
29   !
30
31   !!---------------------------------------------------------------------
32   !! Domain Matrix size
33   !!---------------------------------------------------------------------
34   ! configuration name & resolution   (required only in ORCA family case)
35   CHARACTER(lc) ::   cn_cfg           !: name of the configuration
36   INTEGER       ::   nn_cfg           !: resolution of the configuration
37
38   ! time dimension
39   INTEGER, PUBLIC, PARAMETER :: jpt = 3    !: time dimension
40
41   ! global domain size               !!! * total computational domain *
42   INTEGER       ::   jpiglo           !: 1st dimension of global domain --> i-direction
43   INTEGER       ::   jpjglo           !: 2nd    -                  -    --> j-direction
44   INTEGER       ::   jpkglo           !: 3nd    -                  -    --> k levels
45
46   ! global domain size for AGRIF     !!! * total AGRIF computational domain *
47   INTEGER, PUBLIC            ::   nbug_in_agrif_conv_do_not_remove_or_modify = 1 - 1
48   INTEGER, PUBLIC, PARAMETER ::   nbghostcells = 3                             !: number of ghost cells
49   INTEGER, PUBLIC            ::   nbcellsx   ! = jpiglo - 2 - 2*nbghostcells   !: number of cells in i-direction
50   INTEGER, PUBLIC            ::   nbcellsy   ! = jpjglo - 2 - 2*nbghostcells   !: number of cells in j-direction
51
52   ! local domain size                !!! * local computational domain *
53   INTEGER, PUBLIC ::   jpi   !                                                    !: first  dimension
54   INTEGER, PUBLIC ::   jpj   !                                                    !: second dimension
55   INTEGER, PUBLIC ::   jpk   ! = jpkglo                                           !: third  dimension
56   INTEGER, PUBLIC ::   jpim1 ! = jpi-1                                            !: inner domain indices
57   INTEGER, PUBLIC ::   jpjm1 ! = jpj-1                                            !:   -     -      -
58   INTEGER, PUBLIC ::   jpkm1 ! = jpk-1                                            !:   -     -      -
59   INTEGER, PUBLIC ::   jpij  ! = jpi*jpj                                          !:  jpi x jpj
60   INTEGER, PUBLIC ::   jpimax! = ( jpiglo-2*nn_hls + (jpni-1) ) / jpni + 2*nn_hls !: maximum jpi
61   INTEGER, PUBLIC ::   jpjmax! = ( jpjglo-2*nn_hls + (jpnj-1) ) / jpnj + 2*nn_hls !: maximum jpj
62
63   !!---------------------------------------------------------------------
64   !! Active tracer parameters
65   !!---------------------------------------------------------------------
66   INTEGER, PUBLIC, PARAMETER ::   jpts   = 2    !: Number of active tracers (=2, i.e. T & S )
67   INTEGER, PUBLIC, PARAMETER ::   jp_tem = 1    !: indice for temperature
68   INTEGER, PUBLIC, PARAMETER ::   jp_sal = 2    !: indice for salinity
69
70   !!----------------------------------------------------------------------
71   !!   Domain decomposition
72   !!----------------------------------------------------------------------
73   !! if we dont use massively parallel computer (parameters jpni=jpnj=1) so jpiglo=jpi and jpjglo=jpj
74   INTEGER, PUBLIC            ::   jpni         !: number of processors following i
75   INTEGER, PUBLIC            ::   jpnj         !: number of processors following j
76   INTEGER, PUBLIC            ::   jpnij        !: nb of local domain = nb of processors ( <= jpni x jpnj )
77   INTEGER, PUBLIC, PARAMETER ::   jpr2di = 0   !: number of columns for extra outer halo
78   INTEGER, PUBLIC, PARAMETER ::   jpr2dj = 0   !: number of rows    for extra outer halo
79   INTEGER, PUBLIC, PARAMETER ::   nn_hls = 1   !: halo width (applies to both rows and columns)
80
81   !!----------------------------------------------------------------------
82   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
83   !! $Id$
84   !! Software governed by the CeCILL license (see ./LICENSE)
85   !!======================================================================
86END MODULE par_oce
Note: See TracBrowser for help on using the repository browser.