From 4515940b76fdfd0a47e975dd1e8e5821e1fc70ee Mon Sep 17 00:00:00 2001 From: Sandro Elsweijer Date: Mon, 4 Sep 2023 10:21:24 +0200 Subject: [PATCH] add some more math mode --- src/t8_geometry/t8_geometry_base.hxx | 4 ++-- .../t8_geometry_implementations/t8_geometry_analytic.hxx | 4 ++-- .../t8_geometry_implementations/t8_geometry_linear.hxx | 4 ++-- .../t8_geometry_linear_axis_aligned.cxx | 4 ++-- .../t8_geometry_linear_axis_aligned.hxx | 4 ++-- .../t8_geometry_implementations/t8_geometry_occ.hxx | 4 ++-- .../t8_geometry_implementations/t8_geometry_zero.hxx | 4 ++-- 7 files changed, 14 insertions(+), 14 deletions(-) diff --git a/src/t8_geometry/t8_geometry_base.hxx b/src/t8_geometry/t8_geometry_base.hxx index 095eb0d9c7..03fb3c5670 100644 --- a/src/t8_geometry/t8_geometry_base.hxx +++ b/src/t8_geometry/t8_geometry_base.hxx @@ -73,8 +73,8 @@ struct t8_geometry * \param [in] cmesh The cmesh in which the point lies. * \param [in] glreeid The global tree (of the cmesh) in which the reference point is. * \param [in] ref_coords Array of \a dimension many entries, specifying a point in \f$ [0,1]^\mathrm{dim} \f$. - * \param [out] jacobian The jacobian at \a ref_coords. Array of size dimension x 3. Indices 3*i, 3*i+1, 3*i+2 - * correspond to the i-th column of the jacobian (Entry 3*i + j is \f$ \frac{\partial f_j}{\partial x_i} \f$). + * \param [out] jacobian The jacobian at \a ref_coords. Array of size \f$ \mathrm{dim} \cdot 3 \f$. Indices \f$ 3 \cdot i\f$ , \f$ 3 \cdot i+1 \f$ , \f$ 3 \cdot i+2 \f$ + * correspond to the \f$ i \f$-th column of the jacobian (Entry \f$ 3 \cdot i + j \f$ is \f$ \frac{\partial f_j}{\partial x_i} \f$). */ virtual void t8_geom_evaluate_jacobian (t8_cmesh_t cmesh, t8_gloidx_t gtreeid, const double *ref_coords, double *jacobian) const diff --git a/src/t8_geometry/t8_geometry_implementations/t8_geometry_analytic.hxx b/src/t8_geometry/t8_geometry_implementations/t8_geometry_analytic.hxx index 23c0807d9e..3e936ceb5e 100644 --- a/src/t8_geometry/t8_geometry_implementations/t8_geometry_analytic.hxx +++ b/src/t8_geometry/t8_geometry_implementations/t8_geometry_analytic.hxx @@ -100,8 +100,8 @@ struct t8_geometry_analytic: public t8_geometry * \param [in] cmesh The cmesh in which the point lies. * \param [in] gtreeid The global tree (of the cmesh) in which the reference point is. * \param [in] ref_coords Array of \a dimension many entries, specifying a point in \f$ [0,1]^\mathrm{dim} \f$. - * \param [out] jacobian The jacobian at \a ref_coords. Array of size dimension x 3. Indices 3*i, 3*i+1, 3*i+2 - * correspond to the i-th column of the jacobian (Entry 3*i + j is \f$ \frac{\partial f_j}{\partial x_i} \f$). + * \param [out] jacobian The jacobian at \a ref_coords. Array of size \f$ \mathrm{dim} \cdot 3 \f$. Indices \f$ 3 \cdot i\f$ , \f$ 3 \cdot i+1 \f$ , \f$ 3 \cdot i+2 \f$ + * correspond to the \f$ i \f$-th column of the jacobian (Entry \f$ 3 \cdot i + j \f$ is \f$ \frac{\partial f_j}{\partial x_i} \f$). * \note The jacobian will be * (1) (1 0) (1 0 0) * dim 1: J = (0) dim 2: J = (0 1) dim 3: J = (0 1 0) diff --git a/src/t8_geometry/t8_geometry_implementations/t8_geometry_linear.hxx b/src/t8_geometry/t8_geometry_implementations/t8_geometry_linear.hxx index 63ab07ef7c..d96fb08773 100644 --- a/src/t8_geometry/t8_geometry_implementations/t8_geometry_linear.hxx +++ b/src/t8_geometry/t8_geometry_implementations/t8_geometry_linear.hxx @@ -65,8 +65,8 @@ struct t8_geometry_linear: public t8_geometry_with_vertices * \param [in] cmesh The cmesh in which the point lies. * \param [in] gtreeid The global tree (of the cmesh) in which the reference point is. * \param [in] ref_coords Array of \a dimension many entries, specifying a point in \f$ [0,1]^\mathrm{dim} \f$. - * \param [out] jacobian The jacobian at \a ref_coords. Array of size dimension x 3. Indices 3*i, 3*i+1, 3*i+2 - * correspond to the i-th column of the jacobian (Entry 3*i + j is \f$ \frac{\partial f_j}{\partial x_i} \f$). + * \param [out] jacobian The jacobian at \a ref_coords. Array of size \f$ \mathrm{dim} \cdot 3 \f$. Indices \f$ 3 \cdot i\f$ , \f$ 3 \cdot i+1 \f$ , \f$ 3 \cdot i+2 \f$ + * correspond to the \f$ i \f$-th column of the jacobian (Entry \f$ 3 \cdot i + j \f$ is \f$ \frac{\partial f_j}{\partial x_i} \f$). */ virtual void t8_geom_evaluate_jacobian (t8_cmesh_t cmesh, t8_gloidx_t gtreeid, const double *ref_coords, double *jacobian) const; diff --git a/src/t8_geometry/t8_geometry_implementations/t8_geometry_linear_axis_aligned.cxx b/src/t8_geometry/t8_geometry_implementations/t8_geometry_linear_axis_aligned.cxx index 76c14d51b6..5cb65c3161 100644 --- a/src/t8_geometry/t8_geometry_implementations/t8_geometry_linear_axis_aligned.cxx +++ b/src/t8_geometry/t8_geometry_implementations/t8_geometry_linear_axis_aligned.cxx @@ -62,8 +62,8 @@ t8_geometry_linear_axis_aligned::t8_geom_evaluate (t8_cmesh_t cmesh, t8_gloidx_t * \param [in] cmesh The cmesh in which the point lies. * \param [in] gtreeid The global tree (of the cmesh) in which the reference point is. * \param [in] ref_coords Array of \a dimension many entries, specifying a point in \f$ [0,1]^\mathrm{dim} \f$. - * \param [out] jacobian The jacobian at \a ref_coords. Array of size dimension x 3. Indices 3*i, 3*i+1, 3*i+2 - * correspond to the i-th column of the jacobian (Entry 3*i + j is \f$ \frac{\partial f_j}{\partial x_i} \f$). + * \param [out] jacobian The jacobian at \a ref_coords. Array of size \f$ \mathrm{dim} \cdot 3 \f$. Indices \f$ 3 \cdot i\f$ , \f$ 3 \cdot i+1 \f$ , \f$ 3 \cdot i+2 \f$ + * correspond to the \f$ i \f$-th column of the jacobian (Entry \f$ 3 \cdot i + j \f$ is \f$ \frac{\partial f_j}{\partial x_i} \f$). */ /* *INDENT-OFF* */ /* indent adds second const */ diff --git a/src/t8_geometry/t8_geometry_implementations/t8_geometry_linear_axis_aligned.hxx b/src/t8_geometry/t8_geometry_implementations/t8_geometry_linear_axis_aligned.hxx index 076d87f7e3..e0c6caac31 100644 --- a/src/t8_geometry/t8_geometry_implementations/t8_geometry_linear_axis_aligned.hxx +++ b/src/t8_geometry/t8_geometry_implementations/t8_geometry_linear_axis_aligned.hxx @@ -71,8 +71,8 @@ struct t8_geometry_linear_axis_aligned: public t8_geometry_with_vertices * \param [in] cmesh The cmesh in which the point lies. * \param [in] gtreeid The global tree (of the cmesh) in which the reference point is. * \param [in] ref_coords Array of \a dimension many entries, specifying a point in \f$ [0,1]^\mathrm{dim} \f$. - * \param [out] jacobian The jacobian at \a ref_coords. Array of size dimension x 3. Indices 3*i, 3*i+1, 3*i+2 - * correspond to the i-th column of the jacobian (Entry 3*i + j is \f$ \frac{\partial f_j}{\partial x_i} \f$). + * \param [out] jacobian The jacobian at \a ref_coords. Array of size \f$ \mathrm{dim} \cdot 3 \f$. Indices \f$ 3 \cdot i\f$ , \f$ 3 \cdot i+1 \f$ , \f$ 3 \cdot i+2 \f$ + * correspond to the \f$ i \f$-th column of the jacobian (Entry \f$ 3 \cdot i + j \f$ is \f$ \frac{\partial f_j}{\partial x_i} \f$). */ virtual void t8_geom_evaluate_jacobian (t8_cmesh_t cmesh, t8_gloidx_t gtreeid, const double *ref_coords, double *jacobian) const; diff --git a/src/t8_geometry/t8_geometry_implementations/t8_geometry_occ.hxx b/src/t8_geometry/t8_geometry_implementations/t8_geometry_occ.hxx index 4d148f206d..365ef3459e 100644 --- a/src/t8_geometry/t8_geometry_implementations/t8_geometry_occ.hxx +++ b/src/t8_geometry/t8_geometry_implementations/t8_geometry_occ.hxx @@ -112,8 +112,8 @@ struct t8_geometry_occ: public t8_geometry_with_vertices * \param [in] cmesh The cmesh in which the point lies. * \param [in] gtreeid The global tree (of the cmesh) in which the reference point is. * \param [in] ref_coords Array of \a dimension many entries, specifying a point in \f$ [0,1]^\mathrm{dim} \f$. - * \param [out] jacobian The jacobian at \a ref_coords. Array of size dimension x 3. Indices 3*i, 3*i+1, 3*i+2 - * correspond to the i-th column of the jacobian (Entry 3*i + j is \f$ \frac{\partial f_j}{\partial x_i} \f$). + * \param [out] jacobian The jacobian at \a ref_coords. Array of size \f$ \mathrm{dim} \cdot 3 \f$. Indices \f$ 3 \cdot i\f$ , \f$ 3 \cdot i+1 \f$ , \f$ 3 \cdot i+2 \f$ + * correspond to the \f$ i \f$-th column of the jacobian (Entry \f$ 3 \cdot i + j \f$ is \f$ \frac{\partial f_j}{\partial x_i} \f$). */ virtual void t8_geom_evaluate_jacobian (t8_cmesh_t cmesh, t8_gloidx_t gtreeid, const double *ref_coords, double *jacobian) const; diff --git a/src/t8_geometry/t8_geometry_implementations/t8_geometry_zero.hxx b/src/t8_geometry/t8_geometry_implementations/t8_geometry_zero.hxx index bf01e59285..1bc6a72807 100644 --- a/src/t8_geometry/t8_geometry_implementations/t8_geometry_zero.hxx +++ b/src/t8_geometry/t8_geometry_implementations/t8_geometry_zero.hxx @@ -60,8 +60,8 @@ struct t8_geometry_zero: public t8_geometry * \param [in] cmesh The cmesh in which the point lies. * \param [in] gtreeid The global tree (of the cmesh) in which the reference point is. * \param [in] ref_coords Array of \a dimension many entries, specifying a point in \f$ [0,1]^\mathrm{dim} \f$. - * \param [out] jacobian The jacobian at \a ref_coords. Array of size dimension x 3. Indices 3*i, 3*i+1, 3*i+2 - * correspond to the i-th column of the jacobian (Entry 3*i + j is \f$ \frac{\partial f_j}{\partial x_i} \f$). + * \param [out] jacobian The jacobian at \a ref_coords. Array of size \f$ \mathrm{dim} \cdot 3 \f$. Indices \f$ 3 \cdot i\f$ , \f$ 3 \cdot i+1 \f$ , \f$ 3 \cdot i+2 \f$ + * correspond to the \f$ i \f$-th column of the jacobian (Entry \f$ 3 \cdot i + j \f$ is \f$ \frac{\partial f_j}{\partial x_i} \f$). * \note All entries in \a jacobian will be set to zero. */ virtual void