From cfdb670ff95156fced307165ee35604718598491 Mon Sep 17 00:00:00 2001 From: bangerth Date: Fri, 31 May 2013 21:46:31 +0000 Subject: [PATCH] Augment documentation. git-svn-id: https://svn.dealii.org/trunk@29696 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/include/deal.II/grid/tria_accessor.h | 25 +++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/deal.II/include/deal.II/grid/tria_accessor.h b/deal.II/include/deal.II/grid/tria_accessor.h index c441f99c67..85305a69dc 100644 --- a/deal.II/include/deal.II/grid/tria_accessor.h +++ b/deal.II/include/deal.II/grid/tria_accessor.h @@ -2734,6 +2734,11 @@ public: * See the @ref GlossSubdomainId * "glossary" for more * information. + * + * @note The subdomain of a cell is a property only defined + * for active cells, i.e., cells that are not further + * refined. Consequently, you can only call this function if + * the cell it refers to has no children. */ types::subdomain_id subdomain_id () const; @@ -2841,7 +2846,13 @@ public: * * @post The returned value is equal to !is_ghost() && * !is_artificial(). - **/ + * + * @note Whether a cell is a ghost cell, artificial, or is + * locally owned or is a property that only pertains to cells + * that are active. Consequently, + * you can only call this function if the cell it refers to has + * no children. + */ bool is_locally_owned () const; /** @@ -2870,6 +2881,12 @@ public: * @post The returned value is equal to * !is_locally_owned() && * !is_artificial(). + * + * @note Whether a cell is a ghost cell, artificial, or is + * locally owned or is a property that only pertains to cells + * that are active. Consequently, + * you can only call this function if the cell it refers to has + * no children. */ bool is_ghost () const; @@ -2908,6 +2925,12 @@ public: * @post The returned value is equal to * !is_ghost() && * !is_artificial(). + * + * @note Whether a cell is a ghost cell, artificial, or is + * locally owned or is a property that only pertains to cells + * that are active. Consequently, + * you can only call this function if the cell it refers to has + * no children. */ bool is_artificial () const; -- 2.39.5