Tpetra parallel linear algebra  Version of the Day
Tpetra_Exceptions_decl.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Tpetra: Templated Linear Algebra Services Package
5 // Copyright (2008) Sandia Corporation
6 //
7 // Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
8 // the U.S. Government retains certain rights in this software.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ************************************************************************
40 // @HEADER
41 
42 #ifndef TPETRA_EXCEPTIONS_DECL_HPP
43 #define TPETRA_EXCEPTIONS_DECL_HPP
44 
45 #include <Tpetra_ConfigDefs.hpp>
46 #include <stdexcept>
47 
48 namespace Tpetra {
49 
67 
72 namespace Details {
73 
79 template<class GlobalOrdinal>
80 class InvalidGlobalIndex : public std::domain_error {
81 public:
86  InvalidGlobalIndex (const std::string& msg, const GlobalOrdinal globalIndex)
87  : std::domain_error (msg), glInd_ (globalIndex)
88  {}
89 
91  GlobalOrdinal offendingIndex () const { return glInd_; }
92 
93 private:
95  const GlobalOrdinal glInd_;
96 };
97 
103 template<class GlobalOrdinal>
104 class InvalidGlobalRowIndex : public InvalidGlobalIndex<GlobalOrdinal> {
105 public:
110  InvalidGlobalRowIndex (const std::string& msg, const GlobalOrdinal globalIndex)
111  : InvalidGlobalIndex<GlobalOrdinal> (msg, globalIndex)
112  {}
113 };
114 
115 } // namespace Details
116 } // namespace Tpetra
117 
118 #endif // TPETRA_EXCEPTIONS_DECL_HPP
Namespace Tpetra contains the class and methods constituting the Tpetra library.
InvalidGlobalIndex(const std::string &msg, const GlobalOrdinal globalIndex)
Constructor.
InvalidGlobalRowIndex(const std::string &msg, const GlobalOrdinal globalIndex)
Constructor.
Implementation details of Tpetra.
Exception thrown by CrsMatrix on invalid global row index.
Exception thrown by CrsMatrix on invalid global index.
GlobalOrdinal offendingIndex() const
The offending global index.