/usr/include/deal.II/base/exceptions.h is in libdeal.ii-dev 6.3.1-1.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 | //---------------------------------------------------------------------------
// $Id: exceptions.h 21045 2010-04-26 20:33:56Z bangerth $
// Version: $Name$
//
// Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009, 2010 by the deal.II authors
//
// This file is subject to QPL and may not be distributed
// without copyright and license information. Please refer
// to the file deal.II/doc/license.html for the text and
// further information on this license.
//
//---------------------------------------------------------------------------
#ifndef __deal2__exceptions_h
#define __deal2__exceptions_h
/**
* @file
* Here, the deal.II exception handling is located.
*/
#include <base/config.h>
#include <exception>
// we only need output streams, but older compilers did not provide
// them in a separate include file
#ifdef HAVE_STD_OSTREAM_HEADER
# include <ostream>
#else
# include <iostream>
#endif
DEAL_II_NAMESPACE_OPEN
/**
* This class is the base class for all exception classes. Do not use
* its methods and variables directly since the interface and
* mechanism may be subject to change. Rather create new exception
* classes using the <tt>DeclException</tt> macro family.
*
* See the @ref Exceptions module for more details on this class and
* what can be done with classes derived from it.
*
* @ingroup Exceptions
* @author Wolfgang Bangerth, 1997, extensions 1998
*/
class ExceptionBase : public std::exception
{
public:
/**
* Default constructor.
*/
ExceptionBase ();
/**
* The constructor takes the file in which the
* error happened, the line and the violated
* condition as well as the name of the
* exception class as a <tt>char*</tt> as arguments.
*/
ExceptionBase (const char* f, const int l, const char *func,
const char* c, const char *e);
/**
* Copy constructor.
*/
ExceptionBase (const ExceptionBase &exc);
/**
* Destructor. Empty, but needed
* for the sake of exception
* specification, since the base
* class has this exception
* specification and the
* automatically generated
* destructor would have a
* different one due to member
* objects.
*/
virtual ~ExceptionBase () throw();
/**
* Set the file name and line of where the
* exception appeared as well as the violated
* condition and the name of the exception as
* a char pointer.
*/
void set_fields (const char *f,
const int l,
const char *func,
const char *c,
const char *e);
/**
* Print out the general part of the error
* information.
*/
void print_exc_data (std::ostream &out) const;
/**
* Print more specific information about the
* exception which occured. Overload this
* function in your own exception classes.
*/
virtual void print_info (std::ostream &out) const;
/**
* Function derived from the base class
* which allows to pass information like
* the line and name of the file where the
* exception occured as well as user
* information.
*
* This function is mainly used
* when using exceptions
* declared by the
* <tt>DeclException*</tt>
* macros with the
* <tt>throw</tt> mechanism or
* the <tt>AssertThrow</tt>
* macro.
*/
virtual const char * what () const throw ();
/**
* Print a stacktrace, if one has
* been recorded previously, to
* the given stream.
*/
void print_stack_trace (std::ostream &out) const;
protected:
/**
* Name of the file this exception happen in.
*/
const char *file;
/**
* Line number in this file.
*/
unsigned int line;
/**
* Name of the function, pretty printed.
*/
const char *function;
/**
* The violated condition, as a string.
*/
const char *cond;
/**
* Name of the exception and call sequence.
*/
const char *exc;
/**
* A backtrace to the position
* where the problem happened, if
* the system supports this.
*/
char ** stacktrace;
/**
* The number of stacktrace
* frames that are stored in the
* previous variable. Zero if the
* system does not support stack
* traces.
*/
int n_stacktrace_frames;
};
/**
* In this namespace functions in connection with the Assert and
* AssertThrow mechanism are declared.
*
* @ingroup Exceptions
*/
namespace deal_II_exceptions
{
/**
* Set a string that is printed
* upon output of the message
* indicating a triggered
* <tt>Assert</tt> statement. This
* string, which is printed in
* addition to the usual output may
* indicate information that is
* otherwise not readily available
* unless we are using a
* debugger. For example, with
* distributed programs on cluster
* computers, the output of all
* processes is redirected to the
* same console window. In this
* case, it is convenient to set as
* additional name the name of the
* host on which the program runs,
* so that one can see in which
* instance of the program the
* exception occured.
*
* The string pointed to by the
* argument is copied, so needs not
* be stored after the call to this
* function.
*
* Previously set additional output
* is replaced by the argument
* given to this function.
*/
void set_additional_assert_output (const char * const p);
/**
* Calling this function disables
* printing a stacktrace along with
* the other output printed when an
* exception occurs. Most of the
* time, you will want to see such
* a stacktrace; suppressing it,
* however, is useful if one wants
* to compare the output of a
* program across different
* machines and systems, since the
* stacktrace shows memory
* addresses and library
* names/paths that depend on the
* exact setup of a machine.
*/
void suppress_stacktrace_in_exceptions ();
/**
* Calling this function switches off
* the use of std::abort() when an
* exception is created using the
* Assert() macro. Generally, you
* want to abort the execution of a
* program when Assert() is called,
* but it needs to be switched off
* if you want to log all exceptions
* created, or if you want to test
* if an assertion is working
* correctly. This is done for example
* in regression tests.
* Please note that some fatal
* errors will still call abort(), e.g.
* when an exception is caught
* during exception handling
*/
void disable_abort_on_exception ();
/**
* The functions in this namespace are in connection with the Assert
* and AssertThrow mechanism but are solely for internal purposes and
* are not for use outside the exception handling and throwing
* mechanism.
*
* @ingroup Exceptions
*/
namespace internals
{
/**
* This routine does the main work for the
* exception generation mechanism used in the
* <tt>Assert</tt> macro.
*
* @ref ExceptionBase
*/
void issue_error_assert (const char *file,
int line,
const char *function,
const char *cond,
const char *exc_name,
ExceptionBase &e);
/**
* This routine does the main work for the
* exception generation mechanism used in the
* <tt>AssertThrow</tt> macro.
*
* @ref ExceptionBase
*/
template <class exc>
void issue_error_throw (const char *file,
int line,
const char *function,
const char *cond,
const char *exc_name,
exc e)
{
// Fill the fields of the
// exception object
e.set_fields (file, line, function, cond, exc_name);
throw e;
}
/**
* Relay exceptions from the <tt>Assert</tt> macro to the
* <tt>__IssueError_Assert</tt> function. Used to convert the last
* argument from arbitrary type to ExceptionBase which is not
* possible inside the <tt>Assert</tt> macro due to syntactical
* difficulties in connection with the way we use the macro and the
* declaration of the exception classes.
*
* @ref ExceptionBase
*/
template <class exc>
inline
void issue_error_assert_1 (const char *file,
int line,
const char *function,
const char *cond,
const char *exc_name,
exc e)
{
issue_error_assert (file,line,function,cond,exc_name,e);
}
/**
* Abort the program. This function is used so that we need not
* include <tt>cstdlib</tt> into this file since it is included into all
* other files of the library and we would like to keep its include
* list as short as possible.
*/
void abort ();
}
}
#ifdef DEBUG ////////////////////////////////////////
/**
* This is the main routine in the exception mechanism for debug mode
* error checking. It asserts that a certain condition is fulfilled,
* otherwise issues an error and aborts the program.
*
* See the ExceptionBase class for more information.
*
* @ingroup Exceptions
* @author Wolfgang Bangerth, November 1997, extensions 1998
*/
#define Assert(cond, exc) \
{ \
if (!(cond)) \
::dealii::deal_II_exceptions::internals:: \
issue_error_assert_1 (__FILE__, \
__LINE__, \
__PRETTY_FUNCTION__, #cond, #exc, exc);\
}
#else ////////////////////////////////////////
#define Assert(cond, exc) \
{ }
#endif ////////////////////////////////////////
/**
* This is the main routine in the exception mechanism for run-time
* mode error checking. It assert that a certain condition is
* fulfilled, otherwise issues an error and aborts the program.
*
* On some systems (we only know of DEC Alpha systems running under
* OSF1 or Linux), the compiler fails to compile the <tt>AssertThrow</tt>
* macro properly, yielding an internal compiler error. We detect this
* at configure time. For these cases, the <tt>AssertThrow</tt> macro aborts
* the program if the assertion is not satisfied. This, however,
* happens in debug and optimized mode likewise. Note that in these
* cases, the meaning of a program changes. In particular, one cannot
* catch exceptions thrown by <tt>AssertThrow</tt>, but we did not find
* another way to work around this compiler bug.
*
* See the <tt>ExceptionBase</tt> class for more information.
*
* @ref ExceptionBase
* @ingroup Exceptions
* @author Wolfgang Bangerth, November 1997, extensions 1998
*/
#ifndef DISABLE_ASSERT_THROW
# ifndef HAVE_BUILTIN_EXPECT
# define AssertThrow(cond, exc) \
{ \
if (!(cond)) \
::dealii::deal_II_exceptions::internals:: \
issue_error_throw (__FILE__, \
__LINE__, \
__PRETTY_FUNCTION__, #cond, #exc, exc); \
}
# else // HAVE_BUILTIN_EXPECT
# define AssertThrow(cond, exc) \
{ \
if (__builtin_expect(!(cond), false)) \
::dealii::deal_II_exceptions::internals:: \
issue_error_throw (__FILE__, \
__LINE__, \
__PRETTY_FUNCTION__, #cond, #exc, exc); \
}
# endif
#else
# define AssertThrow(cond, exc) \
{ \
if (!(cond)) \
::dealii::deal_II_exceptions::internals::abort (); \
}
#endif
#ifndef DOXYGEN
/**
* Declare an exception class derived from ExceptionBase without parameters.
* @author Wolfgang Bangerth, November 1997
* @ingroup Exceptions
*/
#define DeclException0(Exception0) \
class Exception0 : public dealii::ExceptionBase {}
/**
* Declare an exception class derived from ExceptionBase with
* one additional parameter.
* @ingroup Exceptions
*/
#define DeclException1(Exception1, type1, outsequence) \
class Exception1 : public dealii::ExceptionBase { \
public: \
Exception1 (const type1 a1) : arg1 (a1) {} \
virtual ~Exception1 () throw () {} \
virtual void print_info (std::ostream &out) const { \
out outsequence << std::endl; \
} \
private: \
const type1 arg1; \
}
/**
* Declare an exception class derived from ExceptionBase with
* two additional parameters.
* @ingroup Exceptions
*/
#define DeclException2(Exception2, type1, type2, outsequence) \
class Exception2 : public dealii::ExceptionBase { \
public: \
Exception2 (const type1 a1, const type2 a2) : \
arg1 (a1), arg2(a2) {} \
virtual ~Exception2 () throw () {} \
virtual void print_info (std::ostream &out) const { \
out outsequence << std::endl; \
} \
private: \
const type1 arg1; \
const type2 arg2; \
}
/**
* Declare an exception class derived from ExceptionBase with
* three additional parameters.
* @ingroup Exceptions
*/
#define DeclException3(Exception3, type1, type2, type3, outsequence) \
class Exception3 : public dealii::ExceptionBase { \
public: \
Exception3 (const type1 a1, const type2 a2, const type3 a3) : \
arg1 (a1), arg2(a2), arg3(a3) {} \
virtual ~Exception3 () throw () {} \
virtual void print_info (std::ostream &out) const { \
out outsequence << std::endl; \
} \
private: \
const type1 arg1; \
const type2 arg2; \
const type3 arg3; \
}
/**
* Declare an exception class derived from ExceptionBase with
* four additional parameters.
* @ingroup Exceptions
*/
#define DeclException4(Exception4, type1, type2, type3, type4, outsequence) \
class Exception4 : public dealii::ExceptionBase { \
public: \
Exception4 (const type1 a1, const type2 a2, \
const type3 a3, const type4 a4) : \
arg1 (a1), arg2(a2), arg3(a3), arg4(a4) {} \
virtual ~Exception4 () throw () {} \
virtual void print_info (std::ostream &out) const { \
out outsequence << std::endl; \
} \
private: \
const type1 arg1; \
const type2 arg2; \
const type3 arg3; \
const type4 arg4; \
}
/**
* Declare an exception class derived from ExceptionBase with
* five additional parameters.
* @ingroup Exceptions
*/
#define DeclException5(Exception5, type1, type2, type3, type4, type5, outsequence) \
class Exception5 : public dealii::ExceptionBase { \
public: \
Exception5 (const type1 a1, const type2 a2, const type3 a3, \
const type4 a4, const type5 a5) : \
arg1 (a1), arg2(a2), arg3(a3), arg4(a4), arg5(a5) {} \
virtual ~Exception5 () throw () {} \
virtual void print_info (std::ostream &out) const { \
out outsequence << std::endl; \
} \
private: \
const type1 arg1; \
const type2 arg2; \
const type3 arg3; \
const type4 arg4; \
const type5 arg5; \
}
#else // ifndef DOXYGEN
/**
* Declare an exception class derived from ExceptionBase without parameters.
* @author Wolfgang Bangerth, November 1997
* @ingroup Exceptions
*/
#define DeclException0(Exception0) \
static dealii::ExceptionBase& Exception0 ()
/**
* Declare an exception class derived from ExceptionBase with
* one additional parameter.
* @ingroup Exceptions
*/
#define DeclException1(Exception1, type1, outsequence) \
static dealii::ExceptionBase& Exception1 (type1 arg1) throw (errortext outsequence)
/**
* Declare an exception class derived from ExceptionBase with
* two additional parameters.
* @ingroup Exceptions
*/
#define DeclException2(Exception2, type1, type2, outsequence) \
static dealii::ExceptionBase& Exception2 (type1 arg1, type2 arg2) throw (errortext outsequence)
/**
* Declare an exception class derived from ExceptionBase with
* three additional parameters.
* @ingroup Exceptions
*/
#define DeclException3(Exception3, type1, type2, type3, outsequence) \
static dealii::ExceptionBase& Exception3 (type1 arg1, type2 arg2, type3 arg3) throw (errortext outsequence)
/**
* Declare an exception class derived from ExceptionBase with
* four additional parameters.
* @ingroup Exceptions
*/
#define DeclException4(Exception4, type1, type2, type3, type4, outsequence) \
static dealii::ExceptionBase& Exception4 (type1 arg1, type2 arg2, type3 arg3, type4 arg4) throw (errortext outsequence)
/**
* Declare an exception class derived from ExceptionBase with
* five additional parameters.
* @ingroup Exceptions
*/
#define DeclException5(Exception5, type1, type2, type3, type4, type5, outsequence) \
static dealii::ExceptionBase& Exception5 (type1 arg1, type2 arg2, type3 arg3, type4 arg4, type5 arg5) throw (errortext outsequence)
#endif
/**
* Declare some exceptions that occur over and over. This way, you can
* simply use these exceptions, instead of having to declare them
* locally in your class. The namespace in which these exceptions are
* declared is later included into the global namespace by
* @code
* using namespace StandardExceptions;
* @endcode
*
* @ingroup Exceptions
*/
namespace StandardExceptions
{
/**
* @addtogroup Exceptions
*/
//@{
/**
* Exception denoting a division by
* zero.
*
* @note Unfortunately, automatic
* detection of division by zero is
* very hardware dependent and
* requires severe hacking on some
* architectures. Therefore, this
* exception is only raised if the
* test s performed explicitly.
*/
DeclException0 (ExcDivideByZero);
/**
* Trying to allocate a new
* object failed due to lack of
* free memory.
*/
DeclException0 (ExcOutOfMemory);
/**
* A memory handler reached a point
* where all allocated objects
* should have been released. Since
* this exception is thrown, some
* were still allocated.
*/
DeclException1 (ExcMemoryLeak, int,
<< "Destroying memory handler while " << arg1
<< " objects are still allocated");
/**
* An error occurred reading or
* writing a file.
*/
DeclException0 (ExcIO);
/**
* An error occurred opening the named file.
*
* The constructor takes a single
* argument of type <tt>char*</tt>
* naming the file.
*/
DeclException1 (ExcFileNotOpen,
char*,
<< "Could not open file " << arg1);
/**
* Exception denoting a part of the
* library or application program
* that has not yet been
* implemented. In many cases, this
* only indicates that there wasn't
* much need for something yet, not
* that this is difficult to
* implement. It is therefore quite
* worth the effort to take a look
* at the corresponding place and
* see whether it can be
* implemented without too much
* effort.
*/
DeclException0 (ExcNotImplemented);
/**
* This exception usually indicates
* that some condition which the
* programmer thinks must be
* satisfied at a certain point in
* an algorithm, is not
* fulfilled. This might be due to
* some programming error above,
* due to changes to the algorithm
* that did not preserve this
* assertion, or due to assumptions
* the programmer made that are not
* valid at all (i.e. the exception
* is thrown although there is no
* error here). Within the library,
* this exception is most often
* used when we write some kind of
* complicated algorithm and are
* not yet sure whether we got it
* right; we then put in assertions
* after each part of the algorithm
* that check for some conditions
* that should hold there, and
* throw an exception if they do
* not.
*
* We usually leave in these
* assertions even after we are
* confident that the
* implementation is correct, since
* if someone later changes or
* extends the algorithm, these
* exceptions will indicate to him
* if he violates assumptions that
* are used later in the
* algorithm. Furthermore, it
* sometimes happens that an
* algorithm does not work in very
* rare corner cases. These cases
* will then be trapped sooner or
* later by the exception, so that
* the algorithm can then be fixed
* for these cases as well.
*/
DeclException0 (ExcInternalError);
/**
* This exception is used in
* functions that may not be called
* (i.e. in pure functions) but
* could not be declared pure since
* the class is intended to be used
* anyway, even though the
* respective function may only be
* called if a derived class is
* used.
*/
DeclException0 (ExcPureFunctionCalled);
/**
* Used for constructors that are
* disabled. Examples are copy
* constructors and assignment
* operators of large objects,
* which are only allowed for empty
* objects.
*/
DeclException0 (ExcInvalidConstructorCall);
/**
* This exception is used if some
* object is found uninitialized.
*/
DeclException0 (ExcNotInitialized);
/**
* The object is in a state not
* suitable for this operation.
*/
DeclException0 (ExcInvalidState);
/**
* This exception is raised if a
* functionality is not possible in
* the given dimension. Mostly used
* to throw function calls in 1d.
*
* The constructor takes a single
* <tt>int</tt>, denoting the
* dimension.
*/
DeclException1 (ExcImpossibleInDim,
int,
<< "Impossible in " << arg1 << "d.");
/**
* A number is zero, but it should
* not be here.
*/
DeclException0(ExcZero);
/**
* The object should have been
* filled with something before
* this member function is called.
*/
DeclException0(ExcEmptyObject);
/**
* This exception is raised
* whenever the sizes of two
* objects were assumed to be
* equal, but were not.
*
* Parameters to the constructor
* are the first and second size,
* both of type <tt>int</tt>.
*/
DeclException2 (ExcDimensionMismatch,
int, int,
<< "Dimension " << arg1 << " not equal to " << arg2);
/**
* The first dimension should be
* either equal to the second or
* the third, but it is neither.
*/
DeclException3 (ExcDimensionMismatch2,
int, int, int,
<< "Dimension " << arg1 << " neither equal to " << arg2 << " nor to " << arg3);
/**
* This exception is one of the
* most often used ones, and
* indicates that an index is not
* within the expected range. For
* example, you might try to access
* an element of a vector which
* does not exist.
*
* The constructor takes three
* <tt>int</tt>, namely
* <ol>
* <li> the violating index
* <li> the lower bound
* <li> the upper bound plus one
* </ol>
*/
DeclException3 (ExcIndexRange, int, int, int,
<< "Index " << arg1 << " is not in ["
<< arg2 << "," << arg3 << "[");
/**
* A number is too small.
*/
DeclException2 (ExcLowerRange, int, int,
<< "Number " << arg1
<< " must be larger or equal " << arg2);
/**
* This exception indicates that
* the first argument should be an
* integer multiple of the second,
* but is not.
*/
DeclException2 (ExcNotMultiple, int, int,
<< "Division " << arg1
<< " by " << arg2
<< " has remainder different from zero");
/**
* This exception is thrown if the
* iterator you access has
* corrupted data. It might for
* instance be, that the container
* it refers does not have an entry
* at the point the iterator
* refers.
*
* Typically, this will be an
* internal error of deal.II,
* because the increment and
* decrement operators should never
* yield an invalid iterator.
*/
DeclException0 (ExcInvalidIterator);
/**
* This exception is thrown if the
* iterator you incremented or
* decremented was already at its
* final state.
*/
DeclException0 (ExcIteratorPastEnd);
/**
* This exception works around a
* design flaw in the
* <tt>DeclException0</tt> macro: that
* does not allow one to specify a
* message that is displayed when
* the exception is raised, as
* opposed to the other exceptions
* which allow to show a text along
* with the given parameters.
*
* When throwing this exception,
* you can give a message as a
* <tt>char*</tt> as argument to the
* exception that is then
* displayed.
*/
DeclException1 (ExcMessage, char*,
<< arg1);
/**
* Exception used when running into
* functions that are only supported
* in a backward compatibility mode.
*/
DeclException1 (ExcCompatibility,
char*,
<< "You are using a backward compatibility feature\n"
<< "that you have disabled during configuration of\n"
<< "the library by the --disable-compat="
<< arg1 << " switch. You should either use an\n"
<< "alternative function, or configure again without\n"
<< "this switch and recompile the library.");
/**
* Some of our numerical classes
* allow for setting alll entries
* to zero using the assignment
* operator <tt>=</tt>.
*
* In many cases, this assignment
* operator makes sense <b>only</b>
* for the argument zero. In other
* cases, this exception is thrown.
*/
DeclException0 (ExcScalarAssignmentOnlyForZeroValue);
/**
* This function requires the BLAS
* library. Please reconfigure
* using the option
* <tt>--with-blas</tt> and check
* if it is actually included.
*/
DeclException0 (ExcNeedsBLAS);
/**
* This function requires the LAPACK
* library. Please reconfigure
* using the option
* <tt>--with-lapack</tt> and check
* if it is actually included.
*/
DeclException0 (ExcNeedsLAPACK);
/**
* This function requires the UMFPack
* library. Please reconfigure
* using the option
* <tt>--with-umfpack</tt> and check
* if it is actually included.
*/
DeclException0 (ExcNeedsUMFPACK);
/**
* This function requires the METIS
* library. Please reconfigure
* using the option
* <tt>--with-metis</tt> and check
* if it is actually included.
*/
DeclException0 (ExcNeedsMETIS);
/**
* This function requires the Petsc
* library. Please reconfigure
* using the option
* <tt>--with-petsc</tt> and check
* if it is actually included.
*/
DeclException0 (ExcNeedsPETSC);
/**
* This function requires the
* NetCDF library, which is neither
* in your standard path nor
* configured with --with-netcdf.
*/
DeclException0 (ExcNeedsNetCDF);
/**
* A configuration option disabled
* this feature. In order to use
* it, you must reconfigure and
* recompile the libraries.
*/
DeclException1 (ExcDisabled, char*,
<< "This feature was disabled by the "
"configuration option --disable-"
<< arg1 << ". Reconfigure to use it!");
//@}
}
/**
* Special assertion for dimension mismatch.
*
* Since this is used very often and always repeats the arguments, we
* introduce this special assertion for ExcDimensionMismatch in order
* to keep the user codes shorter.
*
* @ingroup Exceptions
* @author Guido Kanschat 2007
*/
#define AssertDimension(dim1,dim2) Assert((dim1) == (dim2), \
ExcDimensionMismatch((dim1),(dim2)))
/**
* Special assertion, testing whether <tt>vec</tt> has size
* <tt>dim1</tt>, and each entry of the vector has the
* size <tt>dim2</tt>
*
* @ingroup Exceptions
* @author Guido Kanschat 2010
*/
#define AssertVectorVectorDimension(vec,dim1,dim2) AssertDimension((vec).size(), (dim1)) \
for (unsigned int i=0;i<dim1;++i) { AssertDimension((vec)[i].size(), (dim2)); }
/**
* Special assertion for index range of nonnegative indices.
*
* Since this is used very often and always repeats the arguments, we
* introduce this special assertion for ExcIndexRange in order
* to keep the user codes shorter.
*
* Called wit arguments <tt>index</tt> and <tt>range</tt> it asserts
* that <tt>index<range</tt> and throws
* ExcIndexRange(index,0,range) if it fails.
*
* @ingroup Exceptions
* @author Guido Kanschat 2007
*/
#define AssertIndexRange(index,range) Assert((index) < (range), \
ExcIndexRange((index),0,(range)))
/*
* Unfortunately, the following must be repeated for each library,
* since we cannot have ifdefs in macros.
*/
/**
* Assert support for the BLAS library
*/
#ifdef HAVE_LIBBLAS
# define AssertBLAS {}
#else
# define AssertBLAS Assert(false, ExcNeedsBLAS())
#endif
/**
* Assert support for the LAPACK library
*/
#ifdef HAVE_LIBLAPACK
# define AssertLAPACK {}
#else
# define AssertLAPACK Assert(false, ExcNeedsLAPACK())
#endif
/**
* Assert support for the UMFPACK library
*/
#ifdef HAVE_LIBUMFPACK
# define AssertUMFPACK {}
#else
# define AssertUMFPACK Assert(false, ExcNeedsUMFPACK())
#endif
using namespace StandardExceptions;
DEAL_II_NAMESPACE_CLOSE
#endif
|