1 | MODULE in_out_manager |
---|
2 | !!====================================================================== |
---|
3 | !! *** MODULE in_out_manager *** |
---|
4 | !! Ocean physics: vertical mixing coefficient compute from the tke |
---|
5 | !! turbulent closure parameterization |
---|
6 | !!===================================================================== |
---|
7 | !! History : 1.0 ! 2002-06 (G. Madec) original code |
---|
8 | !! 2.0 ! 2006-07 (S. Masson) iom, add ctl_stop, ctl_warn |
---|
9 | !! 3.0 ! 2008-06 (G. Madec) add ctmp4 to ctmp10 |
---|
10 | !!---------------------------------------------------------------------- |
---|
11 | |
---|
12 | !!---------------------------------------------------------------------- |
---|
13 | !! ctl_stop : update momentum and tracer Kz from a tke scheme |
---|
14 | !! ctl_warn : initialization, namelist read, and parameters control |
---|
15 | !! getunit : give the index of an unused logical unit |
---|
16 | !!---------------------------------------------------------------------- |
---|
17 | USE par_kind ! kind definition |
---|
18 | USE par_oce ! ocean parameter |
---|
19 | USE lib_print ! formated print library |
---|
20 | |
---|
21 | IMPLICIT NONE |
---|
22 | PUBLIC |
---|
23 | |
---|
24 | !!---------------------------------------------------------------------- |
---|
25 | !! namrun namelist parameters |
---|
26 | !!---------------------------------------------------------------------- |
---|
27 | CHARACTER(len=16) :: cexper = "exp0" !: experiment name used for output filename |
---|
28 | CHARACTER(len=32) :: cn_ocerst_in = "restart" !: suffix of ocean restart name (input) |
---|
29 | CHARACTER(len=32) :: cn_ocerst_out = "restart" !: suffix of ocean restart name (output) |
---|
30 | LOGICAL :: ln_rstart = .FALSE. !: start from (F) rest or (T) a restart file |
---|
31 | INTEGER :: no = 0 !: job number |
---|
32 | INTEGER :: nrstdt = 0 !: control of the time step (0, 1 or 2) |
---|
33 | INTEGER :: nn_rstssh = 0 !: hand made initilization of ssh or not (1/0) |
---|
34 | INTEGER :: nit000 = 1 !: index of the first time step |
---|
35 | INTEGER :: nitend = 10 !: index of the last time step |
---|
36 | INTEGER :: ndate0 = 961115 !: initial calendar date aammjj |
---|
37 | INTEGER :: nleapy = 0 !: Leap year calendar flag (0/1 or 30) |
---|
38 | INTEGER :: ninist = 0 !: initial state output flag (0/1) |
---|
39 | LOGICAL :: ln_dimgnnn = .FALSE. !: type of dimgout. (F): 1 file for all proc |
---|
40 | !: (T): 1 file per proc |
---|
41 | !!---------------------------------------------------------------------- |
---|
42 | !! was in restart but moved here because of the OFF line... better solution should be found... |
---|
43 | !!---------------------------------------------------------------------- |
---|
44 | INTEGER :: nitrst !: time step at which restart file should be written |
---|
45 | !!---------------------------------------------------------------------- |
---|
46 | !! output monitoring |
---|
47 | !!---------------------------------------------------------------------- |
---|
48 | LOGICAL :: ln_ctl = .FALSE. !: run control for debugging |
---|
49 | INTEGER :: nstock = 10 !: restart file frequency |
---|
50 | INTEGER :: nprint = 0 !: level of print (0 no print) |
---|
51 | INTEGER :: nwrite = 10 !: restart file frequency |
---|
52 | INTEGER :: nictls = 0 !: Start i indice for the SUM control |
---|
53 | INTEGER :: nictle = 0 !: End i indice for the SUM control |
---|
54 | INTEGER :: njctls = 0 !: Start j indice for the SUM control |
---|
55 | INTEGER :: njctle = 0 !: End j indice for the SUM control |
---|
56 | INTEGER :: isplt = 1 !: number of processors following i |
---|
57 | INTEGER :: jsplt = 1 !: number of processors following j |
---|
58 | INTEGER :: ijsplt = 1 !: nb of local domain = nb of processors |
---|
59 | INTEGER :: nbench = 0 !: benchmark parameter (0/1) |
---|
60 | INTEGER :: nbit_cmp = 0 !: bit reproducibility (0/1) |
---|
61 | !!---------------------------------------------------------------------- |
---|
62 | !! logical units |
---|
63 | !!---------------------------------------------------------------------- |
---|
64 | INTEGER :: numstp !: logical unit for time step |
---|
65 | INTEGER :: numout !: logical unit for output print |
---|
66 | INTEGER :: numnam !: logical unit for namelist |
---|
67 | INTEGER :: numnam_ice !: logical unit for ice namelist |
---|
68 | INTEGER :: numevo_ice !: logical unit for ice variables (temp. evolution) |
---|
69 | INTEGER :: numsol !: logical unit for solver statistics |
---|
70 | INTEGER :: numwri !: logical unit for output write |
---|
71 | INTEGER :: numisp !: logical unit for island statistics |
---|
72 | INTEGER :: numgap !: logical unit for differences diagnostic |
---|
73 | INTEGER :: numbol !: logical unit for "bol" diagnostics |
---|
74 | INTEGER :: numptr !: logical unit for Poleward TRansports |
---|
75 | INTEGER :: numflo !: logical unit for drifting floats |
---|
76 | |
---|
77 | !!---------------------------------------------------------------------- |
---|
78 | !! Run control |
---|
79 | !!---------------------------------------------------------------------- |
---|
80 | |
---|
81 | INTEGER :: nstop = 0 !: error flag (=number of reason for a premature stop run) |
---|
82 | INTEGER :: nwarn = 0 !: warning flag (=number of warning found during the run) |
---|
83 | CHARACTER(len=200) :: ctmp1, ctmp2, ctmp3 !: temporary characters 1 to 3 |
---|
84 | CHARACTER(len=200) :: ctmp4, ctmp5, ctmp6 !: temporary characters 4 to 6 |
---|
85 | CHARACTER(len=200) :: ctmp7, ctmp8, ctmp9 !: temporary characters 7 to 9 |
---|
86 | CHARACTER(len=200) :: ctmp10 !: temporary character 10 |
---|
87 | CHARACTER (len=64) :: cform_err = "(/,' ===>>> : E R R O R', /,' ===========',/)" !: |
---|
88 | CHARACTER (len=64) :: cform_war = "(/,' ===>>> : W A R N I N G', /,' ===============',/)" !: |
---|
89 | LOGICAL :: lwp !: boolean : true on the 1st processor only |
---|
90 | LOGICAL :: lsp_area = .TRUE. !: to make a control print over a specific area |
---|
91 | !!---------------------------------------------------------------------- |
---|
92 | !! NEMO/OPA 3.0 , LOCEAN-IPSL (2008) |
---|
93 | !! $Id$ |
---|
94 | !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt) |
---|
95 | !!---------------------------------------------------------------------- |
---|
96 | |
---|
97 | CONTAINS |
---|
98 | |
---|
99 | SUBROUTINE ctl_stop( cd1, cd2, cd3, cd4, cd5, & |
---|
100 | & cd6, cd7, cd8, cd9, cd10 ) |
---|
101 | !!---------------------------------------------------------------------- |
---|
102 | !! *** ROUTINE stop_opa *** |
---|
103 | !! |
---|
104 | !! ** Purpose : print in ocean.outpput file a error message and |
---|
105 | !! increment the error number (nstop) by one. |
---|
106 | !!---------------------------------------------------------------------- |
---|
107 | CHARACTER(len=*), INTENT(in), OPTIONAL :: cd1, cd2, cd3, cd4, cd5 |
---|
108 | CHARACTER(len=*), INTENT(in), OPTIONAL :: cd6, cd7, cd8, cd9, cd10 |
---|
109 | !!---------------------------------------------------------------------- |
---|
110 | ! |
---|
111 | nstop = nstop + 1 |
---|
112 | IF(lwp) THEN |
---|
113 | WRITE(numout,"(/,' ===>>> : E R R O R', /,' ===========',/)") |
---|
114 | IF( PRESENT(cd1 ) ) WRITE(numout,*) cd1 |
---|
115 | IF( PRESENT(cd2 ) ) WRITE(numout,*) cd2 |
---|
116 | IF( PRESENT(cd3 ) ) WRITE(numout,*) cd3 |
---|
117 | IF( PRESENT(cd4 ) ) WRITE(numout,*) cd4 |
---|
118 | IF( PRESENT(cd5 ) ) WRITE(numout,*) cd5 |
---|
119 | IF( PRESENT(cd6 ) ) WRITE(numout,*) cd6 |
---|
120 | IF( PRESENT(cd7 ) ) WRITE(numout,*) cd7 |
---|
121 | IF( PRESENT(cd8 ) ) WRITE(numout,*) cd8 |
---|
122 | IF( PRESENT(cd9 ) ) WRITE(numout,*) cd9 |
---|
123 | IF( PRESENT(cd10) ) WRITE(numout,*) cd10 |
---|
124 | ENDIF |
---|
125 | CALL FLUSH(numout) |
---|
126 | ! |
---|
127 | END SUBROUTINE ctl_stop |
---|
128 | |
---|
129 | |
---|
130 | SUBROUTINE ctl_warn( cd1, cd2, cd3, cd4, cd5, & |
---|
131 | & cd6, cd7, cd8, cd9, cd10 ) |
---|
132 | !!---------------------------------------------------------------------- |
---|
133 | !! *** ROUTINE stop_warn *** |
---|
134 | !! |
---|
135 | !! ** Purpose : print in ocean.outpput file a error message and |
---|
136 | !! increment the warning number (nwarn) by one. |
---|
137 | !!---------------------------------------------------------------------- |
---|
138 | CHARACTER(len=*), INTENT(in), OPTIONAL :: cd1, cd2, cd3, cd4, cd5 |
---|
139 | CHARACTER(len=*), INTENT(in), OPTIONAL :: cd6, cd7, cd8, cd9, cd10 |
---|
140 | !!---------------------------------------------------------------------- |
---|
141 | ! |
---|
142 | nwarn = nwarn + 1 |
---|
143 | IF(lwp) THEN |
---|
144 | WRITE(numout,"(/,' ===>>> : W A R N I N G', /,' ===============',/)") |
---|
145 | IF( PRESENT(cd1 ) ) WRITE(numout,*) cd1 |
---|
146 | IF( PRESENT(cd2 ) ) WRITE(numout,*) cd2 |
---|
147 | IF( PRESENT(cd3 ) ) WRITE(numout,*) cd3 |
---|
148 | IF( PRESENT(cd4 ) ) WRITE(numout,*) cd4 |
---|
149 | IF( PRESENT(cd5 ) ) WRITE(numout,*) cd5 |
---|
150 | IF( PRESENT(cd6 ) ) WRITE(numout,*) cd6 |
---|
151 | IF( PRESENT(cd7 ) ) WRITE(numout,*) cd7 |
---|
152 | IF( PRESENT(cd8 ) ) WRITE(numout,*) cd8 |
---|
153 | IF( PRESENT(cd9 ) ) WRITE(numout,*) cd9 |
---|
154 | IF( PRESENT(cd10) ) WRITE(numout,*) cd10 |
---|
155 | ENDIF |
---|
156 | CALL FLUSH(numout) |
---|
157 | ! |
---|
158 | END SUBROUTINE ctl_warn |
---|
159 | |
---|
160 | |
---|
161 | FUNCTION getunit() |
---|
162 | !!---------------------------------------------------------------------- |
---|
163 | !! *** FUNCTION getunit *** |
---|
164 | !! |
---|
165 | !! ** Purpose : return the index of an unused logical unit |
---|
166 | !!---------------------------------------------------------------------- |
---|
167 | INTEGER :: getunit |
---|
168 | LOGICAL :: llopn |
---|
169 | !!---------------------------------------------------------------------- |
---|
170 | ! |
---|
171 | getunit = 15 ! choose a unit that is big enough then it is not already used in NEMO |
---|
172 | llopn = .TRUE. |
---|
173 | DO WHILE( (getunit < 998) .AND. llopn ) |
---|
174 | getunit = getunit + 1 |
---|
175 | INQUIRE( unit = getunit, opened = llopn ) |
---|
176 | END DO |
---|
177 | IF( (getunit == 999) .AND. llopn ) THEN |
---|
178 | CALL ctl_stop( 'getunit: All logical units until 999 are used...' ) |
---|
179 | getunit = -1 |
---|
180 | ENDIF |
---|
181 | ! |
---|
182 | END FUNCTION getunit |
---|
183 | |
---|
184 | !!===================================================================== |
---|
185 | END MODULE in_out_manager |
---|