/[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.39 by heimbach,
Fri Jul 13 14:26:57 2001 UTC
+revision 1.44 by heimbach,
Thu Jan 17 16:55:25 2002 UTC
 Line 1
  C $Header$
  C $Name$
+ CBOI
+ C
+ C !TITLE: MITGCM KERNEL CODE SYNOPSIS
+ C !AUTHORS: mitgcm developers ( support@mitgcm.org )
+ C !AFFILIATION: Massachussetts Institute of Technology
+ C !DATE:
+ C !INTRODUCTION: Kernel dynamical routines
+ C This document summarises MITgcm code under the model/ subdirectory.
+ C The code under model/ ( src/ and inc/ ) contains most of
+ C the driver routines for the baseline forms of the kernel equations in the
+ C MITgcm algorithm. Numerical code for much of the baseline forms of
+ C these equations is also under the model/ directory. Other numerical code
+ C used for the kernel equations is contained in packages in the pkg/
+ C directory tree.
+ C Code for auxilliary equations and alternate dicretizations of the kernel
+ C equations and algorithm can also be found in the pkg/ directory tree.
+ C
+ C \subsection{Getting Help and Reporting Errors and Problems}
+ C If you have questions please e-mail support@mitgcm.org. We also welcome
+ C reports of errors and inconsistencies in the code or in the accompanying
+ C documentation. Please feel free to send these
+ C to support@mitgcm.org. For further information and to review
+ C problems reported to support@mitgcm.org please visit http://mitgcm.org.
+ C
+ C \subsection{MITgcm Kernel Code Calling Sequence}
+ C \bv
+ C
+ C Invocation from WRAPPER level...
+ C  :
+ 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    |              :: to THE_MODEL_MAIN separate thread and
+ C    |              :: separate processes will have been established.
+ C    |              :: Each thread and process will have a unique ID
+ C    |              :: but as yet it will not be associated with a
+ C    |              :: specific region in decomposed discrete space.
+ 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    | |
+ C    | |-INI_GRID :: Control grid array (vert. and hori.) initialisation.
+ C    | | |        :: Grid arrays are held and described in GRID.h.
+ C    | | |
+ C    | | |-INI_VERTICAL_GRID        :: Initialise vertical grid arrays.
+ C    | | |
+ C    | | |-INI_CARTESIAN_GRID       :: Cartesian horiz. grid initialisation
+ C    | | |                          :: (calculate grid from kernel parameters).
+ C    | | |
+ C    | | |-INI_SPHERICAL_POLAR_GRID :: Spherical polar horiz. grid
+ C    | | |                          :: initialisation (calculate grid from
+ C    | | |                          :: kernel parameters).
+ C    | | |
+ C    | | |-INI_CURVILINEAR_GRID     :: General orthogonal, structured horiz.
+ C    | |                            :: grid initialisations. ( input from raw
+ C    | |                            :: grid files, LONC.bin, DXF.bin etc... )
+ C    | |
+ C    | |-INI_DEPTHS    :: Read (from "bathyFile") or set bathymetry/orgography.
+ C    | |
+ C    | |-INI_MASKS_ETC :: Derive horizontal and vertical cell fractions and
+ C    | |               :: land masking for solid-fluid boundaries.
+ 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    | |
+ C    | |-PACAKGES_BOOT      :: Start up the optional package environment.
+ C    | |                    :: Runtime selection of active packages.
+ C    | |
+ C    | |-PACKAGES_READPARMS :: Call active package internal parameter load.
+ C    | | |
+ C    | | |-GMREDI_READPARMS    :: GM Package. see pkg/gmredi
+ C    | | |-KPP_READPARMS       :: KPP Package. see pkg/kpp
+ C    | | |-SHAP_FILT_READPARMS :: Shapiro filter package. see pkg/shap_filt
+ C    | | |-OBCS_READPARMS      :: Open bndy package. see pkg/obcs
+ C    | | |-AIM_READPARMS       :: Intermediate Atmos. pacakage. see pkg/aim
+ C    | | |-COST_READPARMS      :: Cost function package. see pkg/cost
+ C    | | |-CTRL_INIT           :: Control vector support package. see pkg/ctrl
+ C    | | |-OPTIM_READPARMS     :: Optimisation support package. see pkg/ctrl
+ C    | | |-GRDCHK_READPARMS    :: Gradient check package. see pkg/grdchk
+ C    | | |-ECCO_READPARMS      :: ECCO Support Package. see pkg/ecco
+ C    | |
+ C    | |-PACKAGES_CHECK
+ C    | | |
+ C    | | |-KPP_CHECK           :: KPP Package. pkg/kpp
+ C    | | |-OBCS_CHECK          :: Open bndy Pacakge. pkg/obcs
+ C    | | |-GMREDI_CHECK        :: GM Package. pkg/gmredi
+ C    | |
+ C    | |-PACKAGES_INIT_FIXED
+ C    | | |-OBCS_INIT_FIXED     :: Open bndy Package. see pkg/obcs
+ C    | | |-FLT_INIT            :: Floats Package. see pkg/flt
+ C    | |
+ C    | |-ZONAL_FILT_INIT       :: FFT filter Package. see pkg/zonal_filt
+ C    | |
+ C    | |-INI_CG2D              :: 2d con. grad solver initialisation.
+ C    | |
+ C    | |-INI_CG3D              :: 3d con. grad solver initialisation.
+ C    | |
+ C    | |-CONFIG_SUMMARY        :: Provide synopsis of kernel setup.
+ C    |                         :: Includes annotated table of kernel
+ C    |                         :: parameter settings.
+ 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    |
+ C    |-CTRL_PACK   :: Control vector support package. see pkg/ctrl
+ C    |
+ C    |-GRDCHK_MAIN :: Gradient check package. see pkg/grdchk
+ C    |
+ C    |-THE_MAIN_LOOP :: Main timestepping loop routine.
+ C    | |
+ C    | |-INITIALISE_VARIA :: Set the initial conditions for time evolving
+ C    | | |                :: variables
+ 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    | | |
+ C    | | |-INI_CG2D     :: 2d con. grad solver initialisation.
+ C    | | |-INI_CG3D     :: 3d con. grad solver initialisation.
+ C    | | |-INI_MIXING   :: Initialise diapycnal diffusivity.
+ C    | | |-INI_DYNVARS  :: Initialise to zero all DYNVARS.h arrays (dynamical
+ C    | | |              :: fields).
+ C    | | |
+ C    | | |-INI_FIELDS   :: Control initialising 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.
+ C    | | | |-INI_PSURF  :: Set model initial free-surface height/pressure.
+ 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
+ C    | | | |                   :: time (only used for pre-c35).
+ C    | | | |
+ C    | | | |-CALC_GRAD_PHI_SURF :: Return DDx and DDy of surface pressure
+ C    | | | |-CORRECTION_STEP    :: Pressure correction to momentum
+ C    | | | |-CYCLE_TRACER       :: Move tracers forward in time.
+ C    | | | |-OBCS_APPLY         :: Open bndy package. see pkg/obcs
+ C    | | | |-SHAP_FILT_APPLY    :: Shapiro filter package. see pkg/shap_filt
+ C    | | | |-ZONAL_FILT_APPLY   :: FFT filter package. see pkg/zonal_filt
+ C    | | | |-CONVECTIVE_ADJUSTMENT :: Control static instability mixing.
+ 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    | | | |                       :: 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    | | | |-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 )
+ C    | | | |-ECCO_INIT            :: ECCO support package. ( see pkg/ecco )
+ C    | | | |-INI_FORCING          :: Set model initial forcing fields.
+ C    | | |   |                    :: Either set in-line or from file as shown.
+ C    | | |   |-READ_FLD_XY_RS(zonalWindFile)
+ C    | | |   |-READ_FLD_XY_RS(meridWindFile)
+ C    | | |   |-READ_FLD_XY_RS(surfQFile)
+ C    | | |   |-READ_FLD_XY_RS(EmPmRfile)
+ C    | | |   |-READ_FLD_XY_RS(thetaClimFile)
+ C    | | |   |-READ_FLD_XY_RS(saltClimFile)
+ C    | | |   |-READ_FLD_XY_RS(surfQswFile)
+ C    | | |
+ C    | | |-CALC_SURF_DR   :: Calculate the new surface level thickness.
+ C    | | |-UPDATE_SURF_DR :: Update the surface-level thickness fraction.
+ C    | | |-UPDATE_CG2D    :: Update 2d conjugate grad. for Free-Surf.
+ C    | | |-STATE_SUMMARY    :: Summarize model prognostic variables.
+ C    | | |-TIMEAVE_STATVARS :: Time averaging package ( see pkg/timeave ).
+ C    | |
+ C    | |-WRITE_STATE      :: Controlling routine for IO to dump model state.
+ C    | | |-WRITE_REC_XYZ_RL :: Single file I/O
+ C    | | |-WRITE_FLD_XYZ_RL :: Multi-file I/O
+ C    | |
+ C    | |-MONITOR          :: Monitor state ( see pkg/monitor )
+ C    | |-CTRL_MAP_FORCING :: Control vector support package. ( see pkg/ctrl )
+ C====|>|
+ C====|>| ****************************
+ C====|>| BEGIN MAIN TIMESTEPPING LOOP
+ C====|>| ****************************
+ C====|>|
+ C/\  | |-FORWARD_STEP     :: Step forward a time-step ( AT LAST !!! )
+ C/\  | | |
+ C/\  | | |-DUMMY_IN_STEPPING :: autodiff package ( pkg/autoduff ).
+ C/\  | | |-CALC_EXACT_ETA :: Change SSH to flow divergence.
+ 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/\  | | | |                    :: for forcing datasets.
+ C/\  | | | |
+ C/\  | | | |-EXCH :: Sync forcing. in overlap regions.
+ C/\  | | |
+ C/\  | | |-THERMODYNAMICS :: theta, salt + tracer equations driver.
+ C/\  | | | |
+ C/\  | | | |-INTEGRATE_FOR_W :: Integrate for vertical velocity.
+ C/\  | | | |-OBCS_APPLY_W    :: Open bndy. package ( see pkg/obcs ).
+ C/\  | | | |-FIND_RHO        :: Calculates [rho(S,T,z)-Rhonil] of a slice
+ C/\  | | | |-GRAD_SIGMA      :: Calculate isoneutral gradients
+ C/\  | | | |-CALC_IVDC       :: Set Implicit Vertical Diffusivity for Convection
+ C/\  | | | |
+ C/\  | | | |-OBCS_CALC            :: Open bndy. package ( see pkg/obcs ).
+ C/\  | | | |-EXTERNAL_FORCING_SURF:: Accumulates appropriately dimensioned
+ C/\  | | | |                      :: forcing terms.
+ C/\  | | | |
+ C/\  | | | |-GMREDI_CALC_TENSOR   :: GM package ( see pkg/gmredi ).
+ C/\  | | | |-GMREDI_CALC_TENSOR_DUMMY :: GM package ( see pkg/gmredi ).
+ C/\  | | | |-KPP_CALC             :: KPP package ( see pkg/kpp ).
+ C/\  | | | |-KPP_CALC_DUMMY       :: KPP package ( see pkg/kpp ).
+ C/\  | | | |-AIM_DO_ATMOS_PHYSICS :: Intermed. atmos package ( see pkg/aim ).
+ C/\  | | | |-GAD_ADVECTION        :: Generalised advection driver (multi-dim
+ C/\  | | | |                         advection case) (see pkg/gad).
+ C/\  | | | |-CALC_COMMON_FACTORS  :: Calculate common data (such as volume flux)
+ C/\  | | | |-CALC_DIFFUSIVITY     :: Calculate net vertical diffusivity
+ C/\  | | | | |
+ C/\  | | | | |-GMREDI_CALC_DIFF   :: GM package ( see pkg/gmredi ).
+ C/\  | | | | |-KPP_CALC_DIFF      :: KPP package ( see pkg/kpp ).
+ C/\  | | | |
+ C/\  | | | |-CALC_GT              :: Calculate the temperature tendency terms
+ C/\  | | | | |
+ C/\  | | | | |-GAD_CALC_RHS       :: Generalised advection package
+ C/\  | | | | |                    :: ( see pkg/gad )
+ C/\  | | | | |-EXTERNAL_FORCING_T :: Problem specific forcing for temperature.
+ C/\  | | | | |-ADAMS_BASHFORTH2   :: Extrapolate tendencies forward in time.
+ C/\  | | | | |-FREESURF_RESCALE_G :: Re-scale Gt for free-surface height.
+ C/\  | | | |
+ C/\  | | | |-TIMESTEP_TRACER      :: Step tracer field forward in time
+ C/\  | | | |
+ C/\  | | | |-CALC_GS              :: Calculate the salinity tendency terms
+ C/\  | | | | |
+ C/\  | | | | |-GAD_CALC_RHS       :: Generalised advection package
+ C/\  | | | | |                    :: ( see pkg/gad )
+ C/\  | | | | |-EXTERNAL_FORCING_S :: Problem specific forcing for salt.
+ 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/\  | | | |-CALC_GTR1            :: Calculate other tracer(s) tendency terms
+ C/\  | | | | |
+ C/\  | | | | |-GAD_CALC_RHS       :: Generalised advection package
+ C/\  | | | | |                    :: ( see pkg/gad )
+ 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/\  | | | |-OBCS_APPLY_TS        :: Open bndy. package (see pkg/obcs ).
+ C/\  | | | |-FREEZE               :: Limit range of temperature.
+ C/\  | | | |
+ C/\  | | | |-IMPLDIFF             :: Solve vertical implicit diffusion equation.
+ C/\  | | | |-OBCS_APPLY_TS        :: Open bndy. package (see pkg/obcs ).
+ C/\  | | | |
+ C/\  | | | |-AIM_AIM2DYN_EXCHANGES :: Inetermed. atmos (see pkg/aim).
+ C/\  | | | |-EXCH                 :: Update overlaps
+ C/\  | | |
+ C/\  | | |-DYNAMICS       :: Momentum equations driver.
+ C/\  | | | |
+ C/\  | | | |-CALC_GRAD_PHI_SURF :: Calculate the gradient of the surface
+ 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_VECINV         :: Vector invariant form mom eqn. package ( see
+ C/\  | | | |                       pkg/mom_vecinv   ).
+ C/\  | | | |-TIMESTEP           :: Step momentum fields forward in time
+ C/\  | | | |-OBCS_APPLY_UV      :: Open bndy. package (see pkg/obcs ).
+ C/\  | | | |
+ C/\  | | | |-IMPLDIFF           :: Solve vertical implicit diffusion equation.
+ C/\  | | | |-OBCS_APPLY_UV      :: Open bndy. package (see pkg/obcs ).
+ C/\  | | | |
+ C/\  | | | |-TIMEAVE_CUMUL_1T   :: Time averaging package ( see pkg/timeave ).
+ C/\  | | | |-TIMEAVE_CUMUATE    :: Time averaging package ( see pkg/timeave ).
+ C/\  | | | |-DEBUG_STATS_RL     :: Quick debug package ( see pkg/debug ).
+ C/\  | | |
+ C/\  | | |-CALC_GW        :: vert. momentum tendency terms ( NH, QH only ).
+ C/\  | | |
+ C/\  | | |-UPDATE_SURF_DR :: Update the surface-level thickness fraction.
+ C/\  | | |
+ C/\  | | |-UPDATE_CG2D    :: Update 2d conjugate grad. for Free-Surf.
+ C/\  | | |
+ C/\  | | |-SOLVE_FOR_PRESSURE           :: Find surface pressure.
+ C/\  | | | |-CALC_DIV_GHAT     :: Form the RHS of the surface pressure eqn.
+ C/\  | | | |-CG2D              :: Two-dim pre-con. conjugate-gradient.
+ C/\  | | | |-CG3D              :: Three-dim pre-con. conjugate-gradient solver.
+ C/\  | | |
+ C/\  | | |-THE_CORRECTION_STEP          :: Step forward to next time step.
+ C/\  | | | |
+ C/\  | | | |-CALC_GRAD_PHI_SURF :: Return DDx and DDy of surface pressure
+ C/\  | | | |-CORRECTION_STEP    :: Pressure correction to momentum
+ C/\  | | | |-CYCLE_TRACER       :: Move tracers forward in time.
+ C/\  | | | |-OBCS_APPLY         :: Open bndy package. see pkg/obcs
+ C/\  | | | |-SHAP_FILT_APPLY    :: Shapiro filter package. see pkg/shap_filt
+ C/\  | | | |-ZONAL_FILT_APPLY   :: FFT filter package. see pkg/zonal_filt
+ C/\  | | | |-CONVECTIVE_ADJUSTMENT :: Control static instability mixing.
+ 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/\  | | |-DO_FIELDS_BLOCKING_EXCHANGES :: Sync up overlap regions.
+ C/\  | | | |-EXCH
+ C/\  | | |
+ C/\  | | |-FLT_MAIN         :: Float package ( pkg/flt ).
+ C/\  | | |
+ C/\  | | |-MONITOR          :: Monitor package ( pkg/monitor ).
+ C/\  | | |
+ C/\  | | |-DO_THE_MODEL_IO  :: Standard diagnostic I/O.
+ C/\  | | | |-WRITE_STATE    :: Core state I/O
+ C/\  | | | |-TIMEAVE_STATV_WRITE :: Time averages. see pkg/timeave
+ C/\  | | | |-AIM_WRITE_DIAGS     :: Intermed. atmos diags. see pkg/aim
+ C/\  | | | |-GMREDI_DIAGS        :: GM diags. see pkg/gmredi
+ C/\  | | | |-KPP_DO_DIAGS        :: KPP diags. see pkg/kpp
+ C/\  | | |
+ C/\  | | |-WRITE_CHECKPOINT :: Do I/O for restart files.
+ C/\  | |
+ C/\  | |-COST_TILE        :: Cost function package. ( see pkg/cost )
+ C<===|=|
+ C<===|=| **************************
+ C<===|=| END MAIN TIMESTEPPING LOOP
+ C<===|=| **************************
+ C<===|=|
+ C    | |-COST_FINAL       :: Cost function package. ( see pkg/cost )
+ C    |
+ C    |-WRITE_CHECKPOINT :: Final state storage, for restart.
+ C    |
+ C    |-TIMER_PRINTALL :: Computational timing summary
+ C    |
+ C    |-COMM_STATS     :: Summarise inter-proc and inter-thread communication
+ C                     :: events.
+ C \ev
+ C
+ C
+ CEOI
  #include "CPP_OPTIONS.h"
