From 68e80e91561eab05da14a3a6fd1bd4cc52380f50 Mon Sep 17 00:00:00 2001 From: Timo Heister Date: Fri, 20 Oct 2017 14:55:32 -0400 Subject: [PATCH] document FE::doc_component_to_base_table --- include/deal.II/fe/fe.h | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/include/deal.II/fe/fe.h b/include/deal.II/fe/fe.h index e4ae7e555f..29e041d0fb 100644 --- a/include/deal.II/fe/fe.h +++ b/include/deal.II/fe/fe.h @@ -2398,15 +2398,20 @@ protected: * * For each component number c, the entries have the following * meaning:
table[c].first.first
Number of the - * base element for c.
table[c].first.second
- *
Component in the base element for c.
- *
table[c].second
Multiple of the base element for - * c.
+ * base element for c. This is the index you can pass to + * base_element().
table[c].first.second
+ *
Component within the base element for c. This value is + * between 0 and the n_components() of this base element.
+ *
table[c].second
Index of the multiple of the base + * element that contains c. This value is between 0 and the + * element_multiplicity() of this base element.
* * This variable is set to the correct size by the constructor of this * class, but needs to be initialized by derived classes, unless its size is * one and the only entry is a zero, which is the case for scalar elements. * In that case, the initialization by the base class is sufficient. + * + * @note This table is filled by FETools::Compositing::build_cell_tables(). */ std::vector, unsigned int> > component_to_base_table; -- 2.39.5