Reference documentation for deal.II version Git d51799cb54 2020-09-28 09:22:08 +0200
\(\newcommand{\dealvcentcolon}{\mathrel{\mathop{:}}}\) \(\newcommand{\dealcoloneq}{\dealvcentcolon\mathrel{\mkern-1.2mu}=}\) \(\newcommand{\jump}[1]{\left[\!\left[ #1 \right]\!\right]}\) \(\newcommand{\average}[1]{\left\{\!\left\{ #1 \right\}\!\right\}}\)
exceptions.h
Go to the documentation of this file.
1 // ---------------------------------------------------------------------
2 //
3 // Copyright (C) 1998 - 2020 by the deal.II authors
4 //
5 // This file is part of the deal.II library.
6 //
7 // The deal.II library is free software; you can use it, redistribute
8 // it, and/or modify it under the terms of the GNU Lesser General
9 // Public License as published by the Free Software Foundation; either
10 // version 2.1 of the License, or (at your option) any later version.
11 // The full text of the license can be found in the file LICENSE.md at
12 // the top level directory of deal.II.
13 //
14 // ---------------------------------------------------------------------
15 
16 #ifndef dealii_exceptions_h
17 #define dealii_exceptions_h
18 
19 #include <deal.II/base/config.h>
20 
21 #include <exception>
22 #include <ostream>
23 #include <string>
24 #include <type_traits>
25 
26 #ifdef DEAL_II_WITH_CUDA
27 # include <cusolverSp.h>
28 # include <cusparse.h>
29 #endif
30 
31 
33 
34 
48 class ExceptionBase : public std::exception
49 {
50 public:
54  ExceptionBase();
55 
60 
64  virtual ~ExceptionBase() noexcept override;
65 
71  operator=(const ExceptionBase &) = delete;
72 
78  void
79  set_fields(const char *file,
80  const int line,
81  const char *function,
82  const char *cond,
83  const char *exc_name);
84 
85 
89  virtual const char *
90  what() const noexcept override;
91 
95  const char *
96  get_exc_name() const;
97 
101  void
102  print_exc_data(std::ostream &out) const;
103 
108  virtual void
109  print_info(std::ostream &out) const;
110 
115  void
116  print_stack_trace(std::ostream &out) const;
117 
118 protected:
122  const char *file;
123 
127  unsigned int line;
128 
132  const char *function;
133 
137  const char *cond;
138 
142  const char *exc;
143 
148  mutable char **stacktrace;
149 
155 
156 #ifdef DEAL_II_HAVE_GLIBC_STACKTRACE
157 
160  void *raw_stacktrace[25];
161 #endif
162 
163 private:
167  void
168  generate_message() const;
169 
174  mutable std::string what_str;
175 };
176 
177 #ifndef DOXYGEN
178 
195 # define DeclException0(Exception0) \
196  class Exception0 : public ::ExceptionBase \
197  {}
198 
199 
219 # define DeclExceptionMsg(Exception, defaulttext) \
220  class Exception : public ::ExceptionBase \
221  { \
222  public: \
223  Exception(const std::string &msg = defaulttext) \
224  : arg(msg) \
225  {} \
226  virtual ~Exception() noexcept \
227  {} \
228  virtual void \
229  print_info(std::ostream &out) const override \
230  { \
231  out << " " << arg << std::endl; \
232  } \
233  \
234  private: \
235  const std::string arg; \
236  }
237 
255 # define DeclException1(Exception1, type1, outsequence) \
256  class Exception1 : public ::ExceptionBase \
257  { \
258  public: \
259  Exception1(type1 const &a1) \
260  : arg1(a1) \
261  {} \
262  virtual ~Exception1() noexcept \
263  {} \
264  virtual void \
265  print_info(std::ostream &out) const override \
266  { \
267  out << " " outsequence << std::endl; \
268  } \
269  \
270  private: \
271  type1 const arg1; \
272  }
273 
274 
292 # define DeclException2(Exception2, type1, type2, outsequence) \
293  class Exception2 : public ::ExceptionBase \
294  { \
295  public: \
296  Exception2(type1 const &a1, type2 const &a2) \
297  : arg1(a1) \
298  , arg2(a2) \
299  {} \
300  virtual ~Exception2() noexcept \
301  {} \
302  virtual void \
303  print_info(std::ostream &out) const override \
304  { \
305  out << " " outsequence << std::endl; \
306  } \
307  \
308  private: \
309  type1 const arg1; \
310  type2 const arg2; \
311  }
312 
313 
331 # define DeclException3(Exception3, type1, type2, type3, outsequence) \
332  class Exception3 : public ::ExceptionBase \
333  { \
334  public: \
335  Exception3(type1 const &a1, type2 const &a2, type3 const &a3) \
336  : arg1(a1) \
337  , arg2(a2) \
338  , arg3(a3) \
339  {} \
340  virtual ~Exception3() noexcept \
341  {} \
342  virtual void \
343  print_info(std::ostream &out) const override \
344  { \
345  out << " " outsequence << std::endl; \
346  } \
347  \
348  private: \
349  type1 const arg1; \
350  type2 const arg2; \
351  type3 const arg3; \
352  }
353 
354 
372 # define DeclException4(Exception4, type1, type2, type3, type4, outsequence) \
373  class Exception4 : public ::ExceptionBase \
374  { \
375  public: \
376  Exception4(type1 const &a1, \
377  type2 const &a2, \
378  type3 const &a3, \
379  type4 const &a4) \
380  : arg1(a1) \
381  , arg2(a2) \
382  , arg3(a3) \
383  , arg4(a4) \
384  {} \
385  virtual ~Exception4() noexcept \
386  {} \
387  virtual void \
388  print_info(std::ostream &out) const override \
389  { \
390  out << " " outsequence << std::endl; \
391  } \
392  \
393  private: \
394  type1 const arg1; \
395  type2 const arg2; \
396  type3 const arg3; \
397  type4 const arg4; \
398  }
399 
400 
418 # define DeclException5( \
419  Exception5, type1, type2, type3, type4, type5, outsequence) \
420  class Exception5 : public ::ExceptionBase \
421  { \
422  public: \
423  Exception5(type1 const &a1, \
424  type2 const &a2, \
425  type3 const &a3, \
426  type4 const &a4, \
427  type5 const &a5) \
428  : arg1(a1) \
429  , arg2(a2) \
430  , arg3(a3) \
431  , arg4(a4) \
432  , arg5(a5) \
433  {} \
434  virtual ~Exception5() noexcept \
435  {} \
436  virtual void \
437  print_info(std::ostream &out) const override \
438  { \
439  out << " " outsequence << std::endl; \
440  } \
441  \
442  private: \
443  type1 const arg1; \
444  type2 const arg2; \
445  type3 const arg3; \
446  type4 const arg4; \
447  type5 const arg5; \
448  }
449 
450 #else /*ifndef DOXYGEN*/
451 
452 // Dummy definitions for doxygen:
453 
470 # define DeclException0(Exception0) \
471  \
472  static ::ExceptionBase &Exception0()
473 
493 # define DeclExceptionMsg(Exception, defaulttext) \
494  \
495  \
496  static ::ExceptionBase &Exception()
497 
515 # define DeclException1(Exception1, type1, outsequence) \
516  \
517  \
518  static ::ExceptionBase &Exception1(type1 arg1)
519 
520 
538 # define DeclException2(Exception2, type1, type2, outsequence) \
539  \
540  \
541  static ::ExceptionBase &Exception2(type1 arg1, type2 arg2)
542 
543 
561 # define DeclException3(Exception3, type1, type2, type3, outsequence) \
562  \
563  \
564  static ::ExceptionBase &Exception3(type1 arg1, type2 arg2, type3 arg3)
565 
566 
584 # define DeclException4(Exception4, type1, type2, type3, type4, outsequence) \
585  \
586  \
587  static ::ExceptionBase &Exception4(type1 arg1, \
588  type2 arg2, \
589  type3 arg3, \
590  type4 arg4)
591 
592 
610 # define DeclException5( \
611  Exception5, type1, type2, type3, type4, type5, outsequence) \
612  \
613  \
614  static ::ExceptionBase &Exception5( \
615  type1 arg1, type2 arg2, type3 arg3, type4 arg4, type5 arg5)
616 
617 #endif /*ifndef DOXYGEN*/
618 
619 
632 {
637 
642  "A piece of code is attempting a division by zero. This is "
643  "likely going to lead to results that make no sense.");
644 
657  std::complex<double>,
658  << "In a significant number of places, deal.II checks that some intermediate "
659  << "value is a finite number (as opposed to plus or minus infinity, or "
660  << "NaN/Not a Number). In the current function, we encountered a number "
661  << "that is not finite (its value is " << arg1 << " and therefore "
662  << "violates the current assertion).\n\n"
663  << "This may be due to the fact that some operation in this function "
664  << "created such a value, or because one of the arguments you passed "
665  << "to the function already had this value from some previous "
666  << "operation. In the latter case, this function only triggered the "
667  << "error but may not actually be responsible for the computation of "
668  << "the number that is not finite.\n\n"
669  << "There are two common cases where this situation happens. First, your "
670  << "code (or something in deal.II) divides by zero in a place where this "
671  << "should not happen. Or, you are trying to solve a linear system "
672  << "with an unsuitable solver (such as an indefinite or non-symmetric "
673  << "linear system using a Conjugate Gradient solver); such attempts "
674  << "oftentimes yield an operation somewhere that tries to divide "
675  << "by zero or take the square root of a negative value.\n\n"
676  << "In any case, when trying to find the source of the error, "
677  << "recall that the location where you are getting this error is "
678  << "simply the first place in the program where there is a check "
679  << "that a number (e.g., an element of a solution vector) is in fact "
680  << "finite, but that the actual error that computed the number "
681  << "may have happened far earlier. To find this location, you "
682  << "may want to add checks for finiteness in places of your "
683  << "program visited before the place where this error is produced. "
684  << "One way to check for finiteness is to use the 'AssertIsFinite' "
685  << "macro.");
686 
691  std::size_t,
692  "Your program tried to allocate some memory but this "
693  "allocation failed. Typically, this either means that "
694  "you simply do not have enough memory in your system, "
695  "or that you are (erroneously) trying to allocate "
696  "a chunk of memory that is simply beyond all reasonable "
697  "size, for example because the size of the object has "
698  "been computed incorrectly."
699  "\n\n"
700  "In the current case, the request was for "
701  << arg1 << " bytes.");
702 
708  int,
709  << "Destroying memory handler while " << arg1
710  << " objects are still allocated.");
711 
716  "An input/output error has occurred. There are a number of "
717  "reasons why this may be happening, both for reading and "
718  "writing operations."
719  "\n\n"
720  "If this happens during an operation that tries to read "
721  "data: First, you may be "
722  "trying to read from a file that doesn't exist or that is "
723  "not readable given its file permissions. Second, deal.II "
724  "uses this error at times if it tries to "
725  "read information from a file but where the information "
726  "in the file does not correspond to the expected format. "
727  "An example would be a truncated file, or a mesh file "
728  "that contains not only sections that describe the "
729  "vertices and cells, but also sections for additional "
730  "data that deal.II does not understand."
731  "\n\n"
732  "If this happens during an operation that tries to write "
733  "data: you may be trying to write to a file to which file "
734  "or directory permissions do not allow you to write. A "
735  "typical example is where you specify an output file in "
736  "a directory that does not exist.");
737 
745  std::string,
746  << "Could not open file " << arg1 << ".");
747 
757  "You are trying to use functionality in deal.II that is "
758  "currently not implemented. In many cases, this indicates "
759  "that there simply didn't appear much of a need for it, or "
760  "that the author of the original code did not have the "
761  "time to implement a particular case. If you hit this "
762  "exception, it is therefore worth the time to look into "
763  "the code to find out whether you may be able to "
764  "implement the missing functionality. If you do, please "
765  "consider providing a patch to the deal.II development "
766  "sources (see the deal.II website on how to contribute).");
767 
789  "This exception -- which is used in many places in the "
790  "library -- usually indicates that some condition which "
791  "the author of the code thought must be satisfied at a "
792  "certain point in an algorithm, is not fulfilled. An "
793  "example would be that the first part of an algorithm "
794  "sorts elements of an array in ascending order, and "
795  "a second part of the algorithm later encounters an "
796  "element that is not larger than the previous one."
797  "\n\n"
798  "There is usually not very much you can do if you "
799  "encounter such an exception since it indicates an error "
800  "in deal.II, not in your own program. Try to come up with "
801  "the smallest possible program that still demonstrates "
802  "the error and contact the deal.II mailing lists with it "
803  "to obtain help.");
804 
813  "You (or a place in the library) are trying to call a "
814  "function that is declared as a virtual function in a "
815  "base class but that has not been overridden in your "
816  "derived class."
817  "\n\n"
818  "This exception happens in cases where the base class "
819  "cannot provide a useful default implementation for "
820  "the virtual function, but where we also do not want "
821  "to mark the function as abstract (i.e., with '=0' at the end) "
822  "because the function is not essential to the class in many "
823  "contexts. In cases like this, the base class provides "
824  "a dummy implementation that makes the compiler happy, but "
825  "that then throws the current exception."
826  "\n\n"
827  "A concrete example would be the 'Function' class. It declares "
828  "the existence of 'value()' and 'gradient()' member functions, "
829  "and both are marked as 'virtual'. Derived classes have to "
830  "override these functions for the values and gradients of a "
831  "particular function. On the other hand, not every function "
832  "has a gradient, and even for those that do, not every program "
833  "actually needs to evaluate it. Consequently, there is no "
834  "*requirement* that a derived class actually override the "
835  "'gradient()' function (as there would be had it been marked "
836  "as abstract). But, since the base class cannot know how to "
837  "compute the gradient, if a derived class does not override "
838  "the 'gradient()' function and it is called anyway, then the "
839  "default implementation in the base class will simply throw "
840  "an exception."
841  "\n\n"
842  "The exception you see is what happens in cases such as the "
843  "one just illustrated. To fix the problem, you need to "
844  "investigate whether the function being called should indeed have "
845  "been called; if the answer is 'yes', then you need to "
846  "implement the missing override in your class.");
847 
852 
857 
865  int,
866  << "You are trying to execute functionality that is "
867  << "impossible in " << arg1
868  << "d or simply does not make any sense.");
869 
878  int,
879  int,
880  << "You are trying to execute functionality that is "
881  << "impossible in dimensions <" << arg1 << "," << arg2
882  << "> or simply does not make any sense.");
883 
884 
889  "In a check in the code, deal.II encountered a zero in "
890  "a place where this does not make sense. See the condition "
891  "that was being checked and that is printed further up "
892  "in the error message to get more information on what "
893  "the erroneous zero corresponds to.");
894 
900  "The object you are trying to access is empty but it makes "
901  "no sense to attempt the operation you are trying on an "
902  "empty object.");
903 
912  std::size_t,
913  std::size_t,
914  << "Dimension " << arg1 << " not equal to " << arg2 << ".");
915 
921  int,
922  int,
923  int,
924  << "Dimension " << arg1 << " neither equal to " << arg2
925  << " nor to " << arg3 << ".");
926 
941  int,
942  int,
943  int,
944  << "Index " << arg1 << " is not in the half-open range [" << arg2 << ","
945  << arg3 << ")."
946  << (arg2 == arg3 ?
947  " In the current case, this half-open range is in fact empty, "
948  "suggesting that you are accessing an element of an empty "
949  "collection such as a vector that has not been set to the "
950  "correct size." :
951  ""));
952 
968  template <typename T>
971  T,
972  T,
973  T,
974  << "Index " << arg1 << " is not in the half-open range [" << arg2 << ","
975  << arg3 << ")."
976  << (arg2 == arg3 ?
977  " In the current case, this half-open range is in fact empty, "
978  "suggesting that you are accessing an element of an empty "
979  "collection such as a vector that has not been set to the "
980  "correct size." :
981  ""));
982 
987  int,
988  int,
989  << "Number " << arg1 << " must be larger than or equal "
990  << arg2 << ".");
991 
995  template <typename T>
997  T,
998  T,
999  << "Number " << arg1 << " must be larger than or equal "
1000  << arg2 << ".");
1001 
1007  int,
1008  int,
1009  << "Division " << arg1 << " by " << arg2
1010  << " has remainder different from zero.");
1011 
1021  "You are trying to use an iterator, but the iterator is "
1022  "in an invalid state. This may indicate that the iterator "
1023  "object has not been initialized, or that it has been "
1024  "moved beyond the end of the range of valid elements.");
1025 
1031  "You are trying to use an iterator, but the iterator is "
1032  "pointing past the end of the range of valid elements. "
1033  "It is not valid to dereference the iterator in this "
1034  "case.");
1035 
1049  DeclException1(ExcMessage, std::string, << arg1);
1050 
1055  "You are trying an operation on a vector that is only "
1056  "allowed if the vector has no ghost elements, but the "
1057  "vector you are operating on does have ghost elements. "
1058  "Specifically, vectors with ghost elements are read-only "
1059  "and cannot appear in operations that write into these "
1060  "vectors."
1061  "\n\n"
1062  "See the glossary entry on 'Ghosted vectors' for more "
1063  "information.");
1064 
1073  "You are trying an operation of the form 'vector=s' with "
1074  "a nonzero scalar value 's'. However, such assignments "
1075  "are only allowed if the right hand side is zero.");
1076 
1082  "You are attempting to use functionality that is only available "
1083  "if deal.II was configured to use LAPACK, but cmake did not "
1084  "find a valid LAPACK library.");
1085 
1090  ExcNeedsMPI,
1091  "You are attempting to use functionality that is only available "
1092  "if deal.II was configured to use MPI.");
1093 
1099  "You are attempting to use functionality that is only available "
1100  "if deal.II was configured with DEAL_II_WITH_SIMPLEX_SUPPORT enabled.");
1101 
1107  "You are attempting to use functionality that is only available "
1108  "if deal.II was configured to use the function parser which "
1109  "relies on the muparser library, but cmake did not "
1110  "find a valid muparser library on your system and also did "
1111  "not choose the one that comes bundled with deal.II.");
1112 
1118  "You are attempting to use functionality that is only available "
1119  "if deal.II was configured to use Assimp, but cmake did not "
1120  "find a valid Assimp library.");
1121 
1122 #ifdef DEAL_II_WITH_CUDA
1123 
1129  DeclException1(ExcCudaError, const char *, << arg1);
1134  std::string,
1135  << "There was an error in a cuSPARSE function: " << arg1);
1136 #endif
1137 
1138 
1139 #ifdef DEAL_II_WITH_MPI
1140 
1161  class ExcMPI : public ::ExceptionBase
1162  {
1163  public:
1164  ExcMPI(const int error_code);
1165 
1166  virtual void
1167  print_info(std::ostream &out) const override;
1168 
1169  const int error_code;
1170  };
1171 #endif // DEAL_II_WITH_MPI
1172 } /*namespace StandardExceptions*/
1173 
1174 
1175 
1183 {
1184  namespace internals
1185  {
1193  extern bool allow_abort_on_exception;
1194  } // namespace internals
1195 
1214  void
1215  set_additional_assert_output(const char *const p);
1216 
1227  void
1229 
1243  void
1245 
1253  namespace internals
1254  {
1259  [[noreturn]] void
1260  abort(const ExceptionBase &exc) noexcept;
1261 
1266  {
1277  };
1278 
1296  template <class ExceptionType>
1297  [[noreturn]] void
1299  const char * file,
1300  int line,
1301  const char * function,
1302  const char * cond,
1303  const char * exc_name,
1304  ExceptionType e) {
1305  // Fill the fields of the exception object
1306  e.set_fields(file, line, function, cond, exc_name);
1307 
1308  switch (handling)
1309  {
1311  {
1314  internals::abort(e);
1315  else
1316  {
1317  // We are not allowed to abort, so just throw the error:
1318  throw e;
1319  }
1320  }
1321  case throw_on_exception:
1322  throw e;
1323  // this function should never return (and AssertNothrow can);
1324  // something must have gone wrong in the error handling code for us
1325  // to get this far, so throw an exception.
1326  default:
1328  }
1329  }
1330 
1334  void do_issue_error_nothrow(const ExceptionBase &e) noexcept;
1335 
1344  template <class ExceptionType>
1345  void
1347  int line,
1348  const char * function,
1349  const char * cond,
1350  const char * exc_name,
1351  ExceptionType e) noexcept
1352  {
1353  static_assert(std::is_base_of<ExceptionBase, ExceptionType>::value,
1354  "The provided exception must inherit from ExceptionBase.");
1355  // Fill the fields of the exception object
1356  e.set_fields(file, line, function, cond, exc_name);
1357  // avoid moving a bunch of code into the header by dispatching to
1358  // another function:
1360  }
1361 #ifdef DEAL_II_WITH_CUDA
1362 
1367  std::string
1368  get_cusparse_error_string(const cusparseStatus_t error_code);
1369 
1375  std::string
1376  get_cusolver_error_string(const cusolverStatus_t error_code);
1377 #endif
1378  } /*namespace internals*/
1379 
1380 } /*namespace deal_II_exceptions*/
1381 
1382 
1383 
1409 #ifdef DEBUG
1410 # ifdef DEAL_II_HAVE_BUILTIN_EXPECT
1411 # define Assert(cond, exc) \
1412  { \
1413  if (__builtin_expect(!(cond), false)) \
1414  ::deal_II_exceptions::internals::issue_error_noreturn( \
1415  ::deal_II_exceptions::internals:: \
1416  abort_or_throw_on_exception, \
1417  __FILE__, \
1418  __LINE__, \
1419  __PRETTY_FUNCTION__, \
1420  #cond, \
1421  #exc, \
1422  exc); \
1423  }
1424 # else /*ifdef DEAL_II_HAVE_BUILTIN_EXPECT*/
1425 # define Assert(cond, exc) \
1426  { \
1427  if (!(cond)) \
1428  ::deal_II_exceptions::internals::issue_error_noreturn( \
1429  ::deal_II_exceptions::internals:: \
1430  abort_or_throw_on_exception, \
1431  __FILE__, \
1432  __LINE__, \
1433  __PRETTY_FUNCTION__, \
1434  #cond, \
1435  #exc, \
1436  exc); \
1437  }
1438 # endif /*ifdef DEAL_II_HAVE_BUILTIN_EXPECT*/
1439 #else
1440 # define Assert(cond, exc) \
1441  {}
1442 #endif
1443 
1444 
1445 
1472 #ifdef DEBUG
1473 # ifdef DEAL_II_HAVE_BUILTIN_EXPECT
1474 # define AssertNothrow(cond, exc) \
1475  { \
1476  if (__builtin_expect(!(cond), false)) \
1477  ::deal_II_exceptions::internals::issue_error_nothrow( \
1478  __FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, #exc, exc); \
1479  }
1480 # else /*ifdef DEAL_II_HAVE_BUILTIN_EXPECT*/
1481 # define AssertNothrow(cond, exc) \
1482  { \
1483  if (!(cond)) \
1484  ::deal_II_exceptions::internals::issue_error_nothrow( \
1485  __FILE__, __LINE__, __PRETTY_FUNCTION__, #cond, #exc, exc); \
1486  }
1487 # endif /*ifdef DEAL_II_HAVE_BUILTIN_EXPECT*/
1488 #else
1489 # define AssertNothrow(cond, exc) \
1490  {}
1491 #endif
1492 
1520 #ifdef DEAL_II_HAVE_BUILTIN_EXPECT
1521 # define AssertThrow(cond, exc) \
1522  { \
1523  if (__builtin_expect(!(cond), false)) \
1524  ::deal_II_exceptions::internals::issue_error_noreturn( \
1525  ::deal_II_exceptions::internals::throw_on_exception, \
1526  __FILE__, \
1527  __LINE__, \
1528  __PRETTY_FUNCTION__, \
1529  #cond, \
1530  #exc, \
1531  exc); \
1532  }
1533 #else /*ifdef DEAL_II_HAVE_BUILTIN_EXPECT*/
1534 # define AssertThrow(cond, exc) \
1535  { \
1536  if (!(cond)) \
1537  ::deal_II_exceptions::internals::issue_error_noreturn( \
1538  ::deal_II_exceptions::internals::throw_on_exception, \
1539  __FILE__, \
1540  __LINE__, \
1541  __PRETTY_FUNCTION__, \
1542  #cond, \
1543  #exc, \
1544  exc); \
1545  }
1546 #endif /*ifdef DEAL_II_HAVE_BUILTIN_EXPECT*/
1547 
1568 #define AssertDimension(dim1, dim2) \
1569  Assert(static_cast<typename ::internal::argument_type<void( \
1570  typename std::common_type<decltype(dim1), \
1571  decltype(dim2)>::type)>::type>(dim1) == \
1572  static_cast<typename ::internal::argument_type<void( \
1573  typename std::common_type<decltype(dim1), \
1574  decltype(dim2)>::type)>::type>(dim2), \
1575  ::ExcDimensionMismatch((dim1), (dim2)))
1576 
1577 
1595 #define AssertVectorVectorDimension(VEC, DIM1, DIM2) \
1596  AssertDimension(VEC.size(), DIM1); \
1597  for (const auto &subvector : VEC) \
1598  { \
1599  (void)subvector; \
1600  AssertDimension(subvector.size(), DIM2); \
1601  }
1602 
1603 namespace internal
1604 {
1605  // Workaround to allow for commas in template parameter lists
1606  // in preprocessor macros as found in
1607  // https://stackoverflow.com/questions/13842468/comma-in-c-c-macro
1608  template <typename T>
1610  template <typename T, typename U>
1611  struct argument_type<T(U)>
1612  {
1613  using type = U;
1614  };
1615 } // namespace internal
1616 
1636 #define AssertIndexRange(index, range) \
1637  Assert( \
1638  static_cast<typename ::internal::argument_type<void( \
1639  typename std::common_type<decltype(index), decltype(range)>::type)>:: \
1640  type>(index) < \
1641  static_cast<typename ::internal::argument_type<void( \
1642  typename std::common_type<decltype(index), decltype(range)>::type)>:: \
1643  type>(range), \
1644  ExcIndexRangeType<typename ::internal::argument_type<void( \
1645  typename std::common_type<decltype(index), decltype(range)>::type)>:: \
1646  type>((index), 0, (range)))
1647 
1667 #define AssertIsFinite(number) \
1668  Assert(::numbers::is_finite(number), \
1669  ::ExcNumberNotFinite(std::complex<double>(number)))
1670 
1671 #ifdef DEAL_II_WITH_MPI
1672 
1692 # define AssertThrowMPI(error_code) \
1693  AssertThrow(error_code == MPI_SUCCESS, ::ExcMPI(error_code))
1694 #else
1695 # define AssertThrowMPI(error_code) \
1696  {}
1697 #endif // DEAL_II_WITH_MPI
1698 
1699 #ifdef DEAL_II_WITH_CUDA
1700 
1717 # ifdef DEBUG
1718 # define AssertCuda(error_code) \
1719  Assert(error_code == cudaSuccess, \
1720  ::ExcCudaError(cudaGetErrorString(error_code)))
1721 # else
1722 # define AssertCuda(error_code) \
1723  { \
1724  (void)(error_code); \
1725  }
1726 # endif
1727 
1744 # ifdef DEBUG
1745 # define AssertNothrowCuda(error_code) \
1746  AssertNothrow(error_code == cudaSuccess, \
1747  ::ExcCudaError(cudaGetErrorString(error_code)))
1748 # else
1749 # define AssertNothrowCuda(error_code) \
1750  { \
1751  (void)(error_code); \
1752  }
1753 # endif
1754 
1772 # ifdef DEBUG
1773 # define AssertCudaKernel() \
1774  { \
1775  cudaError_t local_error_code = cudaPeekAtLastError(); \
1776  AssertCuda(local_error_code); \
1777  local_error_code = cudaDeviceSynchronize(); \
1778  AssertCuda(local_error_code) \
1779  }
1780 # else
1781 # define AssertCudaKernel() \
1782  {}
1783 # endif
1784 
1802 # ifdef DEBUG
1803 # define AssertCusparse(error_code) \
1804  Assert( \
1805  error_code == CUSPARSE_STATUS_SUCCESS, \
1806  ExcCusparseError( \
1807  deal_II_exceptions::internals::get_cusparse_error_string( \
1808  error_code)))
1809 # else
1810 # define AssertCusparse(error_code) \
1811  { \
1812  (void)(error_code); \
1813  }
1814 # endif
1815 
1832 # ifdef DEBUG
1833 # define AssertNothrowCusparse(error_code) \
1834  AssertNothrow( \
1835  error_code == CUSPARSE_STATUS_SUCCESS, \
1836  ExcCusparseError( \
1837  deal_II_exceptions::internals::get_cusparse_error_string( \
1838  error_code)))
1839 # else
1840 # define AssertNothrowCusparse(error_code) \
1841  { \
1842  (void)(error_code); \
1843  }
1844 # endif
1845 
1863 # ifdef DEBUG
1864 # define AssertCusolver(error_code) \
1865  Assert( \
1866  error_code == CUSOLVER_STATUS_SUCCESS, \
1867  ExcCusparseError( \
1868  deal_II_exceptions::internals::get_cusolver_error_string( \
1869  error_code)))
1870 # else
1871 # define AssertCusolver(error_code) \
1872  { \
1873  (void)(error_code); \
1874  }
1875 # endif
1876 
1877 #endif
1878 
1879 using namespace StandardExceptions;
1880 
1882 
1883 #endif
static ::ExceptionBase & ExcCudaError(const char *arg1)
static ::ExceptionBase & ExcPureFunctionCalled()
static ::ExceptionBase & ExcNeedsFunctionparser()
static ::ExceptionBase & ExcNeedsMPI()
#define DeclException2(Exception2, type1, type2, outsequence)
Definition: exceptions.h:538
static ::ExceptionBase & ExcImpossibleInDimSpacedim(int arg1, int arg2)
void suppress_stacktrace_in_exceptions()
Definition: exceptions.cc:65
static ::ExceptionBase & ExcIO()
SymmetricTensor< 2, dim, Number > e(const Tensor< 2, dim, Number > &F)
static ::ExceptionBase & ExcScalarAssignmentOnlyForZeroValue()
static ::ExceptionBase & ExcDimensionMismatch2(int arg1, int arg2, int arg3)
virtual ~ExceptionBase() noexcept override
Definition: exceptions.cc:115
std::string get_cusolver_error_string(const cusolverStatus_t error_code)
Definition: exceptions.cc:517
static const char U
void set_additional_assert_output(const char *const p)
static ::ExceptionBase & ExcNotInitialized()
static ::ExceptionBase & ExcIndexRange(int arg1, int arg2, int arg3)
static ::ExceptionBase & ExcDivideByZero()
void * raw_stacktrace[25]
Definition: exceptions.h:160
virtual void print_info(std::ostream &out) const
Definition: exceptions.cc:210
static ::ExceptionBase & ExcInvalidIterator()
static ::ExceptionBase & ExcNeedsLAPACK()
static ::ExceptionBase & ExcNeedsSimplexSupport()
ExceptionBase operator=(const ExceptionBase &)=delete
static ::ExceptionBase & ExcInvalidState()
static ::ExceptionBase & ExcMessage(std::string arg1)
static ::ExceptionBase & ExcImpossibleInDim(int arg1)
virtual const char * what() const noexcept override
Definition: exceptions.cc:147
#define DeclException1(Exception1, type1, outsequence)
Definition: exceptions.h:515
static const char T
static ::ExceptionBase & ExcMemoryLeak(int arg1)
void set_fields(const char *file, const int line, const char *function, const char *cond, const char *exc_name)
Definition: exceptions.cc:124
static ::ExceptionBase & ExcDimensionMismatch(std::size_t arg1, std::size_t arg2)
void do_issue_error_nothrow(const ExceptionBase &e) noexcept
Definition: exceptions.cc:454
static ::ExceptionBase & ExcOutOfMemory(std::size_t arg1)
std::string get_cusparse_error_string(const cusparseStatus_t error_code)
Definition: exceptions.cc:471
#define DeclExceptionMsg(Exception, defaulttext)
Definition: exceptions.h:493
#define DeclException0(Exception0)
Definition: exceptions.h:470
void abort(const ExceptionBase &exc) noexcept
Definition: exceptions.cc:408
#define DEAL_II_NAMESPACE_CLOSE
Definition: config.h:363
static ::ExceptionBase & ExcNeedsAssimp()
static ::ExceptionBase & ExcIndexRangeType(T arg1, T arg2, T arg3)
std::string what_str
Definition: exceptions.h:174
unsigned int line
Definition: exceptions.h:127
static ::ExceptionBase & ExcLowerRange(int arg1, int arg2)
void print_stack_trace(std::ostream &out) const
Definition: exceptions.cc:218
static ::ExceptionBase & ExcGhostsPresent()
static ::ExceptionBase & ExcIteratorPastEnd()
const char * exc
Definition: exceptions.h:142
const char * cond
Definition: exceptions.h:137
static ::ExceptionBase & ExcNumberNotFinite(std::complex< double > arg1)
void issue_error_noreturn(ExceptionHandling handling, const char *file, int line, const char *function, const char *cond, const char *exc_name, ExceptionType e)
Definition: exceptions.h:1298
void issue_error_nothrow(const char *file, int line, const char *function, const char *cond, const char *exc_name, ExceptionType e) noexcept
Definition: exceptions.h:1346
#define DEAL_II_NAMESPACE_OPEN
Definition: config.h:362
const char * file
Definition: exceptions.h:122
static ::ExceptionBase & ExcCusparseError(std::string arg1)
static ::ExceptionBase & ExcEmptyObject()
void print_exc_data(std::ostream &out) const
Definition: exceptions.cc:178
static ::ExceptionBase & ExcNotMultiple(int arg1, int arg2)
static ::ExceptionBase & ExcNotImplemented()
#define DeclException3(Exception3, type1, type2, type3, outsequence)
Definition: exceptions.h:561
void generate_message() const
Definition: exceptions.cc:307
char ** stacktrace
Definition: exceptions.h:148
void disable_abort_on_exception()
Definition: exceptions.cc:71
const char * get_exc_name() const
Definition: exceptions.cc:170
static ::ExceptionBase & ExcZero()
static ::ExceptionBase & ExcFileNotOpen(std::string arg1)
int n_stacktrace_frames
Definition: exceptions.h:154
static ::ExceptionBase & ExcLowerRangeType(T arg1, T arg2)
static ::ExceptionBase & ExcInternalError()