+ CBOP
+ C     !ROUTINE: THE_MODEL_MAIN
+ C     !INTERFACE:
        SUBROUTINE THE_MODEL_MAIN(myThid)
- 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     \==========================================================/
        IMPLICIT NONE
- C
+ 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
+ C     !CALLING SEQUENCE:
+ C     THE_MODEL_MAIN()
+ C       |
+ C       |
+ C       |--INITIALISE_FIXED
+ C       |   o Set model configuration (fixed arrays)
+ C       |     Topography, hydrography, timestep, grid, etc..
+ C       |
+ C       |--CTRL_UNPACK      o Derivative mode. Unpack control vector.
+ C       |
+ C       |--ADTHE_MAIN_LOOP  o Main timestepping loop for combined
+ C       |                     prognostic and reverse mode integration.
+ C       |
+ C       |--CTRL_PACK        o Derivative mode. Unpack control vector.
+ C       |
+ C       |--GRDCHK_MAIN      o Gradient check control routine.
+ C       |
+ C       |--THE_MAIN_LOOP    o Main timestepping loop for pure prognostic
+ C       |                     integration.
+ C       |
+ C       |--WRITE_CHECKPOINT o Write retsart information.
+ C       |
+ C       |--TIMER_PRINTALL   o Print out timing statistics.
+ C       |
+ C       |--COMM_STATS       o Print out communication statistics.
+ C     !USES:
  C     == Global variables ===
  #include "SIZE.h"
  #include "EEPARAMS.h"
