Teuchos - Trilinos Tools Package Version of the Day
Teuchos_ErrorPolling.hpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 //
00004 //                    Teuchos: Common Tools Package
00005 //                 Copyright (2004) Sandia Corporation
00006 //
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 //
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
00038 //
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 #ifndef TEUCHOS_ERRORPOLLING_H
00043 #define TEUCHOS_ERRORPOLLING_H
00044 
00050 #include "Teuchos_ConfigDefs.hpp"
00051 #include "Teuchos_Assert.hpp"
00052 
00056 
00057 namespace Teuchos
00058 {
00059   class MPIComm;
00060 
00091   class TEUCHOS_DEPRECATED TEUCHOS_LIB_DLL_EXPORT ErrorPolling
00092   {
00093   public:
00100     static void reportFailure(const MPIComm& comm);
00101     
00108     static bool pollForFailures(const MPIComm& comm);
00109     
00111     static void enable() {isActive()=true;}
00112 
00114     static void disable() {isActive()=false;}
00115 
00116   private:
00118     static bool& isActive() {static bool rtn = true; return rtn;}
00119   };
00120 
00128 #define TEUCHOS_POLL_FOR_FAILURES(comm)                                  \
00129   TEUCHOS_TEST_FOR_EXCEPTION(Teuchos::ErrorPolling::pollForFailures(comm), \
00130                      std::runtime_error,                                     \
00131                      "off-processor error detected by proc=" << (comm).getRank());
00132 }
00133 
00135 
00136 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines