From: bangerth Date: Mon, 21 Mar 2011 16:47:31 +0000 (+0000) Subject: Add documentation. X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=9a457a659f3193fe04a8a02ac7df2f15eca00158;p=dealii-svn.git Add documentation. git-svn-id: https://svn.dealii.org/trunk@23486 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/include/deal.II/fe/fe_values.h b/deal.II/include/deal.II/fe/fe_values.h index c5e0b52aad..1fcf713bef 100644 --- a/deal.II/include/deal.II/fe/fe_values.h +++ b/deal.II/include/deal.II/fe/fe_values.h @@ -148,9 +148,9 @@ namespace FEValuesExtractors /** * Extractor for a vector of - * dim components of a + * spacedim components of a * vector-valued element. The value of - * dim is defined by the + * spacedim is defined by the * FEValues object the extractor is applied * to. * @@ -160,6 +160,29 @@ namespace FEValuesExtractors * FEValuesExtractors and in the @ref * vector_valued module. * + * Note that in the current context, a + * vector is meant in the sense physics + * uses it: it has spacedim + * components that behave in specific ways + * under coordinate system + * transformations. Examples include + * velocity or displacement fields. This is + * opposed to how mathematics uses the word + * "vector" (and how we use this word in + * other contexts in the library, for + * example in the Vector class), where it + * really stands for a collection of + * numbers. An example of this latter use + * of the word could be the set of + * concentrations of chemical species in a + * flame; however, these are really just a + * collection of scalar variables, since + * they do not change if the coordinate + * system is rotated, unlike the components + * of a velocity vector, and consequently, + * this class should not be used for this + * context. + * * @ingroup feaccess vector_valued */ struct Vector @@ -499,11 +522,34 @@ namespace FEValuesViews /** * A class representing a view to a set of - * dim components forming a + * spacedim components forming a * vector part of a vector-valued finite * element. Views are discussed in the * @ref vector_valued module. * + * Note that in the current context, a + * vector is meant in the sense physics + * uses it: it has spacedim + * components that behave in specific ways + * under coordinate system + * transformations. Examples include + * velocity or displacement fields. This is + * opposed to how mathematics uses the word + * "vector" (and how we use this word in + * other contexts in the library, for + * example in the Vector class), where it + * really stands for a collection of + * numbers. An example of this latter use + * of the word could be the set of + * concentrations of chemical species in a + * flame; however, these are really just a + * collection of scalar variables, since + * they do not change if the coordinate + * system is rotated, unlike the components + * of a velocity vector, and consequently, + * this class should not be used for this + * context. + * * @ingroup feaccess vector_valued */ template