Xpetra Version of the Day
Loading...
Searching...
No Matches
Xpetra_Exceptions.hpp
Go to the documentation of this file.
1// @HEADER
2//
3// ***********************************************************************
4//
5// Xpetra: A linear algebra interface package
6// Copyright 2012 Sandia Corporation
7//
8// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
9// the U.S. Government retains certain rights in this software.
10//
11// Redistribution and use in source and binary forms, with or without
12// modification, are permitted provided that the following conditions are
13// met:
14//
15// 1. Redistributions of source code must retain the above copyright
16// notice, this list of conditions and the following disclaimer.
17//
18// 2. Redistributions in binary form must reproduce the above copyright
19// notice, this list of conditions and the following disclaimer in the
20// documentation and/or other materials provided with the distribution.
21//
22// 3. Neither the name of the Corporation nor the names of the
23// contributors may be used to endorse or promote products derived from
24// this software without specific prior written permission.
25//
26// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
27// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
30// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
31// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
32// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
33// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
34// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
35// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
36// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
37//
38// Questions? Contact
39// Jonathan Hu (jhu@sandia.gov)
40// Andrey Prokopenko (aprokop@sandia.gov)
41// Ray Tuminaro (rstumin@sandia.gov)
42//
43// ***********************************************************************
44//
45// @HEADER
46#ifndef XPETRA_EXCEPTIONS_HPP
47#define XPETRA_EXCEPTIONS_HPP
48
49#include <exception>
50#include <Teuchos_Exceptions.hpp>
51#include <Teuchos_Assert.hpp>
52
53#include "Xpetra_ConfigDefs.hpp"
54
55// Dynamically cast 'obj' to 'type newObj'. newObj is declared inside of the macro.
56// If the dynamic cast failed, throw an exception of type Xpetra::Exception::Bad_Cast (using the message exceptionMsg).
57#define XPETRA_COMMA ,
58#define XPETRA_DYNAMIC_CAST(type, obj, newObj, exceptionMsg) \
59 type * newObj ## _pt = dynamic_cast<type *>(&obj); \
60 TEUCHOS_TEST_FOR_EXCEPTION(newObj ## _pt == NULL, Xpetra::Exceptions::BadCast, "Cannot cast '" #obj "' to a " #type ". " #exceptionMsg); \
61 type & newObj = *newObj ## _pt;
62
63// Dynamically cast the RCP 'obj' to 'RCP<type> newObj'. newObj is declared inside of the macro.
64// If the dynamic cast failed, throw an exception of type Xpetra::Exception::Bad_Cast (using the message exceptionMsg).
65#define XPETRA_RCP_DYNAMIC_CAST(type, obj, newObj, exceptionMsg) \
66 const RCP<type > & newObj = Teuchos::rcp_dynamic_cast<type >(obj); \
67 TEUCHOS_TEST_FOR_EXCEPTION(newObj == Teuchos::null, Xpetra::Exceptions::BadCast, "Cannot cast '" #obj "' to a " #type ". " #exceptionMsg);
68
69#ifdef HAVE_XPETRA_EPETRA
70#define XPETRA_FACTORY_ERROR_IF_EPETRA(lib) \
71 if ((lib) == ::Xpetra::UseEpetra) \
72 TEUCHOS_TEST_FOR_EXCEPTION(1, ::Xpetra::Exceptions::BadCast, "Epetra can only be used with Scalar=double and LocalOrdinal=GlobalOrdinal=int on a serial node");
73#else
74#define XPETRA_FACTORY_ERROR_IF_EPETRA(lib)
75#endif
76
77#define XPETRA_FACTORY_END TEUCHOS_TEST_FOR_EXCEPTION(1, ::Xpetra::Exceptions::BadCast, "Unknown map->lib() type. Did you compile with Epetra and Tpetra support?");
78
79#define XPETRA_TPETRA_ETI_EXCEPTION(cl,obj,go,node) TEUCHOS_TEST_FOR_EXCEPTION(1, ::Xpetra::Exceptions::BadCast, "Problem in " #cl "! Cannot create new object " #obj " with GO=" #go " and NO=" #node ". Xpetra has been compiled with Tpetra enabled but GO=" #go " disabled and/or NO=" #node " disabled. Please check your Trilinos configuration.");
80
81namespace Xpetra {
82 namespace Exceptions {
83
85
87 {
88 public:
89 BadCast(const std::string& what_arg) : Teuchos::ExceptionBase(what_arg) {}
90 };
91
93
95 {
96 public:
97 NotImplemented(const std::string& what_arg) : Teuchos::ExceptionBase(what_arg) {}
98 };
99
102 {
103 public:
104 RuntimeError(const std::string& what_arg) : Teuchos::ExceptionBase(what_arg) {}
105 };
106
109 public:
110 Incompatible(const std::string& what_arg) : Teuchos::ExceptionBase(what_arg) {}
111 };
112
113
114 }
115}
116
117#endif
Exception indicating invalid cast attempted.
BadCast(const std::string &what_arg)
Exception throws to report incompatible objects (like maps).
Incompatible(const std::string &what_arg)
Exception throws when you call an unimplemented method of Xpetra.
NotImplemented(const std::string &what_arg)
Exception throws to report errors in the internal logical of the program.
RuntimeError(const std::string &what_arg)
Xpetra namespace