From: bangerth Date: Mon, 29 Dec 2008 03:16:04 +0000 (+0000) Subject: Improve documentation. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7664ef9b2b9b7e5a6e93ea27c0b3cffe18376182;p=dealii-svn.git Improve documentation. git-svn-id: https://svn.dealii.org/trunk@18037 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/deal.II/include/grid/tria_accessor.h b/deal.II/deal.II/include/grid/tria_accessor.h index df4bd31579..6abc820732 100644 --- a/deal.II/deal.II/include/grid/tria_accessor.h +++ b/deal.II/deal.II/include/grid/tria_accessor.h @@ -1110,16 +1110,23 @@ class TriaAccessor : public TriaAccessorBase * set_all_boundary_indicators() * function. * - * Caution: Never set the - * boundary indicator to 255, - * unless you exactly know what - * you are doing! This value is - * reserved for another purpose - * and algorithms may not work if - * boundary cells have this - * boundary indicator or if - * interior cells have boundary - * indicators other than 255. + * Caution: You should never set the + * boundary indicator of an interior face + * (a face not at the boundary of the + * domain), or set set the boundary + * indicator of an exterior face to 255 + * (this value is reserved for another + * purpose). Algorithms may not work or + * produce very confusing results if + * boundary cells have this boundary + * indicator or if interior cells have + * boundary indicators other than + * 255. Unfortunately, the current object + * has no means of finding out whether it + * really is at the boundary of the + * domain and so cannot determine whether + * the value you are trying to set makes + * sense under the current circumstances. */ void set_boundary_indicator (const unsigned char) const;