From 93a9666d4a298c505f79740606eca383259f2b78 Mon Sep 17 00:00:00 2001 From: Svenja Schoeder Date: Sat, 8 Sep 2018 01:54:45 +0200 Subject: [PATCH] line break and improvements in comments --- doc/news/changes/minor/20180821SvenjaSchoeder | 4 +++- include/deal.II/matrix_free/fe_evaluation.h | 21 ++++++++++++------- 2 files changed, 16 insertions(+), 9 deletions(-) diff --git a/doc/news/changes/minor/20180821SvenjaSchoeder b/doc/news/changes/minor/20180821SvenjaSchoeder index 626e749bea..f8a03c2cf6 100644 --- a/doc/news/changes/minor/20180821SvenjaSchoeder +++ b/doc/news/changes/minor/20180821SvenjaSchoeder @@ -1,3 +1,5 @@ New: Add a mask argument to filter out some vector lanes in FEEvaluationBase -This is required for local time stepping using the MatrixFree framework, because some cells of batches must be excluded from read/write operations when operating on different time steps compared to their neighbor cells. +This is required for local time stepping using the MatrixFree framework, +because some cells of batches must be excluded from read/write operations +when operating on different time steps compared to their neighbor cells. (Svenja Schoeder, 2018/08/21) diff --git a/include/deal.II/matrix_free/fe_evaluation.h b/include/deal.II/matrix_free/fe_evaluation.h index ddfd44fb50..5addf27267 100644 --- a/include/deal.II/matrix_free/fe_evaluation.h +++ b/include/deal.II/matrix_free/fe_evaluation.h @@ -221,10 +221,13 @@ public: * during the write operation. The functionality is hence similar to the * function AffineConstraints::distribute_local_to_global. If vectorization * is enabled, the DoF values for several cells are used. The mask can be - * used to suppress the write access for some of the vectorized cells, e.g. - * in case of local time stepping, where some cells are excluded from a - * call. A value of `true` in the bitset means that the respective lane - * index will be processed, whereas a value of `false` skips this index. + * used to suppress the write access for some of the cells contained in the + * current cell vectorization batch, e.g. in case of local time stepping, + * where some cells are excluded from a call. A value of `true` in the + * bitset means that the respective lane index will be processed, whereas a + * value of `false` skips this index. The default setting is a bitset that + * contains all ones, which will write the accumulated integrals to all + * cells in the batch. * * If this class was constructed without a MatrixFree object and the * information is acquired on the fly through a @@ -259,10 +262,12 @@ public: * associated to more than one cell (as usual in continuous finite * elements), the values will be overwritten and only the value written last * is retained. The mask can be used to suppress the write access for some - * of the vectorized cells, e.g. in case of local time stepping, where some - * cells are excluded from a call. A value of `true` in the bitset means - * that the respective lane index will be processed, whereas a value of - * `false` skips this index. + * of the cells contained in the current cell vectorization batch, e.g. in + * case of local time stepping, where some cells are excluded from a call. + * A value of `true` in the bitset means that the respective lane index will + * be processed, whereas a value of `false` skips this index. The default + * setting is a bitset that contains all ones, which will write the + * accumulated integrals to all cells in the batch. * * If this class was constructed without a MatrixFree object and the * information is acquired on the fly through a -- 2.39.5