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

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

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

-revision 1.87 by heimbach,
Wed Jan 26 14:39:20 2005 UTC
+revision 1.106 by jmc,
Thu Oct 15 00:38:21 2009 UTC
 Line 34 
 C  :
  C  |
  C  |-THE_MODEL_MAIN :: Primary driver for the MITgcm algorithm
  C    |              :: Called from WRAPPER level numerical
- C    |              :: code innvocation routine. On entry
+ C    |              :: code invocation routine. On entry
  C    |              :: to THE_MODEL_MAIN separate thread and
  C    |              :: separate processes will have been established.
  C    |              :: Each thread and process will have a unique ID
 Line 43 
 C    |              :: specific region i
  C    |
  C    |-INITIALISE_FIXED :: Set fixed model arrays such as topography,
  C    | |                :: grid, solver matrices etc..
  C    | |
  C    | |-INI_PARMS :: Routine to set kernel model parameters.
  C    | |           :: By default kernel parameters are read from file
  C    | |           :: "data" in directory in which code executes.
  C    | |
- C    | |-MON_INIT :: Initialises monitor pacakge ( see pkg/monitor )
+ C    | |-MON_INIT :: Initializes monitor package ( see pkg/monitor )
  C    | |
- C    | |-INI_GRID :: Control grid array (vert. and hori.) initialisation.
+ C    | |-INI_GRID :: Control grid array (vert. and hori.) initialization.
  C    | | |        :: Grid arrays are held and described in GRID.h.
  C    | | |
- C    | | |-INI_VERTICAL_GRID        :: Initialise vertical grid arrays.
+ C    | | |-INI_VERTICAL_GRID        :: Initialize vertical grid arrays.
  C    | | |
- C    | | |-INI_CARTESIAN_GRID       :: Cartesian horiz. grid initialisation
+ C    | | |-INI_CARTESIAN_GRID       :: Cartesian horiz. grid initialization
  C    | | |                          :: (calculate grid from kernel parameters).
  C    | | |
  C    | | |-INI_SPHERICAL_POLAR_GRID :: Spherical polar horiz. grid
