source: NEMO/branches/2020/dev_12905_xios_restart/src/OCE/IOM/iom_def.F90 @ 12950

Last change on this file since 12950 was 12950, checked in by andmirek, 5 months ago

Ticket #2462: new XIOS restart read/write interfaces

  • Property svn:keywords set to Id
File size: 5.1 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   USE netcdf
12
13   IMPLICIT NONE
14   PRIVATE
15
16   INTEGER, PARAMETER, PUBLIC ::   jpdom_data          = 1   !: ( 1  :jpiglo, 1  :jpjglo)    !!gm to be suppressed
17   INTEGER, PARAMETER, PUBLIC ::   jpdom_global        = 2   !: ( 1  :jpiglo, 1  :jpjglo)
18   INTEGER, PARAMETER, PUBLIC ::   jpdom_local         = 3   !: One of the 3 following cases
19   INTEGER, PARAMETER, PUBLIC ::   jpdom_local_full    = 4   !: ( 1  :jpi   , 1  :jpi   )
20   INTEGER, PARAMETER, PUBLIC ::   jpdom_local_noextra = 5   !: ( 1  :nlci  , 1  :nlcj  )
21   INTEGER, PARAMETER, PUBLIC ::   jpdom_local_noovlap = 6   !: (nldi:nlei  ,nldj:nlej  )
22   INTEGER, PARAMETER, PUBLIC ::   jpdom_unknown       = 7   !: No dimension checking
23   INTEGER, PARAMETER, PUBLIC ::   jpdom_autoglo       = 8   !:
24   INTEGER, PARAMETER, PUBLIC ::   jpdom_autoglo_xy    = 9   !: Automatically set horizontal dimensions only
25   INTEGER, PARAMETER, PUBLIC ::   jpdom_autodta       = 10  !:
26
27   INTEGER, PARAMETER, PUBLIC ::   jp_r8    = 200      !: write REAL(8)
28   INTEGER, PARAMETER, PUBLIC ::   jp_r4    = 201      !: write REAL(4)
29   INTEGER, PARAMETER, PUBLIC ::   jp_i4    = 202      !: write INTEGER(4)
30   INTEGER, PARAMETER, PUBLIC ::   jp_i2    = 203      !: write INTEGER(2)
31   INTEGER, PARAMETER, PUBLIC ::   jp_i1    = 204      !: write INTEGER(1)
32
33   INTEGER, PARAMETER, PUBLIC ::   jpmax_files  = 100  !: maximum number of simultaneously opened file
34   INTEGER, PARAMETER, PUBLIC ::   jpmax_vars   = 1200 !: maximum number of variables in one file
35   INTEGER, PARAMETER, PUBLIC ::   jpmax_dims   =  4   !: maximum number of dimensions for one variable
36   INTEGER, PARAMETER, PUBLIC ::   jpmax_digits =  5   !: maximum number of digits for the cpu number in the file name
37
38
39!$AGRIF_DO_NOT_TREAT
40   INTEGER, PUBLIC            ::   iom_open_init = 0   !: used to initialize iom_file(:)%nfid to 0
41!XIOS write restart   
42   LOGICAL, PUBLIC            ::   lwxios          !: write single file restart using XIOS
43   INTEGER, PUBLIC            ::   nxioso          !: type of restart file when writing using XIOS 1 - single, 2 - multiple
44!XIOS read restart   
45   LOGICAL, PUBLIC            ::   lrxios          !: read single file restart using XIOS
46   LOGICAL, PUBLIC            ::   lxios_sini = .FALSE. ! is restart in a single file
47   LOGICAL, PUBLIC            ::   lxios_set  = .FALSE. 
48
49
50
51   TYPE, PUBLIC ::   file_descriptor
52      CHARACTER(LEN=240)                        ::   name     !: name of the file
53      CHARACTER(LEN=3  )                        ::   comp     !: name of component opening the file ('OCE', 'ICE'...)
54      INTEGER                                   ::   nfid     !: identifier of the file (0 if closed)
55                                                              !: jpioipsl option has been removed)
56      INTEGER                                   ::   nvars    !: number of identified varibles in the file
57      INTEGER                                   ::   iduld    !: id of the unlimited dimension
58      INTEGER                                   ::   lenuld   !: length of the unlimited dimension (number of records in file)
59      INTEGER                                   ::   irec     !: writing record position 
60      CHARACTER(LEN=32)                         ::   uldname  !: name of the unlimited dimension
61      CHARACTER(LEN=32), DIMENSION(jpmax_vars)  ::   cn_var   !: names of the variables
62      INTEGER, DIMENSION(jpmax_vars)            ::   nvid     !: id of the variables
63      INTEGER, DIMENSION(jpmax_vars)            ::   ndims    !: number of dimensions of the variables
64      LOGICAL, DIMENSION(jpmax_vars)            ::   luld     !: variable using the unlimited dimension
65      INTEGER, DIMENSION(jpmax_dims,jpmax_vars) ::   dimsz    !: size of variables dimensions
66      REAL(kind=wp), DIMENSION(jpmax_vars)      ::   scf      !: scale_factor of the variables
67      REAL(kind=wp), DIMENSION(jpmax_vars)      ::   ofs      !: add_offset of the variables
68   END TYPE file_descriptor
69   TYPE(file_descriptor), DIMENSION(jpmax_files), PUBLIC ::   iom_file !: array containing the info for all opened files
70!metadata in restart file for restart read with XIOS
71   INTEGER, PUBLIC, PARAMETER :: NMETA = 10
72   CHARACTER(LEN=nf90_max_name), PUBLIC :: meta(NMETA)
73!$AGRIF_END_DO_NOT_TREAT
74   !
75   !! * Substitutions
76#  include "do_loop_substitute.h90"
77   !!----------------------------------------------------------------------
78   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
79   !! $Id$
80   !! Software governed by the CeCILL license (see ./LICENSE)
81   !!======================================================================
82END MODULE iom_def
Note: See TracBrowser for help on using the repository browser.