From 5df823e7863931e7e3e33683c582120d9913e2c4 Mon Sep 17 00:00:00 2001 From: Wolfgang Bangerth Date: Mon, 2 May 2011 14:25:19 +0000 Subject: [PATCH] Provide better crossreferencing in the documentation. git-svn-id: https://svn.dealii.org/trunk@23673 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/include/deal.II/fe/fe_values.h | 66 +++++++++++++++++++------- 1 file changed, 48 insertions(+), 18 deletions(-) diff --git a/deal.II/include/deal.II/fe/fe_values.h b/deal.II/include/deal.II/fe/fe_values.h index fff75531d4..d2df6a698a 100644 --- a/deal.II/include/deal.II/fe/fe_values.h +++ b/deal.II/include/deal.II/fe/fe_values.h @@ -108,10 +108,11 @@ namespace internal * A namespace in which we declare "extractors", i.e. classes that when used * as subscripts in operator[] expressions on FEValues, FEFaceValues, and * FESubfaceValues objects extract certain components of a vector-valued - * element. There are extractors for single scalar components, - * vector components consisting of dim elements, - * and second order symmetric tensors consisting - * of (dim*dim + dim)/2 components + * element. The result of applying an extractor to these objects is an object + * with corresponding type from the namespace FEValuesViews. There are + * extractors for single scalar components, vector components consisting of + * dim elements, and second order symmetric tensors consisting of + * (dim*dim + dim)/2 components * * See the description of the @ref vector_valued module for examples how to * use the features of this namespace. @@ -122,8 +123,12 @@ namespace FEValuesExtractors { /** * Extractor for a single scalar component - * of a vector-valued element. The concept - * of extractors is defined in the + * of a vector-valued element. The result + * of applying an object of this type to an + * FEValues, FEFaceValues or + * FESubfaceValues object is of type + * FEValuesViews::Scalar. The concept of + * extractors is defined in the * documentation of the namespace * FEValuesExtractors and in the @ref * vector_valued module. @@ -152,7 +157,10 @@ namespace FEValuesExtractors * vector-valued element. The value of * spacedim is defined by the * FEValues object the extractor is applied - * to. + * to. The result of applying an object of + * this type to an FEValues, FEFaceValues + * or FESubfaceValues object is of type + * FEValuesViews::Vector. * * The concept of * extractors is defined in the @@ -204,17 +212,19 @@ namespace FEValuesExtractors /** - * Extractor for a symmetric tensor - * of a rank specified by the - * template argument. For a second - * order symmetric tensor, this - * represents a collection of + * Extractor for a symmetric tensor of a + * rank specified by the template + * argument. For a second order symmetric + * tensor, this represents a collection of * (dim*dim + dim)/2 * components of a vector-valued - * element. The value of - * dim is defined by - * the FEValues object the - * extractor is applied to. + * element. The value of dim + * is defined by the FEValues object the + * extractor is applied to. The result of + * applying an object of this type to an + * FEValues, FEFaceValues or + * FESubfaceValues object is of type + * FEValuesViews::SymmetricTensor. * * The concept of * extractors is defined in the @@ -253,7 +263,10 @@ namespace FEValuesExtractors * object. A view represents only a certain part of the whole: whereas the * FEValues object represents all values, gradients, or second * derivatives of all components of a vector-valued element, views restrict - * the attention to only a single component or a subset of components. + * the attention to only a single component or a subset of components. You + * typically get objects of classes defined in this namespace by applying + * FEValuesExtractors objects to a FEValues, FEFaceValues or FESubfaceValues + * objects using the square bracket operator. * * There are classes that present views for single scalar components, * vector components consisting of dim elements, and @@ -271,7 +284,13 @@ namespace FEValuesViews * A class representing a view to a single * scalar component of a possibly * vector-valued finite element. Views are - * discussed in the @ref vector_valued module. + * discussed in the @ref vector_valued + * module. + * + * You get an object of this type if you + * apply a FEValuesExtractors::Scalar to an + * FEValues, FEFaceValues or + * FESubfaceValues object. * * @ingroup feaccess vector_valued */ @@ -550,6 +569,11 @@ namespace FEValuesViews * this class should not be used for this * context. * + * You get an object of this type if you + * apply a FEValuesExtractors::Vector to an + * FEValues, FEFaceValues or + * FESubfaceValues object. + * * @ingroup feaccess vector_valued */ template @@ -1019,6 +1043,12 @@ namespace FEValuesViews * we apply the nabla operator by row * or by column to get the divergence. * + * You get an object of this type if you + * apply a + * FEValuesExtractors::SymmetricTensor to + * an FEValues, FEFaceValues or + * FESubfaceValues object. + * * @ingroup feaccess vector_valued * * @author Andrew McBride, 2009 -- 2.39.5