/[MITgcm]/MITgcm/model/src/the_model_main.F
ViewVC logotype

Diff of /MITgcm/model/src/the_model_main.F

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph | View Patch Patch

revision 1.90 by jmc, Wed Nov 9 19:54:23 2005 UTC revision 1.102 by heimbach, Fri Feb 9 10:20:39 2007 UTC
# Line 34  C  : Line 34  C  :
34  C  |  C  |
35  C  |-THE_MODEL_MAIN :: Primary driver for the MITgcm algorithm  C  |-THE_MODEL_MAIN :: Primary driver for the MITgcm algorithm
36  C    |              :: Called from WRAPPER level numerical  C    |              :: Called from WRAPPER level numerical
37  C    |              :: code innvocation routine. On entry  C    |              :: code invocation routine. On entry
38  C    |              :: to THE_MODEL_MAIN separate thread and  C    |              :: to THE_MODEL_MAIN separate thread and
39  C    |              :: separate processes will have been established.  C    |              :: separate processes will have been established.
40  C    |              :: Each thread and process will have a unique ID  C    |              :: Each thread and process will have a unique ID
# Line 48  C    | |-INI_PARMS :: Routine to set ker Line 48  C    | |-INI_PARMS :: Routine to set ker
48  C    | |           :: By default kernel parameters are read from file  C    | |           :: By default kernel parameters are read from file
49  C    | |           :: "data" in directory in which code executes.  C    | |           :: "data" in directory in which code executes.
50  C    | |  C    | |
51  C    | |-MON_INIT :: Initialises monitor pacakge ( see pkg/monitor )  C    | |-MON_INIT :: Initializes monitor package ( see pkg/monitor )
52  C    | |  C    | |
53  C    | |-INI_GRID :: Control grid array (vert. and hori.) initialisation.  C    | |-INI_GRID :: Control grid array (vert. and hori.) initialization.
54  C    | | |        :: Grid arrays are held and described in GRID.h.  C    | | |        :: Grid arrays are held and described in GRID.h.
55  C    | | |  C    | | |
56  C    | | |-INI_VERTICAL_GRID        :: Initialise vertical grid arrays.  C    | | |-INI_VERTICAL_GRID        :: Initialize vertical grid arrays.
57  C    | | |  C    | | |
58  C    | | |-INI_CARTESIAN_GRID       :: Cartesian horiz. grid initialisation  C    | | |-INI_CARTESIAN_GRID       :: Cartesian horiz. grid initialization
59  C    | | |                          :: (calculate grid from kernel parameters).  C    | | |                          :: (calculate grid from kernel parameters).
60  C    | | |  C    | | |
61  C    | | |-INI_SPHERICAL_POLAR_GRID :: Spherical polar horiz. grid  C    | | |-INI_SPHERICAL_POLAR_GRID :: Spherical polar horiz. grid
62  C    | | |                          :: initialisation (calculate grid from  C    | | |                          :: initialization (calculate grid from
63  C    | | |                          :: kernel parameters).  C    | | |                          :: kernel parameters).
64  C    | | |  C    | | |
65  C    | | |-INI_CURVILINEAR_GRID     :: General orthogonal, structured horiz.  C    | | |-INI_CURVILINEAR_GRID     :: General orthogonal, structured horiz.
66  C    | |                            :: grid initialisations. ( input from raw  C    | |                            :: grid initializations. ( input from raw
67  C    | |                            :: grid files, LONC.bin, DXF.bin etc... )  C    | |                            :: grid files, LONC.bin, DXF.bin etc... )
68  C    | |  C    | |
69  C    | |-INI_DEPTHS    :: Read (from "bathyFile") or set bathymetry/orgography.  C    | |-INI_DEPTHS    :: Read (from "bathyFile") or set bathymetry/orgography.
# Line 74  C    | | Line 74  C    | |
74  C    | |-INI_LINEAR_PHSURF :: Set ref. surface Bo_surf  C    | |-INI_LINEAR_PHSURF :: Set ref. surface Bo_surf
75  C    | |  C    | |
76  C    | |-INI_CORI          :: Set coriolis term. zero, f-plane, beta-plane,  C    | |-INI_CORI          :: Set coriolis term. zero, f-plane, beta-plane,
77  C    | |                   :: sphere optins are coded.  C    | |                   :: sphere options are coded.
78  C    | |  C    | |
79  C    | |-PACAKGES_BOOT      :: Start up the optional package environment.  C    | |-PACAKGES_BOOT      :: Start up the optional package environment.
80  C    | |                    :: Runtime selection of active packages.  C    | |                    :: Runtime selection of active packages.
# Line 107  C    | | |-GCHEM_INIT_FIXED    :: tracer Line 107  C    | | |-GCHEM_INIT_FIXED    :: tracer
107  C    | |  C    | |
108  C    | |-ZONAL_FILT_INIT       :: FFT filter Package. see pkg/zonal_filt  C    | |-ZONAL_FILT_INIT       :: FFT filter Package. see pkg/zonal_filt
109  C    | |  C    | |
110  C    | |-INI_CG2D              :: 2d con. grad solver initialisation.  C    | |-INI_CG2D              :: 2d con. grad solver initialization.
111  C    | |  C    | |
112  C    | |-INI_CG3D              :: 3d con. grad solver initialisation.  C    | |-INI_CG3D              :: 3d con. grad solver initialization.
113  C    | |  C    | |
114  C    | |-CONFIG_SUMMARY        :: Provide synopsis of kernel setup.  C    | |-CONFIG_SUMMARY        :: Provide synopsis of kernel setup.
115  C    |                         :: Includes annotated table of kernel  C    |                         :: Includes annotated table of kernel
# Line 118  C    | Line 118  C    |
118  C    |-CTRL_UNPACK :: Control vector support package. see pkg/ctrl  C    |-CTRL_UNPACK :: Control vector support package. see pkg/ctrl
119  C    |  C    |
120  C    |-ADTHE_MAIN_LOOP :: Derivative evaluating form of main time stepping loop  C    |-ADTHE_MAIN_LOOP :: Derivative evaluating form of main time stepping loop
121  C    !                 :: Auotmatically gerenrated by TAMC/TAF.  C    !                 :: Auotmatically generated by TAMC/TAF.
122  C    |  C    |
123  C    |-CTRL_PACK   :: Control vector support package. see pkg/ctrl  C    |-CTRL_PACK   :: Control vector support package. see pkg/ctrl
124  C    |  C    |
# Line 132  C    | | | Line 132  C    | | |
132  C    | | |-INI_LINEAR_PHISURF :: Set ref. surface Bo_surf  C    | | |-INI_LINEAR_PHISURF :: Set ref. surface Bo_surf
133  C    | | |  C    | | |
134  C    | | |-INI_CORI     :: Set coriolis term. zero, f-plane, beta-plane,  C    | | |-INI_CORI     :: Set coriolis term. zero, f-plane, beta-plane,
135  C    | | |              :: sphere optins are coded.  C    | | |              :: sphere options are coded.
136  C    | | |  C    | | |
137  C    | | |-INI_CG2D     :: 2d con. grad solver initialisation.  C    | | |-INI_CG2D     :: 2d con. grad solver initialization.
138  C    | | |-INI_CG3D     :: 3d con. grad solver initialisation.  C    | | |-INI_CG3D     :: 3d con. grad solver initialization.
139  C    | | |-INI_MIXING   :: Initialise diapycnal diffusivity.  C    | | |-INI_MIXING   :: Initialize diapycnal diffusivity.
140  C    | | |-INI_DYNVARS  :: Initialise to zero all DYNVARS.h arrays (dynamical  C    | | |-INI_DYNVARS  :: Initialize to zero all DYNVARS.h arrays (dynamical
141  C    | | |              :: fields).  C    | | |              :: fields).
142  C    | | |  C    | | |
143  C    | | |-INI_FIELDS   :: Control initialising model fields to non-zero  C    | | |-INI_FIELDS   :: Control initializing model fields to non-zero
144  C    | | | |-INI_VEL    :: Initialize 3D flow field.  C    | | | |-INI_VEL    :: Initialize 3D flow field.
145  C    | | | |-INI_THETA  :: Set model initial temperature field.  C    | | | |-INI_THETA  :: Set model initial temperature field.
146  C    | | | |-INI_SALT   :: Set model initial salinity field.  C    | | | |-INI_SALT   :: Set model initial salinity field.
# Line 173  C    | | | |-FIND_RHO  :: Find adjacent Line 173  C    | | | |-FIND_RHO  :: Find adjacent
173  C    | | | |-CONVECT   :: Mix static instability.  C    | | | |-CONVECT   :: Mix static instability.
174  C    | | | |-TIMEAVE_CUMULATE :: Update convection statistics.  C    | | | |-TIMEAVE_CUMULATE :: Update convection statistics.
175  C    | | |  C    | | |
176  C    | | |-PACKAGES_INIT_VARIABLES :: Does initialisation of time evolving  C    | | |-PACKAGES_INIT_VARIABLES :: Does initialization of time evolving
177  C    | | | |                       :: package data.  C    | | | |                       :: package data.
178  C    | | | |  C    | | | |
179  C    | | | |-GMREDI_INIT          :: GM package. ( see pkg/gmredi )  C    | | | |-GMREDI_INIT          :: GM package. ( see pkg/gmredi )
# Line 181  C    | | | |-KPP_INIT             :: KPP Line 181  C    | | | |-KPP_INIT             :: KPP
181  C    | | | |-KPP_OPEN_DIAGS      C    | | | |-KPP_OPEN_DIAGS    
182  C    | | | |-OBCS_INIT_VARIABLES  :: Open bndy. package. ( see pkg/obcs )  C    | | | |-OBCS_INIT_VARIABLES  :: Open bndy. package. ( see pkg/obcs )
183  C    | | | |-PTRACERS_INIT        :: multi. tracer package,(see pkg/ptracers)  C    | | | |-PTRACERS_INIT        :: multi. tracer package,(see pkg/ptracers)
184  C    | | | |-GCHEM_INIT           : : tracer interface pkg (see pkh/gchem)  C    | | | |-GCHEM_INIT           :: tracer interface pkg (see pkh/gchem)
185  C    | | | |-AIM_INIT             :: Interm. atmos package. ( see pkg/aim )  C    | | | |-AIM_INIT             :: Interm. atmos package. ( see pkg/aim )
186  C    | | | |-CTRL_MAP_INI         :: Control vector package.( see pkg/ctrl )  C    | | | |-CTRL_MAP_INI         :: Control vector package.( see pkg/ctrl )
187  C    | | | |-COST_INIT            :: Cost function package. ( see pkg/cost )  C    | | | |-COST_INIT            :: Cost function package. ( see pkg/cost )
# Line 220  C/\  | | |-CALC_EXACT_ETA :: Change SSH Line 220  C/\  | | |-CALC_EXACT_ETA :: Change SSH
220  C/\  | | |-CALC_SURF_DR   :: Calculate the new surface level thickness.  C/\  | | |-CALC_SURF_DR   :: Calculate the new surface level thickness.
221  C/\  | | |-EXF_GETFORCING :: External forcing package. ( pkg/exf )  C/\  | | |-EXF_GETFORCING :: External forcing package. ( pkg/exf )
222  C/\  | | |-EXTERNAL_FIELDS_LOAD :: Control loading time dep. external data.  C/\  | | |-EXTERNAL_FIELDS_LOAD :: Control loading time dep. external data.
223  C/\  | | | |                    :: Simple interpolcation between end-points  C/\  | | | |                    :: Simple interpolation between end-points
224  C/\  | | | |                    :: for forcing datasets.  C/\  | | | |                    :: for forcing datasets.
225  C/\  | | | |                    C/\  | | | |                  
226  C/\  | | | |-EXCH :: Sync forcing. in overlap regions.  C/\  | | | |-EXCH :: Sync forcing. in overlap regions.
# Line 280  C/\  | | | |-TIMESTEP_TRACER      :: Ste Line 280  C/\  | | | |-TIMESTEP_TRACER      :: Ste
280  C/\  | | | |  C/\  | | | |
281  C/\  | | | |-TIMESTEP_TRACER      :: Step tracer field forward in time  C/\  | | | |-TIMESTEP_TRACER      :: Step tracer field forward in time
282  C/\  | | | |  C/\  | | | |
283  C/\  | | | |-PTRACERS_INTEGRATE   :: Integrate other tracer(s) ( see pkg/ptracers ).  C/\  | | | |-PTRACERS_INTEGRATE   :: Integrate other tracer(s) (see pkg/ptracers).
284  C/\  | | | | |  C/\  | | | | |
285  C/\  | | | | |-GAD_CALC_RHS       :: Generalised advection package  C/\  | | | | |-GAD_CALC_RHS       :: Generalised advection package
286  C/\  | | | | | |                  :: ( see pkg/gad )  C/\  | | | | | |                  :: ( see pkg/gad )
# Line 288  C/\  | | | | | |-KPP_TRANSPORT_PTR:: KPP Line 288  C/\  | | | | | |-KPP_TRANSPORT_PTR:: KPP
288  C/\  | | | | |  C/\  | | | | |
289  C/\  | | | | |-PTRACERS_FORCING   :: Problem specific forcing for tracer.  C/\  | | | | |-PTRACERS_FORCING   :: Problem specific forcing for tracer.
290  C/\  | | | | |-GCHEM_FORCING_INT  :: tracer forcing for gchem pkg (if all  C/\  | | | | |-GCHEM_FORCING_INT  :: tracer forcing for gchem pkg (if all
291  C/\  | | | | |                       tendancy terms calcualted together)  C/\  | | | | |                       tendency terms calcualted together)
292  C/\  | | | | |-ADAMS_BASHFORTH2   :: Extrapolate tendencies forward in time.  C/\  | | | | |-ADAMS_BASHFORTH2   :: Extrapolate tendencies forward in time.
293  C/\  | | | | |-FREESURF_RESCALE_G :: Re-scale Gs for free-surface height.  C/\  | | | | |-FREESURF_RESCALE_G :: Re-scale Gs for free-surface height.
294  C/\  | | | | |-TIMESTEP_TRACER    :: Step tracer field forward in time  C/\  | | | | |-TIMESTEP_TRACER    :: Step tracer field forward in time
# Line 311  C/\  | | | | Line 311  C/\  | | | |
311  C/\  | | | |-CALC_PHI_HYD       :: Integrate the hydrostatic relation.  C/\  | | | |-CALC_PHI_HYD       :: Integrate the hydrostatic relation.
312  C/\  | | | |-MOM_FLUXFORM       :: Flux form mom eqn. package ( see  C/\  | | | |-MOM_FLUXFORM       :: Flux form mom eqn. package ( see
313  C/\  | | | |                       pkg/mom_fluxform ).  C/\  | | | |                       pkg/mom_fluxform ).
314    C/\  | | | | |-MOM_CALC_VISC    :: Calculate Horizontal Viscosities
315  C/\  | | | |-MOM_VECINV         :: Vector invariant form mom eqn. package ( see  C/\  | | | |-MOM_VECINV         :: Vector invariant form mom eqn. package ( see
316  C/\  | | | |                       pkg/mom_vecinv   ).  C/\  | | | |                       pkg/mom_vecinv   ).
317    C/\  | | | | |-MOM_CALC_VISC    :: Calculate Horizontal Viscosities
318  C/\  | | | |-TIMESTEP           :: Step momentum fields forward in time  C/\  | | | |-TIMESTEP           :: Step momentum fields forward in time
319  C/\  | | | |-OBCS_APPLY_UV      :: Open bndy. package (see pkg/obcs ).  C/\  | | | |-OBCS_APPLY_UV      :: Open bndy. package (see pkg/obcs ).
320  C/\  | | | |  C/\  | | | |
# Line 387  C    |-TIMER_PRINTALL :: Computational t Line 389  C    |-TIMER_PRINTALL :: Computational t
389  C    |  C    |
390  C    |-COMM_STATS     :: Summarise inter-proc and inter-thread communication  C    |-COMM_STATS     :: Summarise inter-proc and inter-thread communication
391  C                     :: events.  C                     :: events.
392    C
393  C \ev  C \ev
394  C  C
395  C  C
# Line 464  C     == Global variables === Line 467  C     == Global variables ===
467  # include "tamc.h"  # include "tamc.h"
468  #endif  #endif
469  #ifdef ALLOW_CTRL  #ifdef ALLOW_CTRL
470    # include "ctrl.h"
471  # include "optim.h"  # include "optim.h"
472  #endif  #endif
473    
# Line 493  c--   set default: Line 497  c--   set default:
497        IF (debugMode) CALL DEBUG_ENTER('THE_MODEL_MAIN',myThid)        IF (debugMode) CALL DEBUG_ENTER('THE_MODEL_MAIN',myThid)
498  #endif  #endif
499    
500    #if defined(USE_PAPI) || defined(USE_PCL_FLOPS_SFP) || defined(USE_PCL_FLOPS) || defined(USE_PCL)
501          CALL TIMER_CONTROL('','INIT','THE_MODEL_MAIN',myThid)
502    #endif
503  C--   This timer encompasses the whole code  C--   This timer encompasses the whole code
504        CALL TIMER_START('ALL                    [THE_MODEL_MAIN]',myThid)        CALL TIMER_START('ALL                    [THE_MODEL_MAIN]',myThid)
505    
# Line 519  c Line 526  c
526        IF (myProcId .eq. 0) THEN        IF (myProcId .eq. 0) THEN
527           inquire( file='costfinal', exist=exst )           inquire( file='costfinal', exist=exst )
528           IF ( .NOT. exst ) THEN           IF ( .NOT. exst ) THEN
529              IF ( optimcycle.NE.0 ) THEN              IF ( optimcycle.NE.0 .AND. doMainUnpack ) THEN
530                 CALL TIMER_START('CTRL_UNPACK   [THE_MODEL_MAIN]',mythid)                 CALL TIMER_START('CTRL_UNPACK   [THE_MODEL_MAIN]',mythid)
531                 CALL CTRL_UNPACK( .TRUE. , mythid )                 CALL CTRL_UNPACK( .TRUE. , mythid )
532                 CALL TIMER_STOP ('CTRL_UNPACK   [THE_MODEL_MAIN]',mythid)                 CALL TIMER_STOP ('CTRL_UNPACK   [THE_MODEL_MAIN]',mythid)
# Line 554  c-- The following assumes the TAF option Line 561  c-- The following assumes the TAF option
561           CALL COST_FINAL_STORE ( mythid, lastdiva )           CALL COST_FINAL_STORE ( mythid, lastdiva )
562        ELSE        ELSE
563           CALL TIMER_START('ADTHE_MAIN_LOOP       [ADJOINT RUN]', mythid)           CALL TIMER_START('ADTHE_MAIN_LOOP       [ADJOINT RUN]', mythid)
564           CALL ADTHE_MAIN_LOOP ( myCurrentTime, myCurrentIter, mythid )           CALL ADTHE_MAIN_LOOP (  mythid )
565           CALL TIMER_STOP ('ADTHE_MAIN_LOOP       [ADJOINT RUN]', mythid)           CALL TIMER_STOP ('ADTHE_MAIN_LOOP       [ADJOINT RUN]', mythid)
566           CALL COST_FINAL_RESTORE ( mythid, lastdiva )           CALL COST_FINAL_RESTORE ( mythid, lastdiva )
567        ENDIF        ENDIF
568  c--  c--
569  #  else /* ALLOW_DIVIDED_ADJOINT undef */  #  else /* ALLOW_DIVIDED_ADJOINT undef */
570        CALL TIMER_START('ADTHE_MAIN_LOOP          [ADJOINT RUN]', mythid)        CALL TIMER_START('ADTHE_MAIN_LOOP          [ADJOINT RUN]', mythid)
571        CALL ADTHE_MAIN_LOOP ( myCurrentTime, myCurrentIter, mythid )  #ifdef ALLOW_ECCO
572  cph      CALL ADTHE_MAIN_LOOP ( mythid )        CALL ADTHE_MAIN_LOOP ( myCurrentTime, mythid )
573    #else
574          CALL ADTHE_MAIN_LOOP ( mythid )
575    #endif
576        CALL TIMER_STOP ('ADTHE_MAIN_LOOP          [ADJOINT RUN]', mythid)        CALL TIMER_STOP ('ADTHE_MAIN_LOOP          [ADJOINT RUN]', mythid)
577  #  endif /* ALLOW_DIVIDED_ADJOINT */  #  endif /* ALLOW_DIVIDED_ADJOINT */
578  c  c
# Line 580  C--   Call time stepping loop of full mo Line 590  C--   Call time stepping loop of full mo
590    
591  # ifndef EXCLUDE_CTRL_PACK  # ifndef EXCLUDE_CTRL_PACK
592        _BEGIN_MASTER( mythid )        _BEGIN_MASTER( mythid )
593        IF ( myProcId .eq. 0 .AND. lastdiva ) THEN        IF ( myProcId .eq. 0 .AND. lastdiva .AND. doMainPack ) THEN
594           CALL TIMER_START('CTRL_PACK           [THE_MODEL_MAIN]',mythid)           CALL TIMER_START('CTRL_PACK           [THE_MODEL_MAIN]',mythid)
595           call CTRL_PACK( .FALSE. , mythid )           CALL CTRL_PACK( .FALSE. , mythid )
596           CALL TIMER_STOP ('CTRL_PACK           [THE_MODEL_MAIN]',mythid)           CALL TIMER_STOP ('CTRL_PACK           [THE_MODEL_MAIN]',mythid)
597           IF ( optimcycle.EQ.0 .AND. mycurrentiter.EQ.niter0 ) THEN           IF ( ( optimcycle.EQ.0 .OR. (.NOT. doMainUnpack) )
598         &        .AND. mycurrentiter.EQ.niter0 ) THEN
599              CALL TIMER_START('CTRL_PACK     [THE_MODEL_MAIN]',mythid)              CALL TIMER_START('CTRL_PACK     [THE_MODEL_MAIN]',mythid)
600              CALL CTRL_PACK( .TRUE. , mythid )              CALL CTRL_PACK( .TRUE. , mythid )
601              CALL TIMER_STOP ('CTRL_PACK     [THE_MODEL_MAIN]',mythid)              CALL TIMER_STOP ('CTRL_PACK     [THE_MODEL_MAIN]',mythid)
# Line 617  C--   Call time stepping loop of full mo Line 628  C--   Call time stepping loop of full mo
628  #endif /* ALLOW_TANGENTLINEAR_RUN ALLOW_ADJOINT_RUN ALLOW_ADMTLM */  #endif /* ALLOW_TANGENTLINEAR_RUN ALLOW_ADJOINT_RUN ALLOW_ADMTLM */
629    
630  C--   Final checkpoint (in case the in-loop checkpoint was missed)  C--   Final checkpoint (in case the in-loop checkpoint was missed)
631        CALL TIMER_START('WRITE_CHECKPOINT       [THE_MODEL_MAIN]',myThid)        CALL TIMER_START('DO_WRITE_PICKUP        [THE_MODEL_MAIN]',myThid)
632        CALL PACKAGES_WRITE_PICKUP(        CALL DO_WRITE_PICKUP(
633       I        .TRUE., myCurrentTime, myCurrentIter, myThid )       I        .TRUE., myCurrentTime, myCurrentIter, myThid )
634        CALL WRITE_CHECKPOINT(        CALL TIMER_STOP ('DO_WRITE_PICKUP        [THE_MODEL_MAIN]',myThid)
      I        .TRUE., myCurrentTime, myCurrentIter, myThid )  
       CALL TIMER_STOP ('WRITE_CHECKPOINT       [THE_MODEL_MAIN]',myThid)  
635    
636        CALL TIMER_STOP ('ALL                    [THE_MODEL_MAIN]',myThid)        CALL TIMER_STOP ('ALL                    [THE_MODEL_MAIN]',myThid)
637    
# Line 648  C--   Write timer statistics Line 657  C--   Write timer statistics
657         CALL COMM_STATS         CALL COMM_STATS
658        ENDIF        ENDIF
659    
660    C--   Check threads synchronization :
661          CALL BAR_CHECK( 9, myThid )
662    
663  #ifdef ALLOW_DEBUG  #ifdef ALLOW_DEBUG
664        IF (debugMode) CALL DEBUG_LEAVE('THE_MODEL_MAIN',myThid)        IF (debugMode) CALL DEBUG_LEAVE('THE_MODEL_MAIN',myThid)
665  #endif  #endif
Legend:
Removed from v.1.90  
changed lines
  Added in v.1.102
  ViewVC Help
Powered by ViewVC 1.1.22