#include <exception>
#include <string>
-
-// 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
+#include <ostream>
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.
+ * 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.
+ * 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
+ * @ingroup Exceptions
+ * @author Wolfgang Bangerth, 1997, extensions 1998
*/
class ExceptionBase : public std::exception
{
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.
+ * 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);
+ ExceptionBase (const char *file,
+ int line,
+ const char *function,
+ const char *cond,
+ const char *exc_name);
/**
* 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.
+ * 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.
+ * 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);
+ const int line,
+ const char *function,
+ const char *cond,
+ const char *exc_name);
/**
- * Print out the general part of the error
- * information.
+ * 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.
+ * 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 occurred as well as user
- * information.
+ * Function derived from the base class which allows to pass
+ * information like the line and name of the file where the exception
+ * occurred 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.
+ * 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.
+ * Print a stacktrace, if one has been recorded previously, to the
+ * given stream.
*/
void print_stack_trace (std::ostream &out) const;
const char *exc;
/**
- * A backtrace to the position
- * where the problem happened, if
- * the system supports this.
+ * 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.
+ * 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;
};
{
/**
- * 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.
+ * 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.
+ * 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.
+ * 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.
+ * 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
+ * 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 ();
* are not for use outside the exception handling and throwing
* mechanism.
*
- * @ingroup Exceptions
+ * @ingroup Exceptions
*/
namespace internals
{
/**
- * This routine does the main work for the
- * exception generation mechanism used in the
- * <tt>Assert</tt> macro.
+ * This routine does the main work for the exception generation
+ * mechanism used in the <tt>Assert</tt> macro.
*
- * @ref ExceptionBase
+ * @ref ExceptionBase
*/
void issue_error_assert (const char *file,
int line,
/**
- * This routine does the main work for the
- * exception generation mechanism used in the
- * <tt>AssertThrow</tt> macro.
+ * This routine does the main work for the exception generation
+ * mechanism used in the <tt>AssertThrow</tt> macro.
*
- * @ref ExceptionBase
+ * @ref ExceptionBase
*/
template <class exc>
void issue_error_throw (const char *file,
const char *exc_name,
exc e)
{
- // Fill the fields of the
- // exception object
+ // 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.
+ * 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
+ * @ref ExceptionBase
*/
template <class exc>
inline
}
-
/**
* 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
void abort ();
}
-
}
-#ifdef DEBUG ////////////////////////////////////////
-
+#ifdef DEBUG
/**
* This is the main routine in the exception mechanism for debug mode
* error checking. It asserts that a certain condition is fulfilled,
if (!(cond)) \
::dealii::deal_II_exceptions::internals:: \
issue_error_assert_1 (__FILE__, \
- __LINE__, \
- __PRETTY_FUNCTION__, #cond, #exc, exc);\
+ __LINE__, \
+ __PRETTY_FUNCTION__, #cond, #exc, exc); \
}
-
-#else ////////////////////////////////////////
-
-#define Assert(cond, exc) \
+#else
+#define Assert(cond, exc) \
{ }
-#endif ////////////////////////////////////////
+#endif
*/
#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); \
+# 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); \
+# else /*ifndef 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
+# endif /*ifndef HAVE_BUILTIN_EXPECT*/
#else
-# define AssertThrow(cond, exc) \
+# define AssertThrow(cond, exc) \
{ \
if (!(cond)) \
::dealii::deal_II_exceptions::internals::abort (); \
/**
* Declare an exception class derived from ExceptionBase without parameters.
+ *
* @author Wolfgang Bangerth, November 1997
* @ingroup Exceptions
*/
-#define DeclException0(Exception0) \
+#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 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
+ * 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; \
+#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
+ * 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: \
+#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; \
+ 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
+ * 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; \
+ 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
+ * 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; \
+ 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
+#else /*ifndef DOXYGEN*/
/**
* Declare an exception class derived from ExceptionBase without parameters.
+ *
* @author Wolfgang Bangerth, November 1997
* @ingroup Exceptions
*/
-#define DeclException0(Exception0) \
+#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) \
+ * 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
+ * Declare an exception class derived from ExceptionBase with
+ * two additional parameters.
+ *
+ * @ingroup Exceptions
*/
-#define DeclException2(Exception2, type1, type2, outsequence) \
+#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
+ * Declare an exception class derived from ExceptionBase with
+ * three additional parameters.
+ *
+ * @ingroup Exceptions
*/
-#define DeclException3(Exception3, type1, type2, type3, outsequence) \
+#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
+ * 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
+ * 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
+#endif /*ifndef DOXYGEN*/
/**
* 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
+ * 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
//@{
/**
- * Exception denoting a division by
- * zero.
+ * 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.
+ * @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);
/**
- * Exception raised if a number is
- * not finite.
+ * Exception raised if a number is not finite.
*
- * This exception should be used to
- * catch infinite or not a number
- * results of arithmetic operations
- * that do not result from a
- * division by zero (use
- * ExcDivideByZero for those).
+ * This exception should be used to catch infinite or not a number results
+ * of arithmetic operations that do not result from a division by zero
+ * (use ExcDivideByZero for those).
*/
DeclException0 (ExcNumberNotFinite);
/**
- * Trying to allocate a new
- * object failed due to lack of
- * free memory.
+ * 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.
+ * 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.
+ * 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>
+ * The constructor takes a single argument of type <tt>char*</tt>
* naming the file.
*/
DeclException1 (ExcFileNotOpen,
<< "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.
+ * 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.
+ * 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.
+ * 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.
+ * 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.
+ * 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.
+ * This exception is used if some object is found uninitialized.
*/
DeclException0 (ExcNotInitialized);
/**
- * The object is in a state not
- * suitable for this operation.
+ * 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.
+ * 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.
+ * 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.
+ * 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.
+ * 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.
+ * 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>.
+ * Parameters to the constructor are the first and second size, both of
+ * type <tt>int</tt>.
*/
DeclException2 (ExcDimensionMismatch,
std::size_t, std::size_t,
<< "Dimension " << arg1 << " not equal to " << arg2);
/**
- * The first dimension should be
- * either equal to the second or
- * the third, but it is neither.
+ * 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);
+ << "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.
+ * 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
+ * The constructor takes three <tt>int</tt>, namely
* <ol>
- * <li> the violating index
- * <li> the lower bound
- * <li> the upper bound plus one
+ * <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 << "[");
+ 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);
+ 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.
+ * 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
+ 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.
+ * 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.
+ * 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.
+ * 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:
- * exceptions desclared through
- * DeclException0
- * do 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.
+ * This exception works around a design flaw in the
+ * <tt>DeclException0</tt> macro: exceptions desclared through
+ * DeclException0 do 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>std::string</tt> as argument to the
- * exception that is then
- * displayed. The argument can, of
- * course, be constructed at run-time,
- * for example including the name of a
- * file that can't be opened, or any
- * other text you may want to assemble
- * from different pieces.
+ * When throwing this exception, you can give a message as a
+ * <tt>std::string</tt> as argument to the exception that is then
+ * displayed. The argument can, of course, be constructed at run-time,
+ * for example including the name of a file that can't be opened, or
+ * any other text you may want to assemble from different pieces.
*/
DeclException1 (ExcMessage,
std::string,
<< arg1);
/**
- * Exception used when running into
- * functions that are only supported
+ * Exception used when running into functions that are only supported
* in a backward compatibility mode.
*/
DeclException1 (ExcCompatibility,
<< "this switch and recompile the library.");
/**
- * Some of our numerical classes
- * allow for setting alll entries
- * to zero using the assignment
- * operator <tt>=</tt>.
+ * 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.
+ * 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.
+ * 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.
+ * 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.
+ * 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.
+ * 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.
+ * 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.
+ * 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 "
<< arg1 << ". Reconfigure to use it!");
//@}
-}
+} /*namespace StandardExceptions*/
/**
* Special assertion for dimension mismatch.
* @ingroup Exceptions
* @author Guido Kanschat 2007
*/
-#define AssertDimension(dim1,dim2) Assert((dim1) == (dim2), \
+#define AssertDimension(dim1,dim2) Assert((dim1) == (dim2), \
ExcDimensionMismatch((dim1),(dim2)))
/**
*
* @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)); }
* 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
*/
# define AssertLAPACK Assert(false, ExcNeedsLAPACK())
#endif
-
/**
* Assert support for the UMFPACK library
*/
#endif
-
using namespace StandardExceptions;
-
DEAL_II_NAMESPACE_CLOSE
#endif
projects / dealii-svn.git / commitdiff