Merge remote-tracking branch 'gfdl/dev/gfdl' into user/ksh/open_bc

config_src/dynamic_symmetric/MOM_memory.h

@@ -1,48 +1,33 @@
-!********+*********+*********+*********+*********+*********+*********+*
-!*   This include file determines the compile-time memory settings    *
-!*  for the Modular Ocean Model (MOM), versions 6 and later.          *
-!********+*********+*********+*********+*********+*********+*********+*
+!/*! \brief Compile-time memory settings */
+!/*! \details This include file determines the compile-time memory settings. There are several variants of this file and only one should be in the search path for compilation. */
+!/*! \file MOM_memory.h */
 
-!  Specify the numerical domain.
+!/*! The number of thickness grid points in the i-direction of the global domain. */
 #define NIGLOBAL_ NONSENSE_NIGLOBAL
+!/*! The number of thickness grid points in the j-direction of the global domain. */
 #define NJGLOBAL_ NONSENSE_NJGLOBAL
-                               !    NIGLOBAL_ and NJGLOBAL_ are the number of thickness
-                               !  grid points in the zonal and meridional
-                               !  directions of the physical domain.
+!/*! The number of layers in the vertical direction. */
 #define NK_ NONSENSE_NK
-                               !    The number of layers.
 
+!/*! \def STATIC_MEMORY_ If STATIC_MEMORY_ is defined, the principle variables will have sizes that are statically determined at compile time. Otherwise the sizes are not determined until run time. */
 #undef STATIC_MEMORY_
-                               !    If STATIC_MEMORY_ is defined, the principle
-                               !  variables will have sizes that are statically
-                               !  determined at compile time.  Otherwise the
-                               !  sizes are not determined until run time. The
-                               !  STATIC option is substantially faster, but
-                               !  does not allow the PE count to be changed at
-                               !  run time.
+
+!/*! If SYMMETRIC_MEMORY_ is defined, the velocity point data domain includes every face of the thickness points. In other words, some arrays are larger than others, depending on where they are on the staggered grid. */
 #define SYMMETRIC_MEMORY_
-                               !    If defined, the velocity point data domain
-                               !  includes every face of the thickness points.
-                               !  In other words, some arrays are larger than
-                               !  others, depending on where they are on the 
-                               !  staggered grid.
 
+!/*! The number of processors in the i-direction. */
 #define NIPROC_ NONSENSE_NIPROC
-                               !    NIPROC_ is the number of processors in the
-                               !  x-direction.
+
+!/*! The number of processors in the j-direction. */
 #define NJPROC_ NONSENSE_NJPROC
-                               !    NJPROC_ is the number of processors in the
-                               !  y-direction.
 
+!/*! The maximum permitted number (each) of restart variables, time derivatives, etc. This is mostly used for the size of pointer arrays, so it should be set generously. */
 #define MAX_FIELDS_ 50
-                               !    The maximum permitted number (each) of
-                               !  restart variables, time derivatives, etc.
-                               !  This is mostly used for the size of pointer
-                               !  arrays, so it should be set generously.
 
+!/*! The number of memory halo cells on each side of the computational domain in the i-direction */
 #define NIHALO_ 2
+
+!/*! The number of memory halo cells on each side of the computational domain in the j-direction */
 #define NJHALO_ 2
-                               !   NIHALO_ and NJHALO_ are the sizes of the
-                               ! memory halos on each side.
 
 #include <MOM_memory_macros.h>