From: Timo Heister Date: Thu, 9 Jul 2015 20:07:22 +0000 (-0400) Subject: run wrapcomments.py X-Git-Tag: v8.3.0-rc1~41^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F1099%2Fhead;p=dealii.git run wrapcomments.py Conflicts: include/deal.II/numerics/error_estimator.h --- diff --git a/include/deal.II/algorithms/named_selection.h b/include/deal.II/algorithms/named_selection.h index c5b26cde72..1d7498ea45 100644 --- a/include/deal.II/algorithms/named_selection.h +++ b/include/deal.II/algorithms/named_selection.h @@ -26,8 +26,7 @@ DEAL_II_NAMESPACE_OPEN /** * Select data from NamedData corresponding to the attached name. * - * Given a list of names to search for (provided by add()), objects of - * this + * Given a list of names to search for (provided by add()), objects of this * class provide an index list of the selected data. * * @author Guido Kanschat, 2009 @@ -52,18 +51,15 @@ public: /** - * The number of names in this object. This function may be used - * whether + * The number of names in this object. This function may be used whether * initialize() was called before or not. */ unsigned int size() const; /** - * Return the corresponding index in the NamedData object supplied - * to the - * last initialize(). It is an error if initialize() has not been - * called + * Return the corresponding index in the NamedData object supplied to the + * last initialize(). It is an error if initialize() has not been called * before. * * Indices are in the same order as the calls to add(). @@ -79,8 +75,7 @@ private: std::vector names; /** - * The index map generated by initialize() and accessed by - * operator(). + * The index map generated by initialize() and accessed by operator(). */ std::vector indices; diff --git a/include/deal.II/algorithms/operator.h b/include/deal.II/algorithms/operator.h index c4077bd053..489d4e62d7 100644 --- a/include/deal.II/algorithms/operator.h +++ b/include/deal.II/algorithms/operator.h @@ -133,8 +133,8 @@ namespace Algorithms }; /** - * An unary operator base class, intended to output the vectors in - * AnyData in each step of an iteration. + * An unary operator base class, intended to output the vectors in AnyData + * in each step of an iteration. * * @author Guido Kanschat, 2010 */ diff --git a/include/deal.II/base/data_out_base.h b/include/deal.II/base/data_out_base.h index a8e47c9a32..0d19b916a7 100644 --- a/include/deal.II/base/data_out_base.h +++ b/include/deal.II/base/data_out_base.h @@ -325,8 +325,9 @@ namespace DataOutBase /** * Return an estimate for the memory consumption, in bytes, of this - * object. This is not exact (but will usually be close) because calculating - * the memory usage of trees (e.g., std::map) is difficult. + * object. This is not exact (but will usually be close) because + * calculating the memory usage of trees (e.g., std::map) is + * difficult. */ std::size_t memory_consumption () const; @@ -352,12 +353,13 @@ namespace DataOutBase /** - * Base class describing common functionality between different output flags. + * Base class describing common functionality between different output + * flags. * * This is implemented with the "Curiously Recurring Template Pattern"; * derived classes use their own type to fill in the typename so that - * memory_consumption works correctly. See the Wikipedia page on the - * pattern for more information. + * memory_consumption works correctly. See the Wikipedia page on + * the pattern for more information. * * @ingroup output */ @@ -384,8 +386,9 @@ namespace DataOutBase /** * Return an estimate for the memory consumption, in bytes, of this - * object. This is not exact (but will usually be close) because calculating - * the memory usage of trees (e.g., std::map) is difficult. + * object. This is not exact (but will usually be close) because + * calculating the memory usage of trees (e.g., std::map) is + * difficult. */ std::size_t memory_consumption () const; }; @@ -2274,8 +2277,8 @@ public: /** - * Set the flags to be used for output. This method expects flags to - * be a member of one of the child classes of OutputFlagsBase. + * Set the flags to be used for output. This method expects flags + * to be a member of one of the child classes of OutputFlagsBase. */ template void set_flags (const FlagType &flags); @@ -2317,9 +2320,9 @@ public: void parse_parameters (ParameterHandler &prm); /** - * Return an estimate for the memory consumption, in bytes, of this - * object. This is not exact (but will usually be close) because calculating - * the memory usage of trees (e.g., std::map) is difficult. + * Return an estimate for the memory consumption, in bytes, of this object. + * This is not exact (but will usually be close) because calculating the + * memory usage of trees (e.g., std::map) is difficult. */ std::size_t memory_consumption () const; diff --git a/include/deal.II/base/exceptions.h b/include/deal.II/base/exceptions.h index d86c350501..7f38981c2c 100644 --- a/include/deal.II/base/exceptions.h +++ b/include/deal.II/base/exceptions.h @@ -377,10 +377,10 @@ namespace deal_II_exceptions /** - * Declare an exception class derived from ExceptionBase that can take - * one runtime argument, but if none is given in the place where you - * want to throw the exception, it simply reverts to the default text - * provided when declaring the exception class through this macro. + * Declare an exception class derived from ExceptionBase that can take one + * runtime argument, but if none is given in the place where you want to throw + * the exception, it simply reverts to the default text provided when + * declaring the exception class through this macro. * * @ingroup Exceptions */ @@ -521,10 +521,10 @@ namespace deal_II_exceptions static dealii::ExceptionBase& Exception0 () /** - * Declare an exception class derived from ExceptionBase that can take - * one runtime argument, but if none is given in the place where you - * want to throw the exception, it simply reverts to the default text - * provided when declaring the exception class through this macro. + * Declare an exception class derived from ExceptionBase that can take one + * runtime argument, but if none is given in the place where you want to throw + * the exception, it simply reverts to the default text provided when + * declaring the exception class through this macro. * * @ingroup Exceptions */ @@ -615,8 +615,8 @@ namespace StandardExceptions * of arithmetic operations that do not result from a division by zero (use * ExcDivideByZero for those). * - * The exception uses std::complex as its argument to ensure that we can - * use it for all scalar arguments (real or complex-valued). + * The exception uses std::complex as its argument to ensure that we can use + * it for all scalar arguments (real or complex-valued). */ DeclException1 (ExcNumberNotFinite, std::complex, @@ -873,9 +873,9 @@ namespace StandardExceptions << " nor to " << arg3); /** - * This exception indicates that an index is not within the - * expected range. For example, it may be that you are trying to - * access an element of a vector which does not exist. + * This exception indicates that an index is not within the expected range. + * For example, it may be that you are trying to access an element of a + * vector which does not exist. * * The constructor takes three int arguments, namely *
    @@ -897,9 +897,9 @@ namespace StandardExceptions "")); /** - * This exception indicates that an index is not within the - * expected range. For example, it may be that you are trying to - * access an element of a vector which does not exist. + * This exception indicates that an index is not within the expected range. + * For example, it may be that you are trying to access an element of a + * vector which does not exist. * * The constructor takes three int arguments, namely *
      @@ -1079,11 +1079,10 @@ namespace StandardExceptions ExcIndexRange((index),0,(range))) /** - * An assertion that checks whether a number is finite or not. - * We explicitly cast the number to std::complex to match - * the signature of the exception (see there for an explanation - * of why we use std::complex at all) and to satisfy the - * fact that std::complex has no implicit conversions. + * An assertion that checks whether a number is finite or not. We explicitly + * cast the number to std::complex to match the signature of the exception + * (see there for an explanation of why we use std::complex at all) and to + * satisfy the fact that std::complex has no implicit conversions. * * @ingroup Exceptions * @author Wolfgang Bangerth, 2015 diff --git a/include/deal.II/base/function.h b/include/deal.II/base/function.h index 42c38e0bf8..feccc8f59c 100644 --- a/include/deal.II/base/function.h +++ b/include/deal.II/base/function.h @@ -310,9 +310,9 @@ public: std::vector > &values) const; /** - * Return an estimate for the memory consumption, in bytes, of this - * object. This is not exact (but will usually be close) because calculating - * the memory usage of trees (e.g., std::map) is difficult. + * Return an estimate for the memory consumption, in bytes, of this object. + * This is not exact (but will usually be close) because calculating the + * memory usage of trees (e.g., std::map) is difficult. */ std::size_t memory_consumption () const; }; @@ -498,9 +498,9 @@ public: std::vector > &values) const; /** - * Return an estimate for the memory consumption, in bytes, of this - * object. This is not exact (but will usually be close) because calculating - * the memory usage of trees (e.g., std::map) is difficult. + * Return an estimate for the memory consumption, in bytes, of this object. + * This is not exact (but will usually be close) because calculating the + * memory usage of trees (e.g., std::map) is difficult. */ std::size_t memory_consumption () const; diff --git a/include/deal.II/base/function_derivative.h b/include/deal.II/base/function_derivative.h index 56e259f120..731101823b 100644 --- a/include/deal.II/base/function_derivative.h +++ b/include/deal.II/base/function_derivative.h @@ -95,9 +95,9 @@ public: const unsigned int component = 0) const; /** - * Return an estimate for the memory consumption, in bytes, of this - * object. This is not exact (but will usually be close) because calculating - * the memory usage of trees (e.g., std::map) is difficult. + * Return an estimate for the memory consumption, in bytes, of this object. + * This is not exact (but will usually be close) because calculating the + * memory usage of trees (e.g., std::map) is difficult. */ std::size_t memory_consumption () const; diff --git a/include/deal.II/base/function_lib.h b/include/deal.II/base/function_lib.h index f0351c62bf..8ce8ee203c 100644 --- a/include/deal.II/base/function_lib.h +++ b/include/deal.II/base/function_lib.h @@ -579,8 +579,9 @@ namespace Functions /** * Return an estimate for the memory consumption, in bytes, of this - * object. This is not exact (but will usually be close) because calculating - * the memory usage of trees (e.g., std::map) is difficult. + * object. This is not exact (but will usually be close) because + * calculating the memory usage of trees (e.g., std::map) is + * difficult. */ std::size_t memory_consumption () const; @@ -1031,8 +1032,8 @@ namespace Functions * described by a $dim$-tuple of exponents. Consequently, the class's * constructor takes a Tensor<1,dim> to describe the set of exponents. Most * of the time these exponents will of course be integers, but real - * exponents are of course equally valid. Exponents can't be real when - * the bases are negative numbers. + * exponents are of course equally valid. Exponents can't be real when the + * bases are negative numbers. * * @author Wolfgang Bangerth, 2006 */ @@ -1259,13 +1260,14 @@ namespace Functions /** * A class that represents a function object for a polynomial. A polynomial * is composed by the summation of multiple monomials. If the polynomial has - * n monomials and the dimension is equal to dim, the polynomial can be written as - * $\sum_{i=1}^{n} a_{i}(\prod_{d=1}^{dim} x_{d}^{\alpha_{i,d}})$, where - * $a_{i}$ are the coefficients of the monomials and $\alpha_{i,d}$ are their exponents. - * The class's constructor takes a Table<2,double> to describe the set of - * exponents and a Vector to describe the set of coefficients. + * n monomials and the dimension is equal to dim, the polynomial can be + * written as $\sum_{i=1}^{n} a_{i}(\prod_{d=1}^{dim} + * x_{d}^{\alpha_{i,d}})$, where $a_{i}$ are the coefficients of the + * monomials and $\alpha_{i,d}$ are their exponents. The class's constructor + * takes a Table<2,double> to describe the set of exponents and a + * Vector to describe the set of coefficients. * - * @author Ángel Rodríguez, 2015 + * @author Ángel Rodríguez, 2015 */ template class Polynomial : public Function @@ -1273,12 +1275,12 @@ namespace Functions public: /** * Constructor. The coefficients and the exponents of the polynomial are - * passed as arguments. The Table<2, double> exponents has a number of rows - * equal to the number of monomials of the polynomial and a number of columns - * equal to dim. The i-th row of the exponents table contains the - * ${\alpha_{i,d}}$ exponents of the i-th monomial - * $a_{i}\prod_{d=1}^{dim} x_{d}^{\alpha_{i,d}}$. The i-th element of the coefficients - * vector contains the coefficient $a_{i}$ for the i-th monomial. + * passed as arguments. The Table<2, double> exponents has a number of + * rows equal to the number of monomials of the polynomial and a number of + * columns equal to dim. The i-th row of the exponents table contains the + * ${\alpha_{i,d}}$ exponents of the i-th monomial $a_{i}\prod_{d=1}^{dim} + * x_{d}^{\alpha_{i,d}}$. The i-th element of the coefficients vector + * contains the coefficient $a_{i}$ for the i-th monomial. */ Polynomial (const Table<2,double> &exponents, const std::vector &coefficients); diff --git a/include/deal.II/base/function_time.h b/include/deal.II/base/function_time.h index 9ad4949e7f..1c80ddd2ca 100644 --- a/include/deal.II/base/function_time.h +++ b/include/deal.II/base/function_time.h @@ -42,27 +42,27 @@ DEAL_II_NAMESPACE_OPEN * computations which need only be done once for every new time. For example, * if a time dependent function had a factor sin(t), then it may be a * reasonable choice to calculate this factor in a derived version of - * set_time(), store it in a member variable and use that one rather - * than computing it every time value(), value_list or - * one of the other functions of class Function is called. + * set_time(), store it in a member variable and use that one rather than + * computing it every time value(), value_list or one of the + * other functions of class Function is called. * - * By default, the advance_time() function calls the set_time() - * function with the new time, so it is sufficient in most cases to overload - * only set_time() for computations as sketched out above. + * By default, the advance_time() function calls the set_time() function with + * the new time, so it is sufficient in most cases to overload only set_time() + * for computations as sketched out above. * * The constructor of this class takes an initial value for the time variable, * which defaults to zero. Because a default value is given, none of the * derived classes needs to take an initial value for the time variable if not * needed. * - * @tparam Number The data type in which time values are to be - * stored. This will, in almost all cases, simply be the default @p double, - * but there are cases where one may want to store the time in a different - * (and always scalar) type. An example would be an interval type that can - * store a value as well as its uncertainty. Another example - * would be a type that allows for Automatic Differentiation (see, for - * example, the Sacado type used in step-33) and thereby can generate analytic - * (temporal) derivatives of a function. + * @tparam Number The data type in which time values are to be stored. This + * will, in almost all cases, simply be the default @p double, but there are + * cases where one may want to store the time in a different (and always + * scalar) type. An example would be an interval type that can store a value + * as well as its uncertainty. Another example would be a type that allows for + * Automatic Differentiation (see, for example, the Sacado type used in + * step-33) and thereby can generate analytic (temporal) derivatives of a + * function. * * * @ingroup functions diff --git a/include/deal.II/base/logstream.h b/include/deal.II/base/logstream.h index 577f9dc691..9426454866 100644 --- a/include/deal.II/base/logstream.h +++ b/include/deal.II/base/logstream.h @@ -390,9 +390,9 @@ public: /** - * Return an estimate for the memory consumption, in bytes, of this - * object. This is not exact (but will usually be close) because calculating - * the memory usage of trees (e.g., std::map) is difficult. + * Return an estimate for the memory consumption, in bytes, of this object. + * This is not exact (but will usually be close) because calculating the + * memory usage of trees (e.g., std::map) is difficult. */ std::size_t memory_consumption () const; diff --git a/include/deal.II/base/memory_consumption.h b/include/deal.II/base/memory_consumption.h index c34e8f69a4..cda727c9ff 100644 --- a/include/deal.II/base/memory_consumption.h +++ b/include/deal.II/base/memory_consumption.h @@ -173,8 +173,9 @@ namespace MemoryConsumption /** * Determine the amount of memory consumed by a C-style string. The returned - * value does not include the size of the pointer. This function only measures - * up to (and including) the NUL byte; the underlying buffer may be larger. + * value does not include the size of the pointer. This function only + * measures up to (and including) the NUL byte; the underlying buffer may be + * larger. */ inline std::size_t memory_consumption (const char *string); @@ -236,10 +237,10 @@ namespace MemoryConsumption /** * Estimate the amount of memory (in bytes) occupied by a C-style array. * Since in this library we do not usually store simple data elements like - * doubles in such arrays (but rather use std::vectors - * or deal.II Vector objects), we do not provide specializations - * like for the std::vector arrays, but always use the loop over - * all elements. + * doubles in such arrays (but rather use std::vectors or + * deal.II Vector objects), we do not provide specializations like + * for the std::vector arrays, but always use the loop over all + * elements. */ template inline diff --git a/include/deal.II/base/multithread_info.h b/include/deal.II/base/multithread_info.h index df8d71f1bd..9335ba22ae 100644 --- a/include/deal.II/base/multithread_info.h +++ b/include/deal.II/base/multithread_info.h @@ -71,9 +71,9 @@ public: static unsigned int n_threads (); /** - * Return an estimate for the memory consumption, in bytes, of this - * object. This is not exact (but will usually be close) because calculating - * the memory usage of trees (e.g., std::map) is difficult. + * Return an estimate for the memory consumption, in bytes, of this object. + * This is not exact (but will usually be close) because calculating the + * memory usage of trees (e.g., std::map) is difficult. */ static std::size_t memory_consumption (); diff --git a/include/deal.II/base/numbers.h b/include/deal.II/base/numbers.h index 699157fb7e..70ce3cdb58 100644 --- a/include/deal.II/base/numbers.h +++ b/include/deal.II/base/numbers.h @@ -93,12 +93,12 @@ namespace numbers /** * Check whether a value is not a number. * - * This function uses either std::isnan, - * isnan, or _isnan, whichever is - * available on the system and returns the result. + * This function uses either std::isnan, isnan, or + * _isnan, whichever is available on the system and returns the + * result. * - * If none of the functions detecting NaN is available, this - * function returns false. + * If none of the functions detecting NaN is available, this function + * returns false. */ bool is_nan (const double x); diff --git a/include/deal.II/base/parallel.h b/include/deal.II/base/parallel.h index 80aff32359..032b79757a 100644 --- a/include/deal.II/base/parallel.h +++ b/include/deal.II/base/parallel.h @@ -45,8 +45,8 @@ namespace parallel namespace internal { /** - * Helper struct to tell us if we can use SIMD instructions for the given @p - * Number type. + * Helper struct to tell us if we can use SIMD instructions for the given + * @p Number type. */ template struct EnableOpenMPSimdFor diff --git a/include/deal.II/base/parameter_handler.h b/include/deal.II/base/parameter_handler.h index 860eb5b5ae..68d4891914 100644 --- a/include/deal.II/base/parameter_handler.h +++ b/include/deal.II/base/parameter_handler.h @@ -1648,27 +1648,25 @@ public: const std::string &documentation = std::string()); /** - * Create an alias for an existing entry. This provides a way to refer - * to a parameter in the input file using an alternate name. The - * alias will be in the current section, and the referenced entry needs - * to be an existing entry in the current section. + * Create an alias for an existing entry. This provides a way to refer to a + * parameter in the input file using an alternate name. The alias will be in + * the current section, and the referenced entry needs to be an existing + * entry in the current section. * * The primary purpose of this function is to allow for a backward - * compatible way of changing names in input files of applications - * for which backward compatibility is important. This can be - * achieved by changing the name of the parameter in the call to - * declare_entry(), and then creating an alias that maps the old - * name to the new name. This way, old input files can continue - * to refer to parameters under the old name, and they will - * automatically be mapped to the new parameter name. + * compatible way of changing names in input files of applications for which + * backward compatibility is important. This can be achieved by changing the + * name of the parameter in the call to declare_entry(), and then creating + * an alias that maps the old name to the new name. This way, old input + * files can continue to refer to parameters under the old name, and they + * will automatically be mapped to the new parameter name. * * It is valid to set the same parameter multiple times in an input file. - * The value that will ultimately be chosen in such - * cases is simply the last value set. This rule also applies to - * aliases, where the final value of a parameter is the last value - * set either through the current name of the parameter or through - * any of its possible multiple aliases. For example, if you have - * an input file that looks like + * The value that will ultimately be chosen in such cases is simply the last + * value set. This rule also applies to aliases, where the final value of a + * parameter is the last value set either through the current name of the + * parameter or through any of its possible multiple aliases. For example, + * if you have an input file that looks like * @code * set parm1 = 1 * set parm1_alias = 2 @@ -1677,20 +1675,20 @@ public: * @code * prm.declare_alias ("parm1", "parm1_alias"); * @endcode - * then the final value for the parameter called parm1 - * will be 2, not 1. + * then the final value for the parameter called parm1 will be + * 2, not 1. * - * @param existing_entry_name The name of an existing parameter - * in the current section that the alias should refer to. - * @param alias_name An alternate name for the parameter referenced - * by the first argument. - * @param alias_is_deprecated If true, mark the alias as deprecated. - * This will then be listed in the description of the alias if you call - * print_parameters(), and you will get a warning on the screen - * when reading an input file that contains this deprecated alias. - * The purpose of this argument is to be able to allow the use of - * an old name for a parameter (see above) but make it clear that - * this old name will eventually be removed. + * @param existing_entry_name The name of an existing parameter in the + * current section that the alias should refer to. + * @param alias_name An alternate name for the parameter referenced by the + * first argument. + * @param alias_is_deprecated If true, mark the alias as deprecated. This + * will then be listed in the description of the alias if you call + * print_parameters(), and you will get a warning on the screen when reading + * an input file that contains this deprecated alias. The purpose of this + * argument is to be able to allow the use of an old name for a parameter + * (see above) but make it clear that this old name will eventually be + * removed. */ void declare_alias (const std::string &existing_entry_name, const std::string &alias_name, diff --git a/include/deal.II/base/symmetric_tensor.h b/include/deal.II/base/symmetric_tensor.h index 1ddd65ec56..a50f199253 100644 --- a/include/deal.II/base/symmetric_tensor.h +++ b/include/deal.II/base/symmetric_tensor.h @@ -641,12 +641,11 @@ public: * present object and the indices of the argument, and the result is a * tensor of rank 2. * - * Note that the multiplication operator for symmetric tensors is defined - * to be a double contraction over two indices, while it is defined as a - * single contraction over only one index for regular Tensor - * objects. For symmetric tensors it therefore acts in a way that is - * commonly denoted by a "colon multiplication" in the mathematical - * literature. + * Note that the multiplication operator for symmetric tensors is defined to + * be a double contraction over two indices, while it is defined as a single + * contraction over only one index for regular Tensor objects. For + * symmetric tensors it therefore acts in a way that is commonly denoted by + * a "colon multiplication" in the mathematical literature. * * There are global functions double_contract that do the same work * as this operator, but rather than returning the result as a return value, @@ -752,14 +751,14 @@ public: /** * Reset all values to zero. * - * Note that this is partly inconsistent with the semantics of the @p clear() - * member functions of the standard library containers and of several other - * classes within deal.II, which not only reset the values of stored elements - * to zero, but release all memory and return the object into a virginial - * state. However, since the size of objects of the present type is determined - * by its template parameters, resizing is not an option, and indeed the state - * where all elements have a zero value is the state right after construction - * of such an object. + * Note that this is partly inconsistent with the semantics of the @p + * clear() member functions of the standard library containers and of + * several other classes within deal.II, which not only reset the values of + * stored elements to zero, but release all memory and return the object + * into a virginial state. However, since the size of objects of the present + * type is determined by its template parameters, resizing is not an option, + * and indeed the state where all elements have a zero value is the state + * right after construction of such an object. */ void clear (); diff --git a/include/deal.II/base/table_handler.h b/include/deal.II/base/table_handler.h index 95f48d7f53..802a9d9733 100644 --- a/include/deal.II/base/table_handler.h +++ b/include/deal.II/base/table_handler.h @@ -461,16 +461,16 @@ public: void clear (); /** - * Remove all values added at the current row. This is useful when, - * for example, a time-step is rejected and all data recorded about - * it needs to be discarded. - */ + * Remove all values added at the current row. This is useful when, for + * example, a time-step is rejected and all data recorded about it needs to + * be discarded. + */ void clear_current_row (); /** - * Read or write the data of this object to or from a stream for the purpose - * of serialization. - */ + * Read or write the data of this object to or from a stream for the purpose + * of serialization. + */ template void serialize(Archive &ar, const unsigned int version); diff --git a/include/deal.II/base/tensor.h b/include/deal.II/base/tensor.h index fd2cfe4253..55ce6337d9 100644 --- a/include/deal.II/base/tensor.h +++ b/include/deal.II/base/tensor.h @@ -274,14 +274,14 @@ public: /** * Reset all values to zero. * - * Note that this is partly inconsistent with the semantics of the @p clear() - * member functions of the standard library containers and of several other - * classes within deal.II, which not only reset the values of stored elements - * to zero, but release all memory and return the object into a virginial - * state. However, since the size of objects of the present type is determined - * by its template parameters, resizing is not an option, and indeed the state - * where all elements have a zero value is the state right after construction - * of such an object. + * Note that this is partly inconsistent with the semantics of the @p + * clear() member functions of the standard library containers and of + * several other classes within deal.II, which not only reset the values of + * stored elements to zero, but release all memory and return the object + * into a virginial state. However, since the size of objects of the present + * type is determined by its template parameters, resizing is not an option, + * and indeed the state where all elements have a zero value is the state + * right after construction of such an object. */ void clear (); diff --git a/include/deal.II/base/tensor_base.h b/include/deal.II/base/tensor_base.h index fd21f8dfdd..c7ea73c2ac 100644 --- a/include/deal.II/base/tensor_base.h +++ b/include/deal.II/base/tensor_base.h @@ -244,14 +244,14 @@ public: /** * Reset all values to zero. * - * Note that this is partly inconsistent with the semantics of the @p clear() - * member functions of the standard library containers and of several other - * classes within deal.II, which not only reset the values of stored elements - * to zero, but release all memory and return the object into a virginial - * state. However, since the size of objects of the present type is determined - * by its template parameters, resizing is not an option, and indeed the state - * where all elements have a zero value is the state right after construction - * of such an object. + * Note that this is partly inconsistent with the semantics of the @p + * clear() member functions of the standard library containers and of + * several other classes within deal.II, which not only reset the values of + * stored elements to zero, but release all memory and return the object + * into a virginial state. However, since the size of objects of the present + * type is determined by its template parameters, resizing is not an option, + * and indeed the state where all elements have a zero value is the state + * right after construction of such an object. */ void clear (); @@ -512,14 +512,14 @@ public: /** * Reset all values to zero. * - * Note that this is partly inconsistent with the semantics of the @p clear() - * member functions of the standard library containers and of several other - * classes within deal.II, which not only reset the values of stored elements - * to zero, but release all memory and return the object into a virginial - * state. However, since the size of objects of the present type is determined - * by its template parameters, resizing is not an option, and indeed the state - * where all elements have a zero value is the state right after construction - * of such an object. + * Note that this is partly inconsistent with the semantics of the @p + * clear() member functions of the standard library containers and of + * several other classes within deal.II, which not only reset the values of + * stored elements to zero, but release all memory and return the object + * into a virginial state. However, since the size of objects of the present + * type is determined by its template parameters, resizing is not an option, + * and indeed the state where all elements have a zero value is the state + * right after construction of such an object. */ void clear (); diff --git a/include/deal.II/base/utilities.h b/include/deal.II/base/utilities.h index 5f324680c6..5b8a1bf200 100644 --- a/include/deal.II/base/utilities.h +++ b/include/deal.II/base/utilities.h @@ -113,12 +113,12 @@ namespace Utilities /** * Given a string that contains text separated by a @p delimiter, split it * into its components; for each component, remove leading and trailing - * spaces. The default value of the delimiter is a comma, so that the function - * splits comma separated lists of strings. + * spaces. The default value of the delimiter is a comma, so that the + * function splits comma separated lists of strings. * - * To make data input from tables simpler, if the input string ends in - * a delimiter (possibly followed by an arbitrary amount of whitespace), - * then this last delimiter is ignored. For example, + * To make data input from tables simpler, if the input string ends in a + * delimiter (possibly followed by an arbitrary amount of whitespace), then + * this last delimiter is ignored. For example, * @code * Utilities::split_string_list("abc; def; ghi; ", ';'); * @endcode @@ -135,8 +135,8 @@ namespace Utilities * @code * Utilities::split_string_list(" ; ", ';'); * @endcode - * yields a one-element list. Because of the trimming of - * whitespace, the single element is the empty string. + * yields a one-element list. Because of the trimming of whitespace, the + * single element is the empty string. * * This function can digest the case that the delimiter is a space. In this * case, it returns all words in the string. Combined with the rules above, @@ -144,9 +144,9 @@ namespace Utilities * @code * Utilities::split_string_list("abc def ghi ", ' '); * @endcode - * yields again the 3-element list of output {"abc","def","ghi"} - * from above despite the presence of space at the end of the string. - * Furthermore, + * yields again the 3-element list of output + * {"abc","def","ghi"} from above despite the presence of space + * at the end of the string. Furthermore, * @code * Utilities::split_string_list(" ", ' '); * @endcode @@ -202,16 +202,15 @@ namespace Utilities * Generate a random number from a normalized Gaussian probability * distribution centered around @p a and with standard deviation @p sigma. * - * This function is reentrant, i.e., it can safely be called from - * multiple threads at the same time. In addition, each thread will - * get the same sequence of numbers every time. On the other hand, - * if you run Threads::Task objects via the Threading Building - * Blocks, then tasks will be assigned to mostly random threads, and - * may get a different sequence of random numbers in different runs - * of the program, since a previous task may already have consumed - * the first few random numbers generated for the thread you're - * on. If this is a problem, you need to create your own random - * number generator objects every time you want to start from a + * This function is reentrant, i.e., it can safely be called from multiple + * threads at the same time. In addition, each thread will get the same + * sequence of numbers every time. On the other hand, if you run + * Threads::Task objects via the Threading Building Blocks, then tasks will + * be assigned to mostly random threads, and may get a different sequence of + * random numbers in different runs of the program, since a previous task + * may already have consumed the first few random numbers generated for the + * thread you're on. If this is a problem, you need to create your own + * random number generator objects every time you want to start from a * defined point. * * @note Like the system function rand(), this function produces the same @@ -386,24 +385,24 @@ namespace Utilities std::string get_time (); /** - * Return the present date as YYYY/MM/DD. MM and DD may be either one or two - * digits. + * Return the present date as YYYY/MM/DD. MM and DD may be either one or + * two digits. */ std::string get_date (); /** - * Call the system function posix_memalign, or a replacement function if not - * available, to allocate memory with a certain minimal alignment. The + * Call the system function posix_memalign, or a replacement function if + * not available, to allocate memory with a certain minimal alignment. The * first argument will then return a pointer to this memory block that can * be released later on through a standard free call. * - * @param memptr The address of a pointer variable that will after this call - * point to the allocated memory. + * @param memptr The address of a pointer variable that will after this + * call point to the allocated memory. * @param alignment The minimal alignment of the memory block, in bytes. * @param size The size of the memory block to be allocated, in bytes. * * @note This function checks internally for error codes, rather than - * leaving this task to the calling site. + * leaving this task to the calling site. */ void posix_memalign (void **memptr, size_t alignment, size_t size); diff --git a/include/deal.II/base/vectorization.h b/include/deal.II/base/vectorization.h index 7f0d01eab7..173485bb41 100644 --- a/include/deal.II/base/vectorization.h +++ b/include/deal.II/base/vectorization.h @@ -317,10 +317,10 @@ make_vectorized_array (const Number &u) * given array @p in. The offsets to the input array are given by the array @p * offsets. From each stream, n_entries are read. The data is then transposed * and stored it into an array of VectorizedArray type. The output array @p - * out is expected to be an array of size @p n_entries. This method - * operates on plain arrays, so no checks for valid data access are made. It is - * the user's responsibility to ensure that the given arrays are valid - * according to the access layout below. + * out is expected to be an array of size @p n_entries. This method operates + * on plain arrays, so no checks for valid data access are made. It is the + * user's responsibility to ensure that the given arrays are valid according + * to the access layout below. * * This operation corresponds to a transformation of an array-of-struct * (input) into a struct-of-array (output) according to the following formula: @@ -355,10 +355,10 @@ vectorized_load_and_transpose(const unsigned int n_entries, /** * This method stores the vectorized arrays in transposed form into the given * output array @p out with the given offsets @p offsets. This operation - * corresponds to a transformation of a struct-of-array (input) into an - * array-of-struct (output). This method operates on plain array, so no checks - * for valid data access are made. It is the user's responsibility to ensure - * that the given arrays are valid according to the access layout below. + * corresponds to a transformation of a struct-of-array (input) into an array- + * of-struct (output). This method operates on plain array, so no checks for + * valid data access are made. It is the user's responsibility to ensure that + * the given arrays are valid according to the access layout below. * * This method assumes that the specified offsets do not overlap. Otherwise, * the behavior is undefined in the vectorized case. It is the user's @@ -376,7 +376,8 @@ vectorized_load_and_transpose(const unsigned int n_entries, * out[offsets[v]+i] = in[i][v]; * @endcode * - * For add_into == true, the code implements the following action: + * For add_into == true, the code implements the following + * action: * @code * for (unsigned int i=0; i::n_array_elements; ++v) diff --git a/include/deal.II/distributed/tria.h b/include/deal.II/distributed/tria.h index 33d3137cda..ca0fd523f7 100644 --- a/include/deal.II/distributed/tria.h +++ b/include/deal.II/distributed/tria.h @@ -267,16 +267,16 @@ namespace parallel * argument but permanently fix this one argument to a reference to the * coarse grid triangulation. After each refinement step, the * triangulation will then call the object so created which will in turn - * call set_boundary_ids with the reference to - * the coarse grid as argument. + * call set_boundary_ids with the reference to the + * coarse grid as argument. * * This approach can be generalized. In the example above, we have used a * global function that will be called. However, sometimes it is necessary * that this function is in fact a member function of the class that * generates the mesh, for example because it needs to access run-time * parameters. This can be achieved as follows: assuming the - * set_boundary_ids() function has been declared as a - * (non-static, but possibly private) member function of the + * set_boundary_ids() function has been declared as a (non- + * static, but possibly private) member function of the * MyClass class, then the following will work: * @code * #include @@ -302,12 +302,11 @@ namespace parallel * std_cxx11::ref(coarse_grid))); * } * @endcode - * Here, like any other member function, - * set_boundary_ids implicitly takes a pointer or - * reference to the object it belongs to as first argument. - * std::bind again creates an object that can be called like - * a global function with no arguments, and this object in turn calls - * set_boundary_ids with a pointer to the current + * Here, like any other member function, set_boundary_ids + * implicitly takes a pointer or reference to the object it belongs to as + * first argument. std::bind again creates an object that can + * be called like a global function with no arguments, and this object in + * turn calls set_boundary_ids with a pointer to the current * object and a reference to the triangulation to work on. Note that * because the create_coarse_mesh function is declared as * const, it is necessary that the diff --git a/include/deal.II/dofs/dof_accessor.h b/include/deal.II/dofs/dof_accessor.h index 89ee601037..ec6ef21b16 100644 --- a/include/deal.II/dofs/dof_accessor.h +++ b/include/deal.II/dofs/dof_accessor.h @@ -799,8 +799,8 @@ public: /** * Return an invalid iterator of a type that represents pointing to a child - * of the current object. The object is invalid because points (as represented - * by the current class) do not have children. + * of the current object. The object is invalid because points (as + * represented by the current class) do not have children. */ TriaIterator, level_dof_access > > child (const unsigned int c) const; diff --git a/include/deal.II/dofs/dof_renumbering.h b/include/deal.II/dofs/dof_renumbering.h index caf2695d03..af8bfce158 100644 --- a/include/deal.II/dofs/dof_renumbering.h +++ b/include/deal.II/dofs/dof_renumbering.h @@ -527,21 +527,20 @@ namespace DoFRenumbering * * @param dof_handler The DoFHandler or hp::DoFHandler object to work on. * @param reversed_numbering Whether to use the original Cuthill-McKee - * algorithm, or to reverse the ordering. - * @param use_constraints Whether or not to use hanging node constraints - * in determining the reordering of degrees of freedom. - * @param starting_indices A set of degrees of freedom that form the - * first level of renumbered degrees of freedom. If the set is empty, - * then a single starting entry is chosen automatically among those - * that have the smallest number of others that couple with it. - * If the DoFHandler is built on a parallel triangulation, then on every - * processor, these starting indices need to be a (possibly empty) - * subset of the - * @ref GlossLocallyOwnedDof "locally owned degrees of freedom". - * These will then be used as starting indices for the local renumbering - * on the current processor. (In other words, this argument will in - * fact be different on every processor unless you pass an - * empty list as is the default.) + * algorithm, or to reverse the ordering. + * @param use_constraints Whether or not to use hanging node constraints in + * determining the reordering of degrees of freedom. + * @param starting_indices A set of degrees of freedom that form the first + * level of renumbered degrees of freedom. If the set is empty, then a + * single starting entry is chosen automatically among those that have the + * smallest number of others that couple with it. If the DoFHandler is built + * on a parallel triangulation, then on every processor, these starting + * indices need to be a (possibly empty) subset of the + * @ref GlossLocallyOwnedDof "locally owned degrees of freedom". + * These will then be used as starting indices for the local renumbering on + * the current processor. (In other words, this argument will in fact be + * different on every processor unless you pass an empty list as is the + * default.) */ template void @@ -632,8 +631,9 @@ namespace DoFRenumbering /** * Sort the degrees of freedom by component. It does the same thing as the - * above function, only that it does this for one single level of a multilevel - * discretization. The non-multigrid part of the the DoFHandler is not touched. + * above function, only that it does this for one single level of a + * multilevel discretization. The non-multigrid part of the the DoFHandler + * is not touched. */ template void @@ -675,9 +675,10 @@ namespace DoFRenumbering block_wise (DoFHandler &dof_handler); /** - * Sort the degrees of freedom by vector block. It does the same thing as the - * above function, only that it does this for one single level of a multilevel - * discretization. The non-multigrid part of the the DoFHandler is not touched. + * Sort the degrees of freedom by vector block. It does the same thing as + * the above function, only that it does this for one single level of a + * multilevel discretization. The non-multigrid part of the the DoFHandler + * is not touched. */ template void diff --git a/include/deal.II/dofs/dof_tools.h b/include/deal.II/dofs/dof_tools.h index 57ecea2e64..d8c492652f 100644 --- a/include/deal.II/dofs/dof_tools.h +++ b/include/deal.II/dofs/dof_tools.h @@ -363,12 +363,12 @@ namespace DoFTools * * The actual type of the sparsity pattern may be SparsityPattern, * DynamicSparsityPattern, BlockSparsityPattern, - * BlockDynamicSparsityPattern, or any other class that satisfies - * similar requirements. It is assumed that the size of the sparsity pattern - * matches the number of degrees of freedom and that enough unused nonzero - * entries are left to fill the sparsity pattern. The nonzero entries - * generated by this function are overlaid to possible previous content of - * the object, that is previously added entries are not deleted. + * BlockDynamicSparsityPattern, or any other class that satisfies similar + * requirements. It is assumed that the size of the sparsity pattern matches + * the number of degrees of freedom and that enough unused nonzero entries + * are left to fill the sparsity pattern. The nonzero entries generated by + * this function are overlaid to possible previous content of the object, + * that is previously added entries are not deleted. * * Since this process is purely local, the sparsity pattern does not provide * for entries introduced by the elimination of hanging nodes. They have to @@ -446,8 +446,8 @@ namespace DoFTools * * The actual type of the sparsity pattern may be SparsityPattern, * DynamicSparsityPattern, BlockSparsityPattern, - * BlockDynamicSparsityPattern, BlockDynamicSetSparsityPattern, or any - * other class that satisfies similar requirements. + * BlockDynamicSparsityPattern, BlockDynamicSetSparsityPattern, or any other + * class that satisfies similar requirements. * * There is a complication if some or all of the shape functions of the * finite element in use are non-zero in more than one component (in deal.II @@ -529,9 +529,9 @@ namespace DoFTools * * The actual type of the sparsity pattern may be SparsityPattern, * DynamicSparsityPattern, BlockSparsityPattern, - * BlockDynamicSparsityPattern, BlockDynamicSetSparsityPattern, or any - * other class that satisfies similar requirements. It is assumed that the - * size of the sparsity pattern is already correct. + * BlockDynamicSparsityPattern, BlockDynamicSetSparsityPattern, or any other + * class that satisfies similar requirements. It is assumed that the size of + * the sparsity pattern is already correct. */ template void @@ -1027,10 +1027,10 @@ namespace DoFTools * @ref GlossFaceOrientation "standard orientation". * * Instead of defining a 'first' and 'second' boundary with the help of two - * boundary_ids this function defines a 'left' boundary as all faces - * with local face index 2*dimension and boundary indicator @p - * b_id and, similarly, a 'right' boundary consisting of all face with local - * face index 2*dimension+1 and boundary indicator @p b_id. + * boundary_ids this function defines a 'left' boundary as all faces with + * local face index 2*dimension and boundary indicator @p b_id + * and, similarly, a 'right' boundary consisting of all face with local face + * index 2*dimension+1 and boundary indicator @p b_id. * * @note This version of make_periodicity_constraints will not work on * meshes with cells not in @@ -1202,10 +1202,10 @@ namespace DoFTools * of freedom is at the boundary and belongs to one of the selected * components, and @p false otherwise. The function is used in step-15. * - * By specifying the @p boundary_id variable, you can select which - * boundary indicators the faces have to have on which the degrees of - * freedom are located that shall be extracted. If it is an empty list, then - * all boundary indicators are accepted. + * By specifying the @p boundary_id variable, you can select which boundary + * indicators the faces have to have on which the degrees of freedom are + * located that shall be extracted. If it is an empty list, then all + * boundary indicators are accepted. * * The size of @p component_mask (see * @ref GlossComponentMask) @@ -1237,10 +1237,10 @@ namespace DoFTools * boundary (and correspond to the selected vector components and boundary * indicators, depending on the values of the @p component_mask and @p * boundary_ids arguments). - * @param boundary_ids If empty, this function extracts the indices - * of the degrees of freedom for all parts of the boundary. If it is a non- - * empty list, then the function only considers boundary faces with the - * boundary indicators listed in this argument. + * @param boundary_ids If empty, this function extracts the indices of the + * degrees of freedom for all parts of the boundary. If it is a non- empty + * list, then the function only considers boundary faces with the boundary + * indicators listed in this argument. * * @see * @ref GlossBoundaryIndicator "Glossary entry on boundary indicators" @@ -1274,10 +1274,10 @@ namespace DoFTools * boundary (and correspond to the selected vector components and boundary * indicators, depending on the values of the @p component_mask and @p * boundary_ids arguments). - * @param boundary_ids If empty, this function extracts the indices - * of the degrees of freedom for all parts of the boundary. If it is a non- - * empty list, then the function only considers boundary faces with the - * boundary indicators listed in this argument. + * @param boundary_ids If empty, this function extracts the indices of the + * degrees of freedom for all parts of the boundary. If it is a non- empty + * list, then the function only considers boundary faces with the boundary + * indicators listed in this argument. * * @see * @ref GlossBoundaryIndicator "Glossary entry on boundary indicators" @@ -2031,8 +2031,8 @@ namespace DoFTools * A variant of this function with different arguments is used in step-36. * * @param dof The DoFHandler to work on. - * @param boundary_id The indicator of that part of the boundary for - * which constraints should be computed. If this number equals + * @param boundary_id The indicator of that part of the boundary for which + * constraints should be computed. If this number equals * numbers::invalid_boundary_id then all boundaries of the domain will be * treated. * @param zero_boundary_constraints The constraint object into which the diff --git a/include/deal.II/fe/fe_bernstein.h b/include/deal.II/fe/fe_bernstein.h index fc6db35b3c..f55fd70789 100644 --- a/include/deal.II/fe/fe_bernstein.h +++ b/include/deal.II/fe/fe_bernstein.h @@ -27,35 +27,34 @@ DEAL_II_NAMESPACE_OPEN /*@{*/ /** - * Implementation of a scalar Bernstein finite element @p that we call FE_Bernstein - * in analogy with FE_Q that yields the - * finite element space of continuous, piecewise Bernstein polynomials of degree @p p in - * each coordinate direction. This class is realized using tensor product + * Implementation of a scalar Bernstein finite element @p that we call + * FE_Bernstein in analogy with FE_Q that yields the finite element space of + * continuous, piecewise Bernstein polynomials of degree @p p in each + * coordinate direction. This class is realized using tensor product * polynomials of Bernstein basis polynomials. * * * The standard constructor of this class takes the degree @p p of this finite * element. * - * For more information about the spacedim template parameter - * check the documentation of FiniteElement or the one of - * Triangulation. + * For more information about the spacedim template parameter check + * the documentation of FiniteElement or the one of Triangulation. * *

      Implementation

      * * The constructor creates a TensorProductPolynomials object that includes the - * tensor product of @p Bernstein polynomials of degree @p p. This - * @p TensorProductPolynomials object provides all values and derivatives of - * the shape functions. + * tensor product of @p Bernstein polynomials of degree @p p. This @p + * TensorProductPolynomials object provides all values and derivatives of the + * shape functions. * *

      Numbering of the degrees of freedom (DoFs)

      * * The original ordering of the shape functions represented by the - * TensorProductPolynomials is a tensor product - * numbering. However, the shape functions on a cell are renumbered - * beginning with the shape functions whose support points are at the - * vertices, then on the line, on the quads, and finally (for 3d) on - * the hexes. See the documentation of FE_Q for more details. + * TensorProductPolynomials is a tensor product numbering. However, the shape + * functions on a cell are renumbered beginning with the shape functions whose + * support points are at the vertices, then on the line, on the quads, and + * finally (for 3d) on the hexes. See the documentation of FE_Q for more + * details. * * * @author Marco Tezzele, Luca Heltai @@ -72,26 +71,26 @@ public: FE_Bernstein (const unsigned int p); /** - * Return the matrix interpolating from a face of one element to the face - * of the neighboring element. The size of the matrix is then - * source.dofs_per_face times this->dofs_per_face. The - * FE_Bernstein element family only provides interpolation matrices for elements of - * the same type and FE_Nothing. For all other elements, an exception of - * type FiniteElement::ExcInterpolationNotImplemented is - * thrown. - */ + * Return the matrix interpolating from a face of one element to the face of + * the neighboring element. The size of the matrix is then + * source.dofs_per_face times this->dofs_per_face. The + * FE_Bernstein element family only provides interpolation matrices for + * elements of the same type and FE_Nothing. For all other elements, an + * exception of type + * FiniteElement::ExcInterpolationNotImplemented is thrown. + */ virtual void get_face_interpolation_matrix (const FiniteElement &source, FullMatrix &matrix) const; /** - * Return the matrix interpolating from a face of one element to the face - * of the neighboring element. The size of the matrix is then + * Return the matrix interpolating from a face of one element to the face of + * the neighboring element. The size of the matrix is then * source.dofs_per_face times this->dofs_per_face. The - * FE_Bernstein element family only provides interpolation matrices for elements of - * the same type and FE_Nothing. For all other elements, an exception of - * type FiniteElement::ExcInterpolationNotImplemented is - * thrown. + * FE_Bernstein element family only provides interpolation matrices for + * elements of the same type and FE_Nothing. For all other elements, an + * exception of type + * FiniteElement::ExcInterpolationNotImplemented is thrown. */ virtual void get_subface_interpolation_matrix (const FiniteElement &source, @@ -155,8 +154,8 @@ public: /** * Return a string that uniquely identifies a finite element. This class - * returns FE_Bernstein(degree), with @p dim and @p degree replaced by - * appropriate values. + * returns FE_Bernstein(degree), with @p dim and @p degree + * replaced by appropriate values. */ virtual std::string get_name () const; diff --git a/include/deal.II/fe/fe_q_hierarchical.h b/include/deal.II/fe/fe_q_hierarchical.h index 4b7feab423..12916dd246 100644 --- a/include/deal.II/fe/fe_q_hierarchical.h +++ b/include/deal.II/fe/fe_q_hierarchical.h @@ -579,15 +579,14 @@ public: virtual bool hp_constraints_are_implemented () const; /** - * Return the matrix interpolating from the given finite element to the present one. - * Interpolation only between FE_Q_Hierarchical is supported. + * Return the matrix interpolating from the given finite element to the + * present one. Interpolation only between FE_Q_Hierarchical is supported. */ virtual void get_interpolation_matrix(const FiniteElement< dim> &source, FullMatrix< double > &matrix) const; /** - * Embedding matrix between grids. - * Only isotropic refinement is supported. + * Embedding matrix between grids. Only isotropic refinement is supported. */ virtual const FullMatrix &get_prolongation_matrix (const unsigned int child, diff --git a/include/deal.II/fe/fe_values.h b/include/deal.II/fe/fe_values.h index 25cc72a436..2799aecb6d 100644 --- a/include/deal.II/fe/fe_values.h +++ b/include/deal.II/fe/fe_values.h @@ -264,11 +264,10 @@ namespace FEValuesViews * FEValuesBase::get_function_values function but it only works on the * selected scalar component. * - * The data type stored by the output vector must be what you get - * when you multiply the values of shape functions (i.e., @p - * value_type) times the type used to store the values of the - * unknowns $U_j$ of your finite element vector $U$ (represented - * by the @p fe_function argument). + * The data type stored by the output vector must be what you get when you + * multiply the values of shape functions (i.e., @p value_type) times the + * type used to store the values of the unknowns $U_j$ of your finite + * element vector $U$ (represented by the @p fe_function argument). * * @dealiiRequiresUpdateFlags{update_values} */ @@ -286,11 +285,10 @@ namespace FEValuesViews * FEValuesBase::get_function_gradients function but it only works on the * selected scalar component. * - * The data type stored by the output vector must be what you get - * when you multiply the gradients of shape functions (i.e., @p - * gradient_type) times the type used to store the values of the - * unknowns $U_j$ of your finite element vector $U$ (represented - * by the @p fe_function argument). + * The data type stored by the output vector must be what you get when you + * multiply the gradients of shape functions (i.e., @p gradient_type) + * times the type used to store the values of the unknowns $U_j$ of your + * finite element vector $U$ (represented by the @p fe_function argument). * * @dealiiRequiresUpdateFlags{update_gradients} */ @@ -308,11 +306,10 @@ namespace FEValuesViews * FEValuesBase::get_function_hessians function but it only works on the * selected scalar component. * - * The data type stored by the output vector must be what you get - * when you multiply the Hessians of shape functions (i.e., @p - * hessian_type) times the type used to store the values of the - * unknowns $U_j$ of your finite element vector $U$ (represented - * by the @p fe_function argument). + * The data type stored by the output vector must be what you get when you + * multiply the Hessians of shape functions (i.e., @p hessian_type) times + * the type used to store the values of the unknowns $U_j$ of your finite + * element vector $U$ (represented by the @p fe_function argument). * * @dealiiRequiresUpdateFlags{update_hessians} */ @@ -331,11 +328,10 @@ namespace FEValuesViews * FEValuesBase::get_function_laplacians function but it only works on the * selected scalar component. * - * The data type stored by the output vector must be what you get - * when you multiply the Laplacians of shape functions (i.e., @p - * value_type) times the type used to store the values of the - * unknowns $U_j$ of your finite element vector $U$ (represented - * by the @p fe_function argument). + * The data type stored by the output vector must be what you get when you + * multiply the Laplacians of shape functions (i.e., @p value_type) times + * the type used to store the values of the unknowns $U_j$ of your finite + * element vector $U$ (represented by the @p fe_function argument). * * @dealiiRequiresUpdateFlags{update_hessians} */ @@ -622,11 +618,10 @@ namespace FEValuesViews * FEValuesBase::get_function_values function but it only works on the * selected vector components. * - * The data type stored by the output vector must be what you get - * when you multiply the values of shape functions (i.e., @p - * value_type) times the type used to store the values of the - * unknowns $U_j$ of your finite element vector $U$ (represented - * by the @p fe_function argument). + * The data type stored by the output vector must be what you get when you + * multiply the values of shape functions (i.e., @p value_type) times the + * type used to store the values of the unknowns $U_j$ of your finite + * element vector $U$ (represented by the @p fe_function argument). * * @dealiiRequiresUpdateFlags{update_values} */ @@ -644,11 +639,10 @@ namespace FEValuesViews * FEValuesBase::get_function_gradients function but it only works on the * selected vector components. * - * The data type stored by the output vector must be what you get - * when you multiply the gradients of shape functions (i.e., @p - * gradient_type) times the type used to store the values of the - * unknowns $U_j$ of your finite element vector $U$ (represented - * by the @p fe_function argument). + * The data type stored by the output vector must be what you get when you + * multiply the gradients of shape functions (i.e., @p gradient_type) + * times the type used to store the values of the unknowns $U_j$ of your + * finite element vector $U$ (represented by the @p fe_function argument). * * @dealiiRequiresUpdateFlags{update_gradients} */ @@ -671,11 +665,11 @@ namespace FEValuesViews * but the information can be obtained from * FEValuesBase::get_function_gradients, of course. * - * The data type stored by the output vector must be what you get - * when you multiply the symmetric gradients of shape functions (i.e., @p + * The data type stored by the output vector must be what you get when you + * multiply the symmetric gradients of shape functions (i.e., @p * symmetric_gradient_type) times the type used to store the values of the - * unknowns $U_j$ of your finite element vector $U$ (represented - * by the @p fe_function argument). + * unknowns $U_j$ of your finite element vector $U$ (represented by the @p + * fe_function argument). * * @dealiiRequiresUpdateFlags{update_gradients} */ @@ -695,11 +689,10 @@ namespace FEValuesViews * information can be obtained from FEValuesBase::get_function_gradients, * of course. * - * The data type stored by the output vector must be what you get - * when you multiply the divergences of shape functions (i.e., @p - * divergence_type) times the type used to store the values of the - * unknowns $U_j$ of your finite element vector $U$ (represented - * by the @p fe_function argument). + * The data type stored by the output vector must be what you get when you + * multiply the divergences of shape functions (i.e., @p divergence_type) + * times the type used to store the values of the unknowns $U_j$ of your + * finite element vector $U$ (represented by the @p fe_function argument). * * @dealiiRequiresUpdateFlags{update_gradients} */ @@ -718,11 +711,10 @@ namespace FEValuesViews * information can be obtained from FEValuesBase::get_function_gradients, * of course. * - * The data type stored by the output vector must be what you get - * when you multiply the curls of shape functions (i.e., @p - * curl_type) times the type used to store the values of the - * unknowns $U_j$ of your finite element vector $U$ (represented - * by the @p fe_function argument). + * The data type stored by the output vector must be what you get when you + * multiply the curls of shape functions (i.e., @p curl_type) times the + * type used to store the values of the unknowns $U_j$ of your finite + * element vector $U$ (represented by the @p fe_function argument). * * @dealiiRequiresUpdateFlags{update_gradients} */ @@ -740,11 +732,10 @@ namespace FEValuesViews * FEValuesBase::get_function_hessians function but it only works on the * selected vector components. * - * The data type stored by the output vector must be what you get - * when you multiply the Hessians of shape functions (i.e., @p - * hessian_type) times the type used to store the values of the - * unknowns $U_j$ of your finite element vector $U$ (represented - * by the @p fe_function argument). + * The data type stored by the output vector must be what you get when you + * multiply the Hessians of shape functions (i.e., @p hessian_type) times + * the type used to store the values of the unknowns $U_j$ of your finite + * element vector $U$ (represented by the @p fe_function argument). * * @dealiiRequiresUpdateFlags{update_hessians} */ @@ -763,11 +754,10 @@ namespace FEValuesViews * FEValuesBase::get_function_laplacians function but it only works on the * selected vector components. * - * The data type stored by the output vector must be what you get - * when you multiply the Laplacians of shape functions (i.e., @p - * laplacian_type) times the type used to store the values of the - * unknowns $U_j$ of your finite element vector $U$ (represented - * by the @p fe_function argument). + * The data type stored by the output vector must be what you get when you + * multiply the Laplacians of shape functions (i.e., @p laplacian_type) + * times the type used to store the values of the unknowns $U_j$ of your + * finite element vector $U$ (represented by the @p fe_function argument). * * @dealiiRequiresUpdateFlags{update_hessians} */ @@ -955,11 +945,10 @@ namespace FEValuesViews * FEValuesBase::get_function_values function but it only works on the * selected vector components. * - * The data type stored by the output vector must be what you get - * when you multiply the values of shape functions (i.e., @p - * value_type) times the type used to store the values of the - * unknowns $U_j$ of your finite element vector $U$ (represented - * by the @p fe_function argument). + * The data type stored by the output vector must be what you get when you + * multiply the values of shape functions (i.e., @p value_type) times the + * type used to store the values of the unknowns $U_j$ of your finite + * element vector $U$ (represented by the @p fe_function argument). * * @dealiiRequiresUpdateFlags{update_values} */ @@ -981,11 +970,10 @@ namespace FEValuesViews * See the general discussion of this class for a definition of the * divergence. * - * The data type stored by the output vector must be what you get - * when you multiply the divergences of shape functions (i.e., @p - * divergence_type) times the type used to store the values of the - * unknowns $U_j$ of your finite element vector $U$ (represented - * by the @p fe_function argument). + * The data type stored by the output vector must be what you get when you + * multiply the divergences of shape functions (i.e., @p divergence_type) + * times the type used to store the values of the unknowns $U_j$ of your + * finite element vector $U$ (represented by the @p fe_function argument). * * @dealiiRequiresUpdateFlags{update_gradients} */ @@ -1161,11 +1149,10 @@ namespace FEValuesViews * FEValuesBase::get_function_values function but it only works on the * selected vector components. * - * The data type stored by the output vector must be what you get - * when you multiply the values of shape functions (i.e., @p - * value_type) times the type used to store the values of the - * unknowns $U_j$ of your finite element vector $U$ (represented - * by the @p fe_function argument). + * The data type stored by the output vector must be what you get when you + * multiply the values of shape functions (i.e., @p value_type) times the + * type used to store the values of the unknowns $U_j$ of your finite + * element vector $U$ (represented by the @p fe_function argument). * * @dealiiRequiresUpdateFlags{update_values} */ @@ -1188,11 +1175,10 @@ namespace FEValuesViews * See the general discussion of this class for a definition of the * divergence. * - * The data type stored by the output vector must be what you get - * when you multiply the divergences of shape functions (i.e., @p - * divergence_type) times the type used to store the values of the - * unknowns $U_j$ of your finite element vector $U$ (represented - * by the @p fe_function argument). + * The data type stored by the output vector must be what you get when you + * multiply the divergences of shape functions (i.e., @p divergence_type) + * times the type used to store the values of the unknowns $U_j$ of your + * finite element vector $U$ (represented by the @p fe_function argument). * * @dealiiRequiresUpdateFlags{update_gradients} */ @@ -1738,13 +1724,11 @@ public: * * @param[out] values The values of the function specified by fe_function at * the quadrature points of the current cell. The object is assume to - * already have the correct size. - * The data type stored by this output vector must be what you get - * when you multiply the values of shape function - * times the type used to store the values of the - * unknowns $U_j$ of your finite element vector $U$ (represented - * by the @p fe_function argument). This happens to be equal to the - * type of the elements of the solution vector. + * already have the correct size. The data type stored by this output vector + * must be what you get when you multiply the values of shape function times + * the type used to store the values of the unknowns $U_j$ of your finite + * element vector $U$ (represented by the @p fe_function argument). This + * happens to be equal to the type of the elements of the solution vector. * * @post values[q] will contain the value of the field * described by fe_function at the $q$th quadrature point. @@ -1887,12 +1871,11 @@ public: * @param[out] gradients The gradients of the function specified by * fe_function at the quadrature points of the current cell. The gradients * are computed in real space (as opposed to on the unit cell). The object - * is assume to already have the correct size. - * The data type stored by this output vector must be what you get - * when you multiply the gradients of shape function times the type - * used to store the values of the - * unknowns $U_j$ of your finite element vector $U$ (represented - * by the @p fe_function argument). + * is assume to already have the correct size. The data type stored by this + * output vector must be what you get when you multiply the gradients of + * shape function times the type used to store the values of the unknowns + * $U_j$ of your finite element vector $U$ (represented by the @p + * fe_function argument). * * @post gradients[q] will contain the gradient of the field * described by fe_function at the $q$th quadrature point. @@ -1978,12 +1961,11 @@ public: * @param[out] hessians The Hessians of the function specified by * fe_function at the quadrature points of the current cell. The Hessians * are computed in real space (as opposed to on the unit cell). The object - * is assume to already have the correct size. - * The data type stored by this output vector must be what you get - * when you multiply the Hessians of shape function times the type - * used to store the values of the - * unknowns $U_j$ of your finite element vector $U$ (represented - * by the @p fe_function argument). + * is assume to already have the correct size. The data type stored by this + * output vector must be what you get when you multiply the Hessians of + * shape function times the type used to store the values of the unknowns + * $U_j$ of your finite element vector $U$ (represented by the @p + * fe_function argument). * * @post hessians[q] will contain the Hessian of the field * described by fe_function at the $q$th quadrature point. @@ -2069,13 +2051,12 @@ public: * @param[out] laplacians The Laplacians of the function specified by * fe_function at the quadrature points of the current cell. The Laplacians * are computed in real space (as opposed to on the unit cell). The object - * is assume to already have the correct size. - * The data type stored by this output vector must be what you get - * when you multiply the Laplacians of shape function times the type - * used to store the values of the - * unknowns $U_j$ of your finite element vector $U$ (represented - * by the @p fe_function argument). This happens to be equal to the - * type of the elements of the input vector. + * is assume to already have the correct size. The data type stored by this + * output vector must be what you get when you multiply the Laplacians of + * shape function times the type used to store the values of the unknowns + * $U_j$ of your finite element vector $U$ (represented by the @p + * fe_function argument). This happens to be equal to the type of the + * elements of the input vector. * * @post laplacians[q] will contain the Laplacian of the field * described by fe_function at the $q$th quadrature point. diff --git a/include/deal.II/fe/mapping_fe_field.h b/include/deal.II/fe/mapping_fe_field.h index f37648afa9..23fbcdf404 100644 --- a/include/deal.II/fe/mapping_fe_field.h +++ b/include/deal.II/fe/mapping_fe_field.h @@ -32,28 +32,27 @@ DEAL_II_NAMESPACE_OPEN /*@{*/ /** - * The MappingFEField is a generalization of the MappingQEulerian - * class, for arbitrary vector finite elements. The two main - * differences are that this class uses a vector of absolute positions - * instead of a vector of displacements, and it allows for arbitrary - * FiniteElement types, instead of only FE_Q. + * The MappingFEField is a generalization of the MappingQEulerian class, for + * arbitrary vector finite elements. The two main differences are that this + * class uses a vector of absolute positions instead of a vector of + * displacements, and it allows for arbitrary FiniteElement types, instead of + * only FE_Q. * * This class effectively decouples the topology from the geometry, by * relegating all geometrical information to some components of a - * FiniteElement vector field. The components that are used for the - * geometry can be arbitrarily selected at construction time. + * FiniteElement vector field. The components that are used for the geometry + * can be arbitrarily selected at construction time. * - * The idea is to consider the Triangulation as a parameter - * configuration space, on which we construct an arbitrary - * geometrical mapping, using the instruments of the deal.II library: - * a vector of degrees of freedom, a DoFHandler associated to the - * geometry of the problem and a ComponentMask that tells us which - * components of the FiniteElement to use for the mapping. + * The idea is to consider the Triangulation as a parameter configuration + * space, on which we construct an arbitrary geometrical mapping, using the + * instruments of the deal.II library: a vector of degrees of freedom, a + * DoFHandler associated to the geometry of the problem and a ComponentMask + * that tells us which components of the FiniteElement to use for the mapping. * - * Typically, the DoFHandler operates on a finite element that is - * constructed as a system element (FESystem()) from continuous FE_Q() - * (for iso-parametric discretizations) or FE_Bernstein() (for - * iso-geometric discretizations) objects. An example is shown below: + * Typically, the DoFHandler operates on a finite element that is constructed + * as a system element (FESystem()) from continuous FE_Q() (for iso-parametric + * discretizations) or FE_Bernstein() (for iso-geometric discretizations) + * objects. An example is shown below: * * @code * const FE_Q feq(1); @@ -80,33 +79,30 @@ public: * transformation of the domain from the reference to the current * configuration. * - * In general this class decouples geometry from topology, allowing - * users to define geometries which are only topologically - * equivalent to the underlying Triangulation, but which may - * otherwise be arbitrary. Differently from what happens in - * MappingQEulerian, the FiniteElement field which is passed to the - * constructor is interpreted as an absolute geometrical - * configuration, therefore one has to make sure that the - * euler_vector actually represents a valid geometry (i.e., one with - * no inverted cells, or with no zero-volume cells). + * In general this class decouples geometry from topology, allowing users to + * define geometries which are only topologically equivalent to the + * underlying Triangulation, but which may otherwise be arbitrary. + * Differently from what happens in MappingQEulerian, the FiniteElement + * field which is passed to the constructor is interpreted as an absolute + * geometrical configuration, therefore one has to make sure that the + * euler_vector actually represents a valid geometry (i.e., one with no + * inverted cells, or with no zero-volume cells). * - * If the underlying FiniteElement is a system of FE_Q(), and - * euler_vector is initialized using - * VectorTools::get_position_vector(), then this class is in all - * respects identical to MappingQ(). + * If the underlying FiniteElement is a system of FE_Q(), and euler_vector + * is initialized using VectorTools::get_position_vector(), then this class + * is in all respects identical to MappingQ(). * * The optional ComponentMask argument can be used to specify what * components of the FiniteElement to use for the geometrical - * transformation. If no mask is specified at construction time, - * then a default one is used, which makes this class works in the - * same way of MappingQEulerian(), i.e., the first spacedim - * components of the FiniteElement are assumed to represent the - * geometry of the problem. + * transformation. If no mask is specified at construction time, then a + * default one is used, which makes this class works in the same way of + * MappingQEulerian(), i.e., the first spacedim components of the + * FiniteElement are assumed to represent the geometry of the problem. * * Notice that if a mask is specified, it has to match in size the - * underlying FiniteElement, and it has to have exactly spacedim - * non-zero elements, indicating the components (in order) of the - * FiniteElement which will be used for the geometry. + * underlying FiniteElement, and it has to have exactly spacedim non-zero + * elements, indicating the components (in order) of the FiniteElement which + * will be used for the geometry. * * If an incompatible mask is passed, an exception is thrown. */ @@ -143,7 +139,8 @@ public: const typename Triangulation::cell_iterator &cell, const Point &p) const; - /** Reimplemented from Mapping. See the documentation of the base class for + /** + * Reimplemented from Mapping. See the documentation of the base class for * detailed information. */ virtual void @@ -152,7 +149,8 @@ public: const typename Mapping::InternalDataBase &internal, const MappingType type) const; - /** Reimplemented from Mapping. See the documentation of the base class for + /** + * Reimplemented from Mapping. See the documentation of the base class for * detailed information. */ virtual void @@ -161,7 +159,8 @@ public: const typename Mapping::InternalDataBase &internal, const MappingType type) const; - /** Reimplemented from Mapping. See the documentation of the base class for + /** + * Reimplemented from Mapping. See the documentation of the base class for * detailed information. */ virtual @@ -194,8 +193,7 @@ public: /** - * Storage for internal data of - * d-linear transformation. + * Storage for internal data of d-linear transformation. */ class InternalData : public Mapping::InternalDataBase { @@ -207,118 +205,83 @@ public: const ComponentMask mask); /** - * Shape function at quadrature - * point. Shape functions are - * in tensor product order, so - * vertices must be reordered - * to obtain transformation. + * Shape function at quadrature point. Shape functions are in tensor + * product order, so vertices must be reordered to obtain transformation. */ double shape (const unsigned int qpoint, const unsigned int shape_nr) const; /** - * Shape function at quadrature - * point. See above. + * Shape function at quadrature point. See above. */ double &shape (const unsigned int qpoint, const unsigned int shape_nr); /** - * Gradient of shape function - * in quadrature point. See - * above. + * Gradient of shape function in quadrature point. See above. */ Tensor<1,dim> derivative (const unsigned int qpoint, const unsigned int shape_nr) const; /** - * Gradient of shape function - * in quadrature point. See - * above. + * Gradient of shape function in quadrature point. See above. */ Tensor<1,dim> &derivative (const unsigned int qpoint, const unsigned int shape_nr); /** - * Second derivative of shape - * function in quadrature - * point. See above. + * Second derivative of shape function in quadrature point. See above. */ Tensor<2,dim> second_derivative (const unsigned int qpoint, const unsigned int shape_nr) const; /** - * Second derivative of shape - * function in quadrature - * point. See above. + * Second derivative of shape function in quadrature point. See above. */ Tensor<2,dim> &second_derivative (const unsigned int qpoint, const unsigned int shape_nr); /** - * Return an estimate (in - * bytes) or the memory - * consumption of this - * object. + * Return an estimate (in bytes) or the memory consumption of this object. */ virtual std::size_t memory_consumption () const; /** - * Values of shape - * functions. Access by - * function @p shape. + * Values of shape functions. Access by function @p shape. * * Computed once. */ std::vector shape_values; /** - * Values of shape function - * derivatives. Access by - * function @p derivative. + * Values of shape function derivatives. Access by function @p derivative. * * Computed once. */ std::vector > shape_derivatives; /** - * Values of shape function - * second derivatives. Access - * by function - * @p second_derivative. + * Values of shape function second derivatives. Access by function @p + * second_derivative. * * Computed once. */ std::vector > shape_second_derivatives; /** - * Tensors of covariant - * transformation at each of - * the quadrature points. The - * matrix stored is the - * Jacobian * G^{-1}, - * where G = Jacobian^{t} * Jacobian, - * is the first fundamental - * form of the map; - * if dim=spacedim then - * it reduces to the transpose of the - * inverse of the Jacobian - * matrix, which itself is - * stored in the - * @p contravariant field of - * this structure. + * Tensors of covariant transformation at each of the quadrature points. + * The matrix stored is the Jacobian * G^{-1}, where G = Jacobian^{t} * + * Jacobian, is the first fundamental form of the map; if dim=spacedim + * then it reduces to the transpose of the inverse of the Jacobian matrix, + * which itself is stored in the @p contravariant field of this structure. * * Computed on each cell. */ std::vector > covariant; /** - * Tensors of contravariant - * transformation at each of - * the quadrature points. The - * contravariant matrix is - * the Jacobian of the - * transformation, + * Tensors of contravariant transformation at each of the quadrature + * points. The contravariant matrix is the Jacobian of the transformation, * i.e. $J_{ij}=dx_i/d\hat x_j$. * * Computed on each cell. @@ -326,24 +289,15 @@ public: std::vector< DerivativeForm<1,dim,spacedim> > contravariant; /** - * Unit tangential vectors. Used - * for the computation of - * boundary forms and normal - * vectors. + * Unit tangential vectors. Used for the computation of boundary forms and + * normal vectors. * - * This vector has - * (dim-1)GeometryInfo::faces_per_cell - * entries. The first - * GeometryInfo::faces_per_cell - * contain the vectors in the first - * tangential direction for each - * face; the second set of - * GeometryInfo::faces_per_cell - * entries contain the vectors in the - * second tangential direction (only - * in 3d, since there we have 2 - * tangential directions per face), - * etc. + * This vector has (dim-1)GeometryInfo::faces_per_cell entries. The first + * GeometryInfo::faces_per_cell contain the vectors in the first + * tangential direction for each face; the second set of + * GeometryInfo::faces_per_cell entries contain the vectors in the second + * tangential direction (only in 3d, since there we have 2 tangential + * directions per face), etc. * * Filled once. */ @@ -355,54 +309,42 @@ public: std::vector > > aux; /** - * Number of shape functions. If this is a Q1 mapping, then it is - * simply the number of vertices per cell. However, since also - * derived classes use this class (e.g. the Mapping_Q() class), - * the number of shape functions may also be different. + * Number of shape functions. If this is a Q1 mapping, then it is simply + * the number of vertices per cell. However, since also derived classes + * use this class (e.g. the Mapping_Q() class), the number of shape + * functions may also be different. */ unsigned int n_shape_functions; /** - * Stores the mask given at construction time. If no mask was - * specified at construction time, then a default one is used, - * which makes this class works in the same way of - * MappingQEulerian(), i.e., the first spacedim components of the - * FiniteElement are used for the euler_vector and the euler_dh. + * Stores the mask given at construction time. If no mask was specified at + * construction time, then a default one is used, which makes this class + * works in the same way of MappingQEulerian(), i.e., the first spacedim + * components of the FiniteElement are used for the euler_vector and the + * euler_dh. * * If a mask is specified, then it has to match the underlying - * FiniteElement, and it has to have exactly spacedim non-zero - * elements, indicating the components (in order) of the - * FiniteElement which will be used for the euler vector and the - * euler dof handler. + * FiniteElement, and it has to have exactly spacedim non-zero elements, + * indicating the components (in order) of the FiniteElement which will be + * used for the euler vector and the euler dof handler. */ ComponentMask mask; }; /** - * Transforms a point @p p on - * the unit cell to the point - * @p p_real on the real cell - * @p cell and returns @p p_real. + * Transforms a point @p p on the unit cell to the point @p p_real on the + * real cell @p cell and returns @p p_real. * - * This function is called by - * @p transform_unit_to_real_cell - * and multiple times (through the - * Newton iteration) by - * @p transform_real_to_unit_cell_internal. + * This function is called by @p transform_unit_to_real_cell and multiple + * times (through the Newton iteration) by @p + * transform_real_to_unit_cell_internal. * - * Takes a reference to an - * @p InternalData that must - * already include the shape - * values at point @p p and the - * mapping support points of the - * cell. + * Takes a reference to an @p InternalData that must already include the + * shape values at point @p p and the mapping support points of the cell. * - * This @p InternalData argument - * avoids multiple computations - * of the shape values at point - * @p p and especially multiple - * computations of the mapping + * This @p InternalData argument avoids multiple computations of the shape + * values at point @p p and especially multiple computations of the mapping * support points. */ Point @@ -410,34 +352,18 @@ public: /** - * Transforms the point @p p on - * the real cell to the corresponding - * point on the unit cell - * @p cell by a Newton - * iteration. + * Transforms the point @p p on the real cell to the corresponding point on + * the unit cell @p cell by a Newton iteration. * - * Takes a reference to an - * @p InternalData that is - * assumed to be previously - * created by the @p get_data - * function with @p UpdateFlags - * including - * @p update_transformation_values - * and - * @p update_transformation_gradients - * and a one point Quadrature - * that includes the given - * initial guess for the - * transformation - * @p initial_p_unit. Hence this - * function assumes that - * @p mdata already includes the - * transformation shape values - * and gradients computed at - * @p initial_p_unit. + * Takes a reference to an @p InternalData that is assumed to be previously + * created by the @p get_data function with @p UpdateFlags including @p + * update_transformation_values and @p update_transformation_gradients and a + * one point Quadrature that includes the given initial guess for the + * transformation @p initial_p_unit. Hence this function assumes that @p + * mdata already includes the transformation shape values and gradients + * computed at @p initial_p_unit. * - * @p mdata will be changed by - * this function. + * @p mdata will be changed by this function. */ Point transform_real_to_unit_cell_internal (const typename Triangulation::cell_iterator &cell, @@ -446,8 +372,7 @@ public: InternalData &mdata) const; /** - * Do the computation for the - * fill_* functions. + * Do the computation for the fill_* functions. */ void compute_fill (const typename Triangulation::cell_iterator &cell, const unsigned int npts, @@ -458,8 +383,7 @@ public: /** - * Do the computation for the - * fill_* functions. + * Do the computation for the fill_* functions. */ void compute_fill_face (const typename Triangulation::cell_iterator &cell, const unsigned int face_no, @@ -533,10 +457,10 @@ protected: /** - This function and the next allow to generate the transform require by - the virtual transform() in mapping, but unfortunately in C++ one cannot - declare a virtual template function. - */ + * This function and the next allow to generate the transform require by the + * virtual transform() in mapping, but unfortunately in C++ one cannot + * declare a virtual template function. + */ template < int rank > void transform_fields(const VectorSlice > > input, @@ -546,7 +470,7 @@ protected: /** - see doc in transform_fields + * see doc in transform_fields */ template < int rank > void @@ -559,16 +483,16 @@ protected: protected: /** - * Reference to the vector of shifts. - */ + * Reference to the vector of shifts. + */ SmartPointer >euler_vector; /** - * A FiniteElement object which is only needed in 3D, since it knows how to reorder - * shape functions/DoFs on non-standard faces. This is used to reorder - * support points in the same way. We could make this a pointer to prevent - * construction in 1D and 2D, but since memory and time requirements are not - * particularly high this seems unnecessary at the moment. + * A FiniteElement object which is only needed in 3D, since it knows how to + * reorder shape functions/DoFs on non-standard faces. This is used to + * reorder support points in the same way. We could make this a pointer to + * prevent construction in 1D and 2D, but since memory and time requirements + * are not particularly high this seems unnecessary at the moment. */ SmartPointer, MappingFEField > fe; @@ -587,39 +511,43 @@ private: void update_internal_dofs(const typename Triangulation::cell_iterator &cell) const; /** - * It stores the local degrees of freedom of the DH for each cell - * (i.e. euler_vector * dof_indices, see method update_internal_dofs for more + * It stores the local degrees of freedom of the DH for each cell (i.e. + * euler_vector * dof_indices, see method update_internal_dofs for more * clarifications.). */ mutable Threads::ThreadLocalStorage > local_dof_values; /** * Store the degrees of freedom of the DH for each cell (i.e. - * cell->get_dof_indices(dof_indices), see method update_internal_dofs for more - * clarifications.). Thread safe. + * cell->get_dof_indices(dof_indices), see method update_internal_dofs for + * more clarifications.). Thread safe. */ mutable Threads::ThreadLocalStorage > local_dof_indices; - /** Reimplemented from Mapping. See the documentation of the base class for + /** + * Reimplemented from Mapping. See the documentation of the base class for * detailed information. */ virtual void compute_shapes_virtual (const std::vector > &unit_points, typename MappingFEField::InternalData &data) const; - /** Reimplemented from Mapping. See the documentation of the base class for + /** + * Reimplemented from Mapping. See the documentation of the base class for * detailed information. */ virtual UpdateFlags update_once (const UpdateFlags in) const; - /** Reimplemented from Mapping. See the documentation of the base class for + /** + * Reimplemented from Mapping. See the documentation of the base class for * detailed information. */ virtual UpdateFlags update_each (const UpdateFlags in) const; - /** Reimplemented from Mapping. See the documentation of the base class for + /** + * Reimplemented from Mapping. See the documentation of the base class for * detailed information. */ void @@ -628,7 +556,8 @@ private: const unsigned int n_original_q_points, InternalData &data) const; - /** Reimplemented from Mapping. See the documentation of the base class for + /** + * Reimplemented from Mapping. See the documentation of the base class for * detailed information. */ void @@ -637,7 +566,8 @@ private: const unsigned int n_original_q_points, InternalData &data) const; - /** Reimplemented from Mapping. See the documentation of the base class for + /** + * Reimplemented from Mapping. See the documentation of the base class for * detailed information. */ virtual @@ -645,7 +575,8 @@ private: get_data (const UpdateFlags, const Quadrature &quadrature) const; - /** Reimplemented from Mapping. See the documentation of the base class for + /** + * Reimplemented from Mapping. See the documentation of the base class for * detailed information. */ virtual @@ -653,7 +584,8 @@ private: get_face_data (const UpdateFlags flags, const Quadrature& quadrature) const; - /** Reimplemented from Mapping. See the documentation of the base class for + /** + * Reimplemented from Mapping. See the documentation of the base class for * detailed information. */ virtual @@ -669,12 +601,13 @@ private: /** - * Mapping between indices in the FE space and the real space. This vector contains one - * index for each component of the finite element space. If the index is one for which - * the ComponentMask which is used to construct this element is false, then - * numbers::invalid_unsigned_int is returned, otherwise the component in real space is - * returned. For example, if we construct the mapping using ComponentMask(spacedim, true), - * then this vector contains {0,1,2} in spacedim = 3. + * Mapping between indices in the FE space and the real space. This vector + * contains one index for each component of the finite element space. If the + * index is one for which the ComponentMask which is used to construct this + * element is false, then numbers::invalid_unsigned_int is returned, + * otherwise the component in real space is returned. For example, if we + * construct the mapping using ComponentMask(spacedim, true), then this + * vector contains {0,1,2} in spacedim = 3. */ std::vector fe_to_real; diff --git a/include/deal.II/fe/mapping_q_eulerian.h b/include/deal.II/fe/mapping_q_eulerian.h index 54138e986e..a28a81ddcd 100644 --- a/include/deal.II/fe/mapping_q_eulerian.h +++ b/include/deal.II/fe/mapping_q_eulerian.h @@ -94,26 +94,23 @@ public: /** * Constructor. * - * @param[in] degree The polynomical degree of the desired - * $Q_p$ mapping. - * @param[in] euler_dof_handler A DoFHandler object that defines a - * finite element space. This space needs to have at least dim - * components and the first dim components of the space will - * be considered displacements relative to the original positions - * of the cells of the triangulation. - * @param[in] euler_vector A finite element function in the - * space defined by the second argument. The first dim components - * of this function will be interpreted as the displacement we - * use in definining the mapping, relative to the location of cells - * of the underlying triangulation. + * @param[in] degree The polynomical degree of the desired $Q_p$ mapping. + * @param[in] euler_dof_handler A DoFHandler object that defines a finite + * element space. This space needs to have at least dim components and the + * first dim components of the space will be considered displacements + * relative to the original positions of the cells of the triangulation. + * @param[in] euler_vector A finite element function in the space defined by + * the second argument. The first dim components of this function will be + * interpreted as the displacement we use in definining the mapping, + * relative to the location of cells of the underlying triangulation. */ MappingQEulerian (const unsigned int degree, const DoFHandler &euler_dof_handler, const VECTOR &euler_vector); /** - * @deprecated Use the constructor with the reverse order of - * second and third argument. + * @deprecated Use the constructor with the reverse order of second and + * third argument. */ MappingQEulerian (const unsigned int degree, const VECTOR &euler_vector, diff --git a/include/deal.II/grid/grid_generator.h b/include/deal.II/grid/grid_generator.h index 183c8c3e6a..3073ffc5fe 100644 --- a/include/deal.II/grid/grid_generator.h +++ b/include/deal.II/grid/grid_generator.h @@ -79,11 +79,10 @@ namespace GridGenerator /** * \brief Mesh of a d-simplex with (d+1) vertices and mesh cells, resp. * - * The @p vertices argument contains a vector with all d+1 vertices - * of the simplex. They must be given in an order such that - * the vectors from the first vertex to each of the others form a - * right-handed system. And I am not happy about the discrimination - * involved here. + * The @p vertices argument contains a vector with all d+1 vertices of the + * simplex. They must be given in an order such that the vectors from the + * first vertex to each of the others form a right-handed system. And I am + * not happy about the discrimination involved here. * * The meshes generated in two and three dimensions are * @@ -120,21 +119,20 @@ namespace GridGenerator * Create a coordinate-parallel brick from the two diagonally opposite * corner points @p p1 and @p p2. * - * If the @p colorize flag is set, the @p boundary_ids of the - * surfaces are assigned, such that the lower one in @p x-direction is 0, - * the upper one is 1. The indicators for the surfaces in @p y-direction are - * 2 and 3, the ones for @p z are 4 and 5. Additionally, material ids are - * assigned to the cells according to the octant their center is in: being - * in the right half plane for any coordinate direction xi - * adds 2i. For instance, the center point (1,-1,1) yields a - * material id 5. - * - * @note If spacedim>dim the same mesh as in the case spacedim=dim - * is created, but the vertices have all additional coordinates - * equal to the coordinates of p1, i.e., we generate a - * hyper_rectangle parallel to the x-axis (1d), or to the xy-axis - * passing through p1. The additional coordinates of the point p2 - * are ignored by this class in this case. + * If the @p colorize flag is set, the @p boundary_ids of the surfaces are + * assigned, such that the lower one in @p x-direction is 0, the upper one + * is 1. The indicators for the surfaces in @p y-direction are 2 and 3, the + * ones for @p z are 4 and 5. Additionally, material ids are assigned to the + * cells according to the octant their center is in: being in the right half + * plane for any coordinate direction xi adds + * 2i. For instance, the center point (1,-1,1) yields a material + * id 5. + * + * @note If spacedim>dim the same mesh as in the case spacedim=dim is + * created, but the vertices have all additional coordinates equal to the + * coordinates of p1, i.e., we generate a hyper_rectangle parallel to the + * x-axis (1d), or to the xy-axis passing through p1. The additional + * coordinates of the point p2 are ignored by this class in this case. * * @note The triangulation needs to be void upon calling this function. */ @@ -155,12 +153,12 @@ namespace GridGenerator * a list of integers denoting the number of subdivisions in each coordinate * direction. * - * If the @p colorize flag is set, the @p boundary_ids of the - * surfaces are assigned, such that the lower one in @p x-direction is 0, - * the upper one is 1 (the left and the right vertical face). The indicators - * for the surfaces in @p y-direction are 2 and 3, the ones for @p z are 4 - * and 5. Additionally, material ids are assigned to the cells according to - * the octant their center is in: being in the right half plane for any + * If the @p colorize flag is set, the @p boundary_ids of the surfaces are + * assigned, such that the lower one in @p x-direction is 0, the upper one + * is 1 (the left and the right vertical face). The indicators for the + * surfaces in @p y-direction are 2 and 3, the ones for @p z are 4 and 5. + * Additionally, material ids are assigned to the cells according to the + * octant their center is in: being in the right half plane for any * coordinate direction xi adds 2i. For * instance, the center point (1,-1,1) yields a material id 5 (this means * that in 2d only material ids 0,1,2,3 are assigned independent from the @@ -227,11 +225,11 @@ namespace GridGenerator /** * \brief Rectangular domain with rectangular pattern of holes * - * The domain itself is rectangular, very much as if it had been - * generated by subdivided_hyper_rectangle(). The argument holes - * specifies how many square holes the domain should have in each - * coordinate direction. The total number of mesh cells in that - * direction is then twice this number plus one. + * The domain itself is rectangular, very much as if it had been generated + * by subdivided_hyper_rectangle(). The argument holes + * specifies how many square holes the domain should have in each coordinate + * direction. The total number of mesh cells in that direction is then twice + * this number plus one. * * The number of holes in one direction must be at least one. * @@ -434,36 +432,33 @@ namespace GridGenerator const double half_length = 1.0); /** - * \brief A center cell with stacks of cell protruding from each surface. - * - * Each of the square mesh cells is Cartesian and has size one in each - * coordinate direction. The center of cell number zero is the - * origin. - * - * @param tria A Triangulation object which has to be empty. - * - * @param sizes A vector of integers of dimension - * GeometryInfo::faces_per_cell with the following meaning: the - * legs of the cross are stacked on the faces of the center cell, - * in the usual order of deal.II cells, namely first $-x$, then $x$, - * then $-y$ and so on. The corresponding entries in - * sizes name the number of cells stacked on this - * face. All numbers may be zero, thus L- and T-shaped domains are - * specializations of this domain. - * - * @param colorize_cells If colorization is chosen, then the material - * id of a cells corresponds to the leg it is in. The id of the - * center cell is zero, and then the legs are numbered starting at - * one. - * - * Examples in two and three dimensions are - * + * \brief A center cell with stacks of cell protruding from each surface. + * + * Each of the square mesh cells is Cartesian and has size one in each + * coordinate direction. The center of cell number zero is the origin. + * + * @param tria A Triangulation object which has to be empty. + * + * @param sizes A vector of integers of dimension + * GeometryInfo::faces_per_cell with the following meaning: the legs of + * the cross are stacked on the faces of the center cell, in the usual order + * of deal.II cells, namely first $-x$, then $x$, then $-y$ and so on. The + * corresponding entries in sizes name the number of cells + * stacked on this face. All numbers may be zero, thus L- and T-shaped + * domains are specializations of this domain. + * + * @param colorize_cells If colorization is chosen, then the material id of + * a cells corresponds to the leg it is in. The id of the center cell is + * zero, and then the legs are numbered starting at one. + * + * Examples in two and three dimensions are + * * @image html hyper_cross_2d.png * @image html hyper_cross_3d.png - * - * @author Guido Kanschat - * @date 2015 - */ + * + * @author Guido Kanschat + * @date 2015 + */ template void hyper_cross(Triangulation &tria, const std::vector &sizes, @@ -588,9 +583,9 @@ namespace GridGenerator * computed adaptively such that the resulting elements have the least * aspect ratio. * - * If colorize is set to true, the inner, outer, and the part of the boundary - * where $x=0$, get indicator 0, 1, and 2, respectively. Otherwise all - * indicators are set to 0. + * If colorize is set to true, the inner, outer, and the part of the + * boundary where $x=0$, get indicator 0, 1, and 2, respectively. Otherwise + * all indicators are set to 0. * * @note The triangulation needs to be void upon calling this function. */ @@ -788,9 +783,9 @@ namespace GridGenerator * from meshes for simpler geometries, then this is not the function for * you. Instead, consider GridGenerator::merge_triangulations(). * - * @pre Both of the source conditions need to be available entirely - * locally. In other words, they can not be objects of type - * parallel::distributed::Triangulation. + * @pre Both of the source conditions need to be available entirely locally. + * In other words, they can not be objects of type + * parallel::distributed::Triangulation. */ template void @@ -799,36 +794,36 @@ namespace GridGenerator Triangulation &result); /** - * This function creates a triangulation that consists of the same cells - * as are present in the first argument, except those cells that are listed - * in the second argument. The purpose of the function is to generate + * This function creates a triangulation that consists of the same cells as + * are present in the first argument, except those cells that are listed in + * the second argument. The purpose of the function is to generate * geometries subtractively from the geometry described by an * existing triangulation. A prototypical case is a 2d domain with * rectangular holes. This can be achieved by first meshing the entire - * domain and then using this function to get rid of the cells that - * are located at the holes. Likewise, you could create the mesh - * that GridGenerator::hyper_L() produces by starting with a - * GridGenerator::hyper_cube(), refining it once, and then calling - * the current function with a single cell in the second argument. + * domain and then using this function to get rid of the cells that are + * located at the holes. Likewise, you could create the mesh that + * GridGenerator::hyper_L() produces by starting with a + * GridGenerator::hyper_cube(), refining it once, and then calling the + * current function with a single cell in the second argument. * * @param[in] input_triangulation The original triangulation that serves as - * the template from which the new one is to be created. + * the template from which the new one is to be created. * @param[in] cells_to_remove A list of cells of the triangulation provided - * as first argument that should be removed (i.e., that should not - * show up in the result. + * as first argument that should be removed (i.e., that should not show up + * in the result. * @param[out] result The resulting triangulation that consists of the same - * cells as are in @p input_triangulation, with the exception of the cells - * listed in @p cells_to_remove. + * cells as are in @p input_triangulation, with the exception of the cells + * listed in @p cells_to_remove. * * @pre Because we cannot create triangulations de novo that contain - * adaptively refined cells, the input triangulation needs to have all - * of its cells on the same level. Oftentimes, this will in fact be - * the coarsest level, but it is allowed to pass in a triangulation - * that has been refined globally a number of times. The output - * triangulation will in that case simply be a mesh with only one - * level that consists of the active cells of the input minus the - * ones listed in the second argument. However, the input triangulation - * must not have been adaptively refined. + * adaptively refined cells, the input triangulation needs to have all of + * its cells on the same level. Oftentimes, this will in fact be the + * coarsest level, but it is allowed to pass in a triangulation that has + * been refined globally a number of times. The output triangulation + * will in that case simply be a mesh with only one level that consists of + * the active cells of the input minus the ones listed in the second + * argument. However, the input triangulation must not have been + * adaptively refined. */ template void diff --git a/include/deal.II/grid/grid_refinement.h b/include/deal.II/grid/grid_refinement.h index f0127282ff..7a37b23b77 100644 --- a/include/deal.II/grid/grid_refinement.h +++ b/include/deal.II/grid/grid_refinement.h @@ -49,29 +49,31 @@ namespace GridRefinement { /** * Return a pair of double values of which the first is adjusted refinement - * fraction of cells and the second is adjusted coarsening fraction of cells. + * fraction of cells and the second is adjusted coarsening fraction of + * cells. * * * @arg @p current_n_cells is current cell number. * - * @arg @p max_n_cells is the maximal number of cells. If current cell number - * @p current_n_cells is already exceeded maximal cell number @p max_n_cells, - * refinement fraction of cells will be set to zero and coarsening fraction - * of cells will be adjusted to reduce cell number to @ max_n_cells. - * If cell number is going to be exceeded only upon refinement, then refinement - * and coarsening fractions are going to be adjusted with a same ratio in - * an attempt to reach the maximum number of cells. - * Be aware though that through proliferation of refinement due to - * Triangulation::MeshSmoothing, this number is only an indicator. - * The default value of this argument is to impose no limit on the number - * of cells. + * @arg @p max_n_cells is the maximal number of cells. If current cell + * number @p current_n_cells is already exceeded maximal cell number @p + * max_n_cells, refinement fraction of cells will be set to zero and + * coarsening fraction of cells will be adjusted to reduce cell number to @ + * max_n_cells. If cell number is going to be exceeded only upon refinement, + * then refinement and coarsening fractions are going to be adjusted with a + * same ratio in an attempt to reach the maximum number of cells. Be aware + * though that through proliferation of refinement due to + * Triangulation::MeshSmoothing, this number is only an indicator. The + * default value of this argument is to impose no limit on the number of + * cells. * * @arg @p top_fraction is the requested fraction of cells to be refined. * - * @arg @p bottom_fraction is the requested fraction of cells to be coarsened. + * @arg @p bottom_fraction is the requested fraction of cells to be + * coarsened. * - * @note Usually you do not need to call this function explicitly. Pass - * @p max_n_cells to function refine_and_coarsen_fixed_number() or function + * @note Usually you do not need to call this function explicitly. Pass @p + * max_n_cells to function refine_and_coarsen_fixed_number() or function * refine_and_coarsen_fixed_fraction() and they will call this function if * necessary. */ diff --git a/include/deal.II/grid/grid_tools.h b/include/deal.II/grid/grid_tools.h index 97faef1ab7..46285086b0 100644 --- a/include/deal.II/grid/grid_tools.h +++ b/include/deal.II/grid/grid_tools.h @@ -297,10 +297,10 @@ namespace GridTools const Function *coefficient = 0); /** - * Returns a std::map with all vertices of faces located in the boundary - * - * @param[in] tria The Triangulation object. - */ + * Returns a std::map with all vertices of faces located in the boundary + * + * @param[in] tria The Triangulation object. + */ template std::map > get_all_vertices_at_boundary (const Triangulation &tria); @@ -1115,10 +1115,10 @@ namespace GridTools * @ref GlossFaceOrientation "standard orientation". * * Instead of defining a 'first' and 'second' boundary with the help of two - * boundary_ids this function defines a 'left' boundary as all faces - * with local face index 2*dimension and boundary indicator @p - * b_id and, similarly, a 'right' boundary consisting of all face with local - * face index 2*dimension+1 and boundary indicator @p b_id. + * boundary_ids this function defines a 'left' boundary as all faces with + * local face index 2*dimension and boundary indicator @p b_id + * and, similarly, a 'right' boundary consisting of all face with local face + * index 2*dimension+1 and boundary indicator @p b_id. * * This function will collect periodic face pairs on the coarsest mesh level * and add them to @p matched_pairs leaving the original contents intact. diff --git a/include/deal.II/grid/tria.h b/include/deal.II/grid/tria.h index c1ef230397..045953c948 100644 --- a/include/deal.II/grid/tria.h +++ b/include/deal.II/grid/tria.h @@ -438,14 +438,14 @@ namespace internal * quite inconvenient if one attempted to operate on it directly, since data * is spread over quite a lot of arrays and other places. However, there are * ways powerful enough to work on these data structures without knowing their - * exact relations. deal.II uses class local typedefs (see below) to make things - * as easy and dimension independent as possible. + * exact relations. deal.II uses class local typedefs (see below) to make + * things as easy and dimension independent as possible. * * The Triangulation class provides iterators which enable looping over all * cells without knowing the exact representation used to describe them. For - * more information see the documentation of TriaIterator. Their names - * are typedefs imported from the Iterators class (thus making them local types - * to this class) and are as follows: + * more information see the documentation of TriaIterator. Their + * names are typedefs imported from the Iterators class (thus making them + * local types to this class) and are as follows: * *
        *
      • cell_iterator: loop over all cells used in the Triangulation @@ -479,8 +479,8 @@ namespace internal * * Usage of these iterators is similar to usage of standard container * iterators. Some examples taken from the Triangulation source code follow - * (notice that in the last two examples the template parameter @p spacedim has - * been omitted, so it takes the default value dim). + * (notice that in the last two examples the template parameter @p spacedim + * has been omitted, so it takes the default value dim). * *
          *
        • Counting the number of cells on a specific level @@ -3029,8 +3029,8 @@ private: void clear_despite_subscriptions (); /** - * For all cells, set the active cell indices so that active cells know - * the how many-th active cell they are, and all other cells have an invalid + * For all cells, set the active cell indices so that active cells know the + * how many-th active cell they are, and all other cells have an invalid * value. This function is called after mesh creation, refinement, and * serialization. */ @@ -3130,8 +3130,8 @@ private: * fields of this class that can be modified by the TriaAccessor hierarchy * are pointers, and so these accessor classes store a const pointer to the * triangulation. We could no longer do so for TriaAccessor<0,1,spacedim> if - * this field (that can be modified by TriaAccessor::set_boundary_id) - * were not a pointer. + * this field (that can be modified by TriaAccessor::set_boundary_id) were + * not a pointer. */ std::map *vertex_to_boundary_id_map_1d; @@ -3152,8 +3152,8 @@ private: * fields of this class that can be modified by the TriaAccessor hierarchy * are pointers, and so these accessor classes store a const pointer to the * triangulation. We could no longer do so for TriaAccessor<0,1,spacedim> if - * this field (that can be modified by TriaAccessor::set_boundary_id) - * were not a pointer. + * this field (that can be modified by TriaAccessor::set_boundary_id) were + * not a pointer. */ std::map *vertex_to_manifold_id_map_1d; diff --git a/include/deal.II/grid/tria_accessor.h b/include/deal.II/grid/tria_accessor.h index aac2081527..935f7d2f22 100644 --- a/include/deal.II/grid/tria_accessor.h +++ b/include/deal.II/grid/tria_accessor.h @@ -886,16 +886,16 @@ public: types::boundary_id boundary_indicator () const DEAL_II_DEPRECATED; /** - * Set the boundary indicator of the current object. The same applies as for the - * boundary_id() function. + * Set the boundary indicator of the current object. The same applies as for + * the boundary_id() function. * * This function only sets the boundary object of the current object itself, * not the indicators of the ones that bound it. For example, in 3d, if this * function is called on a face, then the boundary indicator of the 4 edges * that bound the face remain unchanged. If you want to set the boundary * indicators of face and edges at the same time, use the - * set_all_boundary_ids() function. You can see the result of not - * using the correct function in the results section of step-49. + * set_all_boundary_ids() function. You can see the result of not using the + * correct function in the results section of step-49. * * @warning You should never set the boundary indicator of an interior face * (a face not at the boundary of the domain), or set set the boundary @@ -925,12 +925,12 @@ public: void set_boundary_indicator (const types::boundary_id) const DEAL_II_DEPRECATED; /** - * Do as set_boundary_id() but also set the boundary indicators of - * the objects that bound the current object. For example, in 3d, if - * set_boundary_id() is called on a face, then the boundary indicator - * of the 4 edges that bound the face remain unchanged. In contrast, if you - * call the current function, the boundary indicators of face and edges are - * all set to the given value. + * Do as set_boundary_id() but also set the boundary indicators of the + * objects that bound the current object. For example, in 3d, if + * set_boundary_id() is called on a face, then the boundary indicator of the + * 4 edges that bound the face remain unchanged. In contrast, if you call + * the current function, the boundary indicators of face and edges are all + * set to the given value. * * This function is useful if you set boundary indicators of faces in 3d (in * 2d, the function does the same as set_boundary_id()) and you do so @@ -2450,35 +2450,33 @@ public: bool direction_flag () const; /** - * Return the how many-th active cell the current cell is (assuming - * the current cell is indeed active). This is useful, for example, - * if you are accessing the elements of a vector with as many - * entries as there are active cells. Such vectors are used for - * estimating the error on each cell of a triangulation, for - * specifying refinement criteria passed to the functions in - * GridRefinement, and for generating cell-wise output. + * Return the how many-th active cell the current cell is (assuming the + * current cell is indeed active). This is useful, for example, if you are + * accessing the elements of a vector with as many entries as there are + * active cells. Such vectors are used for estimating the error on each cell + * of a triangulation, for specifying refinement criteria passed to the + * functions in GridRefinement, and for generating cell-wise output. * - * The function throws an exception if the current cell is not - * active. + * The function throws an exception if the current cell is not active. * - * @note If the triangulation this function is called on is - * of type parallel::distributed::Triangulation, then active - * cells may be locally owned, ghost cells, or artificial - * (see + * @note If the triangulation this function is called on is of type + * parallel::distributed::Triangulation, then active cells may be locally + * owned, ghost cells, or artificial (see * @ref GlossLocallyOwnedCell, - * @ref GlossGhostCell, and + * @ref GlossGhostCell, + * and * @ref GlossArtificialCell). - * This function counts over all of - * them, including ghost and artificial active cells. + * This function counts over all of them, including ghost and artificial + * active cells. */ unsigned int active_cell_index () const; /** - * Return the index of the parent of this cell within the level of the triangulation to - * which the parent cell belongs. The level of the parent is of course one - * lower than that of the present cell. If the parent does not exist (i.e., - * if the object is at the coarsest level of the mesh hierarchy), an - * exception is generated. + * Return the index of the parent of this cell within the level of the + * triangulation to which the parent cell belongs. The level of the parent + * is of course one lower than that of the present cell. If the parent does + * not exist (i.e., if the object is at the coarsest level of the mesh + * hierarchy), an exception is generated. */ int parent_index () const; @@ -2680,7 +2678,8 @@ protected: private: /** - * Set the active cell index of a cell. This is done at the end of refinement. + * Set the active cell index of a cell. This is done at the end of + * refinement. */ void set_active_cell_index (const unsigned int active_cell_index); diff --git a/include/deal.II/grid/tria_iterator.h b/include/deal.II/grid/tria_iterator.h index c1d72e9ba6..bca384278b 100644 --- a/include/deal.II/grid/tria_iterator.h +++ b/include/deal.II/grid/tria_iterator.h @@ -120,9 +120,9 @@ template class TriaActiveIterator; * * Furthermore, the iterators described here satisfy the requirement of input * and bidirectional iterators as stated by the C++ standard. It is therefore - * possible to use the functions from the algorithm section of the C++ standard, - * e.g., count_if (see the documentation for Triangulation for an - * example) and several others. + * possible to use the functions from the algorithm section of the C++ + * standard, e.g., count_if (see the documentation for Triangulation + * for an example) and several others. * *

          Implementation

          * diff --git a/include/deal.II/grid/tria_levels.h b/include/deal.II/grid/tria_levels.h index f8502d0388..1c0ab04172 100644 --- a/include/deal.II/grid/tria_levels.h +++ b/include/deal.II/grid/tria_levels.h @@ -72,9 +72,9 @@ namespace internal /** - * An integer that, for every active cell, stores the how - * many-th active cell this is. For non-active cells, this value - * is unused and set to an invalid value. + * An integer that, for every active cell, stores the how many-th active + * cell this is. For non-active cells, this value is unused and set to + * an invalid value. */ std::vector active_cell_indices; @@ -208,9 +208,9 @@ namespace internal //TODO: Replace TriaObjectsHex to avoid this specialization /** - * Specialization of TriaLevels for 3D. Since we need - * TriaObjectsHex instead of TriaObjects. Refer to the - * documentation of the general class template for details. + * Specialization of TriaLevels for 3D. Since we need TriaObjectsHex + * instead of TriaObjects. Refer to the documentation of the general class + * template for details. */ template<> class TriaLevel<3> diff --git a/include/deal.II/lac/arpack_solver.h b/include/deal.II/lac/arpack_solver.h index 048ff9929a..1d036936e1 100644 --- a/include/deal.II/lac/arpack_solver.h +++ b/include/deal.II/lac/arpack_solver.h @@ -76,13 +76,12 @@ extern "C" void dneupd_(int *rvec, char *howmany, int *select, double *d, * dnaupd work and also how to set the parameters appropriately * please take a look into the ARPACK manual. * - * @note Whenever you eliminate degrees of freedom using - * ConstraintMatrix, you generate spurious eigenvalues and - * eigenvectors. If you make sure that the diagonals of eliminated - * matrix rows are all equal to one, you get a single additional - * eigenvalue. But beware that some functions in deal.II set these - * diagonals to rather arbitrary (from the point of view of - * eigenvalue problems) values. See also + * @note Whenever you eliminate degrees of freedom using ConstraintMatrix, you + * generate spurious eigenvalues and eigenvectors. If you make sure that the + * diagonals of eliminated matrix rows are all equal to one, you get a single + * additional eigenvalue. But beware that some functions in deal.II set these + * diagonals to rather arbitrary (from the point of view of eigenvalue + * problems) values. See also * @ref step_36 "step-36" * for an example. * @@ -140,40 +139,38 @@ public: /** * Solve the generalized eigensprectrum problem $A x=\lambda B x$ by calling - * the dneupd and dnaupd functions of - * ARPACK. + * the dneupd and dnaupd functions of ARPACK. * - * The function returns a vector of eigenvalues of length n - * and a vector of eigenvectors, where the latter should be twice - * the size of the eigenvalue vector. The first n vectors in - * eigenvectors will be the real parts of the - * eigenvectors, the second n the imaginary parts. + * The function returns a vector of eigenvalues of length n and a + * vector of eigenvectors, where the latter should be twice the size of the + * eigenvalue vector. The first n vectors in + * eigenvectors will be the real parts of the eigenvectors, the + * second n the imaginary parts. * - * @param A The operator for which we want to compute - * eigenvalues. Actually, this parameter is entirely unused. + * @param A The operator for which we want to compute eigenvalues. Actually, + * this parameter is entirely unused. * - * @param B The inner product of the underlying space, typically the - * mass matrix. For constrained problems, it can be a partial mass - * matrix, like for instance the velocity mass matrix of a Stokes - * problem. Only its function vmult() is used. + * @param B The inner product of the underlying space, typically the mass + * matrix. For constrained problems, it can be a partial mass matrix, like + * for instance the velocity mass matrix of a Stokes problem. Only its + * function vmult() is used. * - * @param inverse This is the possibly shifted inverse that is - * actually used instead of A. Only its function - * vmult() is used. + * @param inverse This is the possibly shifted inverse that is actually used + * instead of A. Only its function vmult() is + * used. * * @param eigenvalues is a vector of complex numbers in which the * eigenvalues are returned. * - * @param eigenvectors is a real vector of eigenvectors, - * containing alternatingly the real parts and the imaginary parts of the - * eigenvectors. Therefore, its length should be twice the number of - * eigenvalues. The vectors have to be initialized to match the - * matrices. + * @param eigenvectors is a real vector of eigenvectors, containing + * alternatingly the real parts and the imaginary parts of the eigenvectors. + * Therefore, its length should be twice the number of eigenvalues. The + * vectors have to be initialized to match the matrices. * - * @param n_eigenvalues The purpose of this parameter is not clear, - * but it is safe to set it to the size of eigenvalues - * or greater. Leave it at its default zero, which will be reset to the size - * of eigenvalues internally. + * @param n_eigenvalues The purpose of this parameter is not clear, but it + * is safe to set it to the size of eigenvalues or greater. + * Leave it at its default zero, which will be reset to the size of + * eigenvalues internally. */ template diff --git a/include/deal.II/lac/block_linear_operator.h b/include/deal.II/lac/block_linear_operator.h index 6df1d1d8b7..6bc4b2d5f3 100644 --- a/include/deal.II/lac/block_linear_operator.h +++ b/include/deal.II/lac/block_linear_operator.h @@ -36,16 +36,16 @@ template class BlockVector; /** * @relates LinearOperator * - * A function that encapsulates a given collection @p ops of - * LinearOperators into a block structure. Hereby, it is assumed that Range - * and Domain are blockvectors, i.e., derived from + * A function that encapsulates a given collection @p ops of LinearOperators + * into a block structure. Hereby, it is assumed that Range and Domain are + * blockvectors, i.e., derived from * @ref BlockVectorBase. * The individual linear operators in @p ops must act on a the underlying * vector type of the block vectors, i.e., on Domain::BlockType yielding a * result in Range::BlockType. * - * The list @p ops is best passed as an initializer list. Consider for - * example a linear operator block (acting on Vector) + * The list @p ops is best passed as an initializer list. Consider for example + * a linear operator block (acting on Vector) * @code * op_a00 | op_a01 * | @@ -148,14 +148,14 @@ block_operator(const std::array) - * diag(op_a0, op_a1, ..., op_am). The coresponding - * block_operator invocation takes the form + * The list @p ops is best passed as an initializer list. Consider for example + * a linear operator block (acting on Vector) diag(op_a0, op_a1, + * ..., op_am). The coresponding block_operator invocation takes the + * form * @code * block_diagonal_operator>({op_00, op_a1, ..., op_am}); * @endcode @@ -241,8 +241,8 @@ block_diagonal_operator(const std::arraymatrix to be based on - * the same sparsity pattern as the calling matrix. + * Depending on MatrixType, however, additional restrictions might arise. + * Some sparse matrix formats require matrix to be based on the + * same sparsity pattern as the calling matrix. */ void add (const value_type factor, const BlockMatrixBase &matrix); diff --git a/include/deal.II/lac/block_sparse_matrix_ez.h b/include/deal.II/lac/block_sparse_matrix_ez.h index 27e7ff8b25..9e0985a386 100644 --- a/include/deal.II/lac/block_sparse_matrix_ez.h +++ b/include/deal.II/lac/block_sparse_matrix_ez.h @@ -150,8 +150,8 @@ public: bool empty () const; /** - * Return number of rows of this matrix, which equals the dimension of - * the codomain (or range) space. It is the sum of the number of rows over the + * Return number of rows of this matrix, which equals the dimension of the + * codomain (or range) space. It is the sum of the number of rows over the * sub-matrix blocks of this matrix. * * @deprecated Use m() instead. @@ -160,16 +160,16 @@ public: /** * Return number of columns of this matrix, which equals the dimension of - * the domain space. It is the sum of the number of columns over the - * sub-matrix blocks of this matrix. + * the domain space. It is the sum of the number of columns over the sub- + * matrix blocks of this matrix. * * @deprecated Use n() instead. */ size_type n_cols () const DEAL_II_DEPRECATED; /** - * Return number of rows of this matrix, which equals the dimension of - * the codomain (or range) space. It is the sum of the number of rows over the + * Return number of rows of this matrix, which equals the dimension of the + * codomain (or range) space. It is the sum of the number of rows over the * sub-matrix blocks of this matrix. Recall that the matrix is of size m() * times n(). */ @@ -177,9 +177,9 @@ public: /** * Return number of columns of this matrix, which equals the dimension of - * the domain space. It is the sum of the number of columns over the - * sub-matrix blocks of this matrix. Recall that the matrix is of size m() - * times n(). + * the domain space. It is the sum of the number of columns over the sub- + * matrix blocks of this matrix. Recall that the matrix is of size m() times + * n(). */ size_type n () const; diff --git a/include/deal.II/lac/block_sparsity_pattern.h b/include/deal.II/lac/block_sparsity_pattern.h index fefee68d7b..974734c6fa 100644 --- a/include/deal.II/lac/block_sparsity_pattern.h +++ b/include/deal.II/lac/block_sparsity_pattern.h @@ -57,10 +57,10 @@ namespace TrilinosWrappers * patterns. * * The largest difference between the SparsityPattern and - * DynamicSparsityPattern classes and this class is that mostly, the - * matrices have different properties and you will want to work on the blocks - * making up the matrix rather than the whole matrix. You can access the - * different blocks using the block(row,col) function. + * DynamicSparsityPattern classes and this class is that mostly, the matrices + * have different properties and you will want to work on the blocks making up + * the matrix rather than the whole matrix. You can access the different + * blocks using the block(row,col) function. * * Attention: this object is not automatically notified if the size of one of * its subobjects' size is changed. After you initialize the sizes of the @@ -441,10 +441,9 @@ public: std::size_t memory_consumption () const; /** - * Copy data from an object of type BlockDynamicSparsityPattern, i.e. - * resize this object to the size of the given argument, and copy over the - * contents of each of the subobjects. Previous content of this object is - * lost. + * Copy data from an object of type BlockDynamicSparsityPattern, i.e. resize + * this object to the size of the given argument, and copy over the contents + * of each of the subobjects. Previous content of this object is lost. */ void copy_from (const BlockDynamicSparsityPattern &dsp); }; diff --git a/include/deal.II/lac/block_vector.h b/include/deal.II/lac/block_vector.h index 61a3be70ee..8be1587045 100644 --- a/include/deal.II/lac/block_vector.h +++ b/include/deal.II/lac/block_vector.h @@ -88,8 +88,8 @@ public: /** * Constructor. There are three ways to use this constructor. First, without * any arguments, it generates an object with no blocks. Given one argument, - * it initializes n_blocks blocks, but these blocks have size - * zero. The third variant finally initializes all blocks to the same size + * it initializes n_blocks blocks, but these blocks have size zero. + * The third variant finally initializes all blocks to the same size * block_size. * * Confer the other constructor further down if you intend to use blocks of @@ -107,8 +107,8 @@ public: #ifdef DEAL_II_WITH_CXX11 /** - * Move constructor. Creates a new vector by stealing the internal data - * of the vector @p v. + * Move constructor. Creates a new vector by stealing the internal data of + * the vector @p v. * * @note This constructor is only available if deal.II is configured with * C++11 support. @@ -203,11 +203,11 @@ public: #ifdef DEAL_II_WITH_CXX11 /** - * Move the given vector. This operator replaces the present vector with - * @p v by efficiently swapping the internal data structures. + * Move the given vector. This operator replaces the present vector with @p + * v by efficiently swapping the internal data structures. * - * @note This operator is only available if deal.II is configured with - * C++11 support. + * @note This operator is only available if deal.II is configured with C++11 + * support. */ BlockVector &operator= (BlockVector &&v); #endif @@ -503,8 +503,8 @@ namespace internal template class ReinitHelper; /** - * A helper class internally used in linear_operator.h. - * Specialization for BlockVector. + * A helper class internally used in linear_operator.h. Specialization for + * BlockVector. */ template class ReinitHelper > diff --git a/include/deal.II/lac/chunk_sparse_matrix.h b/include/deal.II/lac/chunk_sparse_matrix.h index 7c3c0b6903..28cbb39eee 100644 --- a/include/deal.II/lac/chunk_sparse_matrix.h +++ b/include/deal.II/lac/chunk_sparse_matrix.h @@ -415,8 +415,8 @@ public: typedef types::global_dof_index size_type; /** - * Type of matrix entries. This typedef is analogous to value_type in - * the standard library containers. + * Type of matrix entries. This typedef is analogous to value_type + * in the standard library containers. */ typedef number value_type; @@ -584,14 +584,14 @@ public: bool empty () const; /** - * Return the dimension of the codomain (or range) space. To remember: - * the matrix is of dimension $m \times n$. + * Return the dimension of the codomain (or range) space. To remember: the + * matrix is of dimension $m \times n$. */ size_type m () const; /** - * Return the dimension of the domain space. To remember: the matrix is - * of dimension $m \times n$. + * Return the dimension of the domain space. To remember: the matrix is of + * dimension $m \times n$. */ size_type n () const; @@ -1137,8 +1137,8 @@ public: iterator end (); /** - * Iterator starting at the first entry of row r. This is the version - * for constant matrices. + * Iterator starting at the first entry of row r. This is the + * version for constant matrices. * * Note that if the given row is empty, i.e. does not contain any nonzero * entries, then the iterator returned by this function equals @@ -1169,8 +1169,8 @@ public: const_iterator end (const unsigned int r) const; /** - * Iterator starting at the first entry of row r. This is the version - * for non-constant matrices. + * Iterator starting at the first entry of row r. This is the + * version for non-constant matrices. * * Note that if the given row is empty, i.e. does not contain any nonzero * entries, then the iterator returned by this function equals diff --git a/include/deal.II/lac/chunk_sparsity_pattern.h b/include/deal.II/lac/chunk_sparsity_pattern.h index c30c2dc306..4ecaa669d0 100644 --- a/include/deal.II/lac/chunk_sparsity_pattern.h +++ b/include/deal.II/lac/chunk_sparsity_pattern.h @@ -277,9 +277,9 @@ public: * statements like v.push_back (ChunkSparsityPattern());, with * v a vector of ChunkSparsityPattern objects. * - * Usually, it is sufficient to use the explicit keyword to disallow unwanted - * temporaries, but this does not work for std::vector. Since - * copying a structure like this is not useful anyway because multiple + * Usually, it is sufficient to use the explicit keyword to disallow + * unwanted temporaries, but this does not work for std::vector. + * Since copying a structure like this is not useful anyway because multiple * matrices can use the same sparsity structure, copies are only allowed for * empty objects, as described above. */ @@ -481,9 +481,9 @@ public: const size_type chunk_size); /** - * Copy data from an object of type DynamicSparsityPattern. Previous - * content of this object is lost, and the sparsity pattern is in compressed - * mode afterwards. + * Copy data from an object of type DynamicSparsityPattern. Previous content + * of this object is lost, and the sparsity pattern is in compressed mode + * afterwards. */ template void copy_from (const SparsityType &dsp, @@ -621,8 +621,9 @@ public: bool stores_only_added_elements () const; /** - * Iterator starting at the first entry of the matrix. The resulting iterator - * can be used to walk over all nonzero entries of the sparsity pattern. + * Iterator starting at the first entry of the matrix. The resulting + * iterator can be used to walk over all nonzero entries of the sparsity + * pattern. */ iterator begin () const; diff --git a/include/deal.II/lac/constraint_matrix.h b/include/deal.II/lac/constraint_matrix.h index d2549ae3b9..4073d22682 100644 --- a/include/deal.II/lac/constraint_matrix.h +++ b/include/deal.II/lac/constraint_matrix.h @@ -989,17 +989,16 @@ public: */ /** - * Given a vector, set all constrained degrees of freedom to values - * so that the constraints are satisfied. For example, if the - * current object stores the constraint $x_3=\frac 12 x_1 + \frac 12 - * x_2$, then this function will read the values of $x_1$ and $x_1$ - * from the given vector and set the element $x_3$ according to this - * constraints. Similarly, if the current object stores the - * constraint $x_42=208$, then this function will set the 42nd - * element of the given vector to 208. - * - * @note If this function is called with a parallel vector @p vec, - * then the vector must not contain ghost elements. + * Given a vector, set all constrained degrees of freedom to values so that + * the constraints are satisfied. For example, if the current object stores + * the constraint $x_3=\frac 12 x_1 + \frac 12 x_2$, then this function will + * read the values of $x_1$ and $x_1$ from the given vector and set the + * element $x_3$ according to this constraints. Similarly, if the current + * object stores the constraint $x_42=208$, then this function will set the + * 42nd element of the given vector to 208. + * + * @note If this function is called with a parallel vector @p vec, then the + * vector must not contain ghost elements. */ template void distribute (VectorType &vec) const; diff --git a/include/deal.II/lac/dynamic_sparsity_pattern.h b/include/deal.II/lac/dynamic_sparsity_pattern.h index 977d369a19..d7e4629ca5 100644 --- a/include/deal.II/lac/dynamic_sparsity_pattern.h +++ b/include/deal.II/lac/dynamic_sparsity_pattern.h @@ -52,8 +52,7 @@ namespace DynamicSparsityPatternIterators typedef types::global_dof_index size_type; /** - * Accessor class for iterators into objects of type - * DynamicSparsityPattern. + * Accessor class for iterators into objects of type DynamicSparsityPattern. * * Note that this class only allows read access to elements, providing their * row and column number (or alternatively the index within the complete @@ -119,17 +118,16 @@ namespace DynamicSparsityPatternIterators unsigned int current_row; /** - * A pointer to the element within the current row that we - * currently point to. + * A pointer to the element within the current row that we currently point + * to. */ std::vector::const_iterator current_entry; /** - * A pointer to the end of the current row. We store this - * to make comparison against the end of line iterator - * cheaper as it otherwise needs to do the IndexSet translation - * from row index to the index within the 'lines' array - * of DynamicSparsityPattern. + * A pointer to the end of the current row. We store this to make + * comparison against the end of line iterator cheaper as it otherwise + * needs to do the IndexSet translation from row index to the index within + * the 'lines' array of DynamicSparsityPattern. */ std::vector::const_iterator end_of_row; @@ -152,24 +150,23 @@ namespace DynamicSparsityPatternIterators * The typical use for these iterators is to iterate over the elements of a * sparsity pattern (or, since they also serve as the basis for iterating * over the elements of an associated matrix, over the elements of a sparse - * matrix), or over the elements of individual rows. There is no - * guarantee that the elements of a row are actually traversed in an order - * in which column numbers monotonically increase. See the documentation of the + * matrix), or over the elements of individual rows. There is no guarantee + * that the elements of a row are actually traversed in an order in which + * column numbers monotonically increase. See the documentation of the * SparsityPattern class for more information. * - * @note This class operates directly on the internal data - * structures of the DynamicSparsityPattern class. As a consequence, some - * operations are cheap and some are not. In particular, it is cheap - * to access the column index of the sparsity pattern entry pointed - * to. On the other hand, it is expensive to compute the distance - * between two iterators. As a consequence, when you design - * algorithms that use these iterators, it is common practice to not - * loop over all elements of a sparsity pattern at once, but - * to have an outer loop over all rows and within this loop iterate - * over the elements of this row. This way, you only ever need to - * dereference the iterator to obtain the column indices whereas the - * (expensive) lookup of the row index can be avoided by using the - * loop index instead. + * @note This class operates directly on the internal data structures of the + * DynamicSparsityPattern class. As a consequence, some operations are cheap + * and some are not. In particular, it is cheap to access the column index + * of the sparsity pattern entry pointed to. On the other hand, it is + * expensive to compute the distance between two iterators. As a + * consequence, when you design algorithms that use these iterators, it is + * common practice to not loop over all elements of a sparsity + * pattern at once, but to have an outer loop over all rows and within this + * loop iterate over the elements of this row. This way, you only ever need + * to dereference the iterator to obtain the column indices whereas the + * (expensive) lookup of the row index can be avoided by using the loop + * index instead. */ class Iterator { @@ -184,8 +181,8 @@ namespace DynamicSparsityPatternIterators const unsigned int index_within_row); /** - * Constructor. Create an invalid (end) iterator into the sparsity - * pattern @p sp. + * Constructor. Create an invalid (end) iterator into the sparsity pattern + * @p sp. */ Iterator (const DynamicSparsityPattern *sp); @@ -264,7 +261,8 @@ namespace DynamicSparsityPatternIterators * module. * * This class is an example of the "dynamic" type of - * @ref Sparsity. It is used in most tutorial programs in one way or another. + * @ref Sparsity. + * It is used in most tutorial programs in one way or another. * *

          Interface

          * @@ -298,8 +296,8 @@ public: typedef types::global_dof_index size_type; /** - * Typedef an for iterator class that allows to walk over all nonzero elements - * of a sparsity pattern. + * Typedef an for iterator class that allows to walk over all nonzero + * elements of a sparsity pattern. * * Since the iterator does not allow to modify the sparsity pattern, this * type is the same as that for @p const_iterator. @@ -309,17 +307,17 @@ public: iterator; /** - * Typedef for an iterator class that allows to walk over all nonzero elements - * of a sparsity pattern. + * Typedef for an iterator class that allows to walk over all nonzero + * elements of a sparsity pattern. */ typedef DynamicSparsityPatternIterators::Iterator const_iterator; /** - * Initialize as an empty object. This is - * useful if you want such objects as member variables in other classes. You - * can make the structure usable by calling the reinit() function. + * Initialize as an empty object. This is useful if you want such objects as + * member variables in other classes. You can make the structure usable by + * calling the reinit() function. */ DynamicSparsityPattern (); @@ -329,16 +327,16 @@ public: * involuntary copies of objects for temporaries, which can use large * amounts of computing time. However, copy constructors are needed if you * want to place a DynamicSparsityPattern in a container, e.g. to write such - * statements like v.push_back (DynamicSparsityPattern());, with - * @p v a vector of @p DynamicSparsityPattern objects. + * statements like v.push_back (DynamicSparsityPattern());, with @p + * v a vector of @p DynamicSparsityPattern objects. */ DynamicSparsityPattern (const DynamicSparsityPattern &); /** - * Initialize a rectangular sparsity pattern with @p m rows and @p n columns. The @p - * rowset restricts the storage to elements in rows of this set. Adding - * elements outside of this set has no effect. The default argument keeps - * all entries. + * Initialize a rectangular sparsity pattern with @p m rows and @p n + * columns. The @p rowset restricts the storage to elements in rows of this + * set. Adding elements outside of this set has no effect. The default + * argument keeps all entries. */ DynamicSparsityPattern (const size_type m, const size_type n, @@ -362,10 +360,10 @@ public: DynamicSparsityPattern &operator = (const DynamicSparsityPattern &); /** - * Reallocate memory and set up data structures for a new sparsity pattern with @p m - * rows and @p n columns. The @p rowset restricts the storage to elements in rows of this - * set. Adding elements outside of this set has no effect. The default - * argument keeps all entries. + * Reallocate memory and set up data structures for a new sparsity pattern + * with @p m rows and @p n columns. The @p rowset restricts the storage to + * elements in rows of this set. Adding elements outside of this set has no + * effect. The default argument keeps all entries. */ void reinit (const size_type m, const size_type n, @@ -397,7 +395,8 @@ public: const size_type j); /** - * Add several nonzero entries to the specified row. Already existing entries are ignored. + * Add several nonzero entries to the specified row. Already existing + * entries are ignored. */ template void add_entries (const size_type row, @@ -421,21 +420,21 @@ public: void symmetrize (); /** - * Print the sparsity pattern. The output consists of one line per row - * of the format [i,j1,j2,j3,...]. i is the row number and + * Print the sparsity pattern. The output consists of one line per row of + * the format [i,j1,j2,j3,...]. i is the row number and * jn are the allocated columns in this row. */ void print (std::ostream &out) const; /** - * Print the sparsity pattern in a format that @p gnuplot understands - * and which can be used to plot the sparsity pattern in a graphical way. - * The format consists of pairs i j of nonzero elements, each - * representing one entry, one per line of the output file. - * Indices are counted from zero on, as usual. Since sparsity patterns are - * printed in the same way as matrices are displayed, we print the negative - * of the column index, which means that the (0,0) element is in - * the top left rather than in the bottom left corner. + * Print the sparsity pattern in a format that @p gnuplot understands and + * which can be used to plot the sparsity pattern in a graphical way. The + * format consists of pairs i j of nonzero elements, each + * representing one entry, one per line of the output file. Indices are + * counted from zero on, as usual. Since sparsity patterns are printed in + * the same way as matrices are displayed, we print the negative of the + * column index, which means that the (0,0) element is in the top + * left rather than in the bottom left corner. * * Print the sparsity pattern in gnuplot by setting the data style to dots * or points and use the @p plot command. @@ -443,14 +442,13 @@ public: void print_gnuplot (std::ostream &out) const; /** - * Return the number of rows, which equals the dimension of the - * image space. + * Return the number of rows, which equals the dimension of the image space. */ size_type n_rows () const; /** - * Return the number of columns, which equals the dimension of - * the range space. + * Return the number of columns, which equals the dimension of the range + * space. */ size_type n_cols () const; @@ -480,11 +478,10 @@ public: * Note the discussion in the general documentation of this class about the * order in which elements are accessed. * - * @note If the sparsity pattern has been initialized with an IndexSet - * that denotes which rows to store, then iterators will simply skip - * over rows that are not stored. In other words, they will look like - * empty rows, but no exception will be generated when iterating over - * such rows. + * @note If the sparsity pattern has been initialized with an IndexSet that + * denotes which rows to store, then iterators will simply skip over rows + * that are not stored. In other words, they will look like empty rows, but + * no exception will be generated when iterating over such rows. */ iterator begin () const; @@ -504,11 +501,10 @@ public: * Note also the discussion in the general documentation of this class about * the order in which elements are accessed. * - * @note If the sparsity pattern has been initialized with an IndexSet - * that denotes which rows to store, then iterators will simply skip - * over rows that are not stored. In other words, they will look like - * empty rows, but no exception will be generated when iterating over - * such rows. + * @note If the sparsity pattern has been initialized with an IndexSet that + * denotes which rows to store, then iterators will simply skip over rows + * that are not stored. In other words, they will look like empty rows, but + * no exception will be generated when iterating over such rows. */ iterator begin (const size_type r) const; diff --git a/include/deal.II/lac/full_matrix.h b/include/deal.II/lac/full_matrix.h index 19808539c1..933b1d50cd 100644 --- a/include/deal.II/lac/full_matrix.h +++ b/include/deal.II/lac/full_matrix.h @@ -73,8 +73,8 @@ public: typedef unsigned int size_type; /** - * Type of matrix entries. This typedef is analogous to value_type in - * the standard library containers. + * Type of matrix entries. This typedef is analogous to value_type + * in the standard library containers. */ typedef number value_type; diff --git a/include/deal.II/lac/generic_linear_algebra.h b/include/deal.II/lac/generic_linear_algebra.h index 151dc1581c..9130696861 100644 --- a/include/deal.II/lac/generic_linear_algebra.h +++ b/include/deal.II/lac/generic_linear_algebra.h @@ -145,8 +145,8 @@ DEAL_II_NAMESPACE_CLOSE DEAL_II_NAMESPACE_OPEN /** - * A namespace in which the wrappers to the Trilinos linear algebra classes are - * typedef'ed to generic names. There are similar namespaces + * A namespace in which the wrappers to the Trilinos linear algebra classes + * are typedef'ed to generic names. There are similar namespaces * LinearAlgebraDealII and LinearAlgebraPETSc for typedefs to deal.II's own * classes and classes that interface with PETSc. */ diff --git a/include/deal.II/lac/iterative_inverse.h b/include/deal.II/lac/iterative_inverse.h index ec705018d4..7bd2d2f773 100644 --- a/include/deal.II/lac/iterative_inverse.h +++ b/include/deal.II/lac/iterative_inverse.h @@ -68,7 +68,8 @@ DEAL_II_NAMESPACE_OPEN * * @deprecated If deal.II was configured with C++11 support, use the * LinearOperator class instead, see the module on - * @ref LAOperators "linear operators" for further details. + * @ref LAOperators "linear operators" + * for further details. * * @ingroup Matrix2 * @author Guido Kanschat diff --git a/include/deal.II/lac/lapack_full_matrix.h b/include/deal.II/lac/lapack_full_matrix.h index ed8a067368..d2b1405226 100644 --- a/include/deal.II/lac/lapack_full_matrix.h +++ b/include/deal.II/lac/lapack_full_matrix.h @@ -206,9 +206,9 @@ public: * @note Source and destination must not be the same vector. * * @note The template with @p number2 only exists for compile-time - * compatibility with FullMatrix. Only the case @p number2 = @p - * number is implemented due to limitations in the underlying LAPACK - * interface. All other variants throw an error upon invocation. + * compatibility with FullMatrix. Only the case @p number2 = @p number is + * implemented due to limitations in the underlying LAPACK interface. All + * other variants throw an error upon invocation. */ template void vmult (Vector &w, @@ -262,8 +262,8 @@ public: const bool adding=false) const; /** - * Adding transpose matrix-vector-multiplication. - * w += AT*v + * Adding transpose matrix-vector-multiplication. w += + * AT*v * * See the documentation of vmult() for details on the implementation. */ diff --git a/include/deal.II/lac/linear_operator.h b/include/deal.II/lac/linear_operator.h index 1950dd7820..8585bbb37d 100644 --- a/include/deal.II/lac/linear_operator.h +++ b/include/deal.II/lac/linear_operator.h @@ -55,9 +55,9 @@ null_operator(const LinearOperator &); /** * A class to store the abstract concept of a linear operator. * - * The class essentially consists of std::function objects - * that store the knowledge of how to apply the linear operator by - * implementing the abstract @p Matrix interface: + * The class essentially consists of std::function objects that + * store the knowledge of how to apply the linear operator by implementing the + * abstract @p Matrix interface: * @code * std::function vmult; * std::function vmult_add; @@ -67,23 +67,23 @@ null_operator(const LinearOperator &); * * But, in contrast to a usual matrix object, the domain and range of the * linear operator are also bound to the LinearOperator class on the type - * level. Because of this, LinearOperator - * has two additional function objects + * level. Because of this, LinearOperator has two + * additional function objects * @code * std::function reinit_range_vector; * std::function reinit_domain_vector; * @endcode - * that store the knowledge how to initialize (resize + internal data structures) - * an arbitrary vector of the @p Range and @p Domain space. + * that store the knowledge how to initialize (resize + internal data + * structures) an arbitrary vector of the @p Range and @p Domain space. * - * The primary purpose of this class is to provide syntactic sugar for - * complex matrix-vector operations and free the user from having to - * create, set up and handle intermediate storage locations by hand. + * The primary purpose of this class is to provide syntactic sugar for complex + * matrix-vector operations and free the user from having to create, set up + * and handle intermediate storage locations by hand. * - * As an example consider the operation $(A+k\,B)\,C$, where $A$, $B$ and - * $C$ denote (possible different) matrices. In order to construct a - * LinearOperator op that stores the knowledge of this - * operation, one can write: + * As an example consider the operation $(A+k\,B)\,C$, where $A$, $B$ and $C$ + * denote (possible different) matrices. In order to construct a + * LinearOperator op that stores the knowledge of this operation, + * one can write: * * @code * dealii::SparseMatrix A, B, C; @@ -99,8 +99,8 @@ null_operator(const LinearOperator &); * @endcode * * @note This class is only available if deal.II was configured with C++11 - * support, i.e., if DEAL_II_WITH_CXX11 is enabled during - * cmake configure. + * support, i.e., if DEAL_II_WITH_CXX11 is enabled during cmake + * configure. * * @author Luca Heltai, Matthias Maier, 2015 * @@ -163,10 +163,9 @@ public: LinearOperator (const LinearOperator &) = default; /** - * Templated copy constructor that creates a LinearOperator object from - * an object @p op for which the conversion function - * linear_operator - * is defined. + * Templated copy constructor that creates a LinearOperator object from an + * object @p op for which the conversion function + * linear_operator is defined. */ template LinearOperator (const Op &op) @@ -192,21 +191,20 @@ public: } /** - * Application of the LinearOperator object to a vector u of the @p - * Domain space giving a vector v of the @p Range space. + * Application of the LinearOperator object to a vector u of the @p Domain + * space giving a vector v of the @p Range space. */ std::function vmult; /** - * Application of the LinearOperator object to a vector u of the @p - * Domain space. The result is added to the vector v. + * Application of the LinearOperator object to a vector u of the @p Domain + * space. The result is added to the vector v. */ std::function vmult_add; /** - * Application of the transpose LinearOperator object to a vector u of - * the @p Range space giving a vector v of the @p Domain - * space. + * Application of the transpose LinearOperator object to a vector u of the + * @p Range space giving a vector v of the @p Domain space. */ std::function Tvmult; @@ -217,11 +215,11 @@ public: std::function Tvmult_add; /** - * Initializes a vector v of the Range space to be directly usable - * as the destination parameter in an application of vmult. Similar to - * the reinit functions of the vector classes, the boolean determines - * whether a fast initalization is done, i.e., if it is set to false the - * content of the vector is set to 0. + * Initializes a vector v of the Range space to be directly usable as the + * destination parameter in an application of vmult. Similar to the reinit + * functions of the vector classes, the boolean determines whether a fast + * initalization is done, i.e., if it is set to false the content of the + * vector is set to 0. */ std::function reinit_range_vector; @@ -240,8 +238,8 @@ public: //@{ /** - * Addition with a LinearOperator @p second_op with the same @p Domain - * and @p Range. + * Addition with a LinearOperator @p second_op with the same @p Domain and + * @p Range. */ LinearOperator & operator+=(const LinearOperator &second_op) @@ -262,8 +260,8 @@ public: } /** - * Composition of the LinearOperator with an endomorphism @p second_op - * of the @p Domain space. + * Composition of the LinearOperator with an endomorphism @p second_op of + * the @p Domain space. */ LinearOperator & operator*=(const LinearOperator &second_op) @@ -284,10 +282,10 @@ public: } /** - * This bool is used to determine whether a linear operator is a - * null operator. In this case the class is able to optimize some - * operations like multiplication or addition. - */ + * This bool is used to determine whether a linear operator is a null + * operator. In this case the class is able to optimize some operations like + * multiplication or addition. + */ bool is_null_operator; //@} @@ -303,7 +301,8 @@ public: * @relates LinearOperator * * Addition of two linear operators @p first_op and @p second_op given by - * $(\text{first\_op}+\text{second\_op})x := \text{first\_op}(x) + \text{second\_op}(x)$ + * $(\text{first\_op}+\text{second\_op})x := \text{first\_op}(x) + + * \text{second\_op}(x)$ * * @ingroup LAOperators */ @@ -363,7 +362,8 @@ operator+(const LinearOperator &first_op, * @relates LinearOperator * * Subtraction of two linear operators @p first_op and @p second_op given by - * $(\text{first\_op}-\text{second\_op})x := \text{first\_op}(x) - \text{second\_op}(x)$ + * $(\text{first\_op}-\text{second\_op})x := \text{first\_op}(x) - + * \text{second\_op}(x)$ * * @ingroup LAOperators */ @@ -391,12 +391,12 @@ operator-(const LinearOperator &first_op, /** * @relates LinearOperator * - * Scalar multiplication of a ScalarOperator object @p op with @p number - * from the left. + * Scalar multiplication of a ScalarOperator object @p op with @p number from + * the left. * * The @p Domain and @p Range types must implement the following - * operator*= member functions accepting the appropriate - * scalar Number type for rescaling: + * operator*= member functions accepting the appropriate scalar + * Number type for rescaling: * * @code * Domain & operator *=(Domain::value_type); @@ -499,7 +499,8 @@ operator*(const LinearOperator &op, * @relates LinearOperator * * Composition of two linear operators @p first_op and @p second_op given by - * $(\text{first\_op}*\text{second\_op})x := \text{first\_op}(\text{second\_op}(x))$ + * $(\text{first\_op}*\text{second\_op})x := + * \text{first\_op}(\text{second\_op}(x))$ * * @ingroup LAOperators */ @@ -608,11 +609,11 @@ transpose_operator(const LinearOperator &op) * vmult and Tvmult implementations of the * LinearOperator object. * - * The LinearOperator object that is created stores a reference to @p - * solver and @p preconditioner. Thus, both objects must remain a valid - * reference for the whole lifetime of the LinearOperator object. Internal - * data structures of the @p solver object will be modified upon - * invocation of vmult or Tvmult. + * The LinearOperator object that is created stores a reference to @p solver + * and @p preconditioner. Thus, both objects must remain a valid reference for + * the whole lifetime of the LinearOperator object. Internal data structures + * of the @p solver object will be modified upon invocation of + * vmult or Tvmult. * * @ingroup LAOperators */ @@ -678,14 +679,12 @@ inverse_operator(const LinearOperatorstd::function object * @ref reinit_vector - * as an argument to initialize the - * reinit_range_vector and reinit_domain_vector - * objects of the LinearOperator object. + * as an argument to initialize the reinit_range_vector and + * reinit_domain_vector objects of the LinearOperator object. * * @ingroup LAOperators */ @@ -725,9 +724,9 @@ identity_operator(const std::function &reinit_vector) /** * @relates LinearOperator * - * Returns a nulled variant of the LinearOperator @p op, i.e. with - * optimized LinearOperator::vmult, LinearOperator::vmult_add, etc. - * functions and with LinearOperator::is_null_operator set to true. + * Returns a nulled variant of the LinearOperator @p op, i.e. with optimized + * LinearOperator::vmult, LinearOperator::vmult_add, etc. functions and with + * LinearOperator::is_null_operator set to true. * * @ingroup LAOperators */ @@ -764,24 +763,24 @@ namespace internal namespace LinearOperator { /** - * A helper class that is responsible for the initialization of a - * vector to be directly usable as the destination parameter, or source - * parameter in an application of vmult of a matrix. + * A helper class that is responsible for the initialization of a vector + * to be directly usable as the destination parameter, or source parameter + * in an application of vmult of a matrix. * * The generic version of this class just calls * Vector::reinit() with the result of * Matrix::m() or Matrix::n(), respectively. - * This class is specialized for more complicated data structures, such - * as TrilinosWrappers::MPI::Vector, etc. + * This class is specialized for more complicated data structures, such as + * TrilinosWrappers::MPI::Vector, etc. */ template class ReinitHelper { public: /** - * Initializes a vector v of the Range space to be directly usable - * as the destination parameter in an application of vmult. Similar to - * the reinit functions of the vector classes, the boolean determines + * Initializes a vector v of the Range space to be directly usable as + * the destination parameter in an application of vmult. Similar to the + * reinit functions of the vector classes, the boolean determines * whether a fast initalization is done, i.e., if it is set to false the * content of the vector is set to 0. * @@ -799,9 +798,9 @@ namespace internal /** * Initializes a vector of the Domain space to be directly usable as the * source parameter in an application of vmult. Similar to the reinit - * functions of the vector classes, the boolean determines whether a fast - * initalization is done, i.e., if it is set to false the content of the - * vector is set to 0. + * functions of the vector classes, the boolean determines whether a + * fast initalization is done, i.e., if it is set to false the content + * of the vector is set to 0. * * The generic version of this class just calls * Vector::reinit() with the result of @@ -994,16 +993,15 @@ namespace * A function that encapsulates generic @p matrix objects that act on a * compatible Vector type into a LinearOperator. The LinearOperator object * that is created stores a reference to the matrix object. Thus, @p matrix - * must remain a valid reference for the whole lifetime of the - * LinearOperator object. + * must remain a valid reference for the whole lifetime of the LinearOperator + * object. * * All changes made on @p matrix after the creation of the LinearOperator * object are reflected by the operator object. For example, it is a valid * procedure to first create a LinearOperator and resize, reassemble the * matrix later. * - * The Matrix class in question must provide the following minimal - * interface: + * The Matrix class in question must provide the following minimal interface: * * @code * class Matrix @@ -1059,13 +1057,11 @@ LinearOperator linear_operator(const Matrix &matrix) * * Variant of above function that takes an operator object @p * operator_exemplar as an additional reference. This object is used to - * populate the reinit_domain_vector and reinit_range_vector function - * objects. The reference @p matrix is used to construct vmult, Tvmult, - * etc. + * populate the reinit_domain_vector and reinit_range_vector function objects. + * The reference @p matrix is used to construct vmult, Tvmult, etc. * - * This variant can, for example, be used to encapsulate preconditioners - * (that typically do not expose any information about the underlying - * matrix). + * This variant can, for example, be used to encapsulate preconditioners (that + * typically do not expose any information about the underlying matrix). * * @author Matthias Maier, 2015 * diff --git a/include/deal.II/lac/matrix_block.h b/include/deal.II/lac/matrix_block.h index 0dd8bed917..56c9630640 100644 --- a/include/deal.II/lac/matrix_block.h +++ b/include/deal.II/lac/matrix_block.h @@ -341,9 +341,8 @@ public: typedef MatrixBlock value_type; /** - * The pointer type used for storing the objects. We use a shard - * pointer, such that they get deleted automatically when not used - * anymore. + * The pointer type used for storing the objects. We use a shard pointer, + * such that they get deleted automatically when not used anymore. */ typedef std_cxx11::shared_ptr ptr_type; diff --git a/include/deal.II/lac/matrix_lib.h b/include/deal.II/lac/matrix_lib.h index 8a88317bd4..2c2a3e14bf 100644 --- a/include/deal.II/lac/matrix_lib.h +++ b/include/deal.II/lac/matrix_lib.h @@ -46,7 +46,8 @@ template class SparseMatrix; * * @deprecated If deal.II was configured with C++11 support, use the * LinearOperator class instead, see the module on - * @ref LAOperators "linear operators" for further details. + * @ref LAOperators "linear operators" + * for further details. * * @author Guido Kanschat, 2000, 2001, 2002, 2005 */ @@ -148,7 +149,8 @@ private: * * @deprecated If deal.II was configured with C++11 support, use the * LinearOperator class instead, see the module on - * @ref LAOperators "linear operators" for further details. + * @ref LAOperators "linear operators" + * for further details. * * @author Guido Kanschat, 2007 */ @@ -215,7 +217,8 @@ private: * * @deprecated If deal.II was configured with C++11 support, use the * LinearOperator class instead, see the module on - * @ref LAOperators "linear operators" for further details. + * @ref LAOperators "linear operators" + * for further details. * * @author Guido Kanschat, 2000, 2001, 2002, 2005 */ @@ -421,7 +424,8 @@ private: * * @deprecated If deal.II was configured with C++11 support, use the * LinearOperator class instead, see the module on - * @ref LAOperators "linear operators" for further details. + * @ref LAOperators "linear operators" + * for further details. * * @author Guido Kanschat, 2005 */ diff --git a/include/deal.II/lac/matrix_out.h b/include/deal.II/lac/matrix_out.h index 874a2d632c..9acc1c22e2 100644 --- a/include/deal.II/lac/matrix_out.h +++ b/include/deal.II/lac/matrix_out.h @@ -256,8 +256,8 @@ namespace internal /** - * Return the element with given indices from any matrix type for which no - * specialization of this function was declared above. This will call + * Return the element with given indices from any matrix type for which + * no specialization of this function was declared above. This will call * operator() on the matrix. */ template diff --git a/include/deal.II/lac/packaged_operation.h b/include/deal.II/lac/packaged_operation.h index 6f9344ffa9..955356d3aa 100644 --- a/include/deal.II/lac/packaged_operation.h +++ b/include/deal.II/lac/packaged_operation.h @@ -35,16 +35,16 @@ template > class PackagedOperation; /** * A class to store a computation. * - * The PackagedOperation class allows lazy evaluation of expressions - * involving vectors and linear operators. This is done by storing the - * computational expression and only performing the computation when either - * the object is implicitly converted to a vector object, or - * apply (or apply_add) is invoked by hand. This - * avoids unnecessary temporary storage of intermediate results. - * - * The class essentially consists of std::function objects - * that store the knowledge of how to generate the result of a computation - * and store it in a vector: + * The PackagedOperation class allows lazy evaluation of expressions involving + * vectors and linear operators. This is done by storing the computational + * expression and only performing the computation when either the object is + * implicitly converted to a vector object, or apply (or + * apply_add) is invoked by hand. This avoids unnecessary + * temporary storage of intermediate results. + * + * The class essentially consists of std::function objects that + * store the knowledge of how to generate the result of a computation and + * store it in a vector: * @code * std::function apply; * std::function apply_add; @@ -73,9 +73,9 @@ template > class PackagedOperation; * @endcode * The expression residual is of type * PackagedOperation>. It stores - * references to A, b and x and - * defers the actual computation until apply, or - * apply_add are explicitly invoked, + * references to A, b and x and defers + * the actual computation until apply, or apply_add + * are explicitly invoked, * @code * dealii::Vector y; * residual.reinit_vector(y); @@ -131,14 +131,13 @@ public: PackagedOperation (const PackagedOperation &) = default; /** - * Constructor that creates a PackagedOperation object from a reference vector - * @p u. The PackagedOperation returns @p u. + * Constructor that creates a PackagedOperation object from a reference + * vector @p u. The PackagedOperation returns @p u. * - * The PackagedOperation object that is created stores a reference to @p - * u. Thus, the vector must remain a valid reference for the whole - * lifetime of the PackagedOperation object. All changes made on @p u - * after the creation of the PackagedOperation object are reflected by - * the operator object. + * The PackagedOperation object that is created stores a reference to @p u. + * Thus, the vector must remain a valid reference for the whole lifetime of + * the PackagedOperation object. All changes made on @p u after the creation + * of the PackagedOperation object are reflected by the operator object. */ PackagedOperation (const Range &u) { @@ -150,12 +149,13 @@ public: */ PackagedOperation &operator=(const PackagedOperation &) = default; - /** Copy assignment operator that creates a PackagedOperation object from a + /** + * Copy assignment operator that creates a PackagedOperation object from a * reference vector @p u. The PackagedOperation returns @p u. * * The PackagedOperation object that is created stores a reference to @p u. - * Thus, the vector must remain a valid reference for the whole lifetime - * of the PackagedOperation object. All changes made on @p u after the creation + * Thus, the vector must remain a valid reference for the whole lifetime of + * the PackagedOperation object. All changes made on @p u after the creation * of the PackagedOperation object are reflected by the operator object. */ PackagedOperation &operator=(const Range &u) @@ -209,7 +209,8 @@ public: } /** - * Subtraction with a PackagedOperation @p second_comp with the same @p Range. + * Subtraction with a PackagedOperation @p second_comp with the same @p + * Range. */ PackagedOperation &operator-=(const PackagedOperation &second_comp) { @@ -228,8 +229,8 @@ public: } /** - * Subract a constant @p offset (of the @p Range space) from the result - * of a PackagedOperation. + * Subract a constant @p offset (of the @p Range space) from the result of a + * PackagedOperation. */ PackagedOperation &operator-=(const Range &offset) { @@ -254,16 +255,17 @@ public: std::function apply; /** - * Add the result of the PackagedOperation to a vector v of the @p Range space. + * Add the result of the PackagedOperation to a vector v of the @p Range + * space. */ std::function apply_add; /** * Initializes a vector v of the Range space to be directly usable as the - * destination parameter in an application of apply, or apply_add. - * Similar to the reinit functions of the vector classes, the boolean - * determines whether a fast initialization is done, i.e., if it is set - * to false the content of the vector is set to 0. + * destination parameter in an application of apply, or apply_add. Similar + * to the reinit functions of the vector classes, the boolean determines + * whether a fast initialization is done, i.e., if it is set to false the + * content of the vector is set to 0. */ std::function reinit_vector; }; @@ -277,8 +279,8 @@ public: /** * @relates PackagedOperation * - * Addition of two PackagedOperation objects @p first_comp and - * @p second_comp given by vector space addition of the corresponding results. + * Addition of two PackagedOperation objects @p first_comp and @p second_comp + * given by vector space addition of the corresponding results. * * @ingroup LAOperators */ @@ -312,8 +314,8 @@ operator+(const PackagedOperation &first_comp, /** * @relates PackagedOperation * - * Subtraction of two PackagedOperation objects @p first_comp and @p second_comp - * given by vector space addition of the corresponding results. + * Subtraction of two PackagedOperation objects @p first_comp and @p + * second_comp given by vector space addition of the corresponding results. * * @ingroup LAOperators */ @@ -350,9 +352,8 @@ operator-(const PackagedOperation &first_comp, /** * @relates PackagedOperation * - * Scalar multiplication of a PackagedOperation objects @p comp with a - * scalar @p number given by a scaling PackagedOperation result with - * @p number. + * Scalar multiplication of a PackagedOperation objects @p comp with a scalar + * @p number given by a scaling PackagedOperation result with @p number. * * @ingroup LAOperators */ @@ -399,9 +400,8 @@ operator*(const PackagedOperation &comp, /** * @relates PackagedOperation * - * Scalar multiplication of a PackagedOperation objects @p comp with a - * scalar @p number given by a scaling PackagedOperation result with - * @p number. + * Scalar multiplication of a PackagedOperation objects @p comp with a scalar + * @p number given by a scaling PackagedOperation result with @p number. * * @ingroup LAOperators */ @@ -462,8 +462,8 @@ PackagedOperation operator-(const PackagedOperation &comp, /** * @relates PackagedOperation * - * Subtract a computational result from a constant @p offset (of the @p - * Range space). The result is a PackagedOperation object that applies this + * Subtract a computational result from a constant @p offset (of the @p Range + * space). The result is a PackagedOperation object that applies this * computation. * * @ingroup LAOperators @@ -514,10 +514,11 @@ namespace * * Create a PackagedOperation object that stores the addition of two vectors. * - * The PackagedOperation object that is created stores a reference to @p u and @p - * v. Thus, the vectors must remain valid references for the whole lifetime + * The PackagedOperation object that is created stores a reference to @p u and + * @p v. Thus, the vectors must remain valid references for the whole lifetime * of the PackagedOperation object. All changes made on @p u or @p v after the - * creation of the PackagedOperation object are reflected by the operator object. + * creation of the PackagedOperation object are reflected by the operator + * object. * * @ingroup LAOperators */ @@ -555,13 +556,14 @@ PackagedOperation operator+(const Range &u, const Range &v) /** * @relates PackagedOperation * - * Create a PackagedOperation object that stores the subtraction of two vectors. + * Create a PackagedOperation object that stores the subtraction of two + * vectors. * - * The PackagedOperation object that is created stores a reference to @p u - * and @p v. Thus, the vectors must remain valid references for the whole - * lifetime of the PackagedOperation object. All changes made on @p u or @p - * v after the creation of the PackagedOperation object are reflected by - * the operator object. + * The PackagedOperation object that is created stores a reference to @p u and + * @p v. Thus, the vectors must remain valid references for the whole lifetime + * of the PackagedOperation object. All changes made on @p u or @p v after the + * creation of the PackagedOperation object are reflected by the operator + * object. * * @ingroup LAOperators */ @@ -599,8 +601,8 @@ PackagedOperation operator-(const Range &u, const Range &v) /** * @relates PackagedOperation * - * Create a PackagedOperation object that stores the scaling of a vector - * with a @p number. + * Create a PackagedOperation object that stores the scaling of a vector with + * a @p number. * * The PackagedOperation object that is created stores a reference to @p u. * Thus, the vectors must remain valid references for the whole lifetime of @@ -622,8 +624,8 @@ PackagedOperation operator*(const Range &u, /** * @relates PackagedOperation * - * Create a PackagedOperation object that stores the scaling of a vector - * with a @p number. + * Create a PackagedOperation object that stores the scaling of a vector with + * a @p number. * * The PackagedOperation object that is created stores a reference to @p u. * Thus, the vectors must remain valid references for the whole lifetime of @@ -645,17 +647,16 @@ PackagedOperation operator*(typename Range::value_type number, /** * @relates PackagedOperation * - * Create a PackagedOperation object from a LinearOperator and a reference to a - * vector @p u of the Domain space. The object stores the PackagedOperation + * Create a PackagedOperation object from a LinearOperator and a reference to + * a vector @p u of the Domain space. The object stores the PackagedOperation * $\text{op} \,u$ (in matrix notation). return * (return_add) are implemented with vmult(__1,u) * (vmult_add(__1,u)). * * The PackagedOperation object that is created stores a reference to @p u. * Thus, the vector must remain a valid reference for the whole lifetime of - * the PackagedOperation object. All changes made on @p u after the - * creation of the PackagedOperation object are reflected by the operator - * object. + * the PackagedOperation object. All changes made on @p u after the creation + * of the PackagedOperation object are reflected by the operator object. * * @ingroup LAOperators */ @@ -688,17 +689,16 @@ operator*(const LinearOperator &op, /** * @relates PackagedOperation * - * Create a PackagedOperation object from a LinearOperator and a reference - * to a vector @p u of the Range space. The object stores the - * PackagedOperation $\text{op}^T \,u$ (in matrix notation). - * return (return_add) are implemented with - * Tvmult(__1,u) (Tvmult_add(__1,u)). + * Create a PackagedOperation object from a LinearOperator and a reference to + * a vector @p u of the Range space. The object stores the PackagedOperation + * $\text{op}^T \,u$ (in matrix notation). return + * (return_add) are implemented with Tvmult(__1,u) + * (Tvmult_add(__1,u)). * * The PackagedOperation object that is created stores a reference to @p u. * Thus, the vector must remain a valid reference for the whole lifetime of - * the PackagedOperation object. All changes made on @p u after the - * creation of the PackagedOperation object are reflected by the operator - * object. + * the PackagedOperation object. All changes made on @p u after the creation + * of the PackagedOperation object are reflected by the operator object. * * @ingroup LAOperators */ @@ -731,8 +731,8 @@ operator*(const Range &u, /** * @relates PackagedOperation * - * Composition of a PackagedOperation object with a LinearOperator. The - * object stores the computation $\text{op} \,comp$ (in matrix notation). + * Composition of a PackagedOperation object with a LinearOperator. The object + * stores the computation $\text{op} \,comp$ (in matrix notation). * * @ingroup LAOperators */ @@ -781,8 +781,8 @@ operator*(const LinearOperator &op, /** * @relates PackagedOperation * - * Composition of a PackagedOperation object with a LinearOperator. The - * object stores the computation $\text{op}^T \,comp$ (in matrix notation). + * Composition of a PackagedOperation object with a LinearOperator. The object + * stores the computation $\text{op}^T \,comp$ (in matrix notation). * * @ingroup LAOperators */ diff --git a/include/deal.II/lac/petsc_matrix_base.h b/include/deal.II/lac/petsc_matrix_base.h index 61552360bb..a0eca82ccb 100644 --- a/include/deal.II/lac/petsc_matrix_base.h +++ b/include/deal.II/lac/petsc_matrix_base.h @@ -921,8 +921,8 @@ namespace PETScWrappers /** * Internal function that checks that there are no pending insert/add - * operations. Throws an exception otherwise. Useful before calling - * any PETSc internal functions modifying the matrix. + * operations. Throws an exception otherwise. Useful before calling any + * PETSc internal functions modifying the matrix. */ void assert_is_compressed(); diff --git a/include/deal.II/lac/petsc_parallel_vector.h b/include/deal.II/lac/petsc_parallel_vector.h index 6aadcafef0..3e82a41153 100644 --- a/include/deal.II/lac/petsc_parallel_vector.h +++ b/include/deal.II/lac/petsc_parallel_vector.h @@ -263,8 +263,8 @@ namespace PETScWrappers const MPI_Comm &communicator); /** - * Release all memory and return to a state just like after having called - * the default constructor. + * Release all memory and return to a state just like after having + * called the default constructor. */ void clear (); diff --git a/include/deal.II/lac/petsc_vector_base.h b/include/deal.II/lac/petsc_vector_base.h index 6765f92117..8ab260e096 100644 --- a/include/deal.II/lac/petsc_vector_base.h +++ b/include/deal.II/lac/petsc_vector_base.h @@ -144,8 +144,8 @@ namespace PETScWrappers /** * Return the imaginary part of the value of the referenced element. * - * @note This operation is not defined for real numbers and an - * exception is thrown. + * @note This operation is not defined for real numbers and an exception + * is thrown. */ PetscReal imag () const; diff --git a/include/deal.II/lac/relaxation_block.h b/include/deal.II/lac/relaxation_block.h index a9e6a32263..ea10f845d6 100644 --- a/include/deal.II/lac/relaxation_block.h +++ b/include/deal.II/lac/relaxation_block.h @@ -69,10 +69,10 @@ public: typedef types::global_dof_index size_type; /** - * Parameters for block relaxation methods. In addition to typical - * control parameters like #relaxation, this object also contains - * the block structure in #block_list and an optional ordering of - * the blocks in #order. + * Parameters for block relaxation methods. In addition to typical control + * parameters like #relaxation, this object also contains the block + * structure in #block_list and an optional ordering of the blocks in + * #order. */ class AdditionalData : public Subscriptor { @@ -85,9 +85,8 @@ public: const bool same_diagonal = false); /** - * The mapping from indices to blocks. Each row of this pattern - * enumerates the indices constituting a diagonal block to be - * inverted. + * The mapping from indices to blocks. Each row of this pattern enumerates + * the indices constituting a diagonal block to be inverted. */ SparsityPattern block_list; @@ -97,18 +96,17 @@ public: double relaxation; /** - * Invert diagonal during initialization. Alternatively, diagonal - * blocks are inverted on the fly, whenever they are used. While - * inverting blocks in advance requires more memory, it usually - * saves a lot of computation. See #same_diagonal on how you can - * avoid memory overhead. + * Invert diagonal during initialization. Alternatively, diagonal blocks + * are inverted on the fly, whenever they are used. While inverting blocks + * in advance requires more memory, it usually saves a lot of computation. + * See #same_diagonal on how you can avoid memory overhead. */ bool invert_diagonal; /** - * Assume all diagonal blocks are equal to save memory. If this - * flag is true, then only the first diagonal block of the matrix - * is inverted and stored. It is then used for all other blocks. + * Assume all diagonal blocks are equal to save memory. If this flag is + * true, then only the first diagonal block of the matrix is inverted and + * stored. It is then used for all other blocks. * * \note Avoid setting this true if your blocks are not equal, in * particularr if their sizes differ. @@ -120,10 +118,10 @@ public: typename PreconditionBlockBase::Inversion inversion; /** - * If #inversion is SVD, we can compute the Penrose-Moore inverse - * of the blocks. In order to do so, we can specify here the - * threshold below which a singular value will be considered zero - * and thus not inverted. This parameter is used in the call to + * If #inversion is SVD, we can compute the Penrose-Moore inverse of the + * blocks. In order to do so, we can specify here the threshold below + * which a singular value will be considered zero and thus not inverted. + * This parameter is used in the call to * LAPACKFullMatrix::compute_inverse_svd(). */ double threshold; @@ -156,14 +154,13 @@ public: }; /** - * Initialize matrix and additional information. In a second step, - * the inverses of the diagonal blocks may be computed. + * Initialize matrix and additional information. In a second step, the + * inverses of the diagonal blocks may be computed. * - * Note that AdditionalData, different from other preconditioners, - * defines quite large objects, and that therefore the object is not - * copied, but rather a pointer is stored. Thus, the lifetime of - * additional_data hast to exceed the lifetime of this - * object. + * Note that AdditionalData, different from other preconditioners, defines + * quite large objects, and that therefore the object is not copied, but + * rather a pointer is stored. Thus, the lifetime of + * additional_data hast to exceed the lifetime of this object. */ void initialize (const MATRIX &A, const AdditionalData ¶meters); diff --git a/include/deal.II/lac/sparse_decomposition.h b/include/deal.II/lac/sparse_decomposition.h index 93f945354d..330bc3306c 100644 --- a/include/deal.II/lac/sparse_decomposition.h +++ b/include/deal.II/lac/sparse_decomposition.h @@ -50,9 +50,9 @@ DEAL_II_NAMESPACE_OPEN * sparsity pattern of the decomposition is a superset of the sparsity pattern * in the original matrix. * - * Such fill-in can be accomplished by various ways, one of which is the - * copy-constructor of the SparsityPattern class that allows the addition of - * side-diagonals to a given sparsity structure. + * Such fill-in can be accomplished by various ways, one of which is the copy- + * constructor of the SparsityPattern class that allows the addition of side- + * diagonals to a given sparsity structure. * * *

          Unified use of preconditioners

          @@ -72,9 +72,9 @@ DEAL_II_NAMESPACE_OPEN * parameters of the LU decomposition. * * 1/ The matrix diagonal can be strengthened by adding - * strengthen_diagonal times the sum of the absolute row entries of - * each row to the respective diagonal entries. By default no strengthening is - * performed. + * strengthen_diagonal times the sum of the absolute row entries + * of each row to the respective diagonal entries. By default no strengthening + * is performed. * * 2/ By default, each initialize() function call creates its own sparsity. * For that, it copies the sparsity of matrix and adds a specific @@ -150,22 +150,22 @@ public: const SparsityPattern *use_this_sparsity=0); /** - * strengthen_diag times the sum of absolute row entries is added - * to the diagonal entries. + * strengthen_diag times the sum of absolute row entries is + * added to the diagonal entries. * * Per default, this value is zero, i.e. the diagonal is not strengthened. */ double strengthen_diagonal; /** - * By default, the initialize(matrix, data) function creates its - * own sparsity. This sparsity has the same SparsityPattern as - * matrix with some extra off diagonals the number of which is - * specified by extra_off_diagonals. + * By default, the initialize(matrix, data) function creates + * its own sparsity. This sparsity has the same SparsityPattern as + * matrix with some extra off diagonals the number of which + * is specified by extra_off_diagonals. * - * The user can give a SparsityPattern to use_this_sparsity. Then - * this sparsity is used and the extra_off_diagonals argument is - * ignored. + * The user can give a SparsityPattern to use_this_sparsity. + * Then this sparsity is used and the extra_off_diagonals + * argument is ignored. */ unsigned int extra_off_diagonals; @@ -184,9 +184,10 @@ public: * function calls reinit(*use_this_sparsity) causing this * sparsity to be used. * - * Note that the sparsity structures of *use_this_sparsity and - * the matrix passed to the initialize function need not be equal. Fill-in - * is allowed, as well as filtering out some elements in the matrix. + * Note that the sparsity structures of *use_this_sparsity + * and the matrix passed to the initialize function need not be equal. + * Fill-in is allowed, as well as filtering out some elements in the + * matrix. */ const SparsityPattern *use_this_sparsity; }; @@ -200,8 +201,8 @@ public: * * According to the parameters, this function creates a new * SparsityPattern or keeps the previous sparsity or takes the sparsity - * given by the user to data. Then, this function performs the LU - * decomposition. + * given by the user to data. Then, this function performs the + * LU decomposition. * * After this function is called the preconditioner is ready to be used * (using the vmult function of derived classes). diff --git a/include/deal.II/lac/sparse_matrix.h b/include/deal.II/lac/sparse_matrix.h index 2d86e0b03b..e234a03746 100644 --- a/include/deal.II/lac/sparse_matrix.h +++ b/include/deal.II/lac/sparse_matrix.h @@ -641,8 +641,8 @@ public: bool empty () const; /** - * Return the dimension of the codomain (or range) space. To remember: - * the matrix is of dimension $m \times n$. + * Return the dimension of the codomain (or range) space. To remember: the + * matrix is of dimension $m \times n$. */ size_type m () const; @@ -1368,8 +1368,7 @@ public: iterator begin (); /** - * Return an iterator pointing the element past the last one of - * this matrix. + * Return an iterator pointing the element past the last one of this matrix. */ const_iterator end () const; @@ -1381,11 +1380,11 @@ public: /** * Return an iterator pointing to the first element of row @p r. * - * Note that if the given row is empty, i.e. does not contain any - * nonzero entries, then the iterator returned by this function - * equals end(r). The returned iterator may not be - * dereferencable in that case if neither row @p r nor any of the - * following rows contain any nonzero entries. + * Note that if the given row is empty, i.e. does not contain any nonzero + * entries, then the iterator returned by this function equals + * end(r). The returned iterator may not be dereferencable in that + * case if neither row @p r nor any of the following rows contain any + * nonzero entries. */ const_iterator begin (const size_type r) const; @@ -1395,12 +1394,12 @@ public: iterator begin (const size_type r); /** - * Return an iterator pointing the element past the last one of - * row @p r , or past the end of the entire sparsity pattern if - * none of the rows after @p r contain any entries at all. + * Return an iterator pointing the element past the last one of row @p r , + * or past the end of the entire sparsity pattern if none of the rows after + * @p r contain any entries at all. * - * Note that the end iterator is not necessarily dereferencable. This is - * in particular the case if it is the end iterator for the last row of a + * Note that the end iterator is not necessarily dereferencable. This is in + * particular the case if it is the end iterator for the last row of a * matrix. */ const_iterator end (const size_type r) const; diff --git a/include/deal.II/lac/sparse_matrix_ez.h b/include/deal.II/lac/sparse_matrix_ez.h index 51c4946e76..1745dcfcd9 100644 --- a/include/deal.II/lac/sparse_matrix_ez.h +++ b/include/deal.II/lac/sparse_matrix_ez.h @@ -289,8 +289,8 @@ public: }; /** - * Type of matrix entries. This typedef is analogous to value_type in - * the standard library containers. + * Type of matrix entries. This typedef is analogous to value_type + * in the standard library containers. */ typedef number value_type; @@ -374,14 +374,14 @@ public: bool empty () const; /** - * Return the dimension of the codomain (or range) space. To remember: - * the matrix is of dimension $m \times n$. + * Return the dimension of the codomain (or range) space. To remember: the + * matrix is of dimension $m \times n$. */ size_type m () const; /** - * Return the dimension of the domain space. To remember: the matrix is - * of dimension $m \times n$. + * Return the dimension of the domain space. To remember: the matrix is of + * dimension $m \times n$. */ size_type n () const; @@ -674,8 +674,8 @@ public: const_iterator end () const; /** - * Iterator starting at the first entry of row @p r. If this row is empty, the - * result is end(r), which does NOT point into row @p r. + * Iterator starting at the first entry of row @p r. If this row is empty, + * the result is end(r), which does NOT point into row @p r. */ const_iterator begin (const size_type r) const; diff --git a/include/deal.II/lac/sparsity_pattern.h b/include/deal.II/lac/sparsity_pattern.h index 8085d4eb3a..5e26cc3718 100644 --- a/include/deal.II/lac/sparsity_pattern.h +++ b/include/deal.II/lac/sparsity_pattern.h @@ -208,9 +208,9 @@ namespace SparsityPatternIterators * The typical use for these iterators is to iterate over the elements of a * sparsity pattern (or, since they also serve as the basis for iterating * over the elements of an associated matrix, over the elements of a sparse - * matrix), or over the elements of individual rows. There is no - * guarantee that the elements of a row are actually traversed in an order - * in which column numbers monotonically increase. See the documentation of the + * matrix), or over the elements of individual rows. There is no guarantee + * that the elements of a row are actually traversed in an order in which + * column numbers monotonically increase. See the documentation of the * SparsityPattern class for more information. * * @note This class operates directly on the internal data structures of the @@ -388,9 +388,9 @@ public: * statements like v.push_back (SparsityPattern());, with * v a vector of SparsityPattern objects. * - * Usually, it is sufficient to use the explicit keyword to disallow unwanted - * temporaries, but this does not work for std::vectors. Since - * copying a structure like this is not useful anyway because multiple + * Usually, it is sufficient to use the explicit keyword to disallow + * unwanted temporaries, but this does not work for std::vectors. + * Since copying a structure like this is not useful anyway because multiple * matrices can use the same sparsity structure, copies are only allowed for * empty objects, as described above. */ @@ -614,11 +614,11 @@ public: const ForwardIterator end); /** - * Copy data from an object of type DynamicSparsityPattern. Although - * not a compressed sparsity pattern, this function is also instantiated if - * the argument is of type SparsityPattern (i.e., the current class). - * Previous content of this object is lost, and the sparsity pattern is in - * compressed mode afterwards. + * Copy data from an object of type DynamicSparsityPattern. Although not a + * compressed sparsity pattern, this function is also instantiated if the + * argument is of type SparsityPattern (i.e., the current class). Previous + * content of this object is lost, and the sparsity pattern is in compressed + * mode afterwards. */ template void copy_from (const CompressedSparsityType &dsp); diff --git a/include/deal.II/lac/sparsity_tools.h b/include/deal.II/lac/sparsity_tools.h index 8b0be1c222..01b987721c 100644 --- a/include/deal.II/lac/sparsity_tools.h +++ b/include/deal.II/lac/sparsity_tools.h @@ -154,12 +154,12 @@ namespace SparsityTools * and puts that node and its direct neighbors into one chunk. Next, it * selects one of the neighbors of the already selected nodes, adds the node * and its direct neighbors that are not part of one of the previous chunks, - * into the next. After this sweep, neighboring nodes are grouped - * together. To ensure a similar grouping on a more global level, this - * grouping is called recursively on the groups so formed. The recursion - * stops when no further grouping is possible. Eventually, the ordering - * obtained by this method passes through the indices represented in the - * sparsity pattern in a z-like way. + * into the next. After this sweep, neighboring nodes are grouped together. + * To ensure a similar grouping on a more global level, this grouping is + * called recursively on the groups so formed. The recursion stops when no + * further grouping is possible. Eventually, the ordering obtained by this + * method passes through the indices represented in the sparsity pattern in + * a z-like way. * * If the graph has two or more unconnected components, the algorithm will * number each component consecutively, starting with the components with @@ -186,11 +186,11 @@ namespace SparsityTools * processors that all participate in this operation. * * @param myrange indicates the range of elements stored locally and should - * be the one used in the constructor of the - * DynamicSparsityPattern. This should be the locally relevant - * set. Only rows contained in myrange are checked in dsp for transfer. - * This function needs to be used with PETScWrappers::MPI::SparseMatrix for - * it to work correctly in a parallel computation. + * be the one used in the constructor of the DynamicSparsityPattern. This + * should be the locally relevant set. Only rows contained in myrange are + * checked in dsp for transfer. This function needs to be used with + * PETScWrappers::MPI::SparseMatrix for it to work correctly in a parallel + * computation. */ template void distribute_sparsity_pattern(DSP_t &dsp, diff --git a/include/deal.II/lac/transpose_matrix.h b/include/deal.II/lac/transpose_matrix.h index c465c32934..dd96aac9d0 100644 --- a/include/deal.II/lac/transpose_matrix.h +++ b/include/deal.II/lac/transpose_matrix.h @@ -34,7 +34,8 @@ DEAL_II_NAMESPACE_OPEN * * @deprecated If deal.II was configured with C++11 support, use the * LinearOperator class instead, see the module on - * @ref LAOperators "linear operators" for further details. + * @ref LAOperators "linear operators" + * for further details. * * @ingroup Matrix2 * @author Guido Kanschat, 2006 diff --git a/include/deal.II/lac/trilinos_block_sparse_matrix.h b/include/deal.II/lac/trilinos_block_sparse_matrix.h index dc908cabf8..f4700f49e8 100644 --- a/include/deal.II/lac/trilinos_block_sparse_matrix.h +++ b/include/deal.II/lac/trilinos_block_sparse_matrix.h @@ -234,8 +234,8 @@ namespace TrilinosWrappers /** * Return a vector of the underlying Trilinos Epetra_Map that sets the * partitioning of the range space of this block matrix, i.e., the - * partitioning of the individual block vectors that are the result - * from matrix-vector products. + * partitioning of the individual block vectors that are the result from + * matrix-vector products. */ std::vector range_partitioner () const; diff --git a/include/deal.II/lac/trilinos_block_vector.h b/include/deal.II/lac/trilinos_block_vector.h index 5061a2be42..320f6d949c 100644 --- a/include/deal.II/lac/trilinos_block_vector.h +++ b/include/deal.II/lac/trilinos_block_vector.h @@ -461,8 +461,8 @@ namespace internal template class ReinitHelper; /** - * A helper class internally used in linear_operator.h. - * Specialization for TrilinosWrappers::BlockVector. + * A helper class internally used in linear_operator.h. Specialization for + * TrilinosWrappers::BlockVector. */ template<> class ReinitHelper diff --git a/include/deal.II/lac/trilinos_parallel_block_vector.h b/include/deal.II/lac/trilinos_parallel_block_vector.h index c83f2f9ee5..214b384c73 100644 --- a/include/deal.II/lac/trilinos_parallel_block_vector.h +++ b/include/deal.II/lac/trilinos_parallel_block_vector.h @@ -137,8 +137,8 @@ namespace TrilinosWrappers * Move constructor. Creates a new vector by stealing the internal data * of the vector @p v. * - * @note This constructor is only available if deal.II is configured with - * C++11 support. + * @note This constructor is only available if deal.II is configured + * with C++11 support. */ BlockVector (BlockVector &&v); #endif @@ -486,8 +486,8 @@ namespace internal template class ReinitHelper; /** - * A helper class internally used in linear_operator.h. - * Specialization for TrilinosWrappers::MPI::BlockVector. + * A helper class internally used in linear_operator.h. Specialization for + * TrilinosWrappers::MPI::BlockVector. */ template<> class ReinitHelper diff --git a/include/deal.II/lac/trilinos_precondition.h b/include/deal.II/lac/trilinos_precondition.h index 91beb6a2b8..8f484b680b 100644 --- a/include/deal.II/lac/trilinos_precondition.h +++ b/include/deal.II/lac/trilinos_precondition.h @@ -1568,8 +1568,8 @@ namespace TrilinosWrappers /** * A data structure that is used to control details of how the algebraic - * multigrid is set up. The flags detailed in here are then passed to - * the Trilinos MueLu implementation. A structure of the current type are + * multigrid is set up. The flags detailed in here are then passed to the + * Trilinos MueLu implementation. A structure of the current type are * passed to the constructor of PreconditionAMGMueLu. */ struct AdditionalData @@ -1592,8 +1592,8 @@ namespace TrilinosWrappers /** * Determines whether the AMG preconditioner should be optimized for * elliptic problems (MueLu option smoothed aggregation SA, using a - * Chebyshev smoother) or for non-elliptic problems (MueLu option - * non-symmetric smoothed aggregation NSSA, smoother is SSOR with + * Chebyshev smoother) or for non-elliptic problems (MueLu option non- + * symmetric smoothed aggregation NSSA, smoother is SSOR with * underrelaxation). */ bool elliptic; @@ -1655,37 +1655,37 @@ namespace TrilinosWrappers bool output_details; /** - * Determines which smoother to use for the AMG cycle. Possibilities - * for smoother_type are the following: + * Determines which smoother to use for the AMG cycle. Possibilities for + * smoother_type are the following: *
            - *
          • "Aztec"
            • - *
          • "IFPACK"
            • - *
          • "Jacobi"
            • - *
          • "ML symmetric Gauss-Seidel"
            • - *
          • "symmetric Gauss-Seidel"
            • - *
          • "ML Gauss-Seidel"
            • - *
          • "Gauss-Seidel"
            • - *
          • "block Gauss-Seidel"
            • - *
          • "symmetric block Gauss-Seidel"
            • - *
          • "Chebyshev"
            • - *
          • "MLS"
            • - *
          • "Hiptmair"
            • - *
          • "Amesos-KLU"
            • - *
          • "Amesos-Superlu"
            • - *
          • "Amesos-UMFPACK"
            • - *
          • "Amesos-Superludist"
            • - *
          • "Amesos-MUMPS"
            • - *
          • "user-defined"
            • - *
          • "SuperLU"
            • - *
          • "IFPACK-Chebyshev"
            • - *
          • "self"
            • - *
          • "do-nothing"
            • - *
          • "IC"
            • - *
          • "ICT"
            • - *
          • "ILU"
            • - *
          • "ILUT"
            • - *
          • "Block Chebyshev"
            • - *
          • "IFPACK-Block Chebyshev"
            • + *
          • "Aztec"
            • + *
          • "IFPACK"
            • + *
          • "Jacobi"
            • + *
          • "ML symmetric Gauss-Seidel"
            • + *
          • "symmetric Gauss-Seidel"
            • + *
          • "ML Gauss-Seidel"
            • + *
          • "Gauss-Seidel"
            • + *
          • "block Gauss-Seidel"
            • + *
          • "symmetric block Gauss-Seidel"
            • + *
          • "Chebyshev"
            • + *
          • "MLS"
            • + *
          • "Hiptmair"
            • + *
          • "Amesos-KLU"
            • + *
          • "Amesos-Superlu"
            • + *
          • "Amesos-UMFPACK"
            • + *
          • "Amesos-Superludist"
            • + *
          • "Amesos-MUMPS"
            • + *
          • "user-defined"
            • + *
          • "SuperLU"
            • + *
          • "IFPACK-Chebyshev"
            • + *
          • "self"
            • + *
          • "do-nothing"
            • + *
          • "IC"
            • + *
          • "ICT"
            • + *
          • "ILU"
            • + *
          • "ILUT"
            • + *
          • "Block Chebyshev"
            • + *
          • "IFPACK-Block Chebyshev"
            • *
          */ const char *smoother_type; @@ -1713,7 +1713,8 @@ namespace TrilinosWrappers /** * Let Trilinos compute a multilevel hierarchy for the solution of a * linear system with the given matrix. As opposed to the other initialize - * function above, this function uses an object of type Epetra_CrsMatrixCrs. + * function above, this function uses an object of type + * Epetra_CrsMatrixCrs. */ void initialize (const Epetra_CrsMatrix &matrix, const AdditionalData &additional_data = AdditionalData()); @@ -1724,8 +1725,8 @@ namespace TrilinosWrappers * format specified in TrilinosWrappers::SparseMatrix. * * This function is similar to the one above, but allows the user to set - * most of the options of the Trilinos ML preconditioner. In order to find out - * about all the options for ML, we refer to the ML user's * guide. Not all ML options have a corresponding MueLu option. */ diff --git a/include/deal.II/lac/trilinos_sparse_matrix.h b/include/deal.II/lac/trilinos_sparse_matrix.h index 4c705beb5e..c12d11debc 100644 --- a/include/deal.II/lac/trilinos_sparse_matrix.h +++ b/include/deal.II/lac/trilinos_sparse_matrix.h @@ -464,9 +464,8 @@ namespace TrilinosWrappers *
            *
          • The matrix uses only one MPI process. *
          • The matrix has been initialized with the reinit() method with a - * DynamicSparsityPattern (that includes the set of locally - * relevant rows, i.e., the rows that an assembly routine will possibly - * write into). + * DynamicSparsityPattern (that includes the set of locally relevant rows, + * i.e., the rows that an assembly routine will possibly write into). *
          • The matrix has been initialized from a * TrilinosWrappers::SparsityPattern object that in turn has been * initialized with the reinit function specifying three index sets, one for @@ -726,13 +725,13 @@ namespace TrilinosWrappers * optional argument @p exchange_data can be used for reinitialization * with a sparsity pattern that is not fully constructed. This feature is * only implemented for input sparsity patterns of type - * DynamicSparsityPattern. If the flag is not set, each processor - * just sets the elements in the sparsity pattern that belong to its rows. + * DynamicSparsityPattern. If the flag is not set, each processor just + * sets the elements in the sparsity pattern that belong to its rows. * * If the sparsity pattern given to this function is of type - * DynamicSparsity pattern, then a matrix will be created that - * allows several threads to write into different rows of the matrix at - * the same also with MPI, as opposed to most other reinit() methods. + * DynamicSparsity pattern, then a matrix will be created that allows + * several threads to write into different rows of the matrix at the same + * also with MPI, as opposed to most other reinit() methods. * * This is a collective operation that needs to be called on all * processors in order to avoid a dead lock. @@ -886,9 +885,9 @@ namespace TrilinosWrappers * to the deal.II own object. The optional argument @p exchange_data can * be used for reinitialization with a sparsity pattern that is not fully * constructed. This feature is only implemented for input sparsity - * patterns of type DynamicSparsityPattern. If the flag is not - * set, each processor just sets the elements in the sparsity pattern that - * belong to its rows. + * patterns of type DynamicSparsityPattern. If the flag is not set, each + * processor just sets the elements in the sparsity pattern that belong to + * its rows. * * This is a collective operation that needs to be called on all * processors in order to avoid a dead lock. @@ -1303,18 +1302,17 @@ namespace TrilinosWrappers * The second parameter can be used to set the diagonal entry of this row * to a value different from zero. The default is to set it to zero. * - * @note If the matrix is stored in parallel across multiple - * processors using MPI, this function only touches rows that are - * locally stored and simply ignores all other row - * indices. Further, in the context of parallel computations, you - * will get into trouble if you clear a row while other processors - * still have pending writes or additions into the same row. In - * other words, if another processor still wants to add something - * to an element of a row and you call this function to zero out - * the row, then the next time you call compress() may add the - * remote value to the zero you just created. Consequently, you - * will want to call compress() after you made the last - * modifications to a matrix and before starting to clear rows. + * @note If the matrix is stored in parallel across multiple processors + * using MPI, this function only touches rows that are locally stored and + * simply ignores all other row indices. Further, in the context of + * parallel computations, you will get into trouble if you clear a row + * while other processors still have pending writes or additions into the + * same row. In other words, if another processor still wants to add + * something to an element of a row and you call this function to zero out + * the row, then the next time you call compress() may add the remote + * value to the zero you just created. Consequently, you will want to call + * compress() after you made the last modifications to a matrix and before + * starting to clear rows. */ void clear_row (const size_type row, const TrilinosScalar new_diag_value = 0); @@ -1327,18 +1325,17 @@ namespace TrilinosWrappers * diagonal entries get the same value -- if you want different values for * the diagonal entries, you have to set them by hand. * - * @note If the matrix is stored in parallel across multiple - * processors using MPI, this function only touches rows that are - * locally stored and simply ignores all other row - * indices. Further, in the context of parallel computations, you - * will get into trouble if you clear a row while other processors - * still have pending writes or additions into the same row. In - * other words, if another processor still wants to add something - * to an element of a row and you call this function to zero out - * the row, then the next time you call compress() may add the - * remote value to the zero you just created. Consequently, you - * will want to call compress() after you made the last - * modifications to a matrix and before starting to clear rows. + * @note If the matrix is stored in parallel across multiple processors + * using MPI, this function only touches rows that are locally stored and + * simply ignores all other row indices. Further, in the context of + * parallel computations, you will get into trouble if you clear a row + * while other processors still have pending writes or additions into the + * same row. In other words, if another processor still wants to add + * something to an element of a row and you call this function to zero out + * the row, then the next time you call compress() may add the remote + * value to the zero you just created. Consequently, you will want to call + * compress() after you made the last modifications to a matrix and before + * starting to clear rows. */ void clear_rows (const std::vector &rows, const TrilinosScalar new_diag_value = 0); @@ -1700,22 +1697,20 @@ namespace TrilinosWrappers /** * Return an iterator pointing to the first element of the matrix. * - * The elements accessed by iterators within each row are ordered - * in the way in which Trilinos stores them, though the - * implementation guarantees that all elements of one row are - * accessed before the elements of the next row. If your algorithm - * relies on visiting elements within one row, you will need to - * consult with the Trilinos documentation on the order in which - * it stores data. It is, however, generally not a good and - * long-term stable idea to rely on the order in which receive - * elements if you iterate over them. - * - * When you iterate over the elements of a parallel matrix, you - * will only be able to access the locally owned rows. (You can - * access the other rows as well, but they will look empty.) In - * that case, you probably want to call the begin() function that - * takes the row as an argument to limit the range of elements to - * loop over. + * The elements accessed by iterators within each row are ordered in the + * way in which Trilinos stores them, though the implementation guarantees + * that all elements of one row are accessed before the elements of the + * next row. If your algorithm relies on visiting elements within one row, + * you will need to consult with the Trilinos documentation on the order + * in which it stores data. It is, however, generally not a good and long- + * term stable idea to rely on the order in which receive elements if you + * iterate over them. + * + * When you iterate over the elements of a parallel matrix, you will only + * be able to access the locally owned rows. (You can access the other + * rows as well, but they will look empty.) In that case, you probably + * want to call the begin() function that takes the row as an argument to + * limit the range of elements to loop over. */ const_iterator begin () const; @@ -1725,8 +1720,8 @@ namespace TrilinosWrappers iterator begin (); /** - * Return an iterator pointing the element past the last one of - * this matrix. + * Return an iterator pointing the element past the last one of this + * matrix. */ const_iterator end () const; @@ -1738,32 +1733,30 @@ namespace TrilinosWrappers /** * Return an iterator pointing to the first element of row @p r. * - * Note that if the given row is empty, i.e. does not contain any - * nonzero entries, then the iterator returned by this function - * equals end(r). The returned iterator may not be - * dereferencable in that case if neither row @p r nor any of the - * following rows contain any nonzero entries. - * - * The elements accessed by iterators within each row are ordered - * in the way in which Trilinos stores them, though the - * implementation guarantees that all elements of one row are - * accessed before the elements of the next row. If your algorithm - * relies on visiting elements within one row, you will need to - * consult with the Trilinos documentation on the order in which - * it stores data. It is, however, generally not a good and - * long-term stable idea to rely on the order in which receive - * elements if you iterate over them. - * - * @note When you access the elements of a parallel matrix, you - * can only access the elements of rows that are actually stored - * locally. (You can access the other rows as well, but they will - * look empty.) Even then, if another processor has since written - * into, or added to, an element of the matrix that is stored on - * the current processor, then you will still see the old value of - * this entry unless you have called compress() between modifying - * the matrix element on the remote processor and accessing it on - * the current processor. See the documentation of the compress() - * function for more information. + * Note that if the given row is empty, i.e. does not contain any nonzero + * entries, then the iterator returned by this function equals + * end(r). The returned iterator may not be dereferencable in + * that case if neither row @p r nor any of the following rows contain any + * nonzero entries. + * + * The elements accessed by iterators within each row are ordered in the + * way in which Trilinos stores them, though the implementation guarantees + * that all elements of one row are accessed before the elements of the + * next row. If your algorithm relies on visiting elements within one row, + * you will need to consult with the Trilinos documentation on the order + * in which it stores data. It is, however, generally not a good and long- + * term stable idea to rely on the order in which receive elements if you + * iterate over them. + * + * @note When you access the elements of a parallel matrix, you can only + * access the elements of rows that are actually stored locally. (You can + * access the other rows as well, but they will look empty.) Even then, if + * another processor has since written into, or added to, an element of + * the matrix that is stored on the current processor, then you will still + * see the old value of this entry unless you have called compress() + * between modifying the matrix element on the remote processor and + * accessing it on the current processor. See the documentation of the + * compress() function for more information. */ const_iterator begin (const size_type r) const; @@ -1773,9 +1766,9 @@ namespace TrilinosWrappers iterator begin (const size_type r); /** - * Return an iterator pointing the element past the last one of - * row @p r , or past the end of the entire sparsity pattern if - * none of the rows after @p r contain any entries at all. + * Return an iterator pointing the element past the last one of row @p r , + * or past the end of the entire sparsity pattern if none of the rows + * after @p r contain any entries at all. * * Note that the end iterator is not necessarily dereferencable. This is * in particular the case if it is the end iterator for the last row of a diff --git a/include/deal.II/lac/trilinos_sparsity_pattern.h b/include/deal.II/lac/trilinos_sparsity_pattern.h index 377da8e29e..aeea761304 100644 --- a/include/deal.II/lac/trilinos_sparsity_pattern.h +++ b/include/deal.II/lac/trilinos_sparsity_pattern.h @@ -258,8 +258,8 @@ namespace TrilinosWrappers * with the difference that this class can work fully in %parallel according * to a partitioning of the sparsity pattern rows. * - * This class has many similarities to the DynamicSparsityPattern, since - * it can dynamically add elements to the pattern without any memory being + * This class has many similarities to the DynamicSparsityPattern, since it + * can dynamically add elements to the pattern without any memory being * previously reserved for it. However, it also has a method * SparsityPattern::compress(), that finalizes the pattern and enables its * use with Trilinos sparse matrices. @@ -340,8 +340,8 @@ namespace TrilinosWrappers * The number of columns entries per row is specified as the maximum * number of entries argument. This does not need to be an accurate * number since the entries are allocated dynamically in a similar manner - * as for the deal.II DynamicSparsityPattern classes, but a good - * estimate will reduce the setup time of the sparsity pattern. + * as for the deal.II DynamicSparsityPattern classes, but a good estimate + * will reduce the setup time of the sparsity pattern. */ void reinit (const size_type m, diff --git a/include/deal.II/lac/trilinos_vector.h b/include/deal.II/lac/trilinos_vector.h index 6d3265b0ed..59f21c6ecb 100644 --- a/include/deal.II/lac/trilinos_vector.h +++ b/include/deal.II/lac/trilinos_vector.h @@ -291,8 +291,8 @@ namespace TrilinosWrappers * Move constructor. Creates a new vector by stealing the internal data * of the vector @p v. * - * @note This constructor is only available if deal.II is configured with - * C++11 support. + * @note This constructor is only available if deal.II is configured + * with C++11 support. */ Vector (Vector &&v); #endif @@ -975,8 +975,8 @@ namespace internal template class ReinitHelper; /** - * A helper class internally used in linear_operator.h. - * Specialization for TrilinosWrappers::MPI::Vector. + * A helper class internally used in linear_operator.h. Specialization for + * TrilinosWrappers::MPI::Vector. */ template<> class ReinitHelper @@ -1002,8 +1002,8 @@ namespace internal }; /** - * A helper class internally used in linear_operator.h. - * Specialization for TrilinosWrappers::Vector. + * A helper class internally used in linear_operator.h. Specialization for + * TrilinosWrappers::Vector. */ template<> class ReinitHelper diff --git a/include/deal.II/lac/vector.h b/include/deal.II/lac/vector.h index 3d8538268e..3da392ce69 100644 --- a/include/deal.II/lac/vector.h +++ b/include/deal.II/lac/vector.h @@ -166,8 +166,8 @@ public: #ifdef DEAL_II_WITH_CXX11 /** - * Move constructor. Creates a new vector by stealing the internal data - * of the vector @p v. + * Move constructor. Creates a new vector by stealing the internal data of + * the vector @p v. * * @note This constructor is only available if deal.II is configured with * C++11 support. @@ -347,11 +347,11 @@ public: #ifdef DEAL_II_WITH_CXX11 /** - * Move the given vector. This operator replaces the present vector with - * @p v by efficiently swapping the internal data structures. + * Move the given vector. This operator replaces the present vector with @p + * v by efficiently swapping the internal data structures. * - * @note This operator is only available if deal.II is configured with - * C++11 support. + * @note This operator is only available if deal.II is configured with C++11 + * support. */ Vector &operator= (Vector &&v); #endif @@ -1001,8 +1001,8 @@ protected: private: /** - * Allocate and align @p val along 64-byte boundaries. The size - * of the allocated memory is determined by @p max_vec_size . + * Allocate and align @p val along 64-byte boundaries. The size of the + * allocated memory is determined by @p max_vec_size . */ void allocate(); diff --git a/include/deal.II/meshworker/functional.h b/include/deal.II/meshworker/functional.h index b2c4a78cf4..9e0b9b6bc1 100644 --- a/include/deal.II/meshworker/functional.h +++ b/include/deal.II/meshworker/functional.h @@ -114,8 +114,8 @@ namespace MeshWorker void initialize(AnyData &results, bool separate_faces = true); /** - * Initialize the local data in the DoFInfo object used later - * for assembling. + * Initialize the local data in the DoFInfo object used later for + * assembling. * * The info object refers to a cell if !face, or else to an * interior or boundary face. diff --git a/include/deal.II/meshworker/simple.h b/include/deal.II/meshworker/simple.h index 2c17bb892f..e4ceda1cb9 100644 --- a/include/deal.II/meshworker/simple.h +++ b/include/deal.II/meshworker/simple.h @@ -120,34 +120,32 @@ namespace MeshWorker /** - * Assemble local matrices into a single global matrix or several - * global matrices associated with the same DoFHandler. If these global - * matrix have a block structure, this structure is not used, but rather - * the global numbering of degrees of freedom. + * Assemble local matrices into a single global matrix or several global + * matrices associated with the same DoFHandler. If these global matrix + * have a block structure, this structure is not used, but rather the + * global numbering of degrees of freedom. * - * After being initialized with a SparseMatrix object (or another - * matrix offering the same functionality as SparseMatrix::add()) - * or a vector of such, this class can be used in a - * MeshWorker::loop() to assemble the cell and face matrices into - * the global matrix. + * After being initialized with a SparseMatrix object (or another matrix + * offering the same functionality as SparseMatrix::add()) or a vector of + * such, this class can be used in a MeshWorker::loop() to assemble the + * cell and face matrices into the global matrix. * * If a ConstraintMatrix has been provided during initialization, this * matrix will be used (ConstraintMatrix::distribute_local_to_global(), to * be precise) to enter the local matrix into the global sparse matrix. * - * The assembler can handle two different types of local - * data. First, by default, the obvious choice of taking a single - * local matrix with dimensions equal to the number of degrees of - * freedom of the cell. Alternatively, a local block structure - * can be initialized in DoFInfo. After this, the local data will - * be arranged as an array of n by n FullMatrix blocks (n being - * the number of blocks in the FESystem used by the DoFHandler in - * DoFInfo), which are ordered lexicographically with column index - * fastest in DoFInfo. If the matrix was initialized with a vector - * of several matrices and local block structure is used, then the - * first n2 matrices in LocalResults will be used for - * the first matrix in this vector, the second set of - * n2 for the second, and so on. + * The assembler can handle two different types of local data. First, by + * default, the obvious choice of taking a single local matrix with + * dimensions equal to the number of degrees of freedom of the cell. + * Alternatively, a local block structure can be initialized in DoFInfo. + * After this, the local data will be arranged as an array of n by n + * FullMatrix blocks (n being the number of blocks in the FESystem used by + * the DoFHandler in DoFInfo), which are ordered lexicographically with + * column index fastest in DoFInfo. If the matrix was initialized with a + * vector of several matrices and local block structure is used, then the + * first n2 matrices in LocalResults will be used for the first + * matrix in this vector, the second set of n2 for the second, + * and so on. * * @ingroup MeshWorker * @author Guido Kanschat, 2009 @@ -192,22 +190,23 @@ namespace MeshWorker void initialize_info(DOFINFO &info, bool face) const; /** - * Assemble the local matrices associated with a single cell into the global matrix. + * Assemble the local matrices associated with a single cell into the + * global matrix. */ template void assemble(const DOFINFO &info); /** - * Assemble all local matrices associated with an interior face - * in the info objects into the global matrix. + * Assemble all local matrices associated with an interior face in the + * info objects into the global matrix. */ template void assemble(const DOFINFO &info1, const DOFINFO &info2); private: /** - * Assemble a single matrix M into the element - * at index in the vector #matrix. + * Assemble a single matrix M into the element at + * index in the vector #matrix. */ void assemble(const FullMatrix &M, const unsigned int index, diff --git a/include/deal.II/numerics/error_estimator.h b/include/deal.II/numerics/error_estimator.h index bb6141468f..bfce5ce296 100644 --- a/include/deal.II/numerics/error_estimator.h +++ b/include/deal.II/numerics/error_estimator.h @@ -40,13 +40,13 @@ namespace hp /** - * Implementation of the error indicator by Kelly, De S. R. Gago, Zienkiewicz and - * Babuska and its modification for the hp-FEM. - * This error indicator tries to approximate the error per cell by - * integration of the jump of the gradient of the solution along the faces of - * each cell. It can be understood as a gradient recovery estimator; see the - * survey of Ainsworth and Oden, "A Posteriori Error Estimation in Finite Element - * Analysis" (Wiley, 2000) for a complete discussion. + * Implementation of the error indicator by Kelly, De S. R. Gago, Zienkiewicz + * and Babuska and its modification for the hp-FEM. This error indicator tries + * to approximate the error per cell by integration of the jump of the + * gradient of the solution along the faces of each cell. It can be + * understood as a gradient recovery estimator; see the survey of Ainsworth + * and Oden, "A Posteriori Error Estimation in Finite Element Analysis" + * (Wiley, 2000) for a complete discussion. * * In the original Kelly error estimator, the contribution of each face to the * cell error is scaled with the cell diagonal. In the modified version, @@ -54,13 +54,13 @@ namespace hp * polynomial degrees of the adjacent elements. The choice between the two is * done by means of the enumerator, defined within the class. * - * @note In spite of the name, Kelly estimator is not truly an a posteriori error - * estimator, even if applied to the Poisson problem only. It gives good hints - * for mesh refinement, but the estimate is not to be trusted. For higher - * order trial spaces the integrals computed here tend to zero faster than the - * error itself, thus ruling out the values as error estimators. However, the - * modified version discussed below can be utilised to obtain the reliable - * error estimator by adding the residual (volume) part. + * @note In spite of the name, Kelly estimator is not truly an a posteriori + * error estimator, even if applied to the Poisson problem only. It gives good + * hints for mesh refinement, but the estimate is not to be trusted. For + * higher order trial spaces the integrals computed here tend to zero faster + * than the error itself, thus ruling out the values as error estimators. + * However, the modified version discussed below can be utilised to obtain the + * reliable error estimator by adding the residual (volume) part. * * The error estimator really only estimates the error for the generalized * Poisson equation $-\nabla\cdot a(x) \nabla u = f$ with either Dirichlet @@ -69,9 +69,9 @@ namespace hp * * The error estimator returns a vector of estimated errors per cell which can * be used to feed the GridRefinement::refine_fixed_fraction, - * GridRefinement::refine_fixed_number, and similar functions. This - * vector contains elements of data type @p float, rather than @p double, - * since accuracy is not important in the current context. + * GridRefinement::refine_fixed_number, and similar functions. This vector + * contains elements of data type @p float, rather than @p double, since + * accuracy is not important in the current context. * * The full reference for the paper in which this error estimator is defined * is as follows: @@ -92,24 +92,24 @@ namespace hp *

            Implementation

            * * In principle, the implementation of the error estimation is simple: let \f[ - * \eta_K^2 = \sum_{F\in\partial K} c_F \int_{\partial K_F} \left[a \frac{\partial - * u_h}{\partial n}\right]^2 do \f] be the error estimator for cell $K$. - * $[\cdot]$ denotes the jump of the argument at the face. In the paper of - * Ainsworth $ c_F=\frac h{24} $, but this factor is a bit esoteric, + * \eta_K^2 = \sum_{F\in\partial K} c_F \int_{\partial K_F} \left[a + * \frac{\partial u_h}{\partial n}\right]^2 do \f] be the error estimator for + * cell $K$. $[\cdot]$ denotes the jump of the argument at the face. In the + * paper of Ainsworth $ c_F=\frac h{24} $, but this factor is a bit esoteric, * stemming from interpolation estimates and stability constants which may * hold for the Poisson problem, but may not hold for more general situations. - * Alternatively, we consider the case when $ c_F=\frac {h_F}{2p_F} $, - * where $ h_F $ is face diagonal and $ p_F=max(p^+,p^-) $ is the - * maximum polynomial degree of adjacent elements. The choice between the two is - * done by means of the enumerator, provided as the last argument in all functions. + * Alternatively, we consider the case when $ c_F=\frac {h_F}{2p_F} $, where $ + * h_F $ is face diagonal and $ p_F=max(p^+,p^-) $ is the maximum polynomial + * degree of adjacent elements. The choice between the two is done by means of + * the enumerator, provided as the last argument in all functions. * * To perform the integration, use is made of the FEFaceValues and * FESubfaceValues classes. The integration is performed by looping over all * cells and integrating over faces that are not yet treated. This way we * avoid integration on faces twice, once for each time we visit one of the * adjacent cells. In a second loop over all cells, we sum up the - * contributions of the faces (which are the integrated square of the jumps times - * some factor) of each cell and take the square root. + * contributions of the faces (which are the integrated square of the jumps + * times some factor) of each cell and take the square root. * * The integration is done using a quadrature formula on the face. For linear * trial functions (FEQ1), the QGauss2 or even the QMidpoint rule will @@ -118,17 +118,17 @@ namespace hp * * We store the contribution of each face in a @p map, as provided by the C++ * standard library, with the iterator pointing to that face being the key - * into the map. When looping the second time over all cells, - * we have to sum up the contributions of the faces and take the square root. - * For the Kelly estimator, the multiplication with $\frac h{24}$ is done - * in the second loop. By doing so we avoid problems to decide with which $h$ - * to multiply, that of the cell on the one or that of the cell on the other - * side of the face. Whereas for the hp-estimator the @p map stores integrals - * multiplied by $\frac {h_F}{2p_F}$, which are then summed in the second loop. + * into the map. When looping the second time over all cells, we have to sum + * up the contributions of the faces and take the square root. For the Kelly + * estimator, the multiplication with $\frac h{24}$ is done in the second + * loop. By doing so we avoid problems to decide with which $h$ to multiply, + * that of the cell on the one or that of the cell on the other side of the + * face. Whereas for the hp-estimator the @p map stores integrals multiplied + * by $\frac {h_F}{2p_F}$, which are then summed in the second loop. * - * $h$ ($h_F$) is taken to be the greatest length of the diagonals of the cell (face). - * For more or less uniform cells (faces) without deformed angles, this coincides - * with the diameter of the cell (face). + * $h$ ($h_F$) is taken to be the greatest length of the diagonals of the cell + * (face). For more or less uniform cells (faces) without deformed angles, + * this coincides with the diameter of the cell (face). * * *

            Vector-valued functions

            @@ -179,10 +179,9 @@ namespace hp * contribution of the face $F\in\partial K$ looks like \f[ n_F\int_F * \left|g-a\frac{\partial u_h}{\partial n}\right|^2 ds \f] where $g$ is the * Neumann boundary function, $n_F=\frac {h}{24}$ and $n_F=\frac {h_F}{p}$ for - * the Kelly and hp-estimator, respectively. - * If the finite element is vector-valued, then - * obviously the function denoting the Neumann boundary conditions needs to be - * vector-valued as well. + * the Kelly and hp-estimator, respectively. If the finite element is vector- + * valued, then obviously the function denoting the Neumann boundary + * conditions needs to be vector-valued as well. * *
          • No other boundary conditions are considered. *
          @@ -247,16 +246,16 @@ namespace hp * that accepts several in- and output vectors at the same time. * * @ingroup numerics - * @author Wolfgang Bangerth, 1998, 1999, 2000, 2004, 2006, Denis Davydov, 2015; - * parallelization by Thomas Richter, 2000 + * @author Wolfgang Bangerth, 1998, 1999, 2000, 2004, 2006, Denis Davydov, + * 2015; parallelization by Thomas Richter, 2000 */ template class KellyErrorEstimator { public: /** - * The enum type given to the class functions to decide on the scaling factors - * of the facial integrals. + * The enum type given to the class functions to decide on the scaling + * factors of the facial integrals. */ enum Strategy { @@ -311,8 +310,8 @@ public: * the number of threads determined automatically. The parameter is retained * for compatibility with old versions of the library. * - * The @p strategy parameter is used to choose the scaling factor for - * the integral over cell's faces. + * The @p strategy parameter is used to choose the scaling factor for the + * integral over cell's faces. * * @note If the DoFHandler object given as an argument to this function * builds on a parallel::distributed::Triangulation, this function skips diff --git a/include/deal.II/numerics/fe_field_function.h b/include/deal.II/numerics/fe_field_function.h index 6a49e40772..43765678d7 100644 --- a/include/deal.II/numerics/fe_field_function.h +++ b/include/deal.II/numerics/fe_field_function.h @@ -121,9 +121,9 @@ namespace Functions * @ref GlossGhostCell). * If the cell is artificial, we have no access to the solution there and * functions that evaluate the solution at such a point will trigger an - * exception of type VectorTools::ExcPointNotAvailableHere. The same - * kind of exception will also be produced if the cell is a ghost cell: On - * such cells, one could in principle evaluate the solution, but it becomes + * exception of type VectorTools::ExcPointNotAvailableHere. The same kind of + * exception will also be produced if the cell is a ghost cell: On such + * cells, one could in principle evaluate the solution, but it becomes * easier if we do not allow to do so because then there is exactly one * processor in a parallel distributed computation that can indeed evaluate * the solution. Consequently, it is clear which processor is responsible diff --git a/include/deal.II/numerics/matrix_tools.h b/include/deal.II/numerics/matrix_tools.h index 9daa1ebd2c..af1c250d9c 100644 --- a/include/deal.II/numerics/matrix_tools.h +++ b/include/deal.II/numerics/matrix_tools.h @@ -818,18 +818,17 @@ namespace MatrixTools * described in the general documentation. This function works on the * classes that are used to wrap PETSc objects. * - * Important: This function is not very efficient: it needs - * to alternatingly read and write into the matrix, a situation that - * PETSc does not handle well. In addition, we only get rid of - * rows corresponding to boundary nodes, but the corresponding case - * of deleting the respective columns (i.e. if @p eliminate_columns - * is @p true) is not presently implemented, and probably will never - * because it is too expensive without direct access to the PETSc - * data structures. (This leads to the situation where the action - * indicated by the default value of the last argument is actually - * not implemented; that argument has true as its - * default value to stay consistent with the other functions of same - * name in this class.) + * Important: This function is not very efficient: it needs to + * alternatingly read and write into the matrix, a situation that PETSc does + * not handle well. In addition, we only get rid of rows corresponding to + * boundary nodes, but the corresponding case of deleting the respective + * columns (i.e. if @p eliminate_columns is @p true) is not presently + * implemented, and probably will never because it is too expensive without + * direct access to the PETSc data structures. (This leads to the situation + * where the action indicated by the default value of the last argument is + * actually not implemented; that argument has true as its + * default value to stay consistent with the other functions of same name in + * this class.) * * This function is used in step-17 and step-18. */ @@ -843,22 +842,21 @@ namespace MatrixTools /** * Same function as above, but for parallel PETSc matrices. * - * @note If the matrix is stored in parallel across multiple - * processors using MPI, this function only touches rows that are - * locally stored and simply ignores all other rows. In other words, - * each processor is responsible for its own rows, and the @p - * boundary_values argument needs to contain all locally owned rows - * of the matrix that you want to have treated. (But it can also - * contain entries for degrees of freedom not owned locally; these - * will simply be ignored.) Further, in the context of parallel - * computations, you will get into trouble if you treat a row while - * other processors still have pending writes or additions into the - * same row. In other words, if another processor still wants to add - * something to an element of a row and you call this function to - * zero out the row, then the next time you call compress() may add - * the remote value to the zero you just created. Consequently, you - * will want to call compress() after you made the last - * modifications to a matrix and before starting to clear rows. + * @note If the matrix is stored in parallel across multiple processors + * using MPI, this function only touches rows that are locally stored and + * simply ignores all other rows. In other words, each processor is + * responsible for its own rows, and the @p boundary_values argument needs + * to contain all locally owned rows of the matrix that you want to have + * treated. (But it can also contain entries for degrees of freedom not + * owned locally; these will simply be ignored.) Further, in the context of + * parallel computations, you will get into trouble if you treat a row while + * other processors still have pending writes or additions into the same + * row. In other words, if another processor still wants to add something to + * an element of a row and you call this function to zero out the row, then + * the next time you call compress() may add the remote value to the zero + * you just created. Consequently, you will want to call compress() after + * you made the last modifications to a matrix and before starting to clear + * rows. */ void apply_boundary_values (const std::map &boundary_values, @@ -895,17 +893,16 @@ namespace MatrixTools * described in the general documentation. This function works on the * classes that are used to wrap Trilinos objects. * - * Important: This function is not very efficient: it needs - * to alternatingly read and write into the matrix, a situation that - * Trilinos does not handle well. In addition, we only get rid of - * rows corresponding to boundary nodes, but the corresponding case - * of deleting the respective columns (i.e. if @p eliminate_columns - * is @p true) is not presently implemented, and probably will never - * because it is too expensive without direct access to the Trilinos - * data structures. (This leads to the situation where the action - * indicated by the default value of the last argument is actually - * not implemented; that argument has true as its - * default value to stay consistent with the other functions of same + * Important: This function is not very efficient: it needs to + * alternatingly read and write into the matrix, a situation that Trilinos + * does not handle well. In addition, we only get rid of rows corresponding + * to boundary nodes, but the corresponding case of deleting the respective + * columns (i.e. if @p eliminate_columns is @p true) is not presently + * implemented, and probably will never because it is too expensive without + * direct access to the Trilinos data structures. (This leads to the + * situation where the action indicated by the default value of the last + * argument is actually not implemented; that argument has true + * as its default value to stay consistent with the other functions of same * name in this class.) */ void @@ -929,22 +926,21 @@ namespace MatrixTools /** * Same as above, but for parallel matrices and vectors. * - * @note If the matrix is stored in parallel across multiple - * processors using MPI, this function only touches rows that are - * locally stored and simply ignores all other rows. In other words, - * each processor is responsible for its own rows, and the @p - * boundary_values argument needs to contain all locally owned rows - * of the matrix that you want to have treated. (But it can also - * contain entries for degrees of freedom not owned locally; these - * will simply be ignored.) Further, in the context of parallel - * computations, you will get into trouble if you treat a row while - * other processors still have pending writes or additions into the - * same row. In other words, if another processor still wants to add - * something to an element of a row and you call this function to - * zero out the row, then the next time you call compress() may add - * the remote value to the zero you just created. Consequently, you - * will want to call compress() after you made the last - * modifications to a matrix and before starting to clear rows. + * @note If the matrix is stored in parallel across multiple processors + * using MPI, this function only touches rows that are locally stored and + * simply ignores all other rows. In other words, each processor is + * responsible for its own rows, and the @p boundary_values argument needs + * to contain all locally owned rows of the matrix that you want to have + * treated. (But it can also contain entries for degrees of freedom not + * owned locally; these will simply be ignored.) Further, in the context of + * parallel computations, you will get into trouble if you treat a row while + * other processors still have pending writes or additions into the same + * row. In other words, if another processor still wants to add something to + * an element of a row and you call this function to zero out the row, then + * the next time you call compress() may add the remote value to the zero + * you just created. Consequently, you will want to call compress() after + * you made the last modifications to a matrix and before starting to clear + * rows. */ void apply_boundary_values (const std::map &boundary_values, diff --git a/include/deal.II/numerics/solution_transfer.h b/include/deal.II/numerics/solution_transfer.h index 6e4bf87966..e1b5278cad 100644 --- a/include/deal.II/numerics/solution_transfer.h +++ b/include/deal.II/numerics/solution_transfer.h @@ -111,8 +111,8 @@ DEAL_II_NAMESPACE_OPEN * @endcode * * Multiple calls to the function interpolate (const Vector &in, - * Vector &out) are NOT allowed. Interpolating several functions - * can be performed in one step by using void interpolate (const + * Vector &out) are NOT allowed. Interpolating several + * functions can be performed in one step by using void interpolate (const * vector >&all_in, vector >&all_out) * const, and using the respective @p * prepare_for_coarsening_and_refinement function taking several vectors as diff --git a/include/deal.II/numerics/vector_tools.h b/include/deal.II/numerics/vector_tools.h index 6f88c53d08..4f34e33b9e 100644 --- a/include/deal.II/numerics/vector_tools.h +++ b/include/deal.II/numerics/vector_tools.h @@ -662,9 +662,9 @@ namespace VectorTools * * The parameter @p function_map provides a list of boundary indicators to * be handled by this function and corresponding boundary value functions. - * The keys of this map correspond to the number @p boundary_id of - * the face. numbers::internal_face_boundary_id is an illegal value for - * this key since it is reserved for interior faces. + * The keys of this map correspond to the number @p boundary_id of the face. + * numbers::internal_face_boundary_id is an illegal value for this key since + * it is reserved for interior faces. * * The flags in the last parameter, @p component_mask denote which * components of the finite element space shall be interpolated. If it is @@ -1072,8 +1072,8 @@ namespace VectorTools * $z$-component. * * The parameter @p boundary_component corresponds to the number @p - * boundary_id of the face. numbers::internal_face_boundary_id is an - * illegal value, since it is reserved for interior faces. + * boundary_id of the face. numbers::internal_face_boundary_id is an illegal + * value, since it is reserved for interior faces. * * The last argument is denoted to compute the normal vector $\vec{n}$ at * the boundary points. @@ -1120,44 +1120,53 @@ namespace VectorTools const hp::MappingCollection &mapping_collection = hp::StaticMappingQ1::mapping_collection); /** - * This function is an updated version of the project_boundary_values_curl_conforming - * function. The intention is to fix a problem when using the previous function in - * conjunction with non-rectangular geometries (i.e. elements with non-rectangular faces). - * The L2-projection method used has been taken from the paper "Electromagnetic scattering - * simulation using an H (curl) conforming hp finite element method in three dimensions" - * by PD Ledger, K Morgan and O Hassan ( Int. J. Num. Meth. Fluids, Volume 53, Issue 8, pages 1267–1296). + * This function is an updated version of the + * project_boundary_values_curl_conforming function. The intention is to fix + * a problem when using the previous function in conjunction with non- + * rectangular geometries (i.e. elements with non-rectangular faces). The + * L2-projection method used has been taken from the paper "Electromagnetic + * scattering simulation using an H (curl) conforming hp finite element + * method in three dimensions" by PD Ledger, K Morgan and O Hassan ( Int. J. + * Num. Meth. Fluids, Volume 53, Issue 8, pages 1267–1296). * - * This function will compute constraints that correspond to Dirichlet boundary conditions of the form - * $\vec{n}\times\vec{E}=\vec{n}\times\vec{F}$ - * i.e. the tangential components of $\vec{E}$ and $f$ shall coincide. + * This function will compute constraints that correspond to Dirichlet + * boundary conditions of the form + * $\vec{n}\times\vec{E}=\vec{n}\times\vec{F}$ i.e. the tangential + * components of $\vec{E}$ and $f$ shall coincide. * *

          Computing constraints

          * - * To compute the constraints we use a projection method based upon the paper mentioned - * above. In 2D this is done in a single stage for the edge-based shape functions, regardless - * of the order of the finite element. In 3D this is done in two stages, edges first and then - * faces. + * To compute the constraints we use a projection method based upon the + * paper mentioned above. In 2D this is done in a single stage for the edge- + * based shape functions, regardless of the order of the finite element. In + * 3D this is done in two stages, edges first and then faces. * - * For each cell, each edge, $e$, is projected by solving the linear system $Ax=b$ where $x$ - * is the vector of contraints on degrees of freedom on the edge and + * For each cell, each edge, $e$, is projected by solving the linear system + * $Ax=b$ where $x$ is the vector of contraints on degrees of freedom on the + * edge and * * $A_{ij} = \int_{e} (\vec{s}_{i}\cdot\vec{t})(\vec{s}_{j}\cdot\vec{t}) dS$ * * $b_{i} = \int_{e} (\vec{s}_{i}\cdot\vec{t})(\vec{F}\cdot\vec{t}) dS$ * - * with $\vec{s}_{i}$ the $i^{th}$ shape function and $\vec{t}$ the tangent vector. + * with $\vec{s}_{i}$ the $i^{th}$ shape function and $\vec{t}$ the tangent + * vector. * - * Once all edge constraints, $x$, have been computed, we may compute the face constraints - * in a similar fashion, taking into account the residuals from the edges. + * Once all edge constraints, $x$, have been computed, we may compute the + * face constraints in a similar fashion, taking into account the residuals + * from the edges. * - * For each face on the cell, $f$, we solve the linear system $By=c$ where $y$ is the vector of - * constraints on degrees of freedom on the face and + * For each face on the cell, $f$, we solve the linear system $By=c$ where + * $y$ is the vector of constraints on degrees of freedom on the face and * - * $B_{ij} = \int_{f} (\vec{n} \times \vec{s}_{i}) \cdot (\vec{n} \times \vec{s}_{j}) dS$ + * $B_{ij} = \int_{f} (\vec{n} \times \vec{s}_{i}) \cdot (\vec{n} \times + * \vec{s}_{j}) dS$ * - * $c_{i} = \int_{f} (\vec{n} \times \vec{r}) \cdot (\vec{n} \times \vec{s}_i) dS$ + * $c_{i} = \int_{f} (\vec{n} \times \vec{r}) \cdot (\vec{n} \times + * \vec{s}_i) dS$ * - * and $\vec{r} = \vec{F} - \sum_{e \in f} \sum{i \in e} x_{i}\vec{s}_i$, the edge residual. + * and $\vec{r} = \vec{F} - \sum_{e \in f} \sum{i \in e} x_{i}\vec{s}_i$, + * the edge residual. * * The resulting constraints are then given in the solutions $x$ and $y$. * @@ -1165,37 +1174,39 @@ namespace VectorTools * constraints before, the new ones are added or the old ones overwritten, * if a node of the boundary part to be used was already in the list of * constraints. This is handled by using inhomogeneous constraints. Please - * note that when combining adaptive meshes and this kind of constraints, the - * Dirichlet conditions should be set first, and then completed by hanging - * node constraints, in order to make sure that the discretization remains - * consistent. See the discussion on conflicting constraints in the + * note that when combining adaptive meshes and this kind of constraints, + * the Dirichlet conditions should be set first, and then completed by + * hanging node constraints, in order to make sure that the discretization + * remains consistent. See the discussion on conflicting constraints in the * module on * @ref constraints. * *

          Arguments to this function>

          * - * This function is explicitly for use with FE_Nedelec elements, or with FESystem - * elements which contain FE_Nedelec elements. It will throw an exception if called - * with any other finite element. The user must ensure that FESystem elements are - * correctly setup when using this function as this check not possible in this case. + * This function is explicitly for use with FE_Nedelec elements, or with + * FESystem elements which contain FE_Nedelec elements. It will throw an + * exception if called with any other finite element. The user must ensure + * that FESystem elements are correctly setup when using this function as + * this check not possible in this case. * - * The second argument of this function denotes the first vector component of the - * finite element which corresponds to the vector function that you wish to constrain. - * For example, if we are solving Maxwell's equations in 3D and have components - * $(E_x,E_y,E_z,B_x,B_y,B_z)$ and we want the boundary conditions - * $\vec{n}\times\vec{B}=\vec{n}\times\vec{f}$, then @p first_vector_component would - * be 3. The @p boundary_function must return 6 components in this example, with the first 3 - * corresponding to $\vec{E}$ and the second 3 corresponding to $\vec{B}$. - * Vectors are implicitly assumed to have exactly dim components - * that are ordered in the same way as we usually order the coordinate directions, - * i.e. $x$-, $y$-, and finally $z$-component. + * The second argument of this function denotes the first vector component + * of the finite element which corresponds to the vector function that you + * wish to constrain. For example, if we are solving Maxwell's equations in + * 3D and have components $(E_x,E_y,E_z,B_x,B_y,B_z)$ and we want the + * boundary conditions $\vec{n}\times\vec{B}=\vec{n}\times\vec{f}$, then @p + * first_vector_component would be 3. The @p boundary_function must return 6 + * components in this example, with the first 3 corresponding to $\vec{E}$ + * and the second 3 corresponding to $\vec{B}$. Vectors are implicitly + * assumed to have exactly dim components that are ordered in + * the same way as we usually order the coordinate directions, i.e. $x$-, + * $y$-, and finally $z$-component. * - * The parameter @p boundary_component corresponds to the number @p boundary_id - * of the face. numbers::internal_face_boundary_id is an illegal value, since it is - * reserved for interior faces. + * The parameter @p boundary_component corresponds to the number @p + * boundary_id of the face. numbers::internal_face_boundary_id is an illegal + * value, since it is reserved for interior faces. * - * The last argument is denoted to compute the normal vector $\vec{n}$ at the - * boundary points. + * The last argument is denoted to compute the normal vector $\vec{n}$ at + * the boundary points. * * * @ingroup constraints @@ -1213,7 +1224,8 @@ namespace VectorTools /** - * hp-namespace version of project_boundary_values_curl_conforming_l2 (above). + * hp-namespace version of project_boundary_values_curl_conforming_l2 + * (above). * * @ingroup constraints */ @@ -1255,11 +1267,11 @@ namespace VectorTools * we usually order the coordinate directions, i.e., $x$-, $y$-, and finally * $z$-component. * - * The parameter @p boundary_component corresponds to the @p - * boundary_id of the faces where the boundary conditions are - * applied. numbers::internal_face_boundary_id is an illegal value, since it - * is reserved for interior faces. The @p mapping is used to compute the - * normal vector $\vec{n}$ at the boundary points. + * The parameter @p boundary_component corresponds to the @p boundary_id of + * the faces where the boundary conditions are applied. + * numbers::internal_face_boundary_id is an illegal value, since it is + * reserved for interior faces. The @p mapping is used to compute the normal + * vector $\vec{n}$ at the boundary points. * *

          Computing constraints

          * @@ -1813,12 +1825,12 @@ namespace VectorTools * formula only evaluates the two solutions at these particular points, * choosing this quadrature formula may indicate an error far smaller than * it actually is. - * @param[in] norm The norm $X$ shown above that should be computed. If - * the norm is NormType::Hdiv_seminorm, then the finite element on which this - * function is called needs to have at least dim vector components, - * and the divergence will be computed on the first div components. - * This works, for example, on the finite elements used for the - * mixed Laplace (step-20) and the Stokes equations (step-22). + * @param[in] norm The norm $X$ shown above that should be computed. If the + * norm is NormType::Hdiv_seminorm, then the finite element on which this + * function is called needs to have at least dim vector components, and the + * divergence will be computed on the first div components. This works, for + * example, on the finite elements used for the mixed Laplace (step-20) and + * the Stokes equations (step-22). * @param[in] weight The additional argument @p weight allows to evaluate * weighted norms. The weight function may be scalar, establishing a * spatially variable weight in the domain for all components equally. This @@ -2109,16 +2121,16 @@ namespace VectorTools const Point &point); /** - * Evaluate a possibly vector-valued finite element function defined by the - * given DoFHandler and nodal vector at the given point, and return the - * (vector) gradient of this function through the last argument. - * - * This is a wrapper function using a Q1-mapping for cell boundaries to call - * the other point_gradient() function. - * - * @note If the cell in which the point is found is not locally owned, an - * exception of type VectorTools::ExcPointNotAvailableHere is thrown. - */ + * Evaluate a possibly vector-valued finite element function defined by the + * given DoFHandler and nodal vector at the given point, and return the + * (vector) gradient of this function through the last argument. + * + * This is a wrapper function using a Q1-mapping for cell boundaries to call + * the other point_gradient() function. + * + * @note If the cell in which the point is found is not locally owned, an + * exception of type VectorTools::ExcPointNotAvailableHere is thrown. + */ template void point_gradient (const DoFHandler &dof, @@ -2333,30 +2345,27 @@ namespace VectorTools */ //@{ /** - * Given a DoFHandler containing at least a spacedim vector field, - * this function interpolates the Triangulation at the support - * points of a FE_Q() finite element of the same degree as - * dh->get_fe().degree. + * Given a DoFHandler containing at least a spacedim vector field, this + * function interpolates the Triangulation at the support points of a FE_Q() + * finite element of the same degree as dh->get_fe().degree. * * Curved manifold are respected, and the resulting VECTOR will be * geometrically consistent. * - * The resulting map is guaranteed to be interpolatory at the - * support points of a FE_Q() finite element of the same degree as - * dh->get_fe().degree. Notice that this may or may not be - * meaningful, depending on the FiniteElement you have distribed in - * dh. + * The resulting map is guaranteed to be interpolatory at the support points + * of a FE_Q() finite element of the same degree as dh->get_fe().degree. + * Notice that this may or may not be meaningful, depending on the + * FiniteElement you have distribed in dh. * * If the underlying finite element is an FE_Q(1)^spacedim, then the - * resulting VECTOR is a finite element field representation of the - * vertices of the Triangulation. + * resulting VECTOR is a finite element field representation of the vertices + * of the Triangulation. * * The optional ComponentMask argument can be used to specify what - * components of the FiniteElement to use to describe the - * geometry. If no mask is specified at construction time, then a - * default one is used, i.e., the first spacedim components of the - * FiniteElement are assumed to represent the geometry of the - * problem. + * components of the FiniteElement to use to describe the geometry. If no + * mask is specified at construction time, then a default one is used, i.e., + * the first spacedim components of the FiniteElement are assumed to + * represent the geometry of the problem. * * @author Luca Heltai, 2015 */