]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Update description of a couple of exceptions. 2370/head
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Fri, 18 Mar 2016 07:10:50 +0000 (02:10 -0500)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Fri, 18 Mar 2016 07:10:50 +0000 (02:10 -0500)
include/deal.II/base/exceptions.h

index 770bd2a679c51370aad49b534ae4cc6164a1e50d..722ab92ee0c31f5a3232a62057449a7f68c5e0d1 100644 (file)
@@ -1054,8 +1054,8 @@ namespace StandardExceptions
 
 
 /**
- * Special assertion, testing whether <tt>vec</tt> has size <tt>dim1</tt>, and
- * each entry of the vector has the size <tt>dim2</tt>
+ * An assertion that tests whether <tt>vec</tt> has size <tt>dim1</tt>, and
+ * each entry of the vector is itself an array that has the size <tt>dim2</tt>.
  *
  * @ingroup Exceptions
  * @author Guido Kanschat 2010
@@ -1065,14 +1065,9 @@ namespace StandardExceptions
 
 
 /**
- * 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&lt;range</tt> and throws ExcIndexRange(index,0,range) if it
+ * An assertion that tests that a given index is within the half-open
+ * range <code>[0,range)</code>. It throws an exception object
+ * <code>ExcIndexRange(index,0,range)</code> if the assertion
  * fails.
  *
  * @ingroup Exceptions
@@ -1081,6 +1076,18 @@ namespace StandardExceptions
 #define AssertIndexRange(index,range) Assert((index) < (range), \
                                              dealii::ExcIndexRange((index),0,(range)))
 
+/**
+ * An assertion that tests that a given index is within the half-open
+ * range <code>[0,range)</code>. It throws an exception object
+ * <code>ExcIndexRange(index,0,range)</code> if the assertion
+ * fails.
+ *
+ * This variation of the AssertIndexRange assertion is used for indices of type
+ * types::global_dof_index for which we need to make special accommodations because
+ * they may not fit into the regular 32-bit integer indices used in AssertIndexRange.
+ *
+ * @ingroup Exceptions
+ */
 #define AssertGlobalIndexRange(index,range) Assert((index) < (range), \
                                                    ExcIndexRange<types::global_dof_index>((index),0,(range)))
 

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.