From: Wolfgang Bangerth Date: Tue, 3 Feb 2004 16:40:14 +0000 (+0000) Subject: Clarify documentation. X-Git-Tag: v8.0.0~15850 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=255b1dbeb2f415701f961af6948ffcd944370bdc;p=dealii.git Clarify documentation. git-svn-id: https://svn.dealii.org/trunk@8390 0785d39b-7218-0410-832d-ea1e28bc413d --- diff --git a/deal.II/deal.II/include/fe/fe_values.h b/deal.II/deal.II/include/fe/fe_values.h index 583dd43251..caf9f6c12e 100644 --- a/deal.II/deal.II/include/fe/fe_values.h +++ b/deal.II/deal.II/include/fe/fe_values.h @@ -438,7 +438,12 @@ class FEValuesBase : protected FEValuesData * input vector may be either a * @p{Vector}, * @p{Vector}, or - * @p{BlockVector}. + * @p{BlockVector}. It + * represents a global vector of + * DoF values associated with the + * @ref{DofHandler} object with + * which this @ref{FEValues} + * object was last initialized. */ template void get_function_values (const InputVector& fe_function, @@ -458,7 +463,12 @@ class FEValuesBase : protected FEValuesData * input vector may be either a * @p{Vector}, * @p{Vector}, or - * @p{BlockVector}. + * @p{BlockVector}. It + * represents a global vector of + * DoF values associated with the + * @ref{DofHandler} object with + * which this @ref{FEValues} + * object was last initialized. */ template void get_function_values (const InputVector &fe_function, @@ -544,7 +554,18 @@ class FEValuesBase : protected FEValuesData * input vector may be either a * @p{Vector}, * @p{Vector}, or - * @p{BlockVector}. + * @p{BlockVector}. It + * represents a global vector of + * DoF values associated with the + * @ref{DofHandler} object with + * which this @ref{FEValues} + * object was last initialized. + * + * The output are the gradients + * of the function represented by + * these DoF values, as computed + * in real space (as opposed to + * on the unit cell). */ template void get_function_grads (const InputVector &fe_function, @@ -573,7 +594,18 @@ class FEValuesBase : protected FEValuesData * input vector may be either a * @p{Vector}, * @p{Vector}, or - * @p{BlockVector}. + * @p{BlockVector}. It + * represents a global vector of + * DoF values associated with the + * @ref{DofHandler} object with + * which this @ref{FEValues} + * object was last initialized. + * + * The output are the gradients + * of the function represented by + * these DoF values, as computed + * in real space (as opposed to + * on the unit cell). */ template void get_function_grads (const InputVector &fe_function, @@ -660,7 +692,18 @@ class FEValuesBase : protected FEValuesData * input vector may be either a * @p{Vector}, * @p{Vector}, or - * @p{BlockVector}. + * @p{BlockVector}. It + * represents a global vector of + * DoF values associated with the + * @ref{DofHandler} object with + * which this @ref{FEValues} + * object was last initialized. + * + * The output are the second derivatives + * of the function represented by + * these DoF values, as computed + * in real space (as opposed to + * on the unit cell). */ template void get_function_2nd_derivatives (const InputVector& fe_function, @@ -687,7 +730,18 @@ class FEValuesBase : protected FEValuesData * input vector may be either a * @p{Vector}, * @p{Vector}, or - * @p{BlockVector}. + * @p{BlockVector}. It + * represents a global vector of + * DoF values associated with the + * @ref{DofHandler} object with + * which this @ref{FEValues} + * object was last initialized. + * + * The output are the second derivatives + * of the function represented by + * these DoF values, as computed + * in real space (as opposed to + * on the unit cell). */ template void get_function_2nd_derivatives (const InputVector &fe_function,