-Line 36 
 C     == Global variables ===
+Line 437 
 C     == Global variables ===
  #ifdef ALLOW_AUTODIFF_TAMC
  #include "tamc.h"
- #include "cost.h"
- #include "adcost.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 ==
  C     Note: Under the multi-threaded model myCurrentIter and
  C           myCurrentTime are local variables passed around as routine
-Line 52 
 C           impose additional synchronis
+Line 453 
 C           impose additional synchronis
  C           updated.
  C     myCurrentTime - Time counter for this thread
  C     myCurrentIter - Iteration counter for this thread
+       INTEGER I
+       INTEGER bi,bj
        INTEGER myCurrentIter
        _RL     myCurrentTime
+ CEOP
  C--   This timer encompasses the whole code
        CALL TIMER_START('ALL                [THE_MODEL_MAIN]',myThid)
  C--   Set model configuration (fixed arrays)
        CALL TIMER_START('INITIALISE_FIXED   [THE_MODEL_MAIN]',myThid)
        CALL INITIALISE_FIXED( myThid )
-Line 67 
 C--   Set model configuration (fixed arr
+Line 470 
 C--   Set model configuration (fixed arr
        myCurrentTime = startTime
        myCurrentIter = nIter0
- #ifdef ALLOW_ADJOINT_RUN
+ #if ( defined (ALLOW_ADJOINT_RUN) || \
+       defined (ALLOW_GRADIENT_CHECK) || \
+       defined (ALLOW_ECCO_OPTIMIZATION) )
        _BEGIN_MASTER( mythid )
        IF (myProcId .eq. 0) THEN
-Line 76 
 C--   Set model configuration (fixed arr
+Line 481 
 C--   Set model configuration (fixed arr
        _END_MASTER( mythid )
        _BARRIER
-       fc   = 0.0
+       CALL COST_DEPENDENT_INIT ( mythid )
-       adfc = 1.0
+       _BARRIER
        CALL TIMER_START('ADTHE_MAIN_LOOP          [ADJOINT RUN]', mythid)
        CALL ADTHE_MAIN_LOOP ( mythid )
        CALL TIMER_STOP ('ADTHE_MAIN_LOOP          [ADJOINT RUN]', mythid)
-Line 99 
 C--   Set model configuration (fixed arr
+Line 505 
 C--   Set model configuration (fixed arr
        end if
  #endif
+ #elif (defined (ALLOW_TANGENTLINEAR_RUN))
+       _BEGIN_MASTER( mythid )
+       IF (myProcId .eq. 0) THEN
+          CALL CTRL_UNPACK( mycurrentiter, mycurrenttime, mythid )
+       ENDIF
+       _END_MASTER( mythid )
+       _BARRIER
+       CALL COST_DEPENDENT_INIT ( mythid )
+       _BARRIER
+       CALL TIMER_START('G_THE_MAIN_LOOP          [FTL RUN]', mythid)
+       CALL G_THE_MAIN_LOOP ( myCurrentTime, myCurrentIter, myThid )
+       CALL TIMER_STOP ('G_THE_MAIN_LOOP          [FTL RUN]', mythid)
+       _BARRIER
+       _BEGIN_MASTER( mythid )
+       IF (myProcId .eq. 0) THEN
+          call CTRL_PACK( mycurrentiter, mycurrenttime, mythid )
+       ENDIF
+       _END_MASTER( mythid )
+       _BARRIER
  #else /* ALLOW_ADJOINT_RUN undef */
  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 THE_MAIN_LOOP( myCurrentTime, myCurrentIter, myThid )
        CALL TIMER_STOP ('THE_MAIN_LOOP      [THE_MODEL_MAIN]',myThid)
  #endif /* ALLOW_ADJOINT_RUN */

 Legend:



Removed from v.1.39
 


changed lines


 
Added in v.1.44
 Legend:



Removed from v.1.39
 


changed lines


 
Added in v.1.44
-Removed from v.1.39
+Added in v.1.44

	ViewVC Help
Powered by ViewVC 1.1.22