source: NEMO/branches/UKMO/r12083_restart_datestamp/src/OCE/IOM/in_out_manager.F90 @ 12477

Last change on this file since 12477 was 12477, checked in by jcastill, 12 months ago

Changes as in the original branch, plus changes for bgc restart (in branch AMM15_v3_6_STABLE_package_collate)

File size: 12.4 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_rstctl        !: control of the time step (0, 1 or 2)
31   INTEGER       ::   nn_rstssh   = 0  !: hand made initilization of ssh or not (1/0)
32   INTEGER       ::   nn_it000         !: index of the first time step
33   INTEGER       ::   nn_itend         !: index of the last time step
34   INTEGER       ::   nn_date0         !: initial calendar date aammjj
35   INTEGER       ::   nn_time0         !: initial time of day in hhmm
36   INTEGER       ::   nn_leapy         !: Leap year calendar flag (0/1 or 30)
37   INTEGER       ::   nn_istate        !: initial state output flag (0/1)
38   INTEGER       ::   nn_write         !: model standard output frequency
39   INTEGER       ::   nn_stock         !: restart file frequency
40   INTEGER, DIMENSION(10) :: nn_stocklist  !: restart dump times
41   LOGICAL       ::   ln_mskland       !: mask land points in NetCDF outputs (costly: + ~15%)
42   LOGICAL       ::   ln_cfmeta        !: output additional data to netCDF files required for compliance with the CF metadata standard
43   LOGICAL       ::   ln_clobber       !: clobber (overwrite) an existing file
44   INTEGER       ::   nn_chunksz       !: chunksize (bytes) for NetCDF file (works only with iom_nf90 routines)
45   LOGICAL       ::   ln_xios_read     !: use xios to read single file restart
46   INTEGER       ::   nn_wxios         !: write resart using xios 0 - no, 1 - single, 2 - multiple file output
47   INTEGER       ::   nn_no            !: Assimilation cycle
48
49#if defined key_netcdf4
50   !!----------------------------------------------------------------------
51   !!                   namnc4 namelist parameters                         (key_netcdf4)
52   !!----------------------------------------------------------------------
53   ! The following four values determine the partitioning of the output fields
54   ! into netcdf4 chunks. They are unrelated to the nn_chunk_sz setting which is
55   ! for runtime optimisation. The individual netcdf4 chunks can be optionally
56   ! gzipped (recommended) leading to significant reductions in I/O volumes
57   !                         !!!**  variables only used with iom_nf90 routines and key_netcdf4 **
58   INTEGER ::   nn_nchunks_i   !: number of chunks required in the i-dimension
59   INTEGER ::   nn_nchunks_j   !: number of chunks required in the j-dimension
60   INTEGER ::   nn_nchunks_k   !: number of chunks required in the k-dimension
61   INTEGER ::   nn_nchunks_t   !: number of chunks required in the t-dimension
62   LOGICAL ::   ln_nc4zip      !: netcdf4 usage: (T) chunk and compress output using the HDF5 sublayers of netcdf4
63   !                           !                 (F) ignore chunking request and use the netcdf4 library
64   !                           !                     to produce netcdf3-compatible files
65#endif
66
67!$AGRIF_DO_NOT_TREAT
68   TYPE(snc4_ctl)     :: snc4set        !: netcdf4 chunking control structure (always needed for decision making)
69!$AGRIF_END_DO_NOT_TREAT
70
71
72   !! conversion of DOCTOR norm namelist name into model name
73   !! (this should disappear in a near futur)
74
75   CHARACTER(lc) ::   cexper                      !: experiment name used for output filename
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   LOGICAL       ::   ln_rstdate = .FALSE.        !: Use calendar date rather than time-step in restart
81   INTEGER       ::   nleapy                      !: Leap year calendar flag (0/1 or 30)
82   INTEGER       ::   ninist                      !: initial state output flag (0/1)
83
84   !!----------------------------------------------------------------------
85   !! was in restart but moved here because of the OFF line... better solution should be found...
86   !!----------------------------------------------------------------------
87   INTEGER ::   nitrst                !: time step at which restart file should be written
88   LOGICAL ::   lrst_oce              !: logical to control the oce restart write
89   LOGICAL ::   lrst_ice              !: logical to control the ice restart write
90   INTEGER ::   numror = 0            !: logical unit for ocean restart (read). Init to 0 is needed for SAS (in daymod.F90)
91   INTEGER ::   numrir                !: logical unit for ice   restart (read)
92   INTEGER ::   numrow                !: logical unit for ocean restart (write)
93   INTEGER ::   numriw                !: logical unit for ice   restart (write)
94   INTEGER ::   nrst_lst              !: number of restart to output next
95
96   !!----------------------------------------------------------------------
97   !!                    output monitoring
98   !!----------------------------------------------------------------------
99   LOGICAL ::   ln_ctl           !: run control for debugging
100   TYPE :: sn_ctl                !: optional use structure for finer control over output selection
101      LOGICAL :: l_config  = .FALSE.  !: activate/deactivate finer control
102                                      !  Note if l_config is True then ln_ctl is ignored.
103                                      !  Otherwise setting ln_ctl True is equivalent to setting
104                                      !  all the following logicals in this structure True
105      LOGICAL :: l_runstat = .FALSE.  !: Produce/do not produce run.stat file (T/F)
106      LOGICAL :: l_trcstat = .FALSE.  !: Produce/do not produce tracer.stat file (T/F)
107      LOGICAL :: l_oceout  = .FALSE.  !: Produce all ocean.outputs    (T) or just one (F)
108      LOGICAL :: l_layout  = .FALSE.  !: Produce all layout.dat files (T) or just one (F)
109      LOGICAL :: l_mppout  = .FALSE.  !: Produce/do not produce mpp.output_XXXX files (T/F)
110      LOGICAL :: l_mpptop  = .FALSE.  !: Produce/do not produce mpp.top.output_XXXX files (T/F)
111                                      !  Optional subsetting of processor report files
112                                      !  Default settings of 0/1000000/1 should ensure all areas report.
113                                      !  Set to a more restrictive range to select specific areas
114      INTEGER :: procmin   = 0        !: Minimum narea to output
115      INTEGER :: procmax   = 1000000  !: Maximum narea to output
116      INTEGER :: procincr  = 1        !: narea increment to output
117      INTEGER :: ptimincr  = 1        !: timestep increment to output (time.step and run.stat)
118   END TYPE
119   TYPE(sn_ctl), SAVE :: sn_cfctl     !: run control structure for selective output, must have SAVE for default init. of sn_ctl
120   LOGICAL ::   ln_timing        !: run control for timing
121   LOGICAL ::   ln_diacfl        !: flag whether to create CFL diagnostics
122   INTEGER ::   nn_print         !: level of print (0 no print)
123   INTEGER ::   nn_ictls         !: Start i indice for the SUM control
124   INTEGER ::   nn_ictle         !: End   i indice for the SUM control
125   INTEGER ::   nn_jctls         !: Start j indice for the SUM control
126   INTEGER ::   nn_jctle         !: End   j indice for the SUM control
127   INTEGER ::   nn_isplt         !: number of processors following i
128   INTEGER ::   nn_jsplt         !: number of processors following j
129   !                                         
130   INTEGER ::   nprint, nictls, nictle, njctls, njctle, isplt, jsplt    !: OLD namelist names
131
132   INTEGER ::   ijsplt     =    1      !: nb of local domain = nb of processors
133
134   !!----------------------------------------------------------------------
135   !!                        logical units
136   !!----------------------------------------------------------------------
137   INTEGER ::   numstp          =   -1      !: logical unit for time step
138   INTEGER ::   numtime         =   -1      !: logical unit for timing
139   INTEGER ::   numout          =    6      !: logical unit for output print; Set to stdout to ensure any
140   INTEGER ::   numnul          =   -1      !: logical unit for /dev/null
141      !                                     !  early output can be collected; do not change
142   INTEGER ::   numnam_ref      =   -1      !: logical unit for reference namelist
143   INTEGER ::   numnam_cfg      =   -1      !: logical unit for configuration specific namelist
144   INTEGER ::   numond          =   -1      !: logical unit for Output Namelist Dynamics
145   INTEGER ::   numnam_ice_ref  =   -1      !: logical unit for ice reference namelist
146   INTEGER ::   numnam_ice_cfg  =   -1      !: logical unit for ice reference namelist
147   INTEGER ::   numoni          =   -1      !: logical unit for Output Namelist Ice
148   INTEGER ::   numevo_ice      =   -1      !: logical unit for ice variables (temp. evolution)
149   INTEGER ::   numrun          =   -1      !: logical unit for run statistics
150   INTEGER ::   numdct_in       =   -1      !: logical unit for transports computing
151   INTEGER ::   numdct_vol      =   -1      !: logical unit for voulume transports output
152   INTEGER ::   numdct_heat     =   -1      !: logical unit for heat    transports output
153   INTEGER ::   numdct_salt     =   -1      !: logical unit for salt    transports output
154   INTEGER ::   numfl           =   -1      !: logical unit for floats ascii output
155   INTEGER ::   numflo          =   -1      !: logical unit for floats ascii output
156
157   !!----------------------------------------------------------------------
158   !!                          Run control 
159   !!----------------------------------------------------------------------
160   INTEGER       ::   no_print = 0          !: optional argument of fld_fill (if present, suppress some control print)
161   INTEGER       ::   nstop = 0             !: error flag (=number of reason for a premature stop run)
162   INTEGER       ::   nwarn = 0             !: warning flag (=number of warning found during the run)
163   CHARACTER(lc) ::   ctmp1, ctmp2, ctmp3   !: temporary characters 1 to 3
164   CHARACTER(lc) ::   ctmp4, ctmp5, ctmp6   !: temporary characters 4 to 6
165   CHARACTER(lc) ::   ctmp7, ctmp8, ctmp9   !: temporary characters 7 to 9
166   CHARACTER(lc) ::   ctmp10                !: temporary character 10
167   LOGICAL       ::   lwm      = .FALSE.    !: boolean : true on the 1st processor only (always)
168   LOGICAL       ::   lwp      = .FALSE.    !: boolean : true on the 1st processor only .OR. ln_ctl
169   LOGICAL       ::   lsp_area = .TRUE.     !: to make a control print over a specific area
170   CHARACTER(lc) ::   cxios_context         !: context name used in xios
171   CHARACTER(lc) ::   crxios_context         !: context name used in xios to read restart
172   CHARACTER(lc) ::   cwxios_context        !: context name used in xios to write restart file
173
174   !!----------------------------------------------------------------------
175   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
176   !! $Id$
177   !! Software governed by the CeCILL license (see ./LICENSE)
178   !!=====================================================================
179END MODULE in_out_manager
Note: See TracBrowser for help on using the repository browser.