Add HYPRE_BRANCH_NAME (#759)

This PR adds a new variable in `HYPRE_config.h` for naming the hypre's branch currently in use. Internal drivers have been updated to use this variable

* Add HYPRE_BRANCH_NAME to Makefile and cmake builds
* Run config/update.sh
* Ignore files generated by cmake in the cmbuild folder
* Update drivers
* Update regression tests

.gitignore

@@ -14,6 +14,7 @@ HYPRE_config.h
 autom4te.cache
 src/TAGS
 hypre/
+cmbuild/
 
 ###############
 # Documentation

src/CMakeLists.txt

@@ -44,6 +44,7 @@ if (EXISTS ${HYPRE_SOURCE_DIR}/../.git)
   if (${develop_string} MATCHES ".*")
     set(HYPRE_DEVELOP_STRING  ${develop_string})
     set(HYPRE_DEVELOP_NUMBER  ${develop_number})
+    set(HYPRE_BRANCH_NAME     ${develop_branch})
     if (develop_branch MATCHES "master")
       set(HYPRE_DEVELOP_BRANCH  ${develop_branch})
     else ()

src/config/HYPRE_config.h.in

@@ -56,6 +56,9 @@
 /* Define to 1 if using long long int for HYPRE_Int and HYPRE_BigInt */
 #undef HYPRE_BIGINT
 
+/* Feature branch string */
+#undef HYPRE_BRANCH_NAME
+
 /* Define to 1 if using complex values */
 #undef HYPRE_COMPLEX
 

src/config/configure.in

@@ -115,6 +115,7 @@ AS_IF([test -d "$HYPRE_SRCDIR/../.git"],
     [
     AC_DEFINE_UNQUOTED(HYPRE_DEVELOP_STRING, ["$develop_string"], [Develop branch string])
     AC_DEFINE_UNQUOTED(HYPRE_DEVELOP_NUMBER, [$develop_number],   [Develop branch commit number])
+    AC_DEFINE_UNQUOTED(HYPRE_BRANCH_NAME,    ["$develop_branch"], [Feature branch string])
     AS_IF([test "x$develop_branch" = "xmaster"],
       [AC_DEFINE_UNQUOTED(HYPRE_DEVELOP_BRANCH, ["$develop_branch"], [Main development branch?])],
       [AC_MSG_NOTICE([NOTE: On branch $develop_branch, not the main development branch])]

src/configure

@@ -2738,6 +2738,11 @@ cat >>confdefs.h <<_ACEOF
 #define HYPRE_DEVELOP_NUMBER $develop_number
 _ACEOF
 
+
+cat >>confdefs.h <<_ACEOF
+#define HYPRE_BRANCH_NAME "$develop_branch"
+_ACEOF
+
     if test "x$develop_branch" = "xmaster"; then :
 
 cat >>confdefs.h <<_ACEOF

src/test/TEST_ij/versioncheck.sh

@@ -19,10 +19,10 @@ if [ -d ../../../.git ]; then
   DEVBRANCH=`git rev-parse --abbrev-ref HEAD`
   if [ -n "$DEVSTRING" ]; then
     if [ "$DEVBRANCH" != "master" ]; then
-      echo "Using HYPRE_DEVELOP_STRING: $DEVSTRING (not main development branch)" \
+      echo "Using HYPRE_DEVELOP_STRING: $DEVSTRING (branch $DEVBRANCH; not the develop branch)" \
        > ${TNAME}.testdatacheck
     else
-      echo "Using HYPRE_DEVELOP_STRING: $DEVSTRING (main development branch $DEVBRANCH)" \
+      echo "Using HYPRE_DEVELOP_STRING: $DEVSTRING (branch $DEVBRANCH; the develop branch)" \
        > ${TNAME}.testdatacheck
     fi
   fi

src/test/TEST_sstruct/versioncheck.sh

@@ -19,10 +19,10 @@ if [ -d ../../../.git ]; then
   DEVBRANCH=`git rev-parse --abbrev-ref HEAD`
   if [ -n "$DEVSTRING" ]; then
     if [ "$DEVBRANCH" != "master" ]; then
-      echo "Using HYPRE_DEVELOP_STRING: $DEVSTRING (not main development branch)" \
+      echo "Using HYPRE_DEVELOP_STRING: $DEVSTRING (branch $DEVBRANCH; not the develop branch)" \
        > ${TNAME}.testdatacheck
     else
-      echo "Using HYPRE_DEVELOP_STRING: $DEVSTRING (main development branch $DEVBRANCH)" \
+      echo "Using HYPRE_DEVELOP_STRING: $DEVSTRING (branch $DEVBRANCH; the develop branch)" \
        > ${TNAME}.testdatacheck
     fi
   fi

src/test/TEST_struct/versioncheck.sh

@@ -19,10 +19,10 @@ if [ -d ../../../.git ]; then
   DEVBRANCH=`git rev-parse --abbrev-ref HEAD`
   if [ -n "$DEVSTRING" ]; then
     if [ "$DEVBRANCH" != "master" ]; then
-      echo "Using HYPRE_DEVELOP_STRING: $DEVSTRING (not main development branch)" \
+      echo "Using HYPRE_DEVELOP_STRING: $DEVSTRING (branch $DEVBRANCH; not the develop branch)" \
        > ${TNAME}.testdatacheck
     else
-      echo "Using HYPRE_DEVELOP_STRING: $DEVSTRING (main development branch $DEVBRANCH)" \
+      echo "Using HYPRE_DEVELOP_STRING: $DEVSTRING (branch $DEVBRANCH; the develop branch)" \
        > ${TNAME}.testdatacheck
     fi
   fi

src/test/ij.c

@@ -2391,15 +2391,19 @@ main( hypre_int argc,
 
    if (myid == 0)
    {
-#ifdef HYPRE_DEVELOP_STRING
+#if defined(HYPRE_DEVELOP_STRING) && defined(HYPRE_DEVELOP_BRANCH)
-#ifdef HYPRE_DEVELOP_BRANCH
+      hypre_printf("\nUsing HYPRE_DEVELOP_STRING: %s (branch %s; the develop branch)\n\n",
-      hypre_printf("\nUsing HYPRE_DEVELOP_STRING: %s (main development branch %s)\n\n",
                    HYPRE_DEVELOP_STRING, HYPRE_DEVELOP_BRANCH);
-#else
+
-      hypre_printf("\nUsing HYPRE_DEVELOP_STRING: %s (not main development branch)\n\n",
+#elif defined(HYPRE_DEVELOP_STRING) && !defined(HYPRE_DEVELOP_BRANCH)
-                   HYPRE_DEVELOP_STRING);
+      hypre_printf("\nUsing HYPRE_DEVELOP_STRING: %s (branch %s; not the develop branch)\n\n",
-#endif
+                   HYPRE_DEVELOP_STRING, HYPRE_BRANCH_NAME);
+
+#elif defined(HYPRE_RELEASE_VERSION)
+      hypre_printf("\nUsing HYPRE_RELEASE_VERSION: %s\n\n",
+                   HYPRE_RELEASE_VERSION);
 #endif
+
       hypre_printf("Running with these driver parameters:\n");
       hypre_printf("  solver ID    = %d\n\n", solver_id);
    }

src/test/sstruct.c

@@ -2917,14 +2917,17 @@ main( hypre_int argc,
 
    if (myid == 0)
    {
-#ifdef HYPRE_DEVELOP_STRING
+#if defined(HYPRE_DEVELOP_STRING) && defined(HYPRE_DEVELOP_BRANCH)
-#ifdef HYPRE_DEVELOP_BRANCH
+      hypre_printf("\nUsing HYPRE_DEVELOP_STRING: %s (branch %s; the develop branch)\n\n",
-      hypre_printf("\nUsing HYPRE_DEVELOP_STRING: %s (main development branch %s)\n\n",
                    HYPRE_DEVELOP_STRING, HYPRE_DEVELOP_BRANCH);
-#else
+
-      hypre_printf("\nUsing HYPRE_DEVELOP_STRING: %s (not main development branch)\n\n",
+#elif defined(HYPRE_DEVELOP_STRING) && !defined(HYPRE_DEVELOP_BRANCH)
-                   HYPRE_DEVELOP_STRING);
+      hypre_printf("\nUsing HYPRE_DEVELOP_STRING: %s (branch %s; not the develop branch)\n\n",
-#endif
+                   HYPRE_DEVELOP_STRING, HYPRE_BRANCH_NAME);
+
+#elif defined(HYPRE_RELEASE_VERSION)
+      hypre_printf("\nUsing HYPRE_RELEASE_VERSION: %s\n\n",
+                   HYPRE_RELEASE_VERSION);
 #endif
    }
 

src/test/struct.c

@@ -736,15 +736,19 @@ main( hypre_int argc,
 
    if (myid == 0 && sum == 0)
    {
-#ifdef HYPRE_DEVELOP_STRING
+#if defined(HYPRE_DEVELOP_STRING) && defined(HYPRE_DEVELOP_BRANCH)
-#ifdef HYPRE_DEVELOP_BRANCH
+      hypre_printf("\nUsing HYPRE_DEVELOP_STRING: %s (branch %s; the develop branch)\n\n",
-      hypre_printf("\nUsing HYPRE_DEVELOP_STRING: %s (main development branch %s)\n\n",
                    HYPRE_DEVELOP_STRING, HYPRE_DEVELOP_BRANCH);
-#else
+
-      hypre_printf("\nUsing HYPRE_DEVELOP_STRING: %s (not main development branch)\n\n",
+#elif defined(HYPRE_DEVELOP_STRING) && !defined(HYPRE_DEVELOP_BRANCH)
-                   HYPRE_DEVELOP_STRING);
+      hypre_printf("\nUsing HYPRE_DEVELOP_STRING: %s (branch %s; not the develop branch)\n\n",
-#endif
+                   HYPRE_DEVELOP_STRING, HYPRE_BRANCH_NAME);
+
+#elif defined(HYPRE_RELEASE_VERSION)
+      hypre_printf("\nUsing HYPRE_RELEASE_VERSION: %s\n\n",
+                   HYPRE_RELEASE_VERSION);
 #endif
+
       hypre_printf("Running with these driver parameters:\n");
       hypre_printf("  (nx, ny, nz)    = (%d, %d, %d)\n", nx, ny, nz);
       hypre_printf("  (istart[0],istart[1],istart[2]) = (%d, %d, %d)\n", \