From: Denis Davydov Date: Thu, 9 Feb 2017 16:56:09 +0000 (+0100) Subject: hack doxygen to show additional methods of FEEValution for partial specialization X-Git-Tag: v8.5.0-rc1~116^2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=refs%2Fpull%2F3970%2Fhead;p=dealii.git hack doxygen to show additional methods of FEEValution for partial specialization --- diff --git a/include/deal.II/matrix_free/fe_evaluation.h b/include/deal.II/matrix_free/fe_evaluation.h index 11064e33bf..681567a398 100644 --- a/include/deal.II/matrix_free/fe_evaluation.h +++ b/include/deal.II/matrix_free/fe_evaluation.h @@ -1923,6 +1923,43 @@ public: */ FEEvaluation &operator= (const FEEvaluation &other); +#ifdef DOXYGEN + // doxygen does not anyhow mentions functions coming from partial template + // specialization of the base class, in this case FEEvaluationAccess. + // For now, hack-in those functions manually only to fix documentation: + + /** @copydoc FEEvaluationAccess::get_divergence() + * @note: only available for n_components_==dim. + */ + VectorizedArray get_divergence (const unsigned int q_point) const; + + /** @copydoc FEEvaluationAccess::get_symmetric_gradient() + * @note: only available for n_components_==dim. + */ + SymmetricTensor<2, dim, VectorizedArray > get_symmetric_gradient (const unsigned int q_point) const; + + /** @copydoc FEEvaluationAccess::get_curl() + * @note: only available for n_components_==dim. + */ + Tensor<1,(dim==2?1:dim), VectorizedArray > get_curl (const unsigned int q_point) const; + + /** @copydoc FEEvaluationAccess::submit_divergence() + * @note: only available for n_components_==dim. + */ + void submit_divergence (const VectorizedArray div_in, const unsigned int q_point); + + /** @copydoc FEEvaluationAccess::submit_symmetric_gradient() + * @note: only available for n_components_==dim. + */ + void submit_symmetric_gradient (const SymmetricTensor<2, dim, VectorizedArray > grad_in, const unsigned int q_point); + + /** @copydoc FEEvaluationAccess::submit_curl() + * @note: only available for n_components_==dim. + */ + void submit_curl (const Tensor<1, dim==2?1:dim, VectorizedArray > curl_in, const unsigned int q_point); + +#endif + /** * Evaluates the function values, the gradients, and the Laplacians of the * FE function given at the DoF values in the input vector at the quadrature