Xpetra_ConfigDefs.hpp

Go to the documentation of this file.

// @HEADER
//
// ***********************************************************************
//
//             Xpetra: A linear algebra interface package
//                  Copyright 2012 Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Questions? Contact
//                    Jonathan Hu       (jhu@sandia.gov)
//                    Andrey Prokopenko (aprokop@sandia.gov)
//                    Ray Tuminaro      (rstumin@sandia.gov)
//
// ***********************************************************************
//
// @HEADER
#ifndef XPETRA_CONFIGDEFS_HPP
#define XPETRA_CONFIGDEFS_HPP

#ifndef __cplusplus
#define __cplusplus
#endif  // ifndef __cplusplus

/* this section undefines all the things autotools defines for us that we wish it didn't. */

#ifdef PACKAGE
#undef PACKAGE
#endif  // ifdef PACKAGE

#ifdef PACKAGE_NAME
#undef PACKAGE_NAME
#endif  // ifdef PACKAGE_NAME

#ifdef PACKAGE_BUGREPORT
#undef PACKAGE_BUGREPORT
#endif  // ifdef PACKAGE_BUGREPORT

#ifdef PACKAGE_STRING
#undef PACKAGE_STRING
#endif  // ifdef PACKAGE_STRING

#ifdef PACKAGE_TARNAME
#undef PACKAGE_TARNAME
#endif  // ifdef PACKAGE_TARNAME

#ifdef PACKAGE_VERSION
#undef PACKAGE_VERSION
#endif  // ifdef PACKAGE_VERSION

#ifdef VERSION
#undef VERSION
#endif  // ifdef VERSION

// end of undoing autoconf's work section

#include <Xpetra_config.hpp>
#include <Teuchos_ConfigDefs.hpp>
#include <TpetraCore_config.h>

#if defined(HAVE_XPETRA_TPETRA)
#include <Tpetra_ConfigDefs.hpp>
#endif

namespace Xpetra {
// Used in all Xpetra code that explicitly must a type (like a loop index)
// that is used with the Teuchos::Array[View,RCP] classes.

typedef Teuchos_Ordinal Array_size_type;
}  // namespace Xpetra

// these make some of the macros in Xpetra_Util.hpp much easier to describe
#ifdef HAVE_XPETRA_THROW_EFFICIENCY_WARNINGS
#define XPETRA_THROWS_EFFICIENCY_WARNINGS 1
#else
#define XPETRA_THROWS_EFFICIENCY_WARNINGS 0
#endif

#ifdef HAVE_XPETRA_PRINT_EFFICIENCY_WARNINGS
#define XPETRA_PRINTS_EFFICIENCY_WARNINGS 1
#else
#define XPETRA_PRINTS_EFFICIENCY_WARNINGS 0
#endif

#ifdef HAVE_XPETRA_THROW_ABUSE_WARNINGS
#define XPETRA_THROWS_ABUSE_WARNINGS 1
#else
#define XPETRA_THROWS_ABUSE_WARNINGS 0
#endif

#ifdef HAVE_XPETRA_PRINT_ABUSE_WARNINGS
#define XPETRA_PRINTS_ABUSE_WARNINGS 1
#else
#define XPETRA_PRINTS_ABUSE_WARNINGS 0
#endif

#ifdef HAVE_XPETRA_PROFILING
#include <string>
#include <Teuchos_TimeMonitor.hpp>
#define XPETRA_MONITOR(funcName) Teuchos::TimeMonitor(*Teuchos::TimeMonitor::getNewTimer(std::string("Xpetra: ") + funcName));
#else
#define XPETRA_MONITOR(funcName)
#endif

// Special macro for exception testing
// XPETRA_TEST_FOR_EXCEPTION is only active if Xpetra is configured with Xpetra_ENABLE_DEBUG:BOOL=ON
// If you want an exception test both in the release and debug version of Xpetra you still can use directly
// TEUCHOS_TEST_FOR_EXCEPTION
#ifdef HAVE_XPETRA_DEBUG
#define XPETRA_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg) \
  TEUCHOS_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg);
#else
#define XPETRA_TEST_FOR_EXCEPTION(throw_exception_test, Exception, msg)
#endif

#include <functional>

// mem management
#include <Teuchos_ArrayView.hpp>
#include <Teuchos_ArrayRCP.hpp>
#include <Teuchos_Array.hpp>
#include <Teuchos_RCP.hpp>
// traits classes
#include <Teuchos_OrdinalTraits.hpp>
#include <Teuchos_ScalarTraits.hpp>
#include <Teuchos_TypeNameTraits.hpp>
#include <Teuchos_NullIteratorTraits.hpp>
#include <Teuchos_SerializationTraits.hpp>
// comm
#include <Teuchos_Comm.hpp>
#include <Teuchos_CommHelpers.hpp>
// misc
#include <Teuchos_ParameterList.hpp>

namespace Xpetra {
typedef size_t global_size_t;

enum LocalGlobal {
  LocallyReplicated,  
  GloballyDistributed 
};

enum LookupStatus {
  AllIDsPresent, 
  IDNotPresent   
};

enum OptimizeOption {
  DoOptimizeStorage,   
  DoNotOptimizeStorage 
};

//   enum CombineMode {
//     ADD,    /*!< Existing values will be summed with new values. */
//     INSERT, /*!< Insert new values that don't currently exist. */
//     REPLACE, /*!< Existing values will be replaced with new values. */
//   };

enum CombineMode {
  ADD,    
  INSERT, 
  ABSMAX  
};

// import Teuchos memory management classes into Xpetra
using Teuchos::Array;
using Teuchos::ArrayRCP;
using Teuchos::ArrayView;
using Teuchos::Comm;
using Teuchos::null;
using Teuchos::OrdinalTraits;
using Teuchos::RCP;
using Teuchos::ScalarTraits;

using Teuchos::arcp;
using Teuchos::arcp_reinterpret_cast;
using Teuchos::av_reinterpret_cast;
using Teuchos::outArg;
using Teuchos::rcp;
using Teuchos::rcpFromRef;
using Teuchos::tuple;

using Teuchos::typeName;

using Teuchos::ParameterList;
using Teuchos::parameterList;
using Teuchos::sublist;

// Xpetra functor objects
// inspired by SGI-specific project2nd, project1st
template <class Arg1, class Arg2>
class firstArg {
 public:
  typedef Arg1 first_argument_type;
  typedef Arg2 second_argument_type;
  typedef Arg1 result_type;
  inline Arg1 operator()(const Arg1 &arg1, const Arg2 &arg2) { return arg1; }
};

template <class Arg1, class Arg2>
class secondArg {
 public:
  typedef Arg1 first_argument_type;
  typedef Arg2 second_argument_type;
  typedef Arg2 result_type;
  inline Arg2 operator()(const Arg1 &arg1, const Arg2 &arg2) { return arg2; }
};

}  // namespace Xpetra

namespace XpetraExamples {
}

#define XPETRA_ERR_CHECK(arg)                \
  {                                          \
    int r = arg;                             \
    if (r < 0) {                             \
      std::cout << "r = " << r << std::endl; \
      assert(r >= 0);                        \
    };                                       \
  };  // TODO: throw exceptions

// This include file defines macros to avoid warnings under CUDA.  See github issue #1133.
#include "Teuchos_CompilerCodeTweakMacros.hpp"

#endif  // XPETRA_CONFIGDEFS_HPP