]> https://gitweb.dealii.org/ - dealii.git/commitdiff
Clarify that update_once/each is not part of a public interface. 2878/head
authorWolfgang Bangerth <bangerth@math.tamu.edu>
Wed, 27 Jul 2016 17:21:40 +0000 (11:21 -0600)
committerWolfgang Bangerth <bangerth@math.tamu.edu>
Wed, 27 Jul 2016 17:21:40 +0000 (11:21 -0600)
doc/doxygen/headers/update_flags.h

index 1c135733300d57ec2030c2731e46309b6dc6ad2b..9f54646b91268d77ff7cc1b97ae8c44e2cc57ab2 100644 (file)
  * 
  * To accommodate this structure, both mappings and finite element classes
  * may internally split the update flags into two sets commonly referenced as
- * <code>update_once</code> and <code>update_each</code>. The former contains
+ * <code>update_once</code> and <code>update_each</code> (though these names
+ * do not appear in any public interfaces). The former contains
  * all those pieces of information that can be pre-computed once at the
  * time the FEValues object starts to interact with a mapping or
  * finite element, whereas the latter contains those flags corresponding to
  * 
  * Once initialization is over and we call FEValues::reinit, FEFaceValues::reinit
  * or FESubfaceValues::reinit to move to a concrete cell or face, we need
- * to calculate the update_each kinds of data. This done in the following
+ * to calculate the "update_each" kinds of data. This is done in the following
  * functions:
  * <ul>
  * <li>FEValues::reinit() calls Mapping::fill_fe_values(), then FiniteElement::fill_fe_values()
  * thenFiniteElement::fill_fe_subface_values()
  * </ul>
  * 
- * This is, where the actual data fields for FEValues, stored in
+ * This is where the actual data fields for FEValues, stored in
  * internal::FEValues::MappingRelatedData and
  * internal::FEValues::FiniteElementRelatedData objects, are
  * computed. These functions call the function in Mapping first, such

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.