source: NEMO/branches/2020/dev_r12558_HPC-08_epico_Extra_Halo/src/OCE/IOM/iom_def.F90 @ 12738

Last change on this file since 12738 was 12738, checked in by smasson, 8 months ago

Extra_Halo: iom cleaning/update to work only with unknown, global or local (without halos) domains, see #2366

  • Property svn:keywords set to Id
File size: 4.9 KB
Line 
1MODULE iom_def
2   !!======================================================================
3   !!                    ***  MODULE  iom_def ***
4   !! IOM variables definitions
5   !!======================================================================
6   !! History :  9.0  ! 2006 09  (S. Masson) Original code
7   !!             -   ! 2007 07  (D. Storkey) Add uldname
8   !!            4.0  ! 2017-11 (M. Andrejczuk) Extend IOM interface to write any 3D fields
9   !!----------------------------------------------------------------------
10   USE par_kind
11
12   IMPLICIT NONE
13   PRIVATE
14
15   INTEGER, PARAMETER, PUBLIC ::   jpdom_global        = 1   !: ( 1  :jpiglo, 1  :jpjglo)
16   INTEGER, PARAMETER, PUBLIC ::   jpdom_local         = 2   !: (nldi:nlei  ,nldj:nlej  )
17   INTEGER, PARAMETER, PUBLIC ::   jpdom_unknown       = 3   !: No dimension checking
18   INTEGER, PARAMETER, PUBLIC ::   jpdom_auto          = 4   !:
19   INTEGER, PARAMETER, PUBLIC ::   jpdom_auto_xy       = 5   !: Automatically set horizontal dimensions only
20
21   INTEGER, PARAMETER, PUBLIC ::   jp_r8    = 200      !: write REAL(8)
22   INTEGER, PARAMETER, PUBLIC ::   jp_r4    = 201      !: write REAL(4)
23   INTEGER, PARAMETER, PUBLIC ::   jp_i4    = 202      !: write INTEGER(4)
24   INTEGER, PARAMETER, PUBLIC ::   jp_i2    = 203      !: write INTEGER(2)
25   INTEGER, PARAMETER, PUBLIC ::   jp_i1    = 204      !: write INTEGER(1)
26
27   INTEGER, PARAMETER, PUBLIC ::   jpmax_files  = 100  !: maximum number of simultaneously opened file
28   INTEGER, PARAMETER, PUBLIC ::   jpmax_vars   = 1200 !: maximum number of variables in one file
29   INTEGER, PARAMETER, PUBLIC ::   jpmax_dims   =  4   !: maximum number of dimensions for one variable
30   INTEGER, PARAMETER, PUBLIC ::   jpmax_digits =  5   !: maximum number of digits for the cpu number in the file name
31
32!$AGRIF_DO_NOT_TREAT
33   INTEGER, PUBLIC            ::   iom_open_init = 0   !: used to initialize iom_file(:)%nfid to 0
34!XIOS write restart   
35   LOGICAL, PUBLIC            ::   lwxios          !: write single file restart using XIOS
36   INTEGER, PUBLIC            ::   nxioso          !: type of restart file when writing using XIOS 1 - single, 2 - multiple
37!XIOS read restart   
38   LOGICAL, PUBLIC            ::   lrxios          !: read single file restart using XIOS
39   LOGICAL, PUBLIC            ::   lxios_sini = .FALSE. ! is restart in a single file
40   LOGICAL, PUBLIC            ::   lxios_set  = .FALSE. 
41
42   TYPE, PUBLIC ::   file_descriptor
43      CHARACTER(LEN=240)                        ::   name     !: name of the file
44      INTEGER                                   ::   nfid     !: identifier of the file (0 if closed)
45                                                              !: jpioipsl option has been removed)
46      INTEGER                                   ::   nvars    !: number of identified varibles in the file
47      INTEGER                                   ::   iduld    !: id of the unlimited dimension
48      INTEGER                                   ::   lenuld   !: length of the unlimited dimension (number of records in file)
49      INTEGER                                   ::   irec     !: writing record position 
50      CHARACTER(LEN=32)                         ::   uldname  !: name of the unlimited dimension
51      CHARACTER(LEN=32), DIMENSION(jpmax_vars)  ::   cn_var   !: names of the variables
52      INTEGER, DIMENSION(jpmax_vars)            ::   nvid     !: id of the variables
53      INTEGER, DIMENSION(jpmax_vars)            ::   ndims    !: number of dimensions of the variables
54      LOGICAL, DIMENSION(jpmax_vars)            ::   luld     !: variable using the unlimited dimension
55      INTEGER, DIMENSION(jpmax_dims,jpmax_vars) ::   dimsz    !: size of variables dimensions
56      REAL(kind=wp), DIMENSION(jpmax_vars)      ::   scf      !: scale_factor of the variables
57      REAL(kind=wp), DIMENSION(jpmax_vars)      ::   ofs      !: add_offset of the variables
58      INTEGER                                   ::   nlev     ! number of vertical levels
59   END TYPE file_descriptor
60   TYPE(file_descriptor), DIMENSION(jpmax_files), PUBLIC ::   iom_file !: array containing the info for all opened files
61   INTEGER, PARAMETER, PUBLIC                   :: max_rst_fields = 95 !: maximum number of restart variables defined in iom_set_rst_vars
62   TYPE, PUBLIC :: RST_FIELD 
63    CHARACTER(len=30) :: vname = "NO_NAME" ! names of variables in restart file
64    CHARACTER(len=30) :: grid = "NO_GRID"
65    LOGICAL           :: active =.FALSE. ! for restart write only: true - write field, false do not write field
66   END TYPE RST_FIELD
67!$AGRIF_END_DO_NOT_TREAT
68   !
69   TYPE(RST_FIELD), PUBLIC, SAVE :: rst_wfields(max_rst_fields), rst_rfields(max_rst_fields)
70   !
71   !! * Substitutions
72#  include "do_loop_substitute.h90"
73   !!----------------------------------------------------------------------
74   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
75   !! $Id$
76   !! Software governed by the CeCILL license (see ./LICENSE)
77   !!======================================================================
78END MODULE iom_def
Note: See TracBrowser for help on using the repository browser.