/[MITgcm]/MITgcm/doc/devel_HOWTO.sgml

Diff of /MITgcm/doc/devel_HOWTO.sgml

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

-revision 1.7 by edhill,
Tue Apr  6 04:12:00 2004 UTC
+revision 1.9 by jmc,
Tue May  9 21:10:19 2006 UTC
 Line 290 
 checkpoint50d_pre
    $ export CVS_RSH=ssh
    $ export CVSROOT=':ext:NAME@mitgcm.org:/u/gcmpack'
    $ mkdir scratch
-   $ cvs co MITgcm manual mitgcm.org
+   $ cvs co -P MITgcm manual mitgcm.org
  </screen>
        <para>These commands extract the necessary information from the CVS server
 Line 886 
 o  Each package gets its runtime configu
     Package runtime config. options are imported
     into a common block held in a header file
     called "${PKG}.h".
+    Note: In some packages, the header file "${PKG}.h" is splitted
+    into "${PKG}_PARAMS.h" that contains the package parameters and
+    ${PKG}_VARS.h" for the field arrays.
  o  The core driver part of the model can check
     for runtime enabling or disabling of individual packages
-Line 908 
 CPP Flags
+Line 911 
 CPP Flags
 . Within the core driver code flags of the form
         ALLOW_${PKG} are used to include or exclude
         whole packages. The ALLOW_${PKG} flags are included
-        from a PKG_CPP_OPTIONS block which is currently
+        from a PACKAGES_CONFIG.h file that is automatically
+        generated by genmake2 (see genmake2 section).
         held in-line in the CPP_OPTIONS.h header file.
         e.g.
         Core model code .....
+        #include "PACKAGES_CONFIG.h"
         #include "CPP_OPTIONS.h"
           :
           :
-Line 925 
 CPP Flags
+Line 930 
 CPP Flags
 . Within an individual package a header file,
         "${PKG}_OPTIONS.h", is used to set CPP flags
-        specific to that package. It is not recommended
+        specific to that package. It also includes
-        to include this file in "CPP_OPTIONS.h".
+        "PACKAGES_CONFIG.h" and "CPP_OPTIONS.h".
  Package Boot Sequence
-Line 978 
 Package Output
+Line 983 
 Package Output
          #ifdef ALLOW_${PKG}
            if ( use${Pkg} )
-      &       CALL ${PKG}_DIAGS( )
+      &       CALL ${PKG}_OUTPUT( )
          #endif
 . S/R PACKAGES_WRITE_PICKUP()
-Line 994 
 Description
+Line 999 
 Description
        - ${PKG}_READPARMS()
      is responsible for reading
      in the package parameters file data.${pkg}, and storing
-     the package parameters in "${PKG}.h".
+     the package parameters in "${PKG}.h" (or in "${PKG}_PARAMS.h").
      -> called from INITIALISE_FIXED in PACKAGES_READPARMS
       - ${PKG}_INIT_FIXED()
-Line 1024 
 Description
+Line 1029 
 Description
       use for e.g. ${PKG}_INI_VARS, ${PKG}_INIT_VARIABLES, or the old
       form ${PKG}_INIT
-      - ${PKG}_DIAGS()
+      - ${PKG}_OUTPUT( )
-      is responsible for writing time-average diagnostics to output
+      is responsible for writing time-average fields to output files
-      files (but the cumulating step is done within the package main S/R).
+      (but the cumulating step is done within the package main S/R).
       Can also contain other diagnostics (.e.g. CALL ${PKG}_MONITOR)
       and write snap-shot fields that are hold in common blocks. Other
       temporary fields are directly dump to file where they are available.
-      NOTE: this part does not yet have a standard form and should be called
+      NOTE: 1) the S/R old name ${PKG}_DIAGS is used in some packages
-        from a package dedicated S/R such as PACKAGE_WRITE_DIAGS
+               but is beeing replaced by ${PKG}_OUTPUT
+               to avoid confusion with pkg/diagnostics functionality.
+) the output part is not yet in a standard form and might still
+               evolve a lot.
      -> called within DO_THE_MODEL_IO
       - ${PKG}_WRITE_PICKUP()
-Line 1058 
 Summary
+Line 1066 
 Summary
    -----------------------
    * ${PKG}_OPTIONS.h     has further package-specific CPP options
    * ${PKG}.h             package-specific common block variables, fields
+    or  ${PKG}_PARAMS.h   package-specific common block parameters
+    and ${PKG}_VARS.h     package-specific common block fields
  - FORTRAN source files
    -----------------------
-Line 1066 
 Summary
+Line 1076 
 Summary
    * ${pkg}_check.F        checks package dependencies and consistencies
    * ${pkg}_init_varia.F   initialises package-related fields
    * ${pkg}_... .F         package source code
-   * ${pkg}_diags.F        write diagnostics to file.
+   * ${pkg}_output.F       write output to file.
    * ${pkg}_write_pickup.F write a package pickup file to restart the model
+   New: Subroutine in one package (pkgA) that only contains code which
+        is connected to a 2nd package (pkgB) (e.g.: gmredi_diagnostics_init.F)
+        will be named: pkgA_pkgB_something.F
  - parameter file
    -----------------------
    * data.${pkg}          parameter file

 Legend:



Removed from v.1.7
 


changed lines


 
Added in v.1.9
 Legend:



Removed from v.1.7
 


changed lines


 
Added in v.1.9
-Removed from v.1.7
+Added in v.1.9

	ViewVC Help
Powered by ViewVC 1.1.22