- C    | | |                          :: initialisation (calculate grid from
+ C    | | |                          :: initialization (calculate grid from
  C    | | |                          :: kernel parameters).
  C    | | |
  C    | | |-INI_CURVILINEAR_GRID     :: General orthogonal, structured horiz.
- C    | |                            :: grid initialisations. ( input from raw
+ C    | |                            :: grid initializations. ( input from raw
  C    | |                            :: grid files, LONC.bin, DXF.bin etc... )
  C    | |
  C    | |-INI_DEPTHS    :: Read (from "bathyFile") or set bathymetry/orgography.
 Line 74 
 C    | |
  C    | |-INI_LINEAR_PHSURF :: Set ref. surface Bo_surf
  C    | |
  C    | |-INI_CORI          :: Set coriolis term. zero, f-plane, beta-plane,
- C    | |                   :: sphere optins are coded.
+ C    | |                   :: sphere options are coded.
  C    | |
  C    | |-PACAKGES_BOOT      :: Start up the optional package environment.
  C    | |                    :: Runtime selection of active packages.
 Line 107 
 C    | | |-GCHEM_INIT_FIXED    :: tracer
  C    | |
  C    | |-ZONAL_FILT_INIT       :: FFT filter Package. see pkg/zonal_filt
  C    | |
- C    | |-INI_CG2D              :: 2d con. grad solver initialisation.
+ C    | |-INI_CG2D              :: 2d con. grad solver initialization.
  C    | |
- C    | |-INI_CG3D              :: 3d con. grad solver initialisation.
+ C    | |-INI_CG3D              :: 3d con. grad solver initialization.
  C    | |
  C    | |-CONFIG_SUMMARY        :: Provide synopsis of kernel setup.
  C    |                         :: Includes annotated table of kernel
 Line 118 
 C    |
  C    |-CTRL_UNPACK :: Control vector support package. see pkg/ctrl
  C    |
  C    |-ADTHE_MAIN_LOOP :: Derivative evaluating form of main time stepping loop
- C    !                 :: Auotmatically gerenrated by TAMC/TAF.
+ C    !                 :: Auotmatically generated by TAMC/TAF.
  C    |
  C    |-CTRL_PACK   :: Control vector support package. see pkg/ctrl
  C    |
 Line 132 
 C    | | |
  C    | | |-INI_LINEAR_PHISURF :: Set ref. surface Bo_surf
  C    | | |
  C    | | |-INI_CORI     :: Set coriolis term. zero, f-plane, beta-plane,
- C    | | |              :: sphere optins are coded.
+ C    | | |              :: sphere options are coded.
  C    | | |
- C    | | |-INI_CG2D     :: 2d con. grad solver initialisation.
+ C    | | |-INI_CG2D     :: 2d con. grad solver initialization.
- C    | | |-INI_CG3D     :: 3d con. grad solver initialisation.
+ C    | | |-INI_CG3D     :: 3d con. grad solver initialization.
- C    | | |-INI_MIXING   :: Initialise diapycnal diffusivity.
+ C    | | |-INI_MIXING   :: Initialize diapycnal diffusivity.
- C    | | |-INI_DYNVARS  :: Initialise to zero all DYNVARS.h arrays (dynamical
+ C    | | |-INI_DYNVARS  :: Initialize to zero all DYNVARS.h arrays (dynamical
  C    | | |              :: fields).
  C    | | |
- C    | | |-INI_FIELDS   :: Control initialising model fields to non-zero
+ C    | | |-INI_FIELDS   :: Control initializing model fields to non-zero
  C    | | | |-INI_VEL    :: Initialize 3D flow field.
  C    | | | |-INI_THETA  :: Set model initial temperature field.
  C    | | | |-INI_SALT   :: Set model initial salinity field.
 Line 163 
 C    | | | |-CONVECTIVE_ADJUSTMENT :: Co
  C    | | | | |-FIND_RHO  :: Find adjacent densities.
  C    | | | | |-CONVECT   :: Mix static instability.
  C    | | | | |-TIMEAVE_CUMULATE :: Update convection statistics.
  C    | | | |
  C    | | | |-CALC_EXACT_ETA        :: Change SSH to flow divergence.
  C    | | |
  C    | | |-CONVECTIVE_ADJUSTMENT_INI :: Control static instability mixing
  C    | | | |                         :: Extra time history interactions.
  C    | | | |
  C    | | | |-FIND_RHO  :: Find adjacent densities.
  C    | | | |-CONVECT   :: Mix static instability.
  C    | | | |-TIMEAVE_CUMULATE :: Update convection statistics.
  C    | | |
- C    | | |-PACKAGES_INIT_VARIABLES :: Does initialisation of time evolving
+ C    | | |-PACKAGES_INIT_VARIABLES :: Does initialization of time evolving
  C    | | | |                       :: package data.
  C    | | | |
  C    | | | |-GMREDI_INIT          :: GM package. ( see pkg/gmredi )
  C    | | | |-KPP_INIT             :: KPP package. ( see pkg/kpp )
  C    | | | |-KPP_OPEN_DIAGS
  C    | | | |-OBCS_INIT_VARIABLES  :: Open bndy. package. ( see pkg/obcs )
  C    | | | |-PTRACERS_INIT        :: multi. tracer package,(see pkg/ptracers)
- C    | | | |-GCHEM_INIT           : : tracer interface pkg (see pkh/gchem)
+ C    | | | |-GCHEM_INIT           :: tracer interface pkg (see pkh/gchem)
  C    | | | |-AIM_INIT             :: Interm. atmos package. ( see pkg/aim )
  C    | | | |-CTRL_MAP_INI         :: Control vector package.( see pkg/ctrl )
  C    | | | |-COST_INIT            :: Cost function package. ( see pkg/cost )
 Line 220 
 C/\  | | |-CALC_EXACT_ETA :: Change SSH
  C/\  | | |-CALC_SURF_DR   :: Calculate the new surface level thickness.
  C/\  | | |-EXF_GETFORCING :: External forcing package. ( pkg/exf )
  C/\  | | |-EXTERNAL_FIELDS_LOAD :: Control loading time dep. external data.
- C/\  | | | |                    :: Simple interpolcation between end-points
+ C/\  | | | |                    :: Simple interpolation between end-points
  C/\  | | | |                    :: for forcing datasets.
  C/\  | | | |
  C/\  | | | |-EXCH :: Sync forcing. in overlap regions.
  C/\  | | |-SEAICE_MODEL   :: Compute sea-ice terms. ( pkg/seaice )
  C/\  | | |-FREEZE         :: Limit surface temperature.
 Line 280 
 C/\  | | | |-TIMESTEP_TRACER      :: Ste
  C/\  | | | |
  C/\  | | | |-TIMESTEP_TRACER      :: Step tracer field forward in time
  C/\  | | | |
- C/\  | | | |-PTRACERS_INTEGRATE   :: Integrate other tracer(s) ( see pkg/ptracers ).
+ C/\  | | | |-PTRACERS_INTEGRATE   :: Integrate other tracer(s) (see pkg/ptracers).
  C/\  | | | | |
  C/\  | | | | |-GAD_CALC_RHS       :: Generalised advection package
  C/\  | | | | | |                  :: ( see pkg/gad )
 Line 288 
 C/\  | | | | | |-KPP_TRANSPORT_PTR:: KPP
  C/\  | | | | |
  C/\  | | | | |-PTRACERS_FORCING   :: Problem specific forcing for tracer.
  C/\  | | | | |-GCHEM_FORCING_INT  :: tracer forcing for gchem pkg (if all
- C/\  | | | | |                       tendancy terms calcualted together)
+ C/\  | | | | |                       tendency terms calcualted together)
  C/\  | | | | |-ADAMS_BASHFORTH2   :: Extrapolate tendencies forward in time.
  C/\  | | | | |-FREESURF_RESCALE_G :: Re-scale Gs for free-surface height.
  C/\  | | | | |-TIMESTEP_TRACER    :: Step tracer field forward in time
 Line 307 
 C/\  | | | |-CALC_GRAD_PHI_SURF :: Calcu
  C/\  | | | |                       Potential anomaly.
  C/\  | | | |-CALC_VISCOSITY     :: Calculate net vertical viscosity
  C/\  | | | | |-KPP_CALC_VISC    :: KPP package ( see pkg/kpp ).
  C/\  | | | |
  C/\  | | | |-CALC_PHI_HYD       :: Integrate the hydrostatic relation.
  C/\  | | | |-MOM_FLUXFORM       :: Flux form mom eqn. package ( see
  C/\  | | | |                       pkg/mom_fluxform ).
+ C/\  | | | | |-MOM_CALC_VISC    :: Calculate Horizontal Viscosities
  C/\  | | | |-MOM_VECINV         :: Vector invariant form mom eqn. package ( see
  C/\  | | | |                       pkg/mom_vecinv   ).
+ C/\  | | | | |-MOM_CALC_VISC    :: Calculate Horizontal Viscosities
  C/\  | | | |-TIMESTEP           :: Step momentum fields forward in time
  C/\  | | | |-OBCS_APPLY_UV      :: Open bndy. package (see pkg/obcs ).
  C/\  | | | |
-Line 347 
 C/\  | | | | |-FIND_RHO  :: Find adjacen
+Line 349 
 C/\  | | | | |-FIND_RHO  :: Find adjacen
  C/\  | | | | |-CONVECT   :: Mix static instability.
  C/\  | | | | |-TIMEAVE_CUMULATE :: Update convection statistics.
  C/\  | | | |
  C/\  | | | |-CALC_EXACT_ETA        :: Change SSH to flow divergence.
  C/\  | | |
  C/\  | | |-DO_FIELDS_BLOCKING_EXCHANGES :: Sync up overlap regions.
  C/\  | | | |-EXCH
  C/\  | | |
  C/\  | | |-GCHEM_FORCING_SEP :: tracer forcing for gchem pkg (if
  C/\  | | |                      tracer dependent tendencies calculated
-Line 387 
 C    |-TIMER_PRINTALL :: Computational t
+Line 389 
 C    |-TIMER_PRINTALL :: Computational t
  C    |
  C    |-COMM_STATS     :: Summarise inter-proc and inter-thread communication
  C                     :: events.
+ C
  C \ev
  C
  C
-Line 407 
 C     !INTERFACE:
+Line 410 
 C     !INTERFACE:
  C     !DESCRIPTION: \bv
  C     *==========================================================*
  C     | SUBROUTINE THE_MODEL_MAIN
  C     | o Master controlling routine for model using the MITgcm
  C     |   UV parallel wrapper.
  C     *==========================================================*
  C     | THE_MODEL_MAIN is invoked by the MITgcm UV parallel
  C     | wrapper with a single integer argument "myThid". This
  C     | variable identifies the thread number of an instance of
  C     | THE_MODEL_MAIN. Each instance of THE_MODEL_MAIN works
  C     | on a particular region of the models domain and
  C     | synchronises with other instances as necessary. The
  C     | routine has to "understand" the MITgcm parallel
  C     | environment and the numerical algorithm. Editing this
  C     | routine is best done with some knowledge of both aspects.
  C     | Notes
  C     | =====
  C     | C*P* comments indicating place holders for which code is
  C     |      presently being developed.
  C     *==========================================================*
  C     \ev
-Line 459 
 C     == Global variables ===
+Line 462 
 C     == Global variables ===
  #include "EEPARAMS.h"
  #include "PARAMS.h"
  #include "DYNVARS.h"
- #ifdef ALLOW_NONHYDROSTATIC
- # include "CG3D.h"
- #endif
  #ifdef ALLOW_AUTODIFF_TAMC
  # include "tamc.h"
  #endif
  #ifdef ALLOW_CTRL
+ # include "ctrl.h"
  # include "optim.h"
  #endif
  C     !INPUT/OUTPUT PARAMETERS:
  C     == Routine arguments ==
  C     myThid - Thread number for this instance of the routine.
        INTEGER myThid
  C     !LOCAL VARIABLES:
  C     == Local variables ==
-Line 493 
 c--   set default:
+Line 494 
 c--   set default:
        lastdiva = .TRUE.
  #ifdef ALLOW_DEBUG
-       IF (debugMode) CALL DEBUG_ENTER('THE_MODEL_MAIN',myThid)
+ C-    cannot test for debugMode which has not yet been set
+       CALL DEBUG_ENTER('THE_MODEL_MAIN',myThid)
  #endif
+ #if defined(USE_PAPI) || defined(USE_PCL_FLOPS_SFP) || defined(USE_PCL_FLOPS) || defined(USE_PCL)
+       CALL TIMER_CONTROL('','INIT','THE_MODEL_MAIN',myThid)
+ #endif
  C--   This timer encompasses the whole code
        CALL TIMER_START('ALL                    [THE_MODEL_MAIN]',myThid)
  #ifdef ALLOW_DEBUG
-       IF (debugMode) CALL DEBUG_CALL('INITIALISE_FIXED',myThid)
+ C-    cannot test for debugMode which has not yet been set
+       CALL DEBUG_CALL('INITIALISE_FIXED',myThid)
  #endif
  C--   Set model configuration (fixed arrays)
-Line 508 
 C--   Set model configuration (fixed arr
+Line 514 
 C--   Set model configuration (fixed arr
        CALL INITIALISE_FIXED( myThid )
        CALL TIMER_STOP ('INITIALISE_FIXED       [THE_MODEL_MAIN]',myThid)
+ #ifdef ALLOW_DEBUG
+       IF (debugMode) CALL DEBUG_LEAVE('INITIALISE_FIXED',myThid)
+ #endif
        myCurrentTime = startTime
        myCurrentIter = nIter0
-Line 521 
 c
+Line 531 
 c
        _BEGIN_MASTER( mythid )
        IF (myProcId .eq. 0) THEN
           inquire( file='costfinal', exist=exst )
-          IF ( .NOT. exst .AND. niter0 .EQ. 0 ) THEN
+          IF ( .NOT. exst ) THEN
-             IF ( optimcycle.NE.0 ) THEN
+             IF ( optimcycle.NE.0 .AND. doMainUnpack ) THEN
                 CALL TIMER_START('CTRL_UNPACK   [THE_MODEL_MAIN]',mythid)
                 CALL CTRL_UNPACK( .TRUE. , mythid )
                 CALL TIMER_STOP ('CTRL_UNPACK   [THE_MODEL_MAIN]',mythid)
-Line 540 
 c
+Line 550 
 c
  # if ( defined (ALLOW_TANGENTLINEAR_RUN) )
  c
+ #ifdef ALLOW_DEBUG
+       IF (debugMode) CALL DEBUG_CALL('G_THE_MAIN_LOOP',myThid)
+ #endif
        CALL TIMER_START('G_THE_MAIN_LOOP           [TANGENT RUN]',mythid)
        CALL G_THE_MAIN_LOOP ( myCurrentTime, myCurrentIter, myThid )
        CALL TIMER_STOP ('G_THE_MAIN_LOOP           [TANGENT RUN]',mythid)
-Line 551 
 c
+Line 564 
 c
  c-- The following assumes the TAF option '-pure'
        inquire( file='costfinal', exist=exst )
        IF ( .NOT. exst) THEN
+ #ifdef ALLOW_DEBUG
+          IF (debugMode) CALL DEBUG_CALL('MDTHE_MAIN_LOOP',myThid)
+ #endif
           CALL TIMER_START('MDTHE_MAIN_LOOP            [MD RUN]', mythid)
           CALL MDTHE_MAIN_LOOP ( myCurrentTime, myCurrentIter, mythid )
           CALL TIMER_STOP ('MDTHE_MAIN_LOOP            [MD RUN]', mythid)
           CALL COST_FINAL_STORE ( mythid, lastdiva )
        ELSE
+ #ifdef ALLOW_DEBUG
+          IF (debugMode) CALL DEBUG_CALL('ADTHE_MAIN_LOOP',myThid)
+ #endif
           CALL TIMER_START('ADTHE_MAIN_LOOP       [ADJOINT RUN]', mythid)
-          CALL ADTHE_MAIN_LOOP ( myCurrentTime, myCurrentIter, mythid )
+          CALL ADTHE_MAIN_LOOP (  mythid )
           CALL TIMER_STOP ('ADTHE_MAIN_LOOP       [ADJOINT RUN]', mythid)
           CALL COST_FINAL_RESTORE ( mythid, lastdiva )
        ENDIF
  c--
  #  else /* ALLOW_DIVIDED_ADJOINT undef */
+ #ifdef ALLOW_DEBUG
+       IF (debugMode) CALL DEBUG_CALL('ADTHE_MAIN_LOOP',myThid)
+ #endif
        CALL TIMER_START('ADTHE_MAIN_LOOP          [ADJOINT RUN]', mythid)
-       CALL ADTHE_MAIN_LOOP ( myCurrentTime, myCurrentIter, mythid )
+ #ifdef ALLOW_ECCO
- cph      CALL ADTHE_MAIN_LOOP ( mythid )
+       CALL ADTHE_MAIN_LOOP ( myCurrentTime, mythid )
+ #else
+       CALL ADTHE_MAIN_LOOP ( mythid )
+ #endif
        CALL TIMER_STOP ('ADTHE_MAIN_LOOP          [ADJOINT RUN]', mythid)
  #  endif /* ALLOW_DIVIDED_ADJOINT */
  c
-Line 575 
 c
+Line 600 
 c
        IF (debugMode) CALL DEBUG_CALL('THE_MAIN_LOOP',myThid)
  #endif
  C--   Call time stepping loop of full model
+ #ifdef ALLOW_DEBUG
+       IF (debugMode) CALL DEBUG_CALL('THE_MAIN_LOOP',myThid)
+ #endif
        CALL TIMER_START('THE_MAIN_LOOP          [THE_MODEL_MAIN]',myThid)
        CALL THE_MAIN_LOOP( myCurrentTime, myCurrentIter, myThid )
        CALL TIMER_STOP ('THE_MAIN_LOOP          [THE_MODEL_MAIN]',myThid)
-Line 583 
 C--   Call time stepping loop of full mo
+Line 611 
 C--   Call time stepping loop of full mo
  # ifndef EXCLUDE_CTRL_PACK
        _BEGIN_MASTER( mythid )
-       IF ( myProcId .eq. 0 .AND. lastdiva ) THEN
+       IF ( myProcId .eq. 0 .AND. lastdiva .AND. doMainPack ) THEN
           CALL TIMER_START('CTRL_PACK           [THE_MODEL_MAIN]',mythid)
-          call CTRL_PACK( .FALSE. , mythid )
+          CALL CTRL_PACK( .FALSE. , mythid )
           CALL TIMER_STOP ('CTRL_PACK           [THE_MODEL_MAIN]',mythid)
-          IF ( optimcycle.EQ.0 .AND. mycurrentiter.EQ.niter0 ) THEN
+          IF ( ( optimcycle.EQ.0 .OR. (.NOT. doMainUnpack) )
+      &        .AND. mycurrentiter.EQ.niter0 ) THEN
              CALL TIMER_START('CTRL_PACK     [THE_MODEL_MAIN]',mythid)
              CALL CTRL_PACK( .TRUE. , mythid )
              CALL TIMER_STOP ('CTRL_PACK     [THE_MODEL_MAIN]',mythid)
-Line 619 
 C--   Call time stepping loop of full mo
+Line 648 
 C--   Call time stepping loop of full mo
  #endif /* ALLOW_TANGENTLINEAR_RUN ALLOW_ADJOINT_RUN ALLOW_ADMTLM */
- C--   Final checkpoint (in case the in-loop checkpoint was missed)
+ #ifdef ALLOW_DIAGNOSTICS
-       CALL TIMER_START('WRITE_CHECKPOINT       [THE_MODEL_MAIN]',myThid)
+       IF (useDiagnostics) THEN
-       CALL PACKAGES_WRITE_PICKUP(
+ C       Close all diagnostics output files
-      I        .TRUE., myCurrentTime, myCurrentIter, myThid )
+         CALL DIAGSTATS_CLOSE_IO( myThid )
-       CALL WRITE_CHECKPOINT(
+       ENDIF
-      I        .TRUE., myCurrentTime, myCurrentIter, myThid )
+ #endif
-       CALL TIMER_STOP ('WRITE_CHECKPOINT       [THE_MODEL_MAIN]',myThid)
-       CALL TIMER_STOP ('ALL                    [THE_MODEL_MAIN]',myThid)
  #ifdef ALLOW_MNC
        IF (useMNC) THEN
-Line 638 
 C       Close all open NetCDF files
+Line 664 
 C       Close all open NetCDF files
        ENDIF
  #endif
+ C--   This timer encompasses the whole code
+       CALL TIMER_STOP ('ALL                    [THE_MODEL_MAIN]',myThid)
  C--   Write timer statistics
        IF ( myThid .EQ. 1 ) THEN
         CALL TIMER_PRINTALL( myThid )
         CALL COMM_STATS
        ENDIF
+ C--   Check threads synchronization :
+       CALL BAR_CHECK( 9, myThid )
  #ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_LEAVE('THE_MODEL_MAIN',myThid)
  #endif

 Legend:



Removed from v.1.87
 


changed lines


 
Added in v.1.106
 Legend:



Removed from v.1.87
 


changed lines


 
Added in v.1.106
-Removed from v.1.87
+Added in v.1.106

	ViewVC Help
Powered by ViewVC 1.1.22