#9 Invariant: fix some Doxygen errors induced by recent changes.

Sources/Operators/GlobalVariationalOperator/Internal/Helper.hxx

@@ -290,8 +290,8 @@ namespace HappyHeart
                 }
                 
                 // \todo #881 Here I assumed clearly exactly one unknown is expected for row and columm!
-                assert(row_unknown_list.size() == 1 && "See #881");
-                assert(col_unknown_list.size() == 1 && "See #881");
+                assert(row_unknown_list.size() == 1 && "See #881 and check numbering subsets of matrix into which you assemble.");
+                assert(col_unknown_list.size() == 1 && "See #881 and check numbering subsets of matrix into which you assemble.");
                 const auto& unknown1 = *(row_unknown_list.front());
                 const auto& unknown2 = *(col_unknown_list.front());
                 

Sources/Operators/LocalVariationalOperator/CauchyAndInvariant/InvariantComputation.hpp

@@ -27,7 +27,7 @@ namespace HappyHeart
      * \copydoc doxygen_hide_cauchy_green_tensor_as_vector_arg
      */
     template<unsigned int DimensionT>
-    double Invariant1(const LocalVector& tensor) noexcept;
+    double Invariant1(const LocalVector& cauchy_green_tensor) noexcept;
     
     /*!
      * \brief Returns second invariant.
@@ -35,7 +35,7 @@ namespace HappyHeart
      * \copydoc doxygen_hide_cauchy_green_tensor_as_vector_arg
      */
     template<unsigned int DimensionT>
-    double Invariant2(const LocalVector& tensor) noexcept;
+    double Invariant2(const LocalVector& cauchy_green_tensor) noexcept;
     
     /*!
      * \brief Returns third invariant.
@@ -43,55 +43,72 @@ namespace HappyHeart
      * \copydoc doxygen_hide_cauchy_green_tensor_as_vector_arg
      */
     template<unsigned int DimensionT>
-    double Invariant3(const LocalVector& tensor) noexcept;
+    double Invariant3(const LocalVector& cauchy_green_tensor) noexcept;
+    
     
     /*!
-     * \brief Returns first derivative of first invariant with respect to Cauchy-Green tensor.
+     * \class doxygen_hide_invariant_first_deriv_arg
+     *
+     * \copydoc doxygen_hide_cauchy_green_tensor_as_vector_arg
+     * \param[out] out Vector which stores the derivative of the invariant. Must be already properly allocated.
+     */
+    
+    
+    /*!
+     * \class doxygen_hide_invariant_second_deriv_arg
      *
      * \copydoc doxygen_hide_cauchy_green_tensor_as_vector_arg
+     * \param[out] out Matrix which stores the second derivative of the invariant. Must be already properly allocated.
+     */
+    
+    
+    /*!
+     * \brief Returns first derivative of first invariant with respect to Cauchy-Green tensor.
+     *
+     * \copydoc doxygen_hide_invariant_first_deriv_arg
      */
     template<unsigned int DimensionT>
-    void FirstDerivativeInvariant1CauchyGreen(const LocalVector& tensor, LocalVector& out);
+    void FirstDerivativeInvariant1CauchyGreen(const LocalVector& cauchy_green_tensor, LocalVector& out);
     
     /*!
      * \brief Returns first derivative of second invariant with respect to Cauchy-Green tensor.
      *
-     * \copydoc doxygen_hide_cauchy_green_tensor_as_vector_arg
+     * \copydoc doxygen_hide_invariant_first_deriv_arg
      */
     template<unsigned int DimensionT>
-    void FirstDerivativeInvariant2CauchyGreen(const LocalVector& tensor, LocalVector& out);
+    void FirstDerivativeInvariant2CauchyGreen(const LocalVector& cauchy_green_tensor, LocalVector& out);
     
     /*!
      * \brief Returns first derivative of third invariant with respect to Cauchy-Green tensor.
      *
-     * \copydoc doxygen_hide_cauchy_green_tensor_as_vector_arg
+     * \copydoc doxygen_hide_invariant_first_deriv_arg
      */
     template<unsigned int DimensionT>
-    void FirstDerivativeInvariant3CauchyGreen(const LocalVector& tensor, LocalVector& out);
+    void FirstDerivativeInvariant3CauchyGreen(const LocalVector& cauchy_green_tensor, LocalVector& out);
     
     /*!
      * \brief Returns second derivative of first invariant with respect to Cauchy-Green tensor.
      *
-     * \copydoc doxygen_hide_cauchy_green_tensor_as_vector_arg
+     * \copydoc doxygen_hide_invariant_second_deriv_arg
      */
     template<unsigned int DimensionT>
-    void SecondDerivativeInvariant1CauchyGreen(const LocalVector& tensor, LocalMatrix& out);
+    void SecondDerivativeInvariant1CauchyGreen(const LocalVector& cauchy_green_tensor, LocalMatrix& out);
     
     /*!
      * \brief Returns second derivative of second invariant with respect to Cauchy-Green tensor.
      *
-     * \copydoc doxygen_hide_cauchy_green_tensor_as_vector_arg
+     * \copydoc doxygen_hide_invariant_second_deriv_arg
      */
     template<unsigned int DimensionT>
-    void SecondDerivativeInvariant2CauchyGreen(const LocalVector& tensor, LocalMatrix& out);
+    void SecondDerivativeInvariant2CauchyGreen(const LocalVector& cauchy_green_tensor, LocalMatrix& out);
     
     /*!
      * \brief Returns second derivative of third invariant with respect to Cauchy-Green tensor.
      *
-     * \copydoc doxygen_hide_cauchy_green_tensor_as_vector_arg
+     * \copydoc doxygen_hide_invariant_second_deriv_arg
      */
     template<unsigned int DimensionT>
-    void SecondDerivativeInvariant3CauchyGreen(const LocalVector& tensor, LocalMatrix& out);
+    void SecondDerivativeInvariant3CauchyGreen(const LocalVector& cauchy_green_tensor, LocalMatrix& out);