/[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.78 by edhill,
Sun Jul 25 03:00:16 2004 UTC
+revision 1.100 by jmc,
Wed Feb  7 23:16:54 2007 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 48 
 C    | |-INI_PARMS :: Routine to set ker
  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 148 
 C    | | | |-INI_PSURF  :: Set model ini
  C    | | | |-INI_PRESSURE :: Compute model initial hydrostatic pressure
  C    | | | |-READ_CHECKPOINT :: Read the checkpoint
  C    | | |
- C    | | |-INI_TR1      :: Set initial tracer 1 distribution.
- C    | | |
  C    | | |-THE_CORRECTION_STEP :: Step forward to next time step.
  C    | | | |                   :: Here applied to move restart conditions
  C    | | | |                   :: (saved in mid timestep) to correct level in
-Line 175 
 C    | | | |-FIND_RHO  :: Find adjacent
+Line 173 
 C    | | | |-FIND_RHO  :: Find adjacent
  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 )
-Line 183 
 C    | | | |-KPP_INIT             :: KPP
+Line 181 
 C    | | | |-KPP_INIT             :: 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 222 
 C/\  | | |-CALC_EXACT_ETA :: Change SSH
+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.
-Line 280 
 C/\  | | | | |-FREESURF_RESCALE_G :: Re-
+Line 278 
 C/\  | | | | |-FREESURF_RESCALE_G :: Re-
  C/\  | | | |
  C/\  | | | |-TIMESTEP_TRACER      :: Step tracer field forward in time
  C/\  | | | |
- C/\  | | | |-CALC_GTR1            :: Calculate other tracer(s) tendency terms
- C/\  | | | | |
- C/\  | | | | |-GAD_CALC_RHS       :: Generalised advection package
- C/\  | | | | |                    :: ( see pkg/gad )
- C/\  | | | | |
- C/\  | | | | |-EXTERNAL_FORCING_TR:: Problem specific forcing for tracer.
- C/\  | | | | |-ADAMS_BASHFORTH2   :: Extrapolate tendencies forward in time.
- C/\  | | | | |-FREESURF_RESCALE_G :: Re-scale Gs for free-surface height.
- 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 299 
 C/\  | | | | | |-KPP_TRANSPORT_PTR:: KPP
+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 322 
 C/\  | | | |
+Line 311 
 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 398 
 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 470 
 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_ECCO_OPTIMIZATION
- # include "optim.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 ==
-Line 499 
 C     myCurrentIter - Iteration counter
+Line 489 
 C     myCurrentIter - Iteration counter
        _RL     myCurrentTime
        logical  exst
        logical  lastdiva
- #ifndef ALLOW_ECCO_OPTIMIZATION
-       integer optimcycle
- #endif
  CEOP
  c--   set default:
- #ifndef ALLOW_ECCO_OPTIMIZATION
-       optimcycle = 0
- #endif
        lastdiva = .TRUE.
  #ifdef ALLOW_DEBUG
        IF (debugMode) 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)
-Line 530 
 C--   Set model configuration (fixed arr
+Line 517 
 C--   Set model configuration (fixed arr
  #if ( defined (ALLOW_ADMTLM) )
  c
-       CALL TIMER_START('ADMTLM_DRIVER          [THE_MODEL_MAIN]',mythid)
+       STOP 'should never get here; ADMTLM_DSVD calls ADMTLM_DRIVER'
-       CALL ADMTLM_DRIVER ( myThid )
-       CALL TIMER_STOP ('ADMTLM_DRIVER          [THE_MODEL_MAIN]',mythid)
  c
  #elif ( defined (ALLOW_AUTODIFF))
-Line 540 
 c
+Line 525 
 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)
              ENDIF
-             IF ( optimcycle.EQ.0 .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)
-             ENDIF
           ENDIF
        ENDIF
        _END_MASTER( mythid )
        _BARRIER
  # endif /* EXCLUDE_CTRL_PACK */
+ # ifdef ALLOW_COST
        CALL COST_DEPENDENT_INIT ( mythid )
        _BARRIER
+ # endif
  # if ( defined (ALLOW_TANGENTLINEAR_RUN) )
  c
-Line 579 
 c-- The following assumes the TAF option
+Line 561 
 c-- The following assumes the TAF option
           CALL COST_FINAL_STORE ( mythid, lastdiva )
        ELSE
           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 */
        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
+ # else /* forward run only within AD setting */
+ #ifdef ALLOW_DEBUG
+       IF (debugMode) CALL DEBUG_CALL('THE_MAIN_LOOP',myThid)
+ #endif
+ C--   Call time stepping loop of full model
+       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)
  # endif
  # 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 .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)
+          ENDIF
        ENDIF
        _END_MASTER( mythid )
        _BARRIER
-Line 619 
 c
+Line 620 
 c
  #ifdef ALLOW_DEBUG
        IF (debugMode) CALL DEBUG_CALL('THE_MAIN_LOOP',myThid)
  #endif
  C--   Call time stepping loop of full model
        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)
- #endif /* ALLOW_TANGENTLINEAR_RUN ALLOW_ADJOINT_RUN ALLOW_ADMTLM_RUN */
+ #endif /* ALLOW_TANGENTLINEAR_RUN ALLOW_ADJOINT_RUN ALLOW_ADMTLM */
  C--   Final checkpoint (in case the in-loop checkpoint was missed)
-       CALL TIMER_START('WRITE_CHECKPOINT       [THE_MODEL_MAIN]',myThid)
+       CALL TIMER_START('DO_WRITE_PICKUP        [THE_MODEL_MAIN]',myThid)
-       CALL PACKAGES_WRITE_PICKUP(
+       CALL DO_WRITE_PICKUP(
-      I        .TRUE., myCurrentTime, myCurrentIter, myThid )
-       CALL WRITE_CHECKPOINT(
       I        .TRUE., myCurrentTime, myCurrentIter, myThid )
-       CALL TIMER_STOP ('WRITE_CHECKPOINT       [THE_MODEL_MAIN]',myThid)
+       CALL TIMER_STOP ('DO_WRITE_PICKUP        [THE_MODEL_MAIN]',myThid)
        CALL TIMER_STOP ('ALL                    [THE_MODEL_MAIN]',myThid)
+ #ifdef ALLOW_DIAGNOSTICS
+       IF (useDiagnostics) THEN
+ C       Close all diagnostics output files
+         CALL DIAGSTATS_CLOSE_IO( myThid )
+       ENDIF
+ #endif
  #ifdef ALLOW_MNC
        IF (useMNC) THEN
  C       Close all open NetCDF files
-Line 652 
 C--   Write timer statistics
+Line 657 
 C--   Write timer statistics
         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.78
 


changed lines


 
Added in v.1.100
 Legend:



Removed from v.1.78
 


changed lines


 
Added in v.1.100
-Removed from v.1.78
+Added in v.1.100

	ViewVC Help
Powered by ViewVC 1.1.22