From: Martin Kronbichler Date: Sun, 29 Apr 2018 14:24:24 +0000 (+0200) Subject: Fix copydoc in FEEvaluationBase. X-Git-Tag: v9.0.0-rc1~70^2~2 X-Git-Url: https://gitweb.dealii.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=dcd5acfe4f1033f1c72061b2513f8a84a92582fb;p=dealii.git Fix copydoc in FEEvaluationBase. --- diff --git a/include/deal.II/matrix_free/fe_evaluation.h b/include/deal.II/matrix_free/fe_evaluation.h index 0e0389b60b..67370d3ab4 100644 --- a/include/deal.II/matrix_free/fe_evaluation.h +++ b/include/deal.II/matrix_free/fe_evaluation.h @@ -425,22 +425,22 @@ public: // specialization of the base class, in this case FEEvaluationAccess. // For now, hack-in those functions manually only to fix documentation: - /** @copydoc FEEvaluationAccess::get_divergence() + /** @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() + /** @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() + /** @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() + /** @copydoc FEEvaluationAccess::submit_divergence() * @note Only available for n_components_==dim. * * @note This operation writes the data to the same field as @@ -450,7 +450,7 @@ public: */ void submit_divergence (const VectorizedArray div_in, const unsigned int q_point); - /** @copydoc FEEvaluationAccess::submit_symmetric_gradient() + /** @copydoc FEEvaluationAccess::submit_symmetric_gradient() * @note Only available for n_components_==dim. * * @note This operation writes the data to the same field as @@ -461,7 +461,7 @@ public: */ void submit_symmetric_gradient (const SymmetricTensor<2, dim, VectorizedArray > grad_in, const unsigned int q_point); - /** @copydoc FEEvaluationAccess::submit_curl() + /** @copydoc FEEvaluationAccess::submit_curl() * @note Only available for n_components_==dim. * * @note This operation writes the data to the same field as @@ -1129,61 +1129,61 @@ public: static constexpr unsigned int dimension = dim; typedef FEEvaluationBase BaseClass; - /** @copydoc FEEvaluationBase::get_dof_value() + /** @copydoc FEEvaluationBase::get_dof_value() */ value_type get_dof_value (const unsigned int dof) const; - /** @copydoc FEEvaluationBase::submit_dof_value() + /** @copydoc FEEvaluationBase::submit_dof_value() */ void submit_dof_value (const value_type val_in, const unsigned int dof); - /** @copydoc FEEvaluationBase::get_value() + /** @copydoc FEEvaluationBase::get_value() */ value_type get_value (const unsigned int q_point) const; - /** @copydoc FEEvaluationBase::submit_value() + /** @copydoc FEEvaluationBase::submit_value() */ void submit_value (const value_type val_in, const unsigned int q_point); - /** @copydoc FEEvaluationBase::submit_value() + /** @copydoc FEEvaluationBase::submit_value() */ void submit_value (const Tensor<1,1,VectorizedArray > val_in, const unsigned int q_point); - /** @copydoc FEEvaluationBase::get_gradient() + /** @copydoc FEEvaluationBase::get_gradient() */ gradient_type get_gradient (const unsigned int q_point) const; - /** @copydoc FEEvaluationBase::get_normal_derivative() + /** @copydoc FEEvaluationBase::get_normal_derivative() */ value_type get_normal_derivative (const unsigned int q_point) const; - /** @copydoc FEEvaluationBase::submit_gradient() + /** @copydoc FEEvaluationBase::submit_gradient() */ void submit_gradient(const gradient_type grad_in, const unsigned int q_point); - /** @copydoc FEEvaluationBase::submit_normal_derivative() + /** @copydoc FEEvaluationBase::submit_normal_derivative() */ void submit_normal_derivative(const value_type grad_in, const unsigned int q_point); - /** @copydoc FEEvaluationBase::get_hessian() + /** @copydoc FEEvaluationBase::get_hessian() */ Tensor<2,dim,VectorizedArray > get_hessian (unsigned int q_point) const; - /** @copydoc FEEvaluationBase::get_hessian_diagonal() + /** @copydoc FEEvaluationBase::get_hessian_diagonal() */ gradient_type get_hessian_diagonal (const unsigned int q_point) const; - /** @copydoc FEEvaluationBase::get_laplacian() + /** @copydoc FEEvaluationBase::get_laplacian() */ value_type get_laplacian (const unsigned int q_point) const; - /** @copydoc FEEvaluationBase::integrate_value() + /** @copydoc FEEvaluationBase::integrate_value() */ value_type integrate_value () const; @@ -1250,7 +1250,7 @@ public: static constexpr unsigned int n_components = dim; typedef FEEvaluationBase BaseClass; - /** @copydoc FEEvaluationBase::get_gradient() + /** @copydoc FEEvaluationBase::get_gradient() */ gradient_type get_gradient (const unsigned int q_point) const; @@ -1276,16 +1276,16 @@ public: Tensor<1,(dim==2?1:dim),VectorizedArray > get_curl (const unsigned int q_point) const; - /** @copydoc FEEvaluationBase::get_hessian() + /** @copydoc FEEvaluationBase::get_hessian() */ Tensor<3,dim,VectorizedArray > get_hessian (const unsigned int q_point) const; - /** @copydoc FEEvaluationBase::get_hessian_diagonal() + /** @copydoc FEEvaluationBase::get_hessian_diagonal() */ gradient_type get_hessian_diagonal (const unsigned int q_point) const; - /** @copydoc FEEvaluationBase::submit_gradient() + /** @copydoc FEEvaluationBase::submit_gradient() */ void submit_gradient(const gradient_type grad_in, const unsigned int q_point); @@ -1391,71 +1391,71 @@ public: static constexpr unsigned int dimension = 1; typedef FEEvaluationBase<1,1,Number,is_face> BaseClass; - /** @copydoc FEEvaluationBase<1,1,Number>::get_dof_value() + /** @copydoc FEEvaluationBase<1,1,Number,is_face>::get_dof_value() */ value_type get_dof_value (const unsigned int dof) const; - /** @copydoc FEEvaluationBase<1,1,Number>::submit_dof_value() + /** @copydoc FEEvaluationBase<1,1,Number,is_face>::submit_dof_value() */ void submit_dof_value (const value_type val_in, const unsigned int dof); - /** @copydoc FEEvaluationBase<1,1,Number>::get_value() + /** @copydoc FEEvaluationBase<1,1,Number,is_face>::get_value() */ value_type get_value (const unsigned int q_point) const; - /** @copydoc FEEvaluationBase<1,1,Number>::submit_value() + /** @copydoc FEEvaluationBase<1,1,Number,is_face>::submit_value() */ void submit_value (const value_type val_in, const unsigned int q_point); - /** @copydoc FEEvaluationBase<1,1,Number>::submit_value() + /** @copydoc FEEvaluationBase<1,1,Number,is_face>::submit_value() */ void submit_value (const gradient_type val_in, const unsigned int q_point); - /** @copydoc FEEvaluationBase<1,1,Number>::get_gradient() + /** @copydoc FEEvaluationBase<1,1,Number,is_face>::get_gradient() */ gradient_type get_gradient (const unsigned int q_point) const; - /** @copydoc FEEvaluationBase::get_normal_derivative() + /** @copydoc FEEvaluationBase::get_normal_derivative() */ value_type get_normal_derivative (const unsigned int q_point) const; - /** @copydoc FEEvaluationBase<1,1,Number>::submit_gradient() + /** @copydoc FEEvaluationBase<1,1,Number,is_face>::submit_gradient() */ void submit_gradient(const gradient_type grad_in, const unsigned int q_point); - /** @copydoc FEEvaluationBase<1,1,Number>::submit_gradient() + /** @copydoc FEEvaluationBase<1,1,Number,is_face>::submit_gradient() */ void submit_gradient(const value_type grad_in, const unsigned int q_point); - /** @copydoc FEEvaluationBase<1,1,Number>::submit_normal_derivative() + /** @copydoc FEEvaluationBase<1,1,Number,is_face>::submit_normal_derivative() */ void submit_normal_derivative(const value_type grad_in, const unsigned int q_point); - /** @copydoc FEEvaluationBase<1,1,Number>::submit_normal_derivative() + /** @copydoc FEEvaluationBase<1,1,Number,is_face>::submit_normal_derivative() */ void submit_normal_derivative(const gradient_type grad_in, const unsigned int q_point); - /** @copydoc FEEvaluationBase<1,1,Number>::get_hessian() + /** @copydoc FEEvaluationBase<1,1,Number,is_face>::get_hessian() */ Tensor<2,1,VectorizedArray > get_hessian (unsigned int q_point) const; - /** @copydoc FEEvaluationBase<1,1,Number>::get_hessian_diagonal() + /** @copydoc FEEvaluationBase<1,1,Number,is_face>::get_hessian_diagonal() */ gradient_type get_hessian_diagonal (const unsigned int q_point) const; - /** @copydoc FEEvaluationBase<1,1,Number>::get_laplacian() + /** @copydoc FEEvaluationBase<1,1,Number,is_face>::get_laplacian() */ value_type get_laplacian (const unsigned int q_point) const; - /** @copydoc FEEvaluationBase<1,1,Number>::integrate_value() + /** @copydoc FEEvaluationBase<1,1,Number,is_face>::integrate_value() */ value_type integrate_value () const;