1 |
C |
2 |
C Invocation from WRAPPER level... |
3 |
C : |
4 |
C : |
5 |
C | |
6 |
C |-THE_MODEL_MAIN :: Primary driver for the MITgcm algorithm |
7 |
C | :: Called from WRAPPER level numerical |
8 |
C | :: code innvocation routine. On entry |
9 |
C | :: to THE_MODEL_MAIN separate thread and |
10 |
C | :: separate processes will have been established. |
11 |
C | :: Each thread and process will have a unique ID |
12 |
C | :: but as yet it will not be associated with a |
13 |
C | :: specific region in decomposed discrete space. |
14 |
C | |
15 |
C |-INITIALISE_FIXED :: Set fixed model arrays such as topography, |
16 |
C | | :: grid, solver matrices etc.. |
17 |
C | | |
18 |
C | |-INI_PARMS :: Routine to set kernel model parameters. |
19 |
C | | :: By default kernel parameters are read from file |
20 |
C | | :: "data" in directory in which code executes. |
21 |
C | | |
22 |
C | |-MON_INIT :: Initialises monitor pacakge ( see pkg/monitor ) |
23 |
C | | |
24 |
C | |-INI_GRID :: Control grid array (vert. and hori.) initialisation. |
25 |
C | | | :: Grid arrays are held and described in GRID.h. |
26 |
C | | | |
27 |
C | | |-INI_VERTICAL_GRID :: Initialise vertical grid arrays. |
28 |
C | | | |
29 |
C | | |-INI_CARTESIAN_GRID :: Cartesian horiz. grid initialisation |
30 |
C | | | :: (calculate grid from kernel parameters). |
31 |
C | | | |
32 |
C | | |-INI_SPHERICAL_POLAR_GRID :: Spherical polar horiz. grid |
33 |
C | | | :: initialisation (calculate grid from |
34 |
C | | | :: kernel parameters). |
35 |
C | | | |
36 |
C | | |-INI_CURVILINEAR_GRID :: General orthogonal, structured horiz. |
37 |
C | | :: grid initialisations. ( input from raw |
38 |
C | | :: grid files, LONC.bin, DXF.bin etc... ) |
39 |
C | | |
40 |
C | |-INI_DEPTHS :: Read (from "bathyFile") or set bathymetry/orgography. |
41 |
C | | |
42 |
C | |-INI_MASKS_ETC :: Derive horizontal and vertical cell fractions and |
43 |
C | | :: land masking for solid-fluid boundaries. |
44 |
C | | |
45 |
C | |-INI_LINEAR_PHSURF :: Set ref. surface Bo_surf |
46 |
C | | |
47 |
C | |-INI_CORI :: Set coriolis term. zero, f-plane, beta-plane, |
48 |
C | | :: sphere optins are coded. |
49 |
C | | |
50 |
C | |-PACAKGES_BOOT :: Start up the optional package environment. |
51 |
C | | :: Runtime selection of active packages. |
52 |
C | | |
53 |
C | |-PACKAGES_READPARMS :: Call active package internal parameter load. |
54 |
C | | | |
55 |
C | | |-GMREDI_READPARMS :: GM Package. see pkg/gmredi |
56 |
C | | |-KPP_READPARMS :: KPP Package. see pkg/kpp |
57 |
C | | |-SHAP_FILT_READPARMS :: Shapiro filter package. see pkg/shap_filt |
58 |
C | | |-OBCS_READPARMS :: Open bndy package. see pkg/obcs |
59 |
C | | |-AIM_READPARMS :: Intermediate Atmos. pacakage. see pkg/aim |
60 |
C | | |-COST_READPARMS :: Cost function package. see pkg/cost |
61 |
C | | |-CTRL_INIT :: Control vector support package. see pkg/ctrl |
62 |
C | | |-OPTIM_READPARMS :: Optimisation support package. see pkg/ctrl |
63 |
C | | |-GRDCHK_READPARMS :: Gradient check package. see pkg/grdchk |
64 |
C | | |-ECCO_READPARMS :: ECCO Support Package. see pkg/ecco |
65 |
C | | |
66 |
C | |-PACKAGES_CHECK |
67 |
C | | | |
68 |
C | | |-KPP_CHECK :: KPP Package. pkg/kpp |
69 |
C | | |-OBCS_CHECK :: Open bndy Pacakge. pkg/obcs |
70 |
C | | |-GMREDI_CHECK :: GM Package. pkg/gmredi |
71 |
C | | |
72 |
C | |-PACKAGES_INIT_FIXED |
73 |
C | | |-OBCS_INIT_FIXED :: Open bndy Package. see pkg/obcs |
74 |
C | | |-FLT_INIT :: Floats Package. see pkg/flt |
75 |
C | | |
76 |
C | |-ZONAL_FILT_INIT :: FFT filter Package. see pkg/zonal_filt |
77 |
C | | |
78 |
C | |-INI_CG2D :: 2d con. grad solver initialisation. |
79 |
C | | |
80 |
C | |-INI_CG3D :: 3d con. grad solver initialisation. |
81 |
C | | |
82 |
C | |-CONFIG_SUMMARY :: Provide synopsis of kernel setup. |
83 |
C | :: Includes annotated table of kernel |
84 |
C | :: parameter settings. |
85 |
C | |
86 |
C |-CTRL_UNPACK :: Control vector support package. see pkg/ctrl |
87 |
C | |
88 |
C |-ADTHE_MAIN_LOOP :: Derivative evaluating form of main time stepping loop |
89 |
C ! :: Auotmatically gerenrated by TAMC/TAF. |
90 |
C | |
91 |
C |-CTRL_PACK :: Control vector support package. see pkg/ctrl |
92 |
C | |
93 |
C |-GRDCHK_MAIN :: Gradient check package. see pkg/grdchk |
94 |
C | |
95 |
C |-THE_MAIN_LOOP :: Main timestepping loop routine. |
96 |
C | | |
97 |
C | |-INITIALISE_VARIA :: Set the initial conditions for time evolving |
98 |
C | | | :: variables |
99 |
C | | | |
100 |
C | | |-INI_LINEAR_PHISURF :: Set ref. surface Bo_surf |
101 |
C | | | |
102 |
C | | |-INI_CORI :: Set coriolis term. zero, f-plane, beta-plane, |
103 |
C | | | :: sphere optins are coded. |
104 |
C | | | |
105 |
C | | |-INI_CG2D :: 2d con. grad solver initialisation. |
106 |
C | | |-INI_CG3D :: 3d con. grad solver initialisation. |
107 |
C | | |-INI_MIXING :: Initialise diapycnal diffusivity. |
108 |
C | | |-INI_DYNVARS :: Initialise to zero all DYNVARS.h arrays (dynamical |
109 |
C | | | :: fields). |
110 |
C | | | |
111 |
C | | |-INI_FIELDS :: Control initialising model fields to non-zero |
112 |
C | | | |-INI_VEL :: Initialize 3D flow field. |
113 |
C | | | |-INI_THETA :: Set model initial temperature field. |
114 |
C | | | |-INI_SALT :: Set model initial salinity field. |
115 |
C | | | |-INI_PSURF :: Set model initial free-surface height/pressure. |
116 |
C | | | |
117 |
C | | |-INI_TR1 :: Set initial tracer 1 distribution. |
118 |
C | | | |
119 |
C | | |-THE_CORRECTION_STEP :: Step forward to next time step. |
120 |
C | | | | :: Here applied to move restart conditions |
121 |
C | | | | :: (saved in mid timestep) to correct level in |
122 |
C | | | | :: time (only used for pre-c35). |
123 |
C | | | | |
124 |
C | | | |-CALC_GRAD_PHI_SURF :: Return DDx and DDy of surface pressure |
125 |
C | | | |-CORRECTION_STEP :: Pressure correction to momentum |
126 |
C | | | |-CYCLE_TRACER :: Move tracers forward in time. |
127 |
C | | | |-OBCS_APPLY :: Open bndy package. see pkg/obcs |
128 |
C | | | |-SHAP_FILT_APPLY :: Shapiro filter package. see pkg/shap_filt |
129 |
C | | | |-ZONAL_FILT_APPLY :: FFT filter package. see pkg/zonal_filt |
130 |
C | | | |-CONVECTIVE_ADJUSTMENT :: Control static instability mixing. |
131 |
C | | | | |-FIND_RHO :: Find adjacent densities. |
132 |
C | | | | |-CONVECT :: Mix static instability. |
133 |
C | | | | |-TIMEAVE_CUMULATE :: Update convection statistics. |
134 |
C | | | | |
135 |
C | | | |-CALC_EXACT_ETA :: Change SSH to flow divergence. |
136 |
C | | | |
137 |
C | | |-CONVECTIVE_ADJUSTMENT_INI :: Control static instability mixing |
138 |
C | | | | :: Extra time history interactions. |
139 |
C | | | | |
140 |
C | | | |-FIND_RHO :: Find adjacent densities. |
141 |
C | | | |-CONVECT :: Mix static instability. |
142 |
C | | | |-TIMEAVE_CUMULATE :: Update convection statistics. |
143 |
C | | | |
144 |
C | | |-PACKAGES_INIT_VARIABLES :: Does initialisation of time evolving |
145 |
C | | | | :: package data. |
146 |
C | | | | |
147 |
C | | | |-GMREDI_INIT :: GM package. ( see pkg/gmredi ) |
148 |
C | | | |-KPP_INIT :: KPP package. ( see pkg/kpp ) |
149 |
C | | | |-KPP_OPEN_DIAGS |
150 |
C | | | |-OBCS_INIT_VARIABLES :: Open bndy. package. ( see pkg/obcs ) |
151 |
C | | | |-AIM_INIT :: Interm. atmos package. ( see pkg/aim ) |
152 |
C | | | |-CTRL_MAP_INI :: Control vector package.( see pkg/ctrl ) |
153 |
C | | | |-COST_INIT :: Cost function package. ( see pkg/cost ) |
154 |
C | | | |-ECCO_INIT :: ECCO support package. ( see pkg/ecco ) |
155 |
C | | | |-INI_FORCING :: Set model initial forcing fields. |
156 |
C | | | | :: Either set in-line or from file as shown. |
157 |
C | | | |-READ_FLD_XY_RS(zonalWindFile) |
158 |
C | | | |-READ_FLD_XY_RS(meridWindFile) |
159 |
C | | | |-READ_FLD_XY_RS(surfQFile) |
160 |
C | | | |-READ_FLD_XY_RS(EmPmRfile) |
161 |
C | | | |-READ_FLD_XY_RS(thetaClimFile) |
162 |
C | | | |-READ_FLD_XY_RS(saltClimFile) |
163 |
C | | | |-READ_FLD_XY_RS(surfQswFile) |
164 |
C | | | |
165 |
C | | |-CALC_SURF_DR :: Calculate the new surface level thickness. |
166 |
C | | |-UPDATE_SURF_DR :: Update the surface-level thickness fraction. |
167 |
C | | |-UPDATE_CG2D :: Update 2d conjugate grad. for Free-Surf. |
168 |
C | | |-STATE_SUMMARY :: Summarize model prognostic variables. |
169 |
C | | |-TIMEAVE_STATVARS :: Time averaging package ( see pkg/timeave ). |
170 |
C | | |
171 |
C | |-WRITE_STATE :: Controlling routine for IO to dump model state. |
172 |
C | | |-WRITE_REC_XYZ_RL :: Single file I/O |
173 |
C | | |-WRITE_FLD_XYZ_RL :: Multi-file I/O |
174 |
C | | |
175 |
C | |-MONITOR :: Monitor state ( see pkg/monitor ) |
176 |
C | |-CTRL_MAP_FORCING :: Control vector support package. ( see pkg/ctrl ) |
177 |
C====|>| |
178 |
C====|>| **************************** |
179 |
C====|>| BEGIN MAIN TIMESTEPPING LOOP |
180 |
C====|>| **************************** |
181 |
C====|>| |
182 |
C/\ | |-FORWARD_STEP :: Step forward a time-step ( AT LAST !!! ) |
183 |
C/\ | | | |
184 |
C/\ | | |-DUMMY_IN_STEPPING :: autodiff package ( pkg/autoduff ). |
185 |
C/\ | | |-CALC_EXACT_ETA :: Change SSH to flow divergence. |
186 |
C/\ | | |-CALC_SURF_DR :: Calculate the new surface level thickness. |
187 |
C/\ | | |-EXF_GETFORCING :: External forcing package. ( pkg/exf ) |
188 |
C/\ | | |-EXTERNAL_FIELDS_LOAD :: Control loading time dep. external data. |
189 |
C/\ | | | | :: Simple interpolcation between end-points |
190 |
C/\ | | | | :: for forcing datasets. |
191 |
C/\ | | | | |
192 |
C/\ | | | |-EXCH :: Sync forcing. in overlap regions. |
193 |
C/\ | | | |
194 |
C/\ | | |-THERMODYNAMICS :: theta, salt + tracer equations driver. |
195 |
C/\ | | | | |
196 |
C/\ | | | |-INTEGRATE_FOR_W :: Integrate for vertical velocity. |
197 |
C/\ | | | |-OBCS_APPLY_W :: Open bndy. package ( see pkg/obcs ). |
198 |
C/\ | | | |-FIND_RHO :: Calculates [rho(S,T,z)-Rhonil] of a slice |
199 |
C/\ | | | |-GRAD_SIGMA :: Calculate isoneutral gradients |
200 |
C/\ | | | |-CALC_IVDC :: Set Implicit Vertical Diffusivity for Convection |
201 |
C/\ | | | | |
202 |
C/\ | | | |-OBCS_CALC :: Open bndy. package ( see pkg/obcs ). |
203 |
C/\ | | | |-EXTERNAL_FORCING_SURF:: Accumulates appropriately dimensioned |
204 |
C/\ | | | | :: forcing terms. |
205 |
C/\ | | | | |
206 |
C/\ | | | |-GMREDI_CALC_TENSOR :: GM package ( see pkg/gmredi ). |
207 |
C/\ | | | |-GMREDI_CALC_TENSOR_DUMMY :: GM package ( see pkg/gmredi ). |
208 |
C/\ | | | |-KPP_CALC :: KPP package ( see pkg/kpp ). |
209 |
C/\ | | | |-KPP_CALC_DUMMY :: KPP package ( see pkg/kpp ). |
210 |
C/\ | | | |-AIM_DO_ATMOS_PHYSICS :: Intermed. atmos package ( see pkg/aim ). |
211 |
C/\ | | | |-GAD_ADVECTION :: Generalised advection driver (multi-dim |
212 |
C/\ | | | | advection case) (see pkg/gad). |
213 |
C/\ | | | |-CALC_COMMON_FACTORS :: Calculate common data (such as volume flux) |
214 |
C/\ | | | |-CALC_DIFFUSIVITY :: Calculate net vertical diffusivity |
215 |
C/\ | | | | | |
216 |
C/\ | | | | |-GMREDI_CALC_DIFF :: GM package ( see pkg/gmredi ). |
217 |
C/\ | | | | |-KPP_CALC_DIFF :: KPP package ( see pkg/kpp ). |
218 |
C/\ | | | | |
219 |
C/\ | | | |-CALC_GT :: Calculate the temperature tendency terms |
220 |
C/\ | | | | | |
221 |
C/\ | | | | |-GAD_CALC_RHS :: Generalised advection package |
222 |
C/\ | | | | | :: ( see pkg/gad ) |
223 |
C/\ | | | | |-EXTERNAL_FORCING_T :: Problem specific forcing for temperature. |
224 |
C/\ | | | | |-ADAMS_BASHFORTH2 :: Extrapolate tendencies forward in time. |
225 |
C/\ | | | | |-FREESURF_RESCALE_G :: Re-scale Gt for free-surface height. |
226 |
C/\ | | | | |
227 |
C/\ | | | |-TIMESTEP_TRACER :: Step tracer field forward in time |
228 |
C/\ | | | | |
229 |
C/\ | | | |-CALC_GS :: Calculate the salinity tendency terms |
230 |
C/\ | | | | | |
231 |
C/\ | | | | |-GAD_CALC_RHS :: Generalised advection package |
232 |
C/\ | | | | | :: ( see pkg/gad ) |
233 |
C/\ | | | | |-EXTERNAL_FORCING_S :: Problem specific forcing for salt. |
234 |
C/\ | | | | |-ADAMS_BASHFORTH2 :: Extrapolate tendencies forward in time. |
235 |
C/\ | | | | |-FREESURF_RESCALE_G :: Re-scale Gs for free-surface height. |
236 |
C/\ | | | | |
237 |
C/\ | | | |-TIMESTEP_TRACER :: Step tracer field forward in time |
238 |
C/\ | | | | |
239 |
C/\ | | | |-CALC_GTR1 :: Calculate other tracer(s) tendency terms |
240 |
C/\ | | | | | |
241 |
C/\ | | | | |-GAD_CALC_RHS :: Generalised advection package |
242 |
C/\ | | | | | :: ( see pkg/gad ) |
243 |
C/\ | | | | |-EXTERNAL_FORCING_TR:: Problem specific forcing for tracer. |
244 |
C/\ | | | | |-ADAMS_BASHFORTH2 :: Extrapolate tendencies forward in time. |
245 |
C/\ | | | | |-FREESURF_RESCALE_G :: Re-scale Gs for free-surface height. |
246 |
C/\ | | | | |
247 |
C/\ | | | |-TIMESTEP_TRACER :: Step tracer field forward in time |
248 |
C/\ | | | |-OBCS_APPLY_TS :: Open bndy. package (see pkg/obcs ). |
249 |
C/\ | | | |-FREEZE :: Limit range of temperature. |
250 |
C/\ | | | | |
251 |
C/\ | | | |-IMPLDIFF :: Solve vertical implicit diffusion equation. |
252 |
C/\ | | | |-OBCS_APPLY_TS :: Open bndy. package (see pkg/obcs ). |
253 |
C/\ | | | | |
254 |
C/\ | | | |-AIM_AIM2DYN_EXCHANGES :: Inetermed. atmos (see pkg/aim). |
255 |
C/\ | | | |-EXCH :: Update overlaps |
256 |
C/\ | | | |
257 |
C/\ | | |-DYNAMICS :: Momentum equations driver. |
258 |
C/\ | | | | |
259 |
C/\ | | | |-CALC_GRAD_PHI_SURF :: Calculate the gradient of the surface |
260 |
C/\ | | | | Potential anomaly. |
261 |
C/\ | | | |-CALC_VISCOSITY :: Calculate net vertical viscosity |
262 |
C/\ | | | | |-KPP_CALC_VISC :: KPP package ( see pkg/kpp ). |
263 |
C/\ | | | | |
264 |
C/\ | | | |-CALC_PHI_HYD :: Integrate the hydrostatic relation. |
265 |
C/\ | | | |-MOM_FLUXFORM :: Flux form mom eqn. package ( see |
266 |
C/\ | | | | pkg/mom_fluxform ). |
267 |
C/\ | | | |-MOM_VECINV :: Vector invariant form mom eqn. package ( see |
268 |
C/\ | | | | pkg/mom_vecinv ). |
269 |
C/\ | | | |-TIMESTEP :: Step momentum fields forward in time |
270 |
C/\ | | | |-OBCS_APPLY_UV :: Open bndy. package (see pkg/obcs ). |
271 |
C/\ | | | | |
272 |
C/\ | | | |-IMPLDIFF :: Solve vertical implicit diffusion equation. |
273 |
C/\ | | | |-OBCS_APPLY_UV :: Open bndy. package (see pkg/obcs ). |
274 |
C/\ | | | | |
275 |
C/\ | | | |-TIMEAVE_CUMUL_1T :: Time averaging package ( see pkg/timeave ). |
276 |
C/\ | | | |-TIMEAVE_CUMUATE :: Time averaging package ( see pkg/timeave ). |
277 |
C/\ | | | |-DEBUG_STATS_RL :: Quick debug package ( see pkg/debug ). |
278 |
C/\ | | | |
279 |
C/\ | | |-CALC_GW :: vert. momentum tendency terms ( NH, QH only ). |
280 |
C/\ | | | |
281 |
C/\ | | |-UPDATE_SURF_DR :: Update the surface-level thickness fraction. |
282 |
C/\ | | | |
283 |
C/\ | | |-UPDATE_CG2D :: Update 2d conjugate grad. for Free-Surf. |
284 |
C/\ | | | |
285 |
C/\ | | |-SOLVE_FOR_PRESSURE :: Find surface pressure. |
286 |
C/\ | | | |-CALC_DIV_GHAT :: Form the RHS of the surface pressure eqn. |
287 |
C/\ | | | |-CG2D :: Two-dim pre-con. conjugate-gradient. |
288 |
C/\ | | | |-CG3D :: Three-dim pre-con. conjugate-gradient solver. |
289 |
C/\ | | | |
290 |
C/\ | | |-THE_CORRECTION_STEP :: Step forward to next time step. |
291 |
C/\ | | | | |
292 |
C/\ | | | |-CALC_GRAD_PHI_SURF :: Return DDx and DDy of surface pressure |
293 |
C/\ | | | |-CORRECTION_STEP :: Pressure correction to momentum |
294 |
C/\ | | | |-CYCLE_TRACER :: Move tracers forward in time. |
295 |
C/\ | | | |-OBCS_APPLY :: Open bndy package. see pkg/obcs |
296 |
C/\ | | | |-SHAP_FILT_APPLY :: Shapiro filter package. see pkg/shap_filt |
297 |
C/\ | | | |-ZONAL_FILT_APPLY :: FFT filter package. see pkg/zonal_filt |
298 |
C/\ | | | |-CONVECTIVE_ADJUSTMENT :: Control static instability mixing. |
299 |
C/\ | | | | |-FIND_RHO :: Find adjacent densities. |
300 |
C/\ | | | | |-CONVECT :: Mix static instability. |
301 |
C/\ | | | | |-TIMEAVE_CUMULATE :: Update convection statistics. |
302 |
C/\ | | | | |
303 |
C/\ | | | |-CALC_EXACT_ETA :: Change SSH to flow divergence. |
304 |
C/\ | | | |
305 |
C/\ | | |-DO_FIELDS_BLOCKING_EXCHANGES :: Sync up overlap regions. |
306 |
C/\ | | | |-EXCH |
307 |
C/\ | | | |
308 |
C/\ | | |-FLT_MAIN :: Float package ( pkg/flt ). |
309 |
C/\ | | | |
310 |
C/\ | | |-MONITOR :: Monitor package ( pkg/monitor ). |
311 |
C/\ | | | |
312 |
C/\ | | |-DO_THE_MODEL_IO :: Standard diagnostic I/O. |
313 |
C/\ | | | |-WRITE_STATE :: Core state I/O |
314 |
C/\ | | | |-TIMEAVE_STATV_WRITE :: Time averages. see pkg/timeave |
315 |
C/\ | | | |-AIM_WRITE_DIAGS :: Intermed. atmos diags. see pkg/aim |
316 |
C/\ | | | |-GMREDI_DIAGS :: GM diags. see pkg/gmredi |
317 |
C/\ | | | |-KPP_DO_DIAGS :: KPP diags. see pkg/kpp |
318 |
C/\ | | | |
319 |
C/\ | | |-WRITE_CHECKPOINT :: Do I/O for restart files. |
320 |
C/\ | | |
321 |
C/\ | |-COST_TILE :: Cost function package. ( see pkg/cost ) |
322 |
C<===|=| |
323 |
C<===|=| ************************** |
324 |
C<===|=| END MAIN TIMESTEPPING LOOP |
325 |
C<===|=| ************************** |
326 |
C<===|=| |
327 |
C | |-COST_FINAL :: Cost function package. ( see pkg/cost ) |
328 |
C | |
329 |
C |-WRITE_CHECKPOINT :: Final state storage, for restart. |
330 |
C | |
331 |
C |-TIMER_PRINTALL :: Computational timing summary |
332 |
C | |
333 |
C |-COMM_STATS :: Summarise inter-proc and inter-thread communication |
334 |
C :: events. |