Merge Pull Request #4864 from trilinos/Trilinos/deprecateFourPackages

Automatically Merged using Trilinos Pull Request AutoTester PR Title: Trilinos: Deprecate four packages OptiPack, GlobiPack, Trios, Claps PR Author: kddevin
trilinos · Apr 16, 2019 · 6a95915 · 6a95915
2 parents 2ba9037 + f59aedf
commit 6a95915
Show file tree

Hide file tree

Showing 15 changed files with 95 additions and 10 deletions.
diff --git a/cmake/std/PullRequestLinuxGCC7.2.0TestingSettings.cmake b/cmake/std/PullRequestLinuxGCC7.2.0TestingSettings.cmake
@@ -35,7 +35,7 @@ set (Domi_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror" CACHE STRING "Warnings as error
 set (EpetraExt_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror" CACHE STRING "Warnings as errors setting")
 #set (FEI_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror" CACHE STRING "Warnings as errors setting")
 set (Galeri_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror" CACHE STRING "Warnings as errors setting")
-set (GlobiPack_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror" CACHE STRING "Warnings as errors setting")
+set (GlobiPack_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror -DTRILINOS_HIDE_DEPRECATED_HEADER_WARNINGS" CACHE STRING "Warnings as errors setting")
 set (Gtest_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror" CACHE STRING "Warnings as errors setting")
 set (Ifpack_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror" CACHE STRING "Warnings as errors setting")
 set (Ifpack2_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror" CACHE STRING "Warnings as errors setting")
@@ -48,12 +48,12 @@ set (MiniTensor_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror" CACHE STRING "Warnings as
 set (ML_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror" CACHE STRING "Warnings as errors setting")
 set (MueLu_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror" CACHE STRING "Warnings as errors setting")
 set (NOX_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror" CACHE STRING "Warnings as errors setting")
-set (OptiPack_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror" CACHE STRING "Warnings as errors setting")
+set (OptiPack_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror -DTRILINOS_HIDE_DEPRECATED_HEADER_WARNINGS" CACHE STRING "Warnings as errors setting")
 #set (Pamgen_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror" CACHE STRING "Warnings as errors setting")
 set (Panzer_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror" CACHE STRING "Warnings as errors setting")
 set (Phalanx_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror" CACHE STRING "Warnings as errors setting")
 set (Pike_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror" CACHE STRING "Warnings as errors setting")
-set (Piro_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror" CACHE STRING "Warnings as errors setting")
+set (Piro_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror -DTRILINOS_HIDE_DEPRECATED_HEADER_WARNINGS" CACHE STRING "Warnings as errors setting")
 #set (ROL_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror" CACHE STRING "Warnings as errors setting")
 set (RTOp_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror" CACHE STRING "Warnings as errors setting")
 set (Rythmos_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Werror" CACHE STRING "Warnings as errors setting")

diff --git a/packages/claps/CMakeLists.txt b/packages/claps/CMakeLists.txt
@@ -15,6 +15,13 @@ TRIBITS_ADD_OPTION_AND_DEFINE(${PACKAGE_NAME}_ENABLE_SClaps
   "Enable Sandia Claps interface."
   OFF )
 
+#
+# Claps package is deprecated April 2019; to be removed May 2019
+
+MESSAGE(WARNING "***** WARNING:  Package Claps is deprecated in April 2019; it will be removed in May 2019 *****")
+
+TRIBITS_ADD_SHOW_DEPRECATED_WARNINGS_OPTION()
+
 #
 # C) Add the libraries, tests, and examples
 #

diff --git a/packages/claps/cmake/Claps_config.h.in b/packages/claps/cmake/Claps_config.h.in
@@ -21,6 +21,8 @@
 /* Define to 1 if you have the <unistd.h> header file. */
 #cmakedefine HAVE_UNISTD_H
 
+@CLAPS_DEPRECATED_DECLARATIONS@
+
 /* Define to `__inline__' or `__inline' if that's what the C compiler
    calls it, or to nothing if 'inline' is not supported under any name.  */
 #ifndef __cplusplus

diff --git a/packages/claps/src/Claps_ConfigDefs.hpp b/packages/claps/src/Claps_ConfigDefs.hpp
@@ -44,6 +44,12 @@
 #ifndef EPETRA_CONFIGDEFS_H
 #define EPETRA_CONFIGDEFS_H
 
+#if !defined(TRILINOS_HIDE_DEPRECATED_HEADER_WARNINGS)
+#ifdef __GNUC__
+#  warning "The package Claps is deprecated in April 2019; it will be removed from Trilinos in May 2019."
+#endif
+#endif
+
 #ifndef __cplusplus
 #define __cplusplus
 #endif

diff --git a/packages/globipack/CMakeLists.txt b/packages/globipack/CMakeLists.txt
@@ -2,6 +2,9 @@
 
 TRIBITS_PACKAGE( GlobiPack ENABLE_SHADOWING_WARNINGS CLEANED )
 
+# GlobiPack package is deprecated April 2019; to be removed May 2019
+MESSAGE(WARNING "***** WARNING:  Package GlobiPack is deprecated in April 2019; it will be removed in May 2019 *****")
+
 TRIBITS_ADD_EXPLICIT_INSTANTIATION_OPTION()
 
 ADD_SUBDIRECTORY(src)

diff --git a/packages/globipack/cmake/GlobiPack_Config.h.in b/packages/globipack/cmake/GlobiPack_Config.h.in
@@ -1 +1,7 @@
-/* Nothing to add yet!. */
+/* Deprecation notice */
+#if !defined(TRILINOS_HIDE_DEPRECATED_HEADER_WARNINGS)
+#ifdef __GNUC__
+#  warning "The package GlobiPack is deprecated in April 2019; it will be removed from Trilinos in May 2019."
+#endif
+#endif
+
diff --git a/packages/optipack/CMakeLists.txt b/packages/optipack/CMakeLists.txt
@@ -2,6 +2,11 @@
 
 TRIBITS_PACKAGE(OptiPack)
 
+# OptiPack package is deprecated April 2019; to be removed May 2019
+MESSAGE(WARNING "***** WARNING:  Package OptiPack is deprecated in April 2019; it will be removed in May 2019 *****")
+
+TRIBITS_ADD_SHOW_DEPRECATED_WARNINGS_OPTION()
+
 TRIBITS_ADD_EXPLICIT_INSTANTIATION_OPTION()
 
 ADD_SUBDIRECTORY(src)

diff --git a/packages/optipack/cmake/OptiPack_Config.h.in b/packages/optipack/cmake/OptiPack_Config.h.in
@@ -1 +1,9 @@
-/* Nothing to add yet!. */
+/* Deprecation notice */
+#if !defined(TRILINOS_HIDE_DEPRECATED_HEADER_WARNINGS)
+#ifdef __GNUC__
+#  warning "The package OptiPack is deprecated in April 2019; it will be removed from Trilinos in May 2019."
+#endif
+#endif
+
+@OPTIPACK_DEPRECATED_DECLARATIONS@
+
diff --git a/packages/piro/CMakeLists.txt b/packages/piro/CMakeLists.txt
@@ -29,6 +29,10 @@ IF (${PACKAGE_NAME}_ENABLE_Epetra AND NOT NOX_ENABLE_Epetra)
   MESSAGE(FATAL_ERROR "Piro configuration error: Enabling Epetra in Piro also requires that Epetra be enabled in NOX (-DNOX_ENABLE_Epetra:BOOL=ON)")
 ENDIF()
 
+IF (${PACKAGE_NAME}_ENABLE_OptiPack)
+  MESSAGE(WARNING "***** WARNING:  OptiPack is deprecated in April 2019; it will be  removed in May 2019 ***** ")
+  MESSAGE(WARNING "***** WARNING:  Option Piro_ENABLE_OptiPack is deprecated in April 2019; it will be removed in May 2019 ***** ")
+ENDIF()
 
 #
 # C) Add the libraries, tests, and examples

diff --git a/packages/piro/cmake/Piro_config.hpp.in b/packages/piro/cmake/Piro_config.hpp.in
@@ -33,9 +33,13 @@
 #cmakedefine HAVE_PIRO_STOKHOS
 /* DEPRECATED */
 #cmakedefine Piro_ENABLE_Stokhos
+
+#ifndef OPTIPACK_HIDE_DEPRECATED_CODE
 #cmakedefine HAVE_PIRO_OPTIPACK
 /* DEPRECATED */
 #cmakedefine Piro_ENABLE_OptiPack
+#endif
+
 #cmakedefine HAVE_PIRO_TRIKOTA
 /* DEPRECATED */
 #cmakedefine Piro_ENABLE_TriKota

diff --git a/packages/piro/src/Piro_PerformAnalysis.cpp b/packages/piro/src/Piro_PerformAnalysis.cpp
@@ -58,10 +58,12 @@
 #include "MoochoPack_MoochoThyraSolver.hpp"
 #endif
 
+#ifndef OPTIPACK_HIDE_DEPRECATED_CODE
 #ifdef HAVE_PIRO_OPTIPACK
 #include "OptiPack_NonlinearCG.hpp"
 #include "GlobiPack_BrentsLineSearch.hpp"
 #endif
+#endif
 
 #ifdef HAVE_PIRO_ROL
 #include "ROL_ThyraVector.hpp"
@@ -103,8 +105,7 @@ Piro::PerformAnalysis(
   }
 #ifdef HAVE_PIRO_TRIKOTA
   else if (analysis=="Dakota") {
-    *out << "Piro PerformAnalysis: Dakota Analysis Being Performed " << endl;
-
+    *out << "Piro PerformAnalysis: Dakota Analysis Being Performed " << endl; 
     status = Piro::PerformDakotaAnalysis(piroModel,
                          analysisParams.sublist("Dakota"), result);
 
@@ -118,6 +119,8 @@ Piro::PerformAnalysis(
 
   }
 #endif
+
+#ifndef OPTIPACK_HIDE_DEPRECATED_CODE
 #ifdef HAVE_PIRO_OPTIPACK
   else if (analysis == "OptiPack") {
     *out << "Piro PerformAnalysis: Optipack Optimization Being Performed " << endl;
@@ -127,6 +130,8 @@ Piro::PerformAnalysis(
 
   }
 #endif
+#endif
+
 #ifdef HAVE_PIRO_ROL
   else if (analysis == "ROL") {
     *out << "Piro PerformAnalysis: ROL Optimization Being Performed " << endl;
@@ -136,12 +141,20 @@ Piro::PerformAnalysis(
   }
 #endif
   else {
-    if (analysis == "Dakota" || analysis == "OptiPack" || analysis == "MOOCHO" || analysis == "ROL")
+    if (analysis == "Dakota" || 
+#ifndef OPTIPACK_HIDE_DEPRECATED_CODE
+        analysis == "OptiPack" || 
+#endif
+        analysis == "MOOCHO" || analysis == "ROL")
       *out << "ERROR: Trilinos/Piro was not configured to include \n "
            << "       analysis type: " << analysis << endl;
     else
       *out << "ERROR: Piro: Unknown analysis type: " << analysis << "\n"
-           << "       Valid analysis types are: Solve, Dakota, MOOCHO, OptiPack, ROL\n" << endl;
+           << "       Valid analysis types are: Solve, Dakota, MOOCHO, "
+#ifndef OPTIPACK_HIDE_DEPRECATED_CODE
+           << "OptiPack, "
+#endif
+           << "ROL\n" << endl;
     status = 0; // Should not fail tests
   }
 
@@ -249,7 +262,9 @@ Piro::PerformDakotaAnalysis(
 #endif
 }
 
+#ifndef OPTIPACK_HIDE_DEPRECATED_CODE
 int
+OPTIPACK_DEPRECATED
 Piro::PerformOptiPackAnalysis(
     Thyra::ModelEvaluatorDefaultBase<double>& piroModel,
     Teuchos::ParameterList& optipackParams,
@@ -304,6 +319,7 @@ Piro::PerformOptiPackAnalysis(
  return 0;  // should not fail tests
 #endif
 }
+#endif  // OPTIPACK_HIDE_DEPRECATED_CODE
 
 int
 Piro::PerformROLAnalysis(
@@ -498,8 +514,10 @@ Piro::getValidPiroAnalysisParameters()
   validPL->set<bool>("Output Final Parameters", false, "");
   validPL->sublist("Solve",     false, "");
   validPL->sublist("MOOCHO",    false, "");
+#ifndef OPTIPACK_HIDE_DEPRECATED_CODE
   validPL->sublist("OptiPack",  false, "");
   validPL->sublist("GlobiPack", false, "");
+#endif
   validPL->sublist("Dakota",    false, "");
   validPL->sublist("ROL",       false, "");
   validPL->set<int>("Write Interval", 1, "Iterval between writes to mesh");

diff --git a/packages/piro/src/Piro_PerformAnalysis.hpp b/packages/piro/src/Piro_PerformAnalysis.hpp
@@ -49,6 +49,10 @@
 #include "Thyra_ModelEvaluatorDefaultBase.hpp"
 #include "Thyra_VectorStdOps.hpp"
 
+#ifndef OPTIPACK_HIDE_DEPRECATED_CODE
+#include "OptiPack_Config.h"
+#endif 
+
 namespace Piro {
 
   //! \name Top-level Thyra analysis driver
@@ -85,15 +89,17 @@ namespace Piro {
      Teuchos::RCP< Thyra::VectorBase<double> >& p
      );
 
+#ifndef OPTIPACK_HIDE_DEPRECATED_CODE
   //! \brief Performs analysis of a solved model using Optipack.
   //! \details Requires that the OptiPack package is available.
   //! \ingroup Piro_Thyra_analysis_driver_grp
-  int PerformOptiPackAnalysis(
+  int OPTIPACK_DEPRECATED PerformOptiPackAnalysis(
      Thyra::ModelEvaluatorDefaultBase<double>& piroModel,
      Teuchos::ParameterList& optipackParams,
      Teuchos::ParameterList& globipackParams,
      Teuchos::RCP< Thyra::VectorBase<double> >& p
      );
+#endif
 
   //! \brief Performs analysis of a solved model using ROL.
   //! \details Requires that the ROL package is available.

diff --git a/packages/piro/test/Main_AnalysisDriver.cpp b/packages/piro/test/Main_AnalysisDriver.cpp
@@ -89,7 +89,11 @@ int main(int argc, char *argv[]) {
        case 0: inputFile="input_Analysis_Dakota.xml"; break;
        case 1: inputFile="input_Analysis_ROL.xml"; break;
        case 2: inputFile="input_Analysis_ROL_AdjointSensitivities.xml"; break;
+#ifndef OPTIPACK_HIDE_DEPRECATED_CODE
        case 3: inputFile="input_Analysis_OptiPack.xml"; break;
+#else
+       case 3: continue;
+#endif
        case 4: inputFile="input_Analysis_MOOCHO.xml"; break;
        default : std::cout << "iTest logic error " << std::endl; exit(-1);
       }

diff --git a/packages/trios/CMakeLists.txt b/packages/trios/CMakeLists.txt
@@ -45,13 +45,18 @@
 # A) Define the package
 #
 
+#
+# Trios package is deprecated April 2019; to be removed May 2019
+MESSAGE(WARNING "***** WARNING:  Package Trios is deprecated in April 2019; it will be removed in May 2019 *****")
+
 TRIBITS_PACKAGE_DECL( Trios ENABLE_SHADOWING_WARNINGS )
 
 TRIBITS_ADD_DEBUG_OPTION()
 
 TRIBITS_ADD_SHOW_DEPRECATED_WARNINGS_OPTION()
 
 
+
 ###########################################################
 # B) Set up package-specific options
 #

diff --git a/packages/trios/cmake/Trios_config.h.in b/packages/trios/cmake/Trios_config.h.in
@@ -1,3 +1,10 @@
+/* Deprecation notice */
+#if !defined(TRILINOS_HIDE_DEPRECATED_HEADER_WARNINGS)
+#ifdef __GNUC__
+#  warning "The package Trios is deprecated in April 2019; it will be removed from Trilinos in May 2019."
+#endif
+#endif
+
 
 /* ************************************************
  * Network configuration