source: branches/UKMO/dev_r8864_restart_date/NEMOGCM/NEMO/OPA_SRC/IOM/in_out_manager.F90 @ 9390

Last change on this file since 9390 was 9390, checked in by davestorkey, 3 years ago

UKMO/dev_r8864_restart_date branch: commit changes.

File size: 10.7 KB
Line 
1MODULE in_out_manager   
2   !!======================================================================
3   !!                       ***  MODULE  in_out_manager  ***
4   !! I/O manager utilities : Defines run parameters together with logical units
5   !!=====================================================================
6   !! History :   1.0  !  2002-06  (G. Madec)   original code
7   !!             2.0  !  2006-07  (S. Masson)  iom, add ctl_stop, ctl_warn
8   !!             3.0  !  2008-06  (G. Madec)   add ctmp4 to ctmp10
9   !!             3.2  !  2009-08  (S. MAsson)  add new ctl_opn
10   !!             3.3  !  2010-10  (A. Coward)  add NetCDF4 usage
11   !!----------------------------------------------------------------------
12
13   !!----------------------------------------------------------------------
14   USE par_oce       ! ocean parameter
15   USE nc4interface  ! NetCDF4 interface
16
17   IMPLICIT NONE
18   PUBLIC
19
20   !!----------------------------------------------------------------------
21   !!                   namrun namelist parameters
22   !!----------------------------------------------------------------------
23   CHARACTER(lc) ::   cn_exp           !: experiment name used for output filename
24   CHARACTER(lc) ::   cn_ocerst_in     !: suffix of ocean restart name (input)
25   CHARACTER(lc) ::   cn_ocerst_indir  !: restart input directory
26   CHARACTER(lc) ::   cn_ocerst_out    !: suffix of ocean restart name (output)
27   CHARACTER(lc) ::   cn_ocerst_outdir !: restart output directory
28   LOGICAL       ::   ln_rstart        !: start from (F) rest or (T) a restart file
29   LOGICAL       ::   ln_rst_list      !: output restarts at list of times (T) or by frequency (F)
30   INTEGER       ::   nn_no            !: job number
31   INTEGER       ::   nn_rstctl        !: control of the time step (0, 1 or 2)
32   INTEGER       ::   nn_rstssh   = 0  !: hand made initilization of ssh or not (1/0)
33   INTEGER       ::   nn_it000         !: index of the first time step
34   INTEGER       ::   nn_itend         !: index of the last time step
35   INTEGER       ::   nn_date0         !: initial calendar date aammjj
36   INTEGER       ::   nn_time0         !: initial time of day in hhmm
37   INTEGER       ::   nn_leapy         !: Leap year calendar flag (0/1 or 30)
38   INTEGER       ::   nn_istate        !: initial state output flag (0/1)
39   INTEGER       ::   nn_write         !: model standard output frequency
40   INTEGER       ::   nn_stock         !: restart file frequency
41   INTEGER, DIMENSION(10) :: nn_stocklist  !: restart dump times
42   LOGICAL       ::   ln_mskland       !: mask land points in NetCDF outputs (costly: + ~15%)
43   LOGICAL       ::   ln_rstdate       !: T=> stamp output restart files with date instead of timestep
44   LOGICAL       ::   ln_cfmeta        !: output additional data to netCDF files required for compliance with the CF metadata standard
45   LOGICAL       ::   ln_clobber       !: clobber (overwrite) an existing file
46   INTEGER       ::   nn_chunksz       !: chunksize (bytes) for NetCDF file (works only with iom_nf90 routines)
47
48#if defined key_netcdf4
49   !!----------------------------------------------------------------------
50   !!                   namnc4 namelist parameters                         (key_netcdf4)
51   !!----------------------------------------------------------------------
52   ! The following four values determine the partitioning of the output fields
53   ! into netcdf4 chunks. They are unrelated to the nn_chunk_sz setting which is
54   ! for runtime optimisation. The individual netcdf4 chunks can be optionally
55   ! gzipped (recommended) leading to significant reductions in I/O volumes
56   !                         !!!**  variables only used with iom_nf90 routines and key_netcdf4 **
57   INTEGER ::   nn_nchunks_i   !: number of chunks required in the i-dimension
58   INTEGER ::   nn_nchunks_j   !: number of chunks required in the j-dimension
59   INTEGER ::   nn_nchunks_k   !: number of chunks required in the k-dimension
60   INTEGER ::   nn_nchunks_t   !: number of chunks required in the t-dimension
61   LOGICAL ::   ln_nc4zip      !: netcdf4 usage: (T) chunk and compress output using the HDF5 sublayers of netcdf4
62   !                           !                 (F) ignore chunking request and use the netcdf4 library
63   !                           !                     to produce netcdf3-compatible files
64#endif
65
66!$AGRIF_DO_NOT_TREAT
67   TYPE(snc4_ctl)     :: snc4set        !: netcdf4 chunking control structure (always needed for decision making)
68!$AGRIF_END_DO_NOT_TREAT
69
70
71   !! conversion of DOCTOR norm namelist name into model name
72   !! (this should disappear in a near futur)
73
74   CHARACTER(lc) ::   cexper                      !: experiment name used for output filename
75   INTEGER       ::   no                          !: job number
76   INTEGER       ::   nrstdt                      !: control of the time step (0, 1 or 2)
77   INTEGER       ::   nit000                      !: index of the first time step
78   INTEGER       ::   nitend                      !: index of the last time step
79   INTEGER       ::   ndate0                      !: initial calendar date aammjj
80   INTEGER       ::   nleapy                      !: Leap year calendar flag (0/1 or 30)
81   INTEGER       ::   ninist                      !: initial state output flag (0/1)
82   INTEGER       ::   nwrite                      !: model standard output frequency
83   INTEGER       ::   nstock                      !: restart file frequency
84   INTEGER, DIMENSION(10) :: nstocklist           !: restart dump times
85
86   !!----------------------------------------------------------------------
87   !! was in restart but moved here because of the OFF line... better solution should be found...
88   !!----------------------------------------------------------------------
89   INTEGER ::   nitrst                !: time step at which restart file should be written
90   LOGICAL ::   lrst_oce              !: logical to control the oce restart write
91   INTEGER ::   numror = 0            !: logical unit for ocean restart (read). Init to 0 is needed for SAS (in daymod.F90)
92   INTEGER ::   numrow                !: logical unit for ocean restart (write)
93   INTEGER ::   nrst_lst              !: number of restart to output next
94
95   !!----------------------------------------------------------------------
96   !!                    output monitoring
97   !!----------------------------------------------------------------------
98   LOGICAL ::   ln_ctl           !: run control for debugging
99   INTEGER ::   nn_timing        !: run control for timing
100   INTEGER ::   nn_diacfl        !: flag whether to create CFL diagnostics
101   INTEGER ::   nn_print         !: level of print (0 no print)
102   INTEGER ::   nn_ictls         !: Start i indice for the SUM control
103   INTEGER ::   nn_ictle         !: End   i indice for the SUM control
104   INTEGER ::   nn_jctls         !: Start j indice for the SUM control
105   INTEGER ::   nn_jctle         !: End   j indice for the SUM control
106   INTEGER ::   nn_isplt         !: number of processors following i
107   INTEGER ::   nn_jsplt         !: number of processors following j
108   INTEGER ::   nn_bench         !: benchmark parameter (0/1)
109   INTEGER ::   nn_bit_cmp = 0   !: bit reproducibility  (0/1)
110   !                                         
111   INTEGER ::   nprint, nictls, nictle, njctls, njctle, isplt, jsplt    !: OLD namelist names
112
113   INTEGER ::   ijsplt     =    1      !: nb of local domain = nb of processors
114
115   !!----------------------------------------------------------------------
116   !!                        logical units
117   !!----------------------------------------------------------------------
118   INTEGER ::   numstp          =   -1      !: logical unit for time step
119   INTEGER ::   numtime         =   -1      !: logical unit for timing
120   INTEGER ::   numout          =    6      !: logical unit for output print; Set to stdout to ensure any early
121                                            !  output can be collected; do not change
122   INTEGER ::   numnam_ref      =   -1      !: logical unit for reference namelist
123   INTEGER ::   numnam_cfg      =   -1      !: logical unit for configuration specific namelist
124   INTEGER ::   numond          =   -1      !: logical unit for Output Namelist Dynamics
125   INTEGER ::   numnam_ice_ref  =   -1      !: logical unit for ice reference namelist
126   INTEGER ::   numnam_ice_cfg  =   -1      !: logical unit for ice reference namelist
127   INTEGER ::   numoni          =   -1      !: logical unit for Output Namelist Ice
128   INTEGER ::   numevo_ice      =   -1      !: logical unit for ice variables (temp. evolution)
129   INTEGER ::   numsol          =   -1      !: logical unit for solver statistics
130   INTEGER ::   numdct_in       =   -1      !: logical unit for transports computing
131   INTEGER ::   numdct_vol      =   -1      !: logical unit for voulume transports output
132   INTEGER ::   numdct_heat     =   -1      !: logical unit for heat    transports output
133   INTEGER ::   numdct_salt     =   -1      !: logical unit for salt    transports output
134   INTEGER ::   numfl           =   -1      !: logical unit for floats ascii output
135   INTEGER ::   numflo          =   -1      !: logical unit for floats ascii output
136
137   !!----------------------------------------------------------------------
138   !!                          Run control 
139   !!----------------------------------------------------------------------
140   INTEGER       ::   no_print = 0          !: optional argument of fld_fill (if present, suppress some control print)
141   INTEGER       ::   nstop = 0             !: error flag (=number of reason for a premature stop run)
142   INTEGER       ::   nwarn = 0             !: warning flag (=number of warning found during the run)
143   CHARACTER(lc) ::   ctmp1, ctmp2, ctmp3   !: temporary characters 1 to 3
144   CHARACTER(lc) ::   ctmp4, ctmp5, ctmp6   !: temporary characters 4 to 6
145   CHARACTER(lc) ::   ctmp7, ctmp8, ctmp9   !: temporary characters 7 to 9
146   CHARACTER(lc) ::   ctmp10                !: temporary character 10
147   CHARACTER(lc) ::   cform_err = "(/,' ===>>> : E R R O R',     /,'         ===========',/)"       !:
148   CHARACTER(lc) ::   cform_war = "(/,' ===>>> : W A R N I N G', /,'         ===============',/)"   !:
149   LOGICAL       ::   lwm      = .FALSE.    !: boolean : true on the 1st processor only (always)
150   LOGICAL       ::   lwp      = .FALSE.    !: boolean : true on the 1st processor only .OR. ln_ctl
151   LOGICAL       ::   lsp_area = .TRUE.     !: to make a control print over a specific area
152   CHARACTER(lc) ::   cxios_context         !: context name used in xios
153
154   !!----------------------------------------------------------------------
155   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
156   !! $Id$
157   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
158   !!=====================================================================
159END MODULE in_out_manager
Note: See TracBrowser for help on using the repository browser.